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