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