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