acb1f6b15a54cc6e14ffa0190cdc48863dc6bba7
[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>\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                 return NULL;
943         case CLI_GENERATE:
944                 return ast_complete_channels(a->line, a->word, a->pos, a->n, e->args);
945         }
946
947         if (a->argc != 4) {
948                 return CLI_SHOWUSAGE;
949         }
950
951         if ((c = ast_channel_get_by_name(a->argv[3]))) {
952                 ast_channel_lock(c);
953                 ast_cli(a->fd, "Requested Hangup on channel '%s'\n", c->name);
954                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
955                 ast_channel_unlock(c);
956                 c = ast_channel_unref(c);
957         } else {
958                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
959         }
960
961         return CLI_SUCCESS;
962 }
963
964 /*! \brief handles CLI command 'cli show permissions' */
965 static char *handle_cli_show_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
966 {
967         struct usergroup_cli_perm *cp;
968         struct cli_perm *perm;
969         struct passwd *pw = NULL;
970         struct group *gr = NULL;
971
972         switch (cmd) {
973         case CLI_INIT:
974                 e->command = "cli show permissions";
975                 e->usage =
976                         "Usage: cli show permissions\n"
977                         "       Shows CLI configured permissions.\n";
978                 return NULL;
979         case CLI_GENERATE:
980                 return NULL;
981         }
982
983         AST_RWLIST_RDLOCK(&cli_perms);
984         AST_LIST_TRAVERSE(&cli_perms, cp, list) {
985                 if (cp->uid >= 0) {
986                         pw = getpwuid(cp->uid);
987                         if (pw) {
988                                 ast_cli(a->fd, "user: %s [uid=%d]\n", pw->pw_name, cp->uid);
989                         }
990                 } else {
991                         gr = getgrgid(cp->gid);
992                         if (gr) {
993                                 ast_cli(a->fd, "group: %s [gid=%d]\n", gr->gr_name, cp->gid);
994                         }
995                 }
996                 ast_cli(a->fd, "Permissions:\n");
997                 if (cp->perms) {
998                         AST_LIST_TRAVERSE(cp->perms, perm, list) {
999                                 ast_cli(a->fd, "\t%s -> %s\n", perm->permit ? "permit" : "deny", perm->command);
1000                         }
1001                 }
1002                 ast_cli(a->fd, "\n");
1003         }
1004         AST_RWLIST_UNLOCK(&cli_perms);
1005
1006         return CLI_SUCCESS;
1007 }
1008
1009 /*! \brief handles CLI command 'cli reload permissions' */
1010 static char *handle_cli_reload_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1011 {
1012         switch (cmd) {
1013         case CLI_INIT:
1014                 e->command = "cli reload permissions";
1015                 e->usage =
1016                         "Usage: cli reload permissions\n"
1017                         "       Reload the 'cli_permissions.conf' file.\n";
1018                 return NULL;
1019         case CLI_GENERATE:
1020                 return NULL;
1021         }
1022
1023         ast_cli_perms_init(1);
1024
1025         return CLI_SUCCESS;
1026 }
1027
1028 /*! \brief handles CLI command 'cli check permissions' */
1029 static char *handle_cli_check_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1030 {
1031         struct passwd *pw = NULL;
1032         struct group *gr;
1033         int gid = -1, uid = -1;
1034         char command[AST_MAX_ARGS] = "";
1035         struct ast_cli_entry *ce = NULL;
1036         int found = 0;
1037         char *group, *tmp;
1038
1039         switch (cmd) {
1040         case CLI_INIT:
1041                 e->command = "cli check permissions";
1042                 e->usage =
1043                         "Usage: cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>]\n"
1044                         "       Check permissions config for a user@group or list the allowed commands for the specified user.\n"
1045                         "       The username or the groupname may be omitted.\n";
1046                 return NULL;
1047         case CLI_GENERATE:
1048                 if (a->pos >= 4) {
1049                         return ast_cli_generator(a->line + strlen("cli check permissions") + strlen(a->argv[3]) + 1, a->word, a->n);
1050                 }
1051                 return NULL;
1052         }
1053
1054         if (a->argc < 4) {
1055                 return CLI_SHOWUSAGE;
1056         }
1057
1058         tmp = ast_strdupa(a->argv[3]);
1059         group = strchr(tmp, '@');
1060         if (group) {
1061                 gr = getgrnam(&group[1]);
1062                 if (!gr) {
1063                         ast_cli(a->fd, "Unknown group '%s'\n", &group[1]);
1064                         return CLI_FAILURE;
1065                 }
1066                 group[0] = '\0';
1067                 gid = gr->gr_gid;
1068         }
1069
1070         if (!group && ast_strlen_zero(tmp)) {
1071                 ast_cli(a->fd, "You didn't supply a username\n");
1072         } else if (!ast_strlen_zero(tmp) && !(pw = getpwnam(tmp))) {
1073                 ast_cli(a->fd, "Unknown user '%s'\n", tmp);
1074                 return CLI_FAILURE;
1075         } else if (pw) {
1076                 uid = pw->pw_uid;
1077         }
1078
1079         if (a->argc == 4) {
1080                 while ((ce = cli_next(ce))) {
1081                         /* Hide commands that start with '_' */
1082                         if (ce->_full_cmd[0] == '_') {
1083                                 continue;
1084                         }
1085                         if (cli_has_permissions(uid, gid, ce->_full_cmd)) {
1086                                 ast_cli(a->fd, "%30.30s %s\n", ce->_full_cmd, S_OR(ce->summary, "<no description available>"));
1087                                 found++;
1088                         }
1089                 }
1090                 if (!found) {
1091                         ast_cli(a->fd, "You are not allowed to run any command on Asterisk\n");
1092                 }
1093         } else {
1094                 ast_join(command, sizeof(command), a->argv + 4);
1095                 ast_cli(a->fd, "%s '%s%s%s' is %s to run command: '%s'\n", uid >= 0 ? "User" : "Group", tmp,
1096                         group && uid >= 0 ? "@" : "",
1097                         group ? &group[1] : "",
1098                         cli_has_permissions(uid, gid, command) ? "allowed" : "not allowed", command);
1099         }
1100
1101         return CLI_SUCCESS;
1102 }
1103
1104 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
1105
1106 static char *handle_commandmatchesarray(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1107 {
1108         char *buf, *obuf;
1109         int buflen = 2048;
1110         int len = 0;
1111         char **matches;
1112         int x, matchlen;
1113         
1114         switch (cmd) {
1115         case CLI_INIT:
1116                 e->command = "_command matchesarray";
1117                 e->usage = 
1118                         "Usage: _command matchesarray \"<line>\" text \n"
1119                         "       This function is used internally to help with command completion and should.\n"
1120                         "       never be called by the user directly.\n";
1121                 return NULL;
1122         case CLI_GENERATE:
1123                 return NULL;
1124         }
1125
1126         if (a->argc != 4)
1127                 return CLI_SHOWUSAGE;
1128         if (!(buf = ast_malloc(buflen)))
1129                 return CLI_FAILURE;
1130         buf[len] = '\0';
1131         matches = ast_cli_completion_matches(a->argv[2], a->argv[3]);
1132         if (matches) {
1133                 for (x=0; matches[x]; x++) {
1134                         matchlen = strlen(matches[x]) + 1;
1135                         if (len + matchlen >= buflen) {
1136                                 buflen += matchlen * 3;
1137                                 obuf = buf;
1138                                 if (!(buf = ast_realloc(obuf, buflen))) 
1139                                         /* Memory allocation failure...  Just free old buffer and be done */
1140                                         ast_free(obuf);
1141                         }
1142                         if (buf)
1143                                 len += sprintf( buf + len, "%s ", matches[x]);
1144                         ast_free(matches[x]);
1145                         matches[x] = NULL;
1146                 }
1147                 ast_free(matches);
1148         }
1149
1150         if (buf) {
1151                 ast_cli(a->fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
1152                 ast_free(buf);
1153         } else
1154                 ast_cli(a->fd, "NULL\n");
1155
1156         return CLI_SUCCESS;
1157 }
1158
1159
1160
1161 static char *handle_commandnummatches(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1162 {
1163         int matches = 0;
1164
1165         switch (cmd) {
1166         case CLI_INIT:
1167                 e->command = "_command nummatches";
1168                 e->usage = 
1169                         "Usage: _command nummatches \"<line>\" text \n"
1170                         "       This function is used internally to help with command completion and should.\n"
1171                         "       never be called by the user directly.\n";
1172                 return NULL;
1173         case CLI_GENERATE:
1174                 return NULL;
1175         }
1176
1177         if (a->argc != 4)
1178                 return CLI_SHOWUSAGE;
1179
1180         matches = ast_cli_generatornummatches(a->argv[2], a->argv[3]);
1181
1182         ast_cli(a->fd, "%d", matches);
1183
1184         return CLI_SUCCESS;
1185 }
1186
1187 static char *handle_commandcomplete(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1188 {
1189         char *buf;
1190         switch (cmd) {
1191         case CLI_INIT:
1192                 e->command = "_command complete";
1193                 e->usage = 
1194                         "Usage: _command complete \"<line>\" text state\n"
1195                         "       This function is used internally to help with command completion and should.\n"
1196                         "       never be called by the user directly.\n";
1197                 return NULL;
1198         case CLI_GENERATE:
1199                 return NULL;
1200         }
1201         if (a->argc != 5)
1202                 return CLI_SHOWUSAGE;
1203         buf = __ast_cli_generator(a->argv[2], a->argv[3], atoi(a->argv[4]), 0);
1204         if (buf) {
1205                 ast_cli(a->fd, "%s", buf);
1206                 ast_free(buf);
1207         } else
1208                 ast_cli(a->fd, "NULL\n");
1209         return CLI_SUCCESS;
1210 }
1211
1212 struct channel_set_debug_args {
1213         int fd;
1214         int is_off;
1215 };
1216
1217 static int channel_set_debug(void *obj, void *arg, void *data, int flags)
1218 {
1219         struct ast_channel *chan = obj;
1220         struct channel_set_debug_args *args = data;
1221
1222         ast_channel_lock(chan);
1223
1224         if (!(chan->fin & DEBUGCHAN_FLAG) || !(chan->fout & DEBUGCHAN_FLAG)) {
1225                 if (args->is_off) {
1226                         chan->fin &= ~DEBUGCHAN_FLAG;
1227                         chan->fout &= ~DEBUGCHAN_FLAG;
1228                 } else {
1229                         chan->fin |= DEBUGCHAN_FLAG;
1230                         chan->fout |= DEBUGCHAN_FLAG;
1231                 }
1232                 ast_cli(args->fd, "Debugging %s on channel %s\n", args->is_off ? "disabled" : "enabled",
1233                                 chan->name);
1234         }
1235
1236         ast_channel_unlock(chan);
1237
1238         return 0;
1239 }
1240
1241 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1242 {
1243         struct ast_channel *c = NULL;
1244         struct channel_set_debug_args args = {
1245                 .fd = a->fd,
1246         };
1247
1248         switch (cmd) {
1249         case CLI_INIT:
1250                 e->command = "core set debug channel";
1251                 e->usage =
1252                         "Usage: core set debug channel <all|channel> [off]\n"
1253                         "       Enables/disables debugging on all or on a specific channel.\n";
1254                 return NULL;
1255         case CLI_GENERATE:
1256                 /* XXX remember to handle the optional "off" */
1257                 if (a->pos != e->args)
1258                         return NULL;
1259                 return a->n == 0 ? ast_strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
1260         }
1261
1262         if (cmd == (CLI_HANDLER + 1000)) {
1263                 /* called from handle_nodebugchan_deprecated */
1264                 args.is_off = 1;
1265         } else if (a->argc == e->args + 2) {
1266                 /* 'core set debug channel {all|chan_id}' */
1267                 if (!strcasecmp(a->argv[e->args + 1], "off"))
1268                         args.is_off = 1;
1269                 else
1270                         return CLI_SHOWUSAGE;
1271         } else if (a->argc != e->args + 1) {
1272                 return CLI_SHOWUSAGE;
1273         }
1274
1275         if (!strcasecmp("all", a->argv[e->args])) {
1276                 if (args.is_off) {
1277                         global_fin &= ~DEBUGCHAN_FLAG;
1278                         global_fout &= ~DEBUGCHAN_FLAG;
1279                 } else {
1280                         global_fin |= DEBUGCHAN_FLAG;
1281                         global_fout |= DEBUGCHAN_FLAG;
1282                 }
1283                 ast_channel_callback(channel_set_debug, NULL, &args, OBJ_NODATA | OBJ_MULTIPLE);
1284         } else {
1285                 if ((c = ast_channel_get_by_name(a->argv[e->args]))) {
1286                         channel_set_debug(c, NULL, &args, 0);
1287                         ast_channel_unref(c);
1288                 } else {
1289                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
1290                 }
1291         }
1292
1293         ast_cli(a->fd, "Debugging on new channels is %s\n", args.is_off ? "disabled" : "enabled");
1294
1295         return CLI_SUCCESS;
1296 }
1297
1298 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1299 {
1300         char *res;
1301
1302         switch (cmd) {
1303         case CLI_INIT:
1304                 e->command = "no debug channel";
1305                 return NULL;
1306         case CLI_HANDLER:
1307                 /* exit out of switch statement */
1308                 break;
1309         default:
1310                 return NULL;
1311         }
1312
1313         if (a->argc != e->args + 1)
1314                 return CLI_SHOWUSAGE;
1315
1316         /* add a 'magic' value to the CLI_HANDLER command so that
1317          * handle_core_set_debug_channel() will act as if 'off'
1318          * had been specified as part of the command
1319          */
1320         res = handle_core_set_debug_channel(e, CLI_HANDLER + 1000, a);
1321
1322         return res;
1323 }
1324                 
1325 static char *handle_showchan(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1326 {
1327         struct ast_channel *c=NULL;
1328         struct timeval now;
1329         struct ast_str *out = ast_str_thread_get(&ast_str_thread_global_buf, 16);
1330         char cdrtime[256];
1331         char nf[256], wf[256], rf[256];
1332         long elapsed_seconds=0;
1333         int hour=0, min=0, sec=0;
1334 #ifdef CHANNEL_TRACE
1335         int trace_enabled;
1336 #endif
1337
1338         switch (cmd) {
1339         case CLI_INIT:
1340                 e->command = "core show channel";
1341                 e->usage = 
1342                         "Usage: core show channel <channel>\n"
1343                         "       Shows lots of information about the specified channel.\n";
1344                 return NULL;
1345         case CLI_GENERATE:
1346                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
1347         }
1348         
1349         if (a->argc != 4) {
1350                 return CLI_SHOWUSAGE;
1351         }
1352
1353         now = ast_tvnow();
1354
1355         if (!(c = ast_channel_get_by_name(a->argv[3]))) {
1356                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1357                 return CLI_SUCCESS;
1358         }
1359
1360         ast_channel_lock(c);
1361
1362         if (c->cdr) {
1363                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
1364                 hour = elapsed_seconds / 3600;
1365                 min = (elapsed_seconds % 3600) / 60;
1366                 sec = elapsed_seconds % 60;
1367                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
1368         } else {
1369                 strcpy(cdrtime, "N/A");
1370         }
1371
1372         ast_cli(a->fd, 
1373                 " -- General --\n"
1374                 "           Name: %s\n"
1375                 "           Type: %s\n"
1376                 "       UniqueID: %s\n"
1377                 "       LinkedID: %s\n"
1378                 "      Caller ID: %s\n"
1379                 " Caller ID Name: %s\n"
1380                 "    DNID Digits: %s\n"
1381                 "       Language: %s\n"
1382                 "          State: %s (%d)\n"
1383                 "          Rings: %d\n"
1384                 "  NativeFormats: %s\n"
1385                 "    WriteFormat: %s\n"
1386                 "     ReadFormat: %s\n"
1387                 " WriteTranscode: %s\n"
1388                 "  ReadTranscode: %s\n"
1389                 "1st File Descriptor: %d\n"
1390                 "      Frames in: %d%s\n"
1391                 "     Frames out: %d%s\n"
1392                 " Time to Hangup: %ld\n"
1393                 "   Elapsed Time: %s\n"
1394                 "  Direct Bridge: %s\n"
1395                 "Indirect Bridge: %s\n"
1396                 " --   PBX   --\n"
1397                 "        Context: %s\n"
1398                 "      Extension: %s\n"
1399                 "       Priority: %d\n"
1400                 "     Call Group: %llu\n"
1401                 "   Pickup Group: %llu\n"
1402                 "    Application: %s\n"
1403                 "           Data: %s\n"
1404                 "    Blocking in: %s\n",
1405                 c->name, c->tech->type, c->uniqueid, c->linkedid,
1406                 S_OR(c->cid.cid_num, "(N/A)"),
1407                 S_OR(c->cid.cid_name, "(N/A)"),
1408                 S_OR(c->cid.cid_dnid, "(N/A)"), 
1409                 c->language,    
1410                 ast_state2str(c->_state), c->_state, c->rings, 
1411                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
1412                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
1413                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
1414                 c->writetrans ? "Yes" : "No",
1415                 c->readtrans ? "Yes" : "No",
1416                 c->fds[0],
1417                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1418                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
1419                 (long)c->whentohangup.tv_sec,
1420                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
1421                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
1422                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
1423                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
1424         
1425         if (pbx_builtin_serialize_variables(c, &out)) {
1426                 ast_cli(a->fd,"      Variables:\n%s\n", ast_str_buffer(out));
1427         }
1428
1429         if (c->cdr && ast_cdr_serialize_variables(c->cdr, &out, '=', '\n', 1)) {
1430                 ast_cli(a->fd,"  CDR Variables:\n%s\n", ast_str_buffer(out));
1431         }
1432
1433 #ifdef CHANNEL_TRACE
1434         trace_enabled = ast_channel_trace_is_enabled(c);
1435         ast_cli(a->fd, "  Context Trace: %s\n", trace_enabled ? "Enabled" : "Disabled");
1436         if (trace_enabled && ast_channel_trace_serialize(c, &out))
1437                 ast_cli(a->fd, "          Trace:\n%s\n", ast_str_buffer(out));
1438 #endif
1439
1440         ast_channel_unlock(c);
1441         c = ast_channel_unref(c);
1442
1443         return CLI_SUCCESS;
1444 }
1445
1446 /*
1447  * helper function to generate CLI matches from a fixed set of values.
1448  * A NULL word is acceptable.
1449  */
1450 char *ast_cli_complete(const char *word, const char * const choices[], int state)
1451 {
1452         int i, which = 0, len;
1453         len = ast_strlen_zero(word) ? 0 : strlen(word);
1454
1455         for (i = 0; choices[i]; i++) {
1456                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
1457                         return ast_strdup(choices[i]);
1458         }
1459         return NULL;
1460 }
1461
1462 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
1463 {
1464         struct ast_channel *c = NULL;
1465         int which = 0;
1466         char notfound = '\0';
1467         char *ret = &notfound; /* so NULL can break the loop */
1468         struct ast_channel_iterator *iter;
1469
1470         if (pos != rpos) {
1471                 return NULL;
1472         }
1473
1474         if (!(iter = ast_channel_iterator_by_name_new(word, strlen(word)))) {
1475                 return NULL;
1476         }
1477
1478         while (ret == &notfound && (c = ast_channel_iterator_next(iter))) {
1479                 if (++which > state) {
1480                         ast_channel_lock(c);
1481                         ret = ast_strdup(c->name);
1482                         ast_channel_unlock(c);
1483                 }
1484                 ast_channel_unref(c);
1485         }
1486
1487         ast_channel_iterator_destroy(iter);
1488
1489         return ret == &notfound ? NULL : ret;
1490 }
1491
1492 static char *group_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1493 {
1494 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1495
1496         struct ast_group_info *gi = NULL;
1497         int numchans = 0;
1498         regex_t regexbuf;
1499         int havepattern = 0;
1500
1501         switch (cmd) {
1502         case CLI_INIT:
1503                 e->command = "group show channels";
1504                 e->usage = 
1505                         "Usage: group show channels [pattern]\n"
1506                         "       Lists all currently active channels with channel group(s) specified.\n"
1507                         "       Optional regular expression pattern is matched to group names for each\n"
1508                         "       channel.\n";
1509                 return NULL;
1510         case CLI_GENERATE:
1511                 return NULL;
1512         }
1513
1514         if (a->argc < 3 || a->argc > 4)
1515                 return CLI_SHOWUSAGE;
1516         
1517         if (a->argc == 4) {
1518                 if (regcomp(&regexbuf, a->argv[3], REG_EXTENDED | REG_NOSUB))
1519                         return CLI_SHOWUSAGE;
1520                 havepattern = 1;
1521         }
1522
1523         ast_cli(a->fd, FORMAT_STRING, "Channel", "Group", "Category");
1524
1525         ast_app_group_list_rdlock();
1526         
1527         gi = ast_app_group_list_head();
1528         while (gi) {
1529                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1530                         ast_cli(a->fd, FORMAT_STRING, gi->chan->name, gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1531                         numchans++;
1532                 }
1533                 gi = AST_LIST_NEXT(gi, group_list);
1534         }
1535         
1536         ast_app_group_list_unlock();
1537         
1538         if (havepattern)
1539                 regfree(&regexbuf);
1540
1541         ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1542         return CLI_SUCCESS;
1543 #undef FORMAT_STRING
1544 }
1545
1546 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1547
1548 static struct ast_cli_entry cli_cli[] = {
1549         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1550         AST_CLI_DEFINE(handle_commandcomplete, "Command complete"),
1551         AST_CLI_DEFINE(handle_commandnummatches, "Returns number of command matches"),
1552         AST_CLI_DEFINE(handle_commandmatchesarray, "Returns command matches array"),
1553
1554         AST_CLI_DEFINE(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1555
1556         AST_CLI_DEFINE(handle_chanlist, "Display information on channels"),
1557
1558         AST_CLI_DEFINE(handle_showcalls, "Display information on calls"),
1559
1560         AST_CLI_DEFINE(handle_showchan, "Display information on a specific channel"),
1561
1562         AST_CLI_DEFINE(handle_core_set_debug_channel, "Enable/disable debugging on a channel"),
1563
1564         AST_CLI_DEFINE(handle_verbose, "Set level of debug/verbose chattiness"),
1565
1566         AST_CLI_DEFINE(group_show_channels, "Display active channels with group(s)"),
1567
1568         AST_CLI_DEFINE(handle_help, "Display help list, or specific help on a command"),
1569
1570         AST_CLI_DEFINE(handle_logger_mute, "Toggle logging output to a console"),
1571
1572         AST_CLI_DEFINE(handle_modlist, "List modules and info"),
1573
1574         AST_CLI_DEFINE(handle_load, "Load a module by name"),
1575
1576         AST_CLI_DEFINE(handle_reload, "Reload configuration"),
1577
1578         AST_CLI_DEFINE(handle_unload, "Unload a module by name"),
1579
1580         AST_CLI_DEFINE(handle_showuptime, "Show uptime information"),
1581
1582         AST_CLI_DEFINE(handle_softhangup, "Request a hangup on a given channel"),
1583
1584         AST_CLI_DEFINE(handle_cli_reload_permissions, "Reload CLI permissions config"),
1585
1586         AST_CLI_DEFINE(handle_cli_show_permissions, "Show CLI permissions"),
1587
1588         AST_CLI_DEFINE(handle_cli_check_permissions, "Try a permissions config for a user"),
1589 };
1590
1591 /*!
1592  * Some regexp characters in cli arguments are reserved and used as separators.
1593  */
1594 static const char cli_rsvd[] = "[]{}|*%";
1595
1596 /*!
1597  * initialize the _full_cmd string and related parameters,
1598  * return 0 on success, -1 on error.
1599  */
1600 static int set_full_cmd(struct ast_cli_entry *e)
1601 {
1602         int i;
1603         char buf[80];
1604
1605         ast_join(buf, sizeof(buf), e->cmda);
1606         e->_full_cmd = ast_strdup(buf);
1607         if (!e->_full_cmd) {
1608                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1609                 return -1;
1610         }
1611         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1612         for (i = 0; e->cmda[i]; i++)
1613                 ;
1614         e->args = i;
1615         return 0;
1616 }
1617
1618 /*! \brief cleanup (free) cli_perms linkedlist. */
1619 static void destroy_user_perms(void)
1620 {
1621         struct cli_perm *perm;
1622         struct usergroup_cli_perm *user_perm;
1623
1624         AST_RWLIST_WRLOCK(&cli_perms);
1625         while ((user_perm = AST_LIST_REMOVE_HEAD(&cli_perms, list))) {
1626                 while ((perm = AST_LIST_REMOVE_HEAD(user_perm->perms, list))) {
1627                         ast_free(perm->command);
1628                         ast_free(perm);
1629                 }
1630                 ast_free(user_perm);
1631         }
1632         AST_RWLIST_UNLOCK(&cli_perms);
1633 }
1634
1635 int ast_cli_perms_init(int reload)
1636 {
1637         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1638         struct ast_config *cfg;
1639         char *cat = NULL;
1640         struct ast_variable *v;
1641         struct usergroup_cli_perm *user_group, *cp_entry;
1642         struct cli_perm *perm = NULL;
1643         struct passwd *pw;
1644         struct group *gr;
1645
1646         if (ast_mutex_trylock(&permsconfiglock)) {
1647                 ast_log(LOG_NOTICE, "You must wait until last 'cli reload permissions' command finish\n");
1648                 return 1;
1649         }
1650
1651         cfg = ast_config_load2(perms_config, "" /* core, can't reload */, config_flags);
1652         if (!cfg) {
1653                 ast_mutex_unlock(&permsconfiglock);
1654                 return 1;
1655         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
1656                 ast_mutex_unlock(&permsconfiglock);
1657                 return 0;
1658         }
1659
1660         /* free current structures. */
1661         destroy_user_perms();
1662
1663         while ((cat = ast_category_browse(cfg, cat))) {
1664                 if (!strcasecmp(cat, "general")) {
1665                         /* General options */
1666                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1667                                 if (!strcasecmp(v->name, "default_perm")) {
1668                                         cli_default_perm = (!strcasecmp(v->value, "permit")) ? 1: 0;
1669                                 }
1670                         }
1671                         continue;
1672                 }
1673
1674                 /* users or groups */
1675                 gr = NULL, pw = NULL;
1676                 if (cat[0] == '@') {
1677                         /* This is a group */
1678                         gr = getgrnam(&cat[1]);
1679                         if (!gr) {
1680                                 ast_log (LOG_WARNING, "Unknown group '%s'\n", &cat[1]);
1681                                 continue;
1682                         }
1683                 } else {
1684                         /* This is a user */
1685                         pw = getpwnam(cat);
1686                         if (!pw) {
1687                                 ast_log (LOG_WARNING, "Unknown user '%s'\n", cat);
1688                                 continue;
1689                         }
1690                 }
1691                 user_group = NULL;
1692                 /* Check for duplicates */
1693                 AST_RWLIST_WRLOCK(&cli_perms);
1694                 AST_LIST_TRAVERSE(&cli_perms, cp_entry, list) {
1695                         if ((pw && cp_entry->uid == pw->pw_uid) || (gr && cp_entry->gid == gr->gr_gid)) {
1696                                 /* if it is duplicated, just added this new settings, to 
1697                                 the current list. */
1698                                 user_group = cp_entry;
1699                                 break;
1700                         }
1701                 }
1702                 AST_RWLIST_UNLOCK(&cli_perms);
1703
1704                 if (!user_group) {
1705                         /* alloc space for the new user config. */
1706                         user_group = ast_calloc(1, sizeof(*user_group));
1707                         if (!user_group) {
1708                                 continue;
1709                         }
1710                         user_group->uid = (pw ? pw->pw_uid : -1);
1711                         user_group->gid = (gr ? gr->gr_gid : -1);
1712                         user_group->perms = ast_calloc(1, sizeof(*user_group->perms));
1713                         if (!user_group->perms) {
1714                                 ast_free(user_group);
1715                                 continue;
1716                         }
1717                 }
1718                 for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
1719                         if (ast_strlen_zero(v->value)) {
1720                                 /* we need to check this condition cause it could break security. */
1721                                 ast_log(LOG_WARNING, "Empty permit/deny option in user '%s'\n", cat);
1722                                 continue;
1723                         }
1724                         if (!strcasecmp(v->name, "permit")) {
1725                                 perm = ast_calloc(1, sizeof(*perm));
1726                                 if (perm) {
1727                                         perm->permit = 1;
1728                                         perm->command = ast_strdup(v->value);
1729                                 }
1730                         } else if (!strcasecmp(v->name, "deny")) {
1731                                 perm = ast_calloc(1, sizeof(*perm));
1732                                 if (perm) {
1733                                         perm->permit = 0;
1734                                         perm->command = ast_strdup(v->value);
1735                                 }
1736                         } else {
1737                                 /* up to now, only 'permit' and 'deny' are possible values. */
1738                                 ast_log(LOG_WARNING, "Unknown '%s' option\n", v->name);
1739                                 continue;
1740                         }
1741                         if (perm) {
1742                                 /* Added the permission to the user's list. */
1743                                 AST_LIST_INSERT_TAIL(user_group->perms, perm, list);
1744                                 perm = NULL;
1745                         }
1746                 }
1747                 AST_RWLIST_WRLOCK(&cli_perms);
1748                 AST_RWLIST_INSERT_TAIL(&cli_perms, user_group, list);
1749                 AST_RWLIST_UNLOCK(&cli_perms);
1750         }
1751
1752         ast_config_destroy(cfg);
1753         ast_mutex_unlock(&permsconfiglock);
1754         return 0;
1755 }
1756
1757 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1758 void ast_builtins_init(void)
1759 {
1760         ast_cli_register_multiple(cli_cli, ARRAY_LEN(cli_cli));
1761 }
1762
1763 /*!
1764  * match a word in the CLI entry.
1765  * returns -1 on mismatch, 0 on match of an optional word,
1766  * 1 on match of a full word.
1767  *
1768  * The pattern can be
1769  *   any_word           match for equal
1770  *   [foo|bar|baz]      optionally, one of these words
1771  *   {foo|bar|baz}      exactly, one of these words
1772  *   %                  any word
1773  */
1774 static int word_match(const char *cmd, const char *cli_word)
1775 {
1776         int l;
1777         char *pos;
1778
1779         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1780                 return -1;
1781         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1782                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1783         /* regexp match, takes [foo|bar] or {foo|bar} */
1784         l = strlen(cmd);
1785         /* wildcard match - will extend in the future */
1786         if (l > 0 && cli_word[0] == '%') {
1787                 return 1;       /* wildcard */
1788         }
1789         pos = strcasestr(cli_word, cmd);
1790         if (pos == NULL) /* not found, say ok if optional */
1791                 return cli_word[0] == '[' ? 0 : -1;
1792         if (pos == cli_word)    /* no valid match at the beginning */
1793                 return -1;
1794         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1795                 return 1;       /* valid match */
1796         return -1;      /* not found */
1797 }
1798
1799 /*! \brief if word is a valid prefix for token, returns the pos-th
1800  * match as a malloced string, or NULL otherwise.
1801  * Always tell in *actual how many matches we got.
1802  */
1803 static char *is_prefix(const char *word, const char *token,
1804         int pos, int *actual)
1805 {
1806         int lw;
1807         char *s, *t1;
1808
1809         *actual = 0;
1810         if (ast_strlen_zero(token))
1811                 return NULL;
1812         if (ast_strlen_zero(word))
1813                 word = "";      /* dummy */
1814         lw = strlen(word);
1815         if (strcspn(word, cli_rsvd) != lw)
1816                 return NULL;    /* no match if word has reserved chars */
1817         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1818                 if (strncasecmp(token, word, lw))       /* no match */
1819                         return NULL;
1820                 *actual = 1;
1821                 return (pos != 0) ? NULL : ast_strdup(token);
1822         }
1823         /* now handle regexp match */
1824
1825         /* Wildcard always matches, so we never do is_prefix on them */
1826
1827         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1828         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1829                 if (*s == '%')  /* wildcard */
1830                         continue;
1831                 if (strncasecmp(s, word, lw))   /* no match */
1832                         continue;
1833                 (*actual)++;
1834                 if (pos-- == 0)
1835                         return ast_strdup(s);
1836         }
1837         return NULL;
1838 }
1839
1840 /*!
1841  * \internal
1842  * \brief locate a cli command in the 'helpers' list (which must be locked).
1843  *     The search compares word by word taking care of regexps in e->cmda
1844  *     This function will return NULL when nothing is matched, or the ast_cli_entry that matched.
1845  * \param cmds
1846  * \param match_type has 3 possible values:
1847  *      0       returns if the search key is equal or longer than the entry.
1848  *                          note that trailing optional arguments are skipped.
1849  *      -1      true if the mismatch is on the last word XXX not true!
1850  *      1       true only on complete, exact match.
1851  *
1852  */
1853 static struct ast_cli_entry *find_cli(const char * const cmds[], int match_type)
1854 {
1855         int matchlen = -1;      /* length of longest match so far */
1856         struct ast_cli_entry *cand = NULL, *e=NULL;
1857
1858         while ( (e = cli_next(e)) ) {
1859                 /* word-by word regexp comparison */
1860                 const char * const *src = cmds;
1861                 const char * const *dst = e->cmda;
1862                 int n = 0;
1863                 for (;; dst++, src += n) {
1864                         n = word_match(*src, *dst);
1865                         if (n < 0)
1866                                 break;
1867                 }
1868                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1869                         /* no more words in 'e' */
1870                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1871                                 break;
1872                         /* Here, cmds has more words than the entry 'e' */
1873                         if (match_type != 0)    /* but we look for almost exact match... */
1874                                 continue;       /* so we skip this one. */
1875                         /* otherwise we like it (case 0) */
1876                 } else {        /* still words in 'e' */
1877                         if (ast_strlen_zero(*src))
1878                                 continue; /* cmds is shorter than 'e', not good */
1879                         /* Here we have leftover words in cmds and 'e',
1880                          * but there is a mismatch. We only accept this one if match_type == -1
1881                          * and this is the last word for both.
1882                          */
1883                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1884                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1885                                 continue;
1886                         /* good, we are in case match_type == -1 and mismatch on last word */
1887                 }
1888                 if (src - cmds > matchlen) {    /* remember the candidate */
1889                         matchlen = src - cmds;
1890                         cand = e;
1891                 }
1892         }
1893
1894         return e ? e : cand;
1895 }
1896
1897 static char *find_best(const char *argv[])
1898 {
1899         static char cmdline[80];
1900         int x;
1901         /* See how close we get, then print the candidate */
1902         const char *myargv[AST_MAX_CMD_LEN] = { NULL, };
1903
1904         AST_RWLIST_RDLOCK(&helpers);
1905         for (x = 0; argv[x]; x++) {
1906                 myargv[x] = argv[x];
1907                 if (!find_cli(myargv, -1))
1908                         break;
1909         }
1910         AST_RWLIST_UNLOCK(&helpers);
1911         ast_join(cmdline, sizeof(cmdline), myargv);
1912         return cmdline;
1913 }
1914
1915 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1916 {
1917         if (e->inuse) {
1918                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1919         } else {
1920                 AST_RWLIST_WRLOCK(&helpers);
1921                 AST_RWLIST_REMOVE(&helpers, e, list);
1922                 AST_RWLIST_UNLOCK(&helpers);
1923                 ast_free(e->_full_cmd);
1924                 e->_full_cmd = NULL;
1925                 if (e->handler) {
1926                         /* this is a new-style entry. Reset fields and free memory. */
1927                         char *cmda = (char *) e->cmda;
1928                         memset(cmda, '\0', sizeof(e->cmda));
1929                         ast_free(e->command);
1930                         e->command = NULL;
1931                         e->usage = NULL;
1932                 }
1933         }
1934         return 0;
1935 }
1936
1937 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1938 {
1939         struct ast_cli_entry *cur;
1940         int i, lf, ret = -1;
1941
1942         struct ast_cli_args a;  /* fake argument */
1943         char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
1944         char *s;
1945
1946         memset(&a, '\0', sizeof(a));
1947         e->handler(e, CLI_INIT, &a);
1948         /* XXX check that usage and command are filled up */
1949         s = ast_skip_blanks(e->command);
1950         s = e->command = ast_strdup(s);
1951         for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
1952                 *dst++ = s;     /* store string */
1953                 s = ast_skip_nonblanks(s);
1954                 if (*s == '\0') /* we are done */
1955                         break;
1956                 *s++ = '\0';
1957                 s = ast_skip_blanks(s);
1958         }
1959         *dst++ = NULL;
1960         
1961         AST_RWLIST_WRLOCK(&helpers);
1962         
1963         if (find_cli(e->cmda, 1)) {
1964                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", S_OR(e->_full_cmd, e->command));
1965                 goto done;
1966         }
1967         if (set_full_cmd(e))
1968                 goto done;
1969
1970         lf = e->cmdlen;
1971         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1972                 int len = cur->cmdlen;
1973                 if (lf < len)
1974                         len = lf;
1975                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
1976                         AST_RWLIST_INSERT_BEFORE_CURRENT(e, list); 
1977                         break;
1978                 }
1979         }
1980         AST_RWLIST_TRAVERSE_SAFE_END;
1981
1982         if (!cur)
1983                 AST_RWLIST_INSERT_TAIL(&helpers, e, list); 
1984         ret = 0;        /* success */
1985
1986 done:
1987         AST_RWLIST_UNLOCK(&helpers);
1988
1989         return ret;
1990 }
1991
1992 /* wrapper function, so we can unregister deprecated commands recursively */
1993 int ast_cli_unregister(struct ast_cli_entry *e)
1994 {
1995         return __ast_cli_unregister(e, NULL);
1996 }
1997
1998 /* wrapper function, so we can register deprecated commands recursively */
1999 int ast_cli_register(struct ast_cli_entry *e)
2000 {
2001         return __ast_cli_register(e, NULL);
2002 }
2003
2004 /*
2005  * register/unregister an array of entries.
2006  */
2007 int ast_cli_register_multiple(struct ast_cli_entry *e, int len)
2008 {
2009         int i, res = 0;
2010
2011         for (i = 0; i < len; i++)
2012                 res |= ast_cli_register(e + i);
2013
2014         return res;
2015 }
2016
2017 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
2018 {
2019         int i, res = 0;
2020
2021         for (i = 0; i < len; i++)
2022                 res |= ast_cli_unregister(e + i);
2023
2024         return res;
2025 }
2026
2027
2028 /*! \brief helper for final part of handle_help
2029  *  if locked = 1, assume the list is already locked
2030  */
2031 static char *help1(int fd, const char * const match[], int locked)
2032 {
2033         char matchstr[80] = "";
2034         struct ast_cli_entry *e = NULL;
2035         int len = 0;
2036         int found = 0;
2037
2038         if (match) {
2039                 ast_join(matchstr, sizeof(matchstr), match);
2040                 len = strlen(matchstr);
2041         }
2042         if (!locked)
2043                 AST_RWLIST_RDLOCK(&helpers);
2044         while ( (e = cli_next(e)) ) {
2045                 /* Hide commands that start with '_' */
2046                 if (e->_full_cmd[0] == '_')
2047                         continue;
2048                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
2049                         continue;
2050                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
2051                 found++;
2052         }
2053         if (!locked)
2054                 AST_RWLIST_UNLOCK(&helpers);
2055         if (!found && matchstr[0])
2056                 ast_cli(fd, "No such command '%s'.\n", matchstr);
2057         return CLI_SUCCESS;
2058 }
2059
2060 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2061 {
2062         char fullcmd[80];
2063         struct ast_cli_entry *my_e;
2064         char *res = CLI_SUCCESS;
2065
2066         if (cmd == CLI_INIT) {
2067                 e->command = "core show help";
2068                 e->usage =
2069                         "Usage: core show help [topic]\n"
2070                         "       When called with a topic as an argument, displays usage\n"
2071                         "       information on the given command. If called without a\n"
2072                         "       topic, it provides a list of commands.\n";
2073                 return NULL;
2074
2075         } else if (cmd == CLI_GENERATE) {
2076                 /* skip first 14 or 15 chars, "core show help " */
2077                 int l = strlen(a->line);
2078
2079                 if (l > 15) {
2080                         l = 15;
2081                 }
2082                 /* XXX watch out, should stop to the non-generator parts */
2083                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
2084         }
2085         if (a->argc == e->args) {
2086                 return help1(a->fd, NULL, 0);
2087         }
2088
2089         AST_RWLIST_RDLOCK(&helpers);
2090         my_e = find_cli(a->argv + 3, 1);        /* try exact match first */
2091         if (!my_e) {
2092                 res = help1(a->fd, a->argv + 3, 1 /* locked */);
2093                 AST_RWLIST_UNLOCK(&helpers);
2094                 return res;
2095         }
2096         if (my_e->usage)
2097                 ast_cli(a->fd, "%s", my_e->usage);
2098         else {
2099                 ast_join(fullcmd, sizeof(fullcmd), a->argv + 3);
2100                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
2101         }
2102         AST_RWLIST_UNLOCK(&helpers);
2103         return res;
2104 }
2105
2106 static char *parse_args(const char *s, int *argc, const char *argv[], int max, int *trailingwhitespace)
2107 {
2108         char *duplicate, *cur;
2109         int x = 0;
2110         int quoted = 0;
2111         int escaped = 0;
2112         int whitespace = 1;
2113         int dummy = 0;
2114
2115         if (trailingwhitespace == NULL)
2116                 trailingwhitespace = &dummy;
2117         *trailingwhitespace = 0;
2118         if (s == NULL)  /* invalid, though! */
2119                 return NULL;
2120         /* make a copy to store the parsed string */
2121         if (!(duplicate = ast_strdup(s)))
2122                 return NULL;
2123
2124         cur = duplicate;
2125         /* scan the original string copying into cur when needed */
2126         for (; *s ; s++) {
2127                 if (x >= max - 1) {
2128                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
2129                         break;
2130                 }
2131                 if (*s == '"' && !escaped) {
2132                         quoted = !quoted;
2133                         if (quoted && whitespace) {
2134                                 /* start a quoted string from previous whitespace: new argument */
2135                                 argv[x++] = cur;
2136                                 whitespace = 0;
2137                         }
2138                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
2139                         /* If we are not already in whitespace, and not in a quoted string or
2140                            processing an escape sequence, and just entered whitespace, then
2141                            finalize the previous argument and remember that we are in whitespace
2142                         */
2143                         if (!whitespace) {
2144                                 *cur++ = '\0';
2145                                 whitespace = 1;
2146                         }
2147                 } else if (*s == '\\' && !escaped) {
2148                         escaped = 1;
2149                 } else {
2150                         if (whitespace) {
2151                                 /* we leave whitespace, and are not quoted. So it's a new argument */
2152                                 argv[x++] = cur;
2153                                 whitespace = 0;
2154                         }
2155                         *cur++ = *s;
2156                         escaped = 0;
2157                 }
2158         }
2159         /* Null terminate */
2160         *cur++ = '\0';
2161         /* XXX put a NULL in the last argument, because some functions that take
2162          * the array may want a null-terminated array.
2163          * argc still reflects the number of non-NULL entries.
2164          */
2165         argv[x] = NULL;
2166         *argc = x;
2167         *trailingwhitespace = whitespace;
2168         return duplicate;
2169 }
2170
2171 /*! \brief Return the number of unique matches for the generator */
2172 int ast_cli_generatornummatches(const char *text, const char *word)
2173 {
2174         int matches = 0, i = 0;
2175         char *buf = NULL, *oldbuf = NULL;
2176
2177         while ((buf = ast_cli_generator(text, word, i++))) {
2178                 if (!oldbuf || strcmp(buf,oldbuf))
2179                         matches++;
2180                 if (oldbuf)
2181                         ast_free(oldbuf);
2182                 oldbuf = buf;
2183         }
2184         if (oldbuf)
2185                 ast_free(oldbuf);
2186         return matches;
2187 }
2188
2189 char **ast_cli_completion_matches(const char *text, const char *word)
2190 {
2191         char **match_list = NULL, *retstr, *prevstr;
2192         size_t match_list_len, max_equal, which, i;
2193         int matches = 0;
2194
2195         /* leave entry 0 free for the longest common substring */
2196         match_list_len = 1;
2197         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
2198                 if (matches + 1 >= match_list_len) {
2199                         match_list_len <<= 1;
2200                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
2201                                 return NULL;
2202                 }
2203                 match_list[++matches] = retstr;
2204         }
2205
2206         if (!match_list)
2207                 return match_list; /* NULL */
2208
2209         /* Find the longest substring that is common to all results
2210          * (it is a candidate for completion), and store a copy in entry 0.
2211          */
2212         prevstr = match_list[1];
2213         max_equal = strlen(prevstr);
2214         for (which = 2; which <= matches; which++) {
2215                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
2216                         continue;
2217                 max_equal = i;
2218         }
2219
2220         if (!(retstr = ast_malloc(max_equal + 1)))
2221                 return NULL;
2222         
2223         ast_copy_string(retstr, match_list[1], max_equal + 1);
2224         match_list[0] = retstr;
2225
2226         /* ensure that the array is NULL terminated */
2227         if (matches + 1 >= match_list_len) {
2228                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
2229                         return NULL;
2230         }
2231         match_list[matches + 1] = NULL;
2232
2233         return match_list;
2234 }
2235
2236 /*! \brief returns true if there are more words to match */
2237 static int more_words (const char * const *dst)
2238 {
2239         int i;
2240         for (i = 0; dst[i]; i++) {
2241                 if (dst[i][0] != '[')
2242                         return -1;
2243         }
2244         return 0;
2245 }
2246         
2247 /*
2248  * generate the entry at position 'state'
2249  */
2250 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
2251 {
2252         const char *argv[AST_MAX_ARGS];
2253         struct ast_cli_entry *e = NULL;
2254         int x = 0, argindex, matchlen;
2255         int matchnum=0;
2256         char *ret = NULL;
2257         char matchstr[80] = "";
2258         int tws = 0;
2259         /* Split the argument into an array of words */
2260         char *duplicate = parse_args(text, &x, argv, ARRAY_LEN(argv), &tws);
2261
2262         if (!duplicate) /* malloc error */
2263                 return NULL;
2264
2265         /* Compute the index of the last argument (could be an empty string) */
2266         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
2267
2268         /* rebuild the command, ignore terminating white space and flatten space */
2269         ast_join(matchstr, sizeof(matchstr)-1, argv);
2270         matchlen = strlen(matchstr);
2271         if (tws) {
2272                 strcat(matchstr, " "); /* XXX */
2273                 if (matchlen)
2274                         matchlen++;
2275         }
2276         if (lock)
2277                 AST_RWLIST_RDLOCK(&helpers);
2278         while ( (e = cli_next(e)) ) {
2279                 /* XXX repeated code */
2280                 int src = 0, dst = 0, n = 0;
2281
2282                 if (e->command[0] == '_')
2283                         continue;
2284
2285                 /*
2286                  * Try to match words, up to and excluding the last word, which
2287                  * is either a blank or something that we want to extend.
2288                  */
2289                 for (;src < argindex; dst++, src += n) {
2290                         n = word_match(argv[src], e->cmda[dst]);
2291                         if (n < 0)
2292                                 break;
2293                 }
2294
2295                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
2296                         continue;
2297                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
2298                 matchnum += n;  /* this many matches here */
2299                 if (ret) {
2300                         /*
2301                          * argv[src] is a valid prefix of the next word in this
2302                          * command. If this is also the correct entry, return it.
2303                          */
2304                         if (matchnum > state)
2305                                 break;
2306                         ast_free(ret);
2307                         ret = NULL;
2308                 } else if (ast_strlen_zero(e->cmda[dst])) {
2309                         /*
2310                          * This entry is a prefix of the command string entered
2311                          * (only one entry in the list should have this property).
2312                          * Run the generator if one is available. In any case we are done.
2313                          */
2314                         if (e->handler) {       /* new style command */
2315                                 struct ast_cli_args a = {
2316                                         .line = matchstr, .word = word,
2317                                         .pos = argindex,
2318                                         .n = state - matchnum,
2319                                         .argv = argv,
2320                                         .argc = x};
2321                                 ret = e->handler(e, CLI_GENERATE, &a);
2322                         }
2323                         if (ret)
2324                                 break;
2325                 }
2326         }
2327         if (lock)
2328                 AST_RWLIST_UNLOCK(&helpers);
2329         ast_free(duplicate);
2330         return ret;
2331 }
2332
2333 char *ast_cli_generator(const char *text, const char *word, int state)
2334 {
2335         return __ast_cli_generator(text, word, state, 1);
2336 }
2337
2338 int ast_cli_command_full(int uid, int gid, int fd, const char *s)
2339 {
2340         const char *args[AST_MAX_ARGS + 1];
2341         struct ast_cli_entry *e;
2342         int x;
2343         char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
2344         char tmp[AST_MAX_ARGS + 1];
2345         char *retval = NULL;
2346         struct ast_cli_args a = {
2347                 .fd = fd, .argc = x, .argv = args+1 };
2348
2349         if (duplicate == NULL)
2350                 return -1;
2351
2352         if (x < 1)      /* We need at least one entry, otherwise ignore */
2353                 goto done;
2354
2355         AST_RWLIST_RDLOCK(&helpers);
2356         e = find_cli(args + 1, 0);
2357         if (e)
2358                 ast_atomic_fetchadd_int(&e->inuse, 1);
2359         AST_RWLIST_UNLOCK(&helpers);
2360         if (e == NULL) {
2361                 ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
2362                 goto done;
2363         }
2364
2365         ast_join(tmp, sizeof(tmp), args + 1);
2366         /* Check if the user has rights to run this command. */
2367         if (!cli_has_permissions(uid, gid, tmp)) {
2368                 ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
2369                 ast_free(duplicate);
2370                 return 0;
2371         }
2372
2373         /*
2374          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
2375          * Remember that the array returned by parse_args is NULL-terminated.
2376          */
2377         args[0] = (char *)e;
2378
2379         retval = e->handler(e, CLI_HANDLER, &a);
2380
2381         if (retval == CLI_SHOWUSAGE) {
2382                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
2383         } else {
2384                 if (retval == CLI_FAILURE)
2385                         ast_cli(fd, "Command '%s' failed.\n", s);
2386         }
2387         ast_atomic_fetchadd_int(&e->inuse, -1);
2388 done:
2389         ast_free(duplicate);
2390         return 0;
2391 }
2392
2393 int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
2394 {
2395         char cmd[512];
2396         int x, y = 0, count = 0;
2397
2398         for (x = 0; x < size; x++) {
2399                 cmd[y] = s[x];
2400                 y++;
2401                 if (s[x] == '\0') {
2402                         ast_cli_command_full(uid, gid, fd, cmd);
2403                         y = 0;
2404                         count++;
2405                 }
2406         }
2407         return count;
2408 }