Merge "res_musiconhold: Start playlist after initial announcement"
[asterisk/asterisk.git] / apps / app_url.c
old mode 100755 (executable)
new mode 100644 (file)
index 53a5894..185712d
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * App to transmit a URL
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2005, Digium, Inc.
+ *
+ * Mark Spencer <markster@digium.com>
  *
- * Mark Spencer <markster@linux-support.net>
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
  *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief App to transmit a URL
+ *
+ * \author Mark Spencer <markster@digium.com>
+ * 
+ * \ingroup applications
  */
-#include <asterisk/lock.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/channel.h>
-#include <asterisk/pbx.h>
-#include <asterisk/module.h>
-#include <asterisk/translate.h>
-#include <asterisk/image.h>
-#include <string.h>
-#include <stdlib.h>
-#include <pthread.h>
 
-static char *tdesc = "Send URL Applications";
+/*** MODULEINFO
+       <support_level>extended</support_level>
+ ***/
+#include "asterisk.h"
 
-static char *app = "SendURL";
+#include "asterisk/pbx.h"
+#include "asterisk/module.h"
+#include "asterisk/app.h"
+#include "asterisk/channel.h"
 
-static char *synopsis = "Send a URL";
+/*** DOCUMENTATION
+       <application name="SendURL" language="en_US">
+               <synopsis>
+                       Send a URL.
+               </synopsis>
+               <syntax>
+                       <parameter name="URL" required="true" />
+                       <parameter name="option">
+                               <optionlist>
+                                       <option name="w">
+                                               <para>Execution will wait for an acknowledgement that the
+                                               URL has been loaded before continuing.</para>
+                                       </option>
+                               </optionlist>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Requests client go to <replaceable>URL</replaceable> (IAX2) or sends the
+                       URL to the client (other channels).</para>
+                       <para>Result is returned in the <variable>SENDURLSTATUS</variable> channel variable:</para>
+                       <variablelist>
+                               <variable name="SENDURLSTATUS">
+                                       <value name="SUCCESS">
+                                               URL successfully sent to client.
+                                       </value>
+                                       <value name="FAILURE">
+                                               Failed to send URL.
+                                       </value>
+                                       <value name="NOLOAD">
+                                               Client failed to load URL (wait enabled).
+                                       </value>
+                                       <value name="UNSUPPORTED">
+                                               Channel does not support URL transport.
+                                       </value>
+                               </variable>
+                       </variablelist>
+                       <para>SendURL continues normally if the URL was sent correctly or if the channel
+                       does not support HTML transport.  Otherwise, the channel is hung up.</para>
+               </description>
+               <see-also>
+                       <ref type="application">SendImage</ref>
+                       <ref type="application">SendText</ref>
+               </see-also>
+       </application>
+ ***/
 
-static char *descrip = 
-"  SendURL(URL[|option]): Requests client go to URL.  If the client\n"
-"does not support html transport, and  there  exists  a  step  with\n"
-"priority  n + 101,  then  execution  will  continue  at that step.\n"
-"Otherwise, execution will continue at  the  next  priority  level.\n"
-"SendURL only returns 0  if  the  URL  was  sent  correctly  or  if\n"
-"the channel  does  not  support HTML transport,  and -1 otherwise.\n"
-"If the option 'wait' is  specified,  execution  will  wait  for an\n"
-"acknowledgement that  the  URL  has  been loaded before continuing\n"
-"and will return -1 if the peer is unable to load the URL\n";
+static char *app = "SendURL";
 
-STANDARD_LOCAL_USER;
+enum option_flags {
+       OPTION_WAIT = (1 << 0),
+};
 
-LOCAL_USER_DECL;
+AST_APP_OPTIONS(app_opts,{
+       AST_APP_OPTION('w', OPTION_WAIT),
+});
 
-static int sendurl_exec(struct ast_channel *chan, void *data)
+static int sendurl_exec(struct ast_channel *chan, const char *data)
 {
        int res = 0;
-       struct localuser *u;
-       char tmp[256];
-       char *options;
-       int option_wait=0;
+       char *tmp;
        struct ast_frame *f;
-       if (!data || !strlen((char *)data)) {
+       char *status = "FAILURE";
+       char *opts[0];
+       struct ast_flags flags = { 0 };
+       AST_DECLARE_APP_ARGS(args,
+               AST_APP_ARG(url);
+               AST_APP_ARG(options);
+       );
+       
+       if (ast_strlen_zero(data)) {
                ast_log(LOG_WARNING, "SendURL requires an argument (URL)\n");
+               pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", status);
                return -1;
        }
-       strncpy(tmp, (char *)data, sizeof(tmp)-1);
-       strtok(tmp, "|");
-       options = strtok(NULL, "|");
-       if (options && !strcasecmp(options, "wait"))
-               option_wait = 1;
-       LOCAL_USER_ADD(u);
+
+       tmp = ast_strdupa(data);
+
+       AST_STANDARD_APP_ARGS(args, tmp);
+       if (args.argc == 2)
+               ast_app_parse_options(app_opts, &flags, opts, args.options);
+       
        if (!ast_channel_supports_html(chan)) {
                /* Does not support transport */
-               if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 101, chan->callerid))
-                       chan->priority += 100;
-               LOCAL_USER_REMOVE(u);
+               pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", "UNSUPPORTED");
                return 0;
        }
-       res = ast_channel_sendurl(chan, tmp);
-       if (res > -1) {
-               if (option_wait) {
-                       for(;;) {
-                               /* Wait for an event */
-                               res = ast_waitfor(chan, -1);
-                               if (res < 0) 
+       res = ast_channel_sendurl(chan, args.url);
+       if (res == -1) {
+               pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", "FAILURE");
+               return res;
+       }
+       status = "SUCCESS";
+       if (ast_test_flag(&flags, OPTION_WAIT)) {
+               for(;;) {
+                       /* Wait for an event */
+                       res = ast_waitfor(chan, -1);
+                       if (res < 0) 
+                               break;
+                       f = ast_read(chan);
+                       if (!f) {
+                               res = -1;
+                               status = "FAILURE";
+                               break;
+                       }
+                       if (f->frametype == AST_FRAME_HTML) {
+                               switch (f->subclass.integer) {
+                               case AST_HTML_LDCOMPLETE:
+                                       res = 0;
+                                       ast_frfree(f);
+                                       status = "NOLOAD";
+                                       goto out;
                                        break;
-                               f = ast_read(chan);
-                               if (!f) {
-                                       res = -1;
+                               case AST_HTML_NOSUPPORT:
+                                       /* Does not support transport */
+                                       status = "UNSUPPORTED";
+                                       res = 0;
+                                       ast_frfree(f);
+                                       goto out;
                                        break;
-                               }
-                               if (f->frametype == AST_FRAME_HTML) {
-                                       switch(f->subclass) {
-                                       case AST_HTML_LDCOMPLETE:
-                                               res = 0;
-                                               ast_frfree(f);
-                                               goto out;
-                                               break;
-                                       case AST_HTML_NOSUPPORT:
-                                               /* Does not support transport */
-                                               if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 101, chan->callerid))
-                                                       chan->priority += 100;
-                                               res = 0;
-                                               goto out;
-                                               break;
-                                       default:
-                                               ast_log(LOG_WARNING, "Don't know what to do with HTML subclass %d\n", f->subclass);
-                                       };
-                               }
-                               ast_frfree(f);
+                               default:
+                                       ast_log(LOG_WARNING, "Don't know what to do with HTML subclass %d\n", f->subclass.integer);
+                               };
                        }
+                       ast_frfree(f);
                }
-       }
+       } 
 out:   
-       LOCAL_USER_REMOVE(u);
+       pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", status);
        return res;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
-       STANDARD_HANGUP_LOCALUSERS;
        return ast_unregister_application(app);
 }
 
-int load_module(void)
-{
-       return ast_register_application(app, sendurl_exec, synopsis, descrip);
-}
-
-char *description(void)
+static int load_module(void)
 {
-       return tdesc;
+       return ast_register_application_xml(app, sendurl_exec);
 }
 
-int usecount(void)
-{
-       int res;
-       STANDARD_USECOUNT(res);
-       return res;
-}
+AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Send URL Applications");
 
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}