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