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