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