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