Applications no longer need to call ast_module_user_add and ast_module_user_remove...
[asterisk/asterisk.git] / apps / app_directed_pickup.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Joshua Colp
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Directed Call Pickup Support
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <unistd.h>
36
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/app.h"
44 #include "asterisk/options.h"
45
46 #define PICKUPMARK "PICKUPMARK"
47
48 static const char *app = "Pickup";
49 static const char *synopsis = "Directed Call Pickup";
50 static const char *descrip =
51 "  Pickup(extension[@context][&extension2@context...]): This application can pickup any ringing channel\n"
52 "that is calling the specified extension. If no context is specified, the current\n"
53 "context will be used. If you use the special string \"PICKUPMARK\" for the context parameter, for example\n"
54 "10@PICKUPMARK, this application tries to find a channel which has defined a channel variable with the same content\n"
55 "as \"extension\".";
56
57 /* Perform actual pickup between two channels */
58 static int pickup_do(struct ast_channel *chan, struct ast_channel *target)
59 {
60         int res = 0;
61
62         ast_debug(1, "Call pickup on '%s' by '%s'\n", target->name, chan->name);
63
64         if ((res = ast_answer(chan))) {
65                 ast_log(LOG_WARNING, "Unable to answer '%s'\n", chan->name);
66                 return -1;
67         }
68
69         if ((res = ast_queue_control(chan, AST_CONTROL_ANSWER))) {
70                 ast_log(LOG_WARNING, "Unable to queue answer on '%s'\n", chan->name);
71                 return -1;
72         }
73
74         if ((res = ast_channel_masquerade(target, chan))) {
75                 ast_log(LOG_WARNING, "Unable to masquerade '%s' into '%s'\n", chan->name, target->name);
76                 return -1;
77         }
78
79         return res;
80 }
81
82 /* Helper function that determines whether a channel is capable of being picked up */
83 static int can_pickup(struct ast_channel *chan)
84 {
85         if (!chan->pbx && (chan->_state == AST_STATE_RINGING || chan->_state == AST_STATE_RING))
86                 return 1;
87         else
88                 return 0;
89 }
90
91 /* Attempt to pick up specified extension with context */
92 static int pickup_by_exten(struct ast_channel *chan, const char *exten, const char *context)
93 {
94         int res = -1;
95         struct ast_channel *target = NULL;
96
97         while ((target = ast_channel_walk_locked(target))) {
98                 if ((!strcasecmp(target->macroexten, exten) || !strcasecmp(target->exten, exten)) &&
99                     !strcasecmp(target->dialcontext, context) &&
100                     can_pickup(target)) {
101                         res = pickup_do(chan, target);
102                         ast_channel_unlock(target);
103                         break;
104                 }
105                 ast_channel_unlock(target);
106         }
107
108         return res;
109 }
110
111 /* Attempt to pick up specified mark */
112 static int pickup_by_mark(struct ast_channel *chan, const char *mark)
113 {
114         int res = -1;
115         const char *tmp = NULL;
116         struct ast_channel *target = NULL;
117
118         while ((target = ast_channel_walk_locked(target))) {
119                 if ((tmp = pbx_builtin_getvar_helper(target, PICKUPMARK)) &&
120                     !strcasecmp(tmp, mark) &&
121                     can_pickup(target)) {
122                         res = pickup_do(chan, target);
123                         ast_channel_unlock(target);
124                         break;
125                 }
126                 ast_channel_unlock(target);
127         }
128
129         return res;
130 }
131
132 /* Main application entry point */
133 static int pickup_exec(struct ast_channel *chan, void *data)
134 {
135         int res = 0;
136         char *tmp = ast_strdupa(data);
137         char *exten = NULL, *context = NULL;
138
139         if (ast_strlen_zero(data)) {
140                 ast_log(LOG_WARNING, "Pickup requires an argument (extension)!\n");
141                 return -1;      
142         }
143         
144         /* Parse extension (and context if there) */
145         while (!ast_strlen_zero(tmp) && (exten = strsep(&tmp, "&"))) {
146                 if ((context = strchr(exten, '@')))
147                         *context++ = '\0';
148                 if (!ast_strlen_zero(context) && !strcasecmp(context, PICKUPMARK)) {
149                         if (!pickup_by_mark(chan, exten))
150                                 break;
151                 } else {
152                         if (!pickup_by_exten(chan, exten, !ast_strlen_zero(context) ? context : chan->context))
153                                 break;
154                 }
155                 ast_log(LOG_NOTICE, "No target channel found for %s.\n", exten);
156         }
157
158         return res;
159 }
160
161 static int unload_module(void)
162 {
163         int res;
164
165         res = ast_unregister_application(app);
166         
167         return res;
168 }
169
170 static int load_module(void)
171 {
172         return ast_register_application(app, pickup_exec, synopsis, descrip);
173 }
174
175 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Directed Call Pickup Application");