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