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