app_page: Add dependency against app_confbridge.
[asterisk/asterisk.git] / apps / app_page.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2004 - 2006 Digium, Inc.  All rights reserved.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * This code is released under the GNU General Public License
9  * version 2.0.  See LICENSE for more information.
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  */
18
19 /*! \file
20  *
21  * \brief page() - Paging application
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 /*** MODULEINFO
29         <depend>app_confbridge</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/file.h"
39 #include "asterisk/app.h"
40 #include "asterisk/chanvars.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/devicestate.h"
43 #include "asterisk/dial.h"
44
45 /*** DOCUMENTATION
46         <application name="Page" language="en_US">
47                 <synopsis>
48                         Page series of phones
49                 </synopsis>
50                 <syntax>
51                         <parameter name="Technology/Resource" required="true" argsep="&amp;">
52                                 <argument name="Technology/Resource" required="true">
53                                         <para>Specification of the device(s) to dial. These must be in the format of
54                                         <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
55                                         represents a particular channel driver, and <replaceable>Resource</replaceable> represents a resource
56                                         available to that particular channel driver.</para>
57                                 </argument>
58                                 <argument name="Technology2/Resource2" multiple="true">
59                                         <para>Optional extra devices to dial in parallel</para>
60                                         <para>If you need more than one, enter them as Technology2/Resource2&amp;
61                                         Technology3/Resource3&amp;.....</para>
62                                 </argument>
63                         </parameter>
64                         <parameter name="options">
65                                 <optionlist>
66                                 <option name="b" argsep="^">
67                                         <para>Before initiating an outgoing call, Gosub to the specified
68                                         location using the newly created channel.  The Gosub will be
69                                         executed for each destination channel.</para>
70                                         <argument name="context" required="false" />
71                                         <argument name="exten" required="false" />
72                                         <argument name="priority" required="true" hasparams="optional" argsep="^">
73                                                 <argument name="arg1" multiple="true" required="true" />
74                                                 <argument name="argN" />
75                                         </argument>
76                                 </option>
77                                 <option name="B" argsep="^">
78                                         <para>Before initiating the outgoing call(s), Gosub to the specified
79                                         location using the current channel.</para>
80                                         <argument name="context" required="false" />
81                                         <argument name="exten" required="false" />
82                                         <argument name="priority" required="true" hasparams="optional" argsep="^">
83                                                 <argument name="arg1" multiple="true" required="true" />
84                                                 <argument name="argN" />
85                                         </argument>
86                                 </option>
87                                         <option name="d">
88                                                 <para>Full duplex audio</para>
89                                         </option>
90                                         <option name="i">
91                                                 <para>Ignore attempts to forward the call</para>
92                                         </option>
93                                         <option name="q">
94                                                 <para>Quiet, do not play beep to caller</para>
95                                         </option>
96                                         <option name="r">
97                                                 <para>Record the page into a file (<literal>CONFBRIDGE(bridge,record_conference)</literal>)</para>
98                                         </option>
99                                         <option name="s">
100                                                 <para>Only dial a channel if its device state says that it is <literal>NOT_INUSE</literal></para>
101                                         </option>
102                                         <option name="A">
103                                                 <argument name="x" required="true">
104                                                         <para>The announcement to playback to all devices</para>
105                                                 </argument>
106                                                 <para>Play an announcement to all paged participants</para>
107                                         </option>
108                                         <option name="n">
109                                                 <para>Do not play announcement to caller (alters <literal>A(x)</literal> behavior)</para>
110                                         </option>
111                                 </optionlist>
112                         </parameter>
113                         <parameter name="timeout">
114                                 <para>Specify the length of time that the system will attempt to connect a call.
115                                 After this duration, any page calls that have not been answered will be hung up by the
116                                 system.</para>
117                         </parameter>
118                 </syntax>
119                 <description>
120                         <para>Places outbound calls to the given <replaceable>technology</replaceable>/<replaceable>resource</replaceable>
121                         and dumps them into a conference bridge as muted participants. The original
122                         caller is dumped into the conference as a speaker and the room is
123                         destroyed when the original caller leaves.</para>
124                 </description>
125                 <see-also>
126                         <ref type="application">ConfBridge</ref>
127                 </see-also>
128         </application>
129  ***/
130 static const char * const app_page= "Page";
131
132 enum page_opt_flags {
133         PAGE_DUPLEX = (1 << 0),
134         PAGE_QUIET = (1 << 1),
135         PAGE_RECORD = (1 << 2),
136         PAGE_SKIP = (1 << 3),
137         PAGE_IGNORE_FORWARDS = (1 << 4),
138         PAGE_ANNOUNCE = (1 << 5),
139         PAGE_NOCALLERANNOUNCE = (1 << 6),
140         PAGE_PREDIAL_CALLEE = (1 << 7),
141         PAGE_PREDIAL_CALLER = (1 << 8),
142 };
143
144 enum {
145         OPT_ARG_ANNOUNCE = 0,
146         OPT_ARG_PREDIAL_CALLEE = 1,
147         OPT_ARG_PREDIAL_CALLER = 2,
148         OPT_ARG_ARRAY_SIZE = 3,
149 };
150
151 AST_APP_OPTIONS(page_opts, {
152         AST_APP_OPTION_ARG('b', PAGE_PREDIAL_CALLEE, OPT_ARG_PREDIAL_CALLEE),
153         AST_APP_OPTION_ARG('B', PAGE_PREDIAL_CALLER, OPT_ARG_PREDIAL_CALLER),
154         AST_APP_OPTION('d', PAGE_DUPLEX),
155         AST_APP_OPTION('q', PAGE_QUIET),
156         AST_APP_OPTION('r', PAGE_RECORD),
157         AST_APP_OPTION('s', PAGE_SKIP),
158         AST_APP_OPTION('i', PAGE_IGNORE_FORWARDS),
159         AST_APP_OPTION_ARG('A', PAGE_ANNOUNCE, OPT_ARG_ANNOUNCE),
160         AST_APP_OPTION('n', PAGE_NOCALLERANNOUNCE),
161 });
162
163 /* We use this structure as a way to pass this to all dialed channels */
164 struct page_options {
165         char *opts[OPT_ARG_ARRAY_SIZE];
166         struct ast_flags flags;
167 };
168
169 /*!
170  * \internal
171  * \brief Setup the page bridge profile.
172  *
173  * \param chan Setup bridge profile on this channel.
174  * \param options Options to setup bridge profile.
175  *
176  * \return Nothing
177  */
178 static void setup_profile_bridge(struct ast_channel *chan, struct page_options *options)
179 {
180         /* Use default_bridge as a starting point */
181         ast_func_write(chan, "CONFBRIDGE(bridge,template)", "");
182         if (ast_test_flag(&options->flags, PAGE_RECORD)) {
183                 ast_func_write(chan, "CONFBRIDGE(bridge,record_conference)", "yes");
184         }
185 }
186
187 /*!
188  * \internal
189  * \brief Setup the paged user profile.
190  *
191  * \param chan Setup user profile on this channel.
192  * \param options Options to setup paged user profile.
193  *
194  * \return Nothing
195  */
196 static void setup_profile_paged(struct ast_channel *chan, struct page_options *options)
197 {
198         /* Use default_user as a starting point */
199         ast_func_write(chan, "CONFBRIDGE(user,template)", "");
200         ast_func_write(chan, "CONFBRIDGE(user,quiet)", "yes");
201         ast_func_write(chan, "CONFBRIDGE(user,end_marked)", "yes");
202         if (!ast_test_flag(&options->flags, PAGE_DUPLEX)) {
203                 ast_func_write(chan, "CONFBRIDGE(user,startmuted)", "yes");
204         }
205         if (ast_test_flag(&options->flags, PAGE_ANNOUNCE)
206                 && !ast_strlen_zero(options->opts[OPT_ARG_ANNOUNCE])) {
207                 ast_func_write(chan, "CONFBRIDGE(user,announcement)", options->opts[OPT_ARG_ANNOUNCE]);
208         }
209 }
210
211 /*!
212  * \internal
213  * \brief Setup the caller user profile.
214  *
215  * \param chan Setup user profile on this channel.
216  * \param options Options to setup caller user profile.
217  *
218  * \return Nothing
219  */
220 static void setup_profile_caller(struct ast_channel *chan, struct page_options *options)
221 {
222         /* Use default_user as a starting point if not already setup. */
223         ast_func_write(chan, "CONFBRIDGE(user,template)", "");
224         ast_func_write(chan, "CONFBRIDGE(user,quiet)", "yes");
225         ast_func_write(chan, "CONFBRIDGE(user,marked)", "yes");
226         if (!ast_test_flag(&options->flags, PAGE_NOCALLERANNOUNCE)
227                 && ast_test_flag(&options->flags, PAGE_ANNOUNCE)
228                 && !ast_strlen_zero(options->opts[OPT_ARG_ANNOUNCE])) {
229                 ast_func_write(chan, "CONFBRIDGE(user,announcement)", options->opts[OPT_ARG_ANNOUNCE]);
230         }
231 }
232
233 static void page_state_callback(struct ast_dial *dial)
234 {
235         struct ast_channel *chan;
236         struct page_options *options;
237
238         if (ast_dial_state(dial) != AST_DIAL_RESULT_ANSWERED ||
239             !(chan = ast_dial_answered(dial)) ||
240             !(options = ast_dial_get_user_data(dial))) {
241                 return;
242         }
243
244         setup_profile_bridge(chan, options);
245         setup_profile_paged(chan, options);
246 }
247
248 static int page_exec(struct ast_channel *chan, const char *data)
249 {
250         char *tech;
251         char *resource;
252         char *tmp;
253         char *predial_callee = NULL;
254         char confbridgeopts[128];
255         char originator[AST_CHANNEL_NAME];
256         struct page_options options = { { 0, }, { 0, } };
257         unsigned int confid = ast_random();
258         struct ast_app *app;
259         int res = 0;
260         int pos = 0;
261         int i = 0;
262         struct ast_dial **dial_list;
263         unsigned int num_dials;
264         int timeout = 0;
265         char *parse;
266
267         AST_DECLARE_APP_ARGS(args,
268                 AST_APP_ARG(devices);
269                 AST_APP_ARG(options);
270                 AST_APP_ARG(timeout);
271         );
272
273         if (ast_strlen_zero(data)) {
274                 ast_log(LOG_WARNING, "This application requires at least one argument (destination(s) to page)\n");
275                 return -1;
276         }
277
278         if (!(app = pbx_findapp("ConfBridge"))) {
279                 ast_log(LOG_WARNING, "There is no ConfBridge application available!\n");
280                 return -1;
281         };
282
283         parse = ast_strdupa(data);
284
285         AST_STANDARD_APP_ARGS(args, parse);
286
287         ast_copy_string(originator, ast_channel_name(chan), sizeof(originator));
288         if ((tmp = strchr(originator, '-'))) {
289                 *tmp = '\0';
290         }
291
292         if (!ast_strlen_zero(args.options)) {
293                 ast_app_parse_options(page_opts, &options.flags, options.opts, args.options);
294         }
295
296         if (!ast_strlen_zero(args.timeout)) {
297                 timeout = atoi(args.timeout);
298         }
299
300         snprintf(confbridgeopts, sizeof(confbridgeopts), "ConfBridge,%u", confid);
301
302         /* Count number of extensions in list by number of ampersands + 1 */
303         num_dials = 1;
304         tmp = args.devices;
305         while (*tmp) {
306                 if (*tmp == '&') {
307                         num_dials++;
308                 }
309                 tmp++;
310         }
311
312         if (!(dial_list = ast_calloc(num_dials, sizeof(struct ast_dial *)))) {
313                 ast_log(LOG_ERROR, "Can't allocate %ld bytes for dial list\n", (long)(sizeof(struct ast_dial *) * num_dials));
314                 return -1;
315         }
316
317         /* PREDIAL: Preprocess any callee gosub arguments. */
318         if (ast_test_flag(&options.flags, PAGE_PREDIAL_CALLEE)
319                 && !ast_strlen_zero(options.opts[OPT_ARG_PREDIAL_CALLEE])) {
320                 ast_replace_subargument_delimiter(options.opts[OPT_ARG_PREDIAL_CALLEE]);
321                 predial_callee =
322                         (char *) ast_app_expand_sub_args(chan, options.opts[OPT_ARG_PREDIAL_CALLEE]);
323         }
324
325         /* PREDIAL: Run gosub on the caller's channel */
326         if (ast_test_flag(&options.flags, PAGE_PREDIAL_CALLER)
327                 && !ast_strlen_zero(options.opts[OPT_ARG_PREDIAL_CALLER])) {
328                 ast_replace_subargument_delimiter(options.opts[OPT_ARG_PREDIAL_CALLER]);
329                 ast_app_exec_sub(NULL, chan, options.opts[OPT_ARG_PREDIAL_CALLER], 0);
330         }
331
332         /* Go through parsing/calling each device */
333         while ((tech = strsep(&args.devices, "&"))) {
334                 int state = 0;
335                 struct ast_dial *dial = NULL;
336
337                 /* don't call the originating device */
338                 if (!strcasecmp(tech, originator))
339                         continue;
340
341                 /* If no resource is available, continue on */
342                 if (!(resource = strchr(tech, '/'))) {
343                         ast_log(LOG_WARNING, "Incomplete destination '%s' supplied.\n", tech);
344                         continue;
345                 }
346
347                 /* Ensure device is not in use if skip option is enabled */
348                 if (ast_test_flag(&options.flags, PAGE_SKIP)) {
349                         state = ast_device_state(tech);
350                         if (state == AST_DEVICE_UNKNOWN) {
351                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'. Paging anyway.\n", tech, ast_devstate2str(state));
352                         } else if (state != AST_DEVICE_NOT_INUSE) {
353                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'.\n", tech, ast_devstate2str(state));
354                                 continue;
355                         }
356                 }
357
358                 *resource++ = '\0';
359
360                 /* Create a dialing structure */
361                 if (!(dial = ast_dial_create())) {
362                         ast_log(LOG_WARNING, "Failed to create dialing structure.\n");
363                         continue;
364                 }
365
366                 /* Append technology and resource */
367                 if (ast_dial_append(dial, tech, resource, NULL) == -1) {
368                         ast_log(LOG_ERROR, "Failed to add %s to outbound dial\n", tech);
369                         ast_dial_destroy(dial);
370                         continue;
371                 }
372
373                 /* Set ANSWER_EXEC as global option */
374                 ast_dial_option_global_enable(dial, AST_DIAL_OPTION_ANSWER_EXEC, confbridgeopts);
375
376                 if (predial_callee) {
377                         ast_dial_option_global_enable(dial, AST_DIAL_OPTION_PREDIAL, predial_callee);
378                 }
379
380                 if (timeout) {
381                         ast_dial_set_global_timeout(dial, timeout * 1000);
382                 }
383
384                 if (ast_test_flag(&options.flags, PAGE_IGNORE_FORWARDS)) {
385                         ast_dial_option_global_enable(dial, AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, NULL);
386                 }
387
388                 ast_dial_set_state_callback(dial, &page_state_callback);
389                 ast_dial_set_user_data(dial, &options);
390
391                 /* Run this dial in async mode */
392                 ast_dial_run(dial, chan, 1);
393
394                 /* Put in our dialing array */
395                 dial_list[pos++] = dial;
396         }
397
398         ast_free(predial_callee);
399
400         if (!ast_test_flag(&options.flags, PAGE_QUIET)) {
401                 res = ast_streamfile(chan, "beep", ast_channel_language(chan));
402                 if (!res)
403                         res = ast_waitstream(chan, "");
404         }
405
406         if (!res) {
407                 setup_profile_bridge(chan, &options);
408                 setup_profile_caller(chan, &options);
409
410                 snprintf(confbridgeopts, sizeof(confbridgeopts), "%u", confid);
411                 pbx_exec(chan, app, confbridgeopts);
412         }
413
414         /* Go through each dial attempt cancelling, joining, and destroying */
415         for (i = 0; i < pos; i++) {
416                 struct ast_dial *dial = dial_list[i];
417
418                 /* We have to wait for the async thread to exit as it's possible ConfBridge won't throw them out immediately */
419                 ast_dial_join(dial);
420
421                 /* Hangup all channels */
422                 ast_dial_hangup(dial);
423
424                 /* Destroy dialing structure */
425                 ast_dial_destroy(dial);
426         }
427
428         ast_free(dial_list);
429
430         return -1;
431 }
432
433 static int unload_module(void)
434 {
435         return ast_unregister_application(app_page);
436 }
437
438 static int load_module(void)
439 {
440         return ast_register_application_xml(app_page, page_exec);
441 }
442
443 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Page Multiple Phones",
444         .support_level = AST_MODULE_SUPPORT_CORE,
445         .load = load_module,
446         .unload = unload_module,
447         .requires = "app_confbridge",
448 );