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