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