move ast_carefulwrite from manager.c to utils.c so that cli.c and
[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)", c->data ? c->data : "",
426                                 S_OR(c->cid.cid_num, ""),
427                                 c->accountcode ? c->accountcode : "", c->amaflags, 
428                                 durbuf, bc ? bc->name : "(None)");
429                 } else if (verbose) {
430                         ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
431                                 c->appl ? c->appl : "(None)", c->data ? S_OR(c->data, "(Empty)" ): "(None)",
432                                 S_OR(c->cid.cid_num, ""), durbuf,
433                                 c->accountcode ? c->accountcode : "", bc ? bc->name : "(None)");
434                 } else {
435                         if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
436                                 snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
437                         else
438                                 strcpy(locbuf, "(None)");
439                         if (c->appl)
440                                 snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, c->data ? c->data : "");
441                         else
442                                 strcpy(appdata, "(None)");
443                         ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
444                 }
445                 numchans++;
446                 ast_channel_unlock(c);
447         }
448         if (!concise) {
449                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
450                 if (option_maxcalls)
451                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
452                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
453                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
454                 else
455                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
456         }
457         return RESULT_SUCCESS;
458         
459 #undef FORMAT_STRING
460 #undef FORMAT_STRING2
461 #undef CONCISE_FORMAT_STRING
462 #undef VERBOSE_FORMAT_STRING
463 #undef VERBOSE_FORMAT_STRING2
464 }
465
466 static char showchan_help[] = 
467 "Usage: show channel <channel>\n"
468 "       Shows lots of information about the specified channel.\n";
469
470 static char debugchan_help[] = 
471 "Usage: debug channel <channel>\n"
472 "       Enables debugging on a specific channel.\n";
473
474 static char debuglevel_help[] = 
475 "Usage: debug level <level> [filename]\n"
476 "       Set debug to specified level (0 to disable).  If filename\n"
477 "is specified, debugging will be limited to just that file.\n";
478
479 static char nodebugchan_help[] = 
480 "Usage: no debug channel <channel>\n"
481 "       Disables debugging on a specific channel.\n";
482
483 static char commandcomplete_help[] = 
484 "Usage: _command complete \"<line>\" text state\n"
485 "       This function is used internally to help with command completion and should.\n"
486 "       never be called by the user directly.\n";
487
488 static char commandnummatches_help[] = 
489 "Usage: _command nummatches \"<line>\" text \n"
490 "       This function is used internally to help with command completion and should.\n"
491 "       never be called by the user directly.\n";
492
493 static char commandmatchesarray_help[] = 
494 "Usage: _command matchesarray \"<line>\" text \n"
495 "       This function is used internally to help with command completion and should.\n"
496 "       never be called by the user directly.\n";
497
498 static int handle_softhangup(int fd, int argc, char *argv[])
499 {
500         struct ast_channel *c=NULL;
501         if (argc != 3)
502                 return RESULT_SHOWUSAGE;
503         c = ast_get_channel_by_name_locked(argv[2]);
504         if (c) {
505                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
506                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
507                 ast_channel_unlock(c);
508         } else
509                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
510         return RESULT_SUCCESS;
511 }
512
513 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
514
515 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
516 {
517         char *buf, *obuf;
518         int buflen = 2048;
519         int len = 0;
520         char **matches;
521         int x, matchlen;
522
523         if (argc != 4)
524                 return RESULT_SHOWUSAGE;
525         if (!(buf = ast_malloc(buflen)))
526                 return RESULT_FAILURE;
527         buf[len] = '\0';
528         matches = ast_cli_completion_matches(argv[2], argv[3]);
529         if (matches) {
530                 for (x=0; matches[x]; x++) {
531                         matchlen = strlen(matches[x]) + 1;
532                         if (len + matchlen >= buflen) {
533                                 buflen += matchlen * 3;
534                                 obuf = buf;
535                                 if (!(buf = ast_realloc(obuf, buflen))) 
536                                         /* Memory allocation failure...  Just free old buffer and be done */
537                                         free(obuf);
538                         }
539                         if (buf)
540                                 len += sprintf( buf + len, "%s ", matches[x]);
541                         free(matches[x]);
542                         matches[x] = NULL;
543                 }
544                 free(matches);
545         }
546
547         if (buf) {
548                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
549                 free(buf);
550         } else
551                 ast_cli(fd, "NULL\n");
552
553         return RESULT_SUCCESS;
554 }
555
556
557
558 static int handle_commandnummatches(int fd, int argc, char *argv[])
559 {
560         int matches = 0;
561
562         if (argc != 4)
563                 return RESULT_SHOWUSAGE;
564
565         matches = ast_cli_generatornummatches(argv[2], argv[3]);
566
567         ast_cli(fd, "%d", matches);
568
569         return RESULT_SUCCESS;
570 }
571
572 static int handle_commandcomplete(int fd, int argc, char *argv[])
573 {
574         char *buf;
575
576         if (argc != 5)
577                 return RESULT_SHOWUSAGE;
578         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
579         if (buf) {
580                 ast_cli(fd, buf);
581                 free(buf);
582         } else
583                 ast_cli(fd, "NULL\n");
584         return RESULT_SUCCESS;
585 }
586
587 static int handle_debuglevel(int fd, int argc, char *argv[])
588 {
589         int newlevel;
590         char *filename = "<any>";
591         if ((argc < 3) || (argc > 4))
592                 return RESULT_SHOWUSAGE;
593         if (sscanf(argv[2], "%d", &newlevel) != 1)
594                 return RESULT_SHOWUSAGE;
595         option_debug = newlevel;
596         if (argc == 4) {
597                 filename = argv[3];
598                 ast_copy_string(debug_filename, filename, sizeof(debug_filename));
599         } else {
600                 debug_filename[0] = '\0';
601         }
602         ast_cli(fd, "Debugging level set to %d, file '%s'\n", newlevel, filename);
603         return RESULT_SUCCESS;
604 }
605
606 /* XXX todo: merge next two functions!!! */
607 static int handle_debugchan(int fd, int argc, char *argv[])
608 {
609         struct ast_channel *c=NULL;
610         int is_all;
611
612         /* 'debug channel {all|chan_id}' */
613         if (argc != 3)
614                 return RESULT_SHOWUSAGE;
615
616         is_all = !strcasecmp("all", argv[2]);
617         if (is_all) {
618                 global_fin |= DEBUGCHAN_FLAG;
619                 global_fout |= DEBUGCHAN_FLAG;
620                 c = ast_channel_walk_locked(NULL);
621         } else {
622                 c = ast_get_channel_by_name_locked(argv[2]);
623                 if (c == NULL)
624                         ast_cli(fd, "No such channel %s\n", argv[2]);
625         }
626         while (c) {
627                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
628                         c->fin |= DEBUGCHAN_FLAG;
629                         c->fout |= DEBUGCHAN_FLAG;
630                         ast_cli(fd, "Debugging enabled on channel %s\n", c->name);
631                 }
632                 ast_channel_unlock(c);
633                 if (!is_all)
634                         break;
635                 c = ast_channel_walk_locked(c);
636         }
637         ast_cli(fd, "Debugging on new channels is enabled\n");
638         return RESULT_SUCCESS;
639 }
640
641 static int handle_nodebugchan(int fd, int argc, char *argv[])
642 {
643         struct ast_channel *c=NULL;
644         int is_all;
645         /* 'no debug channel {all|chan_id}' */
646         if (argc != 4)
647                 return RESULT_SHOWUSAGE;
648         is_all = !strcasecmp("all", argv[3]);
649         if (is_all) {
650                 global_fin &= ~DEBUGCHAN_FLAG;
651                 global_fout &= ~DEBUGCHAN_FLAG;
652                 c = ast_channel_walk_locked(NULL);
653         } else {
654                 c = ast_get_channel_by_name_locked(argv[3]);
655                 if (c == NULL)
656                         ast_cli(fd, "No such channel %s\n", argv[3]);
657         }
658         while(c) {
659                 if ((c->fin & DEBUGCHAN_FLAG) || (c->fout & DEBUGCHAN_FLAG)) {
660                         c->fin &= ~DEBUGCHAN_FLAG;
661                         c->fout &= ~DEBUGCHAN_FLAG;
662                         ast_cli(fd, "Debugging disabled on channel %s\n", c->name);
663                 }
664                 ast_channel_unlock(c);
665                 if (!is_all)
666                         break;
667                 c = ast_channel_walk_locked(c);
668         }
669         ast_cli(fd, "Debugging on new channels is disabled\n");
670         return RESULT_SUCCESS;
671 }
672                 
673 static int handle_showchan(int fd, int argc, char *argv[])
674 {
675         struct ast_channel *c=NULL;
676         struct timeval now;
677         char buf[2048];
678         char cdrtime[256];
679         char nf[256], wf[256], rf[256];
680         long elapsed_seconds=0;
681         int hour=0, min=0, sec=0;
682         
683         if (argc != 3)
684                 return RESULT_SHOWUSAGE;
685         now = ast_tvnow();
686         c = ast_get_channel_by_name_locked(argv[2]);
687         if (!c) {
688                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
689                 return RESULT_SUCCESS;
690         }
691         if(c->cdr) {
692                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
693                 hour = elapsed_seconds / 3600;
694                 min = (elapsed_seconds % 3600) / 60;
695                 sec = elapsed_seconds % 60;
696                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
697         } else
698                 strcpy(cdrtime, "N/A");
699         ast_cli(fd, 
700                 " -- General --\n"
701                 "           Name: %s\n"
702                 "           Type: %s\n"
703                 "       UniqueID: %s\n"
704                 "      Caller ID: %s\n"
705                 " Caller ID Name: %s\n"
706                 "    DNID Digits: %s\n"
707                 "          State: %s (%d)\n"
708                 "          Rings: %d\n"
709                 "  NativeFormats: %s\n"
710                 "    WriteFormat: %s\n"
711                 "     ReadFormat: %s\n"
712                 "1st File Descriptor: %d\n"
713                 "      Frames in: %d%s\n"
714                 "     Frames out: %d%s\n"
715                 " Time to Hangup: %ld\n"
716                 "   Elapsed Time: %s\n"
717                 "  Direct Bridge: %s\n"
718                 "Indirect Bridge: %s\n"
719                 " --   PBX   --\n"
720                 "        Context: %s\n"
721                 "      Extension: %s\n"
722                 "       Priority: %d\n"
723                 "     Call Group: %d\n"
724                 "   Pickup Group: %d\n"
725                 "    Application: %s\n"
726                 "           Data: %s\n"
727                 "    Blocking in: %s\n",
728                 c->name, c->tech->type, c->uniqueid,
729                 S_OR(c->cid.cid_num, "(N/A)"),
730                 S_OR(c->cid.cid_name, "(N/A)"),
731                 S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, 
732                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
733                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
734                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
735                 c->fds[0],
736                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
737                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
738                 (long)c->whentohangup,
739                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
740                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
741                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
742                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
743         
744         if(pbx_builtin_serialize_variables(c,buf,sizeof(buf)))
745                 ast_cli(fd,"      Variables:\n%s\n",buf);
746         if(c->cdr && ast_cdr_serialize_variables(c->cdr,buf, sizeof(buf), '=', '\n', 1))
747                 ast_cli(fd,"  CDR Variables:\n%s\n",buf);
748         
749         ast_channel_unlock(c);
750         return RESULT_SUCCESS;
751 }
752
753 /*
754  * helper function to generate CLI matches from a fixed set of values.
755  * A NULL word is acceptable.
756  */
757 char *ast_cli_complete(const char *word, char *const choices[], int state)
758 {
759         int i, which = 0, len;
760         len = ast_strlen_zero(word) ? 0 : strlen(word);
761
762         for (i = 0; choices[i]; i++) {
763                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
764                         return ast_strdup(choices[i]);
765         }
766         return NULL;
767 }
768
769 static char *complete_show_channels(const char *line, const char *word, int pos, int state)
770 {
771         static char *choices[] = { "concise", "verbose", NULL };
772
773         return (pos != 2) ? NULL : ast_cli_complete(word, choices, state);
774 }
775
776 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
777 {
778         struct ast_channel *c = NULL;
779         int which = 0;
780         int wordlen;
781         char notfound = '\0';
782         char *ret = &notfound; /* so NULL can break the loop */
783
784         if (pos != rpos)
785                 return NULL;
786
787         wordlen = strlen(word); 
788
789         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
790                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
791                         ret = ast_strdup(c->name);
792                 ast_channel_unlock(c);
793         }
794         return ret == &notfound ? NULL : ret;
795 }
796
797 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
798 {
799         return ast_complete_channels(line, word, pos, state, 2);
800 }
801
802 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
803 {
804         return ast_complete_channels(line, word, pos, state, 3);
805 }
806
807 static char *complete_mod_2(const char *line, const char *word, int pos, int state)
808 {
809         return ast_module_helper(line, word, pos, state, 1, 1);
810 }
811
812 static char *complete_mod_4(const char *line, const char *word, int pos, int state)
813 {
814         return ast_module_helper(line, word, pos, state, 3, 0);
815 }
816
817 static char *complete_fn(const char *line, const char *word, int pos, int state)
818 {
819         char *c;
820         char filename[256];
821
822         if (pos != 1)
823                 return NULL;
824         
825         if (word[0] == '/')
826                 ast_copy_string(filename, word, sizeof(filename));
827         else
828                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
829         
830         c = filename_completion_function(filename, state);
831         
832         if (c && word[0] != '/')
833                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
834         
835         return c ? strdup(c) : c;
836 }
837
838 static int group_show_channels(int fd, int argc, char *argv[])
839 {
840 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
841
842         struct ast_channel *c = NULL;
843         int numchans = 0;
844         struct ast_var_t *current;
845         struct varshead *headp;
846         regex_t regexbuf;
847         int havepattern = 0;
848
849         if (argc < 3 || argc > 4)
850                 return RESULT_SHOWUSAGE;
851         
852         if (argc == 4) {
853                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
854                         return RESULT_SHOWUSAGE;
855                 havepattern = 1;
856         }
857
858         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
859         while ( (c = ast_channel_walk_locked(c)) != NULL) {
860                 headp=&c->varshead;
861                 AST_LIST_TRAVERSE(headp,current,entries) {
862                         if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
863                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
864                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current),
865                                                 (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
866                                         numchans++;
867                                 }
868                         } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
869                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
870                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)");
871                                         numchans++;
872                                 }
873                         }
874                 }
875                 numchans++;
876                 ast_channel_unlock(c);
877         }
878
879         if (havepattern)
880                 regfree(&regexbuf);
881
882         ast_cli(fd, "%d active channel%s\n", numchans, (numchans != 1) ? "s" : "");
883         return RESULT_SUCCESS;
884 #undef FORMAT_STRING
885 }
886
887 static int handle_help(int fd, int argc, char *argv[]);
888
889 static char * complete_help(const char *text, const char *word, int pos, int state)
890 {
891         /* skip first 4 or 5 chars, "help "*/
892         int l = strlen(text);
893
894         if (l > 5)
895                 l = 5;
896         text += l;
897         /* XXX watch out, should stop to the non-generator parts */
898         return __ast_cli_generator(text, word, state, 0);
899 }
900
901 static struct ast_cli_entry builtins[] = {
902         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
903         { { "_command", "complete", NULL }, handle_commandcomplete, "Command complete", commandcomplete_help },
904         { { "_command", "nummatches", NULL }, handle_commandnummatches, "Returns number of command matches", commandnummatches_help },
905         { { "_command", "matchesarray", NULL }, handle_commandmatchesarray, "Returns command matches array", commandmatchesarray_help },
906         { { "debug", "channel", NULL }, handle_debugchan, "Enable debugging on a channel", debugchan_help, complete_ch_3 },
907         { { "debug", "level", NULL }, handle_debuglevel, "Set global debug level", debuglevel_help },
908         { { "frog", NULL }, handle_frog,"Perform frog-in-a-blender calculations", frog_help },
909         { { "group", "show", "channels", NULL }, group_show_channels, "Show active channels with group(s)", group_show_channels_help},
910         { { "help", NULL }, handle_help, "Display help list, or specific help on a command", help_help, complete_help },
911         { { "load", NULL }, handle_load, "Load a dynamic module by name", load_help, complete_fn },
912         { { "no", "debug", "channel", NULL }, handle_nodebugchan, "Disable debugging on a channel", nodebugchan_help, complete_ch_4 },
913         { { "reload", NULL }, handle_reload, "Reload configuration", reload_help, complete_mod_2 },
914         { { "set", "debug", NULL }, handle_set_debug, "Set level of debug chattiness", set_debug_help },
915         { { "set", "verbose", NULL }, handle_set_verbose, "Set level of verboseness", set_verbose_help },
916         { { "show", "channel", NULL }, handle_showchan, "Display information on a specific channel", showchan_help, complete_ch_3 },
917         { { "show", "channels", NULL }, handle_chanlist, "Display information on channels", chanlist_help, complete_show_channels },
918         { { "show", "modules", NULL }, handle_modlist, "List modules and info", modlist_help },
919         { { "show", "modules", "like", NULL }, handle_modlist, "List modules and info", modlist_help, complete_mod_4 },
920         { { "show", "uptime", NULL }, handle_showuptime, "Show uptime information", uptime_help },
921         { { "soft", "hangup", NULL }, handle_softhangup, "Request a hangup on a given channel", softhangup_help, complete_ch_3 },
922         { { "unload", NULL }, handle_unload, "Unload a dynamic module by name", unload_help, complete_fn },
923         { { NULL }, NULL, NULL, NULL }
924 };
925
926 /*! \brief initialize the _full_cmd string in * each of the builtins. */
927 void ast_builtins_init(void)
928 {
929         struct ast_cli_entry *e;
930
931         for (e = builtins; e->cmda[0] != NULL; e++) {
932                 char buf[80];
933                 ast_join(buf, sizeof(buf), e->cmda);
934                 e->_full_cmd = strdup(buf);
935                 if (!e->_full_cmd)
936                         ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
937         }
938 }
939
940 /*
941  * We have two sets of commands: builtins are stored in a
942  * NULL-terminated array of ast_cli_entry, whereas external
943  * commands are in a list.
944  * When navigating, we need to keep two pointers and get
945  * the next one in lexicographic order. For the purpose,
946  * we use a structure.
947  */
948
949 struct cli_iterator {
950         struct ast_cli_entry *builtins;
951         struct ast_cli_entry *helpers;
952 };
953
954 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
955 {
956         struct ast_cli_entry *e;
957
958         if (i->builtins == NULL && i->helpers == NULL) {
959                 /* initialize */
960                 i->builtins = builtins;
961                 i->helpers = AST_LIST_FIRST(&helpers);
962         }
963         e = i->builtins; /* temporary */
964         if (!e->cmda[0] || (i->helpers &&
965                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
966                 /* Use helpers */
967                 e = i->helpers;
968                 if (e)
969                         i->helpers = AST_LIST_NEXT(e, list);
970         } else { /* use builtin. e is already set  */
971                 (i->builtins)++;        /* move to next */
972         }
973         return e;
974 }
975
976 /*!
977  * \brief locate a cli command in the 'helpers' list (which must be locked).
978  * exact has 3 values:
979  *      0       returns if the search key is equal or longer than the entry.
980  *      -1      true if the mismatch is on the last word XXX not true!
981  *      1       true only on complete, exact match.
982  */
983 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
984 {
985         int matchlen = -1;      /* length of longest match so far */
986         struct ast_cli_entry *cand = NULL, *e=NULL;
987         struct cli_iterator i = { NULL, NULL};
988
989         while( (e = cli_next(&i)) ) {
990                 int y;
991                 for (y = 0 ; cmds[y] && e->cmda[y]; y++) {
992                         if (strcasecmp(e->cmda[y], cmds[y]))
993                                 break;
994                 }
995                 if (e->cmda[y] == NULL) {       /* no more words in candidate */
996                         if (cmds[y] == NULL)    /* this is an exact match, cannot do better */
997                                 break;
998                         /* here the search key is longer than the candidate */
999                         if (match_type != 0)    /* but we look for almost exact match... */
1000                                 continue;       /* so we skip this one. */
1001                         /* otherwise we like it (case 0) */
1002                 } else {                        /* still words in candidate */
1003                         if (cmds[y] == NULL)    /* search key is shorter, not good */
1004                                 continue;
1005                         /* if we get here, both words exist but there is a mismatch */
1006                         if (match_type == 0)    /* not the one we look for */
1007                                 continue;
1008                         if (match_type == 1)    /* not the one we look for */
1009                                 continue;
1010                         if (cmds[y+1] != NULL || e->cmda[y+1] != NULL)  /* not the one we look for */
1011                                 continue;
1012                         /* we are in case match_type == -1 and mismatch on last word */
1013                 }
1014                 if (cand == NULL || y > matchlen)       /* remember the candidate */
1015                         cand = e;
1016         }
1017         return e ? e : cand;
1018 }
1019
1020 static char *find_best(char *argv[])
1021 {
1022         static char cmdline[80];
1023         int x;
1024         /* See how close we get, then print the candidate */
1025         char *myargv[AST_MAX_CMD_LEN];
1026         for (x=0;x<AST_MAX_CMD_LEN;x++)
1027                 myargv[x]=NULL;
1028         AST_LIST_LOCK(&helpers);
1029         for (x=0;argv[x];x++) {
1030                 myargv[x] = argv[x];
1031                 if (!find_cli(myargv, -1))
1032                         break;
1033         }
1034         AST_LIST_UNLOCK(&helpers);
1035         ast_join(cmdline, sizeof(cmdline), myargv);
1036         return cmdline;
1037 }
1038
1039 int ast_cli_unregister(struct ast_cli_entry *e)
1040 {
1041         if (e->inuse) {
1042                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1043         } else {
1044                 AST_LIST_LOCK(&helpers);
1045                 AST_LIST_REMOVE(&helpers, e, list);
1046                 AST_LIST_UNLOCK(&helpers);
1047         }
1048         return 0;
1049 }
1050
1051 int ast_cli_register(struct ast_cli_entry *e)
1052 {
1053         struct ast_cli_entry *cur;
1054         char fulle[80] ="";
1055         int lf, ret = -1;
1056         
1057         ast_join(fulle, sizeof(fulle), e->cmda);
1058         AST_LIST_LOCK(&helpers);
1059         
1060         if (find_cli(e->cmda, 1)) {
1061                 AST_LIST_UNLOCK(&helpers);
1062                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", fulle);
1063                 goto done;
1064         }
1065         e->_full_cmd = ast_strdup(fulle);
1066         if (!e->_full_cmd)
1067                 goto done;
1068         lf = strlen(fulle);
1069         AST_LIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1070                 int len = strlen(cur->_full_cmd);
1071                 if (lf < len)
1072                         len = lf;
1073                 if (strncasecmp(fulle, cur->_full_cmd, len) < 0) {
1074                         AST_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); 
1075                         break;
1076                 }
1077         }
1078         AST_LIST_TRAVERSE_SAFE_END;
1079
1080         if (!cur)
1081                 AST_LIST_INSERT_TAIL(&helpers, e, list); 
1082         ret = 0;        /* success */
1083
1084 done:
1085         AST_LIST_UNLOCK(&helpers);
1086         
1087         return ret;
1088 }
1089
1090 /*
1091  * register/unregister an array of entries.
1092  */
1093 void ast_cli_register_multiple(struct ast_cli_entry *e, int len)
1094 {
1095         int i;
1096
1097         for (i = 0; i < len; i++)
1098                 ast_cli_register(e + i);
1099 }
1100
1101 void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
1102 {
1103         int i;
1104
1105         for (i = 0; i < len; i++)
1106                 ast_cli_unregister(e + i);
1107 }
1108
1109
1110 /*! \brief helper for help_workhorse and final part of
1111  * handle_help. if locked = 0 it's just help_workhorse,
1112  * otherwise assume the list is already locked and print
1113  * an error message if not found.
1114  */
1115 static int help1(int fd, char *match[], int locked)
1116 {
1117         char matchstr[80] = "";
1118         struct ast_cli_entry *e;
1119         int len = 0;
1120         int found = 0;
1121         struct cli_iterator i = { NULL, NULL};
1122
1123         if (match) {
1124                 ast_join(matchstr, sizeof(matchstr), match);
1125                 len = strlen(matchstr);
1126         }
1127         if (!locked)
1128                 AST_LIST_LOCK(&helpers);
1129         while ( (e = cli_next(&i)) ) {
1130                 /* Hide commands that start with '_' */
1131                 if (e->_full_cmd[0] == '_')
1132                         continue;
1133                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
1134                         continue;
1135                 ast_cli(fd, "%25.25s  %s\n", e->_full_cmd, e->summary);
1136                 found++;
1137         }
1138         AST_LIST_UNLOCK(&helpers);
1139         if (!locked && !found && matchstr[0])
1140                 ast_cli(fd, "No such command '%s'.\n", matchstr);
1141         return 0;
1142 }
1143
1144 static int help_workhorse(int fd, char *match[])
1145 {
1146         return help1(fd, match, 0 /* do not print errors */);
1147 }
1148
1149 static int handle_help(int fd, int argc, char *argv[])
1150 {
1151         char fullcmd[80];
1152         struct ast_cli_entry *e;
1153
1154         if (argc < 1)
1155                 return RESULT_SHOWUSAGE;
1156         if (argc == 1)
1157                 return help_workhorse(fd, NULL);
1158
1159         AST_LIST_LOCK(&helpers);
1160         e = find_cli(argv + 1, 1);      /* try exact match first */
1161         if (!e)
1162                 return help1(fd, argv + 1, 1 /* locked */);
1163         if (e->usage)
1164                 ast_cli(fd, "%s", e->usage);
1165         else {
1166                 ast_join(fullcmd, sizeof(fullcmd), argv+1);
1167                 ast_cli(fd, "No help text available for '%s'.\n", fullcmd);
1168         }
1169         AST_LIST_UNLOCK(&helpers);
1170         return RESULT_SUCCESS;
1171 }
1172
1173 static char *parse_args(const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
1174 {
1175         char *dup, *cur;
1176         int x = 0;
1177         int quoted = 0;
1178         int escaped = 0;
1179         int whitespace = 1;
1180
1181         *trailingwhitespace = 0;
1182         if (s == NULL)  /* invalid, though! */
1183                 return NULL;
1184         /* make a copy to store the parsed string */
1185         if (!(dup = strdup(s)))
1186                 return NULL;
1187
1188         cur = dup;
1189         /* scan the original string copying into cur when needed */
1190         for (; *s ; s++) {
1191                 if (x >= max - 1) {
1192                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1193                         break;
1194                 }
1195                 if (*s == '"' && !escaped) {
1196                         quoted = !quoted;
1197                         if (quoted && whitespace) {
1198                                 /* start a quoted string from previous whitespace: new argument */
1199                                 argv[x++] = cur;
1200                                 whitespace = 0;
1201                         }
1202                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1203                         /* If we are not already in whitespace, and not in a quoted string or
1204                            processing an escape sequence, and just entered whitespace, then
1205                            finalize the previous argument and remember that we are in whitespace
1206                         */
1207                         if (!whitespace) {
1208                                 *cur++ = '\0';
1209                                 whitespace = 1;
1210                         }
1211                 } else if (*s == '\\' && !escaped) {
1212                         escaped = 1;
1213                 } else {
1214                         if (whitespace) {
1215                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1216                                 argv[x++] = cur;
1217                                 whitespace = 0;
1218                         }
1219                         *cur++ = *s;
1220                         escaped = 0;
1221                 }
1222         }
1223         /* Null terminate */
1224         *cur++ = '\0';
1225         /* XXX put a NULL in the last argument, because some functions that take
1226          * the array may want a null-terminated array.
1227          * argc still reflects the number of non-NULL entries.
1228          */
1229         argv[x] = NULL;
1230         *argc = x;
1231         *trailingwhitespace = whitespace;
1232         return dup;
1233 }
1234
1235 /*! \brief Return the number of unique matches for the generator */
1236 int ast_cli_generatornummatches(const char *text, const char *word)
1237 {
1238         int matches = 0, i = 0;
1239         char *buf = NULL, *oldbuf = NULL;
1240
1241         while ((buf = ast_cli_generator(text, word, i++))) {
1242                 if (!oldbuf || strcmp(buf,oldbuf))
1243                         matches++;
1244                 if (oldbuf)
1245                         free(oldbuf);
1246                 oldbuf = buf;
1247         }
1248         if (oldbuf)
1249                 free(oldbuf);
1250         return matches;
1251 }
1252
1253 char **ast_cli_completion_matches(const char *text, const char *word)
1254 {
1255         char **match_list = NULL, *retstr, *prevstr;
1256         size_t match_list_len, max_equal, which, i;
1257         int matches = 0;
1258
1259         /* leave entry 0 free for the longest common substring */
1260         match_list_len = 1;
1261         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1262                 if (matches + 1 >= match_list_len) {
1263                         match_list_len <<= 1;
1264                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1265                                 return NULL;
1266                 }
1267                 match_list[++matches] = retstr;
1268         }
1269
1270         if (!match_list)
1271                 return match_list; /* NULL */
1272
1273         /* Find the longest substring that is common to all results
1274          * (it is a candidate for completion), and store a copy in entry 0.
1275          */
1276         prevstr = match_list[1];
1277         max_equal = strlen(prevstr);
1278         for (which = 2; which <= matches; which++) {
1279                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1280                         continue;
1281                 max_equal = i;
1282         }
1283
1284         if (!(retstr = ast_malloc(max_equal + 1)))
1285                 return NULL;
1286         
1287         strncpy(retstr, match_list[1], max_equal);
1288         retstr[max_equal] = '\0';
1289         match_list[0] = retstr;
1290
1291         /* ensure that the array is NULL terminated */
1292         if (matches + 1 >= match_list_len) {
1293                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1294                         return NULL;
1295         }
1296         match_list[matches + 1] = NULL;
1297
1298         return match_list;
1299 }
1300
1301 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1302 {
1303         char *argv[AST_MAX_ARGS];
1304         struct ast_cli_entry *e;
1305         struct cli_iterator i = { NULL, NULL };
1306         int x = 0, argindex, matchlen;
1307         int matchnum=0;
1308         char *ret = NULL;
1309         char matchstr[80] = "";
1310         int tws;
1311         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1312
1313         if (!dup)       /* error */
1314                 return NULL;
1315         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1316         /* rebuild the command, ignore tws */
1317         ast_join(matchstr, sizeof(matchstr)-1, argv);
1318         if (tws)
1319                 strcat(matchstr, " "); /* XXX */
1320         matchlen = strlen(matchstr);
1321         if (lock)
1322                 AST_LIST_LOCK(&helpers);
1323         while( !ret && (e = cli_next(&i)) ) {
1324                 int lc = strlen(e->_full_cmd);
1325                 if (e->_full_cmd[0] != '_' && lc > 0 && matchlen <= lc &&
1326                                 !strncasecmp(matchstr, e->_full_cmd, matchlen)) {
1327                         /* Found initial part, return a copy of the next word... */
1328                         if (e->cmda[argindex] && ++matchnum > state)
1329                                 ret = strdup(e->cmda[argindex]); /* we need a malloced string */
1330                 } else if (e->generator && !strncasecmp(matchstr, e->_full_cmd, lc) && matchstr[lc] < 33) {
1331                         /* We have a command in its entirity within us -- theoretically only one
1332                            command can have this occur */
1333                         ret = e->generator(matchstr, word, argindex, state);
1334                 }
1335         }
1336         if (lock)
1337                 AST_LIST_UNLOCK(&helpers);
1338         free(dup);
1339         return ret;
1340 }
1341
1342 char *ast_cli_generator(const char *text, const char *word, int state)
1343 {
1344         return __ast_cli_generator(text, word, state, 1);
1345 }
1346
1347 int ast_cli_command(int fd, const char *s)
1348 {
1349         char *argv[AST_MAX_ARGS];
1350         struct ast_cli_entry *e;
1351         int x;
1352         char *dup;
1353         int tws;
1354         
1355         if (!(dup = parse_args(s, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws))) {
1356                 ast_log(LOG_ERROR, "Memory allocation failure\n");
1357                 return -1;
1358         }
1359
1360         /* We need at least one entry, or ignore */
1361         if (x > 0) {
1362                 AST_LIST_LOCK(&helpers);
1363                 e = find_cli(argv, 0);
1364                 if (e)
1365                         e->inuse++;
1366                 AST_LIST_UNLOCK(&helpers);
1367                 if (e) {
1368                         switch(e->handler(fd, x, argv)) {
1369                         case RESULT_SHOWUSAGE:
1370                                 if (e->usage)
1371                                         ast_cli(fd, "%s", e->usage);
1372                                 else
1373                                         ast_cli(fd, "Invalid usage, but no usage information available.\n");
1374                                 break;
1375                         }
1376                 } else 
1377                         ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(argv));
1378                 if (e) {
1379                         AST_LIST_LOCK(&helpers);
1380                         e->inuse--;     /* XXX here an atomic dec would suffice */
1381                         AST_LIST_UNLOCK(&helpers);
1382                 }
1383         }
1384         free(dup);
1385         
1386         return 0;
1387 }