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