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