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