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