Return module show to a working state. (issue #8353 reported by jserve)
[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 debug_help[] = 
115 "Usage: core set debug <level> [filename]\n"
116 "       Sets level of core debug messages to be displayed.  0 means\n"
117 "       no messages should be displayed.  Equivalent to -d[d[d...]]\n"
118 "       on startup.  If filename is specified, debugging will be\n"
119 "       limited to just that file.\n";
120
121 static char nodebug_help[] = 
122 "Usage: core set debug off\n"
123 "       Turns off core debug messages.\n";
124
125 static char logger_mute_help[] = 
126 "Usage: logger mute\n"
127 "       Disables logging output to the current console, making it possible to\n"
128 "       gather information without being disturbed by scrolling lines.\n";
129
130 static char softhangup_help[] =
131 "Usage: soft hangup <channel>\n"
132 "       Request that a channel be hung up. The hangup takes effect\n"
133 "       the next time the driver reads or writes from the channel\n";
134
135 static char group_show_channels_help[] = 
136 "Usage: group show channels [pattern]\n"
137 "       Lists all currently active channels with channel group(s) specified.\n"
138 "       Optional regular expression pattern is matched to group names for each\n"
139 "       channel.\n";
140
141 static int handle_load_deprecated(int fd, int argc, char *argv[])
142 {
143         if (argc != 2)
144                 return RESULT_SHOWUSAGE;
145         if (ast_load_resource(argv[1])) {
146                 ast_cli(fd, "Unable to load module %s\n", argv[1]);
147                 return RESULT_FAILURE;
148         }
149         return RESULT_SUCCESS;
150 }
151
152 static int handle_load(int fd, int argc, char *argv[])
153 {
154         if (argc != 3)
155                 return RESULT_SHOWUSAGE;
156         if (ast_load_resource(argv[2])) {
157                 ast_cli(fd, "Unable to load module %s\n", argv[2]);
158                 return RESULT_FAILURE;
159         }
160         return RESULT_SUCCESS;
161 }
162
163 static int handle_reload_deprecated(int fd, int argc, char *argv[])
164 {
165         int x;
166         int res;
167         if (argc < 1)
168                 return RESULT_SHOWUSAGE;
169         if (argc > 1) { 
170                 for (x = 1; x < argc; x++) {
171                         res = ast_module_reload(argv[x]);
172                         switch(res) {
173                         case 0:
174                                 ast_cli(fd, "No such module '%s'\n", argv[x]);
175                                 break;
176                         case 1:
177                                 ast_cli(fd, "Module '%s' does not support reload\n", argv[x]);
178                                 break;
179                         }
180                 }
181         } else
182                 ast_module_reload(NULL);
183         return RESULT_SUCCESS;
184 }
185
186 static int handle_reload(int fd, int argc, char *argv[])
187 {
188         int x;
189         int res;
190         if (argc < 2)
191                 return RESULT_SHOWUSAGE;
192         if (argc > 2) { 
193                 for (x = 2; x < argc; x++) {
194                         res = ast_module_reload(argv[x]);
195                         switch(res) {
196                         case 0:
197                                 ast_cli(fd, "No such module '%s'\n", argv[x]);
198                                 break;
199                         case 1:
200                                 ast_cli(fd, "Module '%s' does not support reload\n", argv[x]);
201                                 break;
202                         }
203                 }
204         } else
205                 ast_module_reload(NULL);
206         return RESULT_SUCCESS;
207 }
208
209 static int handle_verbose(int fd, int argc, char *argv[])
210 {
211         int oldval = option_verbose;
212         int newlevel;
213         int atleast = 0;
214
215         if ((argc < 4) || (argc > 5))
216                 return RESULT_SHOWUSAGE;
217
218         if (!strcasecmp(argv[3], "atleast"))
219                 atleast = 1;
220
221         if (!atleast) {
222                 if (argc > 4)
223                         return RESULT_SHOWUSAGE;
224
225                 option_verbose = atoi(argv[3]);
226         } else {
227                 if (argc < 5)
228                         return RESULT_SHOWUSAGE;
229
230                 newlevel = atoi(argv[4]);
231                 if (newlevel > option_verbose)
232                         option_verbose = newlevel;
233         }
234         if (oldval > 0 && option_verbose == 0)
235                 ast_cli(fd, "Verbosity is now OFF\n");
236         else if (option_verbose > 0) {
237                 if (oldval == option_verbose)
238                         ast_cli(fd, "Verbosity is at least %d\n", option_verbose);
239                 else
240                         ast_cli(fd, "Verbosity was %d and is now %d\n", oldval, option_verbose);
241         }
242
243         return RESULT_SUCCESS;
244 }
245
246 static int handle_set_debug(int fd, int argc, char *argv[])
247 {
248         int oldval = option_debug;
249         int newlevel;
250         int atleast = 0;
251         char *filename = '\0';
252
253         /* 'core set debug <level>'
254          * 'core set debug <level> <fn>'
255          * 'core set debug atleast <level>'
256          * 'core set debug atleast <level> <fn>'
257          */
258         if ((argc < 4) || (argc > 6))
259                 return RESULT_SHOWUSAGE;
260
261         if (!strcasecmp(argv[3], "atleast"))
262                 atleast = 1;
263
264         if (!atleast) {
265                 if (argc > 5)
266                         return RESULT_SHOWUSAGE;
267
268                 if (sscanf(argv[3], "%d", &newlevel) != 1)
269                         return RESULT_SHOWUSAGE;
270
271                 if (argc == 4) {
272                         debug_filename[0] = '\0';
273                 } else {
274                         filename = argv[4];
275                         ast_copy_string(debug_filename, filename, sizeof(debug_filename));
276                 }
277
278                 option_debug = newlevel;
279         } else {
280                 if (argc < 5 || argc > 6)
281                         return RESULT_SHOWUSAGE;
282
283                 if (sscanf(argv[4], "%d", &newlevel) != 1)
284                         return RESULT_SHOWUSAGE;
285
286                 if (argc == 5) {
287                         debug_filename[0] = '\0';
288                 } else {
289                         filename = argv[5];
290                         ast_copy_string(debug_filename, filename, sizeof(debug_filename));
291                 }
292
293                 if (newlevel > option_debug)
294                         option_debug = newlevel;
295         }
296
297         if (oldval > 0 && option_debug == 0)
298                 ast_cli(fd, "Core debug is now OFF\n");
299         else if (option_debug > 0) {
300                 if (filename) {
301                         if (oldval == option_debug)
302                                 ast_cli(fd, "Core debug is at least %d, file '%s'\n", option_debug, filename);
303                         else
304                                 ast_cli(fd, "Core debug was %d and is now %d, file '%s'\n", oldval, option_debug, filename);
305                 } else {
306                         if (oldval == option_debug)
307                                 ast_cli(fd, "Core debug is at least %d\n", option_debug);
308                         else
309                                 ast_cli(fd, "Core debug was %d and is now %d\n", oldval, option_debug);
310                 }
311         }
312
313         return RESULT_SUCCESS;
314 }
315
316 static int handle_nodebug(int fd, int argc, char *argv[])
317 {
318         int oldval = option_debug;
319         if (argc != 4)
320                 return RESULT_SHOWUSAGE;
321
322         option_debug = 0;
323         debug_filename[0] = '\0';
324
325         if (oldval > 0)
326                 ast_cli(fd, "Core debug is now OFF\n");
327         return RESULT_SUCCESS;
328 }
329
330 static int handle_logger_mute(int fd, int argc, char *argv[])
331 {
332         if (argc != 2)
333                 return RESULT_SHOWUSAGE;
334         ast_console_toggle_mute(fd);
335         return RESULT_SUCCESS;
336 }
337
338 static int handle_unload_deprecated(int fd, int argc, char *argv[])
339 {
340         int x;
341         int force = AST_FORCE_SOFT;
342         if (argc < 2)
343                 return RESULT_SHOWUSAGE;
344         for (x = 1; x < argc; x++) {
345                 if (argv[x][0] == '-') {
346                         switch(argv[x][1]) {
347                         case 'f':
348                                 force = AST_FORCE_FIRM;
349                                 break;
350                         case 'h':
351                                 force = AST_FORCE_HARD;
352                                 break;
353                         default:
354                                 return RESULT_SHOWUSAGE;
355                         }
356                 } else if (x != argc - 1) 
357                         return RESULT_SHOWUSAGE;
358                 else if (ast_unload_resource(argv[x], force)) {
359                         ast_cli(fd, "Unable to unload resource %s\n", argv[x]);
360                         return RESULT_FAILURE;
361                 }
362         }
363         return RESULT_SUCCESS;
364 }
365
366 static int handle_unload(int fd, int argc, char *argv[])
367 {
368         int x;
369         int force = AST_FORCE_SOFT;
370         if (argc < 3)
371                 return RESULT_SHOWUSAGE;
372         for (x = 2; x < argc; x++) {
373                 if (argv[x][0] == '-') {
374                         switch(argv[x][1]) {
375                         case 'f':
376                                 force = AST_FORCE_FIRM;
377                                 break;
378                         case 'h':
379                                 force = AST_FORCE_HARD;
380                                 break;
381                         default:
382                                 return RESULT_SHOWUSAGE;
383                         }
384                 } else if (x != argc - 1) 
385                         return RESULT_SHOWUSAGE;
386                 else if (ast_unload_resource(argv[x], force)) {
387                         ast_cli(fd, "Unable to unload resource %s\n", argv[x]);
388                         return RESULT_FAILURE;
389                 }
390         }
391         return RESULT_SUCCESS;
392 }
393
394 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d\n"
395 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s\n"
396
397 AST_MUTEX_DEFINE_STATIC(climodentrylock);
398 static int climodentryfd = -1;
399
400 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *like)
401 {
402         /* Comparing the like with the module */
403         if (strcasestr(module, like) ) {
404                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt);
405                 return 1;
406         } 
407         return 0;
408 }
409
410 static char modlist_help[] =
411 "Usage: module show [like keyword]\n"
412 "       Shows Asterisk modules currently in use, and usage statistics.\n";
413
414 static char uptime_help[] =
415 "Usage: core show uptime [seconds]\n"
416 "       Shows Asterisk uptime information.\n"
417 "       The seconds word returns the uptime in seconds only.\n";
418
419 static void print_uptimestr(int fd, time_t timeval, const char *prefix, int printsec)
420 {
421         int x; /* the main part - years, weeks, etc. */
422         char timestr[256]="", *s = timestr;
423         size_t maxbytes = sizeof(timestr);
424
425 #define SECOND (1)
426 #define MINUTE (SECOND*60)
427 #define HOUR (MINUTE*60)
428 #define DAY (HOUR*24)
429 #define WEEK (DAY*7)
430 #define YEAR (DAY*365)
431 #define ESS(x) ((x == 1) ? "" : "s")    /* plural suffix */
432 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
433         if (timeval < 0)        /* invalid, nothing to show */
434                 return;
435         if (printsec)  {        /* plain seconds output */
436                 ast_build_string(&s, &maxbytes, "%lu", (u_long)timeval);
437                 timeval = 0; /* bypass the other cases */
438         }
439         if (timeval > YEAR) {
440                 x = (timeval / YEAR);
441                 timeval -= (x * YEAR);
442                 ast_build_string(&s, &maxbytes, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval));
443         }
444         if (timeval > WEEK) {
445                 x = (timeval / WEEK);
446                 timeval -= (x * WEEK);
447                 ast_build_string(&s, &maxbytes, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval));
448         }
449         if (timeval > DAY) {
450                 x = (timeval / DAY);
451                 timeval -= (x * DAY);
452                 ast_build_string(&s, &maxbytes, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval));
453         }
454         if (timeval > HOUR) {
455                 x = (timeval / HOUR);
456                 timeval -= (x * HOUR);
457                 ast_build_string(&s, &maxbytes, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval));
458         }
459         if (timeval > MINUTE) {
460                 x = (timeval / MINUTE);
461                 timeval -= (x * MINUTE);
462                 ast_build_string(&s, &maxbytes, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval));
463         }
464         x = timeval;
465         if (x > 0)
466                 ast_build_string(&s, &maxbytes, "%d second%s ", x, ESS(x));
467         if (timestr[0] != '\0')
468                 ast_cli(fd, "%s: %s\n", prefix, timestr);
469 }
470
471 static int handle_showuptime(int fd, int argc, char *argv[])
472 {
473         /* 'show uptime [seconds]' */
474         time_t curtime = time(NULL);
475         int printsec = (argc == 4 && !strcasecmp(argv[3],"seconds"));
476
477         if (argc != 3 && !printsec)
478                 return RESULT_SHOWUSAGE;
479         if (ast_startuptime)
480                 print_uptimestr(fd, curtime - ast_startuptime, "System uptime", printsec);
481         if (ast_lastreloadtime)
482                 print_uptimestr(fd, curtime - ast_lastreloadtime, "Last reload", printsec);
483         return RESULT_SUCCESS;
484 }
485
486 /* core show modules [like keyword] */
487 static int handle_modlist(int fd, int argc, char *argv[])
488 {
489         char *like = "";
490         if (argc != 2 && argc != 4)
491                 return RESULT_SHOWUSAGE;
492         else if (argc == 4) {
493                 if (strcmp(argv[2],"like")) 
494                         return RESULT_SHOWUSAGE;
495                 like = argv[3];
496         }
497                 
498         ast_mutex_lock(&climodentrylock);
499         climodentryfd = fd; /* global, protected by climodentrylock */
500         ast_cli(fd, MODLIST_FORMAT2, "Module", "Description", "Use Count");
501         ast_cli(fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
502         climodentryfd = -1;
503         ast_mutex_unlock(&climodentrylock);
504         return RESULT_SUCCESS;
505 }
506 #undef MODLIST_FORMAT
507 #undef MODLIST_FORMAT2
508
509 /* core show channels [concise|verbose] */
510 static int handle_chanlist(int fd, int argc, char *argv[])
511 {
512 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
513 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
514 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
515 #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"
516 #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"
517
518         struct ast_channel *c = NULL;
519         char durbuf[10] = "-";
520         char locbuf[40];
521         char appdata[40];
522         int duration;
523         int durh, durm, durs;
524         int numchans = 0, concise = 0, verbose = 0;
525
526         concise = (argc == 4 && (!strcasecmp(argv[3],"concise")));
527         verbose = (argc == 4 && (!strcasecmp(argv[3],"verbose")));
528
529         if (argc < 3 || argc > 4 || (argc == 4 && !concise && !verbose))
530                 return RESULT_SHOWUSAGE;
531
532         if (!concise && !verbose)
533                 ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
534         else if (verbose)
535                 ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
536                         "CallerID", "Duration", "Accountcode", "BridgedTo");
537
538         while ((c = ast_channel_walk_locked(c)) != NULL) {
539                 struct ast_channel *bc = ast_bridged_channel(c);
540                 if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
541                         duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
542                         if (verbose) {
543                                 durh = duration / 3600;
544                                 durm = (duration % 3600) / 60;
545                                 durs = duration % 60;
546                                 snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
547                         } else {
548                                 snprintf(durbuf, sizeof(durbuf), "%d", duration);
549                         }                               
550                 } else {
551                         durbuf[0] = '\0';
552                 }
553                 if (concise) {
554                         ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
555                                 c->appl ? c->appl : "(None)",
556                                 S_OR(c->data, ""),      /* XXX different from verbose ? */
557                                 S_OR(c->cid.cid_num, ""),
558                                 S_OR(c->accountcode, ""),
559                                 c->amaflags, 
560                                 durbuf,
561                                 bc ? bc->name : "(None)");
562                 } else if (verbose) {
563                         ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
564                                 c->appl ? c->appl : "(None)",
565                                 c->data ? S_OR(c->data, "(Empty)" ): "(None)",
566                                 S_OR(c->cid.cid_num, ""),
567                                 durbuf,
568                                 S_OR(c->accountcode, ""),
569                                 bc ? bc->name : "(None)");
570                 } else {
571                         if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
572                                 snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
573                         else
574                                 strcpy(locbuf, "(None)");
575                         if (c->appl)
576                                 snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, c->data ? c->data : "");
577                         else
578                                 strcpy(appdata, "(None)");
579                         ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
580                 }
581                 numchans++;
582                 ast_channel_unlock(c);
583         }
584         if (!concise) {
585                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
586                 if (option_maxcalls)
587                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
588                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
589                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
590                 else
591                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
592         }
593         return RESULT_SUCCESS;
594         
595 #undef FORMAT_STRING
596 #undef FORMAT_STRING2
597 #undef CONCISE_FORMAT_STRING
598 #undef VERBOSE_FORMAT_STRING
599 #undef VERBOSE_FORMAT_STRING2
600 }
601
602 static char showchan_help[] = 
603 "Usage: core show channel <channel>\n"
604 "       Shows lots of information about the specified channel.\n";
605
606 static char debugchan_help[] = 
607 "Usage: core set debug channel <channel> [off]\n"
608 "       Enables/disables debugging on a specific channel.\n";
609
610 static char commandcomplete_help[] = 
611 "Usage: _command complete \"<line>\" text state\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 char commandnummatches_help[] = 
616 "Usage: _command nummatches \"<line>\" text \n"
617 "       This function is used internally to help with command completion and should.\n"
618 "       never be called by the user directly.\n";
619
620 static char commandmatchesarray_help[] = 
621 "Usage: _command matchesarray \"<line>\" text \n"
622 "       This function is used internally to help with command completion and should.\n"
623 "       never be called by the user directly.\n";
624
625 static int handle_softhangup(int fd, int argc, char *argv[])
626 {
627         struct ast_channel *c=NULL;
628         if (argc != 3)
629                 return RESULT_SHOWUSAGE;
630         c = ast_get_channel_by_name_locked(argv[2]);
631         if (c) {
632                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
633                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
634                 ast_channel_unlock(c);
635         } else
636                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
637         return RESULT_SUCCESS;
638 }
639
640 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
641
642 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
643 {
644         char *buf, *obuf;
645         int buflen = 2048;
646         int len = 0;
647         char **matches;
648         int x, matchlen;
649
650         if (argc != 4)
651                 return RESULT_SHOWUSAGE;
652         if (!(buf = ast_malloc(buflen)))
653                 return RESULT_FAILURE;
654         buf[len] = '\0';
655         matches = ast_cli_completion_matches(argv[2], argv[3]);
656         if (matches) {
657                 for (x=0; matches[x]; x++) {
658                         matchlen = strlen(matches[x]) + 1;
659                         if (len + matchlen >= buflen) {
660                                 buflen += matchlen * 3;
661                                 obuf = buf;
662                                 if (!(buf = ast_realloc(obuf, buflen))) 
663                                         /* Memory allocation failure...  Just free old buffer and be done */
664                                         free(obuf);
665                         }
666                         if (buf)
667                                 len += sprintf( buf + len, "%s ", matches[x]);
668                         free(matches[x]);
669                         matches[x] = NULL;
670                 }
671                 free(matches);
672         }
673
674         if (buf) {
675                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
676                 free(buf);
677         } else
678                 ast_cli(fd, "NULL\n");
679
680         return RESULT_SUCCESS;
681 }
682
683
684
685 static int handle_commandnummatches(int fd, int argc, char *argv[])
686 {
687         int matches = 0;
688
689         if (argc != 4)
690                 return RESULT_SHOWUSAGE;
691
692         matches = ast_cli_generatornummatches(argv[2], argv[3]);
693
694         ast_cli(fd, "%d", matches);
695
696         return RESULT_SUCCESS;
697 }
698
699 static int handle_commandcomplete(int fd, int argc, char *argv[])
700 {
701         char *buf;
702
703         if (argc != 5)
704                 return RESULT_SHOWUSAGE;
705         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
706         if (buf) {
707                 ast_cli(fd, buf);
708                 free(buf);
709         } else
710                 ast_cli(fd, "NULL\n");
711         return RESULT_SUCCESS;
712 }
713
714 static int handle_debugchan_deprecated(int fd, int argc, char *argv[])
715 {
716         struct ast_channel *c=NULL;
717         int is_all;
718
719         /* 'debug channel {all|chan_id}' */
720         if (argc != 4)
721                 return RESULT_SHOWUSAGE;
722
723         is_all = !strcasecmp("all", argv[3]);
724         if (is_all) {
725                 global_fin |= DEBUGCHAN_FLAG;
726                 global_fout |= DEBUGCHAN_FLAG;
727                 c = ast_channel_walk_locked(NULL);
728         } else {
729                 c = ast_get_channel_by_name_locked(argv[3]);
730                 if (c == NULL)
731                         ast_cli(fd, "No such channel %s\n", argv[3]);
732         }
733         while (c) {
734                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
735                         c->fin |= DEBUGCHAN_FLAG;
736                         c->fout |= DEBUGCHAN_FLAG;
737                         ast_cli(fd, "Debugging enabled on channel %s\n", c->name);
738                 }
739                 ast_channel_unlock(c);
740                 if (!is_all)
741                         break;
742                 c = ast_channel_walk_locked(c);
743         }
744         ast_cli(fd, "Debugging on new channels is enabled\n");
745         return RESULT_SUCCESS;
746 }
747
748 static int handle_core_set_debug_channel(int fd, int argc, char *argv[])
749 {
750         struct ast_channel *c = NULL;
751         int is_all, is_off = 0;
752
753         /* 'core set debug channel {all|chan_id}' */
754         if (argc == 6 && strcmp(argv[5], "off") == 0)
755                 is_off = 1;
756         else if (argc != 5)
757                 return RESULT_SHOWUSAGE;
758
759         is_all = !strcasecmp("all", argv[4]);
760         if (is_all) {
761                 if (is_off) {
762                         global_fin &= ~DEBUGCHAN_FLAG;
763                         global_fout &= ~DEBUGCHAN_FLAG;
764                 } else {
765                         global_fin |= DEBUGCHAN_FLAG;
766                         global_fout |= DEBUGCHAN_FLAG;
767                 }
768                 c = ast_channel_walk_locked(NULL);
769         } else {
770                 c = ast_get_channel_by_name_locked(argv[4]);
771                 if (c == NULL)
772                         ast_cli(fd, "No such channel %s\n", argv[4]);
773         }
774         while (c) {
775                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
776                         if (is_off) {
777                                 c->fin &= ~DEBUGCHAN_FLAG;
778                                 c->fout &= ~DEBUGCHAN_FLAG;
779                         } else {
780                                 c->fin |= DEBUGCHAN_FLAG;
781                                 c->fout |= DEBUGCHAN_FLAG;
782                         }
783                         ast_cli(fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
784                 }
785                 ast_channel_unlock(c);
786                 if (!is_all)
787                         break;
788                 c = ast_channel_walk_locked(c);
789         }
790         ast_cli(fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
791         return RESULT_SUCCESS;
792 }
793
794 static int handle_nodebugchan_deprecated(int fd, int argc, char *argv[])
795 {
796         struct ast_channel *c=NULL;
797         int is_all;
798         /* 'no debug channel {all|chan_id}' */
799         if (argc != 4)
800                 return RESULT_SHOWUSAGE;
801         is_all = !strcasecmp("all", argv[3]);
802         if (is_all) {
803                 global_fin &= ~DEBUGCHAN_FLAG;
804                 global_fout &= ~DEBUGCHAN_FLAG;
805                 c = ast_channel_walk_locked(NULL);
806         } else {
807                 c = ast_get_channel_by_name_locked(argv[3]);
808                 if (c == NULL)
809                         ast_cli(fd, "No such channel %s\n", argv[3]);
810         }
811         while(c) {
812                 if ((c->fin & DEBUGCHAN_FLAG) || (c->fout & DEBUGCHAN_FLAG)) {
813                         c->fin &= ~DEBUGCHAN_FLAG;
814                         c->fout &= ~DEBUGCHAN_FLAG;
815                         ast_cli(fd, "Debugging disabled on channel %s\n", c->name);
816                 }
817                 ast_channel_unlock(c);
818                 if (!is_all)
819                         break;
820                 c = ast_channel_walk_locked(c);
821         }
822         ast_cli(fd, "Debugging on new channels is disabled\n");
823         return RESULT_SUCCESS;
824 }
825                 
826 static int handle_showchan(int fd, int argc, char *argv[])
827 {
828         struct ast_channel *c=NULL;
829         struct timeval now;
830         char buf[2048];
831         char cdrtime[256];
832         char nf[256], wf[256], rf[256];
833         long elapsed_seconds=0;
834         int hour=0, min=0, sec=0;
835         
836         if (argc != 4)
837                 return RESULT_SHOWUSAGE;
838         now = ast_tvnow();
839         c = ast_get_channel_by_name_locked(argv[3]);
840         if (!c) {
841                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
842                 return RESULT_SUCCESS;
843         }
844         if(c->cdr) {
845                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
846                 hour = elapsed_seconds / 3600;
847                 min = (elapsed_seconds % 3600) / 60;
848                 sec = elapsed_seconds % 60;
849                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
850         } else
851                 strcpy(cdrtime, "N/A");
852         ast_cli(fd, 
853                 " -- General --\n"
854                 "           Name: %s\n"
855                 "           Type: %s\n"
856                 "       UniqueID: %s\n"
857                 "      Caller ID: %s\n"
858                 " Caller ID Name: %s\n"
859                 "    DNID Digits: %s\n"
860                 "          State: %s (%d)\n"
861                 "          Rings: %d\n"
862                 "  NativeFormats: %s\n"
863                 "    WriteFormat: %s\n"
864                 "     ReadFormat: %s\n"
865                 " WriteTranscode: %s\n"
866                 "  ReadTranscode: %s\n"
867                 "1st File Descriptor: %d\n"
868                 "      Frames in: %d%s\n"
869                 "     Frames out: %d%s\n"
870                 " Time to Hangup: %ld\n"
871                 "   Elapsed Time: %s\n"
872                 "  Direct Bridge: %s\n"
873                 "Indirect Bridge: %s\n"
874                 " --   PBX   --\n"
875                 "        Context: %s\n"
876                 "      Extension: %s\n"
877                 "       Priority: %d\n"
878                 "     Call Group: %llu\n"
879                 "   Pickup Group: %llu\n"
880                 "    Application: %s\n"
881                 "           Data: %s\n"
882                 "    Blocking in: %s\n",
883                 c->name, c->tech->type, c->uniqueid,
884                 S_OR(c->cid.cid_num, "(N/A)"),
885                 S_OR(c->cid.cid_name, "(N/A)"),
886                 S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, 
887                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
888                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
889                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
890                 c->writetrans ? "Yes" : "No",
891                 c->readtrans ? "Yes" : "No",
892                 c->fds[0],
893                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
894                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
895                 (long)c->whentohangup,
896                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
897                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
898                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
899                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
900         
901         if(pbx_builtin_serialize_variables(c,buf,sizeof(buf)))
902                 ast_cli(fd,"      Variables:\n%s\n",buf);
903         if(c->cdr && ast_cdr_serialize_variables(c->cdr,buf, sizeof(buf), '=', '\n', 1))
904                 ast_cli(fd,"  CDR Variables:\n%s\n",buf);
905         
906         ast_channel_unlock(c);
907         return RESULT_SUCCESS;
908 }
909
910 /*
911  * helper function to generate CLI matches from a fixed set of values.
912  * A NULL word is acceptable.
913  */
914 char *ast_cli_complete(const char *word, char *const choices[], int state)
915 {
916         int i, which = 0, len;
917         len = ast_strlen_zero(word) ? 0 : strlen(word);
918
919         for (i = 0; choices[i]; i++) {
920                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
921                         return ast_strdup(choices[i]);
922         }
923         return NULL;
924 }
925
926 static char *complete_show_channels(const char *line, const char *word, int pos, int state)
927 {
928         static char *choices[] = { "concise", "verbose", NULL };
929
930         return (pos != 3) ? NULL : ast_cli_complete(word, choices, state);
931 }
932
933 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
934 {
935         struct ast_channel *c = NULL;
936         int which = 0;
937         int wordlen;
938         char notfound = '\0';
939         char *ret = &notfound; /* so NULL can break the loop */
940
941         if (pos != rpos)
942                 return NULL;
943
944         wordlen = strlen(word); 
945
946         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
947                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
948                         ret = ast_strdup(c->name);
949                 ast_channel_unlock(c);
950         }
951         return ret == &notfound ? NULL : ret;
952 }
953
954 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
955 {
956         return ast_complete_channels(line, word, pos, state, 2);
957 }
958
959 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
960 {
961         return ast_complete_channels(line, word, pos, state, 3);
962 }
963
964 static char *complete_ch_5(const char *line, const char *word, int pos, int state)
965 {
966         return ast_complete_channels(line, word, pos, state, 4);
967 }
968
969 static char *complete_mod_2(const char *line, const char *word, int pos, int state)
970 {
971         return ast_module_helper(line, word, pos, state, 1, 1);
972 }
973
974 static char *complete_mod_3_nr(const char *line, const char *word, int pos, int state)
975 {
976         return ast_module_helper(line, word, pos, state, 2, 0);
977 }
978
979 static char *complete_mod_3(const char *line, const char *word, int pos, int state)
980 {
981         return ast_module_helper(line, word, pos, state, 2, 1);
982 }
983
984 static char *complete_mod_4(const char *line, const char *word, int pos, int state)
985 {
986         return ast_module_helper(line, word, pos, state, 3, 0);
987 }
988
989 static char *complete_fn(const char *line, const char *word, int pos, int state)
990 {
991         char *c;
992         char filename[256];
993
994         if (pos != 1)
995                 return NULL;
996         
997         if (word[0] == '/')
998                 ast_copy_string(filename, word, sizeof(filename));
999         else
1000                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
1001         
1002         c = filename_completion_function(filename, state);
1003         
1004         if (c && word[0] != '/')
1005                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
1006         
1007         return c ? strdup(c) : c;
1008 }
1009
1010 static int group_show_channels(int fd, int argc, char *argv[])
1011 {
1012 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
1013
1014         struct ast_channel *c = NULL;
1015         int numchans = 0;
1016         struct ast_var_t *current;
1017         struct varshead *headp;
1018         regex_t regexbuf;
1019         int havepattern = 0;
1020
1021         if (argc < 3 || argc > 4)
1022                 return RESULT_SHOWUSAGE;
1023         
1024         if (argc == 4) {
1025                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
1026                         return RESULT_SHOWUSAGE;
1027                 havepattern = 1;
1028         }
1029
1030         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
1031         while ( (c = ast_channel_walk_locked(c)) != NULL) {
1032                 headp=&c->varshead;
1033                 AST_LIST_TRAVERSE(headp,current,entries) {
1034                         if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
1035                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
1036                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current),
1037                                                 (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
1038                                         numchans++;
1039                                 }
1040                         } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
1041                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
1042                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)");
1043                                         numchans++;
1044                                 }
1045                         }
1046                 }
1047                 numchans++;
1048                 ast_channel_unlock(c);
1049         }
1050
1051         if (havepattern)
1052                 regfree(&regexbuf);
1053
1054         ast_cli(fd, "%d active channel%s\n", numchans, (numchans != 1) ? "s" : "");
1055         return RESULT_SUCCESS;
1056 #undef FORMAT_STRING
1057 }
1058
1059 static int handle_help(int fd, int argc, char *argv[]);
1060
1061 static char * complete_help(const char *text, const char *word, int pos, int state)
1062 {
1063         /* skip first 4 or 5 chars, "help "*/
1064         int l = strlen(text);
1065
1066         if (l > 5)
1067                 l = 5;
1068         text += l;
1069         /* XXX watch out, should stop to the non-generator parts */
1070         return __ast_cli_generator(text, word, state, 0);
1071 }
1072
1073 /* XXX Nothing in this array can currently be deprecated...
1074    You have to change the way find_cli works in order to remove this array
1075    I recommend doing this eventually...
1076  */
1077 static struct ast_cli_entry builtins[] = {
1078         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
1079         { { "_command", "complete", NULL },
1080         handle_commandcomplete, "Command complete",
1081         commandcomplete_help },
1082
1083         { { "_command", "nummatches", NULL },
1084         handle_commandnummatches, "Returns number of command matches",
1085         commandnummatches_help },
1086
1087         { { "_command", "matchesarray", NULL },
1088         handle_commandmatchesarray, "Returns command matches array",
1089         commandmatchesarray_help },
1090
1091         { { NULL }, NULL, NULL, NULL }
1092 };
1093
1094 static struct ast_cli_entry cli_debug_channel_deprecated = {
1095         { "debug", "channel", NULL },
1096         handle_debugchan_deprecated, NULL,
1097         NULL, complete_ch_3 };
1098
1099 static struct ast_cli_entry cli_module_load_deprecated = {
1100         { "load", NULL },
1101         handle_load_deprecated, NULL,
1102         NULL, complete_fn };
1103
1104 static struct ast_cli_entry cli_module_reload_deprecated = {
1105         { "reload", NULL },
1106         handle_reload_deprecated, NULL,
1107         NULL, complete_mod_2 };
1108
1109 static struct ast_cli_entry cli_module_unload_deprecated = {
1110         { "unload", NULL },
1111         handle_unload_deprecated, NULL,
1112         NULL, complete_mod_2 };
1113
1114 static struct ast_cli_entry cli_cli[] = {
1115         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1116         { { "no", "debug", "channel", NULL },
1117         handle_nodebugchan_deprecated, NULL,
1118         NULL, complete_ch_4 },
1119
1120         { { "core", "show", "channels", NULL },
1121         handle_chanlist, "Display information on channels",
1122         chanlist_help, complete_show_channels },
1123
1124         { { "core", "show", "channel", NULL },
1125         handle_showchan, "Display information on a specific channel",
1126         showchan_help, complete_ch_4 },
1127
1128         { { "core", "set", "debug", "channel", NULL },
1129         handle_core_set_debug_channel, "Enable/disable debugging on a channel",
1130         debugchan_help, complete_ch_5, &cli_debug_channel_deprecated },
1131
1132         { { "core", "set", "debug", NULL },
1133         handle_set_debug, "Set level of debug chattiness",
1134         debug_help },
1135
1136         { { "core", "set", "debug", "off", NULL },
1137         handle_nodebug, "Turns off debug chattiness",
1138         nodebug_help },
1139
1140         { { "core", "set", "verbose", NULL },
1141         handle_verbose, "Set level of verboseness",
1142         verbose_help },
1143
1144         { { "group", "show", "channels", NULL },
1145         group_show_channels, "Display active channels with group(s)",
1146         group_show_channels_help },
1147
1148         { { "help", NULL },
1149         handle_help, "Display help list, or specific help on a command",
1150         help_help, complete_help },
1151
1152         { { "logger", "mute", NULL },
1153         handle_logger_mute, "Toggle logging output to a console",
1154         logger_mute_help },
1155
1156         { { "module", "show", NULL },
1157         handle_modlist, "List modules and info",
1158         modlist_help },
1159
1160         { { "module", "show", "like", NULL },
1161         handle_modlist, "List modules and info",
1162         modlist_help, complete_mod_4 },
1163
1164         { { "module", "load", NULL },
1165         handle_load, "Load a module by name",
1166         load_help, complete_fn, &cli_module_load_deprecated },
1167
1168         { { "module", "reload", NULL },
1169         handle_reload, "Reload configuration",
1170         reload_help, complete_mod_3, &cli_module_reload_deprecated },
1171
1172         { { "module", "unload", NULL },
1173         handle_unload, "Unload a module by name",
1174         unload_help, complete_mod_3_nr, &cli_module_unload_deprecated },
1175
1176         { { "core", "show", "uptime", NULL },
1177         handle_showuptime, "Show uptime information",
1178         uptime_help },
1179
1180         { { "soft", "hangup", NULL },
1181         handle_softhangup, "Request a hangup on a given channel",
1182         softhangup_help, complete_ch_3 },
1183 };
1184
1185 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1186 void ast_builtins_init(void)
1187 {
1188         struct ast_cli_entry *e;
1189
1190         for (e = builtins; e->cmda[0] != NULL; e++) {
1191                 char buf[80];
1192                 ast_join(buf, sizeof(buf), e->cmda);
1193                 e->_full_cmd = strdup(buf);
1194                 if (!e->_full_cmd)
1195                         ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1196         }
1197
1198         ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry));
1199 }
1200
1201 /*
1202  * We have two sets of commands: builtins are stored in a
1203  * NULL-terminated array of ast_cli_entry, whereas external
1204  * commands are in a list.
1205  * When navigating, we need to keep two pointers and get
1206  * the next one in lexicographic order. For the purpose,
1207  * we use a structure.
1208  */
1209
1210 struct cli_iterator {
1211         struct ast_cli_entry *builtins;
1212         struct ast_cli_entry *helpers;
1213 };
1214
1215 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
1216 {
1217         struct ast_cli_entry *e;
1218
1219         if (i->builtins == NULL && i->helpers == NULL) {
1220                 /* initialize */
1221                 i->builtins = builtins;
1222                 i->helpers = AST_LIST_FIRST(&helpers);
1223         }
1224         e = i->builtins; /* temporary */
1225         if (!e->cmda[0] || (i->helpers &&
1226                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
1227                 /* Use helpers */
1228                 e = i->helpers;
1229                 if (e)
1230                         i->helpers = AST_LIST_NEXT(e, list);
1231         } else { /* use builtin. e is already set  */
1232                 (i->builtins)++;        /* move to next */
1233         }
1234         return e;
1235 }
1236
1237 /*!
1238  * \brief locate a cli command in the 'helpers' list (which must be locked).
1239  * exact has 3 values:
1240  *      0       returns if the search key is equal or longer than the entry.
1241  *      -1      true if the mismatch is on the last word XXX not true!
1242  *      1       true only on complete, exact match.
1243  */
1244 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
1245 {
1246         int matchlen = -1;      /* length of longest match so far */
1247         struct ast_cli_entry *cand = NULL, *e=NULL;
1248         struct cli_iterator i = { NULL, NULL};
1249
1250         while( (e = cli_next(&i)) ) {
1251                 int y;
1252                 for (y = 0 ; cmds[y] && e->cmda[y]; y++) {
1253                         if (strcasecmp(e->cmda[y], cmds[y]))
1254                                 break;
1255                 }
1256                 if (e->cmda[y] == NULL) {       /* no more words in candidate */
1257                         if (cmds[y] == NULL)    /* this is an exact match, cannot do better */
1258                                 break;
1259                         /* here the search key is longer than the candidate */
1260                         if (match_type != 0)    /* but we look for almost exact match... */
1261                                 continue;       /* so we skip this one. */
1262                         /* otherwise we like it (case 0) */
1263                 } else {                        /* still words in candidate */
1264                         if (cmds[y] == NULL)    /* search key is shorter, not good */
1265                                 continue;
1266                         /* if we get here, both words exist but there is a mismatch */
1267                         if (match_type == 0)    /* not the one we look for */
1268                                 continue;
1269                         if (match_type == 1)    /* not the one we look for */
1270                                 continue;
1271                         if (cmds[y+1] != NULL || e->cmda[y+1] != NULL)  /* not the one we look for */
1272                                 continue;
1273                         /* we are in case match_type == -1 and mismatch on last word */
1274                 }
1275                 if (cand == NULL || y > matchlen)       /* remember the candidate */
1276                         cand = e;
1277         }
1278         return e ? e : cand;
1279 }
1280
1281 static char *find_best(char *argv[])
1282 {
1283         static char cmdline[80];
1284         int x;
1285         /* See how close we get, then print the candidate */
1286         char *myargv[AST_MAX_CMD_LEN];
1287         for (x=0;x<AST_MAX_CMD_LEN;x++)
1288                 myargv[x]=NULL;
1289         AST_LIST_LOCK(&helpers);
1290         for (x=0;argv[x];x++) {
1291                 myargv[x] = argv[x];
1292                 if (!find_cli(myargv, -1))
1293                         break;
1294         }
1295         AST_LIST_UNLOCK(&helpers);
1296         ast_join(cmdline, sizeof(cmdline), myargv);
1297         return cmdline;
1298 }
1299
1300 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1301 {
1302         if (e->deprecate_cmd) {
1303                 __ast_cli_unregister(e->deprecate_cmd, e);
1304         }
1305         if (e->inuse) {
1306                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1307         } else {
1308                 AST_LIST_LOCK(&helpers);
1309                 AST_LIST_REMOVE(&helpers, e, list);
1310                 AST_LIST_UNLOCK(&helpers);
1311                 free(e->_full_cmd);
1312         }
1313         return 0;
1314 }
1315
1316 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1317 {
1318         struct ast_cli_entry *cur;
1319         char fulle[80] ="";
1320         int lf, ret = -1;
1321         
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, e->summary);
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                         /* We have a command in its entirity within us -- theoretically only one
1636                            command can have this occur */
1637                         if (e->generator)
1638                                 ret = e->generator(matchstr, word, argindex, state);
1639                         break;
1640                 }
1641         }
1642         if (lock)
1643                 AST_LIST_UNLOCK(&helpers);
1644         free(dup);
1645         return ret;
1646 }
1647
1648 char *ast_cli_generator(const char *text, const char *word, int state)
1649 {
1650         return __ast_cli_generator(text, word, state, 1);
1651 }
1652
1653 int ast_cli_command(int fd, const char *s)
1654 {
1655         char *argv[AST_MAX_ARGS];
1656         struct ast_cli_entry *e;
1657         int x;
1658         char *dup;
1659         int tws;
1660         
1661         if (!(dup = parse_args(s, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws)))
1662                 return -1;
1663
1664         /* We need at least one entry, or ignore */
1665         if (x > 0) {
1666                 AST_LIST_LOCK(&helpers);
1667                 e = find_cli(argv, 0);
1668                 if (e)
1669                         e->inuse++;
1670                 AST_LIST_UNLOCK(&helpers);
1671                 if (e) {
1672                         switch(e->handler(fd, x, argv)) {
1673                         case RESULT_SHOWUSAGE:
1674                                 if (e->usage)
1675                                         ast_cli(fd, "%s", e->usage);
1676                                 else
1677                                         ast_cli(fd, "Invalid usage, but no usage information available.\n");
1678                                 break;
1679                         default:
1680                                 AST_LIST_LOCK(&helpers);
1681                                 if (e->deprecated == 1) {
1682                                         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);
1683                                         e->deprecated = 2;
1684                                 }
1685                                 AST_LIST_UNLOCK(&helpers);
1686                                 break;
1687                         }
1688                 } else 
1689                         ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(argv));
1690                 if (e)
1691                         ast_atomic_fetchadd_int(&e->inuse, -1);
1692         }
1693         free(dup);
1694         
1695         return 0;
1696 }