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