Merge "res_pjsip/res_pjsip_callerid: NULL check on caller id name string"
[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 /*! \li \ref res_clialiases.c uses the configuration file \ref cli_aliases.conf
30  * \addtogroup configuration_file Configuration Files
31  */
32
33 /*! 
34  * \page cli_aliases.conf cli_aliases.conf
35  * \verbinclude cli_aliases.conf.sample
36  */
37
38 /*** MODULEINFO
39         <support_level>core</support_level>
40  ***/
41
42 #include "asterisk.h"
43
44 #include "asterisk/module.h"
45 #include "asterisk/config.h"
46 #include "asterisk/cli.h"
47 #include "asterisk/astobj2.h"
48
49 /*! Maximum number of buckets for CLI aliases */
50 #define MAX_ALIAS_BUCKETS 53
51
52 /*! Configuration file used for this application */
53 static const char config_file[] = "cli_aliases.conf";
54
55 struct cli_alias {
56         struct ast_cli_entry cli_entry; /*!< Actual CLI structure used for this alias */
57         char *alias;                    /*!< CLI Alias */
58         char *real_cmd;                 /*!< Actual CLI command it is aliased to */
59 };
60
61 static struct ao2_container *cli_aliases;
62
63 /*! \brief Hashing function used for aliases */
64 static int alias_hash_cb(const void *obj, const int flags)
65 {
66         const struct cli_alias *alias = obj;
67         return ast_str_hash(alias->cli_entry.command);
68 }
69
70 /*! \brief Comparison function used for aliases */
71 static int alias_cmp_cb(void *obj, void *arg, int flags)
72 {
73         const struct cli_alias *alias0 = obj, *alias1 = arg;
74
75         return (alias0->cli_entry.command == alias1->cli_entry.command ? CMP_MATCH | CMP_STOP : 0);
76 }
77
78 /*! \brief Callback for unregistering an alias */
79 static int alias_unregister_cb(void *obj, void *arg, int flags)
80 {
81         struct cli_alias *alias = obj;
82
83         /* Unregister the CLI entry from the core */
84         ast_cli_unregister(&alias->cli_entry);
85
86         /* We can determine if this worked or not by looking at the cli_entry itself */
87         return !alias->cli_entry.command ? CMP_MATCH : 0;
88 }
89
90 /*! \brief Callback for finding an alias based on name */
91 static int alias_name_cb(void *obj, void *arg, int flags)
92 {
93         struct cli_alias *alias = obj;
94         char *name = arg;
95
96         return !strcmp(alias->alias, name) ? CMP_MATCH | CMP_STOP : 0;
97 }
98
99 /*! \brief Function which passes through an aliased CLI command to the real one */
100 static char *cli_alias_passthrough(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
101 {
102         struct cli_alias *alias;
103         struct cli_alias tmp = {
104                 .cli_entry.command = e->command,
105         };
106         char *generator;
107         const char *line;
108
109         /* Try to find the alias based on the CLI entry */
110         if (!(alias = ao2_find(cli_aliases, &tmp, OBJ_POINTER))) {
111                 return 0;
112         }
113
114         switch (cmd) {
115         case CLI_INIT:
116                 ao2_ref(alias, -1);
117                 return NULL;
118         case CLI_GENERATE:
119                 line = a->line;
120                 line += (strlen(alias->alias));
121                 if (!strncasecmp(alias->alias, alias->real_cmd, strlen(alias->alias))) {
122                         generator = NULL;
123                 } else if (!ast_strlen_zero(a->word)) {
124                         struct ast_str *real_cmd = ast_str_alloca(strlen(alias->real_cmd) + strlen(line) + 1);
125                         ast_str_append(&real_cmd, 0, "%s%s", alias->real_cmd, line);
126                         generator = ast_cli_generator(ast_str_buffer(real_cmd), a->word, a->n);
127                 } else {
128                         generator = ast_cli_generator(alias->real_cmd, a->word, a->n);
129                 }
130                 ao2_ref(alias, -1);
131                 return generator;
132         }
133
134         /* If they gave us extra arguments we need to construct a string to pass in */
135         if (a->argc != e->args) {
136                 struct ast_str *real_cmd = ast_str_alloca(2048);
137                 int i;
138
139                 ast_str_append(&real_cmd, 0, "%s", alias->real_cmd);
140
141                 /* Add the additional arguments that have been passed in */
142                 for (i = e->args + 1; i <= a->argc; i++) {
143                         ast_str_append(&real_cmd, 0, " %s", a->argv[i - 1]);
144                 }
145
146                 ast_cli_command(a->fd, ast_str_buffer(real_cmd));
147         } else {
148                 ast_cli_command(a->fd, alias->real_cmd);
149         }
150
151         ao2_ref(alias, -1);
152
153         return CLI_SUCCESS;
154 }
155
156 /*! \brief CLI Command to display CLI Aliases */
157 static char *alias_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
158 {
159 #define FORMAT "%-50.50s %-50.50s\n"
160         struct cli_alias *alias;
161         struct ao2_iterator i;
162
163         switch (cmd) {
164         case CLI_INIT:
165                 e->command = "cli show aliases";
166                 e->usage =
167                         "Usage: cli show aliases\n"
168                         "       Displays a list of aliased CLI commands.\n";
169                 return NULL;
170         case CLI_GENERATE:
171                 return NULL;
172         }
173
174         ast_cli(a->fd, FORMAT, "Alias Command", "Real Command");
175
176         i = ao2_iterator_init(cli_aliases, 0);
177         for (; (alias = ao2_iterator_next(&i)); ao2_ref(alias, -1)) {
178                 ast_cli(a->fd, FORMAT, alias->alias, alias->real_cmd);
179         }
180         ao2_iterator_destroy(&i);
181
182         return CLI_SUCCESS;
183 #undef FORMAT
184 }
185
186 /*! \brief CLI commands to interact with things */
187 static struct ast_cli_entry cli_alias[] = {
188         AST_CLI_DEFINE(alias_show, "Show CLI command aliases"),
189 };
190
191 /*! \brief Function called to load or reload the configuration file */
192 static void load_config(int reload)
193 {
194         struct ast_config *cfg = NULL;
195         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
196         struct cli_alias *alias;
197         struct ast_variable *v, *v1;
198
199         if (!(cfg = ast_config_load(config_file, config_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
200                 ast_log(LOG_ERROR, "res_clialiases configuration file '%s' not found\n", config_file);
201                 return;
202         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
203                 return;
204         }
205
206         /* Destroy any existing CLI aliases */
207         if (reload) {
208                 ao2_callback(cli_aliases, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, alias_unregister_cb, NULL);
209         }
210
211         for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
212                 if (strcmp(v->name, "template")) {
213                         ast_log(LOG_WARNING, "%s is not a correct option in [%s]\n", v->name, "general");
214                         continue;
215                 }
216                 /* Read in those there CLI aliases */
217                 for (v1 = ast_variable_browse(cfg, v->value); v1; v1 = v1->next) {
218                         struct cli_alias *existing = ao2_callback(cli_aliases, 0, alias_name_cb, (char*)v1->name);
219
220                         if (existing) {
221                                 ast_log(LOG_WARNING, "Alias '%s' could not be unregistered and has been retained\n",
222                                         existing->alias);
223                                 ao2_ref(existing, -1);
224                                 continue;
225                         }
226
227                         if (!(alias = ao2_alloc((sizeof(*alias) + strlen(v1->name) + strlen(v1->value) + 2), NULL))) {
228                                 continue;
229                         }
230                         alias->alias = ((char *) alias) + sizeof(*alias);
231                         alias->real_cmd = ((char *) alias->alias) + strlen(v1->name) + 1;
232                         strcpy(alias->alias, v1->name);
233                         strcpy(alias->real_cmd, v1->value);
234                         alias->cli_entry.handler = cli_alias_passthrough;
235                         alias->cli_entry.command = alias->alias;
236                         alias->cli_entry.usage = "Aliased CLI Command\n";
237
238                         if (ast_cli_register(&alias->cli_entry)) {
239                                 ao2_ref(alias, -1);
240                                 continue;
241                         }
242                         ao2_link(cli_aliases, alias);
243                         ast_verb(2, "Aliased CLI command '%s' to '%s'\n", v1->name, v1->value);
244                         ao2_ref(alias, -1);
245                 }
246         }
247
248         ast_config_destroy(cfg);
249
250         return;
251 }
252
253 /*! \brief Function called to reload the module */
254 static int reload_module(void)
255 {
256         load_config(1);
257         return 0;
258 }
259
260 /*! \brief Function called to unload the module */
261 static int unload_module(void)
262 {
263         ao2_callback(cli_aliases, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, alias_unregister_cb, NULL);
264
265         if (ao2_container_count(cli_aliases)) {
266                 ast_log(LOG_ERROR, "Could not unregister all CLI aliases\n");
267                 return -1;
268         }
269
270         ao2_ref(cli_aliases, -1);
271
272         ast_cli_unregister_multiple(cli_alias, ARRAY_LEN(cli_alias));
273
274         return 0;
275 }
276
277 /*!
278  * \brief Load the module
279  *
280  * Module loading including tests for configuration or dependencies.
281  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
282  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
283  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
284  * configuration file or other non-critical problem return 
285  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
286  */
287 static int load_module(void)
288 {
289         if (!(cli_aliases = ao2_container_alloc(MAX_ALIAS_BUCKETS, alias_hash_cb, alias_cmp_cb))) {
290                 return AST_MODULE_LOAD_DECLINE;
291         }
292
293         load_config(0);
294
295         ast_cli_register_multiple(cli_alias, ARRAY_LEN(cli_alias));
296
297         return AST_MODULE_LOAD_SUCCESS;
298 }
299
300 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "CLI Aliases",
301         .support_level = AST_MODULE_SUPPORT_CORE,
302         .load = load_module,
303         .unload = unload_module,
304         .reload = reload_module,
305 );