b823f58162a6de64d382c53edab350e590a8989f
[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 "asterisk/file.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/pbx.h"
35 #include "asterisk/module.h"
36 #include "asterisk/lock.h"
37 #include "asterisk/app.h"
38 #include "asterisk/options.h"
39 #include "asterisk/features.h"
40
41 #define PICKUPMARK "PICKUPMARK"
42
43 static const char *app = "Pickup";
44 static const char *synopsis = "Directed Call Pickup";
45 static const char *descrip =
46 "  Pickup([extension[@context][&extension2@[context]...]]):  This application can\n"
47 "pickup any ringing channel that is calling the specified extension.  If no\n"
48 "context is specified, the current context will be used. If you use the special\n"
49 "string \"PICKUPMARK\" for the context parameter, for example 10@PICKUPMARK,\n"
50 "this application tries to find a channel which has defined a ${PICKUPMARK}\n"
51 "channel variable with the same value as \"extension\" (in this example, \"10\").\n"
52 "When no parameter is specified, the application will pickup a channel matching\n"
53 "the pickup group of the active channel.";
54
55 /* Perform actual pickup between two channels */
56 static int pickup_do(struct ast_channel *chan, struct ast_channel *target)
57 {
58         int res = 0;
59
60         ast_debug(1, "Call pickup on '%s' by '%s'\n", target->name, chan->name);
61
62         if ((res = ast_answer(chan))) {
63                 ast_log(LOG_WARNING, "Unable to answer '%s'\n", chan->name);
64                 return -1;
65         }
66
67         if ((res = ast_queue_control(chan, AST_CONTROL_ANSWER))) {
68                 ast_log(LOG_WARNING, "Unable to queue answer on '%s'\n", chan->name);
69                 return -1;
70         }
71
72         if ((res = ast_channel_masquerade(target, chan))) {
73                 ast_log(LOG_WARNING, "Unable to masquerade '%s' into '%s'\n", chan->name, target->name);
74                 return -1;
75         }
76
77         return res;
78 }
79
80 /* Helper function that determines whether a channel is capable of being picked up */
81 static int can_pickup(struct ast_channel *chan)
82 {
83         if (!chan->pbx && (chan->_state == AST_STATE_RINGING || chan->_state == AST_STATE_RING))
84                 return 1;
85         else
86                 return 0;
87 }
88
89 /* Attempt to pick up specified extension with context */
90 static int pickup_by_exten(struct ast_channel *chan, const char *exten, const char *context)
91 {
92         int res = -1;
93         struct ast_channel *target = NULL;
94
95         while ((target = ast_channel_walk_locked(target))) {
96                 if ((!strcasecmp(target->macroexten, exten) || !strcasecmp(target->exten, exten)) &&
97                     !strcasecmp(target->dialcontext, context) &&
98                     can_pickup(target)) {
99                         res = pickup_do(chan, target);
100                         ast_channel_unlock(target);
101                         break;
102                 }
103                 ast_channel_unlock(target);
104         }
105
106         return res;
107 }
108
109 /* Attempt to pick up specified mark */
110 static int pickup_by_mark(struct ast_channel *chan, const char *mark)
111 {
112         int res = -1;
113         const char *tmp = NULL;
114         struct ast_channel *target = NULL;
115
116         while ((target = ast_channel_walk_locked(target))) {
117                 if ((tmp = pbx_builtin_getvar_helper(target, PICKUPMARK)) &&
118                     !strcasecmp(tmp, mark) &&
119                     can_pickup(target)) {
120                         res = pickup_do(chan, target);
121                         ast_channel_unlock(target);
122                         break;
123                 }
124                 ast_channel_unlock(target);
125         }
126
127         return res;
128 }
129
130 /* Main application entry point */
131 static int pickup_exec(struct ast_channel *chan, void *data)
132 {
133         int res = 0;
134         char *tmp = ast_strdupa(data);
135         char *exten = NULL, *context = NULL;
136
137         if (ast_strlen_zero(data)) {
138                 res = ast_pickup_call(chan);
139                 return res;
140         }
141         
142         /* Parse extension (and context if there) */
143         while (!ast_strlen_zero(tmp) && (exten = strsep(&tmp, "&"))) {
144                 if ((context = strchr(exten, '@')))
145                         *context++ = '\0';
146                 if (!ast_strlen_zero(context) && !strcasecmp(context, PICKUPMARK)) {
147                         if (!pickup_by_mark(chan, exten))
148                                 break;
149                 } else {
150                         if (!pickup_by_exten(chan, exten, !ast_strlen_zero(context) ? context : chan->context))
151                                 break;
152                 }
153                 ast_log(LOG_NOTICE, "No target channel found for %s.\n", exten);
154         }
155
156         return res;
157 }
158
159 static int unload_module(void)
160 {
161         int res;
162
163         res = ast_unregister_application(app);
164         
165         return res;
166 }
167
168 static int load_module(void)
169 {
170         return ast_register_application(app, pickup_exec, synopsis, descrip);
171 }
172
173 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Directed Call Pickup Application");