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