Switch from AST_CLI (formerly NEW_CLI) to AST_CLI_DEFINE, since the former didn't...
[asterisk/asterisk.git] / res / res_clioriginate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005 - 2006, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! 
20  * \file
21  * \author Russell Bryant <russell@digium.com>
22  *
23  * \brief Originate calls via the CLI
24  * 
25  */
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
30
31 #include <stdlib.h>
32 #include <stdio.h>
33 #include <string.h>
34
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/module.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/frame.h"
42
43 /*! The timeout for originated calls, in seconds */
44 #define TIMEOUT 30
45
46 /*!
47  * \brief orginate a call from the CLI
48  * \param fd file descriptor for cli
49  * \param chan channel to create type/data
50  * \param app application you want to run
51  * \param appdata data for application
52  * \retval CLI_SUCCESS on success.
53  * \retval CLI_SHOWUSAGE on failure.
54 */
55 static char *orig_app(int fd, const char *chan, const char *app, const char *appdata)
56 {
57         char *chantech;
58         char *chandata;
59         int reason = 0;
60         
61         if (ast_strlen_zero(app))
62                 return CLI_SHOWUSAGE;
63
64         chandata = ast_strdupa(chan);
65         
66         chantech = strsep(&chandata, "/");
67         if (!chandata) {
68                 ast_cli(fd, "*** No data provided after channel type! ***\n");
69                 return CLI_SHOWUSAGE;
70         }
71
72         ast_pbx_outgoing_app(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, app, appdata, &reason, 1, NULL, NULL, NULL, NULL, NULL);
73
74         return CLI_SUCCESS;
75 }
76
77 /*!
78  * \brief orginate from extension
79  * \param fd file descriptor for cli
80  * \param chan channel to create type/data
81  * \param data contains exten\@context
82  * \retval CLI_SUCCESS on success.
83  * \retval CLI_SHOWUSAGE on failure.
84 */
85 static char *orig_exten(int fd, const char *chan, const char *data)
86 {
87         char *chantech;
88         char *chandata;
89         char *exten = NULL;
90         char *context = NULL;
91         int reason = 0;
92
93         chandata = ast_strdupa(chan);
94         
95         chantech = strsep(&chandata, "/");
96         if (!chandata) {
97                 ast_cli(fd, "*** No data provided after channel type! ***\n");
98                 return CLI_SHOWUSAGE;
99         }
100
101         if (!ast_strlen_zero(data)) {
102                 context = ast_strdupa(data);
103                 exten = strsep(&context, "@");
104         }
105
106         if (ast_strlen_zero(exten))
107                 exten = "s";
108         if (ast_strlen_zero(context))
109                 context = "default";
110         
111         ast_pbx_outgoing_exten(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, context, exten, 1, &reason, 1, NULL, NULL, NULL, NULL, NULL);
112
113         return CLI_SUCCESS;
114 }
115
116 /*!
117  * \brief handle for orgination app or exten.
118  * \param e pointer to the CLI structure to initialize
119  * \param cmd operation to execute
120  * \param a structure that contains either application or extension arguements
121  * \retval CLI_SUCCESS on success.
122  * \retval CLI_SHOWUSAGE  on failure.
123 */
124 static char *handle_orig(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
125 {
126         static char *choices[] = { "application", "extension", NULL };
127         char *res;
128         switch (cmd) {
129         case CLI_INIT:
130                 e->command = "originate";
131                 e->usage = 
132                         "  There are two ways to use this command. A call can be originated between a\n"
133                         "channel and a specific application, or between a channel and an extension in\n"
134                         "the dialplan. This is similar to call files or the manager originate action.\n"
135                         "Calls originated with this command are given a timeout of 30 seconds.\n\n"
136
137                         "Usage1: originate <tech/data> application <appname> [appdata]\n"
138                         "  This will originate a call between the specified channel tech/data and the\n"
139                         "given application. Arguments to the application are optional. If the given\n"
140                         "arguments to the application include spaces, all of the arguments to the\n"
141                         "application need to be placed in quotation marks.\n\n"
142
143                         "Usage2: originate <tech/data> extension [exten@][context]\n"
144                         "  This will originate a call between the specified channel tech/data and the\n"
145                         "given extension. If no context is specified, the 'default' context will be\n"
146                         "used. If no extension is given, the 's' extension will be used.\n";
147                 return NULL;
148         case CLI_GENERATE:
149                 if (a->pos != 2)
150                         return NULL;
151
152                 /* ugly, can be removed when CLI entries have ast_module pointers */
153                 ast_module_ref(ast_module_info->self);
154                 res = ast_cli_complete(a->word, choices, a->n);
155                 ast_module_unref(ast_module_info->self);
156
157                 return res;
158         }
159
160         if (ast_strlen_zero(a->argv[1]) || ast_strlen_zero(a->argv[2]))
161                 return CLI_SHOWUSAGE;
162
163         /* ugly, can be removed when CLI entries have ast_module pointers */
164         ast_module_ref(ast_module_info->self);
165
166         if (!strcasecmp("application", a->argv[2])) {
167                 res = orig_app(a->fd, a->argv[1], a->argv[3], a->argv[4]);      
168         } else if (!strcasecmp("extension", a->argv[2])) {
169                 res = orig_exten(a->fd, a->argv[1], a->argv[3]);
170         } else
171                 res = CLI_SHOWUSAGE;
172
173         ast_module_unref(ast_module_info->self);
174
175         return res;
176 }
177
178 static struct ast_cli_entry cli_cliorig[] = {
179         AST_CLI_DEFINE(handle_orig, "Originate a call"),
180 };
181
182 /*! \brief Unload orginate module */
183 static int unload_module(void)
184 {
185         ast_cli_unregister_multiple(cli_cliorig, sizeof(cli_cliorig) / sizeof(struct ast_cli_entry));
186         return 0;
187 }
188
189 /*! \brief Load orginate module */
190 static int load_module(void)
191 {
192         ast_cli_register_multiple(cli_cliorig, sizeof(cli_cliorig) / sizeof(struct ast_cli_entry));
193         return 0;
194 }
195
196 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call origination from the CLI");