convert "help" to new style,
[asterisk/asterisk.git] / main / 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 #include "asterisk/module.h"
44 #include "asterisk/pbx.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/app.h"
48 #include "asterisk/lock.h"
49 #include "editline/readline/readline.h"
50 #include "asterisk/threadstorage.h"
51
52 extern unsigned long global_fin, global_fout;
53
54 AST_THREADSTORAGE(ast_cli_buf);
55
56 /*! \brief Initial buffer size for resulting strings in ast_cli() */
57 #define AST_CLI_INITLEN   256
58
59 void ast_cli(int fd, char *fmt, ...)
60 {
61         int res;
62         struct ast_dynamic_str *buf;
63         va_list ap;
64
65         if (!(buf = ast_dynamic_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
66                 return;
67
68         va_start(ap, fmt);
69         res = ast_dynamic_str_thread_set_va(&buf, 0, &ast_cli_buf, fmt, ap);
70         va_end(ap);
71
72         if (res != AST_DYNSTR_BUILD_FAILED)
73                 ast_carefulwrite(fd, buf->str, strlen(buf->str), 100);
74 }
75
76 static AST_LIST_HEAD_STATIC(helpers, ast_cli_entry);
77
78 static char logger_mute_help[] = 
79 "Usage: logger mute\n"
80 "       Disables logging output to the current console, making it possible to\n"
81 "       gather information without being disturbed by scrolling lines.\n";
82
83 static char softhangup_help[] =
84 "Usage: soft hangup <channel>\n"
85 "       Request that a channel be hung up. The hangup takes effect\n"
86 "       the next time the driver reads or writes from the channel\n";
87
88 static char group_show_channels_help[] = 
89 "Usage: group show channels [pattern]\n"
90 "       Lists all currently active channels with channel group(s) specified.\n"
91 "       Optional regular expression pattern is matched to group names for each\n"
92 "       channel.\n";
93
94 static char *complete_fn(const char *word, int state)
95 {
96         char *c;
97         char filename[256];
98
99         if (word[0] == '/')
100                 ast_copy_string(filename, word, sizeof(filename));
101         else
102                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
103
104         /* XXX the following function is not reentrant, so we better not use it */
105         c = filename_completion_function(filename, state);
106         
107         if (c && word[0] != '/')
108                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
109         
110         return c ? strdup(c) : c;
111 }
112
113 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
114 {
115         /* "module load <mod>" */
116         switch (cmd) {
117         case CLI_INIT:
118                 e->command = "module load";
119                 e->usage =
120                         "Usage: module load <module name>\n"
121                         "       Loads the specified module into Asterisk.\n";
122                 return NULL;
123
124         case CLI_GENERATE:
125                 if (a->argc != e->args + 1)
126                         return NULL;
127                 return complete_fn(a->word, a->n);
128         }
129         if (a->argc != e->args + 1)
130                 return CLI_SHOWUSAGE;
131         if (ast_load_resource(a->argv[e->args])) {
132                 ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
133                 return CLI_FAILURE;
134         }
135         return CLI_SUCCESS;
136 }
137
138 static char *handle_load_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
139 {
140         char *res = handle_load(e, cmd, a);
141         if (cmd == CLI_INIT)
142                 e->command = "load";
143         return res;
144 }
145
146 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
147 {
148         int x;
149
150         switch (cmd) {
151         case CLI_INIT:
152                 e->command = "module reload";
153                 e->usage =
154                         "Usage: module reload [module ...]\n"
155                         "       Reloads configuration files for all listed modules which support\n"
156                         "       reloading, or for all supported modules if none are listed.\n";
157                 return NULL;
158
159         case CLI_GENERATE:
160                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1);
161         }
162         if (a->argc == e->args) {
163                 ast_module_reload(NULL);
164                 return CLI_SUCCESS;
165         }
166         for (x = e->args; x < a->argc; x++) {
167                 int res = ast_module_reload(a->argv[x]);
168                 /* XXX reload has multiple error returns, including -1 on error and 2 on success */
169                 switch(res) {
170                 case 0:
171                         ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
172                         break;
173                 case 1:
174                         ast_cli(a->fd, "Module '%s' does not support reload\n", a->argv[x]);
175                         break;
176                 }
177         }
178         return CLI_SUCCESS;
179 }
180
181 static char *handle_reload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
182 {
183         char *s = handle_reload(e, cmd, a);
184         if (cmd == CLI_INIT)            /* override command name */
185                 e->command = "reload";
186         return s;
187 }
188
189 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
190 {
191         int oldval = option_verbose;
192         int newlevel;
193         int atleast = 0;
194         int fd = a->fd;
195         int argc = a->argc;
196         char **argv = a->argv;
197         int *dst;
198         char *what;
199
200         switch (cmd) {
201         case CLI_INIT:
202                 e->command = "core set {debug|verbose} [off|atleast]";
203                 e->usage =
204                         "Usage: core set {debug|verbose} [atleast] <level>\n"
205                         "       core set {debug|verbose} off\n"
206                         "       Sets level of debug or verbose messages to be displayed.\n"
207                         "       0 or off means no messages should be displayed.\n"
208                         "       Equivalent to -d[d[...]] or -v[v[v...]] on startup\n";
209                 return NULL;
210
211         case CLI_GENERATE:
212                 return NULL;
213         }
214         /* all the above return, so we proceed with the handler.
215          * we are guaranteed to be called with argc >= e->args;
216          */
217
218         if (argc < e->args)
219                 return CLI_SHOWUSAGE;
220         if (!strcasecmp(argv[e->args - 2], "debug")) {
221                 dst = &option_debug;
222                 what = "Core debug";
223         } else {
224                 dst = &option_verbose;
225                 what = "Verbosity";
226         }
227         if (argc == e->args && !strcasecmp(argv[e->args - 1], "off")) {
228                 newlevel = 0;
229                 goto done;
230         }
231         if (!strcasecmp(argv[e->args-1], "atleast"))
232                 atleast = 1;
233         if (argc != e->args + atleast)
234                 return CLI_SHOWUSAGE;
235         if (sscanf(argv[e->args + atleast - 1], "%d", &newlevel) != 1)
236                 return CLI_SHOWUSAGE;
237
238 done:
239         if (!atleast || newlevel > *dst)
240                 *dst = newlevel;
241         if (oldval > 0 && *dst == 0)
242                 ast_cli(fd, "%s is now OFF\n", what);
243         else if (*dst > 0) {
244                 if (oldval == *dst)
245                         ast_cli(fd, "%s is at least %d\n", what, *dst);
246                 else
247                         ast_cli(fd, "%s was %d and is now %d\n", what, oldval, *dst);
248         }
249
250         return CLI_SUCCESS;
251 }
252
253 static int handle_logger_mute(int fd, int argc, char *argv[])
254 {
255         if (argc != 2)
256                 return RESULT_SHOWUSAGE;
257         ast_console_toggle_mute(fd);
258         return RESULT_SUCCESS;
259 }
260
261 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
262 {
263         /* "module unload mod_1 [mod_2 .. mod_N]" */
264         int x;
265         int force = AST_FORCE_SOFT;
266         char *s;
267
268         switch (cmd) {
269         case CLI_INIT:
270                 e->command = "module unload";
271                 e->usage =
272                         "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
273                         "       Unloads the specified module from Asterisk. The -f\n"
274                         "       option causes the module to be unloaded even if it is\n"
275                         "       in use (may cause a crash) and the -h module causes the\n"
276                         "       module to be unloaded even if the module says it cannot, \n"
277                         "       which almost always will cause a crash.\n";
278                 return NULL;
279
280         case CLI_GENERATE:
281                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
282         }
283         if (a->argc < e->args + 1)
284                 return CLI_SHOWUSAGE;
285         x = e->args;    /* first argument */
286         s = a->argv[x];
287         if (s[0] == '-') {
288                 if (s[1] == 'f')
289                         force = AST_FORCE_FIRM;
290                 else if (s[1] == 'h')
291                         force = AST_FORCE_HARD;
292                 else
293                         return CLI_SHOWUSAGE;
294                 if (a->argc < e->args + 2)      /* need at least one module name */
295                         return CLI_SHOWUSAGE;
296                 x++;    /* skip this argument */
297         }
298
299         for (; x < a->argc; x++) {
300                 if (ast_unload_resource(a->argv[x], force)) {
301                         ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
302                         return CLI_FAILURE;
303                 }
304         }
305         return CLI_SUCCESS;
306 }
307
308 static char *handle_unload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
309 {
310         char *res = handle_unload(e, cmd, a);
311         if (cmd == CLI_INIT)
312                 e->command = "unload";  /* XXX override */
313         return res;
314 }
315
316 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d\n"
317 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s\n"
318
319 AST_MUTEX_DEFINE_STATIC(climodentrylock);
320 static int climodentryfd = -1;
321
322 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *like)
323 {
324         /* Comparing the like with the module */
325         if (strcasestr(module, like) ) {
326                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt);
327                 return 1;
328         } 
329         return 0;
330 }
331
332 static void print_uptimestr(int fd, time_t timeval, const char *prefix, int printsec)
333 {
334         int x; /* the main part - years, weeks, etc. */
335         char timestr[256]="", *s = timestr;
336         size_t maxbytes = sizeof(timestr);
337
338 #define SECOND (1)
339 #define MINUTE (SECOND*60)
340 #define HOUR (MINUTE*60)
341 #define DAY (HOUR*24)
342 #define WEEK (DAY*7)
343 #define YEAR (DAY*365)
344 #define ESS(x) ((x == 1) ? "" : "s")    /* plural suffix */
345 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
346         if (timeval < 0)        /* invalid, nothing to show */
347                 return;
348         if (printsec)  {        /* plain seconds output */
349                 ast_build_string(&s, &maxbytes, "%lu", (u_long)timeval);
350                 timeval = 0; /* bypass the other cases */
351         }
352         if (timeval > YEAR) {
353                 x = (timeval / YEAR);
354                 timeval -= (x * YEAR);
355                 ast_build_string(&s, &maxbytes, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval));
356         }
357         if (timeval > WEEK) {
358                 x = (timeval / WEEK);
359                 timeval -= (x * WEEK);
360                 ast_build_string(&s, &maxbytes, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval));
361         }
362         if (timeval > DAY) {
363                 x = (timeval / DAY);
364                 timeval -= (x * DAY);
365                 ast_build_string(&s, &maxbytes, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval));
366         }
367         if (timeval > HOUR) {
368                 x = (timeval / HOUR);
369                 timeval -= (x * HOUR);
370                 ast_build_string(&s, &maxbytes, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval));
371         }
372         if (timeval > MINUTE) {
373                 x = (timeval / MINUTE);
374                 timeval -= (x * MINUTE);
375                 ast_build_string(&s, &maxbytes, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval));
376         }
377         x = timeval;
378         if (x > 0)
379                 ast_build_string(&s, &maxbytes, "%d second%s ", x, ESS(x));
380         if (timestr[0] != '\0')
381                 ast_cli(fd, "%s: %s\n", prefix, timestr);
382 }
383
384 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
385 {
386         time_t curtime;
387         int printsec;
388
389         switch (cmd) {
390         case CLI_INIT:
391                 e->command = "core show uptime";
392                 e->usage =
393                         "Usage: core show uptime [seconds]\n"
394                         "       Shows Asterisk uptime information.\n"
395                         "       The seconds word returns the uptime in seconds only.\n";
396                 return NULL;
397
398         case CLI_GENERATE:
399                 return (a->pos > e->args || a->n > 0) ? NULL : "seconds";
400         }
401         /* regular handler */
402         if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
403                 printsec = 1;
404         else if (a->argc == e->args)
405                 printsec = 0;
406         else
407                 return CLI_SHOWUSAGE;
408         curtime = time(NULL);
409         if (ast_startuptime)
410                 print_uptimestr(a->fd, curtime - ast_startuptime, "System uptime", printsec);
411         if (ast_lastreloadtime)
412                 print_uptimestr(a->fd, curtime - ast_lastreloadtime, "Last reload", printsec);
413         return CLI_SUCCESS;
414 }
415
416 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
417 {
418         char *like;
419
420         switch (cmd) {
421         case CLI_INIT:
422                 e->command = "module show [like]";
423                 e->usage =
424                         "Usage: module show [like keyword]\n"
425                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
426                 return NULL;
427
428         case CLI_GENERATE:
429                 if (a->pos == e->args)
430                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
431                 else
432                         return NULL;
433         }
434         /* all the above return, so we proceed with the handler.
435          * we are guaranteed to have argc >= e->args
436          */
437         if (a->argc == e->args - 1)
438                 like = "";
439         else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
440                 like = a->argv[e->args];
441         else
442                 return CLI_SHOWUSAGE;
443                 
444         ast_mutex_lock(&climodentrylock);
445         climodentryfd = a->fd; /* global, protected by climodentrylock */
446         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count");
447         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
448         climodentryfd = -1;
449         ast_mutex_unlock(&climodentrylock);
450         return RESULT_SUCCESS;
451 }
452 #undef MODLIST_FORMAT
453 #undef MODLIST_FORMAT2
454
455 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
456 {
457 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
458 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
459 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
460 #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"
461 #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"
462
463         struct ast_channel *c = NULL;
464         int numchans = 0, concise = 0, verbose = 0;
465         int fd, argc;
466         char **argv;
467
468         switch (cmd) {
469         case CLI_INIT:
470                 e->command = "core show channels [concise|verbose]";
471                 e->usage =
472                         "Usage: core show channels [concise|verbose]\n"
473                         "       Lists currently defined channels and some information about them. If\n"
474                         "       'concise' is specified, the format is abridged and in a more easily\n"
475                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
476                         "       more and longer fields.\n";
477                 return NULL;
478
479         case CLI_GENERATE:
480                 return NULL;
481         }
482         fd = a->fd;
483         argc = a->argc;
484         argv = a->argv;
485
486         if (a->argc == e->args) {
487                 if (!strcasecmp(argv[e->args-1],"concise"))
488                         concise = 1;
489                 else if (!strcasecmp(argv[e->args-1],"verbose"))
490                         verbose = 1;
491                 else
492                         return CLI_SHOWUSAGE;
493         } else if (a->argc != e->args - 1)
494                 return CLI_SHOWUSAGE;
495
496         if (!concise && !verbose)
497                 ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
498         else if (verbose)
499                 ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
500                         "CallerID", "Duration", "Accountcode", "BridgedTo");
501
502         while ((c = ast_channel_walk_locked(c)) != NULL) {
503                 struct ast_channel *bc = ast_bridged_channel(c);
504                 char durbuf[10] = "-";
505
506                 if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
507                         int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
508                         if (verbose) {
509                                 int durh = duration / 3600;
510                                 int durm = (duration % 3600) / 60;
511                                 int durs = duration % 60;
512                                 snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
513                         } else {
514                                 snprintf(durbuf, sizeof(durbuf), "%d", duration);
515                         }                               
516                 }
517                 if (concise) {
518                         ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
519                                 c->appl ? c->appl : "(None)",
520                                 S_OR(c->data, ""),      /* XXX different from verbose ? */
521                                 S_OR(c->cid.cid_num, ""),
522                                 S_OR(c->accountcode, ""),
523                                 c->amaflags, 
524                                 durbuf,
525                                 bc ? bc->name : "(None)");
526                 } else if (verbose) {
527                         ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
528                                 c->appl ? c->appl : "(None)",
529                                 c->data ? S_OR(c->data, "(Empty)" ): "(None)",
530                                 S_OR(c->cid.cid_num, ""),
531                                 durbuf,
532                                 S_OR(c->accountcode, ""),
533                                 bc ? bc->name : "(None)");
534                 } else {
535                         char locbuf[40] = "(None)";
536                         char appdata[40] = "(None)";
537
538                         if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
539                                 snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
540                         if (c->appl)
541                                 snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
542                         ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
543                 }
544                 numchans++;
545                 ast_channel_unlock(c);
546         }
547         if (!concise) {
548                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
549                 if (option_maxcalls)
550                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
551                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
552                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
553                 else
554                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
555         }
556         return CLI_SUCCESS;
557         
558 #undef FORMAT_STRING
559 #undef FORMAT_STRING2
560 #undef CONCISE_FORMAT_STRING
561 #undef VERBOSE_FORMAT_STRING
562 #undef VERBOSE_FORMAT_STRING2
563 }
564
565 static char showchan_help[] = 
566 "Usage: core show channel <channel>\n"
567 "       Shows lots of information about the specified channel.\n";
568
569 static char commandcomplete_help[] = 
570 "Usage: _command complete \"<line>\" text state\n"
571 "       This function is used internally to help with command completion and should.\n"
572 "       never be called by the user directly.\n";
573
574 static char commandnummatches_help[] = 
575 "Usage: _command nummatches \"<line>\" text \n"
576 "       This function is used internally to help with command completion and should.\n"
577 "       never be called by the user directly.\n";
578
579 static char commandmatchesarray_help[] = 
580 "Usage: _command matchesarray \"<line>\" text \n"
581 "       This function is used internally to help with command completion and should.\n"
582 "       never be called by the user directly.\n";
583
584 static int handle_softhangup(int fd, int argc, char *argv[])
585 {
586         struct ast_channel *c=NULL;
587         if (argc != 3)
588                 return RESULT_SHOWUSAGE;
589         c = ast_get_channel_by_name_locked(argv[2]);
590         if (c) {
591                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
592                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
593                 ast_channel_unlock(c);
594         } else
595                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
596         return RESULT_SUCCESS;
597 }
598
599 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
600
601 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
602 {
603         char *buf, *obuf;
604         int buflen = 2048;
605         int len = 0;
606         char **matches;
607         int x, matchlen;
608
609         if (argc != 4)
610                 return RESULT_SHOWUSAGE;
611         if (!(buf = ast_malloc(buflen)))
612                 return RESULT_FAILURE;
613         buf[len] = '\0';
614         matches = ast_cli_completion_matches(argv[2], argv[3]);
615         if (matches) {
616                 for (x=0; matches[x]; x++) {
617                         matchlen = strlen(matches[x]) + 1;
618                         if (len + matchlen >= buflen) {
619                                 buflen += matchlen * 3;
620                                 obuf = buf;
621                                 if (!(buf = ast_realloc(obuf, buflen))) 
622                                         /* Memory allocation failure...  Just free old buffer and be done */
623                                         free(obuf);
624                         }
625                         if (buf)
626                                 len += sprintf( buf + len, "%s ", matches[x]);
627                         free(matches[x]);
628                         matches[x] = NULL;
629                 }
630                 free(matches);
631         }
632
633         if (buf) {
634                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
635                 free(buf);
636         } else
637                 ast_cli(fd, "NULL\n");
638
639         return RESULT_SUCCESS;
640 }
641
642
643
644 static int handle_commandnummatches(int fd, int argc, char *argv[])
645 {
646         int matches = 0;
647
648         if (argc != 4)
649                 return RESULT_SHOWUSAGE;
650
651         matches = ast_cli_generatornummatches(argv[2], argv[3]);
652
653         ast_cli(fd, "%d", matches);
654
655         return RESULT_SUCCESS;
656 }
657
658 static int handle_commandcomplete(int fd, int argc, char *argv[])
659 {
660         char *buf;
661
662         if (argc != 5)
663                 return RESULT_SHOWUSAGE;
664         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
665         if (buf) {
666                 ast_cli(fd, buf);
667                 free(buf);
668         } else
669                 ast_cli(fd, "NULL\n");
670         return RESULT_SUCCESS;
671 }
672
673 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
674 {
675         struct ast_channel *c = NULL;
676         int is_all, is_off = 0;
677
678         switch (cmd) {
679         case CLI_INIT:
680                 e->command = "core set debug channel";
681                 e->usage =
682                         "Usage: core set debug channel <all|channel> [off]\n"
683                         "       Enables/disables debugging on all or on a specific channel.\n";
684                 return NULL;
685
686         case CLI_GENERATE:
687                 /* XXX remember to handle the optional "off" */
688                 if (a->pos != e->args)
689                         return NULL;
690                 return a->n == 0 ? strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
691         }
692         /* 'core set debug channel {all|chan_id}' */
693         if (a->argc == e->args + 2) {
694                 if (!strcasecmp(a->argv[e->args + 1], "off"))
695                         is_off = 1;
696                 else
697                         return CLI_SHOWUSAGE;
698         } else if (a->argc != e->args + 1)
699                 return CLI_SHOWUSAGE;
700
701         is_all = !strcasecmp("all", a->argv[e->args]);
702         if (is_all) {
703                 if (is_off) {
704                         global_fin &= ~DEBUGCHAN_FLAG;
705                         global_fout &= ~DEBUGCHAN_FLAG;
706                 } else {
707                         global_fin |= DEBUGCHAN_FLAG;
708                         global_fout |= DEBUGCHAN_FLAG;
709                 }
710                 c = ast_channel_walk_locked(NULL);
711         } else {
712                 c = ast_get_channel_by_name_locked(a->argv[e->args]);
713                 if (c == NULL)
714                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
715         }
716         while (c) {
717                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
718                         if (is_off) {
719                                 c->fin &= ~DEBUGCHAN_FLAG;
720                                 c->fout &= ~DEBUGCHAN_FLAG;
721                         } else {
722                                 c->fin |= DEBUGCHAN_FLAG;
723                                 c->fout |= DEBUGCHAN_FLAG;
724                         }
725                         ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
726                 }
727                 ast_channel_unlock(c);
728                 if (!is_all)
729                         break;
730                 c = ast_channel_walk_locked(c);
731         }
732         ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
733         return RESULT_SUCCESS;
734 }
735
736 static char *handle_debugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
737 {
738         char *res;
739
740         if (cmd == CLI_HANDLER && a->argc != e->args + 1)
741                 return CLI_SHOWUSAGE;
742         res = handle_core_set_debug_channel(e, cmd, a);
743         if (cmd == CLI_INIT)
744                 e->command = "debug channel";
745         return res;
746 }
747
748 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
749 {
750         char *res;
751         if (cmd == CLI_HANDLER) {
752                 if (a->argc != e->args + 1)
753                         return CLI_SHOWUSAGE;
754                 /* pretend we have an extra "off" at the end. We can do this as the array
755                  * is NULL terminated so we overwrite that entry.
756                  */
757                 a->argv[e->args+1] = "off";
758                 a->argc++;
759         }
760         res = handle_core_set_debug_channel(e, cmd, a);
761         if (cmd == CLI_INIT)
762                 e->command = "no debug channel";
763         return res;
764 }
765                 
766 static int handle_showchan(int fd, int argc, char *argv[])
767 {
768         struct ast_channel *c=NULL;
769         struct timeval now;
770         char buf[2048];
771         char cdrtime[256];
772         char nf[256], wf[256], rf[256];
773         long elapsed_seconds=0;
774         int hour=0, min=0, sec=0;
775         
776         if (argc != 4)
777                 return RESULT_SHOWUSAGE;
778         now = ast_tvnow();
779         c = ast_get_channel_by_name_locked(argv[3]);
780         if (!c) {
781                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
782                 return RESULT_SUCCESS;
783         }
784         if(c->cdr) {
785                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
786                 hour = elapsed_seconds / 3600;
787                 min = (elapsed_seconds % 3600) / 60;
788                 sec = elapsed_seconds % 60;
789                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
790         } else
791                 strcpy(cdrtime, "N/A");
792         ast_cli(fd, 
793                 " -- General --\n"
794                 "           Name: %s\n"
795                 "           Type: %s\n"
796                 "       UniqueID: %s\n"
797                 "      Caller ID: %s\n"
798                 " Caller ID Name: %s\n"
799                 "    DNID Digits: %s\n"
800                 "          State: %s (%d)\n"
801                 "          Rings: %d\n"
802                 "  NativeFormats: %s\n"
803                 "    WriteFormat: %s\n"
804                 "     ReadFormat: %s\n"
805                 " WriteTranscode: %s\n"
806                 "  ReadTranscode: %s\n"
807                 "1st File Descriptor: %d\n"
808                 "      Frames in: %d%s\n"
809                 "     Frames out: %d%s\n"
810                 " Time to Hangup: %ld\n"
811                 "   Elapsed Time: %s\n"
812                 "  Direct Bridge: %s\n"
813                 "Indirect Bridge: %s\n"
814                 " --   PBX   --\n"
815                 "        Context: %s\n"
816                 "      Extension: %s\n"
817                 "       Priority: %d\n"
818                 "     Call Group: %llu\n"
819                 "   Pickup Group: %llu\n"
820                 "    Application: %s\n"
821                 "           Data: %s\n"
822                 "    Blocking in: %s\n",
823                 c->name, c->tech->type, c->uniqueid,
824                 S_OR(c->cid.cid_num, "(N/A)"),
825                 S_OR(c->cid.cid_name, "(N/A)"),
826                 S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, 
827                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
828                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
829                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
830                 c->writetrans ? "Yes" : "No",
831                 c->readtrans ? "Yes" : "No",
832                 c->fds[0],
833                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
834                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
835                 (long)c->whentohangup,
836                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
837                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
838                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
839                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
840         
841         if(pbx_builtin_serialize_variables(c,buf,sizeof(buf)))
842                 ast_cli(fd,"      Variables:\n%s\n",buf);
843         if(c->cdr && ast_cdr_serialize_variables(c->cdr,buf, sizeof(buf), '=', '\n', 1))
844                 ast_cli(fd,"  CDR Variables:\n%s\n",buf);
845         
846         ast_channel_unlock(c);
847         return RESULT_SUCCESS;
848 }
849
850 /*
851  * helper function to generate CLI matches from a fixed set of values.
852  * A NULL word is acceptable.
853  */
854 char *ast_cli_complete(const char *word, char *const choices[], int state)
855 {
856         int i, which = 0, len;
857         len = ast_strlen_zero(word) ? 0 : strlen(word);
858
859         for (i = 0; choices[i]; i++) {
860                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
861                         return ast_strdup(choices[i]);
862         }
863         return NULL;
864 }
865
866 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
867 {
868         struct ast_channel *c = NULL;
869         int which = 0;
870         int wordlen;
871         char notfound = '\0';
872         char *ret = &notfound; /* so NULL can break the loop */
873
874         if (pos != rpos)
875                 return NULL;
876
877         wordlen = strlen(word); 
878
879         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
880                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
881                         ret = ast_strdup(c->name);
882                 ast_channel_unlock(c);
883         }
884         return ret == &notfound ? NULL : ret;
885 }
886
887 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
888 {
889         return ast_complete_channels(line, word, pos, state, 2);
890 }
891
892 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
893 {
894         return ast_complete_channels(line, word, pos, state, 3);
895 }
896
897 static int group_show_channels(int fd, int argc, char *argv[])
898 {
899 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
900
901         struct ast_channel *c = NULL;
902         int numchans = 0;
903         struct ast_var_t *current;
904         struct varshead *headp;
905         regex_t regexbuf;
906         int havepattern = 0;
907
908         if (argc < 3 || argc > 4)
909                 return RESULT_SHOWUSAGE;
910         
911         if (argc == 4) {
912                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
913                         return RESULT_SHOWUSAGE;
914                 havepattern = 1;
915         }
916
917         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
918         while ( (c = ast_channel_walk_locked(c)) != NULL) {
919                 headp=&c->varshead;
920                 AST_LIST_TRAVERSE(headp,current,entries) {
921                         if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
922                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
923                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current),
924                                                 (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
925                                         numchans++;
926                                 }
927                         } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
928                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
929                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)");
930                                         numchans++;
931                                 }
932                         }
933                 }
934                 numchans++;
935                 ast_channel_unlock(c);
936         }
937
938         if (havepattern)
939                 regfree(&regexbuf);
940
941         ast_cli(fd, "%d active channel%s\n", numchans, (numchans != 1) ? "s" : "");
942         return RESULT_SUCCESS;
943 #undef FORMAT_STRING
944 }
945
946 /* XXX Nothing in this array can currently be deprecated...
947    You have to change the way find_cli works in order to remove this array
948    I recommend doing this eventually...
949  */
950 static struct ast_cli_entry builtins[] = {
951         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
952         { { "_command", "complete", NULL },
953         handle_commandcomplete, "Command complete",
954         commandcomplete_help },
955
956         { { "_command", "nummatches", NULL },
957         handle_commandnummatches, "Returns number of command matches",
958         commandnummatches_help },
959
960         { { "_command", "matchesarray", NULL },
961         handle_commandmatchesarray, "Returns command matches array",
962         commandmatchesarray_help },
963
964         { { NULL }, NULL, NULL, NULL }
965 };
966
967 static struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel");
968 static struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module");
969 static struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name");
970 static struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name");
971
972 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
973
974 static struct ast_cli_entry cli_cli[] = {
975         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
976         NEW_CLI(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
977
978         NEW_CLI(handle_chanlist, "Display information on channels"),
979
980         { { "core", "show", "channel", NULL },
981         handle_showchan, "Display information on a specific channel",
982         showchan_help, complete_ch_4 },
983
984         NEW_CLI(handle_core_set_debug_channel, "Enable/disable debugging on a channel",
985                 .deprecate_cmd = &cli_debug_channel_deprecated),
986
987         NEW_CLI(handle_verbose, "Set level of debug/verbose chattiness"),
988
989         { { "group", "show", "channels", NULL },
990         group_show_channels, "Display active channels with group(s)",
991         group_show_channels_help },
992
993         NEW_CLI(handle_help, "Display help list, or specific help on a command"),
994
995         { { "logger", "mute", NULL },
996         handle_logger_mute, "Toggle logging output to a console",
997         logger_mute_help },
998
999         NEW_CLI(handle_modlist, "List modules and info"),
1000
1001         NEW_CLI(handle_load, "Load a module by name", .deprecate_cmd = &cli_module_load_deprecated),
1002
1003         NEW_CLI(handle_reload, "Reload configuration", .deprecate_cmd = &cli_module_reload_deprecated),
1004
1005         NEW_CLI(handle_unload, "Unload a module by name", .deprecate_cmd = &cli_module_unload_deprecated ),
1006
1007         NEW_CLI(handle_showuptime, "Show uptime information"),
1008
1009         { { "soft", "hangup", NULL },
1010         handle_softhangup, "Request a hangup on a given channel",
1011         softhangup_help, complete_ch_3 },
1012 };
1013
1014 /*!
1015  * Some regexp characters in cli arguments are reserved and used as separators.
1016  */
1017 static const char cli_rsvd[] = "[]{}|*%";
1018
1019 /*!
1020  * initialize the _full_cmd string and related parameters,
1021  * return 0 on success, -1 on error.
1022  */
1023 static int set_full_cmd(struct ast_cli_entry *e)
1024 {
1025         int i;
1026         char buf[80];
1027
1028         ast_join(buf, sizeof(buf), e->cmda);
1029         e->_full_cmd = strdup(buf);
1030         if (!e->_full_cmd) {
1031                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1032                 return -1;
1033         }
1034         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1035         for (i = 0; e->cmda[i]; i++)
1036                 ;
1037         e->args = i;
1038         return 0;
1039 }
1040
1041 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1042 void ast_builtins_init(void)
1043 {
1044         struct ast_cli_entry *e;
1045
1046         for (e = builtins; e->cmda[0] != NULL; e++)
1047                 set_full_cmd(e);
1048
1049         ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry));
1050 }
1051
1052 /*
1053  * We have two sets of commands: builtins are stored in a
1054  * NULL-terminated array of ast_cli_entry, whereas external
1055  * commands are in a list.
1056  * When navigating, we need to keep two pointers and get
1057  * the next one in lexicographic order. For the purpose,
1058  * we use a structure.
1059  */
1060
1061 struct cli_iterator {
1062         struct ast_cli_entry *builtins;
1063         struct ast_cli_entry *helpers;
1064 };
1065
1066 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
1067 {
1068         struct ast_cli_entry *e;
1069
1070         if (i->builtins == NULL && i->helpers == NULL) {
1071                 /* initialize */
1072                 i->builtins = builtins;
1073                 i->helpers = AST_LIST_FIRST(&helpers);
1074         }
1075         e = i->builtins; /* temporary */
1076         if (!e->cmda[0] || (i->helpers &&
1077                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
1078                 /* Use helpers */
1079                 e = i->helpers;
1080                 if (e)
1081                         i->helpers = AST_LIST_NEXT(e, list);
1082         } else { /* use builtin. e is already set  */
1083                 (i->builtins)++;        /* move to next */
1084         }
1085         return e;
1086 }
1087
1088 /*!
1089  * match a word in the CLI entry.
1090  * returns -1 on mismatch, 0 on match of an optional word,
1091  * 1 on match of a full word.
1092  *
1093  * The pattern can be
1094  *   any_word           match for equal
1095  *   [foo|bar|baz]      optionally, one of these words
1096  *   {foo|bar|baz}      exactly, one of these words
1097  *   %                  any word
1098  */
1099 static int word_match(const char *cmd, const char *cli_word)
1100 {
1101         int l;
1102         char *pos;
1103
1104         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1105                 return -1;
1106         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1107                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1108         /* regexp match, takes [foo|bar] or {foo|bar} */
1109         l = strlen(cmd);
1110         /* wildcard match - will extend in the future */
1111         if (l > 0 && cli_word[0] == '%') {
1112                 return 1;       /* wildcard */
1113         }
1114         pos = strcasestr(cli_word, cmd);
1115         if (pos == NULL) /* not found, say ok if optional */
1116                 return cli_word[0] == '[' ? 0 : -1;
1117         if (pos == cli_word)    /* no valid match at the beginning */
1118                 return -1;
1119         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1120                 return 1;       /* valid match */
1121         return -1;      /* not found */
1122 }
1123
1124 /*! \brief if word is a valid prefix for token, returns the pos-th
1125  * match as a malloced string, or NULL otherwise.
1126  * Always tell in *actual how many matches we got.
1127  */
1128 static char *is_prefix(const char *word, const char *token,
1129         int pos, int *actual)
1130 {
1131         int lw;
1132         char *s, *t1;
1133
1134         *actual = 0;
1135         if (ast_strlen_zero(token))
1136                 return NULL;
1137         if (ast_strlen_zero(word))
1138                 word = "";      /* dummy */
1139         lw = strlen(word);
1140         if (strcspn(word, cli_rsvd) != lw)
1141                 return NULL;    /* no match if word has reserved chars */
1142         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1143                 if (strncasecmp(token, word, lw))       /* no match */
1144                         return NULL;
1145                 *actual = 1;
1146                 return (pos != 0) ? NULL : strdup(token);
1147         }
1148         /* now handle regexp match */
1149
1150         /* Wildcard always matches, so we never do is_prefix on them */
1151
1152         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1153         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1154                 if (*s == '%')  /* wildcard */
1155                         continue;
1156                 if (strncasecmp(s, word, lw))   /* no match */
1157                         continue;
1158                 (*actual)++;
1159                 if (pos-- == 0)
1160                         return strdup(s);
1161         }
1162         return NULL;
1163 }
1164
1165 /*!
1166  * \brief locate a cli command in the 'helpers' list (which must be locked).
1167  * exact has 3 values:
1168  *      0       returns if the search key is equal or longer than the entry.
1169  *              note that trailing optional arguments are skipped.
1170  *      -1      true if the mismatch is on the last word XXX not true!
1171  *      1       true only on complete, exact match.
1172  *
1173  * The search compares word by word taking care of regexps in e->cmda
1174  */
1175 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
1176 {
1177         int matchlen = -1;      /* length of longest match so far */
1178         struct ast_cli_entry *cand = NULL, *e=NULL;
1179         struct cli_iterator i = { NULL, NULL};
1180
1181         while( (e = cli_next(&i)) ) {
1182                 /* word-by word regexp comparison */
1183                 char * const *src = cmds;
1184                 char * const *dst = e->cmda;
1185                 int n = 0;
1186                 for (;; dst++, src += n) {
1187                         n = word_match(*src, *dst);
1188                         if (n < 0)
1189                                 break;
1190                 }
1191                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1192                         /* no more words in 'e' */
1193                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1194                                 break;
1195                         /* Here, cmds has more words than the entry 'e' */
1196                         if (match_type != 0)    /* but we look for almost exact match... */
1197                                 continue;       /* so we skip this one. */
1198                         /* otherwise we like it (case 0) */
1199                 } else {        /* still words in 'e' */
1200                         if (ast_strlen_zero(*src))
1201                                 continue; /* cmds is shorter than 'e', not good */
1202                         /* Here we have leftover words in cmds and 'e',
1203                          * but there is a mismatch. We only accept this one if match_type == -1
1204                          * and this is the last word for both.
1205                          */
1206                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1207                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1208                                 continue;
1209                         /* good, we are in case match_type == -1 and mismatch on last word */
1210                 }
1211                 if (src - cmds > matchlen) {    /* remember the candidate */
1212                         matchlen = src - cmds;
1213                         cand = e;
1214                 }
1215         }
1216         return e ? e : cand;
1217 }
1218
1219 static char *find_best(char *argv[])
1220 {
1221         static char cmdline[80];
1222         int x;
1223         /* See how close we get, then print the candidate */
1224         char *myargv[AST_MAX_CMD_LEN];
1225         for (x=0;x<AST_MAX_CMD_LEN;x++)
1226                 myargv[x]=NULL;
1227         AST_LIST_LOCK(&helpers);
1228         for (x=0;argv[x];x++) {
1229                 myargv[x] = argv[x];
1230                 if (!find_cli(myargv, -1))
1231                         break;
1232         }
1233         AST_LIST_UNLOCK(&helpers);
1234         ast_join(cmdline, sizeof(cmdline), myargv);
1235         return cmdline;
1236 }
1237
1238 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1239 {
1240         if (e->deprecate_cmd) {
1241                 __ast_cli_unregister(e->deprecate_cmd, e);
1242         }
1243         if (e->inuse) {
1244                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1245         } else {
1246                 AST_LIST_LOCK(&helpers);
1247                 AST_LIST_REMOVE(&helpers, e, list);
1248                 AST_LIST_UNLOCK(&helpers);
1249                 free(e->_full_cmd);
1250                 e->_full_cmd = NULL;
1251                 if (e->new_handler) {
1252                         /* this is a new-style entry. Reset fields and free memory. */
1253                         bzero((char **)(e->cmda), sizeof(e->cmda));
1254                         free(e->command);
1255                         e->command = NULL;
1256                         e->usage = NULL;
1257                 }
1258         }
1259         return 0;
1260 }
1261
1262 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1263 {
1264         struct ast_cli_entry *cur;
1265         int i, lf, ret = -1;
1266
1267         if (e->handler == NULL) {       /* new style entry, run the handler to init fields */
1268                 struct ast_cli_args a;  /* fake argument */
1269                 char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
1270                 char *s;
1271
1272                 bzero (&a, sizeof(a));
1273                 e->new_handler(e, CLI_INIT, &a);
1274                 /* XXX check that usage and command are filled up */
1275                 s = ast_skip_blanks(e->command);
1276                 s = e->command = ast_strdup(s);
1277                 for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
1278                         *dst++ = s;     /* store string */
1279                         s = ast_skip_nonblanks(s);
1280                         if (*s == '\0') /* we are done */
1281                                 break;
1282                         *s++ = '\0';
1283                         s = ast_skip_blanks(s);
1284                 }
1285                 *dst++ = NULL;
1286         }
1287         if (set_full_cmd(e))
1288                 goto done;
1289         AST_LIST_LOCK(&helpers);
1290         
1291         if (find_cli(e->cmda, 1)) {
1292                 AST_LIST_UNLOCK(&helpers);
1293                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", e->_full_cmd);
1294                 free(e->_full_cmd);
1295                 e->_full_cmd = NULL;
1296                 goto done;
1297         }
1298         if (!ed) {
1299                 e->deprecated = 0;
1300         } else {
1301                 e->deprecated = 1;
1302                 e->summary = ed->summary;
1303                 e->usage = ed->usage;
1304                 /* XXX If command A deprecates command B, and command B deprecates command C...
1305                    Do we want to show command A or command B when telling the user to use new syntax?
1306                    This currently would show command A.
1307                    To show command B, you just need to always use ed->_full_cmd.
1308                  */
1309                 e->_deprecated_by = S_OR(ed->_deprecated_by, ed->_full_cmd);
1310         }
1311
1312         lf = e->cmdlen;
1313         AST_LIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1314                 int len = cur->cmdlen;
1315                 if (lf < len)
1316                         len = lf;
1317                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
1318                         AST_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); 
1319                         break;
1320                 }
1321         }
1322         AST_LIST_TRAVERSE_SAFE_END;
1323
1324         if (!cur)
1325                 AST_LIST_INSERT_TAIL(&helpers, e, list); 
1326         ret = 0;        /* success */
1327
1328 done:
1329         AST_LIST_UNLOCK(&helpers);
1330
1331         if (e->deprecate_cmd) {
1332                 /* This command deprecates another command.  Register that one also. */
1333                 __ast_cli_register(e->deprecate_cmd, e);
1334         }
1335         
1336         return ret;
1337 }
1338
1339 /* wrapper function, so we can unregister deprecated commands recursively */
1340 int ast_cli_unregister(struct ast_cli_entry *e)
1341 {
1342         return __ast_cli_unregister(e, NULL);
1343 }
1344
1345 /* wrapper function, so we can register deprecated commands recursively */
1346 int ast_cli_register(struct ast_cli_entry *e)
1347 {
1348         return __ast_cli_register(e, NULL);
1349 }
1350
1351 /*
1352  * register/unregister an array of entries.
1353  */
1354 void ast_cli_register_multiple(struct ast_cli_entry *e, int len)
1355 {
1356         int i;
1357
1358         for (i = 0; i < len; i++)
1359                 ast_cli_register(e + i);
1360 }
1361
1362 void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
1363 {
1364         int i;
1365
1366         for (i = 0; i < len; i++)
1367                 ast_cli_unregister(e + i);
1368 }
1369
1370
1371 /*! \brief helper for final part of
1372  * handle_help. if locked = 0 it's just "help_workhorse",
1373  * otherwise assume the list is already locked and print
1374  * an error message if not found.
1375  */
1376 static char *help1(int fd, char *match[], int locked)
1377 {
1378         char matchstr[80] = "";
1379         struct ast_cli_entry *e;
1380         int len = 0;
1381         int found = 0;
1382         struct cli_iterator i = { NULL, NULL};
1383
1384         if (match) {
1385                 ast_join(matchstr, sizeof(matchstr), match);
1386                 len = strlen(matchstr);
1387         }
1388         if (!locked)
1389                 AST_LIST_LOCK(&helpers);
1390         while ( (e = cli_next(&i)) ) {
1391                 /* Hide commands that start with '_' */
1392                 if (e->_full_cmd[0] == '_')
1393                         continue;
1394                 /* Hide commands that are marked as deprecated. */
1395                 if (e->deprecated)
1396                         continue;
1397                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
1398                         continue;
1399                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
1400                 found++;
1401         }
1402         if (!locked)
1403                 AST_LIST_UNLOCK(&helpers);
1404         if (!locked && !found && matchstr[0])
1405                 ast_cli(fd, "No such command '%s'.\n", matchstr);
1406         return CLI_SUCCESS;
1407 }
1408
1409 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1410 {
1411         char fullcmd[80];
1412         struct ast_cli_entry *my_e;
1413
1414         if (cmd == CLI_INIT) {
1415                 e->command = "help";
1416                 e->usage =
1417                         "Usage: help [topic]\n"
1418                         "       When called with a topic as an argument, displays usage\n"
1419                         "       information on the given command. If called without a\n"
1420                         "       topic, it provides a list of commands.\n";
1421                 return NULL;
1422
1423         } else if (cmd == CLI_GENERATE) {
1424                 /* skip first 4 or 5 chars, "help " */
1425                 int l = strlen(a->line);
1426
1427                 if (l > 5)
1428                         l = 5;
1429                 /* XXX watch out, should stop to the non-generator parts */
1430                 ast_verbose("'%s' '%s' at %d\n", a->line + l, a->word, a->n);
1431                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
1432         }
1433         if (a->argc == 1)
1434                 return help1(a->fd, NULL, 0);
1435
1436         AST_LIST_LOCK(&helpers);
1437         my_e = find_cli(a->argv + 1, 1);        /* try exact match first */
1438         if (!my_e)
1439                 return help1(a->fd, a->argv + 1, 1 /* locked */);
1440         if (my_e->usage)
1441                 ast_cli(a->fd, "%s", my_e->usage);
1442         else {
1443                 ast_join(fullcmd, sizeof(fullcmd), a->argv+1);
1444                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
1445         }
1446         AST_LIST_UNLOCK(&helpers);
1447         return RESULT_SUCCESS;
1448 }
1449
1450 static char *parse_args(const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
1451 {
1452         char *dup, *cur;
1453         int x = 0;
1454         int quoted = 0;
1455         int escaped = 0;
1456         int whitespace = 1;
1457         int dummy = 0;
1458
1459         if (trailingwhitespace == NULL)
1460                 trailingwhitespace = &dummy;
1461         *trailingwhitespace = 0;
1462         if (s == NULL)  /* invalid, though! */
1463                 return NULL;
1464         /* make a copy to store the parsed string */
1465         if (!(dup = ast_strdup(s)))
1466                 return NULL;
1467
1468         cur = dup;
1469         /* scan the original string copying into cur when needed */
1470         for (; *s ; s++) {
1471                 if (x >= max - 1) {
1472                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1473                         break;
1474                 }
1475                 if (*s == '"' && !escaped) {
1476                         quoted = !quoted;
1477                         if (quoted && whitespace) {
1478                                 /* start a quoted string from previous whitespace: new argument */
1479                                 argv[x++] = cur;
1480                                 whitespace = 0;
1481                         }
1482                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1483                         /* If we are not already in whitespace, and not in a quoted string or
1484                            processing an escape sequence, and just entered whitespace, then
1485                            finalize the previous argument and remember that we are in whitespace
1486                         */
1487                         if (!whitespace) {
1488                                 *cur++ = '\0';
1489                                 whitespace = 1;
1490                         }
1491                 } else if (*s == '\\' && !escaped) {
1492                         escaped = 1;
1493                 } else {
1494                         if (whitespace) {
1495                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1496                                 argv[x++] = cur;
1497                                 whitespace = 0;
1498                         }
1499                         *cur++ = *s;
1500                         escaped = 0;
1501                 }
1502         }
1503         /* Null terminate */
1504         *cur++ = '\0';
1505         /* XXX put a NULL in the last argument, because some functions that take
1506          * the array may want a null-terminated array.
1507          * argc still reflects the number of non-NULL entries.
1508          */
1509         argv[x] = NULL;
1510         *argc = x;
1511         *trailingwhitespace = whitespace;
1512         return dup;
1513 }
1514
1515 /*! \brief Return the number of unique matches for the generator */
1516 int ast_cli_generatornummatches(const char *text, const char *word)
1517 {
1518         int matches = 0, i = 0;
1519         char *buf = NULL, *oldbuf = NULL;
1520
1521         while ((buf = ast_cli_generator(text, word, i++))) {
1522                 if (!oldbuf || strcmp(buf,oldbuf))
1523                         matches++;
1524                 if (oldbuf)
1525                         free(oldbuf);
1526                 oldbuf = buf;
1527         }
1528         if (oldbuf)
1529                 free(oldbuf);
1530         return matches;
1531 }
1532
1533 char **ast_cli_completion_matches(const char *text, const char *word)
1534 {
1535         char **match_list = NULL, *retstr, *prevstr;
1536         size_t match_list_len, max_equal, which, i;
1537         int matches = 0;
1538
1539         /* leave entry 0 free for the longest common substring */
1540         match_list_len = 1;
1541         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1542                 if (matches + 1 >= match_list_len) {
1543                         match_list_len <<= 1;
1544                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1545                                 return NULL;
1546                 }
1547                 match_list[++matches] = retstr;
1548         }
1549
1550         if (!match_list)
1551                 return match_list; /* NULL */
1552
1553         /* Find the longest substring that is common to all results
1554          * (it is a candidate for completion), and store a copy in entry 0.
1555          */
1556         prevstr = match_list[1];
1557         max_equal = strlen(prevstr);
1558         for (which = 2; which <= matches; which++) {
1559                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1560                         continue;
1561                 max_equal = i;
1562         }
1563
1564         if (!(retstr = ast_malloc(max_equal + 1)))
1565                 return NULL;
1566         
1567         ast_copy_string(retstr, match_list[1], max_equal + 1);
1568         match_list[0] = retstr;
1569
1570         /* ensure that the array is NULL terminated */
1571         if (matches + 1 >= match_list_len) {
1572                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1573                         return NULL;
1574         }
1575         match_list[matches + 1] = NULL;
1576
1577         return match_list;
1578 }
1579
1580 /*! \brief returns true if there are more words to match */
1581 static int more_words (char * const *dst)
1582 {
1583         int i;
1584         for (i = 0; dst[i]; i++) {
1585                 if (dst[i][0] != '[')
1586                         return -1;
1587         }
1588         return 0;
1589 }
1590         
1591 /*
1592  * generate the entry at position 'state'
1593  */
1594 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1595 {
1596         char *argv[AST_MAX_ARGS];
1597         struct ast_cli_entry *e;
1598         struct cli_iterator i = { NULL, NULL };
1599         int x = 0, argindex, matchlen;
1600         int matchnum=0;
1601         char *ret = NULL;
1602         char matchstr[80] = "";
1603         int tws = 0;
1604         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1605
1606         if (!dup)       /* malloc error */
1607                 return NULL;
1608         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1609         /* rebuild the command, ignore tws */
1610         ast_join(matchstr, sizeof(matchstr)-1, argv);
1611         matchlen = strlen(matchstr);
1612         if (tws) {
1613                 strcat(matchstr, " "); /* XXX */
1614                 if (matchlen)
1615                         matchlen++;
1616         }
1617         if (lock)
1618                 AST_LIST_LOCK(&helpers);
1619         while ( (e = cli_next(&i)) ) {
1620                 /* XXX repeated code */
1621                 int src = 0, dst = 0, n = 0;
1622                 for (;; dst++, src += n) {
1623                         n = word_match(argv[src], e->cmda[dst]);
1624                         if (n < 0)
1625                                 break;
1626                 }
1627
1628                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
1629                         continue;
1630                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
1631                 matchnum += n;  /* this many matches here */
1632                 if (ret) {
1633                         if (matchnum > state)
1634                                 break;
1635                         free(ret);
1636                         ret = NULL;
1637                 } else if (ast_strlen_zero(e->cmda[dst])) {
1638                         /* This entry is a prefix of the command string entered
1639                          * (only one entry in the list should have this property).
1640                          * Run the generator if one is available. In any case we are done.
1641                          */
1642                         if (e->generator)
1643                                 ret = e->generator(matchstr, word, argindex, state - matchnum);
1644                         else if (e->new_handler) {      /* new style command */
1645                                 struct ast_cli_args a = {
1646                                         .line = matchstr, .word = word,
1647                                         .pos = argindex,
1648                                         .n = state - matchnum };
1649                                 ret = e->new_handler(e, CLI_GENERATE, &a);
1650                         }
1651                         if (ret)
1652                                 break;
1653                 }
1654         }
1655         if (lock)
1656                 AST_LIST_UNLOCK(&helpers);
1657         free(dup);
1658         return ret;
1659 }
1660
1661 char *ast_cli_generator(const char *text, const char *word, int state)
1662 {
1663         return __ast_cli_generator(text, word, state, 1);
1664 }
1665
1666 int ast_cli_command(int fd, const char *s)
1667 {
1668         char *args[AST_MAX_ARGS + 1];
1669         struct ast_cli_entry *e;
1670         int x;
1671         int res;
1672         char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
1673
1674         if (dup == NULL)
1675                 return -1;
1676
1677         if (x < 1)      /* We need at least one entry, otherwise ignore */
1678                 goto done;
1679
1680         AST_LIST_LOCK(&helpers);
1681         e = find_cli(args + 1, 0);
1682         if (e)
1683                 ast_atomic_fetchadd_int(&e->inuse, 1);
1684         AST_LIST_UNLOCK(&helpers);
1685         if (e == NULL) {
1686                 ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1));
1687                 goto done;
1688         }
1689         /*
1690          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
1691          * Remember that the array returned by parse_args is NULL-terminated.
1692          */
1693         args[0] = (char *)e;
1694
1695         if (!e->new_handler)    /* old style */
1696                 res = e->handler(fd, x, args + 1);
1697         else {
1698                 struct ast_cli_args a = {
1699                         .fd = fd, .argc = x, .argv = args+1 };
1700                 char *retval = e->new_handler(e, CLI_HANDLER, &a);
1701
1702                 if (retval == CLI_SUCCESS)
1703                         res = RESULT_SUCCESS;
1704                 else if (retval == CLI_SHOWUSAGE)
1705                         res = RESULT_SHOWUSAGE;
1706                 else
1707                         res = RESULT_FAILURE;
1708         }
1709         switch (res) {
1710         case RESULT_SHOWUSAGE:
1711                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
1712                 break;
1713
1714         case RESULT_FAILURE:
1715                 ast_cli(fd, "Command '%s' failed.\n", s);
1716                 /* FALLTHROUGH */
1717         default:
1718                 AST_LIST_LOCK(&helpers);
1719                 if (e->deprecated == 1) {
1720                         ast_cli(fd, "The '%s' command is deprecated and will be removed in a future release. Please use '%s' instead.\n", e->_full_cmd, e->_deprecated_by);
1721                         e->deprecated = 2;
1722                 }
1723                 AST_LIST_UNLOCK(&helpers);
1724                 break;
1725         }
1726         ast_atomic_fetchadd_int(&e->inuse, -1);
1727 done:
1728         free(dup);
1729         return 0;
1730 }