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