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