* Fixed timeout logic in the dialing API as setting timeouts
[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 static const char *app_page= "Page";
48
49 static const char *page_synopsis = "Pages phones";
50
51 static const char *page_descrip =
52 "Page(Technology/Resource&Technology2/Resource2[,options][,timeout])\n"
53 "  Places outbound calls to the given technology / resource and dumps\n"
54 "them into a conference bridge as muted participants.  The original\n"
55 "caller is dumped into the conference as a speaker and the room is\n"
56 "destroyed when the original caller leaves.  Valid options are:\n"
57 "        d - full duplex audio\n"
58 "        q - quiet, do not play beep to caller\n"
59 "        r - record the page into a file (see 'r' for app_meetme)\n"
60 "        s - only dial channel if devicestate says it is not in use\n"
61 "The timeout parameter specifies the length of time that the system\n"
62 "will attempt to connect a call. After this duration, any intercom\n"
63 "calls that have not been answered will be hung up by the system.\n";
64
65 enum {
66         PAGE_DUPLEX = (1 << 0),
67         PAGE_QUIET = (1 << 1),
68         PAGE_RECORD = (1 << 2),
69         PAGE_SKIP = (1 << 3),
70 } page_opt_flags;
71
72 AST_APP_OPTIONS(page_opts, {
73         AST_APP_OPTION('d', PAGE_DUPLEX),
74         AST_APP_OPTION('q', PAGE_QUIET),
75         AST_APP_OPTION('r', PAGE_RECORD),
76         AST_APP_OPTION('s', PAGE_SKIP),
77 });
78
79 #define MAX_DIALS 128
80
81 static int page_exec(struct ast_channel *chan, void *data)
82 {
83         char *tech, *resource, *tmp;
84         char meetmeopts[88], originator[AST_CHANNEL_NAME], *opts[0];
85         struct ast_flags flags = { 0 };
86         unsigned int confid = ast_random();
87         struct ast_app *app;
88         int res = 0, pos = 0, i = 0;
89         struct ast_dial *dials[MAX_DIALS];
90         int timeout = 0;
91         char *parse;
92
93         AST_DECLARE_APP_ARGS(args,
94                 AST_APP_ARG(devices);
95                 AST_APP_ARG(options);
96                 AST_APP_ARG(timeout);
97         );
98
99         if (ast_strlen_zero(data)) {
100                 ast_log(LOG_WARNING, "This application requires at least one argument (destination(s) to page)\n");
101                 return -1;
102         }
103
104         if (!(app = pbx_findapp("MeetMe"))) {
105                 ast_log(LOG_WARNING, "There is no MeetMe application available!\n");
106                 return -1;
107         };
108
109         parse = ast_strdupa(data);
110
111         AST_STANDARD_APP_ARGS(args, parse);
112
113         ast_copy_string(originator, chan->name, sizeof(originator));
114         if ((tmp = strchr(originator, '-'))) {
115                 *tmp = '\0';
116         }
117
118         if (!ast_strlen_zero(args.options)) {
119                 ast_app_parse_options(page_opts, &flags, opts, args.options);
120         }
121
122         if (!ast_strlen_zero(args.timeout)) {
123                 timeout = atoi(args.timeout);
124         }
125
126         snprintf(meetmeopts, sizeof(meetmeopts), "MeetMe,%ud,%s%sqxdw(5)", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "m"),
127                 (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
128
129         /* Go through parsing/calling each device */
130         while ((tech = strsep(&args.devices, "&"))) {
131                 int state = 0;
132                 struct ast_dial *dial = NULL;
133
134                 /* don't call the originating device */
135                 if (!strcasecmp(tech, originator))
136                         continue;
137
138                 /* If no resource is available, continue on */
139                 if (!(resource = strchr(tech, '/'))) {
140                         ast_log(LOG_WARNING, "Incomplete destination '%s' supplied.\n", tech);
141                         continue;
142                 }
143
144                 /* Ensure device is not in use if skip option is enabled */
145                 if (ast_test_flag(&flags, PAGE_SKIP)) {
146                         state = ast_device_state(tech);
147                         if (state == AST_DEVICE_UNKNOWN) {
148                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'. Paging anyway.\n", tech, devstate2str(state));
149                         } else if (state != AST_DEVICE_NOT_INUSE) {
150                                 ast_log(LOG_WARNING, "Destination '%s' has device state '%s'.\n", tech, devstate2str(state));
151                                 continue;
152                         }
153                 }
154
155                 *resource++ = '\0';
156
157                 /* Create a dialing structure */
158                 if (!(dial = ast_dial_create())) {
159                         ast_log(LOG_WARNING, "Failed to create dialing structure.\n");
160                         continue;
161                 }
162
163                 /* Append technology and resource */
164                 if (ast_dial_append(dial, tech, resource) == -1) {
165                         ast_log(LOG_ERROR, "Failed to add %s to outbound dial\n", tech);
166                         continue;
167                 }
168
169                 /* Set ANSWER_EXEC as global option */
170                 ast_dial_option_global_enable(dial, AST_DIAL_OPTION_ANSWER_EXEC, meetmeopts);
171
172                 if (timeout) {
173                         ast_dial_set_global_timeout(dial, timeout * 1000);
174                 }
175
176                 /* Run this dial in async mode */
177                 ast_dial_run(dial, chan, 1);
178
179                 /* Put in our dialing array */
180                 dials[pos++] = dial;
181         }
182
183         if (!ast_test_flag(&flags, PAGE_QUIET)) {
184                 res = ast_streamfile(chan, "beep", chan->language);
185                 if (!res)
186                         res = ast_waitstream(chan, "");
187         }
188
189         if (!res) {
190                 snprintf(meetmeopts, sizeof(meetmeopts), "%ud,A%s%sqxd", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "t"), 
191                         (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
192                 pbx_exec(chan, app, meetmeopts);
193         }
194
195         /* Go through each dial attempt cancelling, joining, and destroying */
196         for (i = 0; i < pos; i++) {
197                 struct ast_dial *dial = dials[i];
198
199                 /* We have to wait for the async thread to exit as it's possible Meetme won't throw them out immediately */
200                 ast_dial_join(dial);
201
202                 /* Hangup all channels */
203                 ast_dial_hangup(dial);
204
205                 /* Destroy dialing structure */
206                 ast_dial_destroy(dial);
207         }
208
209         return -1;
210 }
211
212 static int unload_module(void)
213 {
214         return ast_unregister_application(app_page);
215 }
216
217 static int load_module(void)
218 {
219         return ast_register_application(app_page, page_exec, page_synopsis, page_descrip);
220 }
221
222 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Page Multiple Phones");
223