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