683ae9c3ea31b6de454e1df0bef9a1ccd5e1d048
[asterisk/asterisk.git] / main / cli.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 Standard Command Line Interface
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 /*! \li \ref cli.c uses the configuration file \ref cli_permissions.conf
27  * \addtogroup configuration_file Configuration Files
28  */
29
30 /*!
31  * \page cli_permissions.conf cli_permissions.conf
32  * \verbinclude cli_permissions.conf.sample
33  */
34
35 /*** MODULEINFO
36         <support_level>core</support_level>
37  ***/
38
39 #include "asterisk.h"
40
41 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
42
43 #include "asterisk/_private.h"
44 #include "asterisk/paths.h"     /* use ast_config_AST_MODULE_DIR */
45 #include <sys/signal.h>
46 #include <signal.h>
47 #include <ctype.h>
48 #include <regex.h>
49 #include <pwd.h>
50 #include <grp.h>
51 #include <editline/readline.h>
52
53 #include "asterisk/cli.h"
54 #include "asterisk/linkedlists.h"
55 #include "asterisk/module.h"
56 #include "asterisk/pbx.h"
57 #include "asterisk/channel.h"
58 #include "asterisk/utils.h"
59 #include "asterisk/app.h"
60 #include "asterisk/lock.h"
61 #include "asterisk/threadstorage.h"
62 #include "asterisk/translate.h"
63 #include "asterisk/bridging.h"
64
65 /*!
66  * \brief List of restrictions per user.
67  */
68 struct cli_perm {
69         unsigned int permit:1;                          /*!< 1=Permit 0=Deny */
70         char *command;                          /*!< Command name (to apply restrictions) */
71         AST_LIST_ENTRY(cli_perm) list;
72 };
73
74 AST_LIST_HEAD_NOLOCK(cli_perm_head, cli_perm);
75
76 /*! \brief list of users to apply restrictions. */
77 struct usergroup_cli_perm {
78         int uid;                                /*!< User ID (-1 disabled) */
79         int gid;                                /*!< Group ID (-1 disabled) */
80         struct cli_perm_head *perms;            /*!< List of permissions. */
81         AST_LIST_ENTRY(usergroup_cli_perm) list;/*!< List mechanics */
82 };
83 /*! \brief CLI permissions config file. */
84 static const char perms_config[] = "cli_permissions.conf";
85 /*! \brief Default permissions value 1=Permit 0=Deny */
86 static int cli_default_perm = 1;
87
88 /*! \brief mutex used to prevent a user from running the 'cli reload permissions' command while
89  * it is already running. */
90 AST_MUTEX_DEFINE_STATIC(permsconfiglock);
91 /*! \brief  List of users and permissions. */
92 static AST_RWLIST_HEAD_STATIC(cli_perms, usergroup_cli_perm);
93
94 /*!
95  * \brief map a debug or verbose level to a module name
96  */
97 struct module_level {
98         unsigned int level;
99         AST_RWLIST_ENTRY(module_level) entry;
100         char module[0];
101 };
102
103 AST_RWLIST_HEAD(module_level_list, module_level);
104
105 /*! list of module names and their debug levels */
106 static struct module_level_list debug_modules = AST_RWLIST_HEAD_INIT_VALUE;
107 /*! list of module names and their verbose levels */
108 static struct module_level_list verbose_modules = AST_RWLIST_HEAD_INIT_VALUE;
109
110 AST_THREADSTORAGE(ast_cli_buf);
111
112 /*! \brief Initial buffer size for resulting strings in ast_cli() */
113 #define AST_CLI_INITLEN   256
114
115 void ast_cli(int fd, const char *fmt, ...)
116 {
117         int res;
118         struct ast_str *buf;
119         va_list ap;
120
121         if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
122                 return;
123
124         va_start(ap, fmt);
125         res = ast_str_set_va(&buf, 0, fmt, ap);
126         va_end(ap);
127
128         if (res != AST_DYNSTR_BUILD_FAILED) {
129                 ast_carefulwrite(fd, ast_str_buffer(buf), ast_str_strlen(buf), 100);
130         }
131 }
132
133 unsigned int ast_debug_get_by_module(const char *module)
134 {
135         struct module_level *ml;
136         unsigned int res = 0;
137
138         AST_RWLIST_RDLOCK(&debug_modules);
139         AST_LIST_TRAVERSE(&debug_modules, ml, entry) {
140                 if (!strcasecmp(ml->module, module)) {
141                         res = ml->level;
142                         break;
143                 }
144         }
145         AST_RWLIST_UNLOCK(&debug_modules);
146
147         return res;
148 }
149
150 unsigned int ast_verbose_get_by_module(const char *module)
151 {
152         struct module_level *ml;
153         unsigned int res = 0;
154
155         AST_RWLIST_RDLOCK(&verbose_modules);
156         AST_LIST_TRAVERSE(&verbose_modules, ml, entry) {
157                 if (!strcasecmp(ml->module, module)) {
158                         res = ml->level;
159                         break;
160                 }
161         }
162         AST_RWLIST_UNLOCK(&verbose_modules);
163
164         return res;
165 }
166
167 /*! \internal
168  *  \brief Check if the user with 'uid' and 'gid' is allow to execute 'command',
169  *         if command starts with '_' then not check permissions, just permit
170  *         to run the 'command'.
171  *         if uid == -1 or gid == -1 do not check permissions.
172  *         if uid == -2 and gid == -2 is because rasterisk client didn't send
173  *         the credentials, so the cli_default_perm will be applied.
174  *  \param uid User ID.
175  *  \param gid Group ID.
176  *  \param command Command name to check permissions.
177  *  \retval 1 if has permission
178  *  \retval 0 if it is not allowed.
179  */
180 static int cli_has_permissions(int uid, int gid, const char *command)
181 {
182         struct usergroup_cli_perm *user_perm;
183         struct cli_perm *perm;
184         /* set to the default permissions general option. */
185         int isallowg = cli_default_perm, isallowu = -1, ispattern;
186         regex_t regexbuf;
187
188         /* if uid == -1 or gid == -1 do not check permissions.
189            if uid == -2 and gid == -2 is because rasterisk client didn't send
190            the credentials, so the cli_default_perm will be applied. */
191         if ((uid == CLI_NO_PERMS && gid == CLI_NO_PERMS) || command[0] == '_') {
192                 return 1;
193         }
194
195         if (gid < 0 && uid < 0) {
196                 return cli_default_perm;
197         }
198
199         AST_RWLIST_RDLOCK(&cli_perms);
200         AST_LIST_TRAVERSE(&cli_perms, user_perm, list) {
201                 if (user_perm->gid != gid && user_perm->uid != uid) {
202                         continue;
203                 }
204                 AST_LIST_TRAVERSE(user_perm->perms, perm, list) {
205                         if (strcasecmp(perm->command, "all") && strncasecmp(perm->command, command, strlen(perm->command))) {
206                                 /* if the perm->command is a pattern, check it against command. */
207                                 ispattern = !regcomp(&regexbuf, perm->command, REG_EXTENDED | REG_NOSUB | REG_ICASE);
208                                 if (ispattern && regexec(&regexbuf, command, 0, NULL, 0)) {
209                                         regfree(&regexbuf);
210                                         continue;
211                                 }
212                                 if (!ispattern) {
213                                         continue;
214                                 }
215                                 regfree(&regexbuf);
216                         }
217                         if (user_perm->uid == uid) {
218                                 /* this is a user definition. */
219                                 isallowu = perm->permit;
220                         } else {
221                                 /* otherwise is a group definition. */
222                                 isallowg = perm->permit;
223                         }
224                 }
225         }
226         AST_RWLIST_UNLOCK(&cli_perms);
227         if (isallowu > -1) {
228                 /* user definition override group definition. */
229                 isallowg = isallowu;
230         }
231
232         return isallowg;
233 }
234
235 static AST_RWLIST_HEAD_STATIC(helpers, ast_cli_entry);
236
237 static char *complete_fn(const char *word, int state)
238 {
239         char *c, *d;
240         char filename[PATH_MAX];
241
242         if (word[0] == '/')
243                 ast_copy_string(filename, word, sizeof(filename));
244         else
245                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
246
247         c = d = filename_completion_function(filename, state);
248
249         if (c && word[0] != '/')
250                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
251         if (c)
252                 c = ast_strdup(c);
253
254         free(d);
255
256         return c;
257 }
258
259 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
260 {
261         /* "module load <mod>" */
262         switch (cmd) {
263         case CLI_INIT:
264                 e->command = "module load";
265                 e->usage =
266                         "Usage: module load <module name>\n"
267                         "       Loads the specified module into Asterisk.\n";
268                 return NULL;
269
270         case CLI_GENERATE:
271                 if (a->pos != e->args)
272                         return NULL;
273                 return complete_fn(a->word, a->n);
274         }
275         if (a->argc != e->args + 1)
276                 return CLI_SHOWUSAGE;
277         if (ast_load_resource(a->argv[e->args])) {
278                 ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
279                 return CLI_FAILURE;
280         }
281         ast_cli(a->fd, "Loaded %s\n", a->argv[e->args]);
282         return CLI_SUCCESS;
283 }
284
285 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
286 {
287         int x;
288
289         switch (cmd) {
290         case CLI_INIT:
291                 e->command = "module reload";
292                 e->usage =
293                         "Usage: module reload [module ...]\n"
294                         "       Reloads configuration files for all listed modules which support\n"
295                         "       reloading, or for all supported modules if none are listed.\n";
296                 return NULL;
297
298         case CLI_GENERATE:
299                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1);
300         }
301         if (a->argc == e->args) {
302                 ast_module_reload(NULL);
303                 return CLI_SUCCESS;
304         }
305         for (x = e->args; x < a->argc; x++) {
306                 enum ast_module_reload_result res = ast_module_reload(a->argv[x]);
307                 switch (res) {
308                 case AST_MODULE_RELOAD_NOT_FOUND:
309                         ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
310                         break;
311                 case AST_MODULE_RELOAD_NOT_IMPLEMENTED:
312                         ast_cli(a->fd, "The module '%s' does not support reloads\n", a->argv[x]);
313                         break;
314                 case AST_MODULE_RELOAD_QUEUED:
315                         ast_cli(a->fd, "Asterisk cannot reload a module yet; request queued\n");
316                         break;
317                 case AST_MODULE_RELOAD_ERROR:
318                         ast_cli(a->fd, "The module '%s' reported a reload failure\n", a->argv[x]);
319                         break;
320                 case AST_MODULE_RELOAD_IN_PROGRESS:
321                         ast_cli(a->fd, "A module reload request is already in progress; please be patient\n");
322                         break;
323                 case AST_MODULE_RELOAD_UNINITIALIZED:
324                         ast_cli(a->fd, "The module '%s' was not properly initialized. Before reloading"
325                                         " the module, you must run \"module load %s\" and fix whatever is"
326                                         " preventing the module from being initialized.\n", a->argv[x], a->argv[x]);
327                         break;
328                 case AST_MODULE_RELOAD_SUCCESS:
329                         ast_cli(a->fd, "Module '%s' reloaded successfully.\n", a->argv[x]);
330                         break;
331                 }
332         }
333         return CLI_SUCCESS;
334 }
335
336 static char *handle_core_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
337 {
338         switch (cmd) {
339         case CLI_INIT:
340                 e->command = "core reload";
341                 e->usage =
342                         "Usage: core reload\n"
343                         "       Execute a global reload.\n";
344                 return NULL;
345
346         case CLI_GENERATE:
347                 return NULL;
348         }
349
350         if (a->argc != e->args) {
351                 return CLI_SHOWUSAGE;
352         }
353
354         ast_module_reload(NULL);
355
356         return CLI_SUCCESS;
357 }
358 /*!
359  * \brief Find the debug or verbose file setting
360  * \arg debug 1 for debug, 0 for verbose
361  */
362 static struct module_level *find_module_level(const char *module, unsigned int debug)
363 {
364         struct module_level *ml;
365         struct module_level_list *mll = debug ? &debug_modules : &verbose_modules;
366
367         AST_LIST_TRAVERSE(mll, ml, entry) {
368                 if (!strcasecmp(ml->module, module))
369                         return ml;
370         }
371
372         return NULL;
373 }
374
375 static char *complete_number(const char *partial, unsigned int min, unsigned int max, int n)
376 {
377         int i, count = 0;
378         unsigned int prospective[2];
379         unsigned int part = strtoul(partial, NULL, 10);
380         char next[12];
381
382         if (part < min || part > max) {
383                 return NULL;
384         }
385
386         for (i = 0; i < 21; i++) {
387                 if (i == 0) {
388                         prospective[0] = prospective[1] = part;
389                 } else if (part == 0 && !ast_strlen_zero(partial)) {
390                         break;
391                 } else if (i < 11) {
392                         prospective[0] = prospective[1] = part * 10 + (i - 1);
393                 } else {
394                         prospective[0] = (part * 10 + (i - 11)) * 10;
395                         prospective[1] = prospective[0] + 9;
396                 }
397                 if (i < 11 && (prospective[0] < min || prospective[0] > max)) {
398                         continue;
399                 } else if (prospective[1] < min || prospective[0] > max) {
400                         continue;
401                 }
402
403                 if (++count > n) {
404                         if (i < 11) {
405                                 snprintf(next, sizeof(next), "%u", prospective[0]);
406                         } else {
407                                 snprintf(next, sizeof(next), "%u...", prospective[0] / 10);
408                         }
409                         return ast_strdup(next);
410                 }
411         }
412         return NULL;
413 }
414
415 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
416 {
417         int oldval;
418         int newlevel;
419         unsigned int is_debug;
420         int atleast = 0;
421         int fd = a->fd;
422         int argc = a->argc;
423         const char * const *argv = a->argv;
424         const char *argv3 = a->argv ? S_OR(a->argv[3], "") : "";
425         int *dst;
426         char *what;
427         struct module_level_list *mll;
428         struct module_level *ml;
429
430         switch (cmd) {
431         case CLI_INIT:
432                 e->command = "core set {debug|verbose}";
433                 e->usage =
434 #if !defined(LOW_MEMORY)
435                         "Usage: core set {debug|verbose} [atleast] <level> [module]\n"
436 #else
437                         "Usage: core set {debug|verbose} [atleast] <level>\n"
438 #endif
439                         "       core set {debug|verbose} off\n"
440 #if !defined(LOW_MEMORY)
441                         "       Sets level of debug or verbose messages to be displayed or\n"
442                         "       sets a module name to display debug messages from.\n"
443 #else
444                         "       Sets level of debug or verbose messages to be displayed.\n"
445 #endif
446                         "       0 or off means no messages should be displayed.\n"
447                         "       Equivalent to -d[d[...]] or -v[v[v...]] on startup\n";
448                 return NULL;
449
450         case CLI_GENERATE:
451                 if (a->pos == 3 || (a->pos == 4 && !strcasecmp(a->argv[3], "atleast"))) {
452                         const char *pos = a->pos == 3 ? argv3 : S_OR(a->argv[4], "");
453                         int numbermatch = (ast_strlen_zero(pos) || strchr("123456789", pos[0])) ? 0 : 21;
454                         if (a->n < 21 && numbermatch == 0) {
455                                 return complete_number(pos, 0, 0x7fffffff, a->n);
456                         } else if (pos[0] == '0') {
457                                 if (a->n == 0) {
458                                         return ast_strdup("0");
459                                 } else {
460                                         return NULL;
461                                 }
462                         } else if (a->n == (21 - numbermatch)) {
463                                 if (a->pos == 3 && !strncasecmp(argv3, "off", strlen(argv3))) {
464                                         return ast_strdup("off");
465                                 } else if (a->pos == 3 && !strncasecmp(argv3, "atleast", strlen(argv3))) {
466                                         return ast_strdup("atleast");
467                                 }
468                         } else if (a->n == (22 - numbermatch) && a->pos == 3 && ast_strlen_zero(argv3)) {
469                                 return ast_strdup("atleast");
470                         }
471 #if !defined(LOW_MEMORY)
472                 } else if (a->pos == 4 || (a->pos == 5 && !strcasecmp(argv3, "atleast"))) {
473                         return ast_complete_source_filename(a->pos == 4 ? S_OR(a->argv[4], "") : S_OR(a->argv[5], ""), a->n);
474 #endif
475                 }
476                 return NULL;
477         }
478         /* all the above return, so we proceed with the handler.
479          * we are guaranteed to be called with argc >= e->args;
480          */
481
482         if (argc <= e->args)
483                 return CLI_SHOWUSAGE;
484         if (!strcasecmp(argv[e->args - 1], "debug")) {
485                 dst = &option_debug;
486                 oldval = option_debug;
487                 what = "Core debug";
488                 is_debug = 1;
489         } else {
490                 dst = &option_verbose;
491                 oldval = option_verbose;
492                 what = "Verbosity";
493                 is_debug = 0;
494         }
495         if (argc == e->args + 1 && !strcasecmp(argv[e->args], "off")) {
496                 newlevel = 0;
497
498                 mll = is_debug ? &debug_modules : &verbose_modules;
499
500                 AST_RWLIST_WRLOCK(mll);
501                 while ((ml = AST_RWLIST_REMOVE_HEAD(mll, entry))) {
502                         ast_free(ml);
503                 }
504                 ast_clear_flag(&ast_options, is_debug ? AST_OPT_FLAG_DEBUG_MODULE : AST_OPT_FLAG_VERBOSE_MODULE);
505                 AST_RWLIST_UNLOCK(mll);
506
507                 goto done;
508         }
509         if (!strcasecmp(argv[e->args], "atleast"))
510                 atleast = 1;
511         if (argc != e->args + atleast + 1 && argc != e->args + atleast + 2)
512                 return CLI_SHOWUSAGE;
513         if (sscanf(argv[e->args + atleast], "%30d", &newlevel) != 1)
514                 return CLI_SHOWUSAGE;
515         if (argc == e->args + atleast + 2) {
516                 /* We have specified a module name. */
517                 char *mod = ast_strdupa(argv[e->args + atleast + 1]);
518
519                 if ((strlen(mod) > 3) && !strcasecmp(mod + strlen(mod) - 3, ".so")) {
520                         mod[strlen(mod) - 3] = '\0';
521                 }
522
523                 mll = is_debug ? &debug_modules : &verbose_modules;
524
525                 AST_RWLIST_WRLOCK(mll);
526
527                 ml = find_module_level(mod, is_debug);
528                 if (!newlevel) {
529                         if (!ml) {
530                                 /* Specified off for a nonexistent entry. */
531                                 AST_RWLIST_UNLOCK(mll);
532                                 return CLI_SUCCESS;
533                         }
534                         AST_RWLIST_REMOVE(mll, ml, entry);
535                         if (AST_RWLIST_EMPTY(mll))
536                                 ast_clear_flag(&ast_options, is_debug ? AST_OPT_FLAG_DEBUG_MODULE : AST_OPT_FLAG_VERBOSE_MODULE);
537                         AST_RWLIST_UNLOCK(mll);
538                         ast_cli(fd, "%s was %d and has been set to 0 for '%s'\n", what, ml->level, mod);
539                         ast_free(ml);
540                         return CLI_SUCCESS;
541                 }
542
543                 if (ml) {
544                         if ((atleast && newlevel < ml->level) || ml->level == newlevel) {
545                                 ast_cli(fd, "%s is %d for '%s'\n", what, ml->level, mod);
546                                 AST_RWLIST_UNLOCK(mll);
547                                 return CLI_SUCCESS;
548                         }
549                         oldval = ml->level;
550                         ml->level = newlevel;
551                 } else {
552                         ml = ast_calloc(1, sizeof(*ml) + strlen(mod) + 1);
553                         if (!ml) {
554                                 AST_RWLIST_UNLOCK(mll);
555                                 return CLI_FAILURE;
556                         }
557                         oldval = ml->level;
558                         ml->level = newlevel;
559                         strcpy(ml->module, mod);
560                         AST_RWLIST_INSERT_TAIL(mll, ml, entry);
561                 }
562
563                 ast_set_flag(&ast_options, is_debug ? AST_OPT_FLAG_DEBUG_MODULE : AST_OPT_FLAG_VERBOSE_MODULE);
564
565                 AST_RWLIST_UNLOCK(mll);
566
567                 ast_cli(fd, "%s was %d and has been set to %d for '%s'\n", what, oldval, ml->level, ml->module);
568
569                 return CLI_SUCCESS;
570         } else if (!newlevel) {
571                 /* Specified level as 0 instead of off. */
572                 mll = is_debug ? &debug_modules : &verbose_modules;
573
574                 AST_RWLIST_WRLOCK(mll);
575                 while ((ml = AST_RWLIST_REMOVE_HEAD(mll, entry))) {
576                         ast_free(ml);
577                 }
578                 ast_clear_flag(&ast_options, is_debug ? AST_OPT_FLAG_DEBUG_MODULE : AST_OPT_FLAG_VERBOSE_MODULE);
579                 AST_RWLIST_UNLOCK(mll);
580         }
581
582 done:
583         if (!atleast || newlevel > *dst)
584                 *dst = newlevel;
585         if (oldval > 0 && *dst == 0)
586                 ast_cli(fd, "%s is now OFF\n", what);
587         else if (*dst > 0) {
588                 if (oldval == *dst)
589                         ast_cli(fd, "%s is at least %d\n", what, *dst);
590                 else
591                         ast_cli(fd, "%s was %d and is now %d\n", what, oldval, *dst);
592         }
593
594         return CLI_SUCCESS;
595 }
596
597 static char *handle_logger_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
598 {
599         switch (cmd) {
600         case CLI_INIT:
601                 e->command = "logger mute";
602                 e->usage =
603                         "Usage: logger mute\n"
604                         "       Disables logging output to the current console, making it possible to\n"
605                         "       gather information without being disturbed by scrolling lines.\n";
606                 return NULL;
607         case CLI_GENERATE:
608                 return NULL;
609         }
610
611         if (a->argc < 2 || a->argc > 3)
612                 return CLI_SHOWUSAGE;
613
614         if (a->argc == 3 && !strcasecmp(a->argv[2], "silent"))
615                 ast_console_toggle_mute(a->fd, 1);
616         else
617                 ast_console_toggle_mute(a->fd, 0);
618
619         return CLI_SUCCESS;
620 }
621
622 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
623 {
624         /* "module unload mod_1 [mod_2 .. mod_N]" */
625         int x;
626         int force = AST_FORCE_SOFT;
627         const char *s;
628
629         switch (cmd) {
630         case CLI_INIT:
631                 e->command = "module unload";
632                 e->usage =
633                         "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
634                         "       Unloads the specified module from Asterisk. The -f\n"
635                         "       option causes the module to be unloaded even if it is\n"
636                         "       in use (may cause a crash) and the -h module causes the\n"
637                         "       module to be unloaded even if the module says it cannot, \n"
638                         "       which almost always will cause a crash.\n";
639                 return NULL;
640
641         case CLI_GENERATE:
642                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
643         }
644         if (a->argc < e->args + 1)
645                 return CLI_SHOWUSAGE;
646         x = e->args;    /* first argument */
647         s = a->argv[x];
648         if (s[0] == '-') {
649                 if (s[1] == 'f')
650                         force = AST_FORCE_FIRM;
651                 else if (s[1] == 'h')
652                         force = AST_FORCE_HARD;
653                 else
654                         return CLI_SHOWUSAGE;
655                 if (a->argc < e->args + 2)      /* need at least one module name */
656                         return CLI_SHOWUSAGE;
657                 x++;    /* skip this argument */
658         }
659
660         for (; x < a->argc; x++) {
661                 if (ast_unload_resource(a->argv[x], force)) {
662                         ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
663                         return CLI_FAILURE;
664                 }
665                 ast_cli(a->fd, "Unloaded %s\n", a->argv[x]);
666         }
667
668         return CLI_SUCCESS;
669 }
670
671 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d %s\n"
672 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s %s\n"
673
674 AST_MUTEX_DEFINE_STATIC(climodentrylock);
675 static int climodentryfd = -1;
676
677 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *status, const char *like)
678 {
679         /* Comparing the like with the module */
680         if (strcasestr(module, like) ) {
681                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt, status);
682                 return 1;
683         }
684         return 0;
685 }
686
687 static void print_uptimestr(int fd, struct timeval timeval, const char *prefix, int printsec)
688 {
689         int x; /* the main part - years, weeks, etc. */
690         struct ast_str *out;
691
692 #define SECOND (1)
693 #define MINUTE (SECOND*60)
694 #define HOUR (MINUTE*60)
695 #define DAY (HOUR*24)
696 #define WEEK (DAY*7)
697 #define YEAR (DAY*365)
698 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
699         if (timeval.tv_sec < 0) /* invalid, nothing to show */
700                 return;
701
702         if (printsec)  {        /* plain seconds output */
703                 ast_cli(fd, "%s: %lu\n", prefix, (u_long)timeval.tv_sec);
704                 return;
705         }
706         out = ast_str_alloca(256);
707         if (timeval.tv_sec > YEAR) {
708                 x = (timeval.tv_sec / YEAR);
709                 timeval.tv_sec -= (x * YEAR);
710                 ast_str_append(&out, 0, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
711         }
712         if (timeval.tv_sec > WEEK) {
713                 x = (timeval.tv_sec / WEEK);
714                 timeval.tv_sec -= (x * WEEK);
715                 ast_str_append(&out, 0, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
716         }
717         if (timeval.tv_sec > DAY) {
718                 x = (timeval.tv_sec / DAY);
719                 timeval.tv_sec -= (x * DAY);
720                 ast_str_append(&out, 0, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
721         }
722         if (timeval.tv_sec > HOUR) {
723                 x = (timeval.tv_sec / HOUR);
724                 timeval.tv_sec -= (x * HOUR);
725                 ast_str_append(&out, 0, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
726         }
727         if (timeval.tv_sec > MINUTE) {
728                 x = (timeval.tv_sec / MINUTE);
729                 timeval.tv_sec -= (x * MINUTE);
730                 ast_str_append(&out, 0, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
731         }
732         x = timeval.tv_sec;
733         if (x > 0 || ast_str_strlen(out) == 0)  /* if there is nothing, print 0 seconds */
734                 ast_str_append(&out, 0, "%d second%s ", x, ESS(x));
735         ast_cli(fd, "%s: %s\n", prefix, ast_str_buffer(out));
736 }
737
738 static struct ast_cli_entry *cli_next(struct ast_cli_entry *e)
739 {
740         if (e) {
741                 return AST_LIST_NEXT(e, list);
742         } else {
743                 return AST_LIST_FIRST(&helpers);
744         }
745 }
746
747 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
748 {
749         struct timeval curtime = ast_tvnow();
750         int printsec;
751
752         switch (cmd) {
753         case CLI_INIT:
754                 e->command = "core show uptime [seconds]";
755                 e->usage =
756                         "Usage: core show uptime [seconds]\n"
757                         "       Shows Asterisk uptime information.\n"
758                         "       The seconds word returns the uptime in seconds only.\n";
759                 return NULL;
760
761         case CLI_GENERATE:
762                 return NULL;
763         }
764         /* regular handler */
765         if (a->argc == e->args && !strcasecmp(a->argv[e->args-1],"seconds"))
766                 printsec = 1;
767         else if (a->argc == e->args-1)
768                 printsec = 0;
769         else
770                 return CLI_SHOWUSAGE;
771         if (ast_startuptime.tv_sec)
772                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime", printsec);
773         if (ast_lastreloadtime.tv_sec)
774                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_lastreloadtime), "Last reload", printsec);
775         return CLI_SUCCESS;
776 }
777
778 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
779 {
780         const char *like;
781
782         switch (cmd) {
783         case CLI_INIT:
784                 e->command = "module show [like]";
785                 e->usage =
786                         "Usage: module show [like keyword]\n"
787                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
788                 return NULL;
789
790         case CLI_GENERATE:
791                 if (a->pos == e->args)
792                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
793                 else
794                         return NULL;
795         }
796         /* all the above return, so we proceed with the handler.
797          * we are guaranteed to have argc >= e->args
798          */
799         if (a->argc == e->args - 1)
800                 like = "";
801         else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
802                 like = a->argv[e->args];
803         else
804                 return CLI_SHOWUSAGE;
805
806         ast_mutex_lock(&climodentrylock);
807         climodentryfd = a->fd; /* global, protected by climodentrylock */
808         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count", "Status");
809         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
810         climodentryfd = -1;
811         ast_mutex_unlock(&climodentrylock);
812         return CLI_SUCCESS;
813 }
814 #undef MODLIST_FORMAT
815 #undef MODLIST_FORMAT2
816
817 static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
818 {
819         struct timeval curtime = ast_tvnow();
820         int showuptime, printsec;
821
822         switch (cmd) {
823         case CLI_INIT:
824                 e->command = "core show calls [uptime]";
825                 e->usage =
826                         "Usage: core show calls [uptime] [seconds]\n"
827                         "       Lists number of currently active calls and total number of calls\n"
828                         "       processed through PBX since last restart. If 'uptime' is specified\n"
829                         "       the system uptime is also displayed. If 'seconds' is specified in\n"
830                         "       addition to 'uptime', the system uptime is displayed in seconds.\n";
831                 return NULL;
832
833         case CLI_GENERATE:
834                 if (a->pos != e->args)
835                         return NULL;
836                 return a->n == 0  ? ast_strdup("seconds") : NULL;
837         }
838
839         /* regular handler */
840         if (a->argc >= e->args && !strcasecmp(a->argv[e->args-1],"uptime")) {
841                 showuptime = 1;
842
843                 if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
844                         printsec = 1;
845                 else if (a->argc == e->args)
846                         printsec = 0;
847                 else
848                         return CLI_SHOWUSAGE;
849         } else if (a->argc == e->args-1) {
850                 showuptime = 0;
851                 printsec = 0;
852         } else
853                 return CLI_SHOWUSAGE;
854
855         if (option_maxcalls) {
856                 ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
857                    ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
858                    ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
859         } else {
860                 ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
861         }
862
863         ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
864
865         if (ast_startuptime.tv_sec && showuptime) {
866                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime", printsec);
867         }
868
869         return RESULT_SUCCESS;
870 }
871
872 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
873 {
874 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
875 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
876 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%s!%d!%s!%s!%s\n"
877 #define VERBOSE_FORMAT_STRING  "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-11.11s %-20.20s\n"
878 #define VERBOSE_FORMAT_STRING2 "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-11.11s %-20.20s\n"
879
880         struct ast_channel *c = NULL;
881         int numchans = 0, concise = 0, verbose = 0, count = 0;
882         struct ast_channel_iterator *iter = NULL;
883
884         switch (cmd) {
885         case CLI_INIT:
886                 e->command = "core show channels [concise|verbose|count]";
887                 e->usage =
888                         "Usage: core show channels [concise|verbose|count]\n"
889                         "       Lists currently defined channels and some information about them. If\n"
890                         "       'concise' is specified, the format is abridged and in a more easily\n"
891                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
892                         "       more and longer fields. If 'count' is specified only the channel and call\n"
893                         "       count is output.\n"
894                         "       The 'concise' option is deprecated and will be removed from future versions\n"
895                         "       of Asterisk.\n";
896                 return NULL;
897
898         case CLI_GENERATE:
899                 return NULL;
900         }
901
902         if (a->argc == e->args) {
903                 if (!strcasecmp(a->argv[e->args-1],"concise"))
904                         concise = 1;
905                 else if (!strcasecmp(a->argv[e->args-1],"verbose"))
906                         verbose = 1;
907                 else if (!strcasecmp(a->argv[e->args-1],"count"))
908                         count = 1;
909                 else
910                         return CLI_SHOWUSAGE;
911         } else if (a->argc != e->args - 1)
912                 return CLI_SHOWUSAGE;
913
914         if (!count) {
915                 if (!concise && !verbose)
916                         ast_cli(a->fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
917                 else if (verbose)
918                         ast_cli(a->fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data",
919                                 "CallerID", "Duration", "Accountcode", "PeerAccount", "BridgeID");
920         }
921
922         if (!count && !(iter = ast_channel_iterator_all_new())) {
923                 return CLI_FAILURE;
924         }
925
926         for (; iter && (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
927                 struct ast_bridge *bridge;
928                 char durbuf[10] = "-";
929
930                 ast_channel_lock(c);
931
932                 bridge = ast_channel_get_bridge(c);
933
934                 if (!count) {
935                         if ((concise || verbose)  && ast_channel_cdr(c) && !ast_tvzero(ast_channel_cdr(c)->start)) {
936                                 int duration = (int)(ast_tvdiff_ms(ast_tvnow(), ast_channel_cdr(c)->start) / 1000);
937                                 if (verbose) {
938                                         int durh = duration / 3600;
939                                         int durm = (duration % 3600) / 60;
940                                         int durs = duration % 60;
941                                         snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
942                                 } else {
943                                         snprintf(durbuf, sizeof(durbuf), "%d", duration);
944                                 }
945                         }
946                         if (concise) {
947                                 ast_cli(a->fd, CONCISE_FORMAT_STRING, ast_channel_name(c), ast_channel_context(c), ast_channel_exten(c), ast_channel_priority(c), ast_state2str(ast_channel_state(c)),
948                                         ast_channel_appl(c) ? ast_channel_appl(c) : "(None)",
949                                         S_OR(ast_channel_data(c), ""),  /* XXX different from verbose ? */
950                                         S_COR(ast_channel_caller(c)->id.number.valid, ast_channel_caller(c)->id.number.str, ""),
951                                         S_OR(ast_channel_accountcode(c), ""),
952                                         S_OR(ast_channel_peeraccount(c), ""),
953                                         ast_channel_amaflags(c),
954                                         durbuf,
955                                         bridge ? bridge->uniqueid : "(Not bridged)",
956                                         ast_channel_uniqueid(c));
957                         } else if (verbose) {
958                                 ast_cli(a->fd, VERBOSE_FORMAT_STRING, ast_channel_name(c), ast_channel_context(c), ast_channel_exten(c), ast_channel_priority(c), ast_state2str(ast_channel_state(c)),
959                                         ast_channel_appl(c) ? ast_channel_appl(c) : "(None)",
960                                         ast_channel_data(c) ? S_OR(ast_channel_data(c), "(Empty)" ): "(None)",
961                                         S_COR(ast_channel_caller(c)->id.number.valid, ast_channel_caller(c)->id.number.str, ""),
962                                         durbuf,
963                                         S_OR(ast_channel_accountcode(c), ""),
964                                         S_OR(ast_channel_peeraccount(c), ""),
965                                         bridge ? bridge->uniqueid : "(Not bridged)");
966                         } else {
967                                 char locbuf[40] = "(None)";
968                                 char appdata[40] = "(None)";
969
970                                 if (!ast_strlen_zero(ast_channel_context(c)) && !ast_strlen_zero(ast_channel_exten(c)))
971                                         snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", ast_channel_exten(c), ast_channel_context(c), ast_channel_priority(c));
972                                 if (ast_channel_appl(c))
973                                         snprintf(appdata, sizeof(appdata), "%s(%s)", ast_channel_appl(c), S_OR(ast_channel_data(c), ""));
974                                 ast_cli(a->fd, FORMAT_STRING, ast_channel_name(c), locbuf, ast_state2str(ast_channel_state(c)), appdata);
975                         }
976                 }
977                 ast_channel_unlock(c);
978                 ao2_cleanup(bridge);
979         }
980
981         if (iter) {
982                 ast_channel_iterator_destroy(iter);
983         }
984
985         if (!concise) {
986                 numchans = ast_active_channels();
987                 ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
988                 if (option_maxcalls)
989                         ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
990                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
991                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
992                 else
993                         ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
994
995                 ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
996         }
997
998         return CLI_SUCCESS;
999
1000 #undef FORMAT_STRING
1001 #undef FORMAT_STRING2
1002 #undef CONCISE_FORMAT_STRING
1003 #undef VERBOSE_FORMAT_STRING
1004 #undef VERBOSE_FORMAT_STRING2
1005 }
1006
1007 static char *handle_softhangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1008 {
1009         struct ast_channel *c=NULL;
1010
1011         switch (cmd) {
1012         case CLI_INIT:
1013                 e->command = "channel request hangup";
1014                 e->usage =
1015                         "Usage: channel request hangup <channel>|<all>\n"
1016                         "       Request that a channel be hung up. The hangup takes effect\n"
1017                         "       the next time the driver reads or writes from the channel.\n"
1018                         "       If 'all' is specified instead of a channel name, all channels\n"
1019                         "       will see the hangup request.\n";
1020                 return NULL;
1021         case CLI_GENERATE:
1022                 return ast_complete_channels(a->line, a->word, a->pos, a->n, e->args);
1023         }
1024
1025         if (a->argc != 4) {
1026                 return CLI_SHOWUSAGE;
1027         }
1028
1029         if (!strcasecmp(a->argv[3], "all")) {
1030                 struct ast_channel_iterator *iter = NULL;
1031                 if (!(iter = ast_channel_iterator_all_new())) {
1032                         return CLI_FAILURE;
1033                 }
1034                 for (; iter && (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
1035                         ast_channel_lock(c);
1036                         ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1037                         ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
1038                         ast_channel_unlock(c);
1039                 }
1040                 ast_channel_iterator_destroy(iter);
1041         } else if ((c = ast_channel_get_by_name(a->argv[3]))) {
1042                 ast_channel_lock(c);
1043                 ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1044                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
1045                 ast_channel_unlock(c);
1046                 c = ast_channel_unref(c);
1047         } else {
1048                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1049         }
1050
1051         return CLI_SUCCESS;
1052 }
1053
1054 /*! \brief handles CLI command 'cli show permissions' */
1055 static char *handle_cli_show_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1056 {
1057         struct usergroup_cli_perm *cp;
1058         struct cli_perm *perm;
1059         struct passwd *pw = NULL;
1060         struct group *gr = NULL;
1061
1062         switch (cmd) {
1063         case CLI_INIT:
1064                 e->command = "cli show permissions";
1065                 e->usage =
1066                         "Usage: cli show permissions\n"
1067                         "       Shows CLI configured permissions.\n";
1068                 return NULL;
1069         case CLI_GENERATE:
1070                 return NULL;
1071         }
1072
1073         AST_RWLIST_RDLOCK(&cli_perms);
1074         AST_LIST_TRAVERSE(&cli_perms, cp, list) {
1075                 if (cp->uid >= 0) {
1076                         pw = getpwuid(cp->uid);
1077                         if (pw) {
1078                                 ast_cli(a->fd, "user: %s [uid=%d]\n", pw->pw_name, cp->uid);
1079                         }
1080                 } else {
1081                         gr = getgrgid(cp->gid);
1082                         if (gr) {
1083                                 ast_cli(a->fd, "group: %s [gid=%d]\n", gr->gr_name, cp->gid);
1084                         }
1085                 }
1086                 ast_cli(a->fd, "Permissions:\n");
1087                 if (cp->perms) {
1088                         AST_LIST_TRAVERSE(cp->perms, perm, list) {
1089                                 ast_cli(a->fd, "\t%s -> %s\n", perm->permit ? "permit" : "deny", perm->command);
1090                         }
1091                 }
1092                 ast_cli(a->fd, "\n");
1093         }
1094         AST_RWLIST_UNLOCK(&cli_perms);
1095
1096         return CLI_SUCCESS;
1097 }
1098
1099 /*! \brief handles CLI command 'cli reload permissions' */
1100 static char *handle_cli_reload_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1101 {
1102         switch (cmd) {
1103         case CLI_INIT:
1104                 e->command = "cli reload permissions";
1105                 e->usage =
1106                         "Usage: cli reload permissions\n"
1107                         "       Reload the 'cli_permissions.conf' file.\n";
1108                 return NULL;
1109         case CLI_GENERATE:
1110                 return NULL;
1111         }
1112
1113         ast_cli_perms_init(1);
1114
1115         return CLI_SUCCESS;
1116 }
1117
1118 /*! \brief handles CLI command 'cli check permissions' */
1119 static char *handle_cli_check_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1120 {
1121         struct passwd *pw = NULL;
1122         struct group *gr;
1123         int gid = -1, uid = -1;
1124         char command[AST_MAX_ARGS] = "";
1125         struct ast_cli_entry *ce = NULL;
1126         int found = 0;
1127         char *group, *tmp;
1128
1129         switch (cmd) {
1130         case CLI_INIT:
1131                 e->command = "cli check permissions";
1132                 e->usage =
1133                         "Usage: cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>]\n"
1134                         "       Check permissions config for a user@group or list the allowed commands for the specified user.\n"
1135                         "       The username or the groupname may be omitted.\n";
1136                 return NULL;
1137         case CLI_GENERATE:
1138                 if (a->pos >= 4) {
1139                         return ast_cli_generator(a->line + strlen("cli check permissions") + strlen(a->argv[3]) + 1, a->word, a->n);
1140                 }
1141                 return NULL;
1142         }
1143
1144         if (a->argc < 4) {
1145                 return CLI_SHOWUSAGE;
1146         }
1147
1148         tmp = ast_strdupa(a->argv[3]);
1149         group = strchr(tmp, '@');
1150         if (group) {
1151                 gr = getgrnam(&group[1]);
1152                 if (!gr) {
1153                         ast_cli(a->fd, "Unknown group '%s'\n", &group[1]);
1154                         return CLI_FAILURE;
1155                 }
1156                 group[0] = '\0';
1157                 gid = gr->gr_gid;
1158         }
1159
1160         if (!group && ast_strlen_zero(tmp)) {
1161                 ast_cli(a->fd, "You didn't supply a username\n");
1162         } else if (!ast_strlen_zero(tmp) && !(pw = getpwnam(tmp))) {
1163                 ast_cli(a->fd, "Unknown user '%s'\n", tmp);
1164                 return CLI_FAILURE;
1165         } else if (pw) {
1166                 uid = pw->pw_uid;
1167         }
1168
1169         if (a->argc == 4) {
1170                 while ((ce = cli_next(ce))) {
1171                         /* Hide commands that start with '_' */
1172                         if (ce->_full_cmd[0] == '_') {
1173                                 continue;
1174                         }
1175                         if (cli_has_permissions(uid, gid, ce->_full_cmd)) {
1176                                 ast_cli(a->fd, "%30.30s %s\n", ce->_full_cmd, S_OR(ce->summary, "<no description available>"));
1177                                 found++;
1178                         }
1179                 }
1180                 if (!found) {
1181                         ast_cli(a->fd, "You are not allowed to run any command on Asterisk\n");
1182                 }
1183         } else {
1184                 ast_join(command, sizeof(command), a->argv + 4);
1185                 ast_cli(a->fd, "%s '%s%s%s' is %s to run command: '%s'\n", uid >= 0 ? "User" : "Group", tmp,
1186                         group && uid >= 0 ? "@" : "",
1187                         group ? &group[1] : "",
1188                         cli_has_permissions(uid, gid, command) ? "allowed" : "not allowed", command);
1189         }
1190
1191         return CLI_SUCCESS;
1192 }
1193
1194 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
1195
1196 static char *handle_commandmatchesarray(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1197 {
1198         char *buf, *obuf;
1199         int buflen = 2048;
1200         int len = 0;
1201         char **matches;
1202         int x, matchlen;
1203
1204         switch (cmd) {
1205         case CLI_INIT:
1206                 e->command = "_command matchesarray";
1207                 e->usage =
1208                         "Usage: _command matchesarray \"<line>\" text \n"
1209                         "       This function is used internally to help with command completion and should.\n"
1210                         "       never be called by the user directly.\n";
1211                 return NULL;
1212         case CLI_GENERATE:
1213                 return NULL;
1214         }
1215
1216         if (a->argc != 4)
1217                 return CLI_SHOWUSAGE;
1218         if (!(buf = ast_malloc(buflen)))
1219                 return CLI_FAILURE;
1220         buf[len] = '\0';
1221         matches = ast_cli_completion_matches(a->argv[2], a->argv[3]);
1222         if (matches) {
1223                 for (x=0; matches[x]; x++) {
1224                         matchlen = strlen(matches[x]) + 1;
1225                         if (len + matchlen >= buflen) {
1226                                 buflen += matchlen * 3;
1227                                 obuf = buf;
1228                                 if (!(buf = ast_realloc(obuf, buflen)))
1229                                         /* Memory allocation failure...  Just free old buffer and be done */
1230                                         ast_free(obuf);
1231                         }
1232                         if (buf)
1233                                 len += sprintf( buf + len, "%s ", matches[x]);
1234                         ast_free(matches[x]);
1235                         matches[x] = NULL;
1236                 }
1237                 ast_free(matches);
1238         }
1239
1240         if (buf) {
1241                 ast_cli(a->fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
1242                 ast_free(buf);
1243         } else
1244                 ast_cli(a->fd, "NULL\n");
1245
1246         return CLI_SUCCESS;
1247 }
1248
1249
1250
1251 static char *handle_commandnummatches(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1252 {
1253         int matches = 0;
1254
1255         switch (cmd) {
1256         case CLI_INIT:
1257                 e->command = "_command nummatches";
1258                 e->usage =
1259                         "Usage: _command nummatches \"<line>\" text \n"
1260                         "       This function is used internally to help with command completion and should.\n"
1261                         "       never be called by the user directly.\n";
1262                 return NULL;
1263         case CLI_GENERATE:
1264                 return NULL;
1265         }
1266
1267         if (a->argc != 4)
1268                 return CLI_SHOWUSAGE;
1269
1270         matches = ast_cli_generatornummatches(a->argv[2], a->argv[3]);
1271
1272         ast_cli(a->fd, "%d", matches);
1273
1274         return CLI_SUCCESS;
1275 }
1276
1277 static char *handle_commandcomplete(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1278 {
1279         char *buf;
1280         switch (cmd) {
1281         case CLI_INIT:
1282                 e->command = "_command complete";
1283                 e->usage =
1284                         "Usage: _command complete \"<line>\" text state\n"
1285                         "       This function is used internally to help with command completion and should.\n"
1286                         "       never be called by the user directly.\n";
1287                 return NULL;
1288         case CLI_GENERATE:
1289                 return NULL;
1290         }
1291         if (a->argc != 5)
1292                 return CLI_SHOWUSAGE;
1293         buf = __ast_cli_generator(a->argv[2], a->argv[3], atoi(a->argv[4]), 0);
1294         if (buf) {
1295                 ast_cli(a->fd, "%s", buf);
1296                 ast_free(buf);
1297         } else
1298                 ast_cli(a->fd, "NULL\n");
1299         return CLI_SUCCESS;
1300 }
1301
1302 struct channel_set_debug_args {
1303         int fd;
1304         int is_off;
1305 };
1306
1307 static int channel_set_debug(void *obj, void *arg, void *data, int flags)
1308 {
1309         struct ast_channel *chan = obj;
1310         struct channel_set_debug_args *args = data;
1311
1312         ast_channel_lock(chan);
1313
1314         if (!(ast_channel_fin(chan) & DEBUGCHAN_FLAG) || !(ast_channel_fout(chan) & DEBUGCHAN_FLAG)) {
1315                 if (args->is_off) {
1316                         ast_channel_fin_set(chan, ast_channel_fin(chan) & ~DEBUGCHAN_FLAG);
1317                         ast_channel_fout_set(chan, ast_channel_fout(chan) & ~DEBUGCHAN_FLAG);
1318                 } else {
1319                         ast_channel_fin_set(chan, ast_channel_fin(chan) | DEBUGCHAN_FLAG);
1320                         ast_channel_fout_set(chan, ast_channel_fout(chan) | DEBUGCHAN_FLAG);
1321                 }
1322                 ast_cli(args->fd, "Debugging %s on channel %s\n", args->is_off ? "disabled" : "enabled",
1323                                 ast_channel_name(chan));
1324         }
1325
1326         ast_channel_unlock(chan);
1327
1328         return 0;
1329 }
1330
1331 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1332 {
1333         struct ast_channel *c = NULL;
1334         struct channel_set_debug_args args = {
1335                 .fd = a->fd,
1336         };
1337
1338         switch (cmd) {
1339         case CLI_INIT:
1340                 e->command = "core set debug channel";
1341                 e->usage =
1342                         "Usage: core set debug channel <all|channel> [off]\n"
1343                         "       Enables/disables debugging on all or on a specific channel.\n";
1344                 return NULL;
1345         case CLI_GENERATE:
1346                 /* XXX remember to handle the optional "off" */
1347                 if (a->pos != e->args)
1348                         return NULL;
1349                 return a->n == 0 ? ast_strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
1350         }
1351
1352         if (cmd == (CLI_HANDLER + 1000)) {
1353                 /* called from handle_nodebugchan_deprecated */
1354                 args.is_off = 1;
1355         } else if (a->argc == e->args + 2) {
1356                 /* 'core set debug channel {all|chan_id}' */
1357                 if (!strcasecmp(a->argv[e->args + 1], "off"))
1358                         args.is_off = 1;
1359                 else
1360                         return CLI_SHOWUSAGE;
1361         } else if (a->argc != e->args + 1) {
1362                 return CLI_SHOWUSAGE;
1363         }
1364
1365         if (!strcasecmp("all", a->argv[e->args])) {
1366                 if (args.is_off) {
1367                         global_fin &= ~DEBUGCHAN_FLAG;
1368                         global_fout &= ~DEBUGCHAN_FLAG;
1369                 } else {
1370                         global_fin |= DEBUGCHAN_FLAG;
1371                         global_fout |= DEBUGCHAN_FLAG;
1372                 }
1373                 ast_channel_callback(channel_set_debug, NULL, &args, OBJ_NODATA | OBJ_MULTIPLE);
1374         } else {
1375                 if ((c = ast_channel_get_by_name(a->argv[e->args]))) {
1376                         channel_set_debug(c, NULL, &args, 0);
1377                         ast_channel_unref(c);
1378                 } else {
1379                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
1380                 }
1381         }
1382
1383         ast_cli(a->fd, "Debugging on new channels is %s\n", args.is_off ? "disabled" : "enabled");
1384
1385         return CLI_SUCCESS;
1386 }
1387
1388 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1389 {
1390         char *res;
1391
1392         switch (cmd) {
1393         case CLI_INIT:
1394                 e->command = "no debug channel";
1395                 return NULL;
1396         case CLI_HANDLER:
1397                 /* exit out of switch statement */
1398                 break;
1399         default:
1400                 return NULL;
1401         }
1402
1403         if (a->argc != e->args + 1)
1404                 return CLI_SHOWUSAGE;
1405
1406         /* add a 'magic' value to the CLI_HANDLER command so that
1407          * handle_core_set_debug_channel() will act as if 'off'
1408          * had been specified as part of the command
1409          */
1410         res = handle_core_set_debug_channel(e, CLI_HANDLER + 1000, a);
1411
1412         return res;
1413 }
1414
1415 static char *handle_showchan(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1416 {
1417         struct ast_channel *c=NULL;
1418         struct timeval now;
1419         char cdrtime[256];
1420         char nf[256];
1421         struct ast_str *write_transpath = ast_str_alloca(256);
1422         struct ast_str *read_transpath = ast_str_alloca(256);
1423         struct ast_str *obuf;/*!< Buffer for variable, CDR variable, and trace output. */
1424         struct ast_str *output;/*!< Accumulation buffer for all output. */
1425         long elapsed_seconds=0;
1426         int hour=0, min=0, sec=0;
1427         struct ast_callid *callid;
1428         char call_identifier_str[AST_CALLID_BUFFER_LENGTH] = "";
1429         struct ast_party_id effective_connected_id;
1430 #ifdef CHANNEL_TRACE
1431         int trace_enabled;
1432 #endif
1433         struct ast_bridge *bridge;
1434
1435         switch (cmd) {
1436         case CLI_INIT:
1437                 e->command = "core show channel";
1438                 e->usage =
1439                         "Usage: core show channel <channel>\n"
1440                         "       Shows lots of information about the specified channel.\n";
1441                 return NULL;
1442         case CLI_GENERATE:
1443                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
1444         }
1445
1446         if (a->argc != 4) {
1447                 return CLI_SHOWUSAGE;
1448         }
1449
1450         now = ast_tvnow();
1451
1452         if (!(c = ast_channel_get_by_name(a->argv[3]))) {
1453                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1454                 return CLI_SUCCESS;
1455         }
1456
1457         obuf = ast_str_thread_get(&ast_str_thread_global_buf, 16);
1458         if (!obuf) {
1459                 return CLI_FAILURE;
1460         }
1461         output = ast_str_create(8192);
1462         if (!output) {
1463                 return CLI_FAILURE;
1464         }
1465
1466         ast_channel_lock(c);
1467
1468         if (ast_channel_cdr(c)) {
1469                 elapsed_seconds = now.tv_sec - ast_channel_cdr(c)->start.tv_sec;
1470                 hour = elapsed_seconds / 3600;
1471                 min = (elapsed_seconds % 3600) / 60;
1472                 sec = elapsed_seconds % 60;
1473                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
1474         } else {
1475                 strcpy(cdrtime, "N/A");
1476         }
1477
1478         /* Construct the call identifier string based on the status of the channel's call identifier */
1479         if ((callid = ast_channel_callid(c))) {
1480                 ast_callid_strnprint(call_identifier_str, sizeof(call_identifier_str), callid);
1481                 ast_callid_unref(callid);
1482         }
1483
1484         effective_connected_id = ast_channel_connected_effective_id(c);
1485         bridge = ast_channel_get_bridge(c);
1486
1487         ast_str_append(&output, 0,
1488                 " -- General --\n"
1489                 "           Name: %s\n"
1490                 "           Type: %s\n"
1491                 "       UniqueID: %s\n"
1492                 "       LinkedID: %s\n"
1493                 "      Caller ID: %s\n"
1494                 " Caller ID Name: %s\n"
1495                 "Connected Line ID: %s\n"
1496                 "Connected Line ID Name: %s\n"
1497                 "Eff. Connected Line ID: %s\n"
1498                 "Eff. Connected Line ID Name: %s\n"
1499                 "    DNID Digits: %s\n"
1500                 "       Language: %s\n"
1501                 "          State: %s (%d)\n"
1502                 "          Rings: %d\n"
1503                 "  NativeFormats: %s\n"
1504                 "    WriteFormat: %s\n"
1505                 "     ReadFormat: %s\n"
1506                 " WriteTranscode: %s %s\n"
1507                 "  ReadTranscode: %s %s\n"
1508                 "1st File Descriptor: %d\n"
1509                 "      Frames in: %d%s\n"
1510                 "     Frames out: %d%s\n"
1511                 " Time to Hangup: %ld\n"
1512                 "   Elapsed Time: %s\n"
1513                 "      Bridge ID: %s\n"
1514                 " --   PBX   --\n"
1515                 "        Context: %s\n"
1516                 "      Extension: %s\n"
1517                 "       Priority: %d\n"
1518                 "     Call Group: %llu\n"
1519                 "   Pickup Group: %llu\n"
1520                 "    Application: %s\n"
1521                 "           Data: %s\n"
1522                 "    Blocking in: %s\n"
1523                 " Call Identifer: %s\n",
1524                 ast_channel_name(c),
1525                 ast_channel_tech(c)->type,
1526                 ast_channel_uniqueid(c),
1527                 ast_channel_linkedid(c),
1528                 S_COR(ast_channel_caller(c)->id.number.valid, ast_channel_caller(c)->id.number.str, "(N/A)"),
1529                 S_COR(ast_channel_caller(c)->id.name.valid, ast_channel_caller(c)->id.name.str, "(N/A)"),
1530                 S_COR(ast_channel_connected(c)->id.number.valid, ast_channel_connected(c)->id.number.str, "(N/A)"),
1531                 S_COR(ast_channel_connected(c)->id.name.valid, ast_channel_connected(c)->id.name.str, "(N/A)"),
1532                 S_COR(effective_connected_id.number.valid, effective_connected_id.number.str, "(N/A)"),
1533                 S_COR(effective_connected_id.name.valid, effective_connected_id.name.str, "(N/A)"),
1534                 S_OR(ast_channel_dialed(c)->number.str, "(N/A)"),
1535                 ast_channel_language(c),
1536                 ast_state2str(ast_channel_state(c)),
1537                 ast_channel_state(c),
1538                 ast_channel_rings(c),
1539                 ast_getformatname_multiple(nf, sizeof(nf), ast_channel_nativeformats(c)),
1540                 ast_getformatname(ast_channel_writeformat(c)),
1541                 ast_getformatname(ast_channel_readformat(c)),
1542                 ast_channel_writetrans(c) ? "Yes" : "No",
1543                 ast_translate_path_to_str(ast_channel_writetrans(c), &write_transpath),
1544                 ast_channel_readtrans(c) ? "Yes" : "No",
1545                 ast_translate_path_to_str(ast_channel_readtrans(c), &read_transpath),
1546                 ast_channel_fd(c, 0),
1547                 ast_channel_fin(c) & ~DEBUGCHAN_FLAG,
1548                 (ast_channel_fin(c) & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1549                 ast_channel_fout(c) & ~DEBUGCHAN_FLAG,
1550                 (ast_channel_fout(c) & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1551                 (long) ast_channel_whentohangup(c)->tv_sec,
1552                 cdrtime,
1553                 bridge ? bridge->uniqueid : "(Not bridged)",
1554                 ast_channel_context(c),
1555                 ast_channel_exten(c),
1556                 ast_channel_priority(c),
1557                 ast_channel_callgroup(c),
1558                 ast_channel_pickupgroup(c),
1559                 (ast_channel_appl(c) ? ast_channel_appl(c) : "(N/A)" ),
1560                 (ast_channel_data(c) ? S_OR(ast_channel_data(c), "(Empty)") : "(None)"),
1561                 (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING) ? ast_channel_blockproc(c) : "(Not Blocking)"),
1562                 S_OR(call_identifier_str, "(None)"));
1563
1564         if (pbx_builtin_serialize_variables(c, &obuf)) {
1565                 ast_str_append(&output, 0, "      Variables:\n%s\n", ast_str_buffer(obuf));
1566         }
1567
1568         if (ast_channel_cdr(c) && ast_cdr_serialize_variables(ast_channel_cdr(c), &obuf, '=', '\n', 1)) {
1569                 ast_str_append(&output, 0, "  CDR Variables:\n%s\n", ast_str_buffer(obuf));
1570         }
1571
1572 #ifdef CHANNEL_TRACE
1573         trace_enabled = ast_channel_trace_is_enabled(c);
1574         ast_str_append(&output, 0, "  Context Trace: %s\n",
1575                 trace_enabled ? "Enabled" : "Disabled");
1576         if (trace_enabled && ast_channel_trace_serialize(c, &obuf)) {
1577                 ast_str_append(&output, 0, "          Trace:\n%s\n", ast_str_buffer(obuf));
1578         }
1579 #endif
1580
1581         ast_channel_unlock(c);
1582         c = ast_channel_unref(c);
1583         ao2_cleanup(bridge);
1584
1585         ast_cli(a->fd, "%s", ast_str_buffer(output));
1586         ast_free(output);
1587         return CLI_SUCCESS;
1588 }
1589
1590 /*
1591  * helper function to generate CLI matches from a fixed set of values.
1592  * A NULL word is acceptable.
1593  */
1594 char *ast_cli_complete(const char *word, const char * const choices[], int state)
1595 {
1596         int i, which = 0, len;
1597         len = ast_strlen_zero(word) ? 0 : strlen(word);
1598
1599         for (i = 0; choices[i]; i++) {
1600                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
1601                         return ast_strdup(choices[i]);
1602         }
1603         return NULL;
1604 }
1605
1606 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
1607 {
1608         struct ast_channel *c = NULL;
1609         int which = 0;
1610         char notfound = '\0';
1611         char *ret = &notfound; /* so NULL can break the loop */
1612         struct ast_channel_iterator *iter;
1613
1614         if (pos != rpos) {
1615                 return NULL;
1616         }
1617
1618         if (ast_strlen_zero(word)) {
1619                 iter = ast_channel_iterator_all_new();
1620         } else {
1621                 iter = ast_channel_iterator_by_name_new(word, strlen(word));
1622         }
1623
1624         if (!iter) {
1625                 return NULL;
1626         }
1627
1628         while (ret == &notfound && (c = ast_channel_iterator_next(iter))) {
1629                 if (++which > state) {
1630                         ast_channel_lock(c);
1631                         ret = ast_strdup(ast_channel_name(c));
1632                         ast_channel_unlock(c);
1633                 }
1634                 ast_channel_unref(c);
1635         }
1636
1637         ast_channel_iterator_destroy(iter);
1638
1639         return ret == &notfound ? NULL : ret;
1640 }
1641
1642 static char *group_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1643 {
1644 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1645
1646         struct ast_group_info *gi = NULL;
1647         int numchans = 0;
1648         regex_t regexbuf;
1649         int havepattern = 0;
1650
1651         switch (cmd) {
1652         case CLI_INIT:
1653                 e->command = "group show channels";
1654                 e->usage =
1655                         "Usage: group show channels [pattern]\n"
1656                         "       Lists all currently active channels with channel group(s) specified.\n"
1657                         "       Optional regular expression pattern is matched to group names for each\n"
1658                         "       channel.\n";
1659                 return NULL;
1660         case CLI_GENERATE:
1661                 return NULL;
1662         }
1663
1664         if (a->argc < 3 || a->argc > 4)
1665                 return CLI_SHOWUSAGE;
1666
1667         if (a->argc == 4) {
1668                 if (regcomp(&regexbuf, a->argv[3], REG_EXTENDED | REG_NOSUB))
1669                         return CLI_SHOWUSAGE;
1670                 havepattern = 1;
1671         }
1672
1673         ast_cli(a->fd, FORMAT_STRING, "Channel", "Group", "Category");
1674
1675         ast_app_group_list_rdlock();
1676
1677         gi = ast_app_group_list_head();
1678         while (gi) {
1679                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1680                         ast_cli(a->fd, FORMAT_STRING, ast_channel_name(gi->chan), gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1681                         numchans++;
1682                 }
1683                 gi = AST_LIST_NEXT(gi, group_list);
1684         }
1685
1686         ast_app_group_list_unlock();
1687
1688         if (havepattern)
1689                 regfree(&regexbuf);
1690
1691         ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1692         return CLI_SUCCESS;
1693 #undef FORMAT_STRING
1694 }
1695
1696 static char *handle_cli_wait_fullybooted(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1697 {
1698         switch (cmd) {
1699         case CLI_INIT:
1700                 e->command = "core waitfullybooted";
1701                 e->usage =
1702                         "Usage: core waitfullybooted\n"
1703                         "       Wait until Asterisk has fully booted.\n";
1704                 return NULL;
1705         case CLI_GENERATE:
1706                 return NULL;
1707         }
1708
1709         while (!ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1710                 usleep(100);
1711         }
1712
1713         ast_cli(a->fd, "Asterisk has fully booted.\n");
1714
1715         return CLI_SUCCESS;
1716 }
1717
1718 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1719
1720 static struct ast_cli_entry cli_cli[] = {
1721         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1722         AST_CLI_DEFINE(handle_commandcomplete, "Command complete"),
1723         AST_CLI_DEFINE(handle_commandnummatches, "Returns number of command matches"),
1724         AST_CLI_DEFINE(handle_commandmatchesarray, "Returns command matches array"),
1725
1726         AST_CLI_DEFINE(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1727
1728         AST_CLI_DEFINE(handle_chanlist, "Display information on channels"),
1729
1730         AST_CLI_DEFINE(handle_showcalls, "Display information on calls"),
1731
1732         AST_CLI_DEFINE(handle_showchan, "Display information on a specific channel"),
1733
1734         AST_CLI_DEFINE(handle_core_set_debug_channel, "Enable/disable debugging on a channel"),
1735
1736         AST_CLI_DEFINE(handle_verbose, "Set level of debug/verbose chattiness"),
1737
1738         AST_CLI_DEFINE(group_show_channels, "Display active channels with group(s)"),
1739
1740         AST_CLI_DEFINE(handle_help, "Display help list, or specific help on a command"),
1741
1742         AST_CLI_DEFINE(handle_logger_mute, "Toggle logging output to a console"),
1743
1744         AST_CLI_DEFINE(handle_modlist, "List modules and info"),
1745
1746         AST_CLI_DEFINE(handle_load, "Load a module by name"),
1747
1748         AST_CLI_DEFINE(handle_reload, "Reload configuration for a module"),
1749
1750         AST_CLI_DEFINE(handle_core_reload, "Global reload"),
1751
1752         AST_CLI_DEFINE(handle_unload, "Unload a module by name"),
1753
1754         AST_CLI_DEFINE(handle_showuptime, "Show uptime information"),
1755
1756         AST_CLI_DEFINE(handle_softhangup, "Request a hangup on a given channel"),
1757
1758         AST_CLI_DEFINE(handle_cli_reload_permissions, "Reload CLI permissions config"),
1759
1760         AST_CLI_DEFINE(handle_cli_show_permissions, "Show CLI permissions"),
1761
1762         AST_CLI_DEFINE(handle_cli_check_permissions, "Try a permissions config for a user"),
1763
1764         AST_CLI_DEFINE(handle_cli_wait_fullybooted, "Wait for Asterisk to be fully booted"),
1765 };
1766
1767 /*!
1768  * Some regexp characters in cli arguments are reserved and used as separators.
1769  */
1770 static const char cli_rsvd[] = "[]{}|*%";
1771
1772 /*!
1773  * initialize the _full_cmd string and related parameters,
1774  * return 0 on success, -1 on error.
1775  */
1776 static int set_full_cmd(struct ast_cli_entry *e)
1777 {
1778         int i;
1779         char buf[80];
1780
1781         ast_join(buf, sizeof(buf), e->cmda);
1782         e->_full_cmd = ast_strdup(buf);
1783         if (!e->_full_cmd) {
1784                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1785                 return -1;
1786         }
1787         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1788         for (i = 0; e->cmda[i]; i++)
1789                 ;
1790         e->args = i;
1791         return 0;
1792 }
1793
1794 /*! \brief cleanup (free) cli_perms linkedlist. */
1795 static void destroy_user_perms(void)
1796 {
1797         struct cli_perm *perm;
1798         struct usergroup_cli_perm *user_perm;
1799
1800         AST_RWLIST_WRLOCK(&cli_perms);
1801         while ((user_perm = AST_LIST_REMOVE_HEAD(&cli_perms, list))) {
1802                 while ((perm = AST_LIST_REMOVE_HEAD(user_perm->perms, list))) {
1803                         ast_free(perm->command);
1804                         ast_free(perm);
1805                 }
1806                 ast_free(user_perm);
1807         }
1808         AST_RWLIST_UNLOCK(&cli_perms);
1809 }
1810
1811 int ast_cli_perms_init(int reload)
1812 {
1813         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1814         struct ast_config *cfg;
1815         char *cat = NULL;
1816         struct ast_variable *v;
1817         struct usergroup_cli_perm *user_group, *cp_entry;
1818         struct cli_perm *perm = NULL;
1819         struct passwd *pw;
1820         struct group *gr;
1821
1822         if (ast_mutex_trylock(&permsconfiglock)) {
1823                 ast_log(LOG_NOTICE, "You must wait until last 'cli reload permissions' command finish\n");
1824                 return 1;
1825         }
1826
1827         cfg = ast_config_load2(perms_config, "" /* core, can't reload */, config_flags);
1828         if (!cfg) {
1829                 ast_mutex_unlock(&permsconfiglock);
1830                 return 1;
1831         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
1832                 ast_mutex_unlock(&permsconfiglock);
1833                 return 0;
1834         }
1835
1836         /* free current structures. */
1837         destroy_user_perms();
1838
1839         while ((cat = ast_category_browse(cfg, cat))) {
1840                 if (!strcasecmp(cat, "general")) {
1841                         /* General options */
1842                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1843                                 if (!strcasecmp(v->name, "default_perm")) {
1844                                         cli_default_perm = (!strcasecmp(v->value, "permit")) ? 1: 0;
1845                                 }
1846                         }
1847                         continue;
1848                 }
1849
1850                 /* users or groups */
1851                 gr = NULL, pw = NULL;
1852                 if (cat[0] == '@') {
1853                         /* This is a group */
1854                         gr = getgrnam(&cat[1]);
1855                         if (!gr) {
1856                                 ast_log (LOG_WARNING, "Unknown group '%s'\n", &cat[1]);
1857                                 continue;
1858                         }
1859                 } else {
1860                         /* This is a user */
1861                         pw = getpwnam(cat);
1862                         if (!pw) {
1863                                 ast_log (LOG_WARNING, "Unknown user '%s'\n", cat);
1864                                 continue;
1865                         }
1866                 }
1867                 user_group = NULL;
1868                 /* Check for duplicates */
1869                 AST_RWLIST_WRLOCK(&cli_perms);
1870                 AST_LIST_TRAVERSE(&cli_perms, cp_entry, list) {
1871                         if ((pw && cp_entry->uid == pw->pw_uid) || (gr && cp_entry->gid == gr->gr_gid)) {
1872                                 /* if it is duplicated, just added this new settings, to
1873                                 the current list. */
1874                                 user_group = cp_entry;
1875                                 break;
1876                         }
1877                 }
1878                 AST_RWLIST_UNLOCK(&cli_perms);
1879
1880                 if (!user_group) {
1881                         /* alloc space for the new user config. */
1882                         user_group = ast_calloc(1, sizeof(*user_group));
1883                         if (!user_group) {
1884                                 continue;
1885                         }
1886                         user_group->uid = (pw ? pw->pw_uid : -1);
1887                         user_group->gid = (gr ? gr->gr_gid : -1);
1888                         user_group->perms = ast_calloc(1, sizeof(*user_group->perms));
1889                         if (!user_group->perms) {
1890                                 ast_free(user_group);
1891                                 continue;
1892                         }
1893                 }
1894                 for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1895                         if (ast_strlen_zero(v->value)) {
1896                                 /* we need to check this condition cause it could break security. */
1897                                 ast_log(LOG_WARNING, "Empty permit/deny option in user '%s'\n", cat);
1898                                 continue;
1899                         }
1900                         if (!strcasecmp(v->name, "permit")) {
1901                                 perm = ast_calloc(1, sizeof(*perm));
1902                                 if (perm) {
1903                                         perm->permit = 1;
1904                                         perm->command = ast_strdup(v->value);
1905                                 }
1906                         } else if (!strcasecmp(v->name, "deny")) {
1907                                 perm = ast_calloc(1, sizeof(*perm));
1908                                 if (perm) {
1909                                         perm->permit = 0;
1910                                         perm->command = ast_strdup(v->value);
1911                                 }
1912                         } else {
1913                                 /* up to now, only 'permit' and 'deny' are possible values. */
1914                                 ast_log(LOG_WARNING, "Unknown '%s' option\n", v->name);
1915                                 continue;
1916                         }
1917                         if (perm) {
1918                                 /* Added the permission to the user's list. */
1919                                 AST_LIST_INSERT_TAIL(user_group->perms, perm, list);
1920                                 perm = NULL;
1921                         }
1922                 }
1923                 AST_RWLIST_WRLOCK(&cli_perms);
1924                 AST_RWLIST_INSERT_TAIL(&cli_perms, user_group, list);
1925                 AST_RWLIST_UNLOCK(&cli_perms);
1926         }
1927
1928         ast_config_destroy(cfg);
1929         ast_mutex_unlock(&permsconfiglock);
1930         return 0;
1931 }
1932
1933 static void cli_shutdown(void)
1934 {
1935         ast_cli_unregister_multiple(cli_cli, ARRAY_LEN(cli_cli));
1936 }
1937
1938 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1939 void ast_builtins_init(void)
1940 {
1941         ast_cli_register_multiple(cli_cli, ARRAY_LEN(cli_cli));
1942         ast_register_atexit(cli_shutdown);
1943 }
1944
1945 /*!
1946  * match a word in the CLI entry.
1947  * returns -1 on mismatch, 0 on match of an optional word,
1948  * 1 on match of a full word.
1949  *
1950  * The pattern can be
1951  *   any_word           match for equal
1952  *   [foo|bar|baz]      optionally, one of these words
1953  *   {foo|bar|baz}      exactly, one of these words
1954  *   %                  any word
1955  */
1956 static int word_match(const char *cmd, const char *cli_word)
1957 {
1958         int l;
1959         char *pos;
1960
1961         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1962                 return -1;
1963         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1964                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1965         l = strlen(cmd);
1966         /* wildcard match - will extend in the future */
1967         if (l > 0 && cli_word[0] == '%') {
1968                 return 1;       /* wildcard */
1969         }
1970
1971         /* Start a search for the command entered against the cli word in question */
1972         pos = strcasestr(cli_word, cmd);
1973         while (pos) {
1974
1975                 /*
1976                  *Check if the word matched with is surrounded by reserved characters on both sides
1977                  * and isn't at the beginning of the cli_word since that would make it check in a location we shouldn't know about.
1978                  * If it is surrounded by reserved chars and isn't at the beginning, it's a match.
1979                  */
1980                 if (pos != cli_word && strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l])) {
1981                         return 1;       /* valid match */
1982                 }
1983
1984                 /* Ok, that one didn't match, strcasestr to the next appearance of the command and start over.*/
1985                 pos = strcasestr(pos + 1, cmd);
1986         }
1987         /* If no matches were found over the course of the while loop, we hit the end of the string. It's a mismatch. */
1988         return -1;
1989 }
1990
1991 /*! \brief if word is a valid prefix for token, returns the pos-th
1992  * match as a malloced string, or NULL otherwise.
1993  * Always tell in *actual how many matches we got.
1994  */
1995 static char *is_prefix(const char *word, const char *token,
1996         int pos, int *actual)
1997 {
1998         int lw;
1999         char *s, *t1;
2000
2001         *actual = 0;
2002         if (ast_strlen_zero(token))
2003                 return NULL;
2004         if (ast_strlen_zero(word))
2005                 word = "";      /* dummy */
2006         lw = strlen(word);
2007         if (strcspn(word, cli_rsvd) != lw)
2008                 return NULL;    /* no match if word has reserved chars */
2009         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
2010                 if (strncasecmp(token, word, lw))       /* no match */
2011                         return NULL;
2012                 *actual = 1;
2013                 return (pos != 0) ? NULL : ast_strdup(token);
2014         }
2015         /* now handle regexp match */
2016
2017         /* Wildcard always matches, so we never do is_prefix on them */
2018
2019         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
2020         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
2021                 if (*s == '%')  /* wildcard */
2022                         continue;
2023                 if (strncasecmp(s, word, lw))   /* no match */
2024                         continue;
2025                 (*actual)++;
2026                 if (pos-- == 0)
2027                         return ast_strdup(s);
2028         }
2029         return NULL;
2030 }
2031
2032 /*!
2033  * \internal
2034  * \brief locate a cli command in the 'helpers' list (which must be locked).
2035  *     The search compares word by word taking care of regexps in e->cmda
2036  *     This function will return NULL when nothing is matched, or the ast_cli_entry that matched.
2037  * \param cmds
2038  * \param match_type has 3 possible values:
2039  *      0       returns if the search key is equal or longer than the entry.
2040  *                          note that trailing optional arguments are skipped.
2041  *      -1      true if the mismatch is on the last word XXX not true!
2042  *      1       true only on complete, exact match.
2043  *
2044  */
2045 static struct ast_cli_entry *find_cli(const char * const cmds[], int match_type)
2046 {
2047         int matchlen = -1;      /* length of longest match so far */
2048         struct ast_cli_entry *cand = NULL, *e=NULL;
2049
2050         while ( (e = cli_next(e)) ) {
2051                 /* word-by word regexp comparison */
2052                 const char * const *src = cmds;
2053                 const char * const *dst = e->cmda;
2054                 int n = 0;
2055                 for (;; dst++, src += n) {
2056                         n = word_match(*src, *dst);
2057                         if (n < 0)
2058                                 break;
2059                 }
2060                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
2061                         /* no more words in 'e' */
2062                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
2063                                 break;
2064                         /* Here, cmds has more words than the entry 'e' */
2065                         if (match_type != 0)    /* but we look for almost exact match... */
2066                                 continue;       /* so we skip this one. */
2067                         /* otherwise we like it (case 0) */
2068                 } else {        /* still words in 'e' */
2069                         if (ast_strlen_zero(*src))
2070                                 continue; /* cmds is shorter than 'e', not good */
2071                         /* Here we have leftover words in cmds and 'e',
2072                          * but there is a mismatch. We only accept this one if match_type == -1
2073                          * and this is the last word for both.
2074                          */
2075                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
2076                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
2077                                 continue;
2078                         /* good, we are in case match_type == -1 and mismatch on last word */
2079                 }
2080                 if (src - cmds > matchlen) {    /* remember the candidate */
2081                         matchlen = src - cmds;
2082                         cand = e;
2083                 }
2084         }
2085
2086         return e ? e : cand;
2087 }
2088
2089 static char *find_best(const char *argv[])
2090 {
2091         static char cmdline[80];
2092         int x;
2093         /* See how close we get, then print the candidate */
2094         const char *myargv[AST_MAX_CMD_LEN] = { NULL, };
2095
2096         AST_RWLIST_RDLOCK(&helpers);
2097         for (x = 0; argv[x]; x++) {
2098                 myargv[x] = argv[x];
2099                 if (!find_cli(myargv, -1))
2100                         break;
2101         }
2102         AST_RWLIST_UNLOCK(&helpers);
2103         ast_join(cmdline, sizeof(cmdline), myargv);
2104         return cmdline;
2105 }
2106
2107 static int cli_is_registered(struct ast_cli_entry *e)
2108 {
2109         struct ast_cli_entry *cur = NULL;
2110
2111         while ((cur = cli_next(cur))) {
2112                 if (cur == e) {
2113                         return 1;
2114                 }
2115         }
2116         return 0;
2117 }
2118
2119 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
2120 {
2121         if (e->inuse) {
2122                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
2123         } else {
2124                 AST_RWLIST_WRLOCK(&helpers);
2125                 AST_RWLIST_REMOVE(&helpers, e, list);
2126                 AST_RWLIST_UNLOCK(&helpers);
2127                 ast_free(e->_full_cmd);
2128                 e->_full_cmd = NULL;
2129                 if (e->handler) {
2130                         /* this is a new-style entry. Reset fields and free memory. */
2131                         char *cmda = (char *) e->cmda;
2132                         memset(cmda, '\0', sizeof(e->cmda));
2133                         ast_free(e->command);
2134                         e->command = NULL;
2135                         e->usage = NULL;
2136                 }
2137         }
2138         return 0;
2139 }
2140
2141 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
2142 {
2143         struct ast_cli_entry *cur;
2144         int i, lf, ret = -1;
2145
2146         struct ast_cli_args a;  /* fake argument */
2147         char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
2148         char *s;
2149
2150         AST_RWLIST_WRLOCK(&helpers);
2151
2152         if (cli_is_registered(e)) {
2153                 ast_log(LOG_WARNING, "Command '%s' already registered (the same ast_cli_entry)\n",
2154                         S_OR(e->_full_cmd, e->command));
2155                 ret = 0;  /* report success */
2156                 goto done;
2157         }
2158
2159         memset(&a, '\0', sizeof(a));
2160         e->handler(e, CLI_INIT, &a);
2161         /* XXX check that usage and command are filled up */
2162         s = ast_skip_blanks(e->command);
2163         s = e->command = ast_strdup(s);
2164         for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
2165                 *dst++ = s;     /* store string */
2166                 s = ast_skip_nonblanks(s);
2167                 if (*s == '\0') /* we are done */
2168                         break;
2169                 *s++ = '\0';
2170                 s = ast_skip_blanks(s);
2171         }
2172         *dst++ = NULL;
2173
2174         if (find_cli(e->cmda, 1)) {
2175                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n",
2176                         S_OR(e->_full_cmd, e->command));
2177                 goto done;
2178         }
2179         if (set_full_cmd(e)) {
2180                 ast_log(LOG_WARNING, "Error registering CLI Command '%s'\n",
2181                         S_OR(e->_full_cmd, e->command));
2182                 goto done;
2183         }
2184
2185         lf = e->cmdlen;
2186         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
2187                 int len = cur->cmdlen;
2188                 if (lf < len)
2189                         len = lf;
2190                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
2191                         AST_RWLIST_INSERT_BEFORE_CURRENT(e, list);
2192                         break;
2193                 }
2194         }
2195         AST_RWLIST_TRAVERSE_SAFE_END;
2196
2197         if (!cur)
2198                 AST_RWLIST_INSERT_TAIL(&helpers, e, list);
2199         ret = 0;        /* success */
2200
2201 done:
2202         AST_RWLIST_UNLOCK(&helpers);
2203         if (ret) {
2204                 ast_free(e->command);
2205                 e->command = NULL;
2206         }
2207
2208         return ret;
2209 }
2210
2211 /* wrapper function, so we can unregister deprecated commands recursively */
2212 int ast_cli_unregister(struct ast_cli_entry *e)
2213 {
2214         return __ast_cli_unregister(e, NULL);
2215 }
2216
2217 /* wrapper function, so we can register deprecated commands recursively */
2218 int ast_cli_register(struct ast_cli_entry *e)
2219 {
2220         return __ast_cli_register(e, NULL);
2221 }
2222
2223 /*
2224  * register/unregister an array of entries.
2225  */
2226 int ast_cli_register_multiple(struct ast_cli_entry *e, int len)
2227 {
2228         int i, res = 0;
2229
2230         for (i = 0; i < len; i++)
2231                 res |= ast_cli_register(e + i);
2232
2233         return res;
2234 }
2235
2236 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
2237 {
2238         int i, res = 0;
2239
2240         for (i = 0; i < len; i++)
2241                 res |= ast_cli_unregister(e + i);
2242
2243         return res;
2244 }
2245
2246
2247 /*! \brief helper for final part of handle_help
2248  *  if locked = 1, assume the list is already locked
2249  */
2250 static char *help1(int fd, const char * const match[], int locked)
2251 {
2252         char matchstr[80] = "";
2253         struct ast_cli_entry *e = NULL;
2254         int len = 0;
2255         int found = 0;
2256
2257         if (match) {
2258                 ast_join(matchstr, sizeof(matchstr), match);
2259                 len = strlen(matchstr);
2260         }
2261         if (!locked)
2262                 AST_RWLIST_RDLOCK(&helpers);
2263         while ( (e = cli_next(e)) ) {
2264                 /* Hide commands that start with '_' */
2265                 if (e->_full_cmd[0] == '_')
2266                         continue;
2267                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
2268                         continue;
2269                 ast_cli(fd, "%-30s -- %s\n", e->_full_cmd,
2270                         S_OR(e->summary, "<no description available>"));
2271                 found++;
2272         }
2273         if (!locked)
2274                 AST_RWLIST_UNLOCK(&helpers);
2275         if (!found && matchstr[0])
2276                 ast_cli(fd, "No such command '%s'.\n", matchstr);
2277         return CLI_SUCCESS;
2278 }
2279
2280 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2281 {
2282         char fullcmd[80];
2283         struct ast_cli_entry *my_e;
2284         char *res = CLI_SUCCESS;
2285
2286         if (cmd == CLI_INIT) {
2287                 e->command = "core show help";
2288                 e->usage =
2289                         "Usage: core show help [topic]\n"
2290                         "       When called with a topic as an argument, displays usage\n"
2291                         "       information on the given command. If called without a\n"
2292                         "       topic, it provides a list of commands.\n";
2293                 return NULL;
2294
2295         } else if (cmd == CLI_GENERATE) {
2296                 /* skip first 14 or 15 chars, "core show help " */
2297                 int l = strlen(a->line);
2298
2299                 if (l > 15) {
2300                         l = 15;
2301                 }
2302                 /* XXX watch out, should stop to the non-generator parts */
2303                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
2304         }
2305         if (a->argc == e->args) {
2306                 return help1(a->fd, NULL, 0);
2307         }
2308
2309         AST_RWLIST_RDLOCK(&helpers);
2310         my_e = find_cli(a->argv + 3, 1);        /* try exact match first */
2311         if (!my_e) {
2312                 res = help1(a->fd, a->argv + 3, 1 /* locked */);
2313                 AST_RWLIST_UNLOCK(&helpers);
2314                 return res;
2315         }
2316         if (my_e->usage)
2317                 ast_cli(a->fd, "%s", my_e->usage);
2318         else {
2319                 ast_join(fullcmd, sizeof(fullcmd), a->argv + 3);
2320                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
2321         }
2322         AST_RWLIST_UNLOCK(&helpers);
2323         return res;
2324 }
2325
2326 static char *parse_args(const char *s, int *argc, const char *argv[], int max, int *trailingwhitespace)
2327 {
2328         char *duplicate, *cur;
2329         int x = 0;
2330         int quoted = 0;
2331         int escaped = 0;
2332         int whitespace = 1;
2333         int dummy = 0;
2334
2335         if (trailingwhitespace == NULL)
2336                 trailingwhitespace = &dummy;
2337         *trailingwhitespace = 0;
2338         if (s == NULL)  /* invalid, though! */
2339                 return NULL;
2340         /* make a copy to store the parsed string */
2341         if (!(duplicate = ast_strdup(s)))
2342                 return NULL;
2343
2344         cur = duplicate;
2345         /* scan the original string copying into cur when needed */
2346         for (; *s ; s++) {
2347                 if (x >= max - 1) {
2348                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
2349                         break;
2350                 }
2351                 if (*s == '"' && !escaped) {
2352                         quoted = !quoted;
2353                         if (quoted && whitespace) {
2354                                 /* start a quoted string from previous whitespace: new argument */
2355                                 argv[x++] = cur;
2356                                 whitespace = 0;
2357                         }
2358                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
2359                         /* If we are not already in whitespace, and not in a quoted string or
2360                            processing an escape sequence, and just entered whitespace, then
2361                            finalize the previous argument and remember that we are in whitespace
2362                         */
2363                         if (!whitespace) {
2364                                 *cur++ = '\0';
2365                                 whitespace = 1;
2366                         }
2367                 } else if (*s == '\\' && !escaped) {
2368                         escaped = 1;
2369                 } else {
2370                         if (whitespace) {
2371                                 /* we leave whitespace, and are not quoted. So it's a new argument */
2372                                 argv[x++] = cur;
2373                                 whitespace = 0;
2374                         }
2375                         *cur++ = *s;
2376                         escaped = 0;
2377                 }
2378         }
2379         /* Null terminate */
2380         *cur++ = '\0';
2381         /* XXX put a NULL in the last argument, because some functions that take
2382          * the array may want a null-terminated array.
2383          * argc still reflects the number of non-NULL entries.
2384          */
2385         argv[x] = NULL;
2386         *argc = x;
2387         *trailingwhitespace = whitespace;
2388         return duplicate;
2389 }
2390
2391 /*! \brief Return the number of unique matches for the generator */
2392 int ast_cli_generatornummatches(const char *text, const char *word)
2393 {
2394         int matches = 0, i = 0;
2395         char *buf = NULL, *oldbuf = NULL;
2396
2397         while ((buf = ast_cli_generator(text, word, i++))) {
2398                 if (!oldbuf || strcmp(buf,oldbuf))
2399                         matches++;
2400                 if (oldbuf)
2401                         ast_free(oldbuf);
2402                 oldbuf = buf;
2403         }
2404         if (oldbuf)
2405                 ast_free(oldbuf);
2406         return matches;
2407 }
2408
2409 char **ast_cli_completion_matches(const char *text, const char *word)
2410 {
2411         char **match_list = NULL, *retstr, *prevstr;
2412         size_t match_list_len, max_equal, which, i;
2413         int matches = 0;
2414
2415         /* leave entry 0 free for the longest common substring */
2416         match_list_len = 1;
2417         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
2418                 if (matches + 1 >= match_list_len) {
2419                         match_list_len <<= 1;
2420                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
2421                                 return NULL;
2422                 }
2423                 match_list[++matches] = retstr;
2424         }
2425
2426         if (!match_list)
2427                 return match_list; /* NULL */
2428
2429         /* Find the longest substring that is common to all results
2430          * (it is a candidate for completion), and store a copy in entry 0.
2431          */
2432         prevstr = match_list[1];
2433         max_equal = strlen(prevstr);
2434         for (which = 2; which <= matches; which++) {
2435                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
2436                         continue;
2437                 max_equal = i;
2438         }
2439
2440         if (!(retstr = ast_malloc(max_equal + 1))) {
2441                 ast_free(match_list);
2442                 return NULL;
2443         }
2444
2445         ast_copy_string(retstr, match_list[1], max_equal + 1);
2446         match_list[0] = retstr;
2447
2448         /* ensure that the array is NULL terminated */
2449         if (matches + 1 >= match_list_len) {
2450                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list)))) {
2451                         ast_free(retstr);
2452                         return NULL;
2453                 }
2454         }
2455         match_list[matches + 1] = NULL;
2456
2457         return match_list;
2458 }
2459
2460 /*! \brief returns true if there are more words to match */
2461 static int more_words (const char * const *dst)
2462 {
2463         int i;
2464         for (i = 0; dst[i]; i++) {
2465                 if (dst[i][0] != '[')
2466                         return -1;
2467         }
2468         return 0;
2469 }
2470
2471 /*
2472  * generate the entry at position 'state'
2473  */
2474 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
2475 {
2476         const char *argv[AST_MAX_ARGS];
2477         struct ast_cli_entry *e = NULL;
2478         int x = 0, argindex, matchlen;
2479         int matchnum=0;
2480         char *ret = NULL;
2481         char matchstr[80] = "";
2482         int tws = 0;
2483         /* Split the argument into an array of words */
2484         char *duplicate = parse_args(text, &x, argv, ARRAY_LEN(argv), &tws);
2485
2486         if (!duplicate) /* malloc error */
2487                 return NULL;
2488
2489         /* Compute the index of the last argument (could be an empty string) */
2490         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
2491
2492         /* rebuild the command, ignore terminating white space and flatten space */
2493         ast_join(matchstr, sizeof(matchstr)-1, argv);
2494         matchlen = strlen(matchstr);
2495         if (tws) {
2496                 strcat(matchstr, " "); /* XXX */
2497                 if (matchlen)
2498                         matchlen++;
2499         }
2500         if (lock)
2501                 AST_RWLIST_RDLOCK(&helpers);
2502         while ( (e = cli_next(e)) ) {
2503                 /* XXX repeated code */
2504                 int src = 0, dst = 0, n = 0;
2505
2506                 if (e->command[0] == '_')
2507                         continue;
2508
2509                 /*
2510                  * Try to match words, up to and excluding the last word, which
2511                  * is either a blank or something that we want to extend.
2512                  */
2513                 for (;src < argindex; dst++, src += n) {
2514                         n = word_match(argv[src], e->cmda[dst]);
2515                         if (n < 0)
2516                                 break;
2517                 }
2518
2519                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
2520                         continue;
2521                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
2522                 matchnum += n;  /* this many matches here */
2523                 if (ret) {
2524                         /*
2525                          * argv[src] is a valid prefix of the next word in this
2526                          * command. If this is also the correct entry, return it.
2527                          */
2528                         if (matchnum > state)
2529                                 break;
2530                         ast_free(ret);
2531                         ret = NULL;
2532                 } else if (ast_strlen_zero(e->cmda[dst])) {
2533                         /*
2534                          * This entry is a prefix of the command string entered
2535                          * (only one entry in the list should have this property).
2536                          * Run the generator if one is available. In any case we are done.
2537                          */
2538                         if (e->handler) {       /* new style command */
2539                                 struct ast_cli_args a = {
2540                                         .line = matchstr, .word = word,
2541                                         .pos = argindex,
2542                                         .n = state - matchnum,
2543                                         .argv = argv,
2544                                         .argc = x};
2545                                 ret = e->handler(e, CLI_GENERATE, &a);
2546                         }
2547                         if (ret)
2548                                 break;
2549                 }
2550         }
2551         if (lock)
2552                 AST_RWLIST_UNLOCK(&helpers);
2553         ast_free(duplicate);
2554         return ret;
2555 }
2556
2557 char *ast_cli_generator(const char *text, const char *word, int state)
2558 {
2559         return __ast_cli_generator(text, word, state, 1);
2560 }
2561
2562 int ast_cli_command_full(int uid, int gid, int fd, const char *s)
2563 {
2564         const char *args[AST_MAX_ARGS + 1];
2565         struct ast_cli_entry *e;
2566         int x;
2567         char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
2568         char tmp[AST_MAX_ARGS + 1];
2569         char *retval = NULL;
2570         struct ast_cli_args a = {
2571                 .fd = fd, .argc = x, .argv = args+1 };
2572
2573         if (duplicate == NULL)
2574                 return -1;
2575
2576         if (x < 1)      /* We need at least one entry, otherwise ignore */
2577                 goto done;
2578
2579         AST_RWLIST_RDLOCK(&helpers);
2580         e = find_cli(args + 1, 0);
2581         if (e)
2582                 ast_atomic_fetchadd_int(&e->inuse, 1);
2583         AST_RWLIST_UNLOCK(&helpers);
2584         if (e == NULL) {
2585                 ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
2586                 goto done;
2587         }
2588
2589         ast_join(tmp, sizeof(tmp), args + 1);
2590         /* Check if the user has rights to run this command. */
2591         if (!cli_has_permissions(uid, gid, tmp)) {
2592                 ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
2593                 ast_free(duplicate);
2594                 return 0;
2595         }
2596
2597         /*
2598          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
2599          * Remember that the array returned by parse_args is NULL-terminated.
2600          */
2601         args[0] = (char *)e;
2602
2603         retval = e->handler(e, CLI_HANDLER, &a);
2604
2605         if (retval == CLI_SHOWUSAGE) {
2606                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
2607         } else {
2608                 if (retval == CLI_FAILURE)
2609                         ast_cli(fd, "Command '%s' failed.\n", s);
2610         }
2611         ast_atomic_fetchadd_int(&e->inuse, -1);
2612 done:
2613         ast_free(duplicate);
2614         return 0;
2615 }
2616
2617 int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
2618 {
2619         char cmd[512];
2620         int x, y = 0, count = 0;
2621
2622         for (x = 0; x < size; x++) {
2623                 cmd[y] = s[x];
2624                 y++;
2625                 if (s[x] == '\0') {
2626                         ast_cli_command_full(uid, gid, fd, cmd);
2627                         y = 0;
2628                         count++;
2629                 }
2630         }
2631         return count;
2632 }