Merged revisions 328247 via svnmerge from
[asterisk/asterisk.git] / res / res_clialiases.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 /*! \file
20  *
21  * \brief CLI Aliases
22  *
23  * \author\verbatim Joshua Colp <jcolp@digium.com> \endverbatim
24  * 
25  * This module provides the capability to create aliases to other
26  * CLI commands.
27  */
28
29 /*** MODULEINFO
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/module.h"
38 #include "asterisk/config.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/astobj2.h"
41
42 /*! Maximum number of buckets for CLI aliases */
43 #define MAX_ALIAS_BUCKETS 53
44
45 /*! Configuration file used for this application */
46 static const char config_file[] = "cli_aliases.conf";
47
48 struct cli_alias {
49         struct ast_cli_entry cli_entry; /*!< Actual CLI structure used for this alias */
50         char *alias;                    /*!< CLI Alias */
51         char *real_cmd;                 /*!< Actual CLI command it is aliased to */
52 };
53
54 static struct ao2_container *cli_aliases;
55
56 /*! \brief Hashing function used for aliases */
57 static int alias_hash_cb(const void *obj, const int flags)
58 {
59         const struct cli_alias *alias = obj;
60         return ast_str_hash(alias->cli_entry.command);
61 }
62
63 /*! \brief Comparison function used for aliases */
64 static int alias_cmp_cb(void *obj, void *arg, int flags)
65 {
66         const struct cli_alias *alias0 = obj, *alias1 = arg;
67
68         return (alias0->cli_entry.command == alias1->cli_entry.command ? CMP_MATCH | CMP_STOP : 0);
69 }
70
71 /*! \brief Destruction function used for aliases */
72 static void alias_destroy(void *obj)
73 {
74         struct cli_alias *alias = obj;
75
76         /* Unregister the CLI entry from the core */
77         ast_cli_unregister(&alias->cli_entry);
78
79         return;
80 }
81
82 /*! \brief Function which passes through an aliased CLI command to the real one */
83 static char *cli_alias_passthrough(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
84 {
85         struct cli_alias *alias;
86         struct cli_alias tmp = {
87                 .cli_entry.command = e->command,
88         };
89         char *generator;
90         const char *line;
91
92         /* Try to find the alias based on the CLI entry */
93         if (!(alias = ao2_find(cli_aliases, &tmp, OBJ_POINTER))) {
94                 return 0;
95         }
96
97         switch (cmd) {
98         case CLI_INIT:
99                 ao2_ref(alias, -1);
100                 return NULL;
101         case CLI_GENERATE:
102                 line = a->line;
103                 line += (strlen(alias->alias));
104                 if (!strncasecmp(alias->alias, alias->real_cmd, strlen(alias->alias))) {
105                         generator = NULL;
106                 } else if (!ast_strlen_zero(a->word)) {
107                         struct ast_str *real_cmd = ast_str_alloca(strlen(alias->real_cmd) + strlen(line) + 1);
108                         ast_str_append(&real_cmd, 0, "%s%s", alias->real_cmd, line);
109                         generator = ast_cli_generator(ast_str_buffer(real_cmd), a->word, a->n);
110                 } else {
111                         generator = ast_cli_generator(alias->real_cmd, a->word, a->n);
112                 }
113                 ao2_ref(alias, -1);
114                 return generator;
115         }
116
117         /* If they gave us extra arguments we need to construct a string to pass in */
118         if (a->argc != e->args) {
119                 struct ast_str *real_cmd = ast_str_alloca(2048);
120                 int i;
121
122                 ast_str_append(&real_cmd, 0, "%s", alias->real_cmd);
123
124                 /* Add the additional arguments that have been passed in */
125                 for (i = e->args + 1; i <= a->argc; i++) {
126                         ast_str_append(&real_cmd, 0, " %s", a->argv[i - 1]);
127                 }
128
129                 ast_cli_command(a->fd, ast_str_buffer(real_cmd));
130         } else {
131                 ast_cli_command(a->fd, alias->real_cmd);
132         }
133
134         ao2_ref(alias, -1);
135
136         return CLI_SUCCESS;
137 }
138
139 /*! \brief CLI Command to display CLI Aliases */
140 static char *alias_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
141 {
142 #define FORMAT "%-50.50s %-50.50s\n"
143         struct cli_alias *alias;
144         struct ao2_iterator i;
145
146         switch (cmd) {
147         case CLI_INIT:
148                 e->command = "cli show aliases";
149                 e->usage =
150                         "Usage: cli show aliases\n"
151                         "       Displays a list of aliased CLI commands.\n";
152                 return NULL;
153         case CLI_GENERATE:
154                 return NULL;
155         }
156
157         ast_cli(a->fd, FORMAT, "Alias Command", "Real Command");
158
159         i = ao2_iterator_init(cli_aliases, 0);
160         for (; (alias = ao2_iterator_next(&i)); ao2_ref(alias, -1)) {
161                 ast_cli(a->fd, FORMAT, alias->alias, alias->real_cmd);
162         }
163         ao2_iterator_destroy(&i);
164
165         return CLI_SUCCESS;
166 #undef FORMAT
167 }
168
169 /*! \brief CLI commands to interact with things */
170 static struct ast_cli_entry cli_alias[] = {
171         AST_CLI_DEFINE(alias_show, "Show CLI command aliases"),
172 };
173
174 /*! \brief Function called to load or reload the configuration file */
175 static void load_config(int reload)
176 {
177         struct ast_config *cfg = NULL;
178         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
179         struct cli_alias *alias;
180         struct ast_variable *v, *v1;
181
182         if (!(cfg = ast_config_load(config_file, config_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
183                 ast_log(LOG_ERROR, "res_clialiases configuration file '%s' not found\n", config_file);
184                 return;
185         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
186                 return;
187         }
188
189         /* Destroy any existing CLI aliases */
190         if (reload) {
191                 ao2_callback(cli_aliases, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
192         }
193
194         for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
195                 if (strcmp(v->name, "template")) {
196                         ast_log(LOG_WARNING, "%s is not a correct option in [%s]\n", v->name, "general");
197                         continue;
198                 }
199                 /* Read in those there CLI aliases */
200                 for (v1 = ast_variable_browse(cfg, v->value); v1; v1 = v1->next) {
201                         if (!(alias = ao2_alloc((sizeof(*alias) + strlen(v1->name) + strlen(v1->value) + 2), alias_destroy))) {
202                                 continue;
203                         }
204                         alias->alias = ((char *) alias) + sizeof(*alias);
205                         alias->real_cmd = ((char *) alias->alias) + strlen(v1->name) + 1;
206                         strcpy(alias->alias, v1->name);
207                         strcpy(alias->real_cmd, v1->value);
208                         alias->cli_entry.handler = cli_alias_passthrough;
209                         alias->cli_entry.command = alias->alias;
210                         alias->cli_entry.usage = "Aliased CLI Command\n";
211
212                         ast_cli_register(&alias->cli_entry);
213                         ao2_link(cli_aliases, alias);
214                         ast_verbose(VERBOSE_PREFIX_2 "Aliased CLI command '%s' to '%s'\n", v1->name, v1->value);
215                         ao2_ref(alias, -1);
216                 }
217         }
218
219         ast_config_destroy(cfg);
220
221         return;
222 }
223
224 /*! \brief Function called to reload the module */
225 static int reload_module(void)
226 {
227         load_config(1);
228         return 0;
229 }
230
231 /*! \brief Function called to unload the module */
232 static int unload_module(void)
233 {
234         ao2_ref(cli_aliases, -1);
235
236         ast_cli_unregister_multiple(cli_alias, ARRAY_LEN(cli_alias));
237
238         return 0;
239 }
240
241 /*! \brief Function called to load the module */
242 static int load_module(void)
243 {
244         if (!(cli_aliases = ao2_container_alloc(MAX_ALIAS_BUCKETS, alias_hash_cb, alias_cmp_cb))) {
245                 return AST_MODULE_LOAD_DECLINE;
246         }
247
248         load_config(0);
249
250         ast_cli_register_multiple(cli_alias, ARRAY_LEN(cli_alias));
251
252         return AST_MODULE_LOAD_SUCCESS;
253 }
254
255 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "CLI Aliases",
256                 .load = load_module,
257                 .unload = unload_module,
258                 .reload = reload_module,
259                 );