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