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