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