CLI: Cosmetic issue - core show uptime
[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_REGISTER_FILE()
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         ast_std_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") && strcasecmp(argv3, "channel"))
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 %-11s %13s\n"
776 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s %-11s %13s\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,
782                 int usecnt, const char *status, const char *like,
783                 enum ast_module_support_level support_level)
784 {
785         /* Comparing the like with the module */
786         if (strcasestr(module, like) ) {
787                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt,
788                                 status, ast_module_support_level_to_string(support_level));
789                 return 1;
790         }
791         return 0;
792 }
793
794 static void print_uptimestr(int fd, struct timeval timeval, const char *prefix, int printsec)
795 {
796         int x; /* the main part - years, weeks, etc. */
797         struct ast_str *out;
798
799 #define SECOND (1)
800 #define MINUTE (SECOND*60)
801 #define HOUR (MINUTE*60)
802 #define DAY (HOUR*24)
803 #define WEEK (DAY*7)
804 #define YEAR (DAY*365)
805 #define NEEDCOMMA(x) ((x) ? ", " : "")  /* define if we need a comma */
806         if (timeval.tv_sec < 0) /* invalid, nothing to show */
807                 return;
808
809         if (printsec)  {        /* plain seconds output */
810                 ast_cli(fd, "%s: %lu\n", prefix, (u_long)timeval.tv_sec);
811                 return;
812         }
813         out = ast_str_alloca(256);
814         if (timeval.tv_sec > YEAR) {
815                 x = (timeval.tv_sec / YEAR);
816                 timeval.tv_sec -= (x * YEAR);
817                 ast_str_append(&out, 0, "%d year%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
818         }
819         if (timeval.tv_sec > WEEK) {
820                 x = (timeval.tv_sec / WEEK);
821                 timeval.tv_sec -= (x * WEEK);
822                 ast_str_append(&out, 0, "%d week%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
823         }
824         if (timeval.tv_sec > DAY) {
825                 x = (timeval.tv_sec / DAY);
826                 timeval.tv_sec -= (x * DAY);
827                 ast_str_append(&out, 0, "%d day%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
828         }
829         if (timeval.tv_sec > HOUR) {
830                 x = (timeval.tv_sec / HOUR);
831                 timeval.tv_sec -= (x * HOUR);
832                 ast_str_append(&out, 0, "%d hour%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
833         }
834         if (timeval.tv_sec > MINUTE) {
835                 x = (timeval.tv_sec / MINUTE);
836                 timeval.tv_sec -= (x * MINUTE);
837                 ast_str_append(&out, 0, "%d minute%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
838         }
839         x = timeval.tv_sec;
840         if (x > 0 || ast_str_strlen(out) == 0) {
841                 /* if there is nothing, print 0 seconds */
842                 ast_str_append(&out, 0, "%d second%s", x, ESS(x));
843         }
844         ast_cli(fd, "%s: %s\n", prefix, ast_str_buffer(out));
845 }
846
847 static struct ast_cli_entry *cli_next(struct ast_cli_entry *e)
848 {
849         if (e) {
850                 return AST_LIST_NEXT(e, list);
851         } else {
852                 return AST_LIST_FIRST(&helpers);
853         }
854 }
855
856 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
857 {
858         struct timeval curtime = ast_tvnow();
859         int printsec;
860
861         switch (cmd) {
862         case CLI_INIT:
863                 e->command = "core show uptime [seconds]";
864                 e->usage =
865                         "Usage: core show uptime [seconds]\n"
866                         "       Shows Asterisk uptime information.\n"
867                         "       The seconds word returns the uptime in seconds only.\n";
868                 return NULL;
869
870         case CLI_GENERATE:
871                 return NULL;
872         }
873         /* regular handler */
874         if (a->argc == e->args && !strcasecmp(a->argv[e->args-1],"seconds"))
875                 printsec = 1;
876         else if (a->argc == e->args-1)
877                 printsec = 0;
878         else
879                 return CLI_SHOWUSAGE;
880         if (ast_startuptime.tv_sec)
881                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime", printsec);
882         if (ast_lastreloadtime.tv_sec)
883                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_lastreloadtime), "Last reload", printsec);
884         return CLI_SUCCESS;
885 }
886
887 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
888 {
889         const char *like;
890
891         switch (cmd) {
892         case CLI_INIT:
893                 e->command = "module show [like]";
894                 e->usage =
895                         "Usage: module show [like keyword]\n"
896                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
897                 return NULL;
898
899         case CLI_GENERATE:
900                 if (a->pos == e->args)
901                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
902                 else
903                         return NULL;
904         }
905         /* all the above return, so we proceed with the handler.
906          * we are guaranteed to have argc >= e->args
907          */
908         if (a->argc == e->args - 1)
909                 like = "";
910         else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
911                 like = a->argv[e->args];
912         else
913                 return CLI_SHOWUSAGE;
914
915         ast_mutex_lock(&climodentrylock);
916         climodentryfd = a->fd; /* global, protected by climodentrylock */
917         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count", "Status", "Support Level");
918         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
919         climodentryfd = -1;
920         ast_mutex_unlock(&climodentrylock);
921         return CLI_SUCCESS;
922 }
923 #undef MODLIST_FORMAT
924 #undef MODLIST_FORMAT2
925
926 static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
927 {
928         struct timeval curtime = ast_tvnow();
929         int showuptime, printsec;
930
931         switch (cmd) {
932         case CLI_INIT:
933                 e->command = "core show calls [uptime]";
934                 e->usage =
935                         "Usage: core show calls [uptime] [seconds]\n"
936                         "       Lists number of currently active calls and total number of calls\n"
937                         "       processed through PBX since last restart. If 'uptime' is specified\n"
938                         "       the system uptime is also displayed. If 'seconds' is specified in\n"
939                         "       addition to 'uptime', the system uptime is displayed in seconds.\n";
940                 return NULL;
941
942         case CLI_GENERATE:
943                 if (a->pos != e->args)
944                         return NULL;
945                 return a->n == 0  ? ast_strdup("seconds") : NULL;
946         }
947
948         /* regular handler */
949         if (a->argc >= e->args && !strcasecmp(a->argv[e->args-1],"uptime")) {
950                 showuptime = 1;
951
952                 if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
953                         printsec = 1;
954                 else if (a->argc == e->args)
955                         printsec = 0;
956                 else
957                         return CLI_SHOWUSAGE;
958         } else if (a->argc == e->args-1) {
959                 showuptime = 0;
960                 printsec = 0;
961         } else
962                 return CLI_SHOWUSAGE;
963
964         if (ast_option_maxcalls) {
965                 ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
966                    ast_active_calls(), ast_option_maxcalls, ESS(ast_active_calls()),
967                    ((double)ast_active_calls() / (double)ast_option_maxcalls) * 100.0);
968         } else {
969                 ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
970         }
971
972         ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
973
974         if (ast_startuptime.tv_sec && showuptime) {
975                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime", printsec);
976         }
977
978         return RESULT_SUCCESS;
979 }
980
981 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
982 {
983 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
984 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
985 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%s!%d!%s!%s!%s\n"
986 #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"
987 #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"
988
989         RAII_VAR(struct ao2_container *, channels, NULL, ao2_cleanup);
990         struct ao2_iterator it_chans;
991         struct stasis_message *msg;
992         int numchans = 0, concise = 0, verbose = 0, count = 0;
993
994         switch (cmd) {
995         case CLI_INIT:
996                 e->command = "core show channels [concise|verbose|count]";
997                 e->usage =
998                         "Usage: core show channels [concise|verbose|count]\n"
999                         "       Lists currently defined channels and some information about them. If\n"
1000                         "       'concise' is specified, the format is abridged and in a more easily\n"
1001                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
1002                         "       more and longer fields. If 'count' is specified only the channel and call\n"
1003                         "       count is output.\n"
1004                         "       The 'concise' option is deprecated and will be removed from future versions\n"
1005                         "       of Asterisk.\n";
1006                 return NULL;
1007
1008         case CLI_GENERATE:
1009                 return NULL;
1010         }
1011
1012         if (a->argc == e->args) {
1013                 if (!strcasecmp(a->argv[e->args-1],"concise"))
1014                         concise = 1;
1015                 else if (!strcasecmp(a->argv[e->args-1],"verbose"))
1016                         verbose = 1;
1017                 else if (!strcasecmp(a->argv[e->args-1],"count"))
1018                         count = 1;
1019                 else
1020                         return CLI_SHOWUSAGE;
1021         } else if (a->argc != e->args - 1)
1022                 return CLI_SHOWUSAGE;
1023
1024
1025         if (!(channels = stasis_cache_dump(ast_channel_cache_by_name(), ast_channel_snapshot_type()))) {
1026                 ast_cli(a->fd, "Failed to retrieve cached channels\n");
1027                 return CLI_SUCCESS;
1028         }
1029
1030         if (!count) {
1031                 if (!concise && !verbose)
1032                         ast_cli(a->fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
1033                 else if (verbose)
1034                         ast_cli(a->fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data",
1035                                 "CallerID", "Duration", "Accountcode", "PeerAccount", "BridgeID");
1036         }
1037
1038         it_chans = ao2_iterator_init(channels, 0);
1039         for (; (msg = ao2_iterator_next(&it_chans)); ao2_ref(msg, -1)) {
1040                 struct ast_channel_snapshot *cs = stasis_message_data(msg);
1041                 char durbuf[10] = "-";
1042
1043                 if (!count) {
1044                         if ((concise || verbose)  && !ast_tvzero(cs->creationtime)) {
1045                                 int duration = (int)(ast_tvdiff_ms(ast_tvnow(), cs->creationtime) / 1000);
1046                                 if (verbose) {
1047                                         int durh = duration / 3600;
1048                                         int durm = (duration % 3600) / 60;
1049                                         int durs = duration % 60;
1050                                         snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
1051                                 } else {
1052                                         snprintf(durbuf, sizeof(durbuf), "%d", duration);
1053                                 }
1054                         }
1055                         if (concise) {
1056                                 ast_cli(a->fd, CONCISE_FORMAT_STRING, cs->name, cs->context, cs->exten, cs->priority, ast_state2str(cs->state),
1057                                         S_OR(cs->appl, "(None)"),
1058                                         cs->data,
1059                                         cs->caller_number,
1060                                         cs->accountcode,
1061                                         cs->peeraccount,
1062                                         cs->amaflags,
1063                                         durbuf,
1064                                         cs->bridgeid,
1065                                         cs->uniqueid);
1066                         } else if (verbose) {
1067                                 ast_cli(a->fd, VERBOSE_FORMAT_STRING, cs->name, cs->context, cs->exten, cs->priority, ast_state2str(cs->state),
1068                                         S_OR(cs->appl, "(None)"),
1069                                         S_OR(cs->data, "(Empty)"),
1070                                         cs->caller_number,
1071                                         durbuf,
1072                                         cs->accountcode,
1073                                         cs->peeraccount,
1074                                         cs->bridgeid);
1075                         } else {
1076                                 char locbuf[40] = "(None)";
1077                                 char appdata[40] = "(None)";
1078
1079                                 if (!cs->context && !cs->exten)
1080                                         snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", cs->exten, cs->context, cs->priority);
1081                                 if (cs->appl)
1082                                         snprintf(appdata, sizeof(appdata), "%s(%s)", cs->appl, S_OR(cs->data, ""));
1083                                 ast_cli(a->fd, FORMAT_STRING, cs->name, locbuf, ast_state2str(cs->state), appdata);
1084                         }
1085                 }
1086         }
1087         ao2_iterator_destroy(&it_chans);
1088
1089         if (!concise) {
1090                 numchans = ast_active_channels();
1091                 ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1092                 if (ast_option_maxcalls)
1093                         ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
1094                                 ast_active_calls(), ast_option_maxcalls, ESS(ast_active_calls()),
1095                                 ((double)ast_active_calls() / (double)ast_option_maxcalls) * 100.0);
1096                 else
1097                         ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
1098
1099                 ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
1100         }
1101
1102         return CLI_SUCCESS;
1103
1104 #undef FORMAT_STRING
1105 #undef FORMAT_STRING2
1106 #undef CONCISE_FORMAT_STRING
1107 #undef VERBOSE_FORMAT_STRING
1108 #undef VERBOSE_FORMAT_STRING2
1109 }
1110
1111 static char *handle_softhangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1112 {
1113         struct ast_channel *c=NULL;
1114
1115         switch (cmd) {
1116         case CLI_INIT:
1117                 e->command = "channel request hangup";
1118                 e->usage =
1119                         "Usage: channel request hangup <channel>|<all>\n"
1120                         "       Request that a channel be hung up. The hangup takes effect\n"
1121                         "       the next time the driver reads or writes from the channel.\n"
1122                         "       If 'all' is specified instead of a channel name, all channels\n"
1123                         "       will see the hangup request.\n";
1124                 return NULL;
1125         case CLI_GENERATE:
1126                 return ast_complete_channels(a->line, a->word, a->pos, a->n, e->args);
1127         }
1128
1129         if (a->argc != 4) {
1130                 return CLI_SHOWUSAGE;
1131         }
1132
1133         if (!strcasecmp(a->argv[3], "all")) {
1134                 struct ast_channel_iterator *iter = NULL;
1135                 if (!(iter = ast_channel_iterator_all_new())) {
1136                         return CLI_FAILURE;
1137                 }
1138                 for (; iter && (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
1139                         ast_channel_lock(c);
1140                         ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1141                         ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
1142                         ast_channel_unlock(c);
1143                 }
1144                 ast_channel_iterator_destroy(iter);
1145         } else if ((c = ast_channel_get_by_name(a->argv[3]))) {
1146                 ast_channel_lock(c);
1147                 ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1148                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
1149                 ast_channel_unlock(c);
1150                 c = ast_channel_unref(c);
1151         } else {
1152                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1153         }
1154
1155         return CLI_SUCCESS;
1156 }
1157
1158 /*! \brief handles CLI command 'cli show permissions' */
1159 static char *handle_cli_show_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1160 {
1161         struct usergroup_cli_perm *cp;
1162         struct cli_perm *perm;
1163         struct passwd *pw = NULL;
1164         struct group *gr = NULL;
1165
1166         switch (cmd) {
1167         case CLI_INIT:
1168                 e->command = "cli show permissions";
1169                 e->usage =
1170                         "Usage: cli show permissions\n"
1171                         "       Shows CLI configured permissions.\n";
1172                 return NULL;
1173         case CLI_GENERATE:
1174                 return NULL;
1175         }
1176
1177         AST_RWLIST_RDLOCK(&cli_perms);
1178         AST_LIST_TRAVERSE(&cli_perms, cp, list) {
1179                 if (cp->uid >= 0) {
1180                         pw = getpwuid(cp->uid);
1181                         if (pw) {
1182                                 ast_cli(a->fd, "user: %s [uid=%d]\n", pw->pw_name, cp->uid);
1183                         }
1184                 } else {
1185                         gr = getgrgid(cp->gid);
1186                         if (gr) {
1187                                 ast_cli(a->fd, "group: %s [gid=%d]\n", gr->gr_name, cp->gid);
1188                         }
1189                 }
1190                 ast_cli(a->fd, "Permissions:\n");
1191                 if (cp->perms) {
1192                         AST_LIST_TRAVERSE(cp->perms, perm, list) {
1193                                 ast_cli(a->fd, "\t%s -> %s\n", perm->permit ? "permit" : "deny", perm->command);
1194                         }
1195                 }
1196                 ast_cli(a->fd, "\n");
1197         }
1198         AST_RWLIST_UNLOCK(&cli_perms);
1199
1200         return CLI_SUCCESS;
1201 }
1202
1203 /*! \brief handles CLI command 'cli reload permissions' */
1204 static char *handle_cli_reload_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1205 {
1206         switch (cmd) {
1207         case CLI_INIT:
1208                 e->command = "cli reload permissions";
1209                 e->usage =
1210                         "Usage: cli reload permissions\n"
1211                         "       Reload the 'cli_permissions.conf' file.\n";
1212                 return NULL;
1213         case CLI_GENERATE:
1214                 return NULL;
1215         }
1216
1217         ast_cli_perms_init(1);
1218
1219         return CLI_SUCCESS;
1220 }
1221
1222 /*! \brief handles CLI command 'cli check permissions' */
1223 static char *handle_cli_check_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1224 {
1225         struct passwd *pw = NULL;
1226         struct group *gr;
1227         int gid = -1, uid = -1;
1228         char command[AST_MAX_ARGS] = "";
1229         struct ast_cli_entry *ce = NULL;
1230         int found = 0;
1231         char *group, *tmp;
1232
1233         switch (cmd) {
1234         case CLI_INIT:
1235                 e->command = "cli check permissions";
1236                 e->usage =
1237                         "Usage: cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>]\n"
1238                         "       Check permissions config for a user@group or list the allowed commands for the specified user.\n"
1239                         "       The username or the groupname may be omitted.\n";
1240                 return NULL;
1241         case CLI_GENERATE:
1242                 if (a->pos >= 4) {
1243                         return ast_cli_generator(a->line + strlen("cli check permissions") + strlen(a->argv[3]) + 1, a->word, a->n);
1244                 }
1245                 return NULL;
1246         }
1247
1248         if (a->argc < 4) {
1249                 return CLI_SHOWUSAGE;
1250         }
1251
1252         tmp = ast_strdupa(a->argv[3]);
1253         group = strchr(tmp, '@');
1254         if (group) {
1255                 gr = getgrnam(&group[1]);
1256                 if (!gr) {
1257                         ast_cli(a->fd, "Unknown group '%s'\n", &group[1]);
1258                         return CLI_FAILURE;
1259                 }
1260                 group[0] = '\0';
1261                 gid = gr->gr_gid;
1262         }
1263
1264         if (!group && ast_strlen_zero(tmp)) {
1265                 ast_cli(a->fd, "You didn't supply a username\n");
1266         } else if (!ast_strlen_zero(tmp) && !(pw = getpwnam(tmp))) {
1267                 ast_cli(a->fd, "Unknown user '%s'\n", tmp);
1268                 return CLI_FAILURE;
1269         } else if (pw) {
1270                 uid = pw->pw_uid;
1271         }
1272
1273         if (a->argc == 4) {
1274                 while ((ce = cli_next(ce))) {
1275                         /* Hide commands that start with '_' */
1276                         if (ce->_full_cmd[0] == '_') {
1277                                 continue;
1278                         }
1279                         if (cli_has_permissions(uid, gid, ce->_full_cmd)) {
1280                                 ast_cli(a->fd, "%30.30s %s\n", ce->_full_cmd, S_OR(ce->summary, "<no description available>"));
1281                                 found++;
1282                         }
1283                 }
1284                 if (!found) {
1285                         ast_cli(a->fd, "You are not allowed to run any command on Asterisk\n");
1286                 }
1287         } else {
1288                 ast_join(command, sizeof(command), a->argv + 4);
1289                 ast_cli(a->fd, "%s '%s%s%s' is %s to run command: '%s'\n", uid >= 0 ? "User" : "Group", tmp,
1290                         group && uid >= 0 ? "@" : "",
1291                         group ? &group[1] : "",
1292                         cli_has_permissions(uid, gid, command) ? "allowed" : "not allowed", command);
1293         }
1294
1295         return CLI_SUCCESS;
1296 }
1297
1298 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
1299
1300 static char *handle_commandmatchesarray(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1301 {
1302         char *buf, *obuf;
1303         int buflen = 2048;
1304         int len = 0;
1305         char **matches;
1306         int x, matchlen;
1307
1308         switch (cmd) {
1309         case CLI_INIT:
1310                 e->command = "_command matchesarray";
1311                 e->usage =
1312                         "Usage: _command matchesarray \"<line>\" text \n"
1313                         "       This function is used internally to help with command completion and should.\n"
1314                         "       never be called by the user directly.\n";
1315                 return NULL;
1316         case CLI_GENERATE:
1317                 return NULL;
1318         }
1319
1320         if (a->argc != 4)
1321                 return CLI_SHOWUSAGE;
1322         if (!(buf = ast_malloc(buflen)))
1323                 return CLI_FAILURE;
1324         buf[len] = '\0';
1325         matches = ast_cli_completion_matches(a->argv[2], a->argv[3]);
1326         if (matches) {
1327                 for (x=0; matches[x]; x++) {
1328                         matchlen = strlen(matches[x]) + 1;
1329                         if (len + matchlen >= buflen) {
1330                                 buflen += matchlen * 3;
1331                                 obuf = buf;
1332                                 if (!(buf = ast_realloc(obuf, buflen)))
1333                                         /* Memory allocation failure...  Just free old buffer and be done */
1334                                         ast_free(obuf);
1335                         }
1336                         if (buf)
1337                                 len += sprintf( buf + len, "%s ", matches[x]);
1338                         ast_free(matches[x]);
1339                         matches[x] = NULL;
1340                 }
1341                 ast_free(matches);
1342         }
1343
1344         if (buf) {
1345                 ast_cli(a->fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
1346                 ast_free(buf);
1347         } else
1348                 ast_cli(a->fd, "NULL\n");
1349
1350         return CLI_SUCCESS;
1351 }
1352
1353
1354
1355 static char *handle_commandnummatches(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1356 {
1357         int matches = 0;
1358
1359         switch (cmd) {
1360         case CLI_INIT:
1361                 e->command = "_command nummatches";
1362                 e->usage =
1363                         "Usage: _command nummatches \"<line>\" text \n"
1364                         "       This function is used internally to help with command completion and should.\n"
1365                         "       never be called by the user directly.\n";
1366                 return NULL;
1367         case CLI_GENERATE:
1368                 return NULL;
1369         }
1370
1371         if (a->argc != 4)
1372                 return CLI_SHOWUSAGE;
1373
1374         matches = ast_cli_generatornummatches(a->argv[2], a->argv[3]);
1375
1376         ast_cli(a->fd, "%d", matches);
1377
1378         return CLI_SUCCESS;
1379 }
1380
1381 static char *handle_commandcomplete(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1382 {
1383         char *buf;
1384         switch (cmd) {
1385         case CLI_INIT:
1386                 e->command = "_command complete";
1387                 e->usage =
1388                         "Usage: _command complete \"<line>\" text state\n"
1389                         "       This function is used internally to help with command completion and should.\n"
1390                         "       never be called by the user directly.\n";
1391                 return NULL;
1392         case CLI_GENERATE:
1393                 return NULL;
1394         }
1395         if (a->argc != 5)
1396                 return CLI_SHOWUSAGE;
1397         buf = __ast_cli_generator(a->argv[2], a->argv[3], atoi(a->argv[4]), 0);
1398         if (buf) {
1399                 ast_cli(a->fd, "%s", buf);
1400                 ast_free(buf);
1401         } else
1402                 ast_cli(a->fd, "NULL\n");
1403         return CLI_SUCCESS;
1404 }
1405
1406 struct channel_set_debug_args {
1407         int fd;
1408         int is_off;
1409 };
1410
1411 static int channel_set_debug(void *obj, void *arg, void *data, int flags)
1412 {
1413         struct ast_channel *chan = obj;
1414         struct channel_set_debug_args *args = data;
1415
1416         ast_channel_lock(chan);
1417
1418         if (!(ast_channel_fin(chan) & DEBUGCHAN_FLAG) || !(ast_channel_fout(chan) & DEBUGCHAN_FLAG)) {
1419                 if (args->is_off) {
1420                         ast_channel_fin_set(chan, ast_channel_fin(chan) & ~DEBUGCHAN_FLAG);
1421                         ast_channel_fout_set(chan, ast_channel_fout(chan) & ~DEBUGCHAN_FLAG);
1422                 } else {
1423                         ast_channel_fin_set(chan, ast_channel_fin(chan) | DEBUGCHAN_FLAG);
1424                         ast_channel_fout_set(chan, ast_channel_fout(chan) | DEBUGCHAN_FLAG);
1425                 }
1426                 ast_cli(args->fd, "Debugging %s on channel %s\n", args->is_off ? "disabled" : "enabled",
1427                                 ast_channel_name(chan));
1428         }
1429
1430         ast_channel_unlock(chan);
1431
1432         return 0;
1433 }
1434
1435 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1436 {
1437         struct ast_channel *c = NULL;
1438         struct channel_set_debug_args args = {
1439                 .fd = a->fd,
1440         };
1441
1442         switch (cmd) {
1443         case CLI_INIT:
1444                 e->command = "core set debug channel";
1445                 e->usage =
1446                         "Usage: core set debug channel <all|channel> [off]\n"
1447                         "       Enables/disables debugging on all or on a specific channel.\n";
1448                 return NULL;
1449         case CLI_GENERATE:
1450                 /* XXX remember to handle the optional "off" */
1451                 if (a->pos != e->args)
1452                         return NULL;
1453                 return a->n == 0 ? ast_strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
1454         }
1455
1456         if (cmd == (CLI_HANDLER + 1000)) {
1457                 /* called from handle_nodebugchan_deprecated */
1458                 args.is_off = 1;
1459         } else if (a->argc == e->args + 2) {
1460                 /* 'core set debug channel {all|chan_id}' */
1461                 if (!strcasecmp(a->argv[e->args + 1], "off"))
1462                         args.is_off = 1;
1463                 else
1464                         return CLI_SHOWUSAGE;
1465         } else if (a->argc != e->args + 1) {
1466                 return CLI_SHOWUSAGE;
1467         }
1468
1469         if (!strcasecmp("all", a->argv[e->args])) {
1470                 if (args.is_off) {
1471                         global_fin &= ~DEBUGCHAN_FLAG;
1472                         global_fout &= ~DEBUGCHAN_FLAG;
1473                 } else {
1474                         global_fin |= DEBUGCHAN_FLAG;
1475                         global_fout |= DEBUGCHAN_FLAG;
1476                 }
1477                 ast_channel_callback(channel_set_debug, NULL, &args, OBJ_NODATA | OBJ_MULTIPLE);
1478         } else {
1479                 if ((c = ast_channel_get_by_name(a->argv[e->args]))) {
1480                         channel_set_debug(c, NULL, &args, 0);
1481                         ast_channel_unref(c);
1482                 } else {
1483                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
1484                 }
1485         }
1486
1487         ast_cli(a->fd, "Debugging on new channels is %s\n", args.is_off ? "disabled" : "enabled");
1488
1489         return CLI_SUCCESS;
1490 }
1491
1492 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1493 {
1494         char *res;
1495
1496         switch (cmd) {
1497         case CLI_INIT:
1498                 e->command = "no debug channel";
1499                 return NULL;
1500         case CLI_HANDLER:
1501                 /* exit out of switch statement */
1502                 break;
1503         default:
1504                 return NULL;
1505         }
1506
1507         if (a->argc != e->args + 1)
1508                 return CLI_SHOWUSAGE;
1509
1510         /* add a 'magic' value to the CLI_HANDLER command so that
1511          * handle_core_set_debug_channel() will act as if 'off'
1512          * had been specified as part of the command
1513          */
1514         res = handle_core_set_debug_channel(e, CLI_HANDLER + 1000, a);
1515
1516         return res;
1517 }
1518
1519 static char *handle_showchan(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1520 {
1521         struct ast_channel *chan;
1522         struct timeval now;
1523         char cdrtime[256];
1524         struct ast_str *obuf;/*!< Buffer for CDR variables. */
1525         struct ast_str *output;/*!< Accumulation buffer for all output. */
1526         long elapsed_seconds=0;
1527         int hour=0, min=0, sec=0;
1528         struct ast_var_t *var;
1529         struct ast_str *write_transpath = ast_str_alloca(256);
1530         struct ast_str *read_transpath = ast_str_alloca(256);
1531         struct ast_str *codec_buf = ast_str_alloca(64);
1532         struct ast_bridge *bridge;
1533         ast_callid callid;
1534         char callid_buf[32];
1535
1536         switch (cmd) {
1537         case CLI_INIT:
1538                 e->command = "core show channel";
1539                 e->usage =
1540                         "Usage: core show channel <channel>\n"
1541                         "       Shows lots of information about the specified channel.\n";
1542                 return NULL;
1543         case CLI_GENERATE:
1544                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
1545         }
1546
1547         if (a->argc != 4) {
1548                 return CLI_SHOWUSAGE;
1549         }
1550
1551         obuf = ast_str_thread_get(&ast_str_thread_global_buf, 16);
1552         if (!obuf) {
1553                 return CLI_FAILURE;
1554         }
1555
1556         output = ast_str_create(8192);
1557         if (!output) {
1558                 return CLI_FAILURE;
1559         }
1560
1561         chan = ast_channel_get_by_name(a->argv[3]);
1562         if (!chan) {
1563                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1564                 return CLI_SUCCESS;
1565         }
1566
1567         now = ast_tvnow();
1568         ast_channel_lock(chan);
1569
1570         if (!ast_tvzero(ast_channel_creationtime(chan))) {
1571                 elapsed_seconds = now.tv_sec - ast_channel_creationtime(chan).tv_sec;
1572                 hour = elapsed_seconds / 3600;
1573                 min = (elapsed_seconds % 3600) / 60;
1574                 sec = elapsed_seconds % 60;
1575                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
1576         } else {
1577                 strcpy(cdrtime, "N/A");
1578         }
1579
1580         ast_translate_path_to_str(ast_channel_writetrans(chan), &write_transpath);
1581         ast_translate_path_to_str(ast_channel_readtrans(chan), &read_transpath);
1582
1583         bridge = ast_channel_get_bridge(chan);
1584         callid_buf[0] = '\0';
1585         callid = ast_channel_callid(chan);
1586         if (callid) {
1587                 ast_callid_strnprint(callid_buf, sizeof(callid_buf), callid);
1588         }
1589
1590         ast_str_append(&output, 0,
1591                 " -- General --\n"
1592                 "           Name: %s\n"
1593                 "           Type: %s\n"
1594                 "       UniqueID: %s\n"
1595                 "       LinkedID: %s\n"
1596                 "      Caller ID: %s\n"
1597                 " Caller ID Name: %s\n"
1598                 "Connected Line ID: %s\n"
1599                 "Connected Line ID Name: %s\n"
1600                 "Eff. Connected Line ID: %s\n"
1601                 "Eff. Connected Line ID Name: %s\n"
1602                 "    DNID Digits: %s\n"
1603                 "       Language: %s\n"
1604                 "          State: %s (%u)\n"
1605                 "  NativeFormats: %s\n"
1606                 "    WriteFormat: %s\n"
1607                 "     ReadFormat: %s\n"
1608                 " WriteTranscode: %s %s\n"
1609                 "  ReadTranscode: %s %s\n"
1610                 " Time to Hangup: %ld\n"
1611                 "   Elapsed Time: %s\n"
1612                 "      Bridge ID: %s\n"
1613                 " --   PBX   --\n"
1614                 "        Context: %s\n"
1615                 "      Extension: %s\n"
1616                 "       Priority: %d\n"
1617                 "     Call Group: %llu\n"
1618                 "   Pickup Group: %llu\n"
1619                 "    Application: %s\n"
1620                 "           Data: %s\n"
1621                 " Call Identifer: %s\n",
1622                 ast_channel_name(chan),
1623                 ast_channel_tech(chan)->type,
1624                 ast_channel_uniqueid(chan),
1625                 ast_channel_linkedid(chan),
1626                 S_COR(ast_channel_caller(chan)->id.number.valid,
1627                       ast_channel_caller(chan)->id.number.str, "(N/A)"),
1628                 S_COR(ast_channel_caller(chan)->id.name.valid,
1629                       ast_channel_caller(chan)->id.name.str, "(N/A)"),
1630                 S_COR(ast_channel_connected(chan)->id.number.valid,
1631                       ast_channel_connected(chan)->id.number.str, "(N/A)"),
1632                 S_COR(ast_channel_connected(chan)->id.name.valid,
1633                       ast_channel_connected(chan)->id.name.str, "(N/A)"),
1634                 S_COR(ast_channel_connected_effective_id(chan).number.valid,
1635                       ast_channel_connected_effective_id(chan).number.str, "(N/A)"),
1636                 S_COR(ast_channel_connected_effective_id(chan).name.valid,
1637                       ast_channel_connected_effective_id(chan).name.str, "(N/A)"),
1638                 S_OR(ast_channel_dialed(chan)->number.str, "(N/A)"),
1639                 ast_channel_language(chan),
1640                 ast_state2str(ast_channel_state(chan)),
1641                 ast_channel_state(chan),
1642                 ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf),
1643                 ast_format_get_name(ast_channel_writeformat(chan)),
1644                 ast_format_get_name(ast_channel_readformat(chan)),
1645                 ast_str_strlen(write_transpath) ? "Yes" : "No",
1646                 ast_str_buffer(write_transpath),
1647                 ast_str_strlen(read_transpath) ? "Yes" : "No",
1648                 ast_str_buffer(read_transpath),
1649                 (long)ast_channel_whentohangup(chan)->tv_sec,
1650                 cdrtime,
1651                 bridge ? bridge->uniqueid : "(Not bridged)",
1652                 ast_channel_context(chan),
1653                 ast_channel_exten(chan),
1654                 ast_channel_priority(chan),
1655                 ast_channel_callgroup(chan),
1656                 ast_channel_pickupgroup(chan),
1657                 S_OR(ast_channel_appl(chan), "(N/A)"),
1658                 S_OR(ast_channel_data(chan), "(Empty)"),
1659                 S_OR(callid_buf, "(None)")
1660                 );
1661         ast_str_append(&output, 0, "      Variables:\n");
1662
1663         AST_LIST_TRAVERSE(ast_channel_varshead(chan), var, entries) {
1664                 ast_str_append(&output, 0, "%s=%s\n", ast_var_name(var), ast_var_value(var));
1665         }
1666
1667         if (!(ast_channel_tech(chan)->properties & AST_CHAN_TP_INTERNAL)
1668                 && ast_cdr_serialize_variables(ast_channel_name(chan), &obuf, '=', '\n')) {
1669                 ast_str_append(&output, 0, "  CDR Variables:\n%s\n", ast_str_buffer(obuf));
1670         }
1671
1672         ast_channel_unlock(chan);
1673
1674         ast_cli(a->fd, "%s", ast_str_buffer(output));
1675         ast_free(output);
1676
1677         ao2_cleanup(bridge);
1678         ast_channel_unref(chan);
1679
1680         return CLI_SUCCESS;
1681 }
1682
1683 /*
1684  * helper function to generate CLI matches from a fixed set of values.
1685  * A NULL word is acceptable.
1686  */
1687 char *ast_cli_complete(const char *word, const char * const choices[], int state)
1688 {
1689         int i, which = 0, len;
1690         len = ast_strlen_zero(word) ? 0 : strlen(word);
1691
1692         for (i = 0; choices[i]; i++) {
1693                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
1694                         return ast_strdup(choices[i]);
1695         }
1696         return NULL;
1697 }
1698
1699 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
1700 {
1701         int wordlen = strlen(word), which = 0;
1702         RAII_VAR(struct ao2_container *, cached_channels, NULL, ao2_cleanup);
1703         char *ret = NULL;
1704         struct ao2_iterator iter;
1705         struct stasis_message *msg;
1706
1707         if (pos != rpos) {
1708                 return NULL;
1709         }
1710
1711         if (!(cached_channels = stasis_cache_dump(ast_channel_cache(), ast_channel_snapshot_type()))) {
1712                 return NULL;
1713         }
1714
1715         iter = ao2_iterator_init(cached_channels, 0);
1716         for (; (msg = ao2_iterator_next(&iter)); ao2_ref(msg, -1)) {
1717                 struct ast_channel_snapshot *snapshot = stasis_message_data(msg);
1718
1719                 if (!strncasecmp(word, snapshot->name, wordlen) && (++which > state)) {
1720                         ret = ast_strdup(snapshot->name);
1721                         ao2_ref(msg, -1);
1722                         break;
1723                 }
1724         }
1725         ao2_iterator_destroy(&iter);
1726
1727         return ret;
1728 }
1729
1730 static char *group_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1731 {
1732 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1733
1734         struct ast_group_info *gi = NULL;
1735         int numchans = 0;
1736         regex_t regexbuf;
1737         int havepattern = 0;
1738
1739         switch (cmd) {
1740         case CLI_INIT:
1741                 e->command = "group show channels";
1742                 e->usage =
1743                         "Usage: group show channels [pattern]\n"
1744                         "       Lists all currently active channels with channel group(s) specified.\n"
1745                         "       Optional regular expression pattern is matched to group names for each\n"
1746                         "       channel.\n";
1747                 return NULL;
1748         case CLI_GENERATE:
1749                 return NULL;
1750         }
1751
1752         if (a->argc < 3 || a->argc > 4)
1753                 return CLI_SHOWUSAGE;
1754
1755         if (a->argc == 4) {
1756                 if (regcomp(&regexbuf, a->argv[3], REG_EXTENDED | REG_NOSUB))
1757                         return CLI_SHOWUSAGE;
1758                 havepattern = 1;
1759         }
1760
1761         ast_cli(a->fd, FORMAT_STRING, "Channel", "Group", "Category");
1762
1763         ast_app_group_list_rdlock();
1764
1765         gi = ast_app_group_list_head();
1766         while (gi) {
1767                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1768                         ast_cli(a->fd, FORMAT_STRING, ast_channel_name(gi->chan), gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1769                         numchans++;
1770                 }
1771                 gi = AST_LIST_NEXT(gi, group_list);
1772         }
1773
1774         ast_app_group_list_unlock();
1775
1776         if (havepattern)
1777                 regfree(&regexbuf);
1778
1779         ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1780         return CLI_SUCCESS;
1781 #undef FORMAT_STRING
1782 }
1783
1784 static char *handle_cli_wait_fullybooted(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1785 {
1786         switch (cmd) {
1787         case CLI_INIT:
1788                 e->command = "core waitfullybooted";
1789                 e->usage =
1790                         "Usage: core waitfullybooted\n"
1791                         "       Wait until Asterisk has fully booted.\n";
1792                 return NULL;
1793         case CLI_GENERATE:
1794                 return NULL;
1795         }
1796
1797         while (!ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1798                 usleep(100);
1799         }
1800
1801         ast_cli(a->fd, "Asterisk has fully booted.\n");
1802
1803         return CLI_SUCCESS;
1804 }
1805
1806 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1807
1808 static struct ast_cli_entry cli_cli[] = {
1809         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1810         AST_CLI_DEFINE(handle_commandcomplete, "Command complete"),
1811         AST_CLI_DEFINE(handle_commandnummatches, "Returns number of command matches"),
1812         AST_CLI_DEFINE(handle_commandmatchesarray, "Returns command matches array"),
1813
1814         AST_CLI_DEFINE(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1815
1816         AST_CLI_DEFINE(handle_chanlist, "Display information on channels"),
1817
1818         AST_CLI_DEFINE(handle_showcalls, "Display information on calls"),
1819
1820         AST_CLI_DEFINE(handle_showchan, "Display information on a specific channel"),
1821
1822         AST_CLI_DEFINE(handle_core_set_debug_channel, "Enable/disable debugging on a channel"),
1823
1824         AST_CLI_DEFINE(handle_debug, "Set level of debug chattiness"),
1825         AST_CLI_DEFINE(handle_verbose, "Set level of verbose chattiness"),
1826
1827         AST_CLI_DEFINE(group_show_channels, "Display active channels with group(s)"),
1828
1829         AST_CLI_DEFINE(handle_help, "Display help list, or specific help on a command"),
1830
1831         AST_CLI_DEFINE(handle_logger_mute, "Toggle logging output to a console"),
1832
1833         AST_CLI_DEFINE(handle_modlist, "List modules and info"),
1834
1835         AST_CLI_DEFINE(handle_load, "Load a module by name"),
1836
1837         AST_CLI_DEFINE(handle_reload, "Reload configuration for a module"),
1838
1839         AST_CLI_DEFINE(handle_core_reload, "Global reload"),
1840
1841         AST_CLI_DEFINE(handle_unload, "Unload a module by name"),
1842
1843         AST_CLI_DEFINE(handle_showuptime, "Show uptime information"),
1844
1845         AST_CLI_DEFINE(handle_softhangup, "Request a hangup on a given channel"),
1846
1847         AST_CLI_DEFINE(handle_cli_reload_permissions, "Reload CLI permissions config"),
1848
1849         AST_CLI_DEFINE(handle_cli_show_permissions, "Show CLI permissions"),
1850
1851         AST_CLI_DEFINE(handle_cli_check_permissions, "Try a permissions config for a user"),
1852
1853         AST_CLI_DEFINE(handle_cli_wait_fullybooted, "Wait for Asterisk to be fully booted"),
1854 };
1855
1856 /*!
1857  * Some regexp characters in cli arguments are reserved and used as separators.
1858  */
1859 static const char cli_rsvd[] = "[]{}|*%";
1860
1861 /*!
1862  * initialize the _full_cmd string and related parameters,
1863  * return 0 on success, -1 on error.
1864  */
1865 static int set_full_cmd(struct ast_cli_entry *e)
1866 {
1867         int i;
1868         char buf[80];
1869
1870         ast_join(buf, sizeof(buf), e->cmda);
1871         e->_full_cmd = ast_strdup(buf);
1872         if (!e->_full_cmd) {
1873                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1874                 return -1;
1875         }
1876         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1877         for (i = 0; e->cmda[i]; i++)
1878                 ;
1879         e->args = i;
1880         return 0;
1881 }
1882
1883 /*! \brief cleanup (free) cli_perms linkedlist. */
1884 static void destroy_user_perms(void)
1885 {
1886         struct cli_perm *perm;
1887         struct usergroup_cli_perm *user_perm;
1888
1889         AST_RWLIST_WRLOCK(&cli_perms);
1890         while ((user_perm = AST_LIST_REMOVE_HEAD(&cli_perms, list))) {
1891                 while ((perm = AST_LIST_REMOVE_HEAD(user_perm->perms, list))) {
1892                         ast_free(perm->command);
1893                         ast_free(perm);
1894                 }
1895                 ast_free(user_perm);
1896         }
1897         AST_RWLIST_UNLOCK(&cli_perms);
1898 }
1899
1900 int ast_cli_perms_init(int reload)
1901 {
1902         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1903         struct ast_config *cfg;
1904         char *cat = NULL;
1905         struct ast_variable *v;
1906         struct usergroup_cli_perm *user_group, *cp_entry;
1907         struct cli_perm *perm = NULL;
1908         struct passwd *pw;
1909         struct group *gr;
1910
1911         if (ast_mutex_trylock(&permsconfiglock)) {
1912                 ast_log(LOG_NOTICE, "You must wait until last 'cli reload permissions' command finish\n");
1913                 return 1;
1914         }
1915
1916         cfg = ast_config_load2(perms_config, "" /* core, can't reload */, config_flags);
1917         if (!cfg) {
1918                 ast_mutex_unlock(&permsconfiglock);
1919                 return 1;
1920         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
1921                 ast_mutex_unlock(&permsconfiglock);
1922                 return 0;
1923         }
1924
1925         /* free current structures. */
1926         destroy_user_perms();
1927
1928         while ((cat = ast_category_browse(cfg, cat))) {
1929                 if (!strcasecmp(cat, "general")) {
1930                         /* General options */
1931                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1932                                 if (!strcasecmp(v->name, "default_perm")) {
1933                                         cli_default_perm = (!strcasecmp(v->value, "permit")) ? 1: 0;
1934                                 }
1935                         }
1936                         continue;
1937                 }
1938
1939                 /* users or groups */
1940                 gr = NULL, pw = NULL;
1941                 if (cat[0] == '@') {
1942                         /* This is a group */
1943                         gr = getgrnam(&cat[1]);
1944                         if (!gr) {
1945                                 ast_log (LOG_WARNING, "Unknown group '%s'\n", &cat[1]);
1946                                 continue;
1947                         }
1948                 } else {
1949                         /* This is a user */
1950                         pw = getpwnam(cat);
1951                         if (!pw) {
1952                                 ast_log (LOG_WARNING, "Unknown user '%s'\n", cat);
1953                                 continue;
1954                         }
1955                 }
1956                 user_group = NULL;
1957                 /* Check for duplicates */
1958                 AST_RWLIST_WRLOCK(&cli_perms);
1959                 AST_LIST_TRAVERSE(&cli_perms, cp_entry, list) {
1960                         if ((pw && cp_entry->uid == pw->pw_uid) || (gr && cp_entry->gid == gr->gr_gid)) {
1961                                 /* if it is duplicated, just added this new settings, to
1962                                 the current list. */
1963                                 user_group = cp_entry;
1964                                 break;
1965                         }
1966                 }
1967                 AST_RWLIST_UNLOCK(&cli_perms);
1968
1969                 if (!user_group) {
1970                         /* alloc space for the new user config. */
1971                         user_group = ast_calloc(1, sizeof(*user_group));
1972                         if (!user_group) {
1973                                 continue;
1974                         }
1975                         user_group->uid = (pw ? pw->pw_uid : -1);
1976                         user_group->gid = (gr ? gr->gr_gid : -1);
1977                         user_group->perms = ast_calloc(1, sizeof(*user_group->perms));
1978                         if (!user_group->perms) {
1979                                 ast_free(user_group);
1980                                 continue;
1981                         }
1982                 }
1983                 for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1984                         if (ast_strlen_zero(v->value)) {
1985                                 /* we need to check this condition cause it could break security. */
1986                                 ast_log(LOG_WARNING, "Empty permit/deny option in user '%s'\n", cat);
1987                                 continue;
1988                         }
1989                         if (!strcasecmp(v->name, "permit")) {
1990                                 perm = ast_calloc(1, sizeof(*perm));
1991                                 if (perm) {
1992                                         perm->permit = 1;
1993                                         perm->command = ast_strdup(v->value);
1994                                 }
1995                         } else if (!strcasecmp(v->name, "deny")) {
1996                                 perm = ast_calloc(1, sizeof(*perm));
1997                                 if (perm) {
1998                                         perm->permit = 0;
1999                                         perm->command = ast_strdup(v->value);
2000                                 }
2001                         } else {
2002                                 /* up to now, only 'permit' and 'deny' are possible values. */
2003                                 ast_log(LOG_WARNING, "Unknown '%s' option\n", v->name);
2004                                 continue;
2005                         }
2006                         if (perm) {
2007                                 /* Added the permission to the user's list. */
2008                                 AST_LIST_INSERT_TAIL(user_group->perms, perm, list);
2009                                 perm = NULL;
2010                         }
2011                 }
2012                 AST_RWLIST_WRLOCK(&cli_perms);
2013                 AST_RWLIST_INSERT_TAIL(&cli_perms, user_group, list);
2014                 AST_RWLIST_UNLOCK(&cli_perms);
2015         }
2016
2017         ast_config_destroy(cfg);
2018         ast_mutex_unlock(&permsconfiglock);
2019         return 0;
2020 }
2021
2022 static void cli_shutdown(void)
2023 {
2024         ast_cli_unregister_multiple(cli_cli, ARRAY_LEN(cli_cli));
2025 }
2026
2027 /*! \brief initialize the _full_cmd string in * each of the builtins. */
2028 void ast_builtins_init(void)
2029 {
2030         ast_cli_register_multiple(cli_cli, ARRAY_LEN(cli_cli));
2031         ast_register_cleanup(cli_shutdown);
2032 }
2033
2034 /*!
2035  * match a word in the CLI entry.
2036  * returns -1 on mismatch, 0 on match of an optional word,
2037  * 1 on match of a full word.
2038  *
2039  * The pattern can be
2040  *   any_word           match for equal
2041  *   [foo|bar|baz]      optionally, one of these words
2042  *   {foo|bar|baz}      exactly, one of these words
2043  *   %                  any word
2044  */
2045 static int word_match(const char *cmd, const char *cli_word)
2046 {
2047         int l;
2048         char *pos;
2049
2050         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
2051                 return -1;
2052         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
2053                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
2054         l = strlen(cmd);
2055         /* wildcard match - will extend in the future */
2056         if (l > 0 && cli_word[0] == '%') {
2057                 return 1;       /* wildcard */
2058         }
2059
2060         /* Start a search for the command entered against the cli word in question */
2061         pos = strcasestr(cli_word, cmd);
2062         while (pos) {
2063
2064                 /*
2065                  *Check if the word matched with is surrounded by reserved characters on both sides
2066                  * and isn't at the beginning of the cli_word since that would make it check in a location we shouldn't know about.
2067                  * If it is surrounded by reserved chars and isn't at the beginning, it's a match.
2068                  */
2069                 if (pos != cli_word && strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l])) {
2070                         return 1;       /* valid match */
2071                 }
2072
2073                 /* Ok, that one didn't match, strcasestr to the next appearance of the command and start over.*/
2074                 pos = strcasestr(pos + 1, cmd);
2075         }
2076         /* If no matches were found over the course of the while loop, we hit the end of the string. It's a mismatch. */
2077         return -1;
2078 }
2079
2080 /*! \brief if word is a valid prefix for token, returns the pos-th
2081  * match as a malloced string, or NULL otherwise.
2082  * Always tell in *actual how many matches we got.
2083  */
2084 static char *is_prefix(const char *word, const char *token,
2085         int pos, int *actual)
2086 {
2087         int lw;
2088         char *s, *t1;
2089
2090         *actual = 0;
2091         if (ast_strlen_zero(token))
2092                 return NULL;
2093         if (ast_strlen_zero(word))
2094                 word = "";      /* dummy */
2095         lw = strlen(word);
2096         if (strcspn(word, cli_rsvd) != lw)
2097                 return NULL;    /* no match if word has reserved chars */
2098         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
2099                 if (strncasecmp(token, word, lw))       /* no match */
2100                         return NULL;
2101                 *actual = 1;
2102                 return (pos != 0) ? NULL : ast_strdup(token);
2103         }
2104         /* now handle regexp match */
2105
2106         /* Wildcard always matches, so we never do is_prefix on them */
2107
2108         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
2109         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
2110                 if (*s == '%')  /* wildcard */
2111                         continue;
2112                 if (strncasecmp(s, word, lw))   /* no match */
2113                         continue;
2114                 (*actual)++;
2115                 if (pos-- == 0)
2116                         return ast_strdup(s);
2117         }
2118         return NULL;
2119 }
2120
2121 /*!
2122  * \internal
2123  * \brief locate a cli command in the 'helpers' list (which must be locked).
2124  *     The search compares word by word taking care of regexps in e->cmda
2125  *     This function will return NULL when nothing is matched, or the ast_cli_entry that matched.
2126  * \param cmds
2127  * \param match_type has 3 possible values:
2128  *      0       returns if the search key is equal or longer than the entry.
2129  *                          note that trailing optional arguments are skipped.
2130  *      -1      true if the mismatch is on the last word XXX not true!
2131  *      1       true only on complete, exact match.
2132  *
2133  */
2134 static struct ast_cli_entry *find_cli(const char * const cmds[], int match_type)
2135 {
2136         int matchlen = -1;      /* length of longest match so far */
2137         struct ast_cli_entry *cand = NULL, *e=NULL;
2138
2139         while ( (e = cli_next(e)) ) {
2140                 /* word-by word regexp comparison */
2141                 const char * const *src = cmds;
2142                 const char * const *dst = e->cmda;
2143                 int n = 0;
2144                 for (;; dst++, src += n) {
2145                         n = word_match(*src, *dst);
2146                         if (n < 0)
2147                                 break;
2148                 }
2149                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
2150                         /* no more words in 'e' */
2151                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
2152                                 break;
2153                         /* Here, cmds has more words than the entry 'e' */
2154                         if (match_type != 0)    /* but we look for almost exact match... */
2155                                 continue;       /* so we skip this one. */
2156                         /* otherwise we like it (case 0) */
2157                 } else {        /* still words in 'e' */
2158                         if (ast_strlen_zero(*src))
2159                                 continue; /* cmds is shorter than 'e', not good */
2160                         /* Here we have leftover words in cmds and 'e',
2161                          * but there is a mismatch. We only accept this one if match_type == -1
2162                          * and this is the last word for both.
2163                          */
2164                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
2165                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
2166                                 continue;
2167                         /* good, we are in case match_type == -1 and mismatch on last word */
2168                 }
2169                 if (src - cmds > matchlen) {    /* remember the candidate */
2170                         matchlen = src - cmds;
2171                         cand = e;
2172                 }
2173         }
2174
2175         return e ? e : cand;
2176 }
2177
2178 static char *find_best(const char *argv[])
2179 {
2180         static char cmdline[80];
2181         int x;
2182         /* See how close we get, then print the candidate */
2183         const char *myargv[AST_MAX_CMD_LEN] = { NULL, };
2184
2185         AST_RWLIST_RDLOCK(&helpers);
2186         for (x = 0; argv[x]; x++) {
2187                 myargv[x] = argv[x];
2188                 if (!find_cli(myargv, -1))
2189                         break;
2190         }
2191         AST_RWLIST_UNLOCK(&helpers);
2192         ast_join(cmdline, sizeof(cmdline), myargv);
2193         return cmdline;
2194 }
2195
2196 static int cli_is_registered(struct ast_cli_entry *e)
2197 {
2198         struct ast_cli_entry *cur = NULL;
2199
2200         while ((cur = cli_next(cur))) {
2201                 if (cur == e) {
2202                         return 1;
2203                 }
2204         }
2205         return 0;
2206 }
2207
2208 int ast_cli_unregister(struct ast_cli_entry *e)
2209 {
2210         if (e->inuse) {
2211                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
2212         } else {
2213                 AST_RWLIST_WRLOCK(&helpers);
2214                 AST_RWLIST_REMOVE(&helpers, e, list);
2215                 AST_RWLIST_UNLOCK(&helpers);
2216                 ast_free(e->_full_cmd);
2217                 e->_full_cmd = NULL;
2218                 if (e->handler) {
2219                         /* this is a new-style entry. Reset fields and free memory. */
2220                         char *cmda = (char *) e->cmda;
2221                         memset(cmda, '\0', sizeof(e->cmda));
2222                         ast_free(e->command);
2223                         e->command = NULL;
2224                         e->usage = NULL;
2225                 }
2226         }
2227         return 0;
2228 }
2229
2230 int __ast_cli_register(struct ast_cli_entry *e, struct ast_module *module)
2231 {
2232         struct ast_cli_entry *cur;
2233         int i, lf, ret = -1;
2234
2235         struct ast_cli_args a;  /* fake argument */
2236         char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
2237         char *s;
2238
2239         AST_RWLIST_WRLOCK(&helpers);
2240
2241         if (cli_is_registered(e)) {
2242                 ast_log(LOG_WARNING, "Command '%s' already registered (the same ast_cli_entry)\n",
2243                         S_OR(e->_full_cmd, e->command));
2244                 ret = 0;  /* report success */
2245                 goto done;
2246         }
2247
2248         memset(&a, '\0', sizeof(a));
2249
2250         e->module = module;
2251         /* No module reference needed here, the module called us. */
2252         e->handler(e, CLI_INIT, &a);
2253
2254         /* XXX check that usage and command are filled up */
2255         s = ast_skip_blanks(e->command);
2256         s = e->command = ast_strdup(s);
2257         for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
2258                 *dst++ = s;     /* store string */
2259                 s = ast_skip_nonblanks(s);
2260                 if (*s == '\0') /* we are done */
2261                         break;
2262                 *s++ = '\0';
2263                 s = ast_skip_blanks(s);
2264         }
2265         *dst++ = NULL;
2266
2267         if (find_cli(e->cmda, 1)) {
2268                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n",
2269                         S_OR(e->_full_cmd, e->command));
2270                 goto done;
2271         }
2272         if (set_full_cmd(e)) {
2273                 ast_log(LOG_WARNING, "Error registering CLI Command '%s'\n",
2274                         S_OR(e->_full_cmd, e->command));
2275                 goto done;
2276         }
2277
2278         lf = e->cmdlen;
2279         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
2280                 int len = cur->cmdlen;
2281                 if (lf < len)
2282                         len = lf;
2283                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
2284                         AST_RWLIST_INSERT_BEFORE_CURRENT(e, list);
2285                         break;
2286                 }
2287         }
2288         AST_RWLIST_TRAVERSE_SAFE_END;
2289
2290         if (!cur)
2291                 AST_RWLIST_INSERT_TAIL(&helpers, e, list);
2292         ret = 0;        /* success */
2293
2294 done:
2295         AST_RWLIST_UNLOCK(&helpers);
2296         if (ret) {
2297                 ast_free(e->command);
2298                 e->command = NULL;
2299         }
2300
2301         return ret;
2302 }
2303
2304 /*
2305  * register/unregister an array of entries.
2306  */
2307 int __ast_cli_register_multiple(struct ast_cli_entry *e, int len, struct ast_module *module)
2308 {
2309         int i, res = 0;
2310
2311         for (i = 0; i < len; i++) {
2312                 res |= __ast_cli_register(e + i, module);
2313         }
2314
2315         return res;
2316 }
2317
2318 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
2319 {
2320         int i, res = 0;
2321
2322         for (i = 0; i < len; i++)
2323                 res |= ast_cli_unregister(e + i);
2324
2325         return res;
2326 }
2327
2328
2329 /*! \brief helper for final part of handle_help
2330  *  if locked = 1, assume the list is already locked
2331  */
2332 static char *help1(int fd, const char * const match[], int locked)
2333 {
2334         char matchstr[80] = "";
2335         struct ast_cli_entry *e = NULL;
2336         int len = 0;
2337         int found = 0;
2338
2339         if (match) {
2340                 ast_join(matchstr, sizeof(matchstr), match);
2341                 len = strlen(matchstr);
2342         }
2343         if (!locked)
2344                 AST_RWLIST_RDLOCK(&helpers);
2345         while ( (e = cli_next(e)) ) {
2346                 /* Hide commands that start with '_' */
2347                 if (e->_full_cmd[0] == '_')
2348                         continue;
2349                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
2350                         continue;
2351                 ast_cli(fd, "%-30s -- %s\n", e->_full_cmd,
2352                         S_OR(e->summary, "<no description available>"));
2353                 found++;
2354         }
2355         if (!locked)
2356                 AST_RWLIST_UNLOCK(&helpers);
2357         if (!found && matchstr[0])
2358                 ast_cli(fd, "No such command '%s'.\n", matchstr);
2359         return CLI_SUCCESS;
2360 }
2361
2362 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2363 {
2364         char fullcmd[80];
2365         struct ast_cli_entry *my_e;
2366         char *res = CLI_SUCCESS;
2367
2368         if (cmd == CLI_INIT) {
2369                 e->command = "core show help";
2370                 e->usage =
2371                         "Usage: core show help [topic]\n"
2372                         "       When called with a topic as an argument, displays usage\n"
2373                         "       information on the given command. If called without a\n"
2374                         "       topic, it provides a list of commands.\n";
2375                 return NULL;
2376
2377         } else if (cmd == CLI_GENERATE) {
2378                 /* skip first 14 or 15 chars, "core show help " */
2379                 int l = strlen(a->line);
2380
2381                 if (l > 15) {
2382                         l = 15;
2383                 }
2384                 /* XXX watch out, should stop to the non-generator parts */
2385                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
2386         }
2387         if (a->argc == e->args) {
2388                 return help1(a->fd, NULL, 0);
2389         }
2390
2391         AST_RWLIST_RDLOCK(&helpers);
2392         my_e = find_cli(a->argv + 3, 1);        /* try exact match first */
2393         if (!my_e) {
2394                 res = help1(a->fd, a->argv + 3, 1 /* locked */);
2395                 AST_RWLIST_UNLOCK(&helpers);
2396                 return res;
2397         }
2398         if (my_e->usage)
2399                 ast_cli(a->fd, "%s", my_e->usage);
2400         else {
2401                 ast_join(fullcmd, sizeof(fullcmd), a->argv + 3);
2402                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
2403         }
2404         AST_RWLIST_UNLOCK(&helpers);
2405         return res;
2406 }
2407
2408 static char *parse_args(const char *s, int *argc, const char *argv[], int max, int *trailingwhitespace)
2409 {
2410         char *duplicate, *cur;
2411         int x = 0;
2412         int quoted = 0;
2413         int escaped = 0;
2414         int whitespace = 1;
2415         int dummy = 0;
2416
2417         if (trailingwhitespace == NULL)
2418                 trailingwhitespace = &dummy;
2419         *trailingwhitespace = 0;
2420         if (s == NULL)  /* invalid, though! */
2421                 return NULL;
2422         /* make a copy to store the parsed string */
2423         if (!(duplicate = ast_strdup(s)))
2424                 return NULL;
2425
2426         cur = duplicate;
2427
2428         /* Remove leading spaces from the command */
2429         while (isspace(*s)) {
2430                 cur++;
2431                 s++;
2432         }
2433
2434         /* scan the original string copying into cur when needed */
2435         for (; *s ; s++) {
2436                 if (x >= max - 1) {
2437                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
2438                         break;
2439                 }
2440                 if (*s == '"' && !escaped) {
2441                         quoted = !quoted;
2442                         if (quoted && whitespace) {
2443                                 /* start a quoted string from previous whitespace: new argument */
2444                                 argv[x++] = cur;
2445                                 whitespace = 0;
2446                         }
2447                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
2448                         /* If we are not already in whitespace, and not in a quoted string or
2449                            processing an escape sequence, and just entered whitespace, then
2450                            finalize the previous argument and remember that we are in whitespace
2451                         */
2452                         if (!whitespace) {
2453                                 *cur++ = '\0';
2454                                 whitespace = 1;
2455                         }
2456                 } else if (*s == '\\' && !escaped) {
2457                         escaped = 1;
2458                 } else {
2459                         if (whitespace) {
2460                                 /* we leave whitespace, and are not quoted. So it's a new argument */
2461                                 argv[x++] = cur;
2462                                 whitespace = 0;
2463                         }
2464                         *cur++ = *s;
2465                         escaped = 0;
2466                 }
2467         }
2468         /* Null terminate */
2469         *cur++ = '\0';
2470         /* XXX put a NULL in the last argument, because some functions that take
2471          * the array may want a null-terminated array.
2472          * argc still reflects the number of non-NULL entries.
2473          */
2474         argv[x] = NULL;
2475         *argc = x;
2476         *trailingwhitespace = whitespace;
2477         return duplicate;
2478 }
2479
2480 /*! \brief Return the number of unique matches for the generator */
2481 int ast_cli_generatornummatches(const char *text, const char *word)
2482 {
2483         int matches = 0, i = 0;
2484         char *buf = NULL, *oldbuf = NULL;
2485
2486         while ((buf = ast_cli_generator(text, word, i++))) {
2487                 if (!oldbuf || strcmp(buf,oldbuf))
2488                         matches++;
2489                 if (oldbuf)
2490                         ast_free(oldbuf);
2491                 oldbuf = buf;
2492         }
2493         if (oldbuf)
2494                 ast_free(oldbuf);
2495         return matches;
2496 }
2497
2498 static void destroy_match_list(char **match_list, int matches)
2499 {
2500         if (match_list) {
2501                 int idx;
2502
2503                 for (idx = 1; idx < matches; ++idx) {
2504                         ast_free(match_list[idx]);
2505                 }
2506                 ast_free(match_list);
2507         }
2508 }
2509
2510 char **ast_cli_completion_matches(const char *text, const char *word)
2511 {
2512         char **match_list = NULL, *retstr, *prevstr;
2513         char **new_list;
2514         size_t match_list_len, max_equal, which, i;
2515         int matches = 0;
2516
2517         /* leave entry 0 free for the longest common substring */
2518         match_list_len = 1;
2519         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
2520                 if (matches + 1 >= match_list_len) {
2521                         match_list_len <<= 1;
2522                         new_list = ast_realloc(match_list, match_list_len * sizeof(*match_list));
2523                         if (!new_list) {
2524                                 destroy_match_list(match_list, matches);
2525                                 return NULL;
2526                         }
2527                         match_list = new_list;
2528                 }
2529                 match_list[++matches] = retstr;
2530         }
2531
2532         if (!match_list) {
2533                 return match_list; /* NULL */
2534         }
2535
2536         /* Find the longest substring that is common to all results
2537          * (it is a candidate for completion), and store a copy in entry 0.
2538          */
2539         prevstr = match_list[1];
2540         max_equal = strlen(prevstr);
2541         for (which = 2; which <= matches; which++) {
2542                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
2543                         continue;
2544                 max_equal = i;
2545         }
2546
2547         retstr = ast_malloc(max_equal + 1);
2548         if (!retstr) {
2549                 destroy_match_list(match_list, matches);
2550                 return NULL;
2551         }
2552         ast_copy_string(retstr, match_list[1], max_equal + 1);
2553         match_list[0] = retstr;
2554
2555         /* ensure that the array is NULL terminated */
2556         if (matches + 1 >= match_list_len) {
2557                 new_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list));
2558                 if (!new_list) {
2559                         ast_free(retstr);
2560                         destroy_match_list(match_list, matches);
2561                         return NULL;
2562                 }
2563                 match_list = new_list;
2564         }
2565         match_list[matches + 1] = NULL;
2566
2567         return match_list;
2568 }
2569
2570 /*! \brief returns true if there are more words to match */
2571 static int more_words (const char * const *dst)
2572 {
2573         int i;
2574         for (i = 0; dst[i]; i++) {
2575                 if (dst[i][0] != '[')
2576                         return -1;
2577         }
2578         return 0;
2579 }
2580
2581 /*
2582  * generate the entry at position 'state'
2583  */
2584 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
2585 {
2586         const char *argv[AST_MAX_ARGS];
2587         struct ast_cli_entry *e = NULL;
2588         int x = 0, argindex, matchlen;
2589         int matchnum=0;
2590         char *ret = NULL;
2591         char matchstr[80] = "";
2592         int tws = 0;
2593         /* Split the argument into an array of words */
2594         char *duplicate = parse_args(text, &x, argv, ARRAY_LEN(argv), &tws);
2595
2596         if (!duplicate) /* malloc error */
2597                 return NULL;
2598
2599         /* Compute the index of the last argument (could be an empty string) */
2600         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
2601
2602         /* rebuild the command, ignore terminating white space and flatten space */
2603         ast_join(matchstr, sizeof(matchstr)-1, argv);
2604         matchlen = strlen(matchstr);
2605         if (tws) {
2606                 strcat(matchstr, " "); /* XXX */
2607                 if (matchlen)
2608                         matchlen++;
2609         }
2610         if (lock)
2611                 AST_RWLIST_RDLOCK(&helpers);
2612         while ( (e = cli_next(e)) ) {
2613                 /* XXX repeated code */
2614                 int src = 0, dst = 0, n = 0;
2615
2616                 if (e->command[0] == '_')
2617                         continue;
2618
2619                 /*
2620                  * Try to match words, up to and excluding the last word, which
2621                  * is either a blank or something that we want to extend.
2622                  */
2623                 for (;src < argindex; dst++, src += n) {
2624                         n = word_match(argv[src], e->cmda[dst]);
2625                         if (n < 0)
2626                                 break;
2627                 }
2628
2629                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
2630                         continue;
2631                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
2632                 matchnum += n;  /* this many matches here */
2633                 if (ret) {
2634                         /*
2635                          * argv[src] is a valid prefix of the next word in this
2636                          * command. If this is also the correct entry, return it.
2637                          */
2638                         if (matchnum > state)
2639                                 break;
2640                         ast_free(ret);
2641                         ret = NULL;
2642                 } else if (ast_strlen_zero(e->cmda[dst])) {
2643                         /*
2644                          * This entry is a prefix of the command string entered
2645                          * (only one entry in the list should have this property).
2646                          * Run the generator if one is available. In any case we are done.
2647                          */
2648                         if (e->handler) {       /* new style command */
2649                                 struct ast_cli_args a = {
2650                                         .line = matchstr, .word = word,
2651                                         .pos = argindex,
2652                                         .n = state - matchnum,
2653                                         .argv = argv,
2654                                         .argc = x};
2655                                 ast_module_ref(e->module);
2656                                 ret = e->handler(e, CLI_GENERATE, &a);
2657                                 ast_module_unref(e->module);
2658                         }
2659                         if (ret)
2660                                 break;
2661                 }
2662         }
2663         if (lock)
2664                 AST_RWLIST_UNLOCK(&helpers);
2665         ast_free(duplicate);
2666         return ret;
2667 }
2668
2669 char *ast_cli_generator(const char *text, const char *word, int state)
2670 {
2671         return __ast_cli_generator(text, word, state, 1);
2672 }
2673
2674 int ast_cli_command_full(int uid, int gid, int fd, const char *s)
2675 {
2676         const char *args[AST_MAX_ARGS + 1];
2677         struct ast_cli_entry *e;
2678         int x;
2679         char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
2680         char tmp[AST_MAX_ARGS + 1];
2681         char *retval = CLI_FAILURE;
2682         struct ast_cli_args a = {
2683                 .fd = fd, .argc = x, .argv = args+1 };
2684
2685         if (duplicate == NULL)
2686                 return RESULT_FAILURE;
2687
2688         if (x < 1)      /* We need at least one entry, otherwise ignore */
2689                 goto done;
2690
2691         AST_RWLIST_RDLOCK(&helpers);
2692         e = find_cli(args + 1, 0);
2693         if (e)
2694                 ast_atomic_fetchadd_int(&e->inuse, 1);
2695         AST_RWLIST_UNLOCK(&helpers);
2696         if (e == NULL) {
2697                 ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
2698                 goto done;
2699         }
2700
2701         ast_join(tmp, sizeof(tmp), args + 1);
2702         /* Check if the user has rights to run this command. */
2703         if (!cli_has_permissions(uid, gid, tmp)) {
2704                 ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
2705                 goto done;
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         ast_module_ref(e->module);
2715         retval = e->handler(e, CLI_HANDLER, &a);
2716         ast_module_unref(e->module);
2717
2718         if (retval == CLI_SHOWUSAGE) {
2719                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
2720         } else if (retval == CLI_FAILURE) {
2721                 ast_cli(fd, "Command '%s' failed.\n", s);
2722         }
2723         ast_atomic_fetchadd_int(&e->inuse, -1);
2724 done:
2725         ast_free(duplicate);
2726         return retval == CLI_SUCCESS ? RESULT_SUCCESS : RESULT_FAILURE;
2727 }
2728
2729 int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
2730 {
2731         char cmd[512];
2732         int x, y = 0, count = 0;
2733
2734         for (x = 0; x < size; x++) {
2735                 cmd[y] = s[x];
2736                 y++;
2737                 if (s[x] == '\0') {
2738                         ast_cli_command_full(uid, gid, fd, cmd);
2739                         y = 0;
2740                         count++;
2741                 }
2742         }
2743         return count;
2744 }