Mon Mar 12 2012 21:25:21

Asterisk developer's documentation


app_url.c File Reference

App to transmit a URL. More...

#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/channel.h"
Include dependency graph for app_url.c:

Go to the source code of this file.

Enumerations

enum  option_flags {
  OPTION_A = (1 << 0), OPTION_B = (1 << 1), OPTION_C = (1 << 2), OPTION_WAIT = (1 << 0),
  OPTION_PATTERNS_DISABLED = (1 << 0)
}

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
static int sendurl_exec (struct ast_channel *chan, const char *data)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send URL Applications" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static char * app = "SendURL"
static struct ast_app_option app_opts [128] = { [ 'w' ] = { .flag = OPTION_WAIT },}
static struct ast_module_infoast_module_info = &__mod_info

Detailed Description

App to transmit a URL.

Author:
Mark Spencer <markster@digium.com>

Definition in file app_url.c.


Enumeration Type Documentation

Enumerator:
OPTION_A 
OPTION_B 
OPTION_C 
OPTION_WAIT 
OPTION_PATTERNS_DISABLED 

Definition at line 89 of file app_url.c.

                  {
   OPTION_WAIT = (1 << 0),
};

Function Documentation

static void __reg_module ( void  ) [static]

Definition at line 182 of file app_url.c.

static void __unreg_module ( void  ) [static]

Definition at line 182 of file app_url.c.

static int load_module ( void  ) [static]

Definition at line 177 of file app_url.c.

References ast_register_application_xml, and sendurl_exec().

static int sendurl_exec ( struct ast_channel chan,
const char *  data 
) [static]

Definition at line 97 of file app_url.c.

References app_opts, args, AST_APP_ARG, ast_app_parse_options(), ast_channel_sendurl(), ast_channel_supports_html(), AST_DECLARE_APP_ARGS, AST_FRAME_HTML, ast_frfree, AST_HTML_LDCOMPLETE, AST_HTML_NOSUPPORT, ast_log(), ast_read(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_waitfor(), f, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, OPTION_WAIT, pbx_builtin_setvar_helper(), status, ast_frame::subclass, and url.

Referenced by load_module().

{
   int res = 0;
   char *tmp;
   struct ast_frame *f;
   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;
   }

   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 */
      pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", "UNSUPPORTED");
      return 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;
            case AST_HTML_NOSUPPORT:
               /* Does not support transport */
               status = "UNSUPPORTED";
               res = 0;
               ast_frfree(f);
               goto out;
               break;
            default:
               ast_log(LOG_WARNING, "Don't know what to do with HTML subclass %d\n", f->subclass.integer);
            };
         }
         ast_frfree(f);
      }
   } 
out:  
   pbx_builtin_setvar_helper(chan, "SENDURLSTATUS", status);
   return res;
}
static int unload_module ( void  ) [static]

Definition at line 172 of file app_url.c.

References ast_unregister_application().


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send URL Applications" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static]

Definition at line 182 of file app_url.c.

char* app = "SendURL" [static]

Definition at line 87 of file app_url.c.

struct ast_app_option app_opts[128] = { [ 'w' ] = { .flag = OPTION_WAIT },} [static]

Definition at line 95 of file app_url.c.

Referenced by sendurl_exec().

Definition at line 182 of file app_url.c.