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