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