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