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