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