Sat Nov 1 06:28:35 2008

Asterisk developer's documentation

---

pbx_config.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2006, Digium, Inc.
 *
 * Mark Spencer <markster@digium.com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 *
 * \brief Populate and remember extensions from static config file
 *
 * 
 */

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision: 143612 $")

#include <sys/types.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>

#include "asterisk/pbx.h"
#include "asterisk/config.h"
#include "asterisk/options.h"
#include "asterisk/module.h"
#include "asterisk/logger.h"
#include "asterisk/cli.h"
#include "asterisk/callerid.h"

static char *config = "extensions.conf";
static char *registrar = "pbx_config";
static char userscontext[AST_MAX_EXTENSION] = "default";

static int static_config = 0;
static int write_protect_config = 1;
static int autofallthrough_config = 1;
static int clearglobalvars_config = 0;

AST_MUTEX_DEFINE_STATIC(save_dialplan_lock);

static struct ast_context *local_contexts = NULL;

/*
 * Help for commands provided by this module ...
 */
static char context_add_extension_help[] =
"Usage: dialplan add extension <exten>,<priority>,<app>,<app-data>\n"
"       into <context> [replace]\n\n"
"       This command will add new extension into <context>. If there is an\n"
"       existence of extension with the same priority and last 'replace'\n"
"       arguments is given here we simply replace this extension.\n"
"\n"
"Example: dialplan add extension 6123,1,Dial,IAX/216.207.245.56/6123 into local\n"
"         Now, you can dial 6123 and talk to Markster :)\n";

static char context_remove_extension_help[] =
"Usage: dialplan remove extension exten[/cid]@context [priority]\n"
"       Remove an extension from a given context. If a priority\n"
"       is given, only that specific priority from the given extension\n"
"       will be removed.\n";

static char context_add_ignorepat_help[] =
"Usage: dialplan add ignorepat <pattern> into <context>\n"
"       This command adds a new ignore pattern into context <context>\n"
"\n"
"Example: dialplan add ignorepat _3XX into local\n";

static char context_remove_ignorepat_help[] =
"Usage: dialplan remove ignorepat <pattern> from <context>\n"
"       This command removes an ignore pattern from context <context>\n"
"\n"
"Example: dialplan remove ignorepat _3XX from local\n";

static char context_add_include_help[] =
"Usage: dialplan add include <context> into <context>\n"
"       Include a context in another context.\n";

static char context_remove_include_help[] =
"Usage: dialplan remove include <context> from <context>\n"
"       Remove an included context from another context.\n";

static char save_dialplan_help[] =
"Usage: dialplan save [/path/to/extension/file]\n"
"       Save dialplan created by pbx_config module.\n"
"\n"
"Example: dialplan save                 (/etc/asterisk/extensions.conf)\n"
"         dialplan save /home/markster  (/home/markster/extensions.conf)\n";

static char reload_extensions_help[] =
"Usage: dialplan reload\n"
"       reload extensions.conf without reloading any other modules\n"
"       This command does not delete global variables unless\n"
"       clearglobalvars is set to yes in extensions.conf\n";

/*
 * Implementation of functions provided by this module
 */

/*!
 * REMOVE INCLUDE command stuff
 */
static int handle_context_dont_include_deprecated(int fd, int argc, char *argv[])
{
   if (argc != 5)
      return RESULT_SHOWUSAGE;

   if (strcmp(argv[3], "into"))
      return RESULT_SHOWUSAGE;

   if (!ast_context_remove_include(argv[4], argv[2], registrar)) {
      ast_cli(fd, "We are not including '%s' into '%s' now\n",
         argv[2], argv[4]);
      return RESULT_SUCCESS;
   }

   ast_cli(fd, "Failed to remove '%s' include from '%s' context\n",
      argv[2], argv[4]);
   return RESULT_FAILURE;
}

static int handle_context_remove_include(int fd, int argc, char *argv[])
{
   if (argc != 6) {
      return RESULT_SHOWUSAGE;
   }

   if (strcmp(argv[4], "from")) {
      return RESULT_SHOWUSAGE;
   }

   if (!ast_context_remove_include(argv[5], argv[3], registrar)) {
      ast_cli(fd, "The dialplan no longer includes '%s' into '%s'\n",
         argv[3], argv[5]);
      return RESULT_SUCCESS;
   }

   ast_cli(fd, "Failed to remove '%s' include from '%s' context\n",
      argv[3], argv[5]);

   return RESULT_FAILURE;
}

/*! \brief return true if 'name' is included by context c */
static int lookup_ci(struct ast_context *c, const char *name)
{
   struct ast_include *i = NULL;

   if (ast_lock_context(c))   /* error, skip */
      return 0;
   while ( (i = ast_walk_context_includes(c, i)) )
      if (!strcmp(name, ast_get_include_name(i)))
         break;
   ast_unlock_context(c);
   return i ? -1 /* success */ : 0;
}

/*! \brief return true if 'name' is in the ignorepats for context c */
static int lookup_c_ip(struct ast_context *c, const char *name)
{
   struct ast_ignorepat *ip = NULL;

   if (ast_lock_context(c))   /* error, skip */
      return 0;
   while ( (ip = ast_walk_context_ignorepats(c, ip)) )
      if (!strcmp(name, ast_get_ignorepat_name(ip)))
         break;
   ast_unlock_context(c);
   return ip ? -1 /* success */ : 0;
}

/*! \brief moves to the n-th word in the string, or empty string if none */
static const char *skip_words(const char *p, int n)
{
   int in_blank = 0;
   for (;n && *p; p++) {
      if (isblank(*p) /* XXX order is important */ && !in_blank) {
         n--;  /* one word is gone */
         in_blank = 1;
      } else if (/* !is_blank(*p), we know already, && */ in_blank) {
         in_blank = 0;
      }
   }
   return p;
}

/*! \brief match the first 'len' chars of word. len==0 always succeeds */
static int partial_match(const char *s, const char *word, int len)
{
   return (len == 0 || !strncmp(s, word, len));
}

/*! \brief split extension\@context in two parts, return -1 on error.
 * The return string is malloc'ed and pointed by *ext
 */
static int split_ec(const char *src, char **ext, char ** const ctx, char ** const cid)
{
   char *i, *c, *e = ast_strdup(src); /* now src is not used anymore */

   if (e == NULL)
      return -1;  /* malloc error */
   /* now, parse values from 'exten@context' */
   *ext = e;
   c = strchr(e, '@');
   if (c == NULL) /* no context part */
      *ctx = "";  /* it is not overwritten, anyways */
   else {   /* found context, check for duplicity ... */
      *c++ = '\0';
      *ctx = c;
      if (strchr(c, '@')) { /* two @, not allowed */
         free(e);
         return -1;
      }
   }
   if (cid && (i = strchr(e, '/'))) {
      *i++ = '\0';
      *cid = i;
   } else if (cid) {
      /* Signal none detected */
      *cid = NULL;
   }
   return 0;
}

/* _X_ is the string we need to complete */
static char *complete_context_dont_include_deprecated(const char *line, const char *word,
   int pos, int state)
{
   int which = 0;
   char *res = NULL;
   int len = strlen(word); /* how many bytes to match */
   struct ast_context *c = NULL;

   if (pos == 2) {      /* "dont include _X_" */
      if (ast_wrlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         return NULL;
      }
      /* walk contexts and their includes, return the n-th match */
      while (!res && (c = ast_walk_contexts(c))) {
         struct ast_include *i = NULL;

         if (ast_lock_context(c))   /* error ? skip this one */
            continue;

         while ( !res && (i = ast_walk_context_includes(c, i)) ) {
            const char *i_name = ast_get_include_name(i);
            struct ast_context *nc = NULL;
            int already_served = 0;

            if (!partial_match(i_name, word, len))
               continue;   /* not matched */

            /* check if this include is already served or not */

            /* go through all contexts again till we reach actual
             * context or already_served = 1
             */
            while ( (nc = ast_walk_contexts(nc)) && nc != c && !already_served)
               already_served = lookup_ci(nc, i_name);

            if (!already_served && ++which > state)
               res = strdup(i_name);
         }
         ast_unlock_context(c);
      }

      ast_unlock_contexts();
      return res;
   } else if (pos == 3) { /* "dont include CTX _X_" */
      /*
       * complete as 'in', but only if previous context is really
       * included somewhere
       */
      char *context, *dupline;
      const char *s = skip_words(line, 2); /* skip 'dont' 'include' */

      if (state > 0)
         return NULL;
      context = dupline = strdup(s);
      if (!dupline) {
         ast_log(LOG_ERROR, "Out of free memory\n");
         return NULL;
      }
      strsep(&dupline, " ");

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock contexts list\n");
         free(context);
         return NULL;
      }

      /* go through all contexts and check if is included ... */
      while (!res && (c = ast_walk_contexts(c)))
         if (lookup_ci(c, context)) /* context is really included, complete "in" command */
            res = strdup("in");
      ast_unlock_contexts();
      if (!res)
         ast_log(LOG_WARNING, "%s not included anywhere\n", context);
      free(context);
      return res;
   } else if (pos == 4) { /* "dont include CTX in _X_" */
      /*
       * Context from which we removing include ... 
       */
      char *context, *dupline, *in;
      const char *s = skip_words(line, 2); /* skip 'dont' 'include' */
      context = dupline = strdup(s);
      if (!dupline) {
         ast_log(LOG_ERROR, "Out of free memory\n");
         return NULL;
      }

      strsep(&dupline, " "); /* skip context */

      /* third word must be 'in' */
      in = strsep(&dupline, " ");
      if (!in || strcmp(in, "in")) {
         free(context);
         return NULL;
      }

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         free(context);
         return NULL;
      }

      /* walk through all contexts ... */
      c = NULL;
      while ( !res && (c = ast_walk_contexts(c))) {
         const char *c_name = ast_get_context_name(c);
         if (!partial_match(c_name, word, len)) /* not a good target */
            continue;
         /* walk through all includes and check if it is our context */ 
         if (lookup_ci(c, context) && ++which > state)
            res = strdup(c_name);
      }
      ast_unlock_contexts();
      free(context);
      return res;
   }

   return NULL;
}

static char *complete_context_remove_include(const char *line, const char *word,
   int pos, int state)
{
   int which = 0;
   char *res = NULL;
   int len = strlen(word); /* how many bytes to match */
   struct ast_context *c = NULL;

   if (pos == 3) {      /* "dialplan remove include _X_" */
      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         return NULL;
      }
      /* walk contexts and their includes, return the n-th match */
      while (!res && (c = ast_walk_contexts(c))) {
         struct ast_include *i = NULL;

         if (ast_lock_context(c))   /* error ? skip this one */
            continue;

         while ( !res && (i = ast_walk_context_includes(c, i)) ) {
            const char *i_name = ast_get_include_name(i);
            struct ast_context *nc = NULL;
            int already_served = 0;

            if (!partial_match(i_name, word, len))
               continue;   /* not matched */

            /* check if this include is already served or not */

            /* go through all contexts again till we reach actual
             * context or already_served = 1
             */
            while ( (nc = ast_walk_contexts(nc)) && nc != c && !already_served)
               already_served = lookup_ci(nc, i_name);

            if (!already_served && ++which > state)
               res = strdup(i_name);
         }
         ast_unlock_context(c);
      }

      ast_unlock_contexts();
      return res;
   } else if (pos == 4) { /* "dialplan remove include CTX _X_" */
      /*
       * complete as 'from', but only if previous context is really
       * included somewhere
       */
      char *context, *dupline;
      const char *s = skip_words(line, 3); /* skip 'dialplan' 'remove' 'include' */

      if (state > 0)
         return NULL;
      context = dupline = strdup(s);
      if (!dupline) {
         ast_log(LOG_ERROR, "Out of free memory\n");
         return NULL;
      }
      strsep(&dupline, " ");

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock contexts list\n");
         free(context);
         return NULL;
      }

      /* go through all contexts and check if is included ... */
      while (!res && (c = ast_walk_contexts(c)))
         if (lookup_ci(c, context)) /* context is really included, complete "from" command */
            res = strdup("from");
      ast_unlock_contexts();
      if (!res)
         ast_log(LOG_WARNING, "%s not included anywhere\n", context);
      free(context);
      return res;
   } else if (pos == 5) { /* "dialplan remove include CTX from _X_" */
      /*
       * Context from which we removing include ... 
       */
      char *context, *dupline, *from;
      const char *s = skip_words(line, 3); /* skip 'dialplan' 'remove' 'include' */
      context = dupline = strdup(s);
      if (!dupline) {
         ast_log(LOG_ERROR, "Out of free memory\n");
         return NULL;
      }

      strsep(&dupline, " "); /* skip context */

      /* fourth word must be 'from' */
      from = strsep(&dupline, " ");
      if (!from || strcmp(from, "from")) {
         free(context);
         return NULL;
      }

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         free(context);
         return NULL;
      }

      /* walk through all contexts ... */
      c = NULL;
      while ( !res && (c = ast_walk_contexts(c))) {
         const char *c_name = ast_get_context_name(c);
         if (!partial_match(c_name, word, len)) /* not a good target */
            continue;
         /* walk through all includes and check if it is our context */ 
         if (lookup_ci(c, context) && ++which > state)
            res = strdup(c_name);
      }
      ast_unlock_contexts();
      free(context);
      return res;
   }

   return NULL;
}

/*!
 * REMOVE EXTENSION command stuff
 */
static int handle_context_remove_extension_deprecated(int fd, int argc, char *argv[])
{
   int removing_priority = 0;
   char *exten, *context, *cid;
   int ret = RESULT_FAILURE;

   if (argc != 4 && argc != 3) return RESULT_SHOWUSAGE;

   /*
    * Priority input checking ...
    */
   if (argc == 4) {
      char *c = argv[3];

      /* check for digits in whole parameter for right priority ...
       * why? because atoi (strtol) returns 0 if any characters in
       * string and whole extension will be removed, it's not good
       */
      if (!strcmp("hint", c))
         removing_priority = PRIORITY_HINT;
      else {
         while (*c && isdigit(*c))
            c++;
         if (*c) { /* non-digit in string */
            ast_cli(fd, "Invalid priority '%s'\n", argv[3]);
            return RESULT_FAILURE;
         }
         removing_priority = atoi(argv[3]);
      }

      if (removing_priority == 0) {
         ast_cli(fd, "If you want to remove whole extension, please " \
            "omit priority argument\n");
         return RESULT_FAILURE;
      }
   }

   /* XXX original overwrote argv[2] */
   /*
    * Format exten@context checking ...
    */
   if (split_ec(argv[2], &exten, &context, &cid))
      return RESULT_FAILURE; /* XXX malloc failure */
   if ((!strlen(exten)) || (!(strlen(context)))) {
      ast_cli(fd, "Missing extension or context name in second argument '%s'\n",
         argv[2]);
      free(exten);
      return RESULT_FAILURE;
   }

   if (!ast_context_remove_extension_callerid(context, exten, removing_priority,
         /* Do NOT substitute S_OR; it is NOT the same thing */
         cid ? cid : (removing_priority ? "" : NULL), cid ? 1 : 0, registrar)) {
      if (!removing_priority)
         ast_cli(fd, "Whole extension %s@%s removed\n",
            exten, context);
      else
         ast_cli(fd, "Extension %s@%s with priority %d removed\n",
            exten, context, removing_priority);
         
      ret = RESULT_SUCCESS;
   } else {
      ast_cli(fd, "Failed to remove extension %s@%s\n", exten, context);
      ret = RESULT_FAILURE;
   }
   free(exten);
   return ret;
}

static int handle_context_remove_extension(int fd, int argc, char *argv[])
{
   int removing_priority = 0;
   char *exten, *context, *cid;
   int ret = RESULT_FAILURE;

   if (argc != 5 && argc != 4) return RESULT_SHOWUSAGE;

   /*
    * Priority input checking ...
    */
   if (argc == 5) {
      char *c = argv[4];

      /* check for digits in whole parameter for right priority ...
       * why? because atoi (strtol) returns 0 if any characters in
       * string and whole extension will be removed, it's not good
       */
      if (!strcmp("hint", c))
         removing_priority = PRIORITY_HINT;
      else {
         while (*c && isdigit(*c))
            c++;
         if (*c) { /* non-digit in string */
            ast_cli(fd, "Invalid priority '%s'\n", argv[4]);
            return RESULT_FAILURE;
         }
         removing_priority = atoi(argv[4]);
      }

      if (removing_priority == 0) {
         ast_cli(fd, "If you want to remove whole extension, please " \
            "omit priority argument\n");
         return RESULT_FAILURE;
      }
   }

   /* XXX original overwrote argv[3] */
   /*
    * Format exten@context checking ...
    */
   if (split_ec(argv[3], &exten, &context, &cid))
      return RESULT_FAILURE; /* XXX malloc failure */
   if ((!strlen(exten)) || (!(strlen(context)))) {
      ast_cli(fd, "Missing extension or context name in third argument '%s'\n",
         argv[3]);
      free(exten);
      return RESULT_FAILURE;
   }

   if (!ast_context_remove_extension_callerid(context, exten, removing_priority,
         /* Do NOT substitute S_OR; it is NOT the same thing */
         cid ? cid : (removing_priority ? "" : NULL), cid ? 1 : 0, registrar)) {
      if (!removing_priority)
         ast_cli(fd, "Whole extension %s@%s removed\n",
            exten, context);
      else
         ast_cli(fd, "Extension %s@%s with priority %d removed\n",
            exten, context, removing_priority);
         
      ret = RESULT_SUCCESS;
   } else {
      ast_cli(fd, "Failed to remove extension %s@%s\n", exten, context);
      ret = RESULT_FAILURE;
   }
   free(exten);
   return ret;
}

#define BROKEN_READLINE 1

#ifdef BROKEN_READLINE
/*
 * There is one funny thing, when you have word like 300@ and you hit
 * <tab>, you arguments will like as your word is '300 ', so it '@'
 * characters acts sometimes as word delimiter and sometimes as a part
 * of word
 *
 * This fix function, allocates new word variable and store here every
 * time xxx@yyy always as one word and correct pos is set too
 *
 * It's ugly, I know, but I'm waiting for Mark suggestion if upper is
 * bug or feature ...
 */
static int fix_complete_args(const char *line, char **word, int *pos)
{
   char *_line, *_strsep_line, *_previous_word = NULL, *_word = NULL;
   int words = 0;

   _line = strdup(line);

   _strsep_line = _line;
   while (_strsep_line) {
      _previous_word = _word;
      _word = strsep(&_strsep_line, " ");

      if (_word && strlen(_word)) words++;
   }


   if (_word || _previous_word) {
      if (_word) {
         if (!strlen(_word)) words++;
         *word = strdup(_word);
      } else
         *word = strdup(_previous_word);
      *pos = words - 1;
      free(_line);
      return 0;
   }

   free(_line);
   return -1;
}
#endif /* BROKEN_READLINE */

static char *complete_context_remove_extension_deprecated(const char *line, const char *word, int pos,
   int state)
{
   char *ret = NULL;
   int which = 0;

#ifdef BROKEN_READLINE
   char *word2;
   /*
    * Fix arguments, *word is a new allocated structure, REMEMBER to
    * free *word when you want to return from this function ...
    */
   if (fix_complete_args(line, &word2, &pos)) {
      ast_log(LOG_ERROR, "Out of free memory\n");
      return NULL;
   }
   word = word2;
#endif

   if (pos == 2) { /* 'remove extension _X_' (exten/cid@context ... */
      struct ast_context *c = NULL;
      char *context = NULL, *exten = NULL, *cid = NULL;
      int le = 0; /* length of extension */
      int lc = 0; /* length of context */
      int lcid = 0; /* length of cid */

      lc = split_ec(word, &exten, &context, &cid);
#ifdef BROKEN_READLINE
      free(word2);
#endif
      if (lc)  /* error */
         return NULL;
      le = strlen(exten);
      lc = strlen(context);
      lcid = cid ? strlen(cid) : -1;

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         goto error2;
      }

      /* find our context ... */
      while ( (c = ast_walk_contexts(c)) ) { /* match our context if any */
         struct ast_exten *e = NULL;
         /* XXX locking ? */
         if (!partial_match(ast_get_context_name(c), context, lc))
            continue;   /* context not matched */
         while ( (e = ast_walk_context_extensions(c, e)) ) { /* try to complete extensions ... */
            if ( !strchr(word, '/') ||
                  (!strchr(word, '@') && partial_match(ast_get_extension_cidmatch(e), cid, lcid)) ||
                  (strchr(word, '@') && !strcmp(ast_get_extension_cidmatch(e), cid))) {
               if ( ((strchr(word, '/') || strchr(word, '@')) && !strcmp(ast_get_extension_name(e), exten)) ||
                   (!strchr(word, '/') && !strchr(word, '@') && partial_match(ast_get_extension_name(e), exten, le))) { /* n-th match */
                  if (++which > state) {
                     /* If there is an extension then return exten@context. */
                     if (ast_get_extension_matchcid(e) && (!strchr(word, '@') || strchr(word, '/'))) {
                        asprintf(&ret, "%s/%s@%s", ast_get_extension_name(e), ast_get_extension_cidmatch(e), ast_get_context_name(c));
                        break;
                     } else if (!ast_get_extension_matchcid(e) && !strchr(word, '/')) {
                        asprintf(&ret, "%s@%s", ast_get_extension_name(e), ast_get_context_name(c));
                        break;
                     }
                  }
               }
            }
         }
         if (e)   /* got a match */
            break;
      }

      ast_unlock_contexts();
   error2:
      if (exten)
         free(exten);
   } else if (pos == 3) { /* 'remove extension EXT _X_' (priority) */
      char *exten = NULL, *context, *cid, *p;
      struct ast_context *c;
      int le, lc, lcid, len;
      const char *s = skip_words(line, 2); /* skip 'remove' 'extension' */
      int i = split_ec(s, &exten, &context, &cid); /* parse ext@context */

      if (i)   /* error */
         goto error3;
      if ( (p = strchr(exten, ' ')) ) /* remove space after extension */
         *p = '\0';
      if ( (p = strchr(context, ' ')) ) /* remove space after context */
         *p = '\0';
      le = strlen(exten);
      lc = strlen(context);
      lcid = strlen(cid);
      len = strlen(word);
      if (le == 0 || lc == 0)
         goto error3;

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         goto error3;
      }

      /* walk contexts */
      c = NULL;
      while ( (c = ast_walk_contexts(c)) ) {
         /* XXX locking on c ? */
         struct ast_exten *e;
         if (strcmp(ast_get_context_name(c), context) != 0)
            continue;
         /* got it, we must match here */
         e = NULL;
         while ( (e = ast_walk_context_extensions(c, e)) ) {
            struct ast_exten *priority;
            char buffer[10];

            if (cid && strcmp(ast_get_extension_cidmatch(e), cid) != 0) {
               continue;
            }
            if (strcmp(ast_get_extension_name(e), exten) != 0)
               continue;
            /* XXX lock e ? */
            priority = NULL;
            while ( !ret && (priority = ast_walk_extension_priorities(e, priority)) ) {
               snprintf(buffer, sizeof(buffer), "%u", ast_get_extension_priority(priority));
               if (partial_match(buffer, word, len) && ++which > state) /* n-th match */
                  ret = strdup(buffer);
            }
            break;
         }
         break;
      }
      ast_unlock_contexts();
   error3:
      if (exten)
         free(exten);
   }
#ifdef BROKEN_READLINE
   free(word2);
#endif
   return ret; 
}

static char *complete_context_remove_extension(const char *line, const char *word, int pos,
   int state)
{
   char *ret = NULL;
   int which = 0;

#ifdef BROKEN_READLINE
   char *word2;
   /*
    * Fix arguments, *word is a new allocated structure, REMEMBER to
    * free *word when you want to return from this function ...
    */
   if (fix_complete_args(line, &word2, &pos)) {
      ast_log(LOG_ERROR, "Out of free memory\n");
      return NULL;
   }
   word = word2;
#endif

   if (pos == 3) { /* 'dialplan remove extension _X_' (exten@context ... */
      struct ast_context *c = NULL;
      char *context = NULL, *exten = NULL, *cid = NULL;
      int le = 0; /* length of extension */
      int lc = 0; /* length of context */
      int lcid = 0; /* length of cid */

      lc = split_ec(word, &exten, &context, &cid);
      if (lc)  { /* error */
#ifdef BROKEN_READLINE
         free(word2);
#endif
         return NULL;
      }
      le = strlen(exten);
      lc = strlen(context);
      lcid = cid ? strlen(cid) : -1;

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         goto error2;
      }

      /* find our context ... */
      while ( (c = ast_walk_contexts(c)) ) { /* match our context if any */
         struct ast_exten *e = NULL;
         /* XXX locking ? */
         if (!partial_match(ast_get_context_name(c), context, lc))
            continue;   /* context not matched */
         while ( (e = ast_walk_context_extensions(c, e)) ) { /* try to complete extensions ... */
            if ( !strchr(word, '/') ||
                  (!strchr(word, '@') && partial_match(ast_get_extension_cidmatch(e), cid, lcid)) ||
                  (strchr(word, '@') && !strcmp(ast_get_extension_cidmatch(e), cid))) {
               if ( ((strchr(word, '/') || strchr(word, '@')) && !strcmp(ast_get_extension_name(e), exten)) ||
                   (!strchr(word, '/') && !strchr(word, '@') && partial_match(ast_get_extension_name(e), exten, le))) { /* n-th match */
                  if (++which > state) {
                     /* If there is an extension then return exten@context. */
                     if (ast_get_extension_matchcid(e) && (!strchr(word, '@') || strchr(word, '/'))) {
                        asprintf(&ret, "%s/%s@%s", ast_get_extension_name(e), ast_get_extension_cidmatch(e), ast_get_context_name(c));
                        break;
                     } else if (!ast_get_extension_matchcid(e) && !strchr(word, '/')) {
                        asprintf(&ret, "%s@%s", ast_get_extension_name(e), ast_get_context_name(c));
                        break;
                     }
                  }
               }
            }
         }
         if (e)   /* got a match */
            break;
      }
#ifdef BROKEN_READLINE
      free(word2);
#endif

      ast_unlock_contexts();
   error2:
      if (exten)
         free(exten);
   } else if (pos == 4) { /* 'dialplan remove extension EXT _X_' (priority) */
      char *exten = NULL, *context, *cid, *p;
      struct ast_context *c;
      int le, lc, lcid, len;
      const char *s = skip_words(line, 3); /* skip 'dialplan' 'remove' 'extension' */
      int i = split_ec(s, &exten, &context, &cid); /* parse ext@context */

      if (i)   /* error */
         goto error3;
      if ( (p = strchr(exten, ' ')) ) /* remove space after extension */
         *p = '\0';
      if ( (p = strchr(context, ' ')) ) /* remove space after context */
         *p = '\0';
      le = strlen(exten);
      lc = strlen(context);
      lcid = cid ? strlen(cid) : -1;
      len = strlen(word);
      if (le == 0 || lc == 0)
         goto error3;

      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         goto error3;
      }

      /* walk contexts */
      c = NULL;
      while ( (c = ast_walk_contexts(c)) ) {
         /* XXX locking on c ? */
         struct ast_exten *e;
         if (strcmp(ast_get_context_name(c), context) != 0)
            continue;
         /* got it, we must match here */
         e = NULL;
         while ( (e = ast_walk_context_extensions(c, e)) ) {
            struct ast_exten *priority;
            char buffer[10];

            if (cid && strcmp(ast_get_extension_cidmatch(e), cid) != 0) {
               continue;
            }
            if (strcmp(ast_get_extension_name(e), exten) != 0)
               continue;
            /* XXX lock e ? */
            priority = NULL;
            while ( !ret && (priority = ast_walk_extension_priorities(e, priority)) ) {
               snprintf(buffer, sizeof(buffer), "%u", ast_get_extension_priority(priority));
               if (partial_match(buffer, word, len) && ++which > state) /* n-th match */
                  ret = strdup(buffer);
            }
            break;
         }
         break;
      }
      ast_unlock_contexts();
   error3:
      if (exten)
         free(exten);
#ifdef BROKEN_READLINE
      free(word2);
#endif
   }
   return ret; 
}

/*!
 * Include context ...
 */
static int handle_context_add_include_deprecated(int fd, int argc, char *argv[])
{
   if (argc != 5) /* include context CTX in CTX */
      return RESULT_SHOWUSAGE;

   /* third arg must be 'in' ... */
   if (strcmp(argv[3], "in") && strcmp(argv[3], "into")) /* XXX why both ? */
      return RESULT_SHOWUSAGE;

   if (ast_context_add_include(argv[4], argv[2], registrar)) {
      switch (errno) {
      case ENOMEM:
         ast_cli(fd, "Out of memory for context addition\n");
         break;

      case EBUSY:
         ast_cli(fd, "Failed to lock context(s) list, please try again later\n");
         break;

      case EEXIST:
         ast_cli(fd, "Context '%s' already included in '%s' context\n",
            argv[2], argv[4]);
         break;

      case ENOENT:
      case EINVAL:
         ast_cli(fd, "There is no existence of context '%s'\n",
            errno == ENOENT ? argv[4] : argv[2]);
         break;

      default:
         ast_cli(fd, "Failed to include '%s' in '%s' context\n",
            argv[2], argv[4]);
         break;
      }
      return RESULT_FAILURE;
   }

   /* show some info ... */
   ast_cli(fd, "Context '%s' included in '%s' context\n",
      argv[2], argv[4]);

   return RESULT_SUCCESS;
}

static int handle_context_add_include(int fd, int argc, char *argv[])
{
   if (argc != 6) /* dialplan add include CTX in CTX */
      return RESULT_SHOWUSAGE;

   /* fifth arg must be 'into' ... */
   if (strcmp(argv[4], "into"))
      return RESULT_SHOWUSAGE;

   if (ast_context_add_include(argv[5], argv[3], registrar)) {
      switch (errno) {
      case ENOMEM:
         ast_cli(fd, "Out of memory for context addition\n");
         break;

      case EBUSY:
         ast_cli(fd, "Failed to lock context(s) list, please try again later\n");
         break;

      case EEXIST:
         ast_cli(fd, "Context '%s' already included in '%s' context\n",
            argv[3], argv[5]);
         break;

      case ENOENT:
      case EINVAL:
         ast_cli(fd, "There is no existence of context '%s'\n",
            errno == ENOENT ? argv[5] : argv[3]);
         break;

      default:
         ast_cli(fd, "Failed to include '%s' in '%s' context\n",
            argv[3], argv[5]);
         break;
      }
      return RESULT_FAILURE;
   }

   /* show some info ... */
   ast_cli(fd, "Context '%s' included in '%s' context\n",
      argv[3], argv[5]);

   return RESULT_SUCCESS;
}

static char *complete_context_add_include_deprecated(const char *line, const char *word, int pos,
    int state)
{
   struct ast_context *c;
   int which = 0;
   char *ret = NULL;
   int len = strlen(word);

   if (pos == 2) {      /* 'include context _X_' (context) ... */
      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         return NULL;
      }
      for (c = NULL; !ret && (c = ast_walk_contexts(c)); )
         if (partial_match(ast_get_context_name(c), word, len) && ++which > state)
            ret = strdup(ast_get_context_name(c));
      ast_unlock_contexts();
      return ret;
   } else if (pos == 3) { /* include context CTX _X_ */
      /* complete  as 'in' if context exists or we are unable to check */
      char *context, *dupline;
      struct ast_context *c;
      const char *s = skip_words(line, 2);   /* should not fail */

      if (state != 0)   /* only once */
         return NULL;

      /* parse context from line ... */
      context = dupline = strdup(s);
      if (!context) {
         ast_log(LOG_ERROR, "Out of free memory\n");
         return strdup("in");
      }
      strsep(&dupline, " ");

      /* check for context existence ... */
      if (ast_rdlock_contexts()) {
         ast_log(LOG_ERROR, "Failed to lock context list\n");
         /* our fault, we can't check, so complete 'in' ... */
         ret = strdup("in");
      } else {
         for (c = NULL; !ret && (c = ast_walk_contexts(c)); )
            if (!strcmp(context, ast_get_context_name(c)))
               ret = strdup("in"); /* found */
         ast_unlock_contexts();
      }
      free(context);
      return ret;
   } else if (pos == 4) { /* 'include context CTX in _X_' (dst context) */
      char *context, *dupline, *in;
      const char