git migration: Refactor the ASTERISK_FILE_VERSION macro
[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 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_REGISTER_FILE();
34
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/cli.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/frame.h"
41 #include "asterisk/format_cache.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         struct ast_format_cap *cap;
61
62         if (ast_strlen_zero(app))
63                 return CLI_SHOWUSAGE;
64
65         chandata = ast_strdupa(chan);
66
67         chantech = strsep(&chandata, "/");
68         if (!chandata) {
69                 ast_cli(fd, "*** No data provided after channel type! ***\n");
70                 return CLI_SHOWUSAGE;
71         }
72
73         if (!(cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
74                 return CLI_FAILURE;
75         }
76         ast_format_cap_append(cap, ast_format_slin, 0);
77         ast_pbx_outgoing_app(chantech, cap, chandata, TIMEOUT * 1000, app, appdata, &reason, 0, NULL, NULL, NULL, NULL, NULL, NULL);
78         ao2_ref(cap, -1);
79
80         return CLI_SUCCESS;
81 }
82
83 /*!
84  * \brief orginate from extension
85  * \param fd file descriptor for cli
86  * \param chan channel to create type/data
87  * \param data contains exten\@context
88  * \retval CLI_SUCCESS on success.
89  * \retval CLI_SHOWUSAGE on failure.
90 */
91 static char *orig_exten(int fd, const char *chan, const char *data)
92 {
93         char *chantech;
94         char *chandata;
95         char *exten = NULL;
96         char *context = NULL;
97         int reason = 0;
98         struct ast_format_cap *cap;
99
100         chandata = ast_strdupa(chan);
101
102         chantech = strsep(&chandata, "/");
103         if (!chandata) {
104                 ast_cli(fd, "*** No data provided after channel type! ***\n");
105                 return CLI_SHOWUSAGE;
106         }
107
108         if (!ast_strlen_zero(data)) {
109                 context = ast_strdupa(data);
110                 exten = strsep(&context, "@");
111         }
112
113         if (ast_strlen_zero(exten))
114                 exten = "s";
115         if (ast_strlen_zero(context))
116                 context = "default";
117         if (!(cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
118                 return CLI_FAILURE;
119         }
120         ast_format_cap_append(cap, ast_format_slin, 0);
121         ast_pbx_outgoing_exten(chantech, cap, chandata, TIMEOUT * 1000, context, exten, 1, &reason, 0, NULL, NULL, NULL, NULL, NULL, 0, NULL);
122         ao2_ref(cap, -1);
123
124         return CLI_SUCCESS;
125 }
126
127 /*!
128  * \brief handle for orgination app or exten.
129  * \param e pointer to the CLI structure to initialize
130  * \param cmd operation to execute
131  * \param a structure that contains either application or extension arguments
132  * \retval CLI_SUCCESS on success.
133  * \retval CLI_SHOWUSAGE on failure.*/
134 static char *handle_orig(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
135 {
136         static const char * const choices[] = { "application", "extension", NULL };
137         char *res = NULL;
138         switch (cmd) {
139         case CLI_INIT:
140                 e->command = "channel originate";
141                 e->usage =
142                         "  There are two ways to use this command. A call can be originated between a\n"
143                         "channel and a specific application, or between a channel and an extension in\n"
144                         "the dialplan. This is similar to call files or the manager originate action.\n"
145                         "Calls originated with this command are given a timeout of 30 seconds.\n\n"
146
147                         "Usage1: channel originate <tech/data> application <appname> [appdata]\n"
148                         "  This will originate a call between the specified channel tech/data and the\n"
149                         "given application. Arguments to the application are optional. If the given\n"
150                         "arguments to the application include spaces, all of the arguments to the\n"
151                         "application need to be placed in quotation marks.\n\n"
152
153                         "Usage2: channel originate <tech/data> extension [exten@][context]\n"
154                         "  This will originate a call between the specified channel tech/data and the\n"
155                         "given extension. If no context is specified, the 'default' context will be\n"
156                         "used. If no extension is given, the 's' extension will be used.\n";
157                 return NULL;
158         case CLI_GENERATE:
159                 /* ugly, can be removed when CLI entries have ast_module pointers */
160                 ast_module_ref(ast_module_info->self);
161                 if (a->pos == 3) {
162                         res = ast_cli_complete(a->word, choices, a->n);
163                 } else if (a->pos == 4) {
164                         if (!strcasecmp("application", a->argv[3])) {
165                                 res = ast_complete_applications(a->line, a->word, a->n);
166                         }
167                 }
168                 ast_module_unref(ast_module_info->self);
169                 return res;
170         }
171
172         if (ast_strlen_zero(a->argv[2]) || ast_strlen_zero(a->argv[3]))
173                 return CLI_SHOWUSAGE;
174
175         /* ugly, can be removed when CLI entries have ast_module pointers */
176         ast_module_ref(ast_module_info->self);
177
178         if (!strcasecmp("application", a->argv[3])) {
179                 res = orig_app(a->fd, a->argv[2], a->argv[4], a->argv[5]);
180         } else if (!strcasecmp("extension", a->argv[3])) {
181                 res = orig_exten(a->fd, a->argv[2], a->argv[4]);
182         } else {
183                 res = CLI_SHOWUSAGE;
184         }
185
186         ast_module_unref(ast_module_info->self);
187
188         return res;
189 }
190
191 static char *handle_redirect(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
192 {
193         const char *name, *dest;
194         struct ast_channel *chan;
195         int res;
196
197         switch (cmd) {
198         case CLI_INIT:
199                 e->command = "channel redirect";
200                 e->usage = ""
201                 "Usage: channel redirect <channel> <[[context,]exten,]priority>\n"
202                 "    Redirect an active channel to a specified extension.\n";
203                 /*! \todo It would be nice to be able to redirect 2 channels at the same
204                  *  time like you can with AMI redirect.  However, it is not possible to acquire
205                  *  two channels without the potential for a deadlock with how ast_channel structs
206                  *  are managed today.  Once ast_channel is a refcounted object, this command
207                  *  will be able to support that. */
208                 return NULL;
209         case CLI_GENERATE:
210                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 2);
211         }
212
213         if (a->argc != e->args + 2) {
214                 return CLI_SHOWUSAGE;
215         }
216
217         name = a->argv[2];
218         dest = a->argv[3];
219
220         if (!(chan = ast_channel_get_by_name(name))) {
221                 ast_cli(a->fd, "Channel '%s' not found\n", name);
222                 return CLI_FAILURE;
223         }
224
225         res = ast_async_parseable_goto(chan, dest);
226
227         chan = ast_channel_unref(chan);
228
229         if (!res) {
230                 ast_cli(a->fd, "Channel '%s' successfully redirected to %s\n", name, dest);
231         } else {
232                 ast_cli(a->fd, "Channel '%s' failed to be redirected to %s\n", name, dest);
233         }
234
235         return res ? CLI_FAILURE : CLI_SUCCESS;
236 }
237
238 static struct ast_cli_entry cli_cliorig[] = {
239         AST_CLI_DEFINE(handle_orig, "Originate a call"),
240         AST_CLI_DEFINE(handle_redirect, "Redirect a call"),
241 };
242
243 static int unload_module(void)
244 {
245         return ast_cli_unregister_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
246 }
247
248 static int load_module(void)
249 {
250         int res;
251         res = ast_cli_register_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
252         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
253 }
254
255 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call origination and redirection from the CLI");