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