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