1f0d063f72a794ccafab4a24eae370b5c87fbc58
[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, const 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, count = 0;
462         int fd, argc;
463         char **argv;
464
465         switch (cmd) {
466         case CLI_INIT:
467                 e->command = "core show channels [concise|verbose|count]";
468                 e->usage =
469                         "Usage: core show channels [concise|verbose|count]\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. If 'count' is specified only the channel and call\n"
474                         "       count is output.\n";
475                 return NULL;
476
477         case CLI_GENERATE:
478                 return NULL;
479         }
480         fd = a->fd;
481         argc = a->argc;
482         argv = a->argv;
483
484         if (a->argc == e->args) {
485                 if (!strcasecmp(argv[e->args-1],"concise"))
486                         concise = 1;
487                 else if (!strcasecmp(argv[e->args-1],"verbose"))
488                         verbose = 1;
489                 else if (!strcasecmp(argv[e->args-1],"count"))
490                         count = 1;
491                 else
492                         return CLI_SHOWUSAGE;
493         } else if (a->argc != e->args - 1)
494                 return CLI_SHOWUSAGE;
495
496         if (!count) {
497                 if (!concise && !verbose)
498                         ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
499                 else if (verbose)
500                         ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
501                                 "CallerID", "Duration", "Accountcode", "BridgedTo");
502         }
503
504         while ((c = ast_channel_walk_locked(c)) != NULL) {
505                 struct ast_channel *bc = ast_bridged_channel(c);
506                 char durbuf[10] = "-";
507
508                 if (!count) {
509                         if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
510                                 int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
511                                 if (verbose) {
512                                         int durh = duration / 3600;
513                                         int durm = (duration % 3600) / 60;
514                                         int durs = duration % 60;
515                                         snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
516                                 } else {
517                                         snprintf(durbuf, sizeof(durbuf), "%d", duration);
518                                 }                               
519                         }
520                         if (concise) {
521                                 ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
522                                         c->appl ? c->appl : "(None)",
523                                         S_OR(c->data, ""),      /* XXX different from verbose ? */
524                                         S_OR(c->cid.cid_num, ""),
525                                         S_OR(c->accountcode, ""),
526                                         c->amaflags, 
527                                         durbuf,
528                                         bc ? bc->name : "(None)");
529                         } else if (verbose) {
530                                 ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
531                                         c->appl ? c->appl : "(None)",
532                                         c->data ? S_OR(c->data, "(Empty)" ): "(None)",
533                                         S_OR(c->cid.cid_num, ""),
534                                         durbuf,
535                                         S_OR(c->accountcode, ""),
536                                         bc ? bc->name : "(None)");
537                         } else {
538                                 char locbuf[40] = "(None)";
539                                 char appdata[40] = "(None)";
540                                 
541                                 if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
542                                         snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
543                                 if (c->appl)
544                                         snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
545                                 ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
546                         }
547                 }
548                 numchans++;
549                 ast_channel_unlock(c);
550         }
551         if (!concise) {
552                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
553                 if (option_maxcalls)
554                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
555                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
556                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
557                 else
558                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
559         }
560         return CLI_SUCCESS;
561         
562 #undef FORMAT_STRING
563 #undef FORMAT_STRING2
564 #undef CONCISE_FORMAT_STRING
565 #undef VERBOSE_FORMAT_STRING
566 #undef VERBOSE_FORMAT_STRING2
567 }
568
569 static const char showchan_help[] = 
570 "Usage: core show channel <channel>\n"
571 "       Shows lots of information about the specified channel.\n";
572
573 static const char commandcomplete_help[] = 
574 "Usage: _command complete \"<line>\" text state\n"
575 "       This function is used internally to help with command completion and should.\n"
576 "       never be called by the user directly.\n";
577
578 static const char commandnummatches_help[] = 
579 "Usage: _command nummatches \"<line>\" text \n"
580 "       This function is used internally to help with command completion and should.\n"
581 "       never be called by the user directly.\n";
582
583 static const char commandmatchesarray_help[] = 
584 "Usage: _command matchesarray \"<line>\" text \n"
585 "       This function is used internally to help with command completion and should.\n"
586 "       never be called by the user directly.\n";
587
588 static int handle_softhangup(int fd, int argc, char *argv[])
589 {
590         struct ast_channel *c=NULL;
591         if (argc != 3)
592                 return RESULT_SHOWUSAGE;
593         c = ast_get_channel_by_name_locked(argv[2]);
594         if (c) {
595                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
596                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
597                 ast_channel_unlock(c);
598         } else
599                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
600         return RESULT_SUCCESS;
601 }
602
603 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
604
605 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
606 {
607         char *buf, *obuf;
608         int buflen = 2048;
609         int len = 0;
610         char **matches;
611         int x, matchlen;
612
613         if (argc != 4)
614                 return RESULT_SHOWUSAGE;
615         if (!(buf = ast_malloc(buflen)))
616                 return RESULT_FAILURE;
617         buf[len] = '\0';
618         matches = ast_cli_completion_matches(argv[2], argv[3]);
619         if (matches) {
620                 for (x=0; matches[x]; x++) {
621                         matchlen = strlen(matches[x]) + 1;
622                         if (len + matchlen >= buflen) {
623                                 buflen += matchlen * 3;
624                                 obuf = buf;
625                                 if (!(buf = ast_realloc(obuf, buflen))) 
626                                         /* Memory allocation failure...  Just free old buffer and be done */
627                                         free(obuf);
628                         }
629                         if (buf)
630                                 len += sprintf( buf + len, "%s ", matches[x]);
631                         free(matches[x]);
632                         matches[x] = NULL;
633                 }
634                 free(matches);
635         }
636
637         if (buf) {
638                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
639                 free(buf);
640         } else
641                 ast_cli(fd, "NULL\n");
642
643         return RESULT_SUCCESS;
644 }
645
646
647
648 static int handle_commandnummatches(int fd, int argc, char *argv[])
649 {
650         int matches = 0;
651
652         if (argc != 4)
653                 return RESULT_SHOWUSAGE;
654
655         matches = ast_cli_generatornummatches(argv[2], argv[3]);
656
657         ast_cli(fd, "%d", matches);
658
659         return RESULT_SUCCESS;
660 }
661
662 static int handle_commandcomplete(int fd, int argc, char *argv[])
663 {
664         char *buf;
665
666         if (argc != 5)
667                 return RESULT_SHOWUSAGE;
668         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
669         if (buf) {
670                 ast_cli(fd, buf);
671                 free(buf);
672         } else
673                 ast_cli(fd, "NULL\n");
674         return RESULT_SUCCESS;
675 }
676
677 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
678 {
679         struct ast_channel *c = NULL;
680         int is_all, is_off = 0;
681
682         switch (cmd) {
683         case CLI_INIT:
684                 e->command = "core set debug channel";
685                 e->usage =
686                         "Usage: core set debug channel <all|channel> [off]\n"
687                         "       Enables/disables debugging on all or on a specific channel.\n";
688                 return NULL;
689
690         case CLI_GENERATE:
691                 /* XXX remember to handle the optional "off" */
692                 if (a->pos != e->args)
693                         return NULL;
694                 return a->n == 0 ? strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
695         }
696         /* 'core set debug channel {all|chan_id}' */
697         if (a->argc == e->args + 2) {
698                 if (!strcasecmp(a->argv[e->args + 1], "off"))
699                         is_off = 1;
700                 else
701                         return CLI_SHOWUSAGE;
702         } else if (a->argc != e->args + 1)
703                 return CLI_SHOWUSAGE;
704
705         is_all = !strcasecmp("all", a->argv[e->args]);
706         if (is_all) {
707                 if (is_off) {
708                         global_fin &= ~DEBUGCHAN_FLAG;
709                         global_fout &= ~DEBUGCHAN_FLAG;
710                 } else {
711                         global_fin |= DEBUGCHAN_FLAG;
712                         global_fout |= DEBUGCHAN_FLAG;
713                 }
714                 c = ast_channel_walk_locked(NULL);
715         } else {
716                 c = ast_get_channel_by_name_locked(a->argv[e->args]);
717                 if (c == NULL)
718                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
719         }
720         while (c) {
721                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
722                         if (is_off) {
723                                 c->fin &= ~DEBUGCHAN_FLAG;
724                                 c->fout &= ~DEBUGCHAN_FLAG;
725                         } else {
726                                 c->fin |= DEBUGCHAN_FLAG;
727                                 c->fout |= DEBUGCHAN_FLAG;
728                         }
729                         ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
730                 }
731                 ast_channel_unlock(c);
732                 if (!is_all)
733                         break;
734                 c = ast_channel_walk_locked(c);
735         }
736         ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
737         return RESULT_SUCCESS;
738 }
739
740 static char *handle_debugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
741 {
742         char *res;
743
744         if (cmd == CLI_HANDLER && a->argc != e->args + 1)
745                 return CLI_SHOWUSAGE;
746         res = handle_core_set_debug_channel(e, cmd, a);
747         if (cmd == CLI_INIT)
748                 e->command = "debug channel";
749         return res;
750 }
751
752 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
753 {
754         char *res;
755         if (cmd == CLI_HANDLER) {
756                 if (a->argc != e->args + 1)
757                         return CLI_SHOWUSAGE;
758                 /* pretend we have an extra "off" at the end. We can do this as the array
759                  * is NULL terminated so we overwrite that entry.
760                  */
761                 a->argv[e->args+1] = "off";
762                 a->argc++;
763         }
764         res = handle_core_set_debug_channel(e, cmd, a);
765         if (cmd == CLI_INIT)
766                 e->command = "no debug channel";
767         return res;
768 }
769                 
770 static int handle_showchan(int fd, int argc, char *argv[])
771 {
772         struct ast_channel *c=NULL;
773         struct timeval now;
774         struct ast_str *out = ast_str_alloca(2048);
775         char cdrtime[256];
776         char nf[256], wf[256], rf[256];
777         long elapsed_seconds=0;
778         int hour=0, min=0, sec=0;
779         
780         if (argc != 4)
781                 return RESULT_SHOWUSAGE;
782         now = ast_tvnow();
783         c = ast_get_channel_by_name_locked(argv[3]);
784         if (!c) {
785                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
786                 return RESULT_SUCCESS;
787         }
788         if (c->cdr) {
789                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
790                 hour = elapsed_seconds / 3600;
791                 min = (elapsed_seconds % 3600) / 60;
792                 sec = elapsed_seconds % 60;
793                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
794         } else
795                 strcpy(cdrtime, "N/A");
796         ast_cli(fd, 
797                 " -- General --\n"
798                 "           Name: %s\n"
799                 "           Type: %s\n"
800                 "       UniqueID: %s\n"
801                 "      Caller ID: %s\n"
802                 " Caller ID Name: %s\n"
803                 "    DNID Digits: %s\n"
804                 "       Language: %s\n"
805                 "          State: %s (%d)\n"
806                 "          Rings: %d\n"
807                 "  NativeFormats: %s\n"
808                 "    WriteFormat: %s\n"
809                 "     ReadFormat: %s\n"
810                 " WriteTranscode: %s\n"
811                 "  ReadTranscode: %s\n"
812                 "1st File Descriptor: %d\n"
813                 "      Frames in: %d%s\n"
814                 "     Frames out: %d%s\n"
815                 " Time to Hangup: %ld\n"
816                 "   Elapsed Time: %s\n"
817                 "  Direct Bridge: %s\n"
818                 "Indirect Bridge: %s\n"
819                 " --   PBX   --\n"
820                 "        Context: %s\n"
821                 "      Extension: %s\n"
822                 "       Priority: %d\n"
823                 "     Call Group: %llu\n"
824                 "   Pickup Group: %llu\n"
825                 "    Application: %s\n"
826                 "           Data: %s\n"
827                 "    Blocking in: %s\n",
828                 c->name, c->tech->type, c->uniqueid,
829                 S_OR(c->cid.cid_num, "(N/A)"),
830                 S_OR(c->cid.cid_name, "(N/A)"),
831                 S_OR(c->cid.cid_dnid, "(N/A)"), 
832                 c->language,    
833                 ast_state2str(c->_state), c->_state, c->rings, 
834                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
835                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
836                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
837                 c->writetrans ? "Yes" : "No",
838                 c->readtrans ? "Yes" : "No",
839                 c->fds[0],
840                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
841                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
842                 (long)c->whentohangup,
843                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
844                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
845                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
846                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
847         
848         if (pbx_builtin_serialize_variables(c, &out))
849                 ast_cli(fd,"      Variables:\n%s\n", out->str);
850         if (c->cdr && ast_cdr_serialize_variables(c->cdr, &out, '=', '\n', 1))
851                 ast_cli(fd,"  CDR Variables:\n%s\n", out->str);
852         
853         ast_channel_unlock(c);
854         return RESULT_SUCCESS;
855 }
856
857 /*
858  * helper function to generate CLI matches from a fixed set of values.
859  * A NULL word is acceptable.
860  */
861 char *ast_cli_complete(const char *word, char *const choices[], int state)
862 {
863         int i, which = 0, len;
864         len = ast_strlen_zero(word) ? 0 : strlen(word);
865
866         for (i = 0; choices[i]; i++) {
867                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
868                         return ast_strdup(choices[i]);
869         }
870         return NULL;
871 }
872
873 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
874 {
875         struct ast_channel *c = NULL;
876         int which = 0;
877         int wordlen;
878         char notfound = '\0';
879         char *ret = &notfound; /* so NULL can break the loop */
880
881         if (pos != rpos)
882                 return NULL;
883
884         wordlen = strlen(word); 
885
886         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
887                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
888                         ret = ast_strdup(c->name);
889                 ast_channel_unlock(c);
890         }
891         return ret == &notfound ? NULL : ret;
892 }
893
894 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
895 {
896         return ast_complete_channels(line, word, pos, state, 2);
897 }
898
899 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
900 {
901         return ast_complete_channels(line, word, pos, state, 3);
902 }
903
904 static int group_show_channels(int fd, int argc, char *argv[])
905 {
906 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
907
908         struct ast_group_info *gi = NULL;
909         int numchans = 0;
910         regex_t regexbuf;
911         int havepattern = 0;
912
913         if (argc < 3 || argc > 4)
914                 return RESULT_SHOWUSAGE;
915         
916         if (argc == 4) {
917                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
918                         return RESULT_SHOWUSAGE;
919                 havepattern = 1;
920         }
921
922         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
923
924         ast_app_group_list_lock();
925         
926         gi = ast_app_group_list_head();
927         while (gi) {
928                 if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
929                         ast_cli(fd, FORMAT_STRING, gi->chan->name, gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
930                         numchans++;
931                 }
932                 gi = AST_LIST_NEXT(gi, list);
933         }
934         
935         ast_app_group_list_unlock();
936         
937         if (havepattern)
938                 regfree(&regexbuf);
939
940         ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
941         return RESULT_SUCCESS;
942 #undef FORMAT_STRING
943 }
944
945 /* XXX Nothing in this array can currently be deprecated...
946    You have to change the way find_cli works in order to remove this array
947    I recommend doing this eventually...
948  */
949 static struct ast_cli_entry builtins[] = {
950         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
951         { { "_command", "complete", NULL },
952         handle_commandcomplete, "Command complete",
953         commandcomplete_help },
954
955         { { "_command", "nummatches", NULL },
956         handle_commandnummatches, "Returns number of command matches",
957         commandnummatches_help },
958
959         { { "_command", "matchesarray", NULL },
960         handle_commandmatchesarray, "Returns command matches array",
961         commandmatchesarray_help },
962
963         { { NULL }, NULL, NULL, NULL }
964 };
965
966 static struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel");
967 static struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module");
968 static struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name");
969 static struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name");
970
971 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
972
973 static struct ast_cli_entry cli_cli[] = {
974         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
975         NEW_CLI(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
976
977         NEW_CLI(handle_chanlist, "Display information on channels"),
978
979         { { "core", "show", "channel", NULL },
980         handle_showchan, "Display information on a specific channel",
981         showchan_help, complete_ch_4 },
982
983         NEW_CLI(handle_core_set_debug_channel, "Enable/disable debugging on a channel",
984                 .deprecate_cmd = &cli_debug_channel_deprecated),
985
986         NEW_CLI(handle_verbose, "Set level of debug/verbose chattiness"),
987
988         { { "group", "show", "channels", NULL },
989         group_show_channels, "Display active channels with group(s)",
990         group_show_channels_help },
991
992         NEW_CLI(handle_help, "Display help list, or specific help on a command"),
993
994         { { "logger", "mute", NULL },
995         handle_logger_mute, "Toggle logging output to a console",
996         logger_mute_help },
997
998         NEW_CLI(handle_modlist, "List modules and info"),
999
1000         NEW_CLI(handle_load, "Load a module by name", .deprecate_cmd = &cli_module_load_deprecated),
1001
1002         NEW_CLI(handle_reload, "Reload configuration", .deprecate_cmd = &cli_module_reload_deprecated),
1003
1004         NEW_CLI(handle_unload, "Unload a module by name", .deprecate_cmd = &cli_module_unload_deprecated ),
1005
1006         NEW_CLI(handle_showuptime, "Show uptime information"),
1007
1008         { { "soft", "hangup", NULL },
1009         handle_softhangup, "Request a hangup on a given channel",
1010         softhangup_help, complete_ch_3 },
1011 };
1012
1013 /*!
1014  * Some regexp characters in cli arguments are reserved and used as separators.
1015  */
1016 static const char cli_rsvd[] = "[]{}|*%";
1017
1018 /*!
1019  * initialize the _full_cmd string and related parameters,
1020  * return 0 on success, -1 on error.
1021  */
1022 static int set_full_cmd(struct ast_cli_entry *e)
1023 {
1024         int i;
1025         char buf[80];
1026
1027         ast_join(buf, sizeof(buf), e->cmda);
1028         e->_full_cmd = strdup(buf);
1029         if (!e->_full_cmd) {
1030                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1031                 return -1;
1032         }
1033         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1034         for (i = 0; e->cmda[i]; i++)
1035                 ;
1036         e->args = i;
1037         return 0;
1038 }
1039
1040 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1041 void ast_builtins_init(void)
1042 {
1043         struct ast_cli_entry *e;
1044
1045         for (e = builtins; e->cmda[0] != NULL; e++)
1046                 set_full_cmd(e);
1047
1048         ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry));
1049 }
1050
1051 /*
1052  * We have two sets of commands: builtins are stored in a
1053  * NULL-terminated array of ast_cli_entry, whereas external
1054  * commands are in a list.
1055  * When navigating, we need to keep two pointers and get
1056  * the next one in lexicographic order. For the purpose,
1057  * we use a structure.
1058  */
1059
1060 struct cli_iterator {
1061         struct ast_cli_entry *builtins;
1062         struct ast_cli_entry *helpers;
1063 };
1064
1065 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
1066 {
1067         struct ast_cli_entry *e;
1068
1069         if (i->builtins == NULL && i->helpers == NULL) {
1070                 /* initialize */
1071                 i->builtins = builtins;
1072                 i->helpers = AST_LIST_FIRST(&helpers);
1073         }
1074         e = i->builtins; /* temporary */
1075         if (!e->cmda[0] || (i->helpers &&
1076                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
1077                 /* Use helpers */
1078                 e = i->helpers;
1079                 if (e)
1080                         i->helpers = AST_LIST_NEXT(e, list);
1081         } else { /* use builtin. e is already set  */
1082                 (i->builtins)++;        /* move to next */
1083         }
1084         return e;
1085 }
1086
1087 /*!
1088  * match a word in the CLI entry.
1089  * returns -1 on mismatch, 0 on match of an optional word,
1090  * 1 on match of a full word.
1091  *
1092  * The pattern can be
1093  *   any_word           match for equal
1094  *   [foo|bar|baz]      optionally, one of these words
1095  *   {foo|bar|baz}      exactly, one of these words
1096  *   %                  any word
1097  */
1098 static int word_match(const char *cmd, const char *cli_word)
1099 {
1100         int l;
1101         char *pos;
1102
1103         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1104                 return -1;
1105         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1106                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1107         /* regexp match, takes [foo|bar] or {foo|bar} */
1108         l = strlen(cmd);
1109         /* wildcard match - will extend in the future */
1110         if (l > 0 && cli_word[0] == '%') {
1111                 return 1;       /* wildcard */
1112         }
1113         pos = strcasestr(cli_word, cmd);
1114         if (pos == NULL) /* not found, say ok if optional */
1115                 return cli_word[0] == '[' ? 0 : -1;
1116         if (pos == cli_word)    /* no valid match at the beginning */
1117                 return -1;
1118         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1119                 return 1;       /* valid match */
1120         return -1;      /* not found */
1121 }
1122
1123 /*! \brief if word is a valid prefix for token, returns the pos-th
1124  * match as a malloced string, or NULL otherwise.
1125  * Always tell in *actual how many matches we got.
1126  */
1127 static char *is_prefix(const char *word, const char *token,
1128         int pos, int *actual)
1129 {
1130         int lw;
1131         char *s, *t1;
1132
1133         *actual = 0;
1134         if (ast_strlen_zero(token))
1135                 return NULL;
1136         if (ast_strlen_zero(word))
1137                 word = "";      /* dummy */
1138         lw = strlen(word);
1139         if (strcspn(word, cli_rsvd) != lw)
1140                 return NULL;    /* no match if word has reserved chars */
1141         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1142                 if (strncasecmp(token, word, lw))       /* no match */
1143                         return NULL;
1144                 *actual = 1;
1145                 return (pos != 0) ? NULL : strdup(token);
1146         }
1147         /* now handle regexp match */
1148
1149         /* Wildcard always matches, so we never do is_prefix on them */
1150
1151         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1152         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1153                 if (*s == '%')  /* wildcard */
1154                         continue;
1155                 if (strncasecmp(s, word, lw))   /* no match */
1156                         continue;
1157                 (*actual)++;
1158                 if (pos-- == 0)
1159                         return strdup(s);
1160         }
1161         return NULL;
1162 }
1163
1164 /*!
1165  * \brief locate a cli command in the 'helpers' list (which must be locked).
1166  * exact has 3 values:
1167  *      0       returns if the search key is equal or longer than the entry.
1168  *              note that trailing optional arguments are skipped.
1169  *      -1      true if the mismatch is on the last word XXX not true!
1170  *      1       true only on complete, exact match.
1171  *
1172  * The search compares word by word taking care of regexps in e->cmda
1173  */
1174 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
1175 {
1176         int matchlen = -1;      /* length of longest match so far */
1177         struct ast_cli_entry *cand = NULL, *e=NULL;
1178         struct cli_iterator i = { NULL, NULL};
1179
1180         while ( (e = cli_next(&i)) ) {
1181                 /* word-by word regexp comparison */
1182                 char * const *src = cmds;
1183                 char * const *dst = e->cmda;
1184                 int n = 0;
1185                 for (;; dst++, src += n) {
1186                         n = word_match(*src, *dst);
1187                         if (n < 0)
1188                                 break;
1189                 }
1190                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1191                         /* no more words in 'e' */
1192                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1193                                 break;
1194                         /* Here, cmds has more words than the entry 'e' */
1195                         if (match_type != 0)    /* but we look for almost exact match... */
1196                                 continue;       /* so we skip this one. */
1197                         /* otherwise we like it (case 0) */
1198                 } else {        /* still words in 'e' */
1199                         if (ast_strlen_zero(*src))
1200                                 continue; /* cmds is shorter than 'e', not good */
1201                         /* Here we have leftover words in cmds and 'e',
1202                          * but there is a mismatch. We only accept this one if match_type == -1
1203                          * and this is the last word for both.
1204                          */
1205                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1206                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1207                                 continue;
1208                         /* good, we are in case match_type == -1 and mismatch on last word */
1209                 }
1210                 if (src - cmds > matchlen) {    /* remember the candidate */
1211                         matchlen = src - cmds;
1212                         cand = e;
1213                 }
1214         }
1215         return e ? e : cand;
1216 }
1217
1218 static char *find_best(char *argv[])
1219 {
1220         static char cmdline[80];
1221         int x;
1222         /* See how close we get, then print the candidate */
1223         char *myargv[AST_MAX_CMD_LEN];
1224         for (x=0;x<AST_MAX_CMD_LEN;x++)
1225                 myargv[x]=NULL;
1226         AST_LIST_LOCK(&helpers);
1227         for (x=0;argv[x];x++) {
1228                 myargv[x] = argv[x];
1229                 if (!find_cli(myargv, -1))
1230                         break;
1231         }
1232         AST_LIST_UNLOCK(&helpers);
1233         ast_join(cmdline, sizeof(cmdline), myargv);
1234         return cmdline;
1235 }
1236
1237 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1238 {
1239         if (e->deprecate_cmd) {
1240                 __ast_cli_unregister(e->deprecate_cmd, e);
1241         }
1242         if (e->inuse) {
1243                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1244         } else {
1245                 AST_LIST_LOCK(&helpers);
1246                 AST_LIST_REMOVE(&helpers, e, list);
1247                 AST_LIST_UNLOCK(&helpers);
1248                 free(e->_full_cmd);
1249                 e->_full_cmd = NULL;
1250                 if (e->new_handler) {
1251                         /* this is a new-style entry. Reset fields and free memory. */
1252                         bzero((char **)(e->cmda), sizeof(e->cmda));
1253                         free(e->command);
1254                         e->command = NULL;
1255                         e->usage = NULL;
1256                 }
1257         }
1258         return 0;
1259 }
1260
1261 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1262 {
1263         struct ast_cli_entry *cur;
1264         int i, lf, ret = -1;
1265
1266         if (e->handler == NULL) {       /* new style entry, run the handler to init fields */
1267                 struct ast_cli_args a;  /* fake argument */
1268                 char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
1269                 char *s;
1270
1271                 bzero (&a, sizeof(a));
1272                 e->new_handler(e, CLI_INIT, &a);
1273                 /* XXX check that usage and command are filled up */
1274                 s = ast_skip_blanks(e->command);
1275                 s = e->command = ast_strdup(s);
1276                 for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
1277                         *dst++ = s;     /* store string */
1278                         s = ast_skip_nonblanks(s);
1279                         if (*s == '\0') /* we are done */
1280                                 break;
1281                         *s++ = '\0';
1282                         s = ast_skip_blanks(s);
1283                 }
1284                 *dst++ = NULL;
1285         }
1286         if (set_full_cmd(e))
1287                 goto done;
1288         AST_LIST_LOCK(&helpers);
1289         
1290         if (find_cli(e->cmda, 1)) {
1291                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", e->_full_cmd);
1292                 free(e->_full_cmd);
1293                 e->_full_cmd = NULL;
1294                 goto done;
1295         }
1296         if (!ed) {
1297                 e->deprecated = 0;
1298         } else {
1299                 e->deprecated = 1;
1300                 e->summary = ed->summary;
1301                 e->usage = ed->usage;
1302                 /* XXX If command A deprecates command B, and command B deprecates command C...
1303                    Do we want to show command A or command B when telling the user to use new syntax?
1304                    This currently would show command A.
1305                    To show command B, you just need to always use ed->_full_cmd.
1306                  */
1307                 e->_deprecated_by = S_OR(ed->_deprecated_by, ed->_full_cmd);
1308         }
1309
1310         lf = e->cmdlen;
1311         AST_LIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1312                 int len = cur->cmdlen;
1313                 if (lf < len)
1314                         len = lf;
1315                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
1316                         AST_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); 
1317                         break;
1318                 }
1319         }
1320         AST_LIST_TRAVERSE_SAFE_END;
1321
1322         if (!cur)
1323                 AST_LIST_INSERT_TAIL(&helpers, e, list); 
1324         ret = 0;        /* success */
1325
1326 done:
1327         AST_LIST_UNLOCK(&helpers);
1328
1329         if (e->deprecate_cmd) {
1330                 /* This command deprecates another command.  Register that one also. */
1331                 __ast_cli_register(e->deprecate_cmd, e);
1332         }
1333         
1334         return ret;
1335 }
1336
1337 /* wrapper function, so we can unregister deprecated commands recursively */
1338 int ast_cli_unregister(struct ast_cli_entry *e)
1339 {
1340         return __ast_cli_unregister(e, NULL);
1341 }
1342
1343 /* wrapper function, so we can register deprecated commands recursively */
1344 int ast_cli_register(struct ast_cli_entry *e)
1345 {
1346         return __ast_cli_register(e, NULL);
1347 }
1348
1349 /*
1350  * register/unregister an array of entries.
1351  */
1352 int ast_cli_register_multiple(struct ast_cli_entry *e, int len)
1353 {
1354         int i, res = 0;
1355
1356         for (i = 0; i < len; i++)
1357                 res |= ast_cli_register(e + i);
1358
1359         return res;
1360 }
1361
1362 int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
1363 {
1364         int i, res = 0;
1365
1366         for (i = 0; i < len; i++)
1367                 res |= ast_cli_unregister(e + i);
1368
1369         return res;
1370 }
1371
1372
1373 /*! \brief helper for final part of
1374  * handle_help. if locked = 0 it's just "help_workhorse",
1375  * otherwise assume the list is already locked and print
1376  * an error message if not found.
1377  */
1378 static char *help1(int fd, char *match[], int locked)
1379 {
1380         char matchstr[80] = "";
1381         struct ast_cli_entry *e;
1382         int len = 0;
1383         int found = 0;
1384         struct cli_iterator i = { NULL, NULL};
1385
1386         if (match) {
1387                 ast_join(matchstr, sizeof(matchstr), match);
1388                 len = strlen(matchstr);
1389         }
1390         if (!locked)
1391                 AST_LIST_LOCK(&helpers);
1392         while ( (e = cli_next(&i)) ) {
1393                 /* Hide commands that start with '_' */
1394                 if (e->_full_cmd[0] == '_')
1395                         continue;
1396                 /* Hide commands that are marked as deprecated. */
1397                 if (e->deprecated)
1398                         continue;
1399                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
1400                         continue;
1401                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
1402                 found++;
1403         }
1404         if (!locked)
1405                 AST_LIST_UNLOCK(&helpers);
1406         if (!locked && !found && matchstr[0])
1407                 ast_cli(fd, "No such command '%s'.\n", matchstr);
1408         return CLI_SUCCESS;
1409 }
1410
1411 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1412 {
1413         char fullcmd[80];
1414         struct ast_cli_entry *my_e;
1415
1416         if (cmd == CLI_INIT) {
1417                 e->command = "help";
1418                 e->usage =
1419                         "Usage: help [topic]\n"
1420                         "       When called with a topic as an argument, displays usage\n"
1421                         "       information on the given command. If called without a\n"
1422                         "       topic, it provides a list of commands.\n";
1423                 return NULL;
1424
1425         } else if (cmd == CLI_GENERATE) {
1426                 /* skip first 4 or 5 chars, "help " */
1427                 int l = strlen(a->line);
1428
1429                 if (l > 5)
1430                         l = 5;
1431                 /* XXX watch out, should stop to the non-generator parts */
1432                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
1433         }
1434         if (a->argc == 1)
1435                 return help1(a->fd, NULL, 0);
1436
1437         AST_LIST_LOCK(&helpers);
1438         my_e = find_cli(a->argv + 1, 1);        /* try exact match first */
1439         if (!my_e)
1440                 return help1(a->fd, a->argv + 1, 1 /* locked */);
1441         if (my_e->usage)
1442                 ast_cli(a->fd, "%s", my_e->usage);
1443         else {
1444                 ast_join(fullcmd, sizeof(fullcmd), a->argv+1);
1445                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
1446         }
1447         AST_LIST_UNLOCK(&helpers);
1448         return RESULT_SUCCESS;
1449 }
1450
1451 static char *parse_args(const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
1452 {
1453         char *dup, *cur;
1454         int x = 0;
1455         int quoted = 0;
1456         int escaped = 0;
1457         int whitespace = 1;
1458         int dummy = 0;
1459
1460         if (trailingwhitespace == NULL)
1461                 trailingwhitespace = &dummy;
1462         *trailingwhitespace = 0;
1463         if (s == NULL)  /* invalid, though! */
1464                 return NULL;
1465         /* make a copy to store the parsed string */
1466         if (!(dup = ast_strdup(s)))
1467                 return NULL;
1468
1469         cur = dup;
1470         /* scan the original string copying into cur when needed */
1471         for (; *s ; s++) {
1472                 if (x >= max - 1) {
1473                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1474                         break;
1475                 }
1476                 if (*s == '"' && !escaped) {
1477                         quoted = !quoted;
1478                         if (quoted && whitespace) {
1479                                 /* start a quoted string from previous whitespace: new argument */
1480                                 argv[x++] = cur;
1481                                 whitespace = 0;
1482                         }
1483                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1484                         /* If we are not already in whitespace, and not in a quoted string or
1485                            processing an escape sequence, and just entered whitespace, then
1486                            finalize the previous argument and remember that we are in whitespace
1487                         */
1488                         if (!whitespace) {
1489                                 *cur++ = '\0';
1490                                 whitespace = 1;
1491                         }
1492                 } else if (*s == '\\' && !escaped) {
1493                         escaped = 1;
1494                 } else {
1495                         if (whitespace) {
1496                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1497                                 argv[x++] = cur;
1498                                 whitespace = 0;
1499                         }
1500                         *cur++ = *s;
1501                         escaped = 0;
1502                 }
1503         }
1504         /* Null terminate */
1505         *cur++ = '\0';
1506         /* XXX put a NULL in the last argument, because some functions that take
1507          * the array may want a null-terminated array.
1508          * argc still reflects the number of non-NULL entries.
1509          */
1510         argv[x] = NULL;
1511         *argc = x;
1512         *trailingwhitespace = whitespace;
1513         return dup;
1514 }
1515
1516 /*! \brief Return the number of unique matches for the generator */
1517 int ast_cli_generatornummatches(const char *text, const char *word)
1518 {
1519         int matches = 0, i = 0;
1520         char *buf = NULL, *oldbuf = NULL;
1521
1522         while ((buf = ast_cli_generator(text, word, i++))) {
1523                 if (!oldbuf || strcmp(buf,oldbuf))
1524                         matches++;
1525                 if (oldbuf)
1526                         free(oldbuf);
1527                 oldbuf = buf;
1528         }
1529         if (oldbuf)
1530                 free(oldbuf);
1531         return matches;
1532 }
1533
1534 char **ast_cli_completion_matches(const char *text, const char *word)
1535 {
1536         char **match_list = NULL, *retstr, *prevstr;
1537         size_t match_list_len, max_equal, which, i;
1538         int matches = 0;
1539
1540         /* leave entry 0 free for the longest common substring */
1541         match_list_len = 1;
1542         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1543                 if (matches + 1 >= match_list_len) {
1544                         match_list_len <<= 1;
1545                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1546                                 return NULL;
1547                 }
1548                 match_list[++matches] = retstr;
1549         }
1550
1551         if (!match_list)
1552                 return match_list; /* NULL */
1553
1554         /* Find the longest substring that is common to all results
1555          * (it is a candidate for completion), and store a copy in entry 0.
1556          */
1557         prevstr = match_list[1];
1558         max_equal = strlen(prevstr);
1559         for (which = 2; which <= matches; which++) {
1560                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1561                         continue;
1562                 max_equal = i;
1563         }
1564
1565         if (!(retstr = ast_malloc(max_equal + 1)))
1566                 return NULL;
1567         
1568         ast_copy_string(retstr, match_list[1], max_equal + 1);
1569         match_list[0] = retstr;
1570
1571         /* ensure that the array is NULL terminated */
1572         if (matches + 1 >= match_list_len) {
1573                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1574                         return NULL;
1575         }
1576         match_list[matches + 1] = NULL;
1577
1578         return match_list;
1579 }
1580
1581 /*! \brief returns true if there are more words to match */
1582 static int more_words (char * const *dst)
1583 {
1584         int i;
1585         for (i = 0; dst[i]; i++) {
1586                 if (dst[i][0] != '[')
1587                         return -1;
1588         }
1589         return 0;
1590 }
1591         
1592 /*
1593  * generate the entry at position 'state'
1594  */
1595 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1596 {
1597         char *argv[AST_MAX_ARGS];
1598         struct ast_cli_entry *e;
1599         struct cli_iterator i = { NULL, NULL };
1600         int x = 0, argindex, matchlen;
1601         int matchnum=0;
1602         char *ret = NULL;
1603         char matchstr[80] = "";
1604         int tws = 0;
1605         /* Split the argument into an array of words */
1606         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1607
1608         if (!dup)       /* malloc error */
1609                 return NULL;
1610
1611         /* Compute the index of the last argument (could be an empty string) */
1612         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1613
1614         /* rebuild the command, ignore terminating white space and flatten space */
1615         ast_join(matchstr, sizeof(matchstr)-1, argv);
1616         matchlen = strlen(matchstr);
1617         if (tws) {
1618                 strcat(matchstr, " "); /* XXX */
1619                 if (matchlen)
1620                         matchlen++;
1621         }
1622         if (lock)
1623                 AST_LIST_LOCK(&helpers);
1624         while ( (e = cli_next(&i)) ) {
1625                 /* XXX repeated code */
1626                 int src = 0, dst = 0, n = 0;
1627
1628                 /*
1629                  * Try to match words, up to and excluding the last word, which
1630                  * is either a blank or something that we want to extend.
1631                  */
1632                 for (;src < argindex; dst++, src += n) {
1633                         n = word_match(argv[src], e->cmda[dst]);
1634                         if (n < 0)
1635                                 break;
1636                 }
1637
1638                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
1639                         continue;
1640                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
1641                 matchnum += n;  /* this many matches here */
1642                 if (ret) {
1643                         /*
1644                          * argv[src] is a valid prefix of the next word in this
1645                          * command. If this is also the correct entry, return it.
1646                          */
1647                         if (matchnum > state)
1648                                 break;
1649                         free(ret);
1650                         ret = NULL;
1651                 } else if (ast_strlen_zero(e->cmda[dst])) {
1652                         /*
1653                          * This entry is a prefix of the command string entered
1654                          * (only one entry in the list should have this property).
1655                          * Run the generator if one is available. In any case we are done.
1656                          */
1657                         if (e->generator)
1658                                 ret = e->generator(matchstr, word, argindex, state - matchnum);
1659                         else if (e->new_handler) {      /* new style command */
1660                                 struct ast_cli_args a = {
1661                                         .line = matchstr, .word = word,
1662                                         .pos = argindex,
1663                                         .n = state - matchnum };
1664                                 ret = e->new_handler(e, CLI_GENERATE, &a);
1665                         }
1666                         if (ret)
1667                                 break;
1668                 }
1669         }
1670         if (lock)
1671                 AST_LIST_UNLOCK(&helpers);
1672         free(dup);
1673         return ret;
1674 }
1675
1676 char *ast_cli_generator(const char *text, const char *word, int state)
1677 {
1678         return __ast_cli_generator(text, word, state, 1);
1679 }
1680
1681 int ast_cli_command(int fd, const char *s)
1682 {
1683         char *args[AST_MAX_ARGS + 1];
1684         struct ast_cli_entry *e;
1685         int x;
1686         int res;
1687         char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
1688
1689         if (dup == NULL)
1690                 return -1;
1691
1692         if (x < 1)      /* We need at least one entry, otherwise ignore */
1693                 goto done;
1694
1695         AST_LIST_LOCK(&helpers);
1696         e = find_cli(args + 1, 0);
1697         if (e)
1698                 ast_atomic_fetchadd_int(&e->inuse, 1);
1699         AST_LIST_UNLOCK(&helpers);
1700         if (e == NULL) {
1701                 ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1));
1702                 goto done;
1703         }
1704         /*
1705          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
1706          * Remember that the array returned by parse_args is NULL-terminated.
1707          */
1708         args[0] = (char *)e;
1709
1710         if (!e->new_handler)    /* old style */
1711                 res = e->handler(fd, x, args + 1);
1712         else {
1713                 struct ast_cli_args a = {
1714                         .fd = fd, .argc = x, .argv = args+1 };
1715                 char *retval = e->new_handler(e, CLI_HANDLER, &a);
1716
1717                 if (retval == CLI_SUCCESS)
1718                         res = RESULT_SUCCESS;
1719                 else if (retval == CLI_SHOWUSAGE)
1720                         res = RESULT_SHOWUSAGE;
1721                 else
1722                         res = RESULT_FAILURE;
1723         }
1724         switch (res) {
1725         case RESULT_SHOWUSAGE:
1726                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
1727                 AST_LIST_LOCK(&helpers);
1728                 if (e->deprecated)
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                 AST_LIST_UNLOCK(&helpers);
1731                 break;
1732         case RESULT_FAILURE:
1733                 ast_cli(fd, "Command '%s' failed.\n", s);
1734                 /* FALLTHROUGH */
1735         default:
1736                 AST_LIST_LOCK(&helpers);
1737                 if (e->deprecated == 1) {
1738                         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);
1739                         e->deprecated = 2;
1740                 }
1741                 AST_LIST_UNLOCK(&helpers);
1742                 break;
1743         }
1744         ast_atomic_fetchadd_int(&e->inuse, -1);
1745 done:
1746         free(dup);
1747         return 0;
1748 }