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