(closes issue #10192)
[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 <unistd.h>
31 #include <stdlib.h>
32 #include <sys/signal.h>
33 #include <stdio.h>
34 #include <signal.h>
35 #include <string.h>
36 #include <ctype.h>
37 #include <regex.h>
38
39 #include "asterisk/logger.h"
40 #include "asterisk/options.h"
41 #include "asterisk/cli.h"
42 #include "asterisk/linkedlists.h"
43 #include "asterisk/module.h"
44 #include "asterisk/pbx.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/app.h"
48 #include "asterisk/lock.h"
49 #include "editline/readline/readline.h"
50 #include "asterisk/threadstorage.h"
51
52 /*!
53  * \brief map a debug or verbose value to a filename
54  */
55 struct ast_debug_file {
56         unsigned int level;
57         AST_RWLIST_ENTRY(ast_debug_file) entry;
58         char filename[0];
59 };
60
61 AST_RWLIST_HEAD(debug_file_list, ast_debug_file);
62
63 /*! list of filenames and their debug settings */
64 static struct debug_file_list debug_files;
65 /*! list of filenames and their verbose settings */
66 static struct debug_file_list verbose_files;
67
68 AST_THREADSTORAGE(ast_cli_buf);
69
70 /*! \brief Initial buffer size for resulting strings in ast_cli() */
71 #define AST_CLI_INITLEN   256
72
73 void ast_cli(int fd, const char *fmt, ...)
74 {
75         int res;
76         struct ast_str *buf;
77         va_list ap;
78
79         if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
80                 return;
81
82         va_start(ap, fmt);
83         res = ast_str_set_va(&buf, 0, fmt, ap);
84         va_end(ap);
85
86         if (res != AST_DYNSTR_BUILD_FAILED)
87                 ast_carefulwrite(fd, buf->str, strlen(buf->str), 100);
88 }
89
90 unsigned int ast_debug_get_by_file(const char *file) 
91 {
92         struct ast_debug_file *adf;
93         unsigned int res = 0;
94
95         AST_RWLIST_RDLOCK(&debug_files);
96         AST_LIST_TRAVERSE(&debug_files, adf, entry) {
97                 if (!strncasecmp(adf->filename, file, strlen(adf->filename))) {
98                         res = adf->level;
99                         break;
100                 }
101         }
102         AST_RWLIST_UNLOCK(&debug_files);
103
104         return res;
105 }
106
107 unsigned int ast_verbose_get_by_file(const char *file) 
108 {
109         struct ast_debug_file *adf;
110         unsigned int res = 0;
111
112         AST_RWLIST_RDLOCK(&verbose_files);
113         AST_LIST_TRAVERSE(&verbose_files, adf, entry) {
114                 if (!strncasecmp(adf->filename, file, strlen(file))) {
115                         res = adf->level;
116                         break;
117                 }
118         }
119         AST_RWLIST_UNLOCK(&verbose_files);
120
121         return res;
122 }
123
124 static AST_LIST_HEAD_STATIC(helpers, ast_cli_entry);
125
126 static const char logger_mute_help[] = 
127 "Usage: logger mute\n"
128 "       Disables logging output to the current console, making it possible to\n"
129 "       gather information without being disturbed by scrolling lines.\n";
130
131 static const char softhangup_help[] =
132 "Usage: soft hangup <channel>\n"
133 "       Request that a channel be hung up. The hangup takes effect\n"
134 "       the next time the driver reads or writes from the channel\n";
135
136 static const char group_show_channels_help[] = 
137 "Usage: group show channels [pattern]\n"
138 "       Lists all currently active channels with channel group(s) specified.\n"
139 "       Optional regular expression pattern is matched to group names for each\n"
140 "       channel.\n";
141
142 static char *complete_fn(const char *word, int state)
143 {
144         char *c;
145         char filename[256];
146
147         if (word[0] == '/')
148                 ast_copy_string(filename, word, sizeof(filename));
149         else
150                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
151
152         /* XXX the following function is not reentrant, so we better not use it */
153         c = filename_completion_function(filename, state);
154         
155         if (c && word[0] != '/')
156                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
157         
158         return c ? ast_strdup(c) : c;
159 }
160
161 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
162 {
163         /* "module load <mod>" */
164         switch (cmd) {
165         case CLI_INIT:
166                 e->command = "module load";
167                 e->usage =
168                         "Usage: module load <module name>\n"
169                         "       Loads the specified module into Asterisk.\n";
170                 return NULL;
171
172         case CLI_GENERATE:
173                 if (a->pos != e->args)
174                         return NULL;
175                 return complete_fn(a->word, a->n);
176         }
177         if (a->argc != e->args + 1)
178                 return CLI_SHOWUSAGE;
179         if (ast_load_resource(a->argv[e->args])) {
180                 ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
181                 return CLI_FAILURE;
182         }
183         return CLI_SUCCESS;
184 }
185
186 static char *handle_load_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
187 {
188         char *res = handle_load(e, cmd, a);
189         if (cmd == CLI_INIT)
190                 e->command = "load";
191         return res;
192 }
193
194 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
195 {
196         int x;
197
198         switch (cmd) {
199         case CLI_INIT:
200                 e->command = "module reload";
201                 e->usage =
202                         "Usage: module reload [module ...]\n"
203                         "       Reloads configuration files for all listed modules which support\n"
204                         "       reloading, or for all supported modules if none are listed.\n";
205                 return NULL;
206
207         case CLI_GENERATE:
208                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1);
209         }
210         if (a->argc == e->args) {
211                 ast_module_reload(NULL);
212                 return CLI_SUCCESS;
213         }
214         for (x = e->args; x < a->argc; x++) {
215                 int res = ast_module_reload(a->argv[x]);
216                 /* XXX reload has multiple error returns, including -1 on error and 2 on success */
217                 switch (res) {
218                 case 0:
219                         ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
220                         break;
221                 case 1:
222                         ast_cli(a->fd, "Module '%s' does not support reload\n", a->argv[x]);
223                         break;
224                 }
225         }
226         return CLI_SUCCESS;
227 }
228
229 static char *handle_reload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
230 {
231         char *s = handle_reload(e, cmd, a);
232         if (cmd == CLI_INIT)            /* override command name */
233                 e->command = "reload";
234         return s;
235 }
236
237 /*! 
238  * \brief Find the debug or verbose file setting 
239  * \arg debug 1 for debug, 0 for verbose
240  */
241 static struct ast_debug_file *find_debug_file(const char *fn, unsigned int debug)
242 {
243         struct ast_debug_file *df = NULL;
244         struct debug_file_list *dfl = debug ? &debug_files : &verbose_files;
245
246         AST_LIST_TRAVERSE(dfl, df, entry) {
247                 if (!strcasecmp(df->filename, fn))
248                         break;
249         }
250
251         return df;
252 }
253
254 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
255 {
256         int oldval;
257         int newlevel;
258         int atleast = 0;
259         int fd = a->fd;
260         int argc = a->argc;
261         char **argv = a->argv;
262         int *dst;
263         char *what;
264         struct debug_file_list *dfl;
265         struct ast_debug_file *adf;
266         char *fn;
267
268         switch (cmd) {
269         case CLI_INIT:
270                 e->command = "core set {debug|verbose} [off|atleast]";
271                 e->usage =
272                         "Usage: core set {debug|verbose} [atleast] <level> [filename]\n"
273                         "       core set {debug|verbose} off\n"
274                         "       Sets level of debug or verbose messages to be displayed or \n"
275                         "       sets a filename to display debug messages from.\n"
276                         "       0 or off means no messages should be displayed.\n"
277                         "       Equivalent to -d[d[...]] or -v[v[v...]] on startup\n";
278                 return NULL;
279
280         case CLI_GENERATE:
281                 return NULL;
282         }
283         /* all the above return, so we proceed with the handler.
284          * we are guaranteed to be called with argc >= e->args;
285          */
286
287         if (argc < e->args)
288                 return CLI_SHOWUSAGE;
289         if (!strcasecmp(argv[e->args - 2], "debug")) {
290                 dst = &option_debug;
291                 oldval = option_debug;
292                 what = "Core debug";
293         } else {
294                 dst = &option_verbose;
295                 oldval = option_verbose;
296                 what = "Verbosity";
297         }
298         if (argc == e->args && !strcasecmp(argv[e->args - 1], "off")) {
299                 unsigned int debug = (*what == 'C');
300                 newlevel = 0;
301
302                 dfl = debug ? &debug_files : &verbose_files;
303
304                 AST_RWLIST_WRLOCK(dfl);
305                 while ((adf = AST_RWLIST_REMOVE_HEAD(dfl, entry)))
306                         ast_free(adf);
307                 ast_clear_flag(&ast_options, debug ? AST_OPT_FLAG_DEBUG_FILE : AST_OPT_FLAG_VERBOSE_FILE);
308                 AST_RWLIST_UNLOCK(dfl);
309
310                 goto done;
311         }
312         if (!strcasecmp(argv[e->args-1], "atleast"))
313                 atleast = 1;
314         if (argc != e->args + atleast && argc != e->args + atleast + 1)
315                 return CLI_SHOWUSAGE;
316         if (sscanf(argv[e->args + atleast - 1], "%d", &newlevel) != 1)
317                 return CLI_SHOWUSAGE;
318         if (argc == e->args + atleast + 1) {
319                 unsigned int debug = (*what == 'C');
320                 dfl = debug ? &debug_files : &verbose_files;
321
322                 fn = argv[e->args + atleast];
323
324                 AST_RWLIST_WRLOCK(dfl);
325
326                 if ((adf = find_debug_file(fn, debug)) && !newlevel) {
327                         AST_RWLIST_REMOVE(dfl, adf, entry);
328                         if (AST_RWLIST_EMPTY(dfl))
329                                 ast_clear_flag(&ast_options, debug ? AST_OPT_FLAG_DEBUG_FILE : AST_OPT_FLAG_VERBOSE_FILE);
330                         AST_RWLIST_UNLOCK(dfl);
331                         ast_cli(fd, "%s was %d and has been set to 0 for '%s'\n", what, adf->level, fn);
332                         ast_free(adf);
333                         return CLI_SUCCESS;
334                 }
335
336                 if (adf) {
337                         if ((atleast && newlevel < adf->level) || adf->level == newlevel) {
338                                 ast_cli(fd, "%s is %d for '%s'\n", what, adf->level, fn);
339                                 AST_RWLIST_UNLOCK(dfl);
340                                 return CLI_SUCCESS;
341                         }
342                 } else if (!(adf = ast_calloc(1, sizeof(*adf) + strlen(fn) + 1))) {
343                         AST_RWLIST_UNLOCK(dfl);
344                         return CLI_FAILURE;
345                 }
346
347                 oldval = adf->level;
348                 adf->level = newlevel;
349                 strcpy(adf->filename, fn);
350
351                 ast_set_flag(&ast_options, debug ? AST_OPT_FLAG_DEBUG_FILE : AST_OPT_FLAG_VERBOSE_FILE);
352
353                 AST_RWLIST_INSERT_TAIL(dfl, adf, entry);
354                 AST_RWLIST_UNLOCK(dfl);
355
356                 ast_cli(fd, "%s was %d and has been set to %d for '%s'\n", what, oldval, adf->level, adf->filename);
357
358                 return CLI_SUCCESS;
359         }
360
361 done:
362         if (!atleast || newlevel > *dst)
363                 *dst = newlevel;
364         if (oldval > 0 && *dst == 0)
365                 ast_cli(fd, "%s is now OFF\n", what);
366         else if (*dst > 0) {
367                 if (oldval == *dst)
368                         ast_cli(fd, "%s is at least %d\n", what, *dst);
369                 else
370                         ast_cli(fd, "%s was %d and is now %d\n", what, oldval, *dst);
371         }
372
373         return CLI_SUCCESS;
374 }
375
376 static int handle_logger_mute(int fd, int argc, char *argv[])
377 {
378         if (argc != 2)
379                 return RESULT_SHOWUSAGE;
380         ast_console_toggle_mute(fd);
381         return RESULT_SUCCESS;
382 }
383
384 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
385 {
386         /* "module unload mod_1 [mod_2 .. mod_N]" */
387         int x;
388         int force = AST_FORCE_SOFT;
389         char *s;
390
391         switch (cmd) {
392         case CLI_INIT:
393                 e->command = "module unload";
394                 e->usage =
395                         "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
396                         "       Unloads the specified module from Asterisk. The -f\n"
397                         "       option causes the module to be unloaded even if it is\n"
398                         "       in use (may cause a crash) and the -h module causes the\n"
399                         "       module to be unloaded even if the module says it cannot, \n"
400                         "       which almost always will cause a crash.\n";
401                 return NULL;
402
403         case CLI_GENERATE:
404                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
405         }
406         if (a->argc < e->args + 1)
407                 return CLI_SHOWUSAGE;
408         x = e->args;    /* first argument */
409         s = a->argv[x];
410         if (s[0] == '-') {
411                 if (s[1] == 'f')
412                         force = AST_FORCE_FIRM;
413                 else if (s[1] == 'h')
414                         force = AST_FORCE_HARD;
415                 else
416                         return CLI_SHOWUSAGE;
417                 if (a->argc < e->args + 2)      /* need at least one module name */
418                         return CLI_SHOWUSAGE;
419                 x++;    /* skip this argument */
420         }
421
422         for (; x < a->argc; x++) {
423                 if (ast_unload_resource(a->argv[x], force)) {
424                         ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
425                         return CLI_FAILURE;
426                 }
427         }
428         return CLI_SUCCESS;
429 }
430
431 static char *handle_unload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
432 {
433         char *res = handle_unload(e, cmd, a);
434         if (cmd == CLI_INIT)
435                 e->command = "unload";  /* XXX override */
436         return res;
437 }
438
439 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d\n"
440 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s\n"
441
442 AST_MUTEX_DEFINE_STATIC(climodentrylock);
443 static int climodentryfd = -1;
444
445 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *like)
446 {
447         /* Comparing the like with the module */
448         if (strcasestr(module, like) ) {
449                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt);
450                 return 1;
451         } 
452         return 0;
453 }
454
455 static void print_uptimestr(int fd, struct timeval timeval, const char *prefix, int printsec)
456 {
457         int x; /* the main part - years, weeks, etc. */
458         struct ast_str *out;
459
460 #define SECOND (1)
461 #define MINUTE (SECOND*60)
462 #define HOUR (MINUTE*60)
463 #define DAY (HOUR*24)
464 #define WEEK (DAY*7)
465 #define YEAR (DAY*365)
466 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
467         if (timeval.tv_sec < 0) /* invalid, nothing to show */
468                 return;
469
470         if (printsec)  {        /* plain seconds output */
471                 ast_cli(fd, "%s: %lu\n", prefix, (u_long)timeval.tv_sec);
472                 return;
473         }
474         out = ast_str_alloca(256);
475         if (timeval.tv_sec > YEAR) {
476                 x = (timeval.tv_sec / YEAR);
477                 timeval.tv_sec -= (x * YEAR);
478                 ast_str_append(&out, 0, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
479         }
480         if (timeval.tv_sec > WEEK) {
481                 x = (timeval.tv_sec / WEEK);
482                 timeval.tv_sec -= (x * WEEK);
483                 ast_str_append(&out, 0, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
484         }
485         if (timeval.tv_sec > DAY) {
486                 x = (timeval.tv_sec / DAY);
487                 timeval.tv_sec -= (x * DAY);
488                 ast_str_append(&out, 0, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
489         }
490         if (timeval.tv_sec > HOUR) {
491                 x = (timeval.tv_sec / HOUR);
492                 timeval.tv_sec -= (x * HOUR);
493                 ast_str_append(&out, 0, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
494         }
495         if (timeval.tv_sec > MINUTE) {
496                 x = (timeval.tv_sec / MINUTE);
497                 timeval.tv_sec -= (x * MINUTE);
498                 ast_str_append(&out, 0, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval.tv_sec));
499         }
500         x = timeval.tv_sec;
501         if (x > 0 || out->used == 0)    /* if there is nothing, print 0 seconds */
502                 ast_str_append(&out, 0, "%d second%s ", x, ESS(x));
503         ast_cli(fd, "%s: %s\n", prefix, out->str);
504 }
505
506 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
507 {
508         struct timeval curtime = ast_tvnow();
509         int printsec;
510
511         switch (cmd) {
512         case CLI_INIT:
513                 e->command = "core show uptime [seconds]";
514                 e->usage =
515                         "Usage: core show uptime [seconds]\n"
516                         "       Shows Asterisk uptime information.\n"
517                         "       The seconds word returns the uptime in seconds only.\n";
518                 return NULL;
519
520         case CLI_GENERATE:
521                 return NULL;
522         }
523         /* regular handler */
524         if (a->argc == e->args && !strcasecmp(a->argv[e->args-1],"seconds"))
525                 printsec = 1;
526         else if (a->argc == e->args-1)
527                 printsec = 0;
528         else
529                 return CLI_SHOWUSAGE;
530         if (ast_startuptime.tv_sec)
531                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime", printsec);
532         if (ast_lastreloadtime.tv_sec)
533                 print_uptimestr(a->fd, ast_tvsub(curtime, ast_lastreloadtime), "Last reload", printsec);
534         return CLI_SUCCESS;
535 }
536
537 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
538 {
539         char *like;
540
541         switch (cmd) {
542         case CLI_INIT:
543                 e->command = "module show [like]";
544                 e->usage =
545                         "Usage: module show [like keyword]\n"
546                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
547                 return NULL;
548
549         case CLI_GENERATE:
550                 if (a->pos == e->args)
551                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
552                 else
553                         return NULL;
554         }
555         /* all the above return, so we proceed with the handler.
556          * we are guaranteed to have argc >= e->args
557          */
558         if (a->argc == e->args - 1)
559                 like = "";
560         else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
561                 like = a->argv[e->args];
562         else
563                 return CLI_SHOWUSAGE;
564                 
565         ast_mutex_lock(&climodentrylock);
566         climodentryfd = a->fd; /* global, protected by climodentrylock */
567         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count");
568         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
569         climodentryfd = -1;
570         ast_mutex_unlock(&climodentrylock);
571         return RESULT_SUCCESS;
572 }
573 #undef MODLIST_FORMAT
574 #undef MODLIST_FORMAT2
575
576 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
577 {
578 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
579 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
580 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
581 #define VERBOSE_FORMAT_STRING  "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
582 #define VERBOSE_FORMAT_STRING2 "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
583
584         struct ast_channel *c = NULL;
585         int numchans = 0, concise = 0, verbose = 0, count = 0;
586         int fd, argc;
587         char **argv;
588
589         switch (cmd) {
590         case CLI_INIT:
591                 e->command = "core show channels [concise|verbose|count]";
592                 e->usage =
593                         "Usage: core show channels [concise|verbose|count]\n"
594                         "       Lists currently defined channels and some information about them. If\n"
595                         "       'concise' is specified, the format is abridged and in a more easily\n"
596                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
597                         "       more and longer fields. If 'count' is specified only the channel and call\n"
598                         "       count is output.\n";
599                 return NULL;
600
601         case CLI_GENERATE:
602                 return NULL;
603         }
604         fd = a->fd;
605         argc = a->argc;
606         argv = a->argv;
607
608         if (a->argc == e->args) {
609                 if (!strcasecmp(argv[e->args-1],"concise"))
610                         concise = 1;
611                 else if (!strcasecmp(argv[e->args-1],"verbose"))
612                         verbose = 1;
613                 else if (!strcasecmp(argv[e->args-1],"count"))
614                         count = 1;
615                 else
616                         return CLI_SHOWUSAGE;
617         } else if (a->argc != e->args - 1)
618                 return CLI_SHOWUSAGE;
619
620         if (!count) {
621                 if (!concise && !verbose)
622                         ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
623                 else if (verbose)
624                         ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
625                                 "CallerID", "Duration", "Accountcode", "BridgedTo");
626         }
627
628         while ((c = ast_channel_walk_locked(c)) != NULL) {
629                 struct ast_channel *bc = ast_bridged_channel(c);
630                 char durbuf[10] = "-";
631
632                 if (!count) {
633                         if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
634                                 int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
635                                 if (verbose) {
636                                         int durh = duration / 3600;
637                                         int durm = (duration % 3600) / 60;
638                                         int durs = duration % 60;
639                                         snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
640                                 } else {
641                                         snprintf(durbuf, sizeof(durbuf), "%d", duration);
642                                 }                               
643                         }
644                         if (concise) {
645                                 ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
646                                         c->appl ? c->appl : "(None)",
647                                         S_OR(c->data, ""),      /* XXX different from verbose ? */
648                                         S_OR(c->cid.cid_num, ""),
649                                         S_OR(c->accountcode, ""),
650                                         c->amaflags, 
651                                         durbuf,
652                                         bc ? bc->name : "(None)");
653                         } else if (verbose) {
654                                 ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
655                                         c->appl ? c->appl : "(None)",
656                                         c->data ? S_OR(c->data, "(Empty)" ): "(None)",
657                                         S_OR(c->cid.cid_num, ""),
658                                         durbuf,
659                                         S_OR(c->accountcode, ""),
660                                         bc ? bc->name : "(None)");
661                         } else {
662                                 char locbuf[40] = "(None)";
663                                 char appdata[40] = "(None)";
664                                 
665                                 if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
666                                         snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
667                                 if (c->appl)
668                                         snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
669                                 ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
670                         }
671                 }
672                 numchans++;
673                 ast_channel_unlock(c);
674         }
675         if (!concise) {
676                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
677                 if (option_maxcalls)
678                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
679                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
680                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
681                 else
682                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
683         }
684         return CLI_SUCCESS;
685         
686 #undef FORMAT_STRING
687 #undef FORMAT_STRING2
688 #undef CONCISE_FORMAT_STRING
689 #undef VERBOSE_FORMAT_STRING
690 #undef VERBOSE_FORMAT_STRING2
691 }
692
693 static const char showchan_help[] = 
694 "Usage: core show channel <channel>\n"
695 "       Shows lots of information about the specified channel.\n";
696
697 static const char commandcomplete_help[] = 
698 "Usage: _command complete \"<line>\" text state\n"
699 "       This function is used internally to help with command completion and should.\n"
700 "       never be called by the user directly.\n";
701
702 static const char commandnummatches_help[] = 
703 "Usage: _command nummatches \"<line>\" text \n"
704 "       This function is used internally to help with command completion and should.\n"
705 "       never be called by the user directly.\n";
706
707 static const char commandmatchesarray_help[] = 
708 "Usage: _command matchesarray \"<line>\" text \n"
709 "       This function is used internally to help with command completion and should.\n"
710 "       never be called by the user directly.\n";
711
712 static int handle_softhangup(int fd, int argc, char *argv[])
713 {
714         struct ast_channel *c=NULL;
715         if (argc != 3)
716                 return RESULT_SHOWUSAGE;
717         c = ast_get_channel_by_name_locked(argv[2]);
718         if (c) {
719                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
720                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
721                 ast_channel_unlock(c);
722         } else
723                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
724         return RESULT_SUCCESS;
725 }
726
727 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
728
729 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
730 {
731         char *buf, *obuf;
732         int buflen = 2048;
733         int len = 0;
734         char **matches;
735         int x, matchlen;
736
737         if (argc != 4)
738                 return RESULT_SHOWUSAGE;
739         if (!(buf = ast_malloc(buflen)))
740                 return RESULT_FAILURE;
741         buf[len] = '\0';
742         matches = ast_cli_completion_matches(argv[2], argv[3]);
743         if (matches) {
744                 for (x=0; matches[x]; x++) {
745                         matchlen = strlen(matches[x]) + 1;
746                         if (len + matchlen >= buflen) {
747                                 buflen += matchlen * 3;
748                                 obuf = buf;
749                                 if (!(buf = ast_realloc(obuf, buflen))) 
750                                         /* Memory allocation failure...  Just free old buffer and be done */
751                                         ast_free(obuf);
752                         }
753                         if (buf)
754                                 len += sprintf( buf + len, "%s ", matches[x]);
755                         ast_free(matches[x]);
756                         matches[x] = NULL;
757                 }
758                 ast_free(matches);
759         }
760
761         if (buf) {
762                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
763                 ast_free(buf);
764         } else
765                 ast_cli(fd, "NULL\n");
766
767         return RESULT_SUCCESS;
768 }
769
770
771
772 static int handle_commandnummatches(int fd, int argc, char *argv[])
773 {
774         int matches = 0;
775
776         if (argc != 4)
777                 return RESULT_SHOWUSAGE;
778
779         matches = ast_cli_generatornummatches(argv[2], argv[3]);
780
781         ast_cli(fd, "%d", matches);
782
783         return RESULT_SUCCESS;
784 }
785
786 static int handle_commandcomplete(int fd, int argc, char *argv[])
787 {
788         char *buf;
789
790         if (argc != 5)
791                 return RESULT_SHOWUSAGE;
792         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
793         if (buf) {
794                 ast_cli(fd, buf);
795                 ast_free(buf);
796         } else
797                 ast_cli(fd, "NULL\n");
798         return RESULT_SUCCESS;
799 }
800
801 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
802 {
803         struct ast_channel *c = NULL;
804         int is_all, is_off = 0;
805
806         switch (cmd) {
807         case CLI_INIT:
808                 e->command = "core set debug channel";
809                 e->usage =
810                         "Usage: core set debug channel <all|channel> [off]\n"
811                         "       Enables/disables debugging on all or on a specific channel.\n";
812                 return NULL;
813
814         case CLI_GENERATE:
815                 /* XXX remember to handle the optional "off" */
816                 if (a->pos != e->args)
817                         return NULL;
818                 return a->n == 0 ? ast_strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
819         }
820         /* 'core set debug channel {all|chan_id}' */
821         if (a->argc == e->args + 2) {
822                 if (!strcasecmp(a->argv[e->args + 1], "off"))
823                         is_off = 1;
824                 else
825                         return CLI_SHOWUSAGE;
826         } else if (a->argc != e->args + 1)
827                 return CLI_SHOWUSAGE;
828
829         is_all = !strcasecmp("all", a->argv[e->args]);
830         if (is_all) {
831                 if (is_off) {
832                         global_fin &= ~DEBUGCHAN_FLAG;
833                         global_fout &= ~DEBUGCHAN_FLAG;
834                 } else {
835                         global_fin |= DEBUGCHAN_FLAG;
836                         global_fout |= DEBUGCHAN_FLAG;
837                 }
838                 c = ast_channel_walk_locked(NULL);
839         } else {
840                 c = ast_get_channel_by_name_locked(a->argv[e->args]);
841                 if (c == NULL)
842                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
843         }
844         while (c) {
845                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
846                         if (is_off) {
847                                 c->fin &= ~DEBUGCHAN_FLAG;
848                                 c->fout &= ~DEBUGCHAN_FLAG;
849                         } else {
850                                 c->fin |= DEBUGCHAN_FLAG;
851                                 c->fout |= DEBUGCHAN_FLAG;
852                         }
853                         ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
854                 }
855                 ast_channel_unlock(c);
856                 if (!is_all)
857                         break;
858                 c = ast_channel_walk_locked(c);
859         }
860         ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
861         return RESULT_SUCCESS;
862 }
863
864 static char *handle_debugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
865 {
866         char *res;
867
868         if (cmd == CLI_HANDLER && a->argc != e->args + 1)
869                 return CLI_SHOWUSAGE;
870         res = handle_core_set_debug_channel(e, cmd, a);
871         if (cmd == CLI_INIT)
872                 e->command = "debug channel";
873         return res;
874 }
875
876 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
877 {
878         char *res;
879         if (cmd == CLI_HANDLER) {
880                 if (a->argc != e->args + 1)
881                         return CLI_SHOWUSAGE;
882                 /* pretend we have an extra "off" at the end. We can do this as the array
883                  * is NULL terminated so we overwrite that entry.
884                  */
885                 a->argv[e->args+1] = "off";
886                 a->argc++;
887         }
888         res = handle_core_set_debug_channel(e, cmd, a);
889         if (cmd == CLI_INIT)
890                 e->command = "no debug channel";
891         return res;
892 }
893                 
894 static int handle_showchan(int fd, int argc, char *argv[])
895 {
896         struct ast_channel *c=NULL;
897         struct timeval now;
898         struct ast_str *out = ast_str_alloca(2048);
899         char cdrtime[256];
900         char nf[256], wf[256], rf[256];
901         long elapsed_seconds=0;
902         int hour=0, min=0, sec=0;
903         
904         if (argc != 4)
905                 return RESULT_SHOWUSAGE;
906         now = ast_tvnow();
907         c = ast_get_channel_by_name_locked(argv[3]);
908         if (!c) {
909                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
910                 return RESULT_SUCCESS;
911         }
912         if (c->cdr) {
913                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
914                 hour = elapsed_seconds / 3600;
915                 min = (elapsed_seconds % 3600) / 60;
916                 sec = elapsed_seconds % 60;
917                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
918         } else
919                 strcpy(cdrtime, "N/A");
920         ast_cli(fd, 
921                 " -- General --\n"
922                 "           Name: %s\n"
923                 "           Type: %s\n"
924                 "       UniqueID: %s\n"
925                 "      Caller ID: %s\n"
926                 " Caller ID Name: %s\n"
927                 "    DNID Digits: %s\n"
928                 "       Language: %s\n"
929                 "          State: %s (%d)\n"
930                 "          Rings: %d\n"
931                 "  NativeFormats: %s\n"
932                 "    WriteFormat: %s\n"
933                 "     ReadFormat: %s\n"
934                 " WriteTranscode: %s\n"
935                 "  ReadTranscode: %s\n"
936                 "1st File Descriptor: %d\n"
937                 "      Frames in: %d%s\n"
938                 "     Frames out: %d%s\n"
939                 " Time to Hangup: %ld\n"
940                 "   Elapsed Time: %s\n"
941                 "  Direct Bridge: %s\n"
942                 "Indirect Bridge: %s\n"
943                 " --   PBX   --\n"
944                 "        Context: %s\n"
945                 "      Extension: %s\n"
946                 "       Priority: %d\n"
947                 "     Call Group: %llu\n"
948                 "   Pickup Group: %llu\n"
949                 "    Application: %s\n"
950                 "           Data: %s\n"
951                 "    Blocking in: %s\n",
952                 c->name, c->tech->type, c->uniqueid,
953                 S_OR(c->cid.cid_num, "(N/A)"),
954                 S_OR(c->cid.cid_name, "(N/A)"),
955                 S_OR(c->cid.cid_dnid, "(N/A)"), 
956                 c->language,    
957                 ast_state2str(c->_state), c->_state, c->rings, 
958                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
959                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
960                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
961                 c->writetrans ? "Yes" : "No",
962                 c->readtrans ? "Yes" : "No",
963                 c->fds[0],
964                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
965                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
966                 (long)c->whentohangup,
967                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
968                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
969                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
970                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
971         
972         if (pbx_builtin_serialize_variables(c, &out))
973                 ast_cli(fd,"      Variables:\n%s\n", out->str);
974         if (c->cdr && ast_cdr_serialize_variables(c->cdr, &out, '=', '\n', 1))
975                 ast_cli(fd,"  CDR Variables:\n%s\n", out->str);
976         
977         ast_channel_unlock(c);
978         return RESULT_SUCCESS;
979 }
980
981 /*
982  * helper function to generate CLI matches from a fixed set of values.
983  * A NULL word is acceptable.
984  */
985 char *ast_cli_complete(const char *word, char *const choices[], int state)
986 {
987         int i, which = 0, len;
988         len = ast_strlen_zero(word) ? 0 : strlen(word);
989
990         for (i = 0; choices[i]; i++) {
991                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
992                         return ast_strdup(choices[i]);
993         }
994         return NULL;
995 }
996
997 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
998 {
999         struct ast_channel *c = NULL;
1000         int which = 0;
1001         int wordlen;
1002         char notfound = '\0';
1003         char *ret = &notfound; /* so NULL can break the loop */
1004
1005         if (pos != rpos)
1006                 return NULL;
1007
1008         wordlen = strlen(word); 
1009
1010         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
1011                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
1012                         ret = ast_strdup(c->name);
1013                 ast_channel_unlock(c);
1014         }
1015         return ret == &notfound ? NULL : ret;
1016 }
1017
1018 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
1019 {
1020         return ast_complete_channels(line, word, pos, state, 2);
1021 }
1022
1023 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
1024 {
1025         return ast_complete_channels(line, word, pos, state, 3);
1026 }
1027
1028 static int group_show_channels(int fd, int argc, char *argv[])
1029 {
1030 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1031
1032         struct ast_group_info *gi = NULL;
1033         int numchans = 0;
1034         regex_t regexbuf;
1035         int havepattern = 0;
1036
1037         if (argc < 3 || argc > 4)
1038                 return RESULT_SHOWUSAGE;
1039         
1040         if (argc == 4) {
1041                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
1042                         return RESULT_SHOWUSAGE;
1043                 havepattern = 1;
1044         }
1045
1046         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
1047
1048         ast_app_group_list_rdlock();
1049         
1050         gi = ast_app_group_list_head();
1051         while (gi) {
1052                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1053                         ast_cli(fd, FORMAT_STRING, gi->chan->name, gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1054                         numchans++;
1055                 }
1056                 gi = AST_LIST_NEXT(gi, list);
1057         }
1058         
1059         ast_app_group_list_unlock();
1060         
1061         if (havepattern)
1062                 regfree(&regexbuf);
1063
1064         ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
1065         return RESULT_SUCCESS;
1066 #undef FORMAT_STRING
1067 }
1068
1069 /* XXX Nothing in this array can currently be deprecated...
1070    You have to change the way find_cli works in order to remove this array
1071    I recommend doing this eventually...
1072  */
1073 static struct ast_cli_entry builtins[] = {
1074         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
1075         { { "_command", "complete", NULL },
1076         handle_commandcomplete, "Command complete",
1077         commandcomplete_help },
1078
1079         { { "_command", "nummatches", NULL },
1080         handle_commandnummatches, "Returns number of command matches",
1081         commandnummatches_help },
1082
1083         { { "_command", "matchesarray", NULL },
1084         handle_commandmatchesarray, "Returns command matches array",
1085         commandmatchesarray_help },
1086
1087         { { NULL }, NULL, NULL, NULL }
1088 };
1089
1090 static struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel");
1091 static struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module");
1092 static struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name");
1093 static struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name");
1094
1095 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1096
1097 static struct ast_cli_entry cli_cli[] = {
1098         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1099         NEW_CLI(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1100
1101         NEW_CLI(handle_chanlist, "Display information on channels"),
1102
1103         { { "core", "show", "channel", NULL },
1104         handle_showchan, "Display information on a specific channel",
1105         showchan_help, complete_ch_4 },
1106
1107         NEW_CLI(handle_core_set_debug_channel, "Enable/disable debugging on a channel",
1108                 .deprecate_cmd = &cli_debug_channel_deprecated),
1109
1110         NEW_CLI(handle_verbose, "Set level of debug/verbose chattiness"),
1111
1112         { { "group", "show", "channels", NULL },
1113         group_show_channels, "Display active channels with group(s)",
1114         group_show_channels_help },
1115
1116         NEW_CLI(handle_help, "Display help list, or specific help on a command"),
1117
1118         { { "logger", "mute", NULL },
1119         handle_logger_mute, "Toggle logging output to a console",
1120         logger_mute_help },
1121
1122         NEW_CLI(handle_modlist, "List modules and info"),
1123
1124         NEW_CLI(handle_load, "Load a module by name", .deprecate_cmd = &cli_module_load_deprecated),
1125
1126         NEW_CLI(handle_reload, "Reload configuration", .deprecate_cmd = &cli_module_reload_deprecated),
1127
1128         NEW_CLI(handle_unload, "Unload a module by name", .deprecate_cmd = &cli_module_unload_deprecated ),
1129
1130         NEW_CLI(handle_showuptime, "Show uptime information"),
1131
1132         { { "soft", "hangup", NULL },
1133         handle_softhangup, "Request a hangup on a given channel",
1134         softhangup_help, complete_ch_3 },
1135 };
1136
1137 /*!
1138  * Some regexp characters in cli arguments are reserved and used as separators.
1139  */
1140 static const char cli_rsvd[] = "[]{}|*%";
1141
1142 /*!
1143  * initialize the _full_cmd string and related parameters,
1144  * return 0 on success, -1 on error.
1145  */
1146 static int set_full_cmd(struct ast_cli_entry *e)
1147 {
1148         int i;
1149         char buf[80];
1150
1151         ast_join(buf, sizeof(buf), e->cmda);
1152         e->_full_cmd = ast_strdup(buf);
1153         if (!e->_full_cmd) {
1154                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1155                 return -1;
1156         }
1157         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1158         for (i = 0; e->cmda[i]; i++)
1159                 ;
1160         e->args = i;
1161         return 0;
1162 }
1163
1164 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1165 void ast_builtins_init(void)
1166 {
1167         struct ast_cli_entry *e;
1168
1169         for (e = builtins; e->cmda[0] != NULL; e++)
1170                 set_full_cmd(e);
1171
1172         ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry));
1173 }
1174
1175 /*
1176  * We have two sets of commands: builtins are stored in a
1177  * NULL-terminated array of ast_cli_entry, whereas external
1178  * commands are in a list.
1179  * When navigating, we need to keep two pointers and get
1180  * the next one in lexicographic order. For the purpose,
1181  * we use a structure.
1182  */
1183
1184 struct cli_iterator {
1185         struct ast_cli_entry *builtins;
1186         struct ast_cli_entry *helpers;
1187 };
1188
1189 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
1190 {
1191         struct ast_cli_entry *e;
1192
1193         if (i->builtins == NULL && i->helpers == NULL) {
1194                 /* initialize */
1195                 i->builtins = builtins;
1196                 i->helpers = AST_LIST_FIRST(&helpers);
1197         }
1198         e = i->builtins; /* temporary */
1199         if (!e->cmda[0] || (i->helpers &&
1200                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
1201                 /* Use helpers */
1202                 e = i->helpers;
1203                 if (e)
1204                         i->helpers = AST_LIST_NEXT(e, list);
1205         } else { /* use builtin. e is already set  */
1206                 (i->builtins)++;        /* move to next */
1207         }
1208         return e;
1209 }
1210
1211 /*!
1212  * match a word in the CLI entry.
1213  * returns -1 on mismatch, 0 on match of an optional word,
1214  * 1 on match of a full word.
1215  *
1216  * The pattern can be
1217  *   any_word           match for equal
1218  *   [foo|bar|baz]      optionally, one of these words
1219  *   {foo|bar|baz}      exactly, one of these words
1220  *   %                  any word
1221  */
1222 static int word_match(const char *cmd, const char *cli_word)
1223 {
1224         int l;
1225         char *pos;
1226
1227         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1228                 return -1;
1229         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1230                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1231         /* regexp match, takes [foo|bar] or {foo|bar} */
1232         l = strlen(cmd);
1233         /* wildcard match - will extend in the future */
1234         if (l > 0 && cli_word[0] == '%') {
1235                 return 1;       /* wildcard */
1236         }
1237         pos = strcasestr(cli_word, cmd);
1238         if (pos == NULL) /* not found, say ok if optional */
1239                 return cli_word[0] == '[' ? 0 : -1;
1240         if (pos == cli_word)    /* no valid match at the beginning */
1241                 return -1;
1242         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1243                 return 1;       /* valid match */
1244         return -1;      /* not found */
1245 }
1246
1247 /*! \brief if word is a valid prefix for token, returns the pos-th
1248  * match as a malloced string, or NULL otherwise.
1249  * Always tell in *actual how many matches we got.
1250  */
1251 static char *is_prefix(const char *word, const char *token,
1252         int pos, int *actual)
1253 {
1254         int lw;
1255         char *s, *t1;
1256
1257         *actual = 0;
1258         if (ast_strlen_zero(token))
1259                 return NULL;
1260         if (ast_strlen_zero(word))
1261                 word = "";      /* dummy */
1262         lw = strlen(word);
1263         if (strcspn(word, cli_rsvd) != lw)
1264                 return NULL;    /* no match if word has reserved chars */
1265         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1266                 if (strncasecmp(token, word, lw))       /* no match */
1267                         return NULL;
1268                 *actual = 1;
1269                 return (pos != 0) ? NULL : ast_strdup(token);
1270         }
1271         /* now handle regexp match */
1272
1273         /* Wildcard always matches, so we never do is_prefix on them */
1274
1275         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1276         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1277                 if (*s == '%')  /* wildcard */
1278                         continue;
1279                 if (strncasecmp(s, word, lw))   /* no match */
1280                         continue;
1281                 (*actual)++;
1282                 if (pos-- == 0)
1283                         return ast_strdup(s);
1284         }
1285         return NULL;
1286 }
1287
1288 /*!
1289  * \brief locate a cli command in the 'helpers' list (which must be locked).
1290  * exact has 3 values:
1291  *      0       returns if the search key is equal or longer than the entry.
1292  *              note that trailing optional arguments are skipped.
1293  *      -1      true if the mismatch is on the last word XXX not true!
1294  *      1       true only on complete, exact match.
1295  *
1296  * The search compares word by word taking care of regexps in e->cmda
1297  */
1298 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
1299 {
1300         int matchlen = -1;      /* length of longest match so far */
1301         struct ast_cli_entry *cand = NULL, *e=NULL;
1302         struct cli_iterator i = { NULL, NULL};
1303
1304         while ( (e = cli_next(&i)) ) {
1305                 /* word-by word regexp comparison */
1306                 char * const *src = cmds;
1307                 char * const *dst = e->cmda;
1308                 int n = 0;
1309                 for (;; dst++, src += n) {
1310                         n = word_match(*src, *dst);
1311                         if (n < 0)
1312                                 break;
1313                 }
1314                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1315                         /* no more words in 'e' */
1316                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1317                                 break;
1318                         /* Here, cmds has more words than the entry 'e' */
1319                         if (match_type != 0)    /* but we look for almost exact match... */
1320                                 continue;       /* so we skip this one. */
1321                         /* otherwise we like it (case 0) */
1322                 } else {        /* still words in 'e' */
1323                         if (ast_strlen_zero(*src))
1324                                 continue; /* cmds is shorter than 'e', not good */
1325                         /* Here we have leftover words in cmds and 'e',
1326                          * but there is a mismatch. We only accept this one if match_type == -1
1327                          * and this is the last word for both.
1328                          */
1329                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1330                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1331                                 continue;
1332                         /* good, we are in case match_type == -1 and mismatch on last word */
1333                 }
1334                 if (src - cmds > matchlen) {    /* remember the candidate */
1335                         matchlen = src - cmds;
1336                         cand = e;
1337                 }
1338         }
1339         return e ? e : cand;
1340 }
1341
1342 static char *find_best(char *argv[])
1343 {
1344         static char cmdline[80];
1345         int x;
1346         /* See how close we get, then print the candidate */
1347         char *myargv[AST_MAX_CMD_LEN];
1348         for (x=0;x<AST_MAX_CMD_LEN;x++)
1349                 myargv[x]=NULL;
1350         AST_LIST_LOCK(&helpers);
1351         for (x=0;argv[x];x++) {
1352                 myargv[x] = argv[x];
1353                 if (!find_cli(myargv, -1))
1354                         break;
1355         }
1356         AST_LIST_UNLOCK(&helpers);
1357         ast_join(cmdline, sizeof(cmdline), myargv);
1358         return cmdline;
1359 }
1360
1361 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1362 {
1363         if (e->deprecate_cmd) {
1364                 __ast_cli_unregister(e->deprecate_cmd, e);
1365         }
1366         if (e->inuse) {
1367                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1368         } else {
1369                 AST_LIST_LOCK(&helpers);
1370                 AST_LIST_REMOVE(&helpers, e, list);
1371                 AST_LIST_UNLOCK(&helpers);
1372                 ast_free(e->_full_cmd);
1373                 e->_full_cmd = NULL;
1374                 if (e->new_handler) {
1375                         /* this is a new-style entry. Reset fields and free memory. */
1376                         bzero((char **)(e->cmda), sizeof(e->cmda));
1377                         ast_free(e->command);
1378                         e->command = NULL;
1379                         e->usage = NULL;
1380                 }
1381         }
1382         return 0;
1383 }
1384
1385 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1386 {
1387         struct ast_cli_entry *cur;
1388         int i, lf, ret = -1;
1389
1390         if (e->handler == NULL) {       /* new style entry, run the handler to init fields */
1391                 struct ast_cli_args a;  /* fake argument */
1392                 char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
1393                 char *s;
1394
1395                 bzero (&a, sizeof(a));
1396                 e->new_handler(e, CLI_INIT, &a);
1397                 /* XXX check that usage and command are filled up */
1398                 s = ast_skip_blanks(e->command);
1399                 s = e->command = ast_strdup(s);
1400                 for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
1401                         *dst++ = s;     /* store string */
1402                         s = ast_skip_nonblanks(s);
1403                         if (*s == '\0') /* we are done */
1404                                 break;
1405                         *s++ = '\0';
1406                         s = ast_skip_blanks(s);
1407                 }
1408                 *dst++ = NULL;
1409         }
1410         if (set_full_cmd(e))
1411                 goto done;
1412         AST_LIST_LOCK(&helpers);
1413         
1414         if (find_cli(e->cmda, 1)) {
1415                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", e->_full_cmd);
1416                 ast_free(e->_full_cmd);
1417                 e->_full_cmd = NULL;
1418                 goto done;
1419         }
1420         if (!ed) {
1421                 e->deprecated = 0;
1422         } else {
1423                 e->deprecated = 1;
1424                 e->summary = ed->summary;
1425                 e->usage = ed->usage;
1426                 /* XXX If command A deprecates command B, and command B deprecates command C...
1427                    Do we want to show command A or command B when telling the user to use new syntax?
1428                    This currently would show command A.
1429                    To show command B, you just need to always use ed->_full_cmd.
1430                  */
1431                 e->_deprecated_by = S_OR(ed->_deprecated_by, ed->_full_cmd);
1432         }
1433
1434         lf = e->cmdlen;
1435         AST_LIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1436                 int len = cur->cmdlen;
1437                 if (lf < len)
1438                         len = lf;
1439                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
1440                         AST_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); 
1441                         break;
1442                 }
1443         }
1444         AST_LIST_TRAVERSE_SAFE_END;
1445
1446         if (!cur)
1447                 AST_LIST_INSERT_TAIL(&helpers, e, list); 
1448         ret = 0;        /* success */
1449
1450 done:
1451         AST_LIST_UNLOCK(&helpers);
1452
1453         if (e->deprecate_cmd) {
1454                 /* This command deprecates another command.  Register that one also. */
1455                 __ast_cli_register(e->deprecate_cmd, e);
1456         }
1457         
1458         return ret;
1459 }
1460
1461 /* wrapper function, so we can unregister deprecated commands recursively */
1462 int ast_cli_unregister(struct ast_cli_entry *e)
1463 {
1464         return __ast_cli_unregister(e, NULL);
1465 }
1466
1467 /* wrapper function, so we can register deprecated commands recursively */
1468 int ast_cli_register(struct ast_cli_entry *e)
1469 {
1470         return __ast_cli_register(e, NULL);
1471 }
1472
1473 /*
1474  * register/unregister an array of entries.
1475  */
1476 int ast_cli_register_multiple(struct ast_cli_entry *e, int len)
1477 {
1478         int i, res = 0;
1479
1480         for (i = 0; i < len; i++)
1481                 res |= ast_cli_register(e + i);
1482
1483         return res;
1484 }
1485
1486 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
1487 {
1488         int i, res = 0;
1489
1490         for (i = 0; i < len; i++)
1491                 res |= ast_cli_unregister(e + i);
1492
1493         return res;
1494 }
1495
1496
1497 /*! \brief helper for final part of
1498  * handle_help. if locked = 0 it's just "help_workhorse",
1499  * otherwise assume the list is already locked and print
1500  * an error message if not found.
1501  */
1502 static char *help1(int fd, char *match[], int locked)
1503 {
1504         char matchstr[80] = "";
1505         struct ast_cli_entry *e;
1506         int len = 0;
1507         int found = 0;
1508         struct cli_iterator i = { NULL, NULL};
1509
1510         if (match) {
1511                 ast_join(matchstr, sizeof(matchstr), match);
1512                 len = strlen(matchstr);
1513         }
1514         if (!locked)
1515                 AST_LIST_LOCK(&helpers);
1516         while ( (e = cli_next(&i)) ) {
1517                 /* Hide commands that start with '_' */
1518                 if (e->_full_cmd[0] == '_')
1519                         continue;
1520                 /* Hide commands that are marked as deprecated. */
1521                 if (e->deprecated)
1522                         continue;
1523                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
1524                         continue;
1525                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
1526                 found++;
1527         }
1528         if (!locked)
1529                 AST_LIST_UNLOCK(&helpers);
1530         if (!locked && !found && matchstr[0])
1531                 ast_cli(fd, "No such command '%s'.\n", matchstr);
1532         return CLI_SUCCESS;
1533 }
1534
1535 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1536 {
1537         char fullcmd[80];
1538         struct ast_cli_entry *my_e;
1539
1540         if (cmd == CLI_INIT) {
1541                 e->command = "help";
1542                 e->usage =
1543                         "Usage: help [topic]\n"
1544                         "       When called with a topic as an argument, displays usage\n"
1545                         "       information on the given command. If called without a\n"
1546                         "       topic, it provides a list of commands.\n";
1547                 return NULL;
1548
1549         } else if (cmd == CLI_GENERATE) {
1550                 /* skip first 4 or 5 chars, "help " */
1551                 int l = strlen(a->line);
1552
1553                 if (l > 5)
1554                         l = 5;
1555                 /* XXX watch out, should stop to the non-generator parts */
1556                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
1557         }
1558         if (a->argc == 1)
1559                 return help1(a->fd, NULL, 0);
1560
1561         AST_LIST_LOCK(&helpers);
1562         my_e = find_cli(a->argv + 1, 1);        /* try exact match first */
1563         if (!my_e)
1564                 return help1(a->fd, a->argv + 1, 1 /* locked */);
1565         if (my_e->usage)
1566                 ast_cli(a->fd, "%s", my_e->usage);
1567         else {
1568                 ast_join(fullcmd, sizeof(fullcmd), a->argv+1);
1569                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
1570         }
1571         AST_LIST_UNLOCK(&helpers);
1572         return RESULT_SUCCESS;
1573 }
1574
1575 static char *parse_args(const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
1576 {
1577         char *dup, *cur;
1578         int x = 0;
1579         int quoted = 0;
1580         int escaped = 0;
1581         int whitespace = 1;
1582         int dummy = 0;
1583
1584         if (trailingwhitespace == NULL)
1585                 trailingwhitespace = &dummy;
1586         *trailingwhitespace = 0;
1587         if (s == NULL)  /* invalid, though! */
1588                 return NULL;
1589         /* make a copy to store the parsed string */
1590         if (!(dup = ast_strdup(s)))
1591                 return NULL;
1592
1593         cur = dup;
1594         /* scan the original string copying into cur when needed */
1595         for (; *s ; s++) {
1596                 if (x >= max - 1) {
1597                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1598                         break;
1599                 }
1600                 if (*s == '"' && !escaped) {
1601                         quoted = !quoted;
1602                         if (quoted && whitespace) {
1603                                 /* start a quoted string from previous whitespace: new argument */
1604                                 argv[x++] = cur;
1605                                 whitespace = 0;
1606                         }
1607                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1608                         /* If we are not already in whitespace, and not in a quoted string or
1609                            processing an escape sequence, and just entered whitespace, then
1610                            finalize the previous argument and remember that we are in whitespace
1611                         */
1612                         if (!whitespace) {
1613                                 *cur++ = '\0';
1614                                 whitespace = 1;
1615                         }
1616                 } else if (*s == '\\' && !escaped) {
1617                         escaped = 1;
1618                 } else {
1619                         if (whitespace) {
1620                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1621                                 argv[x++] = cur;
1622                                 whitespace = 0;
1623                         }
1624                         *cur++ = *s;
1625                         escaped = 0;
1626                 }
1627         }
1628         /* Null terminate */
1629         *cur++ = '\0';
1630         /* XXX put a NULL in the last argument, because some functions that take
1631          * the array may want a null-terminated array.
1632          * argc still reflects the number of non-NULL entries.
1633          */
1634         argv[x] = NULL;
1635         *argc = x;
1636         *trailingwhitespace = whitespace;
1637         return dup;
1638 }
1639
1640 /*! \brief Return the number of unique matches for the generator */
1641 int ast_cli_generatornummatches(const char *text, const char *word)
1642 {
1643         int matches = 0, i = 0;
1644         char *buf = NULL, *oldbuf = NULL;
1645
1646         while ((buf = ast_cli_generator(text, word, i++))) {
1647                 if (!oldbuf || strcmp(buf,oldbuf))
1648                         matches++;
1649                 if (oldbuf)
1650                         ast_free(oldbuf);
1651                 oldbuf = buf;
1652         }
1653         if (oldbuf)
1654                 ast_free(oldbuf);
1655         return matches;
1656 }
1657
1658 char **ast_cli_completion_matches(const char *text, const char *word)
1659 {
1660         char **match_list = NULL, *retstr, *prevstr;
1661         size_t match_list_len, max_equal, which, i;
1662         int matches = 0;
1663
1664         /* leave entry 0 free for the longest common substring */
1665         match_list_len = 1;
1666         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1667                 if (matches + 1 >= match_list_len) {
1668                         match_list_len <<= 1;
1669                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1670                                 return NULL;
1671                 }
1672                 match_list[++matches] = retstr;
1673         }
1674
1675         if (!match_list)
1676                 return match_list; /* NULL */
1677
1678         /* Find the longest substring that is common to all results
1679          * (it is a candidate for completion), and store a copy in entry 0.
1680          */
1681         prevstr = match_list[1];
1682         max_equal = strlen(prevstr);
1683         for (which = 2; which <= matches; which++) {
1684                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1685                         continue;
1686                 max_equal = i;
1687         }
1688
1689         if (!(retstr = ast_malloc(max_equal + 1)))
1690                 return NULL;
1691         
1692         ast_copy_string(retstr, match_list[1], max_equal + 1);
1693         match_list[0] = retstr;
1694
1695         /* ensure that the array is NULL terminated */
1696         if (matches + 1 >= match_list_len) {
1697                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1698                         return NULL;
1699         }
1700         match_list[matches + 1] = NULL;
1701
1702         return match_list;
1703 }
1704
1705 /*! \brief returns true if there are more words to match */
1706 static int more_words (char * const *dst)
1707 {
1708         int i;
1709         for (i = 0; dst[i]; i++) {
1710                 if (dst[i][0] != '[')
1711                         return -1;
1712         }
1713         return 0;
1714 }
1715         
1716 /*
1717  * generate the entry at position 'state'
1718  */
1719 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1720 {
1721         char *argv[AST_MAX_ARGS];
1722         struct ast_cli_entry *e;
1723         struct cli_iterator i = { NULL, NULL };
1724         int x = 0, argindex, matchlen;
1725         int matchnum=0;
1726         char *ret = NULL;
1727         char matchstr[80] = "";
1728         int tws = 0;
1729         /* Split the argument into an array of words */
1730         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1731
1732         if (!dup)       /* malloc error */
1733                 return NULL;
1734
1735         /* Compute the index of the last argument (could be an empty string) */
1736         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1737
1738         /* rebuild the command, ignore terminating white space and flatten space */
1739         ast_join(matchstr, sizeof(matchstr)-1, argv);
1740         matchlen = strlen(matchstr);
1741         if (tws) {
1742                 strcat(matchstr, " "); /* XXX */
1743                 if (matchlen)
1744                         matchlen++;
1745         }
1746         if (lock)
1747                 AST_LIST_LOCK(&helpers);
1748         while ( (e = cli_next(&i)) ) {
1749                 /* XXX repeated code */
1750                 int src = 0, dst = 0, n = 0;
1751
1752                 /*
1753                  * Try to match words, up to and excluding the last word, which
1754                  * is either a blank or something that we want to extend.
1755                  */
1756                 for (;src < argindex; dst++, src += n) {
1757                         n = word_match(argv[src], e->cmda[dst]);
1758                         if (n < 0)
1759                                 break;
1760                 }
1761
1762                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
1763                         continue;
1764                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
1765                 matchnum += n;  /* this many matches here */
1766                 if (ret) {
1767                         /*
1768                          * argv[src] is a valid prefix of the next word in this
1769                          * command. If this is also the correct entry, return it.
1770                          */
1771                         if (matchnum > state)
1772                                 break;
1773                         ast_free(ret);
1774                         ret = NULL;
1775                 } else if (ast_strlen_zero(e->cmda[dst])) {
1776                         /*
1777                          * This entry is a prefix of the command string entered
1778                          * (only one entry in the list should have this property).
1779                          * Run the generator if one is available. In any case we are done.
1780                          */
1781                         if (e->generator)
1782                                 ret = e->generator(matchstr, word, argindex, state - matchnum);
1783                         else if (e->new_handler) {      /* new style command */
1784                                 struct ast_cli_args a = {
1785                                         .line = matchstr, .word = word,
1786                                         .pos = argindex,
1787                                         .n = state - matchnum };
1788                                 ret = e->new_handler(e, CLI_GENERATE, &a);
1789                         }
1790                         if (ret)
1791                                 break;
1792                 }
1793         }
1794         if (lock)
1795                 AST_LIST_UNLOCK(&helpers);
1796         ast_free(dup);
1797         return ret;
1798 }
1799
1800 char *ast_cli_generator(const char *text, const char *word, int state)
1801 {
1802         return __ast_cli_generator(text, word, state, 1);
1803 }
1804
1805 int ast_cli_command(int fd, const char *s)
1806 {
1807         char *args[AST_MAX_ARGS + 1];
1808         struct ast_cli_entry *e;
1809         int x;
1810         int res;
1811         char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
1812
1813         if (dup == NULL)
1814                 return -1;
1815
1816         if (x < 1)      /* We need at least one entry, otherwise ignore */
1817                 goto done;
1818
1819         AST_LIST_LOCK(&helpers);
1820         e = find_cli(args + 1, 0);
1821         if (e)
1822                 ast_atomic_fetchadd_int(&e->inuse, 1);
1823         AST_LIST_UNLOCK(&helpers);
1824         if (e == NULL) {
1825                 ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1));
1826                 goto done;
1827         }
1828         /*
1829          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
1830          * Remember that the array returned by parse_args is NULL-terminated.
1831          */
1832         args[0] = (char *)e;
1833
1834         if (!e->new_handler)    /* old style */
1835                 res = e->handler(fd, x, args + 1);
1836         else {
1837                 struct ast_cli_args a = {
1838                         .fd = fd, .argc = x, .argv = args+1 };
1839                 char *retval = e->new_handler(e, CLI_HANDLER, &a);
1840
1841                 if (retval == CLI_SUCCESS)
1842                         res = RESULT_SUCCESS;
1843                 else if (retval == CLI_SHOWUSAGE)
1844                         res = RESULT_SHOWUSAGE;
1845                 else
1846                         res = RESULT_FAILURE;
1847         }
1848         switch (res) {
1849         case RESULT_SHOWUSAGE:
1850                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
1851                 AST_LIST_LOCK(&helpers);
1852                 if (e->deprecated)
1853                         ast_cli(fd, "The '%s' command is deprecated and will be removed in a future release. Please use '%s' instead.\n", e->_full_cmd, e->_deprecated_by);
1854                 AST_LIST_UNLOCK(&helpers);
1855                 break;
1856         case RESULT_FAILURE:
1857                 ast_cli(fd, "Command '%s' failed.\n", s);
1858                 /* FALLTHROUGH */
1859         default:
1860                 AST_LIST_LOCK(&helpers);
1861                 if (e->deprecated == 1) {
1862                         ast_cli(fd, "The '%s' command is deprecated and will be removed in a future release. Please use '%s' instead.\n", e->_full_cmd, e->_deprecated_by);
1863                         e->deprecated = 2;
1864                 }
1865                 AST_LIST_UNLOCK(&helpers);
1866                 break;
1867         }
1868         ast_atomic_fetchadd_int(&e->inuse, -1);
1869 done:
1870         ast_free(dup);
1871         return 0;
1872 }