Merged revisions 313366 via svnmerge from
[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)  && c->cdr && !ast_tvzero(c->cdr->start)) {
906                                 int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->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, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
918                                         c->appl ? c->appl : "(None)",
919                                         S_OR(c->data, ""),      /* XXX different from verbose ? */
920                                         S_COR(c->caller.id.number.valid, c->caller.id.number.str, ""),
921                                         S_OR(c->accountcode, ""),
922                                         S_OR(c->peeraccount, ""),
923                                         c->amaflags, 
924                                         durbuf,
925                                         bc ? bc->name : "(None)",
926                                         c->uniqueid);
927                         } else if (verbose) {
928                                 ast_cli(a->fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
929                                         c->appl ? c->appl : "(None)",
930                                         c->data ? S_OR(c->data, "(Empty)" ): "(None)",
931                                         S_COR(c->caller.id.number.valid, c->caller.id.number.str, ""),
932                                         durbuf,
933                                         S_OR(c->accountcode, ""),
934                                         S_OR(c->peeraccount, ""),
935                                         bc ? bc->name : "(None)");
936                         } else {
937                                 char locbuf[40] = "(None)";
938                                 char appdata[40] = "(None)";
939                                 
940                                 if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
941                                         snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
942                                 if (c->appl)
943                                         snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
944                                 ast_cli(a->fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), 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", c->name);
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", c->name);
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 (!(chan->fin & DEBUGCHAN_FLAG) || !(chan->fout & DEBUGCHAN_FLAG)) {
1284                 if (args->is_off) {
1285                         chan->fin &= ~DEBUGCHAN_FLAG;
1286                         chan->fout &= ~DEBUGCHAN_FLAG;
1287                 } else {
1288                         chan->fin |= DEBUGCHAN_FLAG;
1289                         chan->fout |= DEBUGCHAN_FLAG;
1290                 }
1291                 ast_cli(args->fd, "Debugging %s on channel %s\n", args->is_off ? "disabled" : "enabled",
1292                                 chan->name);
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         struct ast_str *out = ast_str_thread_get(&ast_str_thread_global_buf, 16);
1389         char cdrtime[256];
1390         char nf[256];
1391         struct ast_str *write_transpath = ast_str_alloca(256);
1392         struct ast_str *read_transpath = ast_str_alloca(256);
1393         long elapsed_seconds=0;
1394         int hour=0, min=0, sec=0;
1395 #ifdef CHANNEL_TRACE
1396         int trace_enabled;
1397 #endif
1398
1399         switch (cmd) {
1400         case CLI_INIT:
1401                 e->command = "core show channel";
1402                 e->usage = 
1403                         "Usage: core show channel <channel>\n"
1404                         "       Shows lots of information about the specified channel.\n";
1405                 return NULL;
1406         case CLI_GENERATE:
1407                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
1408         }
1409         
1410         if (a->argc != 4) {
1411                 return CLI_SHOWUSAGE;
1412         }
1413
1414         now = ast_tvnow();
1415
1416         if (!(c = ast_channel_get_by_name(a->argv[3]))) {
1417                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1418                 return CLI_SUCCESS;
1419         }
1420
1421         ast_channel_lock(c);
1422
1423         if (c->cdr) {
1424                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
1425                 hour = elapsed_seconds / 3600;
1426                 min = (elapsed_seconds % 3600) / 60;
1427                 sec = elapsed_seconds % 60;
1428                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
1429         } else {
1430                 strcpy(cdrtime, "N/A");
1431         }
1432
1433         ast_cli(a->fd, 
1434                 " -- General --\n"
1435                 "           Name: %s\n"
1436                 "           Type: %s\n"
1437                 "       UniqueID: %s\n"
1438                 "       LinkedID: %s\n"
1439                 "      Caller ID: %s\n"
1440                 " Caller ID Name: %s\n"
1441                 "Connected Line ID: %s\n"
1442                 "Connected Line ID Name: %s\n"
1443                 "    DNID Digits: %s\n"
1444                 "       Language: %s\n"
1445                 "          State: %s (%d)\n"
1446                 "          Rings: %d\n"
1447                 "  NativeFormats: %s\n"
1448                 "    WriteFormat: %s\n"
1449                 "     ReadFormat: %s\n"
1450                 " WriteTranscode: %s %s\n"
1451                 "  ReadTranscode: %s %s\n"
1452                 "1st File Descriptor: %d\n"
1453                 "      Frames in: %d%s\n"
1454                 "     Frames out: %d%s\n"
1455                 " Time to Hangup: %ld\n"
1456                 "   Elapsed Time: %s\n"
1457                 "  Direct Bridge: %s\n"
1458                 "Indirect Bridge: %s\n"
1459                 " --   PBX   --\n"
1460                 "        Context: %s\n"
1461                 "      Extension: %s\n"
1462                 "       Priority: %d\n"
1463                 "     Call Group: %llu\n"
1464                 "   Pickup Group: %llu\n"
1465                 "    Application: %s\n"
1466                 "           Data: %s\n"
1467                 "    Blocking in: %s\n",
1468                 c->name, c->tech->type, c->uniqueid, c->linkedid,
1469                 S_COR(c->caller.id.number.valid, c->caller.id.number.str, "(N/A)"),
1470                 S_COR(c->caller.id.name.valid, c->caller.id.name.str, "(N/A)"),
1471                 S_COR(c->connected.id.number.valid, c->connected.id.number.str, "(N/A)"),
1472                 S_COR(c->connected.id.name.valid, c->connected.id.name.str, "(N/A)"),
1473                 S_OR(c->dialed.number.str, "(N/A)"),
1474                 c->language,    
1475                 ast_state2str(c->_state), c->_state, c->rings, 
1476                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats),
1477                 ast_getformatname(&c->writeformat),
1478                 ast_getformatname(&c->readformat),
1479                 c->writetrans ? "Yes" : "No",
1480                 ast_translate_path_to_str(c->writetrans, &write_transpath),
1481                 c->readtrans ? "Yes" : "No",
1482                 ast_translate_path_to_str(c->readtrans, &read_transpath),
1483                 c->fds[0],
1484                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1485                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1486                 (long)c->whentohangup.tv_sec,
1487                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
1488                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
1489                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
1490                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
1491         
1492         if (pbx_builtin_serialize_variables(c, &out)) {
1493                 ast_cli(a->fd,"      Variables:\n%s\n", ast_str_buffer(out));
1494         }
1495
1496         if (c->cdr && ast_cdr_serialize_variables(c->cdr, &out, '=', '\n', 1)) {
1497                 ast_cli(a->fd,"  CDR Variables:\n%s\n", ast_str_buffer(out));
1498         }
1499
1500 #ifdef CHANNEL_TRACE
1501         trace_enabled = ast_channel_trace_is_enabled(c);
1502         ast_cli(a->fd, "  Context Trace: %s\n", trace_enabled ? "Enabled" : "Disabled");
1503         if (trace_enabled && ast_channel_trace_serialize(c, &out))
1504                 ast_cli(a->fd, "          Trace:\n%s\n", ast_str_buffer(out));
1505 #endif
1506
1507         ast_channel_unlock(c);
1508         c = ast_channel_unref(c);
1509
1510         return CLI_SUCCESS;
1511 }
1512
1513 /*
1514  * helper function to generate CLI matches from a fixed set of values.
1515  * A NULL word is acceptable.
1516  */
1517 char *ast_cli_complete(const char *word, const char * const choices[], int state)
1518 {
1519         int i, which = 0, len;
1520         len = ast_strlen_zero(word) ? 0 : strlen(word);
1521
1522         for (i = 0; choices[i]; i++) {
1523                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
1524                         return ast_strdup(choices[i]);
1525         }
1526         return NULL;
1527 }
1528
1529 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
1530 {
1531         struct ast_channel *c = NULL;
1532         int which = 0;
1533         char notfound = '\0';
1534         char *ret = &notfound; /* so NULL can break the loop */
1535         struct ast_channel_iterator *iter;
1536
1537         if (pos != rpos) {
1538                 return NULL;
1539         }
1540
1541         if (ast_strlen_zero(word)) {
1542                 iter = ast_channel_iterator_all_new();
1543         } else {
1544                 iter = ast_channel_iterator_by_name_new(word, strlen(word));
1545         }
1546
1547         if (!iter) {
1548                 return NULL;
1549         }
1550
1551         while (ret == &notfound && (c = ast_channel_iterator_next(iter))) {
1552                 if (++which > state) {
1553                         ast_channel_lock(c);
1554                         ret = ast_strdup(c->name);
1555                         ast_channel_unlock(c);
1556                 }
1557                 ast_channel_unref(c);
1558         }
1559
1560         ast_channel_iterator_destroy(iter);
1561
1562         return ret == &notfound ? NULL : ret;
1563 }
1564
1565 static char *group_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1566 {
1567 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1568
1569         struct ast_group_info *gi = NULL;
1570         int numchans = 0;
1571         regex_t regexbuf;
1572         int havepattern = 0;
1573
1574         switch (cmd) {
1575         case CLI_INIT:
1576                 e->command = "group show channels";
1577                 e->usage = 
1578                         "Usage: group show channels [pattern]\n"
1579                         "       Lists all currently active channels with channel group(s) specified.\n"
1580                         "       Optional regular expression pattern is matched to group names for each\n"
1581                         "       channel.\n";
1582                 return NULL;
1583         case CLI_GENERATE:
1584                 return NULL;
1585         }
1586
1587         if (a->argc < 3 || a->argc > 4)
1588                 return CLI_SHOWUSAGE;
1589         
1590         if (a->argc == 4) {
1591                 if (regcomp(&regexbuf, a->argv[3], REG_EXTENDED | REG_NOSUB))
1592                         return CLI_SHOWUSAGE;
1593                 havepattern = 1;
1594         }
1595
1596         ast_cli(a->fd, FORMAT_STRING, "Channel", "Group", "Category");
1597
1598         ast_app_group_list_rdlock();
1599         
1600         gi = ast_app_group_list_head();
1601         while (gi) {
1602                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1603                         ast_cli(a->fd, FORMAT_STRING, gi->chan->name, gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1604                         numchans++;
1605                 }
1606                 gi = AST_LIST_NEXT(gi, group_list);
1607         }
1608         
1609         ast_app_group_list_unlock();
1610         
1611         if (havepattern)
1612                 regfree(&regexbuf);
1613
1614         ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1615         return CLI_SUCCESS;
1616 #undef FORMAT_STRING
1617 }
1618
1619 static char *handle_cli_wait_fullybooted(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1620 {
1621         switch (cmd) {
1622         case CLI_INIT:
1623                 e->command = "core waitfullybooted";
1624                 e->usage =
1625                         "Usage: core waitfullybooted\n"
1626                         "       Wait until Asterisk has fully booted.\n";
1627                 return NULL;
1628         case CLI_GENERATE:
1629                 return NULL;
1630         }
1631
1632         while (!ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1633                 usleep(100);
1634         }
1635
1636         ast_cli(a->fd, "Asterisk has fully booted.\n");
1637
1638         return CLI_SUCCESS;
1639 }
1640
1641 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1642
1643 static struct ast_cli_entry cli_cli[] = {
1644         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1645         AST_CLI_DEFINE(handle_commandcomplete, "Command complete"),
1646         AST_CLI_DEFINE(handle_commandnummatches, "Returns number of command matches"),
1647         AST_CLI_DEFINE(handle_commandmatchesarray, "Returns command matches array"),
1648
1649         AST_CLI_DEFINE(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1650
1651         AST_CLI_DEFINE(handle_chanlist, "Display information on channels"),
1652
1653         AST_CLI_DEFINE(handle_showcalls, "Display information on calls"),
1654
1655         AST_CLI_DEFINE(handle_showchan, "Display information on a specific channel"),
1656
1657         AST_CLI_DEFINE(handle_core_set_debug_channel, "Enable/disable debugging on a channel"),
1658
1659         AST_CLI_DEFINE(handle_verbose, "Set level of debug/verbose chattiness"),
1660
1661         AST_CLI_DEFINE(group_show_channels, "Display active channels with group(s)"),
1662
1663         AST_CLI_DEFINE(handle_help, "Display help list, or specific help on a command"),
1664
1665         AST_CLI_DEFINE(handle_logger_mute, "Toggle logging output to a console"),
1666
1667         AST_CLI_DEFINE(handle_modlist, "List modules and info"),
1668
1669         AST_CLI_DEFINE(handle_load, "Load a module by name"),
1670
1671         AST_CLI_DEFINE(handle_reload, "Reload configuration for a module"),
1672
1673         AST_CLI_DEFINE(handle_core_reload, "Global reload"),
1674
1675         AST_CLI_DEFINE(handle_unload, "Unload a module by name"),
1676
1677         AST_CLI_DEFINE(handle_showuptime, "Show uptime information"),
1678
1679         AST_CLI_DEFINE(handle_softhangup, "Request a hangup on a given channel"),
1680
1681         AST_CLI_DEFINE(handle_cli_reload_permissions, "Reload CLI permissions config"),
1682
1683         AST_CLI_DEFINE(handle_cli_show_permissions, "Show CLI permissions"),
1684
1685         AST_CLI_DEFINE(handle_cli_check_permissions, "Try a permissions config for a user"),
1686
1687         AST_CLI_DEFINE(handle_cli_wait_fullybooted, "Wait for Asterisk to be fully booted"),
1688 };
1689
1690 /*!
1691  * Some regexp characters in cli arguments are reserved and used as separators.
1692  */
1693 static const char cli_rsvd[] = "[]{}|*%";
1694
1695 /*!
1696  * initialize the _full_cmd string and related parameters,
1697  * return 0 on success, -1 on error.
1698  */
1699 static int set_full_cmd(struct ast_cli_entry *e)
1700 {
1701         int i;
1702         char buf[80];
1703
1704         ast_join(buf, sizeof(buf), e->cmda);
1705         e->_full_cmd = ast_strdup(buf);
1706         if (!e->_full_cmd) {
1707                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1708                 return -1;
1709         }
1710         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1711         for (i = 0; e->cmda[i]; i++)
1712                 ;
1713         e->args = i;
1714         return 0;
1715 }
1716
1717 /*! \brief cleanup (free) cli_perms linkedlist. */
1718 static void destroy_user_perms(void)
1719 {
1720         struct cli_perm *perm;
1721         struct usergroup_cli_perm *user_perm;
1722
1723         AST_RWLIST_WRLOCK(&cli_perms);
1724         while ((user_perm = AST_LIST_REMOVE_HEAD(&cli_perms, list))) {
1725                 while ((perm = AST_LIST_REMOVE_HEAD(user_perm->perms, list))) {
1726                         ast_free(perm->command);
1727                         ast_free(perm);
1728                 }
1729                 ast_free(user_perm);
1730         }
1731         AST_RWLIST_UNLOCK(&cli_perms);
1732 }
1733
1734 int ast_cli_perms_init(int reload)
1735 {
1736         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1737         struct ast_config *cfg;
1738         char *cat = NULL;
1739         struct ast_variable *v;
1740         struct usergroup_cli_perm *user_group, *cp_entry;
1741         struct cli_perm *perm = NULL;
1742         struct passwd *pw;
1743         struct group *gr;
1744
1745         if (ast_mutex_trylock(&permsconfiglock)) {
1746                 ast_log(LOG_NOTICE, "You must wait until last 'cli reload permissions' command finish\n");
1747                 return 1;
1748         }
1749
1750         cfg = ast_config_load2(perms_config, "" /* core, can't reload */, config_flags);
1751         if (!cfg) {
1752                 ast_mutex_unlock(&permsconfiglock);
1753                 return 1;
1754         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
1755                 ast_mutex_unlock(&permsconfiglock);
1756                 return 0;
1757         }
1758
1759         /* free current structures. */
1760         destroy_user_perms();
1761
1762         while ((cat = ast_category_browse(cfg, cat))) {
1763                 if (!strcasecmp(cat, "general")) {
1764                         /* General options */
1765                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1766                                 if (!strcasecmp(v->name, "default_perm")) {
1767                                         cli_default_perm = (!strcasecmp(v->value, "permit")) ? 1: 0;
1768                                 }
1769                         }
1770                         continue;
1771                 }
1772
1773                 /* users or groups */
1774                 gr = NULL, pw = NULL;
1775                 if (cat[0] == '@') {
1776                         /* This is a group */
1777                         gr = getgrnam(&cat[1]);
1778                         if (!gr) {
1779                                 ast_log (LOG_WARNING, "Unknown group '%s'\n", &cat[1]);
1780                                 continue;
1781                         }
1782                 } else {
1783                         /* This is a user */
1784                         pw = getpwnam(cat);
1785                         if (!pw) {
1786                                 ast_log (LOG_WARNING, "Unknown user '%s'\n", cat);
1787                                 continue;
1788                         }
1789                 }
1790                 user_group = NULL;
1791                 /* Check for duplicates */
1792                 AST_RWLIST_WRLOCK(&cli_perms);
1793                 AST_LIST_TRAVERSE(&cli_perms, cp_entry, list) {
1794                         if ((pw && cp_entry->uid == pw->pw_uid) || (gr && cp_entry->gid == gr->gr_gid)) {
1795                                 /* if it is duplicated, just added this new settings, to 
1796                                 the current list. */
1797                                 user_group = cp_entry;
1798                                 break;
1799                         }
1800                 }
1801                 AST_RWLIST_UNLOCK(&cli_perms);
1802
1803                 if (!user_group) {
1804                         /* alloc space for the new user config. */
1805                         user_group = ast_calloc(1, sizeof(*user_group));
1806                         if (!user_group) {
1807                                 continue;
1808                         }
1809                         user_group->uid = (pw ? pw->pw_uid : -1);
1810                         user_group->gid = (gr ? gr->gr_gid : -1);
1811                         user_group->perms = ast_calloc(1, sizeof(*user_group->perms));
1812                         if (!user_group->perms) {
1813                                 ast_free(user_group);
1814                                 continue;
1815                         }
1816                 }
1817                 for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1818                         if (ast_strlen_zero(v->value)) {
1819                                 /* we need to check this condition cause it could break security. */
1820                                 ast_log(LOG_WARNING, "Empty permit/deny option in user '%s'\n", cat);
1821                                 continue;
1822                         }
1823                         if (!strcasecmp(v->name, "permit")) {
1824                                 perm = ast_calloc(1, sizeof(*perm));
1825                                 if (perm) {
1826                                         perm->permit = 1;
1827                                         perm->command = ast_strdup(v->value);
1828                                 }
1829                         } else if (!strcasecmp(v->name, "deny")) {
1830                                 perm = ast_calloc(1, sizeof(*perm));
1831                                 if (perm) {
1832                                         perm->permit = 0;
1833                                         perm->command = ast_strdup(v->value);
1834                                 }
1835                         } else {
1836                                 /* up to now, only 'permit' and 'deny' are possible values. */
1837                                 ast_log(LOG_WARNING, "Unknown '%s' option\n", v->name);
1838                                 continue;
1839                         }
1840                         if (perm) {
1841                                 /* Added the permission to the user's list. */
1842                                 AST_LIST_INSERT_TAIL(user_group->perms, perm, list);
1843                                 perm = NULL;
1844                         }
1845                 }
1846                 AST_RWLIST_WRLOCK(&cli_perms);
1847                 AST_RWLIST_INSERT_TAIL(&cli_perms, user_group, list);
1848                 AST_RWLIST_UNLOCK(&cli_perms);
1849         }
1850
1851         ast_config_destroy(cfg);
1852         ast_mutex_unlock(&permsconfiglock);
1853         return 0;
1854 }
1855
1856 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1857 void ast_builtins_init(void)
1858 {
1859         ast_cli_register_multiple(cli_cli, ARRAY_LEN(cli_cli));
1860 }
1861
1862 /*!
1863  * match a word in the CLI entry.
1864  * returns -1 on mismatch, 0 on match of an optional word,
1865  * 1 on match of a full word.
1866  *
1867  * The pattern can be
1868  *   any_word           match for equal
1869  *   [foo|bar|baz]      optionally, one of these words
1870  *   {foo|bar|baz}      exactly, one of these words
1871  *   %                  any word
1872  */
1873 static int word_match(const char *cmd, const char *cli_word)
1874 {
1875         int l;
1876         char *pos;
1877
1878         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1879                 return -1;
1880         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1881                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1882         /* regexp match, takes [foo|bar] or {foo|bar} */
1883         l = strlen(cmd);
1884         /* wildcard match - will extend in the future */
1885         if (l > 0 && cli_word[0] == '%') {
1886                 return 1;       /* wildcard */
1887         }
1888         pos = strcasestr(cli_word, cmd);
1889         if (pos == NULL) /* not found, say ok if optional */
1890                 return cli_word[0] == '[' ? 0 : -1;
1891         if (pos == cli_word)    /* no valid match at the beginning */
1892                 return -1;
1893         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1894                 return 1;       /* valid match */
1895         return -1;      /* not found */
1896 }
1897
1898 /*! \brief if word is a valid prefix for token, returns the pos-th
1899  * match as a malloced string, or NULL otherwise.
1900  * Always tell in *actual how many matches we got.
1901  */
1902 static char *is_prefix(const char *word, const char *token,
1903         int pos, int *actual)
1904 {
1905         int lw;
1906         char *s, *t1;
1907
1908         *actual = 0;
1909         if (ast_strlen_zero(token))
1910                 return NULL;
1911         if (ast_strlen_zero(word))
1912                 word = "";      /* dummy */
1913         lw = strlen(word);
1914         if (strcspn(word, cli_rsvd) != lw)
1915                 return NULL;    /* no match if word has reserved chars */
1916         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1917                 if (strncasecmp(token, word, lw))       /* no match */
1918                         return NULL;
1919                 *actual = 1;
1920                 return (pos != 0) ? NULL : ast_strdup(token);
1921         }
1922         /* now handle regexp match */
1923
1924         /* Wildcard always matches, so we never do is_prefix on them */
1925
1926         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1927         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1928                 if (*s == '%')  /* wildcard */
1929                         continue;
1930                 if (strncasecmp(s, word, lw))   /* no match */
1931                         continue;
1932                 (*actual)++;
1933                 if (pos-- == 0)
1934                         return ast_strdup(s);
1935         }
1936         return NULL;
1937 }
1938
1939 /*!
1940  * \internal
1941  * \brief locate a cli command in the 'helpers' list (which must be locked).
1942  *     The search compares word by word taking care of regexps in e->cmda
1943  *     This function will return NULL when nothing is matched, or the ast_cli_entry that matched.
1944  * \param cmds
1945  * \param match_type has 3 possible values:
1946  *      0       returns if the search key is equal or longer than the entry.
1947  *                          note that trailing optional arguments are skipped.
1948  *      -1      true if the mismatch is on the last word XXX not true!
1949  *      1       true only on complete, exact match.
1950  *
1951  */
1952 static struct ast_cli_entry *find_cli(const char * const cmds[], int match_type)
1953 {
1954         int matchlen = -1;      /* length of longest match so far */
1955         struct ast_cli_entry *cand = NULL, *e=NULL;
1956
1957         while ( (e = cli_next(e)) ) {
1958                 /* word-by word regexp comparison */
1959                 const char * const *src = cmds;
1960                 const char * const *dst = e->cmda;
1961                 int n = 0;
1962                 for (;; dst++, src += n) {
1963                         n = word_match(*src, *dst);
1964                         if (n < 0)
1965                                 break;
1966                 }
1967                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1968                         /* no more words in 'e' */
1969                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1970                                 break;
1971                         /* Here, cmds has more words than the entry 'e' */
1972                         if (match_type != 0)    /* but we look for almost exact match... */
1973                                 continue;       /* so we skip this one. */
1974                         /* otherwise we like it (case 0) */
1975                 } else {        /* still words in 'e' */
1976                         if (ast_strlen_zero(*src))
1977                                 continue; /* cmds is shorter than 'e', not good */
1978                         /* Here we have leftover words in cmds and 'e',
1979                          * but there is a mismatch. We only accept this one if match_type == -1
1980                          * and this is the last word for both.
1981                          */
1982                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1983                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1984                                 continue;
1985                         /* good, we are in case match_type == -1 and mismatch on last word */
1986                 }
1987                 if (src - cmds > matchlen) {    /* remember the candidate */
1988                         matchlen = src - cmds;
1989                         cand = e;
1990                 }
1991         }
1992
1993         return e ? e : cand;
1994 }
1995
1996 static char *find_best(const char *argv[])
1997 {
1998         static char cmdline[80];
1999         int x;
2000         /* See how close we get, then print the candidate */
2001         const char *myargv[AST_MAX_CMD_LEN] = { NULL, };
2002
2003         AST_RWLIST_RDLOCK(&helpers);
2004         for (x = 0; argv[x]; x++) {
2005                 myargv[x] = argv[x];
2006                 if (!find_cli(myargv, -1))
2007                         break;
2008         }
2009         AST_RWLIST_UNLOCK(&helpers);
2010         ast_join(cmdline, sizeof(cmdline), myargv);
2011         return cmdline;
2012 }
2013
2014 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
2015 {
2016         if (e->inuse) {
2017                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
2018         } else {
2019                 AST_RWLIST_WRLOCK(&helpers);
2020                 AST_RWLIST_REMOVE(&helpers, e, list);
2021                 AST_RWLIST_UNLOCK(&helpers);
2022                 ast_free(e->_full_cmd);
2023                 e->_full_cmd = NULL;
2024                 if (e->handler) {
2025                         /* this is a new-style entry. Reset fields and free memory. */
2026                         char *cmda = (char *) e->cmda;
2027                         memset(cmda, '\0', sizeof(e->cmda));
2028                         ast_free(e->command);
2029                         e->command = NULL;
2030                         e->usage = NULL;
2031                 }
2032         }
2033         return 0;
2034 }
2035
2036 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
2037 {
2038         struct ast_cli_entry *cur;
2039         int i, lf, ret = -1;
2040
2041         struct ast_cli_args a;  /* fake argument */
2042         char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
2043         char *s;
2044
2045         memset(&a, '\0', sizeof(a));
2046         e->handler(e, CLI_INIT, &a);
2047         /* XXX check that usage and command are filled up */
2048         s = ast_skip_blanks(e->command);
2049         s = e->command = ast_strdup(s);
2050         for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
2051                 *dst++ = s;     /* store string */
2052                 s = ast_skip_nonblanks(s);
2053                 if (*s == '\0') /* we are done */
2054                         break;
2055                 *s++ = '\0';
2056                 s = ast_skip_blanks(s);
2057         }
2058         *dst++ = NULL;
2059         
2060         AST_RWLIST_WRLOCK(&helpers);
2061         
2062         if (find_cli(e->cmda, 1)) {
2063                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", S_OR(e->_full_cmd, e->command));
2064                 goto done;
2065         }
2066         if (set_full_cmd(e))
2067                 goto done;
2068
2069         lf = e->cmdlen;
2070         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
2071                 int len = cur->cmdlen;
2072                 if (lf < len)
2073                         len = lf;
2074                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
2075                         AST_RWLIST_INSERT_BEFORE_CURRENT(e, list); 
2076                         break;
2077                 }
2078         }
2079         AST_RWLIST_TRAVERSE_SAFE_END;
2080
2081         if (!cur)
2082                 AST_RWLIST_INSERT_TAIL(&helpers, e, list); 
2083         ret = 0;        /* success */
2084
2085 done:
2086         AST_RWLIST_UNLOCK(&helpers);
2087
2088         return ret;
2089 }
2090
2091 /* wrapper function, so we can unregister deprecated commands recursively */
2092 int ast_cli_unregister(struct ast_cli_entry *e)
2093 {
2094         return __ast_cli_unregister(e, NULL);
2095 }
2096
2097 /* wrapper function, so we can register deprecated commands recursively */
2098 int ast_cli_register(struct ast_cli_entry *e)
2099 {
2100         return __ast_cli_register(e, NULL);
2101 }
2102
2103 /*
2104  * register/unregister an array of entries.
2105  */
2106 int ast_cli_register_multiple(struct ast_cli_entry *e, int len)
2107 {
2108         int i, res = 0;
2109
2110         for (i = 0; i < len; i++)
2111                 res |= ast_cli_register(e + i);
2112
2113         return res;
2114 }
2115
2116 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
2117 {
2118         int i, res = 0;
2119
2120         for (i = 0; i < len; i++)
2121                 res |= ast_cli_unregister(e + i);
2122
2123         return res;
2124 }
2125
2126
2127 /*! \brief helper for final part of handle_help
2128  *  if locked = 1, assume the list is already locked
2129  */
2130 static char *help1(int fd, const char * const match[], int locked)
2131 {
2132         char matchstr[80] = "";
2133         struct ast_cli_entry *e = NULL;
2134         int len = 0;
2135         int found = 0;
2136
2137         if (match) {
2138                 ast_join(matchstr, sizeof(matchstr), match);
2139                 len = strlen(matchstr);
2140         }
2141         if (!locked)
2142                 AST_RWLIST_RDLOCK(&helpers);
2143         while ( (e = cli_next(e)) ) {
2144                 /* Hide commands that start with '_' */
2145                 if (e->_full_cmd[0] == '_')
2146                         continue;
2147                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
2148                         continue;
2149                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
2150                 found++;
2151         }
2152         if (!locked)
2153                 AST_RWLIST_UNLOCK(&helpers);
2154         if (!found && matchstr[0])
2155                 ast_cli(fd, "No such command '%s'.\n", matchstr);
2156         return CLI_SUCCESS;
2157 }
2158
2159 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2160 {
2161         char fullcmd[80];
2162         struct ast_cli_entry *my_e;
2163         char *res = CLI_SUCCESS;
2164
2165         if (cmd == CLI_INIT) {
2166                 e->command = "core show help";
2167                 e->usage =
2168                         "Usage: core show help [topic]\n"
2169                         "       When called with a topic as an argument, displays usage\n"
2170                         "       information on the given command. If called without a\n"
2171                         "       topic, it provides a list of commands.\n";
2172                 return NULL;
2173
2174         } else if (cmd == CLI_GENERATE) {
2175                 /* skip first 14 or 15 chars, "core show help " */
2176                 int l = strlen(a->line);
2177
2178                 if (l > 15) {
2179                         l = 15;
2180                 }
2181                 /* XXX watch out, should stop to the non-generator parts */
2182                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
2183         }
2184         if (a->argc == e->args) {
2185                 return help1(a->fd, NULL, 0);
2186         }
2187
2188         AST_RWLIST_RDLOCK(&helpers);
2189         my_e = find_cli(a->argv + 3, 1);        /* try exact match first */
2190         if (!my_e) {
2191                 res = help1(a->fd, a->argv + 3, 1 /* locked */);
2192                 AST_RWLIST_UNLOCK(&helpers);
2193                 return res;
2194         }
2195         if (my_e->usage)
2196                 ast_cli(a->fd, "%s", my_e->usage);
2197         else {
2198                 ast_join(fullcmd, sizeof(fullcmd), a->argv + 3);
2199                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
2200         }
2201         AST_RWLIST_UNLOCK(&helpers);
2202         return res;
2203 }
2204
2205 static char *parse_args(const char *s, int *argc, const char *argv[], int max, int *trailingwhitespace)
2206 {
2207         char *duplicate, *cur;
2208         int x = 0;
2209         int quoted = 0;
2210         int escaped = 0;
2211         int whitespace = 1;
2212         int dummy = 0;
2213
2214         if (trailingwhitespace == NULL)
2215                 trailingwhitespace = &dummy;
2216         *trailingwhitespace = 0;
2217         if (s == NULL)  /* invalid, though! */
2218                 return NULL;
2219         /* make a copy to store the parsed string */
2220         if (!(duplicate = ast_strdup(s)))
2221                 return NULL;
2222
2223         cur = duplicate;
2224         /* scan the original string copying into cur when needed */
2225         for (; *s ; s++) {
2226                 if (x >= max - 1) {
2227                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
2228                         break;
2229                 }
2230                 if (*s == '"' && !escaped) {
2231                         quoted = !quoted;
2232                         if (quoted && whitespace) {
2233                                 /* start a quoted string from previous whitespace: new argument */
2234                                 argv[x++] = cur;
2235                                 whitespace = 0;
2236                         }
2237                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
2238                         /* If we are not already in whitespace, and not in a quoted string or
2239                            processing an escape sequence, and just entered whitespace, then
2240                            finalize the previous argument and remember that we are in whitespace
2241                         */
2242                         if (!whitespace) {
2243                                 *cur++ = '\0';
2244                                 whitespace = 1;
2245                         }
2246                 } else if (*s == '\\' && !escaped) {
2247                         escaped = 1;
2248                 } else {
2249                         if (whitespace) {
2250                                 /* we leave whitespace, and are not quoted. So it's a new argument */
2251                                 argv[x++] = cur;
2252                                 whitespace = 0;
2253                         }
2254                         *cur++ = *s;
2255                         escaped = 0;
2256                 }
2257         }
2258         /* Null terminate */
2259         *cur++ = '\0';
2260         /* XXX put a NULL in the last argument, because some functions that take
2261          * the array may want a null-terminated array.
2262          * argc still reflects the number of non-NULL entries.
2263          */
2264         argv[x] = NULL;
2265         *argc = x;
2266         *trailingwhitespace = whitespace;
2267         return duplicate;
2268 }
2269
2270 /*! \brief Return the number of unique matches for the generator */
2271 int ast_cli_generatornummatches(const char *text, const char *word)
2272 {
2273         int matches = 0, i = 0;
2274         char *buf = NULL, *oldbuf = NULL;
2275
2276         while ((buf = ast_cli_generator(text, word, i++))) {
2277                 if (!oldbuf || strcmp(buf,oldbuf))
2278                         matches++;
2279                 if (oldbuf)
2280                         ast_free(oldbuf);
2281                 oldbuf = buf;
2282         }
2283         if (oldbuf)
2284                 ast_free(oldbuf);
2285         return matches;
2286 }
2287
2288 char **ast_cli_completion_matches(const char *text, const char *word)
2289 {
2290         char **match_list = NULL, *retstr, *prevstr;
2291         size_t match_list_len, max_equal, which, i;
2292         int matches = 0;
2293
2294         /* leave entry 0 free for the longest common substring */
2295         match_list_len = 1;
2296         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
2297                 if (matches + 1 >= match_list_len) {
2298                         match_list_len <<= 1;
2299                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
2300                                 return NULL;
2301                 }
2302                 match_list[++matches] = retstr;
2303         }
2304
2305         if (!match_list)
2306                 return match_list; /* NULL */
2307
2308         /* Find the longest substring that is common to all results
2309          * (it is a candidate for completion), and store a copy in entry 0.
2310          */
2311         prevstr = match_list[1];
2312         max_equal = strlen(prevstr);
2313         for (which = 2; which <= matches; which++) {
2314                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
2315                         continue;
2316                 max_equal = i;
2317         }
2318
2319         if (!(retstr = ast_malloc(max_equal + 1)))
2320                 return NULL;
2321         
2322         ast_copy_string(retstr, match_list[1], max_equal + 1);
2323         match_list[0] = retstr;
2324
2325         /* ensure that the array is NULL terminated */
2326         if (matches + 1 >= match_list_len) {
2327                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
2328                         return NULL;
2329         }
2330         match_list[matches + 1] = NULL;
2331
2332         return match_list;
2333 }
2334
2335 /*! \brief returns true if there are more words to match */
2336 static int more_words (const char * const *dst)
2337 {
2338         int i;
2339         for (i = 0; dst[i]; i++) {
2340                 if (dst[i][0] != '[')
2341                         return -1;
2342         }
2343         return 0;
2344 }
2345         
2346 /*
2347  * generate the entry at position 'state'
2348  */
2349 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
2350 {
2351         const char *argv[AST_MAX_ARGS];
2352         struct ast_cli_entry *e = NULL;
2353         int x = 0, argindex, matchlen;
2354         int matchnum=0;
2355         char *ret = NULL;
2356         char matchstr[80] = "";
2357         int tws = 0;
2358         /* Split the argument into an array of words */
2359         char *duplicate = parse_args(text, &x, argv, ARRAY_LEN(argv), &tws);
2360
2361         if (!duplicate) /* malloc error */
2362                 return NULL;
2363
2364         /* Compute the index of the last argument (could be an empty string) */
2365         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
2366
2367         /* rebuild the command, ignore terminating white space and flatten space */
2368         ast_join(matchstr, sizeof(matchstr)-1, argv);
2369         matchlen = strlen(matchstr);
2370         if (tws) {
2371                 strcat(matchstr, " "); /* XXX */
2372                 if (matchlen)
2373                         matchlen++;
2374         }
2375         if (lock)
2376                 AST_RWLIST_RDLOCK(&helpers);
2377         while ( (e = cli_next(e)) ) {
2378                 /* XXX repeated code */
2379                 int src = 0, dst = 0, n = 0;
2380
2381                 if (e->command[0] == '_')
2382                         continue;
2383
2384                 /*
2385                  * Try to match words, up to and excluding the last word, which
2386                  * is either a blank or something that we want to extend.
2387                  */
2388                 for (;src < argindex; dst++, src += n) {
2389                         n = word_match(argv[src], e->cmda[dst]);
2390                         if (n < 0)
2391                                 break;
2392                 }
2393
2394                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
2395                         continue;
2396                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
2397                 matchnum += n;  /* this many matches here */
2398                 if (ret) {
2399                         /*
2400                          * argv[src] is a valid prefix of the next word in this
2401                          * command. If this is also the correct entry, return it.
2402                          */
2403                         if (matchnum > state)
2404                                 break;
2405                         ast_free(ret);
2406                         ret = NULL;
2407                 } else if (ast_strlen_zero(e->cmda[dst])) {
2408                         /*
2409                          * This entry is a prefix of the command string entered
2410                          * (only one entry in the list should have this property).
2411                          * Run the generator if one is available. In any case we are done.
2412                          */
2413                         if (e->handler) {       /* new style command */
2414                                 struct ast_cli_args a = {
2415                                         .line = matchstr, .word = word,
2416                                         .pos = argindex,
2417                                         .n = state - matchnum,
2418                                         .argv = argv,
2419                                         .argc = x};
2420                                 ret = e->handler(e, CLI_GENERATE, &a);
2421                         }
2422                         if (ret)
2423                                 break;
2424                 }
2425         }
2426         if (lock)
2427                 AST_RWLIST_UNLOCK(&helpers);
2428         ast_free(duplicate);
2429         return ret;
2430 }
2431
2432 char *ast_cli_generator(const char *text, const char *word, int state)
2433 {
2434         return __ast_cli_generator(text, word, state, 1);
2435 }
2436
2437 int ast_cli_command_full(int uid, int gid, int fd, const char *s)
2438 {
2439         const char *args[AST_MAX_ARGS + 1];
2440         struct ast_cli_entry *e;
2441         int x;
2442         char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
2443         char tmp[AST_MAX_ARGS + 1];
2444         char *retval = NULL;
2445         struct ast_cli_args a = {
2446                 .fd = fd, .argc = x, .argv = args+1 };
2447
2448         if (duplicate == NULL)
2449                 return -1;
2450
2451         if (x < 1)      /* We need at least one entry, otherwise ignore */
2452                 goto done;
2453
2454         AST_RWLIST_RDLOCK(&helpers);
2455         e = find_cli(args + 1, 0);
2456         if (e)
2457                 ast_atomic_fetchadd_int(&e->inuse, 1);
2458         AST_RWLIST_UNLOCK(&helpers);
2459         if (e == NULL) {
2460                 ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
2461                 goto done;
2462         }
2463
2464         ast_join(tmp, sizeof(tmp), args + 1);
2465         /* Check if the user has rights to run this command. */
2466         if (!cli_has_permissions(uid, gid, tmp)) {
2467                 ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
2468                 ast_free(duplicate);
2469                 return 0;
2470         }
2471
2472         /*
2473          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
2474          * Remember that the array returned by parse_args is NULL-terminated.
2475          */
2476         args[0] = (char *)e;
2477
2478         retval = e->handler(e, CLI_HANDLER, &a);
2479
2480         if (retval == CLI_SHOWUSAGE) {
2481                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
2482         } else {
2483                 if (retval == CLI_FAILURE)
2484                         ast_cli(fd, "Command '%s' failed.\n", s);
2485         }
2486         ast_atomic_fetchadd_int(&e->inuse, -1);
2487 done:
2488         ast_free(duplicate);
2489         return 0;
2490 }
2491
2492 int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
2493 {
2494         char cmd[512];
2495         int x, y = 0, count = 0;
2496
2497         for (x = 0; x < size; x++) {
2498                 cmd[y] = s[x];
2499                 y++;
2500                 if (s[x] == '\0') {
2501                         ast_cli_command_full(uid, gid, fd, cmd);
2502                         y = 0;
2503                         count++;
2504                 }
2505         }
2506         return count;
2507 }