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