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