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