main/cli.c

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