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