Applications no longer need to call ast_module_user_add and ast_module_user_remove...
[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>zaptel</depend>
30         <depend>app_meetme</depend>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <unistd.h>
40 #include <string.h>
41 #include <errno.h>
42
43 #include "asterisk/options.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/module.h"
48 #include "asterisk/file.h"
49 #include "asterisk/app.h"
50 #include "asterisk/chanvars.h"
51 #include "asterisk/utils.h"
52 #include "asterisk/devicestate.h"
53 #include "asterisk/dial.h"
54
55 static const char *app_page= "Page";
56
57 static const char *page_synopsis = "Pages phones";
58
59 static const char *page_descrip =
60 "Page(Technology/Resource&Technology2/Resource2[|options])\n"
61 "  Places outbound calls to the given technology / resource and dumps\n"
62 "them into a conference bridge as muted participants.  The original\n"
63 "caller is dumped into the conference as a speaker and the room is\n"
64 "destroyed when the original caller leaves.  Valid options are:\n"
65 "        d - full duplex audio\n"
66 "        q - quiet, do not play beep to caller\n"
67 "        r - record the page into a file (see 'r' for app_meetme)\n"
68 "        s - only dial channel if devicestate says it is not in use\n";
69
70 enum {
71         PAGE_DUPLEX = (1 << 0),
72         PAGE_QUIET = (1 << 1),
73         PAGE_RECORD = (1 << 2),
74         PAGE_SKIP = (1 << 3),
75 } page_opt_flags;
76
77 AST_APP_OPTIONS(page_opts, {
78         AST_APP_OPTION('d', PAGE_DUPLEX),
79         AST_APP_OPTION('q', PAGE_QUIET),
80         AST_APP_OPTION('r', PAGE_RECORD),
81         AST_APP_OPTION('s', PAGE_SKIP),
82 });
83
84 #define MAX_DIALS 128
85
86 static int page_exec(struct ast_channel *chan, void *data)
87 {
88         char *options, *tech, *resource, *tmp;
89         char meetmeopts[88], originator[AST_CHANNEL_NAME];
90         struct ast_flags flags = { 0 };
91         unsigned int confid = ast_random();
92         struct ast_app *app;
93         int res = 0, pos = 0, i = 0;
94         struct ast_dial *dials[MAX_DIALS];
95
96         if (ast_strlen_zero(data)) {
97                 ast_log(LOG_WARNING, "This application requires at least one argument (destination(s) to page)\n");
98                 return -1;
99         }
100
101         if (!(app = pbx_findapp("MeetMe"))) {
102                 ast_log(LOG_WARNING, "There is no MeetMe application available!\n");
103                 return -1;
104         };
105
106         options = ast_strdupa(data);
107
108         ast_copy_string(originator, chan->name, sizeof(originator));
109         if ((tmp = strchr(originator, '-')))
110                 *tmp = '\0';
111
112         tmp = strsep(&options, "|");
113         if (options)
114                 ast_app_parse_options(page_opts, &flags, NULL, options);
115
116         snprintf(meetmeopts, sizeof(meetmeopts), "MeetMe|%ud|%s%sqxdw(5)", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "m"),
117                 (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
118
119         /* Go through parsing/calling each device */
120         while ((tech = strsep(&tmp, "&"))) {
121                 int state = 0;
122                 struct ast_dial *dial = NULL;
123
124                 /* don't call the originating device */
125                 if (!strcasecmp(tech, originator))
126                         continue;
127
128                 /* If no resource is available, continue on */
129                 if (!(resource = strchr(tech, '/'))) {
130                         ast_log(LOG_WARNING, "Incomplete destination '%s' supplied.\n", tech);
131                         continue;
132                 }
133
134                 /* Ensure device is not in use if skip option is enabled */
135                 if (ast_test_flag(&flags, PAGE_SKIP) && (state = ast_device_state(tech)) != AST_DEVICE_NOT_INUSE) {
136                         ast_log(LOG_WARNING, "Destination '%s' has device state '%s'.\n", tech, devstate2str(state));
137                         continue;
138                 }
139
140                 *resource++ = '\0';
141
142                 /* Create a dialing structure */
143                 if (!(dial = ast_dial_create())) {
144                         ast_log(LOG_WARNING, "Failed to create dialing structure.\n");
145                         continue;
146                 }
147
148                 /* Append technology and resource */
149                 ast_dial_append(dial, tech, resource);
150
151                 /* Set ANSWER_EXEC as global option */
152                 ast_dial_option_global_enable(dial, AST_DIAL_OPTION_ANSWER_EXEC, meetmeopts);
153
154                 /* Run this dial in async mode */
155                 ast_dial_run(dial, chan, 1);
156
157                 /* Put in our dialing array */
158                 dials[pos++] = dial;
159         }
160
161         if (!ast_test_flag(&flags, PAGE_QUIET)) {
162                 res = ast_streamfile(chan, "beep", chan->language);
163                 if (!res)
164                         res = ast_waitstream(chan, "");
165         }
166
167         if (!res) {
168                 snprintf(meetmeopts, sizeof(meetmeopts), "%ud|A%s%sqxd", confid, (ast_test_flag(&flags, PAGE_DUPLEX) ? "" : "t"), 
169                         (ast_test_flag(&flags, PAGE_RECORD) ? "r" : "") );
170                 pbx_exec(chan, app, meetmeopts);
171         }
172
173         /* Go through each dial attempt cancelling, joining, and destroying */
174         for (i = 0; i < pos; i++) {
175                 struct ast_dial *dial = dials[i];
176
177                 /* We have to wait for the async thread to exit as it's possible Meetme won't throw them out immediately */
178                 ast_dial_join(dial);
179
180                 /* Hangup all channels */
181                 ast_dial_hangup(dial);
182
183                 /* Destroy dialing structure */
184                 ast_dial_destroy(dial);
185         }
186
187         return -1;
188 }
189
190 static int unload_module(void)
191 {
192         return ast_unregister_application(app_page);
193 }
194
195 static int load_module(void)
196 {
197         return ast_register_application(app_page, page_exec, page_synopsis, page_descrip);
198 }
199
200 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Page Multiple Phones");
201