app_page.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (c) 2004 - 2006 Digium, Inc.  All rights reserved.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * This code is released under the GNU General Public License
00009  * version 2.0.  See LICENSE for more information.
00010  *
00011  * See http://www.asterisk.org for more information about
00012  * the Asterisk project. Please do not directly contact
00013  * any of the maintainers of this project for assistance;
00014  * the project provides a web site, mailing lists and IRC
00015  * channels for your use.
00016  *
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief page() - Paging application
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  *
00025  * \ingroup applications
00026  */
00027 
00028 /*** MODULEINFO
00029    <depend>app_confbridge</depend>
00030    <support_level>core</support_level>
00031  ***/
00032 
00033 #include "asterisk.h"
00034 
00035 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 410158 $")
00036 
00037 #include "asterisk/channel.h"
00038 #include "asterisk/pbx.h"
00039 #include "asterisk/module.h"
00040 #include "asterisk/file.h"
00041 #include "asterisk/app.h"
00042 #include "asterisk/chanvars.h"
00043 #include "asterisk/utils.h"
00044 #include "asterisk/devicestate.h"
00045 #include "asterisk/dial.h"
00046 
00047 /*** DOCUMENTATION
00048    <application name="Page" language="en_US">
00049       <synopsis>
00050          Page series of phones
00051       </synopsis>
00052       <syntax>
00053          <parameter name="Technology/Resource" required="true" argsep="&amp;">
00054             <argument name="Technology/Resource" required="true">
00055                <para>Specification of the device(s) to dial. These must be in the format of
00056                <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
00057                represents a particular channel driver, and <replaceable>Resource</replaceable> represents a resource
00058                available to that particular channel driver.</para>
00059             </argument>
00060             <argument name="Technology2/Resource2" multiple="true">
00061                <para>Optional extra devices to dial in parallel</para>
00062                <para>If you need more than one, enter them as Technology2/Resource2&amp;
00063                Technology3/Resourse3&amp;.....</para>
00064             </argument>
00065          </parameter>
00066          <parameter name="options">
00067             <optionlist>
00068             <option name="b" argsep="^">
00069                <para>Before initiating an outgoing call, Gosub to the specified
00070                location using the newly created channel.  The Gosub will be
00071                executed for each destination channel.</para>
00072                <argument name="context" required="false" />
00073                <argument name="exten" required="false" />
00074                <argument name="priority" required="true" hasparams="optional" argsep="^">
00075                   <argument name="arg1" multiple="true" required="true" />
00076                   <argument name="argN" />
00077                </argument>
00078             </option>
00079             <option name="B" argsep="^">
00080                <para>Before initiating the outgoing call(s), Gosub to the specified
00081                location using the current channel.</para>
00082                <argument name="context" required="false" />
00083                <argument name="exten" required="false" />
00084                <argument name="priority" required="true" hasparams="optional" argsep="^">
00085                   <argument name="arg1" multiple="true" required="true" />
00086                   <argument name="argN" />
00087                </argument>
00088             </option>
00089                <option name="d">
00090                   <para>Full duplex audio</para>
00091                </option>
00092                <option name="i">
00093                   <para>Ignore attempts to forward the call</para>
00094                </option>
00095                <option name="q">
00096                   <para>Quiet, do not play beep to caller</para>
00097                </option>
00098                <option name="r">
00099                   <para>Record the page into a file (<literal>CONFBRIDGE(bridge,record_conference)</literal>)</para>
00100                </option>
00101                <option name="s">
00102                   <para>Only dial a channel if its device state says that it is <literal>NOT_INUSE</literal></para>
00103                </option>
00104                <option name="A">
00105                   <argument name="x" required="true">
00106                      <para>The announcement to playback to all devices</para>
00107                   </argument>
00108                   <para>Play an announcement to all paged participants</para>
00109                </option>
00110                <option name="n">
00111                   <para>Do not play announcement to caller (alters <literal>A(x)</literal> behavior)</para>
00112                </option>
00113             </optionlist>
00114          </parameter>
00115          <parameter name="timeout">
00116             <para>Specify the length of time that the system will attempt to connect a call.
00117             After this duration, any page calls that have not been answered will be hung up by the
00118             system.</para>
00119          </parameter>
00120       </syntax>
00121       <description>
00122          <para>Places outbound calls to the given <replaceable>technology</replaceable>/<replaceable>resource</replaceable>
00123          and dumps them into a conference bridge as muted participants. The original
00124          caller is dumped into the conference as a speaker and the room is
00125          destroyed when the original caller leaves.</para>
00126       </description>
00127       <see-also>
00128          <ref type="application">ConfBridge</ref>
00129       </see-also>
00130    </application>
00131  ***/
00132 static const char * const app_page= "Page";
00133 
00134 enum page_opt_flags {
00135    PAGE_DUPLEX = (1 << 0),
00136    PAGE_QUIET = (1 << 1),
00137    PAGE_RECORD = (1 << 2),
00138    PAGE_SKIP = (1 << 3),
00139    PAGE_IGNORE_FORWARDS = (1 << 4),
00140    PAGE_ANNOUNCE = (1 << 5),
00141    PAGE_NOCALLERANNOUNCE = (1 << 6),
00142    PAGE_PREDIAL_CALLEE = (1 << 7),
00143    PAGE_PREDIAL_CALLER = (1 << 8),
00144 };
00145 
00146 enum {
00147    OPT_ARG_ANNOUNCE = 0,
00148    OPT_ARG_PREDIAL_CALLEE = 1,
00149    OPT_ARG_PREDIAL_CALLER = 2,
00150    OPT_ARG_ARRAY_SIZE = 3,
00151 };
00152 
00153 AST_APP_OPTIONS(page_opts, {
00154    AST_APP_OPTION_ARG('b', PAGE_PREDIAL_CALLEE, OPT_ARG_PREDIAL_CALLEE),
00155    AST_APP_OPTION_ARG('B', PAGE_PREDIAL_CALLER, OPT_ARG_PREDIAL_CALLER),
00156    AST_APP_OPTION('d', PAGE_DUPLEX),
00157    AST_APP_OPTION('q', PAGE_QUIET),
00158    AST_APP_OPTION('r', PAGE_RECORD),
00159    AST_APP_OPTION('s', PAGE_SKIP),
00160    AST_APP_OPTION('i', PAGE_IGNORE_FORWARDS),
00161    AST_APP_OPTION_ARG('A', PAGE_ANNOUNCE, OPT_ARG_ANNOUNCE),
00162    AST_APP_OPTION('n', PAGE_NOCALLERANNOUNCE),
00163 });
00164 
00165 /* We use this structure as a way to pass this to all dialed channels */
00166 struct page_options {
00167    char *opts[OPT_ARG_ARRAY_SIZE];
00168    struct ast_flags flags;
00169 };
00170 
00171 /*!
00172  * \internal
00173  * \brief Setup the page bridge profile.
00174  *
00175  * \param chan Setup bridge profile on this channel.
00176  * \param options Options to setup bridge profile.
00177  *
00178  * \return Nothing
00179  */
00180 static void setup_profile_bridge(struct ast_channel *chan, struct page_options *options)
00181 {
00182    /* Use default_bridge as a starting point */
00183    ast_func_write(chan, "CONFBRIDGE(bridge,template)", "");
00184    if (ast_test_flag(&options->flags, PAGE_RECORD)) {
00185       ast_func_write(chan, "CONFBRIDGE(bridge,record_conference)", "yes");
00186    }
00187 }
00188 
00189 /*!
00190  * \internal
00191  * \brief Setup the paged user profile.
00192  *
00193  * \param chan Setup user profile on this channel.
00194  * \param options Options to setup paged user profile.
00195  *
00196  * \return Nothing
00197  */
00198 static void setup_profile_paged(struct ast_channel *chan, struct page_options *options)
00199 {
00200    /* Use default_user as a starting point */
00201    ast_func_write(chan, "CONFBRIDGE(user,template)", "");
00202    ast_func_write(chan, "CONFBRIDGE(user,quiet)", "yes");
00203    ast_func_write(chan, "CONFBRIDGE(user,end_marked)", "yes");
00204    if (!ast_test_flag(&options->flags, PAGE_DUPLEX)) {
00205       ast_func_write(chan, "CONFBRIDGE(user,startmuted)", "yes");
00206    }
00207    if (ast_test_flag(&options->flags, PAGE_ANNOUNCE)
00208       && !ast_strlen_zero(options->opts[OPT_ARG_ANNOUNCE])) {
00209       ast_func_write(chan, "CONFBRIDGE(user,announcement)", options->opts[OPT_ARG_ANNOUNCE]);
00210    }
00211 }
00212 
00213 /*!
00214  * \internal
00215  * \brief Setup the caller user profile.
00216  *
00217  * \param chan Setup user profile on this channel.
00218  * \param options Options to setup caller user profile.
00219  *
00220  * \return Nothing
00221  */
00222 static void setup_profile_caller(struct ast_channel *chan, struct page_options *options)
00223 {
00224    /* Use default_user as a starting point if not already setup. */
00225    ast_func_write(chan, "CONFBRIDGE(user,template)", "");
00226    ast_func_write(chan, "CONFBRIDGE(user,quiet)", "yes");
00227    ast_func_write(chan, "CONFBRIDGE(user,marked)", "yes");
00228    if (!ast_test_flag(&options->flags, PAGE_NOCALLERANNOUNCE)
00229       && ast_test_flag(&options->flags, PAGE_ANNOUNCE)
00230       && !ast_strlen_zero(options->opts[OPT_ARG_ANNOUNCE])) {
00231       ast_func_write(chan, "CONFBRIDGE(user,announcement)", options->opts[OPT_ARG_ANNOUNCE]);
00232    }
00233 }
00234 
00235 static void page_state_callback(struct ast_dial *dial)
00236 {
00237    struct ast_channel *chan;
00238    struct page_options *options;
00239 
00240    if (ast_dial_state(dial) != AST_DIAL_RESULT_ANSWERED ||
00241        !(chan = ast_dial_answered(dial)) ||
00242        !(options = ast_dial_get_user_data(dial))) {
00243       return;
00244    }
00245 
00246    setup_profile_bridge(chan, options);
00247    setup_profile_paged(chan, options);
00248 }
00249 
00250 static int page_exec(struct ast_channel *chan, const char *data)
00251 {
00252    char *tech, *resource, *tmp;
00253    char confbridgeopts[128], originator[AST_CHANNEL_NAME];
00254    struct page_options options = { { 0, }, { 0, } };
00255    unsigned int confid = ast_random();
00256    struct ast_app *app;
00257    int res = 0, pos = 0, i = 0;
00258    struct ast_dial **dial_list;
00259    unsigned int num_dials;
00260    int timeout = 0;
00261    char *parse;
00262 
00263    AST_DECLARE_APP_ARGS(args,
00264       AST_APP_ARG(devices);
00265       AST_APP_ARG(options);
00266       AST_APP_ARG(timeout);
00267    );
00268 
00269    if (ast_strlen_zero(data)) {
00270       ast_log(LOG_WARNING, "This application requires at least one argument (destination(s) to page)\n");
00271       return -1;
00272    }
00273 
00274    if (!(app = pbx_findapp("ConfBridge"))) {
00275       ast_log(LOG_WARNING, "There is no ConfBridge application available!\n");
00276       return -1;
00277    };
00278 
00279    parse = ast_strdupa(data);
00280 
00281    AST_STANDARD_APP_ARGS(args, parse);
00282 
00283    ast_copy_string(originator, ast_channel_name(chan), sizeof(originator));
00284    if ((tmp = strchr(originator, '-'))) {
00285       *tmp = '\0';
00286    }
00287 
00288    if (!ast_strlen_zero(args.options)) {
00289       ast_app_parse_options(page_opts, &options.flags, options.opts, args.options);
00290    }
00291 
00292    if (!ast_strlen_zero(args.timeout)) {
00293       timeout = atoi(args.timeout);
00294    }
00295 
00296    snprintf(confbridgeopts, sizeof(confbridgeopts), "ConfBridge,%u", confid);
00297 
00298    /* Count number of extensions in list by number of ampersands + 1 */
00299    num_dials = 1;
00300    tmp = args.devices;
00301    while (*tmp) {
00302       if (*tmp == '&') {
00303          num_dials++;
00304       }
00305       tmp++;
00306    }
00307 
00308    if (!(dial_list = ast_calloc(num_dials, sizeof(struct ast_dial *)))) {
00309       ast_log(LOG_ERROR, "Can't allocate %ld bytes for dial list\n", (long)(sizeof(struct ast_dial *) * num_dials));
00310       return -1;
00311    }
00312 
00313    if (ast_test_flag(&options.flags, PAGE_PREDIAL_CALLER)
00314       && !ast_strlen_zero(options.opts[OPT_ARG_PREDIAL_CALLER])) {
00315       ast_replace_subargument_delimiter(options.opts[OPT_ARG_PREDIAL_CALLER]);
00316       ast_app_exec_sub(NULL, chan, options.opts[OPT_ARG_PREDIAL_CALLER], 0);
00317    }
00318 
00319    /* Go through parsing/calling each device */
00320    while ((tech = strsep(&args.devices, "&"))) {
00321       int state = 0;
00322       struct ast_dial *dial = NULL;
00323 
00324       /* don't call the originating device */
00325       if (!strcasecmp(tech, originator))
00326          continue;
00327 
00328       /* If no resource is available, continue on */
00329       if (!(resource = strchr(tech, '/'))) {
00330          ast_log(LOG_WARNING, "Incomplete destination '%s' supplied.\n", tech);
00331          continue;
00332       }
00333 
00334       /* Ensure device is not in use if skip option is enabled */
00335       if (ast_test_flag(&options.flags, PAGE_SKIP)) {
00336          state = ast_device_state(tech);
00337          if (state == AST_DEVICE_UNKNOWN) {
00338             ast_log(LOG_WARNING, "Destination '%s' has device state '%s'. Paging anyway.\n", tech, ast_devstate2str(state));
00339          } else if (state != AST_DEVICE_NOT_INUSE) {
00340             ast_log(LOG_WARNING, "Destination '%s' has device state '%s'.\n", tech, ast_devstate2str(state));
00341             continue;
00342          }
00343       }
00344 
00345       *resource++ = '\0';
00346 
00347       /* Create a dialing structure */
00348       if (!(dial = ast_dial_create())) {
00349          ast_log(LOG_WARNING, "Failed to create dialing structure.\n");
00350          continue;
00351       }
00352 
00353       /* Append technology and resource */
00354       if (ast_dial_append(dial, tech, resource, NULL) == -1) {
00355          ast_log(LOG_ERROR, "Failed to add %s to outbound dial\n", tech);
00356          ast_dial_destroy(dial);
00357          continue;
00358       }
00359 
00360       /* Set ANSWER_EXEC as global option */
00361       ast_dial_option_global_enable(dial, AST_DIAL_OPTION_ANSWER_EXEC, confbridgeopts);
00362 
00363       if (ast_test_flag(&options.flags, PAGE_PREDIAL_CALLEE)
00364          && !ast_strlen_zero(options.opts[OPT_ARG_PREDIAL_CALLEE])) {
00365          ast_dial_option_global_enable(dial, AST_DIAL_OPTION_PREDIAL, options.opts[OPT_ARG_PREDIAL_CALLEE]);
00366       }
00367 
00368       if (timeout) {
00369          ast_dial_set_global_timeout(dial, timeout * 1000);
00370       }
00371 
00372       if (ast_test_flag(&options.flags, PAGE_IGNORE_FORWARDS)) {
00373          ast_dial_option_global_enable(dial, AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, NULL);
00374       }
00375 
00376       ast_dial_set_state_callback(dial, &page_state_callback);
00377       ast_dial_set_user_data(dial, &options);
00378 
00379       /* Run this dial in async mode */
00380       ast_dial_run(dial, chan, 1);
00381 
00382       /* Put in our dialing array */
00383       dial_list[pos++] = dial;
00384    }
00385 
00386    if (!ast_test_flag(&options.flags, PAGE_QUIET)) {
00387       res = ast_streamfile(chan, "beep", ast_channel_language(chan));
00388       if (!res)
00389          res = ast_waitstream(chan, "");
00390    }
00391 
00392    if (!res) {
00393       setup_profile_bridge(chan, &options);
00394       setup_profile_caller(chan, &options);
00395 
00396       snprintf(confbridgeopts, sizeof(confbridgeopts), "%u", confid);
00397       pbx_exec(chan, app, confbridgeopts);
00398    }
00399 
00400    /* Go through each dial attempt cancelling, joining, and destroying */
00401    for (i = 0; i < pos; i++) {
00402       struct ast_dial *dial = dial_list[i];
00403 
00404       /* We have to wait for the async thread to exit as it's possible ConfBridge won't throw them out immediately */
00405       ast_dial_join(dial);
00406 
00407       /* Hangup all channels */
00408       ast_dial_hangup(dial);
00409 
00410       /* Destroy dialing structure */
00411       ast_dial_destroy(dial);
00412    }
00413 
00414    ast_free(dial_list);
00415 
00416    return -1;
00417 }
00418 
00419 static int unload_module(void)
00420 {
00421    return ast_unregister_application(app_page);
00422 }
00423 
00424 static int load_module(void)
00425 {
00426    return ast_register_application_xml(app_page, page_exec);
00427 }
00428 
00429 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Page Multiple Phones");
00430 

Generated on Thu Apr 16 06:27:11 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6