Update osplookup documentation to use commas instead of pipes.
[asterisk/asterisk.git] / res / res_clioriginate.c
index 3069759..3d20e3c 100644 (file)
  * 
  */
 
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
-
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
 
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
-#include "asterisk/logger.h"
 #include "asterisk/module.h"
 #include "asterisk/cli.h"
 #include "asterisk/utils.h"
@@ -43,53 +38,46 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
 /*! The timeout for originated calls, in seconds */
 #define TIMEOUT 30
 
-static struct module_symbols *me;
-
-static char orig_help[] = 
-"  There are two ways to use this command. A call can be originated between a\n"
-"channel and a specific application, or between a channel and an extension in\n"
-"the dialplan. This is similar to call files or the manager originate action.\n"
-"Calls originated with this command are given a timeout of 30 seconds.\n\n"
-
-"Usage1: originate <tech/data> application <appname> [appdata]\n"
-"  This will originate a call between the specified channel tech/data and the\n"
-"given application. Arguments to the application are optional. If the given\n"
-"arguments to the application include spaces, all of the arguments to the\n"
-"application need to be placed in quotation marks.\n\n"
-
-"Usage2: originate <tech/data> extension [exten@][context]\n"
-"  This will originate a call between the specified channel tech/data and the\n"
-"given extension. If no context is specified, the 'default' context will be\n"
-"used. If no extension is given, the 's' extension will be used.\n";
-
-static int handle_orig(int fd, int argc, char *argv[]);
-static char *complete_orig(const char *line, const char *word, int pos, int state);
-
-struct ast_cli_entry cli_orig = { { "originate", NULL }, handle_orig, "Originate a call", orig_help, complete_orig };
-
-static int orig_app(int fd, const char *chan, const char *app, const char *appdata)
+/*!
+ * \brief orginate a call from the CLI
+ * \param fd file descriptor for cli
+ * \param chan channel to create type/data
+ * \param app application you want to run
+ * \param appdata data for application
+ * \retval CLI_SUCCESS on success.
+ * \retval CLI_SHOWUSAGE on failure.
+*/
+static char *orig_app(int fd, const char *chan, const char *app, const char *appdata)
 {
        char *chantech;
        char *chandata;
        int reason = 0;
        
        if (ast_strlen_zero(app))
-               return RESULT_SHOWUSAGE;
+               return CLI_SHOWUSAGE;
 
        chandata = ast_strdupa(chan);
        
        chantech = strsep(&chandata, "/");
        if (!chandata) {
                ast_cli(fd, "*** No data provided after channel type! ***\n");
-               return RESULT_SHOWUSAGE;
+               return CLI_SHOWUSAGE;
        }
 
        ast_pbx_outgoing_app(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, app, appdata, &reason, 1, NULL, NULL, NULL, NULL, NULL);
 
-       return RESULT_SUCCESS;
+       return CLI_SUCCESS;
 }
 
-static int orig_exten(int fd, const char *chan, const char *data)
+/*!
+ * \brief orginate from extension
+ * \param fd file descriptor for cli
+ * \param chan channel to create type/data
+ * \param data contains exten\@context
+ * \retval CLI_SUCCESS on success.
+ * \retval CLI_SHOWUSAGE on failure.
+*/
+static char *orig_exten(int fd, const char *chan, const char *data)
 {
        char *chantech;
        char *chandata;
@@ -102,7 +90,7 @@ static int orig_exten(int fd, const char *chan, const char *data)
        chantech = strsep(&chandata, "/");
        if (!chandata) {
                ast_cli(fd, "*** No data provided after channel type! ***\n");
-               return RESULT_SHOWUSAGE;
+               return CLI_SHOWUSAGE;
        }
 
        if (!ast_strlen_zero(data)) {
@@ -117,64 +105,87 @@ static int orig_exten(int fd, const char *chan, const char *data)
        
        ast_pbx_outgoing_exten(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, context, exten, 1, &reason, 1, NULL, NULL, NULL, NULL, NULL);
 
-       return RESULT_SUCCESS;
+       return CLI_SUCCESS;
 }
 
-static int handle_orig(int fd, int argc, char *argv[])
+/*!
+ * \brief handle for orgination app or exten.
+ * \param e pointer to the CLI structure to initialize
+ * \param cmd operation to execute
+ * \param a structure that contains either application or extension arguments
+ * \retval CLI_SUCCESS on success.
+ * \retval CLI_SHOWUSAGE on failure.
+*/
+static char *handle_orig(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
-       int res;
-
-       if (ast_strlen_zero(argv[1]) || ast_strlen_zero(argv[2]))
-               return RESULT_SHOWUSAGE;
-
-       ast_atomic_fetchadd_int(&me->usecnt, +1);
-
-       if (!strcasecmp("application", argv[2])) {
-               res = orig_app(fd, argv[1], argv[3], argv[4]);  
-       } else if (!strcasecmp("extension", argv[2])) {
-               res = orig_exten(fd, argv[1], argv[3]);
-       } else
-               res = RESULT_SHOWUSAGE;
+       static char *choices[] = { "application", "extension", NULL };
+       char *res;
+       switch (cmd) {
+       case CLI_INIT:
+               e->command = "originate";
+               e->usage = 
+                       "  There are two ways to use this command. A call can be originated between a\n"
+                       "channel and a specific application, or between a channel and an extension in\n"
+                       "the dialplan. This is similar to call files or the manager originate action.\n"
+                       "Calls originated with this command are given a timeout of 30 seconds.\n\n"
+
+                       "Usage1: originate <tech/data> application <appname> [appdata]\n"
+                       "  This will originate a call between the specified channel tech/data and the\n"
+                       "given application. Arguments to the application are optional. If the given\n"
+                       "arguments to the application include spaces, all of the arguments to the\n"
+                       "application need to be placed in quotation marks.\n\n"
+
+                       "Usage2: originate <tech/data> extension [exten@][context]\n"
+                       "  This will originate a call between the specified channel tech/data and the\n"
+                       "given extension. If no context is specified, the 'default' context will be\n"
+                       "used. If no extension is given, the 's' extension will be used.\n";
+               return NULL;
+       case CLI_GENERATE:
+               if (a->pos != 2)
+                       return NULL;
 
-       ast_atomic_fetchadd_int(&me->usecnt, -1);
+               /* ugly, can be removed when CLI entries have ast_module pointers */
+               ast_module_ref(ast_module_info->self);
+               res = ast_cli_complete(a->word, choices, a->n);
+               ast_module_unref(ast_module_info->self);
 
-       return res;
-}
+               return res;
+       }
 
-static char *complete_orig(const char *line, const char *word, int pos, int state)
-{
-       static char *choices[] = { "application", "extension", NULL };
-       char *ret;
+       if (ast_strlen_zero(a->argv[1]) || ast_strlen_zero(a->argv[2]))
+               return CLI_SHOWUSAGE;
 
-       if (pos != 2)
-               return NULL;
+       /* ugly, can be removed when CLI entries have ast_module pointers */
+       ast_module_ref(ast_module_info->self);
 
-       ast_atomic_fetchadd_int(&me->usecnt, +1);
-       ret = ast_cli_complete(word, choices, state);
-       ast_atomic_fetchadd_int(&me->usecnt, -1);
+       if (!strcasecmp("application", a->argv[2])) {
+               res = orig_app(a->fd, a->argv[1], a->argv[3], a->argv[4]);      
+       } else if (!strcasecmp("extension", a->argv[2])) {
+               res = orig_exten(a->fd, a->argv[1], a->argv[3]);
+       } else
+               res = CLI_SHOWUSAGE;
 
-       return ret;
-}
+       ast_module_unref(ast_module_info->self);
 
-static int unload_module(void *mod)
-{
-       return ast_cli_unregister(&cli_orig);
+       return res;
 }
 
-static int load_module(void *mod)
-{
-       me = mod;
-       return ast_cli_register(&cli_orig);
-}
+static struct ast_cli_entry cli_cliorig[] = {
+       AST_CLI_DEFINE(handle_orig, "Originate a call"),
+};
 
-static const char *description(void)
+/*! \brief Unload orginate module */
+static int unload_module(void)
 {
-       return "Call origination from the CLI";
+       return ast_cli_unregister_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
 }
 
-static const char *key(void)
+/*! \brief Load orginate module */
+static int load_module(void)
 {
-       return ASTERISK_GPL_KEY;
+       int res;
+       res = ast_cli_register_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
+       return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
 }
 
-STD_MOD(MOD_0 | NO_USECOUNT, NULL, NULL, NULL);
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call origination from the CLI");