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