Add audio announcement option to app_page
[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>dahdi</depend>
30         <depend>app_meetme</depend>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40 #include "asterisk/file.h"
41 #include "asterisk/app.h"
42 #include "asterisk/chanvars.h"
43 #include "asterisk/utils.h"
44 #include "asterisk/devicestate.h"
45 #include "asterisk/dial.h"
46
47 /*** DOCUMENTATION
48         <application name="Page" language="en_US">
49                 <synopsis>
50                         Page series of phones
51                 </synopsis>
52                 <syntax>
53                         <parameter name="Technology/Resource" required="true" argsep="&amp;">
54                                 <argument name="Technology/Resource" required="true">
55                                         <para>Specification of the device(s) to dial. These must be in the format of
56                                         <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
57                                         represents a particular channel driver, and <replaceable>Resource</replaceable> represents a resource
58                                         available to that particular channel driver.</para>
59                                 </argument>
60                                 <argument name="Technology2/Resource2" multiple="true">
61                                         <para>Optional extra devices to dial inparallel</para>
62                                         <para>If you need more then one enter them as Technology2/Resource2&amp;
63                                         Technology3/Resourse3&amp;.....</para>
64                                 </argument>
65                         </parameter>
66                         <parameter name="options">
67                                 <optionlist>
68                                         <option name="d">
69                                                 <para>Full duplex audio</para>
70                                         </option>
71                                         <option name="i">
72                                                 <para>Ignore attempts to forward the call</para>
73                                         </option>
74                                         <option name="q">
75                                                 <para>Quiet, do not play beep to caller</para>
76                                         </option>
77                                         <option name="r">
78                                                 <para>Record the page into a file (meetme option <literal>r</literal>)</para>
79                                         </option>
80                                         <option name="s">
81                                                 <para>Only dial a channel if its device state says that it is <literal>NOT_INUSE</literal></para>
82                                         </option>
83                                         <option name="A">
84                                                 <argument name="x" required="true">
85                                                         <para>The announcement to playback in all devices</para>
86                                                 </argument>
87                                                 <para>Play an announcement simultaneously to all paged participants</para>
88                                         </option>
89                                         <option name="n">
90                                                 <para>Do not play simultaneous announcement to caller (implies <literal>A(x)</literal>)</para>
91                                         </option>
92                                 </optionlist>
93                         </parameter>
94                         <parameter name="timeout">
95                                 <para>Specify the length of time that the system will attempt to connect a call.
96                                 After this duration, any intercom calls that have not been answered will be hung up by the
97                                 system.</para>
98                         </parameter>
99                 </syntax>
100                 <description>
101                         <para>Places outbound calls to the given <replaceable>technology</replaceable>/<replaceable>resource</replaceable>
102                         and dumps them into a conference bridge as muted participants. The original
103                         caller is dumped into the conference as a speaker and the room is
104                         destroyed when the original callers leaves.</para>
105                 </description>
106                 <see-also>
107                         <ref type="application">MeetMe</ref>
108                 </see-also>
109         </application>
110  ***/
111 static const char * const app_page= "Page";
112
113 enum page_opt_flags {
114         PAGE_DUPLEX = (1 << 0),
115         PAGE_QUIET = (1 << 1),
116         PAGE_RECORD = (1 << 2),
117         PAGE_SKIP = (1 << 3),
118         PAGE_IGNORE_FORWARDS = (1 << 4),
119         PAGE_ANNOUNCE = (1 << 5),
120         PAGE_NOCALLERANNOUNCE = (1 << 6),
121 };
122
123 enum {
124         OPT_ARG_ANNOUNCE = 0,
125         OPT_ARG_ARRAY_SIZE = 1,
126 };
127
128 AST_APP_OPTIONS(page_opts, {
129         AST_APP_OPTION('d', PAGE_DUPLEX),
130         AST_APP_OPTION('q', PAGE_QUIET),
131         AST_APP_OPTION('r', PAGE_RECORD),
132         AST_APP_OPTION('s', PAGE_SKIP),
133         AST_APP_OPTION('i', PAGE_IGNORE_FORWARDS),
134         AST_APP_OPTION('i', PAGE_IGNORE_FORWARDS),
135         AST_APP_OPTION_ARG('A', PAGE_ANNOUNCE, OPT_ARG_ANNOUNCE),
136         AST_APP_OPTION('n', PAGE_NOCALLERANNOUNCE),
137 });
138
139
140 static int page_exec(struct ast_channel *chan, const char *data)
141 {
142         char *tech, *resource, *tmp;
143         char meetmeopts[128], originator[AST_CHANNEL_NAME], *opts[OPT_ARG_ARRAY_SIZE];
144         struct ast_flags flags = { 0 };
145         unsigned int confid = ast_random();
146         struct ast_app *app;
147         int res = 0, pos = 0, i = 0;
148         struct ast_dial **dial_list;
149         unsigned int num_dials;
150         int timeout = 0;
151         char *parse;
152
153         AST_DECLARE_APP_ARGS(args,
154                 AST_APP_ARG(devices);
155                 AST_APP_ARG(options);
156                 AST_APP_ARG(timeout);
157         );
158
159         if (ast_strlen_zero(data)) {
160                 ast_log(LOG_WARNING, "This application requires at least one argument (destination(s) to page)\n");
161                 return -1;
162         }
163
164         if (!(app = pbx_findapp("MeetMe"))) {
165                 ast_log(LOG_WARNING, "There is no MeetMe application available!\n");
166                 return -1;
167         };
168
169         parse = ast_strdupa(data);
170
171         AST_STANDARD_APP_ARGS(args, parse);
172
173         ast_copy_string(originator, chan->name, sizeof(originator));
174         if ((tmp = strchr(originator, '-'))) {
175                 *tmp = '\0';
176         }
177
178         if (!ast_strlen_zero(args.options)) {
179                 ast_app_parse_options(page_opts, &flags, opts, args.options);
180         }
181
182         if (!ast_strlen_zero(args.timeout)) {
183                 timeout = atoi(args.timeout);
184         }
185
186         if (ast_test_flag(&flags, PAGE_ANNOUNCE) && !ast_strlen_zero(opts[OPT_ARG_ANNOUNCE])) {
187                 snprintf(meetmeopts, sizeof(meetmeopts), "MeetMe,%ud,%s%sqxdw(5)G(%s)", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "m"),
188                                                  (ast_test_flag(&flags, PAGE_RECORD) ? "r" : ""), opts[OPT_ARG_ANNOUNCE] );
189         } else {
190                 snprintf(meetmeopts, sizeof(meetmeopts), "MeetMe,%ud,%s%sqxdw(5)", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "m"),
191                 (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
192         }
193
194         /* Count number of extensions in list by number of ampersands + 1 */
195         num_dials = 1;
196         tmp = args.devices;
197         while (*tmp) {
198                 if (*tmp == '&') {
199                         num_dials++;
200                 }
201                 tmp++;
202         }
203
204         if (!(dial_list = ast_calloc(num_dials, sizeof(struct ast_dial *)))) {
205                 ast_log(LOG_ERROR, "Can't allocate %ld bytes for dial list\n", (long)(sizeof(struct ast_dial *) * num_dials));
206                 return -1;
207         }
208
209         /* Go through parsing/calling each device */
210         while ((tech = strsep(&args.devices, "&"))) {
211                 int state = 0;
212                 struct ast_dial *dial = NULL;
213
214                 /* don't call the originating device */
215                 if (!strcasecmp(tech, originator))
216                         continue;
217
218                 /* If no resource is available, continue on */
219                 if (!(resource = strchr(tech, '/'))) {
220                         ast_log(LOG_WARNING, "Incomplete destination '%s' supplied.\n", tech);
221                         continue;
222                 }
223
224                 /* Ensure device is not in use if skip option is enabled */
225                 if (ast_test_flag(&flags, PAGE_SKIP)) {
226                         state = ast_device_state(tech);
227                         if (state == AST_DEVICE_UNKNOWN) {
228                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'. Paging anyway.\n", tech, ast_devstate2str(state));
229                         } else if (state != AST_DEVICE_NOT_INUSE) {
230                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'.\n", tech, ast_devstate2str(state));
231                                 continue;
232                         }
233                 }
234
235                 *resource++ = '\0';
236
237                 /* Create a dialing structure */
238                 if (!(dial = ast_dial_create())) {
239                         ast_log(LOG_WARNING, "Failed to create dialing structure.\n");
240                         continue;
241                 }
242
243                 /* Append technology and resource */
244                 if (ast_dial_append(dial, tech, resource) == -1) {
245                         ast_log(LOG_ERROR, "Failed to add %s to outbound dial\n", tech);
246                         continue;
247                 }
248
249                 /* Set ANSWER_EXEC as global option */
250                 ast_dial_option_global_enable(dial, AST_DIAL_OPTION_ANSWER_EXEC, meetmeopts);
251
252                 if (timeout) {
253                         ast_dial_set_global_timeout(dial, timeout * 1000);
254                 }
255
256                 if (ast_test_flag(&flags, PAGE_IGNORE_FORWARDS)) {
257                         ast_dial_option_global_enable(dial, AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, NULL);
258                 }
259
260                 /* Run this dial in async mode */
261                 ast_dial_run(dial, chan, 1);
262
263                 /* Put in our dialing array */
264                 dial_list[pos++] = dial;
265         }
266
267         if (!ast_test_flag(&flags, PAGE_QUIET)) {
268                 res = ast_streamfile(chan, "beep", chan->language);
269                 if (!res)
270                         res = ast_waitstream(chan, "");
271         }
272
273         if (!res) {
274                 /* Default behaviour */
275                 snprintf(meetmeopts, sizeof(meetmeopts), "%ud,A%s%sqxd", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "t"), 
276                         (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
277                 if (ast_test_flag(&flags, PAGE_ANNOUNCE) && !ast_strlen_zero(opts[OPT_ARG_ANNOUNCE]) &&
278                                 !ast_test_flag(&flags, PAGE_NOCALLERANNOUNCE)) {
279                         snprintf(meetmeopts, sizeof(meetmeopts), "%ud,A%s%sqxdG(%s)", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "t"), 
280                           (ast_test_flag(&flags, PAGE_RECORD) ? "r" : ""), opts[OPT_ARG_ANNOUNCE] );
281                 }
282                 pbx_exec(chan, app, meetmeopts);
283         }
284
285         /* Go through each dial attempt cancelling, joining, and destroying */
286         for (i = 0; i < pos; i++) {
287                 struct ast_dial *dial = dial_list[i];
288
289                 /* We have to wait for the async thread to exit as it's possible Meetme won't throw them out immediately */
290                 ast_dial_join(dial);
291
292                 /* Hangup all channels */
293                 ast_dial_hangup(dial);
294
295                 /* Destroy dialing structure */
296                 ast_dial_destroy(dial);
297         }
298
299         return -1;
300 }
301
302 static int unload_module(void)
303 {
304         return ast_unregister_application(app_page);
305 }
306
307 static int load_module(void)
308 {
309         return ast_register_application_xml(app_page, page_exec);
310 }
311
312 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Page Multiple Phones");
313