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