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