Thu Apr 28 2011 17:15:24

Asterisk developer's documentation


pbx_config.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2006, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Populate and remember extensions from static config file
00022  *
00023  * 
00024  */
00025 
00026 #include "asterisk.h"
00027 
00028 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 285366 $")
00029 
00030 #include <ctype.h>
00031 
00032 #include "asterisk/paths.h"   /* ast_config_AST_CONFIG_DIR */
00033 #include "asterisk/pbx.h"
00034 #include "asterisk/config.h"
00035 #include "asterisk/module.h"
00036 #include "asterisk/logger.h"
00037 #include "asterisk/cli.h"
00038 #include "asterisk/channel.h" /* AST_MAX_EXTENSION */
00039 #include "asterisk/callerid.h"
00040 
00041 static char config[] = "extensions.conf";
00042 static char registrar[] = "pbx_config";
00043 static char userscontext[AST_MAX_EXTENSION] = "default";
00044 
00045 static int static_config = 0;
00046 static int write_protect_config = 1;
00047 static int autofallthrough_config = 1;
00048 static int clearglobalvars_config = 0;
00049 static int extenpatternmatchnew_config = 0;
00050 static char *overrideswitch_config = NULL;
00051 
00052 AST_MUTEX_DEFINE_STATIC(save_dialplan_lock);
00053 
00054 static struct ast_context *local_contexts = NULL;
00055 static struct ast_hashtab *local_table = NULL;
00056 /*
00057  * Prototypes for our completion functions
00058  */
00059 static char *complete_dialplan_remove_include(struct ast_cli_args *);
00060 static char *complete_dialplan_add_include(struct ast_cli_args *);
00061 static char *complete_dialplan_remove_ignorepat(struct ast_cli_args *);
00062 static char *complete_dialplan_add_ignorepat(struct ast_cli_args *);
00063 static char *complete_dialplan_remove_extension(struct ast_cli_args *);
00064 static char *complete_dialplan_add_extension(struct ast_cli_args *);
00065 
00066 /*
00067  * Implementation of functions provided by this module
00068  */
00069 
00070 /*!
00071  * REMOVE INCLUDE command stuff
00072  */
00073 static char *handle_cli_dialplan_remove_include(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
00074 {
00075    switch (cmd) {
00076    case CLI_INIT:
00077       e->command = "dialplan remove include";
00078       e->usage =
00079          "Usage: dialplan remove include <context> from <context>\n"
00080          "       Remove an included context from another context.\n";
00081       return NULL;
00082    case CLI_GENERATE:
00083       return complete_dialplan_remove_include(a);
00084    }
00085 
00086    if (strcmp(a->argv[4], "from"))
00087       return CLI_SHOWUSAGE;
00088 
00089    if (!ast_context_remove_include(a->argv[5], a->argv[3], registrar)) {
00090       ast_cli(a->fd, "We are not including '%s' into '%s' now\n",
00091          a->argv[3], a->argv[5]);
00092       return CLI_SUCCESS;
00093    }
00094 
00095    ast_cli(a->fd, "Failed to remove '%s' include from '%s' context\n",
00096       a->argv[3], a->argv[5]);
00097    return CLI_FAILURE;
00098 }
00099 
00100 /*! \brief return true if 'name' is included by context c */
00101 static int lookup_ci(struct ast_context *c, const char *name)
00102 {
00103    struct ast_include *i = NULL;
00104 
00105    if (ast_rdlock_context(c)) /* error, skip */
00106       return 0;
00107    while ( (i = ast_walk_context_includes(c, i)) )
00108       if (!strcmp(name, ast_get_include_name(i)))
00109          break;
00110    ast_unlock_context(c);
00111    return i ? -1 /* success */ : 0;
00112 }
00113 
00114 /*! \brief return true if 'name' is in the ignorepats for context c */
00115 static int lookup_c_ip(struct ast_context *c, const char *name)
00116 {
00117    struct ast_ignorepat *ip = NULL;
00118 
00119    if (ast_rdlock_context(c)) /* error, skip */
00120       return 0;
00121    while ( (ip = ast_walk_context_ignorepats(c, ip)) )
00122       if (!strcmp(name, ast_get_ignorepat_name(ip)))
00123          break;
00124    ast_unlock_context(c);
00125    return ip ? -1 /* success */ : 0;
00126 }
00127 
00128 /*! \brief moves to the n-th word in the string, or empty string if none */
00129 static const char *skip_words(const char *p, int n)
00130 {
00131    int in_blank = 0;
00132    for (;n && *p; p++) {
00133       if (isblank(*p) /* XXX order is important */ && !in_blank) {
00134          n--;  /* one word is gone */
00135          in_blank = 1;
00136       } else if (/* !is_blank(*p), we know already, && */ in_blank) {
00137          in_blank = 0;
00138       }
00139    }
00140    return p;
00141 }
00142 
00143 /*! \brief match the first 'len' chars of word. len==0 always succeeds */
00144 static int partial_match(const char *s, const char *word, int len)
00145 {
00146    return (len == 0 || !strncmp(s, word, len));
00147 }
00148 
00149 /*! \brief split extension\@context in two parts, return -1 on error.
00150  * The return string is malloc'ed and pointed by *ext
00151  */
00152 static int split_ec(const char *src, char **ext, char ** const ctx, char ** const cid)
00153 {
00154    char *i, *c, *e = ast_strdup(src); /* now src is not used anymore */
00155 
00156    if (e == NULL)
00157       return -1;  /* malloc error */
00158    /* now, parse values from 'exten@context' */
00159    *ext = e;
00160    c = strchr(e, '@');
00161    if (c == NULL) /* no context part */
00162       *ctx = "";  /* it is not overwritten, anyways */
00163    else {   /* found context, check for duplicity ... */
00164       *c++ = '\0';
00165       *ctx = c;
00166       if (strchr(c, '@')) { /* two @, not allowed */
00167          free(e);
00168          return -1;
00169       }
00170    }
00171    if (cid && (i = strchr(e, '/'))) {
00172       *i++ = '\0';
00173       *cid = i;
00174    } else if (cid) {
00175       /* Signal none detected */
00176       *cid = NULL;
00177    }
00178    return 0;
00179 }
00180 
00181 /* _X_ is the string we need to complete */
00182 static char *complete_dialplan_remove_include(struct ast_cli_args *a)
00183 {
00184    int which = 0;
00185    char *res = NULL;
00186    int len = strlen(a->word); /* how many bytes to match */
00187    struct ast_context *c = NULL;
00188 
00189    if (a->pos == 3) {      /* "dialplan remove include _X_" */
00190       if (ast_wrlock_contexts()) {
00191          ast_log(LOG_ERROR, "Failed to lock context list\n");
00192          return NULL;
00193       }
00194       /* walk contexts and their includes, return the n-th match */
00195       while (!res && (c = ast_walk_contexts(c))) {
00196          struct ast_include *i = NULL;
00197 
00198          if (ast_rdlock_context(c)) /* error ? skip this one */
00199             continue;
00200 
00201          while ( !res && (i = ast_walk_context_includes(c, i)) ) {
00202             const char *i_name = ast_get_include_name(i);
00203             struct ast_context *nc = NULL;
00204             int already_served = 0;
00205 
00206             if (!partial_match(i_name, a->word, len))
00207                continue;   /* not matched */
00208 
00209             /* check if this include is already served or not */
00210 
00211             /* go through all contexts again till we reach actual
00212              * context or already_served = 1
00213              */
00214             while ( (nc = ast_walk_contexts(nc)) && nc != c && !already_served)
00215                already_served = lookup_ci(nc, i_name);
00216 
00217             if (!already_served && ++which > a->n)
00218                res = strdup(i_name);
00219          }
00220          ast_unlock_context(c);
00221       }
00222 
00223       ast_unlock_contexts();
00224       return res;
00225    } else if (a->pos == 4) { /* "dialplan remove include CTX _X_" */
00226       /*
00227        * complete as 'from', but only if previous context is really
00228        * included somewhere
00229        */
00230       char *context, *dupline;
00231       const char *s = skip_words(a->line, 3); /* skip 'dialplan' 'remove' 'include' */
00232 
00233       if (a->n > 0)
00234          return NULL;
00235       context = dupline = strdup(s);
00236       if (!dupline) {
00237          ast_log(LOG_ERROR, "Out of free memory\n");
00238          return NULL;
00239       }
00240       strsep(&dupline, " ");
00241 
00242       if (ast_rdlock_contexts()) {
00243          ast_log(LOG_ERROR, "Failed to lock contexts list\n");
00244          free(context);
00245          return NULL;
00246       }
00247 
00248       /* go through all contexts and check if is included ... */
00249       while (!res && (c = ast_walk_contexts(c)))
00250          if (lookup_ci(c, context)) /* context is really included, complete "from" command */
00251             res = strdup("from");
00252       ast_unlock_contexts();
00253       if (!res)
00254          ast_log(LOG_WARNING, "%s not included anywhere\n", context);
00255       free(context);
00256       return res;
00257    } else if (a->pos == 5) { /* "dialplan remove include CTX from _X_" */
00258       /*
00259        * Context from which we removing include ... 
00260        */
00261       char *context, *dupline, *from;
00262       const char *s = skip_words(a->line, 3); /* skip 'dialplan' 'remove' 'include' */
00263       context = dupline = strdup(s);
00264       if (!dupline) {
00265          ast_log(LOG_ERROR, "Out of free memory\n");
00266          return NULL;
00267       }
00268 
00269       strsep(&dupline, " "); /* skip context */
00270 
00271       /* fourth word must be 'from' */
00272       from = strsep(&dupline, " ");
00273       if (!from || strcmp(from, "from")) {
00274          free(context);
00275          return NULL;
00276       }
00277 
00278       if (ast_rdlock_contexts()) {
00279          ast_log(LOG_ERROR, "Failed to lock context list\n");
00280          free(context);
00281          return NULL;
00282       }
00283 
00284       /* walk through all contexts ... */
00285       c = NULL;
00286       while ( !res && (c = ast_walk_contexts(c))) {
00287          const char *c_name = ast_get_context_name(c);
00288          if (!partial_match(c_name, a->word, len)) /* not a good target */
00289             continue;
00290          /* walk through all includes and check if it is our context */ 
00291          if (lookup_ci(c, context) && ++which > a->n)
00292             res = strdup(c_name);
00293       }
00294       ast_unlock_contexts();
00295       free(context);
00296       return res;
00297    }
00298 
00299    return NULL;
00300 }
00301 
00302 /*!
00303  * REMOVE EXTENSION command stuff
00304  */
00305 static char *handle_cli_dialplan_remove_extension(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
00306 {
00307    int removing_priority = 0;
00308    char *exten, *context, *cid;
00309    char *ret = CLI_FAILURE;
00310 
00311    switch (cmd) {
00312    case CLI_INIT:
00313       e->command = "dialplan remove extension";
00314       e->usage =
00315          "Usage: dialplan remove extension exten[/cid]@context [priority]\n"
00316          "       Remove an extension from a given context. If a priority\n"
00317          "       is given, only that specific priority from the given extension\n"
00318          "       will be removed.\n";
00319       return NULL;
00320    case CLI_GENERATE:
00321       return complete_dialplan_remove_extension(a);
00322    }
00323 
00324    if (a->argc != 5 && a->argc != 4)
00325       return CLI_SHOWUSAGE;
00326 
00327    /*
00328     * Priority input checking ...
00329     */
00330    if (a->argc == 5) {
00331       char *c = a->argv[4];
00332 
00333       /* check for digits in whole parameter for right priority ...
00334        * why? because atoi (strtol) returns 0 if any characters in
00335        * string and whole extension will be removed, it's not good
00336        */
00337       if (!strcmp("hint", c))
00338          removing_priority = PRIORITY_HINT;
00339       else {
00340          while (*c && isdigit(*c))
00341             c++;
00342          if (*c) { /* non-digit in string */
00343             ast_cli(a->fd, "Invalid priority '%s'\n", a->argv[4]);
00344             return CLI_FAILURE;
00345          }
00346          removing_priority = atoi(a->argv[4]);
00347       }
00348 
00349       if (removing_priority == 0) {
00350          ast_cli(a->fd, "If you want to remove whole extension, please " \
00351             "omit priority argument\n");
00352          return CLI_FAILURE;
00353       }
00354    }
00355 
00356    /* XXX original overwrote argv[3] */
00357    /*
00358     * Format exten@context checking ...
00359     */
00360    if (split_ec(a->argv[3], &exten, &context, &cid))
00361       return CLI_FAILURE; /* XXX malloc failure */
00362    if ((!strlen(exten)) || (!(strlen(context)))) {
00363       ast_cli(a->fd, "Missing extension or context name in third argument '%s'\n",
00364          a->argv[3]);
00365       free(exten);
00366       return CLI_FAILURE;
00367    }
00368 
00369    if (!ast_context_remove_extension_callerid(context, exten, removing_priority,
00370          /* Do NOT substitute S_OR; it is NOT the same thing */
00371          cid ? cid : (removing_priority ? "" : NULL), cid ? 1 : 0, registrar)) {
00372       if (!removing_priority)
00373          ast_cli(a->fd, "Whole extension %s@%s removed\n",
00374             exten, context);
00375       else
00376          ast_cli(a->fd, "Extension %s@%s with priority %d removed\n",
00377             exten, context, removing_priority);
00378          
00379       ret = CLI_SUCCESS;
00380    } else {
00381       if (cid) {
00382          ast_cli(a->fd, "Failed to remove extension %s/%s@%s\n", exten, cid, context);
00383       } else {
00384          ast_cli(a->fd, "Failed to remove extension %s@%s\n", exten, context);
00385       }
00386       ret = CLI_FAILURE;
00387    }
00388    free(exten);
00389    return ret;
00390 }
00391 
00392 static char *complete_dialplan_remove_extension(struct ast_cli_args *a)
00393 {
00394    char *ret = NULL;
00395    int which = 0;
00396 
00397    if (a->pos == 3) { /* 'dialplan remove extension _X_' (exten@context ... */
00398       struct ast_context *c = NULL;
00399       char *context = NULL, *exten = NULL, *cid = NULL;
00400       int le = 0; /* length of extension */
00401       int lc = 0; /* length of context */
00402       int lcid = 0; /* length of cid */
00403 
00404       lc = split_ec(a->word, &exten, &context, &cid);
00405       if (lc)  { /* error */
00406          return NULL;
00407       }
00408       le = strlen(exten);
00409       lc = strlen(context);
00410       lcid = cid ? strlen(cid) : -1;
00411 
00412       if (ast_rdlock_contexts()) {
00413          ast_log(LOG_ERROR, "Failed to lock context list\n");
00414          goto error2;
00415       }
00416 
00417       /* find our context ... */
00418       while ( (c = ast_walk_contexts(c)) ) { /* match our context if any */
00419          struct ast_exten *e = NULL;
00420          /* XXX locking ? */
00421          if (!partial_match(ast_get_context_name(c), context, lc))
00422             continue;   /* context not matched */
00423          while ( (e = ast_walk_context_extensions(c, e)) ) { /* try to complete extensions ... */
00424             if ( !strchr(a->word, '/') ||
00425                   (!strchr(a->word, '@') && partial_match(ast_get_extension_cidmatch(e), cid, lcid)) ||
00426                   (strchr(a->word, '@') && !strcmp(ast_get_extension_cidmatch(e), cid))) {
00427                if ( ((strchr(a->word, '/') || strchr(a->word, '@')) && !strcmp(ast_get_extension_name(e), exten)) ||
00428                    (!strchr(a->word, '/') && !strchr(a->word, '@') && partial_match(ast_get_extension_name(e), exten, le))) { /* n-th match */
00429                   if (++which > a->n) {
00430                      /* If there is an extension then return exten@context. */
00431                      if (ast_get_extension_matchcid(e) && (!strchr(a->word, '@') || strchr(a->word, '/'))) {
00432                         if (asprintf(&ret, "%s/%s@%s", ast_get_extension_name(e), ast_get_extension_cidmatch(e), ast_get_context_name(c)) < 0) {
00433                            ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
00434                            ret = NULL;
00435                         }
00436                         break;
00437                      } else if (!ast_get_extension_matchcid(e) && !strchr(a->word, '/')) {
00438                         if (asprintf(&ret, "%s@%s", ast_get_extension_name(e), ast_get_context_name(c)) < 0) {
00439                            ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
00440                            ret = NULL;
00441                         }
00442                         break;
00443                      }
00444                   }
00445                }
00446             }
00447          }
00448          if (e)   /* got a match */
00449             break;
00450       }
00451 
00452       ast_unlock_contexts();
00453    error2:
00454       free(exten);
00455    } else if (a->pos == 4) { /* 'dialplan remove extension EXT _X_' (priority) */
00456       char *exten = NULL, *context, *cid, *p;
00457       struct ast_context *c;
00458       int le, lc, len;
00459       const char *s = skip_words(a->line, 3); /* skip 'dialplan' 'remove' 'extension' */
00460       int i = split_ec(s, &exten, &context, &cid); /* parse ext@context */
00461 
00462       if (i)   /* error */
00463          goto error3;
00464       if ( (p = strchr(exten, ' ')) ) /* remove space after extension */
00465          *p = '\0';
00466       if ( (p = strchr(context, ' ')) ) /* remove space after context */
00467          *p = '\0';
00468       le = strlen(exten);
00469       lc = strlen(context);
00470       len = strlen(a->word);
00471       if (le == 0 || lc == 0)
00472          goto error3;
00473 
00474       if (ast_rdlock_contexts()) {
00475          ast_log(LOG_ERROR, "Failed to lock context list\n");
00476          goto error3;
00477       }
00478 
00479       /* walk contexts */
00480       c = NULL;
00481       while ( (c = ast_walk_contexts(c)) ) {
00482          /* XXX locking on c ? */
00483          struct ast_exten *e;
00484          if (strcmp(ast_get_context_name(c), context) != 0)
00485             continue;
00486          /* got it, we must match here */
00487          e = NULL;
00488          while ( (e = ast_walk_context_extensions(c, e)) ) {
00489             struct ast_exten *priority;
00490             char buffer[10];
00491 
00492             if (cid && strcmp(ast_get_extension_cidmatch(e), cid) != 0) {
00493                continue;
00494             }
00495             if (strcmp(ast_get_extension_name(e), exten) != 0)
00496                continue;
00497             /* XXX lock e ? */
00498             priority = NULL;
00499             while ( !ret && (priority = ast_walk_extension_priorities(e, priority)) ) {
00500                snprintf(buffer, sizeof(buffer), "%u", ast_get_extension_priority(priority));
00501                if (partial_match(buffer, a->word, len) && ++which > a->n) /* n-th match */
00502                   ret = strdup(buffer);
00503             }
00504             break;
00505          }
00506          break;
00507       }
00508       ast_unlock_contexts();
00509    error3:
00510       free(exten);
00511    }
00512    return ret; 
00513 }
00514 
00515 /*!
00516  * Include context ...
00517  */
00518 static char *handle_cli_dialplan_add_include(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
00519 {
00520    switch (cmd) {
00521    case CLI_INIT:
00522       e->command = "dialplan add include";
00523       e->usage =
00524          "Usage: dialplan add include <context> into <context>\n"
00525          "       Include a context in another context.\n";
00526       return NULL;
00527    case CLI_GENERATE:
00528       return complete_dialplan_add_include(a);
00529    }
00530 
00531    if (a->argc != 6) /* dialplan add include CTX in CTX */
00532       return CLI_SHOWUSAGE;
00533 
00534    /* fifth arg must be 'into' ... */
00535    if (strcmp(a->argv[4], "into"))
00536       return CLI_SHOWUSAGE;
00537 
00538    if (ast_context_add_include(a->argv[5], a->argv[3], registrar)) {
00539       switch (errno) {
00540       case ENOMEM:
00541          ast_cli(a->fd, "Out of memory for context addition\n");
00542          break;
00543 
00544       case EBUSY:
00545          ast_cli(a->fd, "Failed to lock context(s) list, please try again later\n");
00546          break;
00547 
00548       case EEXIST:
00549          ast_cli(a->fd, "Context '%s' already included in '%s' context\n",
00550             a->argv[3], a->argv[5]);
00551          break;
00552 
00553       case ENOENT:
00554       case EINVAL:
00555          ast_cli(a->fd, "There is no existence of context '%s'\n",
00556             errno == ENOENT ? a->argv[5] : a->argv[3]);
00557          break;
00558 
00559       default:
00560          ast_cli(a->fd, "Failed to include '%s' in '%s' context\n",
00561             a->argv[3], a->argv[5]);
00562          break;
00563       }
00564       return CLI_FAILURE;
00565    }
00566 
00567    /* show some info ... */
00568    ast_cli(a->fd, "Context '%s' included in '%s' context\n",
00569       a->argv[3], a->argv[5]);
00570 
00571    return CLI_SUCCESS;
00572 }
00573 
00574 static char *complete_dialplan_add_include(struct ast_cli_args *a)
00575 {
00576    struct ast_context *c;
00577    int which = 0;
00578    char *ret = NULL;
00579    int len = strlen(a->word);
00580 
00581    if (a->pos == 3) {      /* 'dialplan add include _X_' (context) ... */
00582       if (ast_rdlock_contexts()) {
00583          ast_log(LOG_ERROR, "Failed to lock context list\n");
00584          return NULL;
00585       }
00586       for (c = NULL; !ret && (c = ast_walk_contexts(c)); )
00587          if (partial_match(ast_get_context_name(c), a->word, len) && ++which > a->n)
00588             ret = strdup(ast_get_context_name(c));
00589       ast_unlock_contexts();
00590       return ret;
00591    } else if (a->pos == 4) { /* dialplan add include CTX _X_ */
00592       /* complete  as 'into' if context exists or we are unable to check */
00593       char *context, *dupline;
00594       const char *s = skip_words(a->line, 3); /* should not fail */
00595 
00596       if (a->n != 0) /* only once */
00597          return NULL;
00598 
00599       /* parse context from line ... */
00600       context = dupline = strdup(s);
00601       if (!context) {
00602          ast_log(LOG_ERROR, "Out of free memory\n");
00603          return strdup("into");
00604       }
00605       strsep(&dupline, " ");
00606 
00607       /* check for context existence ... */
00608       if (ast_rdlock_contexts()) {
00609          ast_log(LOG_ERROR, "Failed to lock context list\n");
00610          /* our fault, we can't check, so complete 'into' ... */
00611          ret = strdup("into");
00612       } else {
00613          struct ast_context *ctx;
00614          for (ctx = NULL; !ret && (ctx = ast_walk_contexts(ctx)); )
00615             if (!strcmp(context, ast_get_context_name(ctx)))
00616                ret = strdup("into"); /* found */
00617          ast_unlock_contexts();
00618       }
00619       free(context);
00620       return ret;
00621    } else if (a->pos == 5) { /* 'dialplan add include CTX into _X_' (dst context) */
00622       char *context, *dupline, *into;
00623       const char *s = skip_words(a->line, 3); /* should not fail */
00624       context = dupline = strdup(s);
00625       if (!dupline) {
00626          ast_log(LOG_ERROR, "Out of free memory\n");
00627          return NULL;
00628       }
00629       strsep(&dupline, " "); /* skip context */
00630       into = strsep(&dupline, " ");
00631       /* error if missing context or fifth word is not 'into' */
00632       if (!strlen(context) || strcmp(into, "into")) {
00633          ast_log(LOG_ERROR, "bad context %s or missing into %s\n",
00634             context, into);
00635          goto error3;
00636       }
00637 
00638       if (ast_rdlock_contexts()) {
00639          ast_log(LOG_ERROR, "Failed to lock context list\n");
00640          goto error3;
00641       }
00642 
00643       for (c = NULL; (c = ast_walk_contexts(c)); )
00644          if (!strcmp(context, ast_get_context_name(c)))
00645             break;
00646       if (c) { /* first context exists, go on... */
00647          /* go through all contexts ... */
00648          for (c = NULL; !ret && (c = ast_walk_contexts(c)); ) {
00649             if (!strcmp(context, ast_get_context_name(c)))
00650                continue; /* skip ourselves */
00651             if (partial_match(ast_get_context_name(c), a->word, len) &&
00652                   !lookup_ci(c, context) /* not included yet */ &&
00653                   ++which > a->n)
00654                ret = strdup(ast_get_context_name(c));
00655          }
00656       } else {
00657          ast_log(LOG_ERROR, "context %s not found\n", context);
00658       }
00659       ast_unlock_contexts();
00660    error3:
00661       free(context);
00662       return ret;
00663    }
00664 
00665    return NULL;
00666 }
00667 
00668 /*!
00669  * \brief 'save dialplan' CLI command implementation functions ...
00670  */
00671 static char *handle_cli_dialplan_save(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
00672 {
00673    char filename[256], overrideswitch[256] = "";
00674    struct ast_context *c;
00675    struct ast_config *cfg;
00676    struct ast_variable *v;
00677    int incomplete = 0; /* incomplete config write? */
00678    FILE *output;
00679    struct ast_flags config_flags = { 0 };
00680    const char *base, *slash, *file;
00681 
00682    switch (cmd) {
00683    case CLI_INIT:
00684       e->command = "dialplan save";
00685       e->usage =
00686          "Usage: dialplan save [/path/to/extension/file]\n"
00687          "       Save dialplan created by pbx_config module.\n"
00688          "\n"
00689          "Example: dialplan save                 (/etc/asterisk/extensions.conf)\n"
00690          "         dialplan save /home/markster  (/home/markster/extensions.conf)\n";
00691       return NULL;
00692    case CLI_GENERATE:
00693       return NULL;
00694    }
00695 
00696    if (! (static_config && !write_protect_config)) {
00697       ast_cli(a->fd,
00698          "I can't save dialplan now, see '%s' example file.\n",
00699          config);
00700       return CLI_FAILURE;
00701    }
00702 
00703    if (a->argc != 2 && a->argc != 3)
00704       return CLI_SHOWUSAGE;
00705 
00706    if (ast_mutex_lock(&save_dialplan_lock)) {
00707       ast_cli(a->fd,
00708          "Failed to lock dialplan saving (another proccess saving?)\n");
00709       return CLI_FAILURE;
00710    }
00711    /* XXX the code here is quite loose, a pathname with .conf in it
00712     * is assumed to be a complete pathname
00713     */
00714    if (a->argc == 3) {  /* have config path. Look for *.conf */
00715       base = a->argv[2];
00716       if (!strstr(a->argv[2], ".conf")) { /*no, this is assumed to be a pathname */
00717          /* if filename ends with '/', do not add one */
00718          slash = (*(a->argv[2] + strlen(a->argv[2]) -1) == '/') ? "/" : "";
00719          file = config; /* default: 'extensions.conf' */
00720       } else { /* yes, complete file name */
00721          slash = "";
00722          file = "";
00723       }
00724    } else {
00725       /* no config file, default one */
00726       base = ast_config_AST_CONFIG_DIR;
00727       slash = "/";
00728       file = config;
00729    }
00730    snprintf(filename, sizeof(filename), "%s%s%s", base, slash, config);
00731 
00732    cfg = ast_config_load("extensions.conf", config_flags);
00733 
00734    /* try to lock contexts list */
00735    if (ast_rdlock_contexts()) {
00736       ast_cli(a->fd, "Failed to lock contexts list\n");
00737       ast_mutex_unlock(&save_dialplan_lock);
00738       ast_config_destroy(cfg);
00739       return CLI_FAILURE;
00740    }
00741 
00742    /* create new file ... */
00743    if (!(output = fopen(filename, "wt"))) {
00744       ast_cli(a->fd, "Failed to create file '%s'\n",
00745          filename);
00746       ast_unlock_contexts();
00747       ast_mutex_unlock(&save_dialplan_lock);
00748       ast_config_destroy(cfg);
00749       return CLI_FAILURE;
00750    }
00751 
00752    /* fireout general info */
00753    if (overrideswitch_config) {
00754       snprintf(overrideswitch, sizeof(overrideswitch), "overrideswitch=%s\n", overrideswitch_config);
00755    }
00756    fprintf(output, "[general]\nstatic=%s\nwriteprotect=%s\nautofallthrough=%s\nclearglobalvars=%s\n%sextenpatternmatchnew=%s\n\n",
00757       static_config ? "yes" : "no",
00758       write_protect_config ? "yes" : "no",
00759                 autofallthrough_config ? "yes" : "no",
00760             clearglobalvars_config ? "yes" : "no",
00761             overrideswitch_config ? overrideswitch : "",
00762             extenpatternmatchnew_config ? "yes" : "no");
00763 
00764    if ((v = ast_variable_browse(cfg, "globals"))) {
00765       fprintf(output, "[globals]\n");
00766       while(v) {
00767          fprintf(output, "%s => %s\n", v->name, v->value);
00768          v = v->next;
00769       }
00770       fprintf(output, "\n");
00771    }
00772 
00773    ast_config_destroy(cfg);
00774    
00775 #define PUT_CTX_HDR  do { \
00776    if (!context_header_written) {   \
00777       fprintf(output, "[%s]\n", ast_get_context_name(c));   \
00778       context_header_written = 1;   \
00779    }  \
00780    } while (0)
00781 
00782    /* walk all contexts */
00783    for (c = NULL; (c = ast_walk_contexts(c)); ) {
00784       int context_header_written = 0;
00785       struct ast_exten *ext, *last_written_e = NULL;
00786       struct ast_include *i;
00787       struct ast_ignorepat *ip;
00788       struct ast_sw *sw;
00789 
00790       /* try to lock context and fireout all info */  
00791       if (ast_rdlock_context(c)) { /* lock failure */
00792          incomplete = 1;
00793          continue;
00794       }
00795       /* registered by this module? */
00796       /* XXX do we need this ? */
00797       if (!strcmp(ast_get_context_registrar(c), registrar)) {
00798          fprintf(output, "[%s]\n", ast_get_context_name(c));
00799          context_header_written = 1;
00800       }
00801 
00802       /* walk extensions ... */
00803       for (ext = NULL; (ext = ast_walk_context_extensions(c, ext)); ) {
00804          struct ast_exten *p = NULL;
00805 
00806          /* fireout priorities */
00807          while ( (p = ast_walk_extension_priorities(ext, p)) ) {
00808             if (strcmp(ast_get_extension_registrar(p), registrar) != 0) /* not this source */
00809                continue;
00810       
00811             /* make empty line between different extensions */ 
00812             if (last_written_e != NULL &&
00813                    strcmp(ast_get_extension_name(last_written_e),
00814                       ast_get_extension_name(p)))
00815                fprintf(output, "\n");
00816             last_written_e = p;
00817          
00818             PUT_CTX_HDR;
00819 
00820             if (ast_get_extension_priority(p) == PRIORITY_HINT) { /* easy */
00821                fprintf(output, "exten => %s,hint,%s\n",
00822                       ast_get_extension_name(p),
00823                       ast_get_extension_app(p));
00824             } else {
00825                const char *sep, *cid;
00826                const char *el = ast_get_extension_label(p);
00827                char label[128] = "";
00828  
00829                if (ast_get_extension_matchcid(p)) {
00830                   sep = "/";
00831                   cid = ast_get_extension_cidmatch(p);
00832                } else
00833                   sep = cid = "";
00834             
00835                if (el && (snprintf(label, sizeof(label), "(%s)", el) != (strlen(el) + 2)))
00836                   incomplete = 1;   /* error encountered or label > 125 chars */
00837                
00838                fprintf(output, "exten => %s%s%s,%d%s,%s(%s)\n",
00839                    ast_get_extension_name(p), (ast_strlen_zero(sep) ? "" : sep), (ast_strlen_zero(cid) ? "" : cid),
00840                    ast_get_extension_priority(p), label,
00841                    ast_get_extension_app(p), (ast_strlen_zero(ast_get_extension_app_data(p)) ? "" : (const char *)ast_get_extension_app_data(p)));
00842             }
00843          }
00844       }
00845 
00846       /* written any extensions? ok, write space between exten & inc */
00847       if (last_written_e)
00848          fprintf(output, "\n");
00849 
00850       /* walk through includes */
00851       for (i = NULL; (i = ast_walk_context_includes(c, i)) ; ) {
00852          if (strcmp(ast_get_include_registrar(i), registrar) != 0)
00853             continue; /* not mine */
00854          PUT_CTX_HDR;
00855          fprintf(output, "include => %s\n", ast_get_include_name(i));
00856       }
00857       if (ast_walk_context_includes(c, NULL))
00858          fprintf(output, "\n");
00859 
00860       /* walk through switches */
00861       for (sw = NULL; (sw = ast_walk_context_switches(c, sw)) ; ) {
00862          if (strcmp(ast_get_switch_registrar(sw), registrar) != 0)
00863             continue; /* not mine */
00864          PUT_CTX_HDR;
00865          fprintf(output, "switch => %s/%s\n",
00866                 ast_get_switch_name(sw), ast_get_switch_data(sw));
00867       }
00868 
00869       if (ast_walk_context_switches(c, NULL))
00870          fprintf(output, "\n");
00871 
00872       /* fireout ignorepats ... */
00873       for (ip = NULL; (ip = ast_walk_context_ignorepats(c, ip)); ) {
00874          if (strcmp(ast_get_ignorepat_registrar(ip), registrar) != 0)
00875             continue; /* not mine */
00876          PUT_CTX_HDR;
00877          fprintf(output, "ignorepat => %s\n",
00878                   ast_get_ignorepat_name(ip));
00879       }
00880 
00881       ast_unlock_context(c);
00882    }  
00883 
00884    ast_unlock_contexts();
00885    ast_mutex_unlock(&save_dialplan_lock);
00886    fclose(output);
00887 
00888    if (incomplete) {
00889       ast_cli(a->fd, "Saved dialplan is incomplete\n");
00890       return CLI_FAILURE;
00891    }
00892 
00893    ast_cli(a->fd, "Dialplan successfully saved into '%s'\n",
00894       filename);
00895    return CLI_SUCCESS;
00896 }
00897 
00898 /*!
00899  * \brief ADD EXTENSION command stuff
00900  */
00901 static char *handle_cli_dialplan_add_extension(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
00902 {
00903    char *whole_exten;
00904    char *exten, *prior;
00905    int iprior = -2;
00906    char *cidmatch, *app, *app_data;
00907    char *start, *end;
00908 
00909    switch (cmd) {
00910    case CLI_INIT:
00911       e->command = "dialplan add extension";
00912       e->usage =
00913          "Usage: dialplan add extension <exten>,<priority>,<app>,<app-data>\n"
00914          "       into <context> [replace]\n\n"
00915          "       This command will add new extension into <context>. If there is an\n"
00916          "       existence of extension with the same priority and last 'replace'\n"
00917          "       arguments is given here we simply replace this extension.\n"
00918          "\n"
00919          "Example: dialplan add extension 6123,1,Dial,IAX/216.207.245.56/6123 into local\n"
00920          "         Now, you can dial 6123 and talk to Markster :)\n";
00921       return NULL;
00922    case CLI_GENERATE:
00923       return complete_dialplan_add_extension(a);
00924    }
00925 
00926    /* check for arguments at first */
00927    if (a->argc != 6 && a->argc != 7)
00928       return CLI_SHOWUSAGE;
00929    if (strcmp(a->argv[4], "into"))
00930       return CLI_SHOWUSAGE;
00931    if (a->argc == 7)
00932       if (strcmp(a->argv[6], "replace"))
00933          return CLI_SHOWUSAGE;
00934 
00935    /* XXX overwrite argv[3] */
00936    whole_exten = a->argv[3];
00937    exten = strsep(&whole_exten,",");
00938    if (strchr(exten, '/')) {
00939       cidmatch = exten;
00940       strsep(&cidmatch,"/");
00941    } else {
00942       cidmatch = NULL;
00943    }
00944    prior = strsep(&whole_exten,",");
00945    if (prior) {
00946       if (!strcmp(prior, "hint")) {
00947          iprior = PRIORITY_HINT;
00948       } else {
00949          if (sscanf(prior, "%30d", &iprior) != 1) {
00950             ast_cli(a->fd, "'%s' is not a valid priority\n", prior);
00951             prior = NULL;
00952          }
00953       }
00954    }
00955    app = whole_exten;
00956    if (app && (start = strchr(app, '(')) && (end = strrchr(app, ')'))) {
00957       *start = *end = '\0';
00958       app_data = start + 1;
00959    } else {
00960       if (app) {
00961          app_data = strchr(app, ',');
00962          if (app_data) {
00963             *app_data = '\0';
00964             app_data++;
00965          }
00966       } else   
00967          app_data = NULL;
00968    }
00969 
00970    if (!exten || !prior || !app || (!app_data && iprior != PRIORITY_HINT))
00971       return CLI_SHOWUSAGE;
00972 
00973    if (!app_data)
00974       app_data="";
00975    if (ast_add_extension(a->argv[5], a->argc == 7 ? 1 : 0, exten, iprior, NULL, cidmatch, app,
00976       (void *)strdup(app_data), ast_free_ptr, registrar)) {
00977       switch (errno) {
00978       case ENOMEM:
00979          ast_cli(a->fd, "Out of free memory\n");
00980          break;
00981 
00982       case EBUSY:
00983          ast_cli(a->fd, "Failed to lock context(s) list, please try again later\n");
00984          break;
00985 
00986       case ENOENT:
00987          ast_cli(a->fd, "No existence of '%s' context\n", a->argv[5]);
00988          break;
00989 
00990       case EEXIST:
00991          ast_cli(a->fd, "Extension %s@%s with priority %s already exists\n",
00992             exten, a->argv[5], prior);
00993          break;
00994 
00995       default:
00996          ast_cli(a->fd, "Failed to add '%s,%s,%s,%s' extension into '%s' context\n",
00997                exten, prior, app, app_data, a->argv[5]);
00998          break;
00999       }
01000       return CLI_FAILURE;
01001    }
01002 
01003    if (a->argc == 7)
01004       ast_cli(a->fd, "Extension %s@%s (%s) replace by '%s,%s,%s,%s'\n",
01005          exten, a->argv[5], prior, exten, prior, app, app_data);
01006    else
01007       ast_cli(a->fd, "Extension '%s,%s,%s,%s' added into '%s' context\n",
01008          exten, prior, app, app_data, a->argv[5]);
01009 
01010    return CLI_SUCCESS;
01011 }
01012 
01013 /*! dialplan add extension 6123,1,Dial,IAX/212.71.138.13/6123 into local */
01014 static char *complete_dialplan_add_extension(struct ast_cli_args *a)
01015 {
01016    int which = 0;
01017 
01018    if (a->pos == 4) {      /* complete 'into' word ... */
01019       return (a->n == 0) ? strdup("into") : NULL;
01020    } else if (a->pos == 5) { /* complete context */
01021       struct ast_context *c = NULL;
01022       int len = strlen(a->word);
01023       char *res = NULL;
01024 
01025       /* try to lock contexts list ... */
01026       if (ast_rdlock_contexts()) {
01027          ast_log(LOG_WARNING, "Failed to lock contexts list\n");
01028          return NULL;
01029       }
01030 
01031       /* walk through all contexts */
01032       while ( !res && (c = ast_walk_contexts(c)) )
01033          if (partial_match(ast_get_context_name(c), a->word, len) && ++which > a->n)
01034             res = strdup(ast_get_context_name(c));
01035       ast_unlock_contexts();
01036       return res;
01037    } else if (a->pos == 6) {
01038       return a->n == 0 ? strdup("replace") : NULL;
01039    }
01040    return NULL;
01041 }
01042 
01043 /*!
01044  * IGNOREPAT CLI stuff
01045  */
01046 static char *handle_cli_dialplan_add_ignorepat(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01047 {
01048    switch (cmd) {
01049    case CLI_INIT:
01050       e->command = "dialplan add ignorepat";
01051       e->usage =
01052          "Usage: dialplan add ignorepat <pattern> into <context>\n"
01053          "       This command adds a new ignore pattern into context <context>\n"
01054          "\n"
01055          "Example: dialplan add ignorepat _3XX into local\n";
01056       return NULL;
01057    case CLI_GENERATE:
01058       return complete_dialplan_add_ignorepat(a);
01059    }
01060 
01061    if (a->argc != 6)
01062       return CLI_SHOWUSAGE;
01063 
01064    if (strcmp(a->argv[4], "into"))
01065       return CLI_SHOWUSAGE;
01066 
01067    if (ast_context_add_ignorepat(a->argv[5], a->argv[3], registrar)) {
01068       switch (errno) {
01069       case ENOMEM:
01070          ast_cli(a->fd, "Out of free memory\n");
01071          break;
01072 
01073       case ENOENT:
01074          ast_cli(a->fd, "There is no existence of '%s' context\n", a->argv[5]);
01075          break;
01076 
01077       case EEXIST:
01078          ast_cli(a->fd, "Ignore pattern '%s' already included in '%s' context\n",
01079             a->argv[3], a->argv[5]);
01080          break;
01081 
01082       case EBUSY:
01083          ast_cli(a->fd, "Failed to lock context(s) list, please, try again later\n");
01084          break;
01085 
01086       default:
01087          ast_cli(a->fd, "Failed to add ingore pattern '%s' into '%s' context\n",
01088             a->argv[3], a->argv[5]);
01089          break;
01090       }
01091       return CLI_FAILURE;
01092    }
01093 
01094    ast_cli(a->fd, "Ignore pattern '%s' added into '%s' context\n",
01095       a->argv[3], a->argv[5]);
01096 
01097    return CLI_SUCCESS;
01098 }
01099 
01100 static char *complete_dialplan_add_ignorepat(struct ast_cli_args *a)
01101 {
01102    if (a->pos == 4)
01103       return a->n == 0 ? strdup("into") : NULL;
01104    else if (a->pos == 5) {
01105       struct ast_context *c;
01106       int which = 0;
01107       char *dupline, *ignorepat = NULL;
01108       const char *s;
01109       char *ret = NULL;
01110       int len = strlen(a->word);
01111 
01112       /* XXX skip first three words 'dialplan' 'add' 'ignorepat' */
01113       s = skip_words(a->line, 3);
01114       if (s == NULL)
01115          return NULL;
01116       dupline = strdup(s);
01117       if (!dupline) {
01118          ast_log(LOG_ERROR, "Malloc failure\n");
01119          return NULL;
01120       }
01121       ignorepat = strsep(&dupline, " ");
01122 
01123       if (ast_rdlock_contexts()) {
01124          ast_log(LOG_ERROR, "Failed to lock contexts list\n");
01125          return NULL;
01126       }
01127 
01128       for (c = NULL; !ret && (c = ast_walk_contexts(c));) {
01129          int found = 0;
01130 
01131          if (!partial_match(ast_get_context_name(c), a->word, len))
01132             continue; /* not mine */
01133          if (ignorepat) /* there must be one, right ? */
01134             found = lookup_c_ip(c, ignorepat);
01135          if (!found && ++which > a->n)
01136             ret = strdup(ast_get_context_name(c));
01137       }
01138 
01139       free(ignorepat);
01140       ast_unlock_contexts();
01141       return ret;
01142    }
01143 
01144    return NULL;
01145 }
01146 
01147 static char *handle_cli_dialplan_remove_ignorepat(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01148 {
01149    switch (cmd) {
01150    case CLI_INIT:
01151       e->command = "dialplan remove ignorepat";
01152       e->usage =
01153          "Usage: dialplan remove ignorepat <pattern> from <context>\n"
01154          "       This command removes an ignore pattern from context <context>\n"
01155          "\n"
01156          "Example: dialplan remove ignorepat _3XX from local\n";
01157       return NULL;
01158    case CLI_GENERATE:
01159       return complete_dialplan_remove_ignorepat(a);
01160    }
01161 
01162    if (a->argc != 6)
01163       return CLI_SHOWUSAGE;
01164 
01165    if (strcmp(a->argv[4], "from"))
01166       return CLI_SHOWUSAGE;
01167 
01168    if (ast_context_remove_ignorepat(a->argv[5], a->argv[3], registrar)) {
01169       switch (errno) {
01170       case EBUSY:
01171          ast_cli(a->fd, "Failed to lock context(s) list, please try again later\n");
01172          break;
01173 
01174       case ENOENT:
01175          ast_cli(a->fd, "There is no existence of '%s' context\n", a->argv[5]);
01176          break;
01177 
01178       case EINVAL:
01179          ast_cli(a->fd, "There is no existence of '%s' ignore pattern in '%s' context\n",
01180                a->argv[3], a->argv[5]);
01181          break;
01182 
01183       default:
01184          ast_cli(a->fd, "Failed to remove ignore pattern '%s' from '%s' context\n",
01185                a->argv[3], a->argv[5]);
01186          break;
01187       }
01188       return CLI_FAILURE;
01189    }
01190 
01191    ast_cli(a->fd, "Ignore pattern '%s' removed from '%s' context\n",
01192       a->argv[3], a->argv[5]);
01193    return CLI_SUCCESS;
01194 }
01195 
01196 static char *complete_dialplan_remove_ignorepat(struct ast_cli_args *a)
01197 {
01198    struct ast_context *c;
01199    int which = 0;
01200    char *ret = NULL;
01201 
01202    if (a->pos == 3) {
01203       int len = strlen(a->word);
01204       if (ast_rdlock_contexts()) {
01205          ast_log(LOG_WARNING, "Failed to lock contexts list\n");
01206          return NULL;
01207       }
01208 
01209       for (c = NULL; !ret && (c = ast_walk_contexts(c));) {
01210          struct ast_ignorepat *ip;
01211 
01212          if (ast_rdlock_context(c)) /* error, skip it */
01213             continue;
01214          
01215          for (ip = NULL; !ret && (ip = ast_walk_context_ignorepats(c, ip));) {
01216             if (partial_match(ast_get_ignorepat_name(ip), a->word, len) && ++which > a->n) {
01217                /* n-th match */
01218                struct ast_context *cw = NULL;
01219                int found = 0;
01220                while ( (cw = ast_walk_contexts(cw)) && cw != c && !found) {
01221                   /* XXX do i stop on c, or skip it ? */
01222                   found = lookup_c_ip(cw, ast_get_ignorepat_name(ip));
01223                }
01224                if (!found)
01225                   ret = strdup(ast_get_ignorepat_name(ip));
01226             }
01227          }
01228          ast_unlock_context(c);
01229       }
01230       ast_unlock_contexts();
01231       return ret;
01232    } else if (a->pos == 4) {
01233        return a->n == 0 ? strdup("from") : NULL;
01234    } else if (a->pos == 5) { /* XXX check this */
01235       char *dupline, *duplinet, *ignorepat;
01236       int len = strlen(a->word);
01237 
01238       dupline = strdup(a->line);
01239       if (!dupline) {
01240          ast_log(LOG_WARNING, "Out of free memory\n");
01241          return NULL;
01242       }
01243 
01244       duplinet = dupline;
01245       strsep(&duplinet, " ");
01246       strsep(&duplinet, " ");
01247       ignorepat = strsep(&duplinet, " ");
01248 
01249       if (!ignorepat) {
01250          free(dupline);
01251          return NULL;
01252       }
01253 
01254       if (ast_rdlock_contexts()) {
01255          ast_log(LOG_WARNING, "Failed to lock contexts list\n");
01256          free(dupline);
01257          return NULL;
01258       }
01259 
01260       for (c = NULL; !ret && (c = ast_walk_contexts(c)); ) {
01261          if (ast_rdlock_context(c)) /* fail, skip it */
01262             continue;
01263          if (!partial_match(ast_get_context_name(c), a->word, len))
01264             continue;
01265          if (lookup_c_ip(c, ignorepat) && ++which > a->n)
01266             ret = strdup(ast_get_context_name(c));
01267          ast_unlock_context(c);
01268       }
01269       ast_unlock_contexts();
01270       free(dupline);
01271       return NULL;
01272    }
01273 
01274    return NULL;
01275 }
01276 
01277 static int pbx_load_module(void);
01278 
01279 static char *handle_cli_dialplan_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01280 {
01281    switch (cmd) {
01282    case CLI_INIT:
01283       e->command = "dialplan reload";
01284       e->usage =
01285          "Usage: dialplan reload\n"
01286          "       Reload extensions.conf without reloading any other\n"
01287          "       modules.  This command does not delete global variables\n"
01288          "       unless clearglobalvars is set to yes in extensions.conf\n";
01289       return NULL;
01290    case CLI_GENERATE:
01291       return NULL;
01292    }
01293 
01294    if (a->argc != 2)
01295       return CLI_SHOWUSAGE;
01296 
01297    if (clearglobalvars_config)
01298       pbx_builtin_clear_globals();
01299 
01300    pbx_load_module();
01301    ast_cli(a->fd, "Dialplan reloaded.\n");
01302    return CLI_SUCCESS;
01303 }
01304 
01305 /*!
01306  * CLI entries for commands provided by this module
01307  */
01308 static struct ast_cli_entry cli_pbx_config[] = {
01309    AST_CLI_DEFINE(handle_cli_dialplan_add_extension,    "Add new extension into context"),
01310    AST_CLI_DEFINE(handle_cli_dialplan_remove_extension, "Remove a specified extension"),
01311    AST_CLI_DEFINE(handle_cli_dialplan_add_ignorepat,    "Add new ignore pattern"),
01312    AST_CLI_DEFINE(handle_cli_dialplan_remove_ignorepat, "Remove ignore pattern from context"),
01313    AST_CLI_DEFINE(handle_cli_dialplan_add_include,      "Include context in other context"),
01314    AST_CLI_DEFINE(handle_cli_dialplan_remove_include,   "Remove a specified include from context"),
01315    AST_CLI_DEFINE(handle_cli_dialplan_reload,           "Reload extensions and *only* extensions")
01316 };
01317 
01318 static struct ast_cli_entry cli_dialplan_save =
01319    AST_CLI_DEFINE(handle_cli_dialplan_save, "Save dialplan");
01320 
01321 /*!
01322  * Standard module functions ...
01323  */
01324 static int unload_module(void)
01325 {
01326    if (static_config && !write_protect_config)
01327       ast_cli_unregister(&cli_dialplan_save);
01328    if (overrideswitch_config) {
01329       ast_free(overrideswitch_config);
01330    }
01331    ast_cli_unregister_multiple(cli_pbx_config, ARRAY_LEN(cli_pbx_config));
01332    ast_context_destroy(NULL, registrar);
01333    return 0;
01334 }
01335 
01336 /*!\note Protect against misparsing based upon commas in the middle of fields
01337  * like character classes.  We've taken steps to permit pretty much every other
01338  * printable character in a character class, so properly handling a comma at
01339  * this level is a natural extension.  This is almost like the standard
01340  * application parser in app.c, except that it handles square brackets. */
01341 static char *pbx_strsep(char **destructible, const char *delim)
01342 {
01343    int square = 0;
01344    char *res = *destructible;
01345    for (; destructible && *destructible && **destructible; (*destructible)++) {
01346       if (**destructible == '[' && !strchr(delim, '[')) {
01347          square++;
01348       } else if (**destructible == ']' && !strchr(delim, ']')) {
01349          if (square) {
01350             square--;
01351          }
01352       } else if (**destructible == '\\' && !strchr(delim, '\\')) {
01353          (*destructible)++;
01354       } else if (strchr(delim, **destructible) && !square) {
01355          **destructible = '\0';
01356          (*destructible)++;
01357          break;
01358       }
01359    }
01360    if (destructible && *destructible && **destructible == '\0') {
01361       *destructible = NULL;
01362    }
01363    return res;
01364 }
01365 
01366 static int pbx_load_config(const char *config_file)
01367 {
01368    struct ast_config *cfg;
01369    char *end;
01370    char *label;
01371 #ifdef LOW_MEMORY
01372    char realvalue[256];
01373 #else
01374    char realvalue[8192];
01375 #endif
01376    int lastpri = -2;
01377    struct ast_context *con;
01378    struct ast_variable *v;
01379    const char *cxt;
01380    const char *aft;
01381    const char *newpm, *ovsw;
01382    struct ast_flags config_flags = { 0 };
01383    char lastextension[256];
01384    cfg = ast_config_load(config_file, config_flags);
01385    if (!cfg || cfg == CONFIG_STATUS_FILEINVALID)
01386       return 0;
01387 
01388    /* Use existing config to populate the PBX table */
01389    static_config = ast_true(ast_variable_retrieve(cfg, "general", "static"));
01390    write_protect_config = ast_true(ast_variable_retrieve(cfg, "general", "writeprotect"));
01391    if ((aft = ast_variable_retrieve(cfg, "general", "autofallthrough")))
01392       autofallthrough_config = ast_true(aft);
01393    if ((newpm = ast_variable_retrieve(cfg, "general", "extenpatternmatchnew")))
01394       extenpatternmatchnew_config = ast_true(newpm);
01395    clearglobalvars_config = ast_true(ast_variable_retrieve(cfg, "general", "clearglobalvars"));
01396    if ((ovsw = ast_variable_retrieve(cfg, "general", "overrideswitch"))) {
01397       if (overrideswitch_config) {
01398          ast_free(overrideswitch_config);
01399       }
01400       if (!ast_strlen_zero(ovsw)) {
01401          overrideswitch_config = ast_strdup(ovsw);
01402       } else {
01403          overrideswitch_config = NULL;
01404       }
01405    }
01406 
01407    ast_copy_string(userscontext, ast_variable_retrieve(cfg, "general", "userscontext") ?: "default", sizeof(userscontext));
01408                             
01409    for (v = ast_variable_browse(cfg, "globals"); v; v = v->next) {
01410       pbx_substitute_variables_helper(NULL, v->value, realvalue, sizeof(realvalue) - 1);
01411       pbx_builtin_setvar_helper(NULL, v->name, realvalue);
01412    }
01413    for (cxt = ast_category_browse(cfg, NULL);
01414         cxt;
01415         cxt = ast_category_browse(cfg, cxt)) {
01416       /* All categories but "general" or "globals" are considered contexts */
01417       if (!strcasecmp(cxt, "general") || !strcasecmp(cxt, "globals")) {
01418          continue;
01419       }
01420       if (!(con = ast_context_find_or_create(&local_contexts, local_table, cxt, registrar))) {
01421          continue;
01422       }
01423 
01424       /* Reset continuation items at the beginning of each context */
01425       lastextension[0] = '\0';
01426       lastpri = -2;
01427 
01428       for (v = ast_variable_browse(cfg, cxt); v; v = v->next) {
01429          char *tc = NULL;
01430          char realext[256] = "";
01431          char *stringp, *ext;
01432 
01433          if (!strncasecmp(v->name, "same", 4)) {
01434             if (ast_strlen_zero(lastextension)) {
01435                ast_log(LOG_ERROR, "No previous pattern in the first entry of context '%s' to match '%s' at line %d!\n", cxt, v->name, v->lineno);
01436                continue;
01437             }
01438             if ((stringp = tc = ast_strdup(v->value))) {
01439                ast_copy_string(realext, lastextension, sizeof(realext));
01440                goto process_extension;
01441             }
01442          } else if (!strcasecmp(v->name, "exten")) {
01443             int ipri;
01444             char *plus, *firstp;
01445             char *pri, *appl, *data, *cidmatch;
01446 
01447             if (!(stringp = tc = ast_strdup(v->value))) {
01448                continue;
01449             }
01450 
01451             ext = S_OR(pbx_strsep(&stringp, ","), "");
01452             pbx_substitute_variables_helper(NULL, ext, realext, sizeof(realext) - 1);
01453             ast_copy_string(lastextension, realext, sizeof(lastextension));
01454 process_extension:
01455             ipri = -2;
01456             if ((cidmatch = strchr(realext, '/'))) {
01457                *cidmatch++ = '\0';
01458                ast_shrink_phone_number(cidmatch);
01459             }
01460             pri = ast_strip(S_OR(strsep(&stringp, ","), ""));
01461             if ((label = strchr(pri, '('))) {
01462                *label++ = '\0';
01463                if ((end = strchr(label, ')'))) {
01464                   *end = '\0';
01465                } else {
01466                   ast_log(LOG_WARNING, "Label missing trailing ')' at line %d\n", v->lineno);
01467                   ast_free(tc);
01468                   continue;
01469                }
01470             }
01471             if ((plus = strchr(pri, '+'))) {
01472                *plus++ = '\0';
01473             }
01474             if (!strcmp(pri,"hint")) {
01475                ipri = PRIORITY_HINT;
01476             } else if (!strcmp(pri, "next") || !strcmp(pri, "n")) {
01477                if (lastpri > -2) {
01478                   ipri = lastpri + 1;
01479                } else {
01480                   ast_log(LOG_WARNING, "Can't use 'next' priority on the first entry at line %d!\n", v->lineno);
01481                   ast_free(tc);
01482                   continue;
01483                }
01484             } else if (!strcmp(pri, "same") || !strcmp(pri, "s")) {
01485                if (lastpri > -2) {
01486                   ipri = lastpri;
01487                } else {
01488                   ast_log(LOG_WARNING, "Can't use 'same' priority on the first entry at line %d!\n", v->lineno);
01489                   ast_free(tc);
01490                   continue;
01491                }
01492             } else if (sscanf(pri, "%30d", &ipri) != 1 &&
01493                   (ipri = ast_findlabel_extension2(NULL, con, realext, pri, cidmatch)) < 1) {
01494                ast_log(LOG_WARNING, "Invalid priority/label '%s' at line %d\n", pri, v->lineno);
01495                ipri = 0;
01496                ast_free(tc);
01497                continue;
01498             } else if (ipri < 1) {
01499                ast_log(LOG_WARNING, "Invalid priority '%s' at line %d\n", pri, v->lineno);
01500                ast_free(tc);
01501                continue;
01502             }
01503             appl = S_OR(stringp, "");
01504             /* Find the first occurrence of '(' */
01505             if (!(firstp = strchr(appl, '('))) {
01506                /* No arguments */
01507                data = "";
01508             } else {
01509                char *orig_appl = ast_strdup(appl);
01510 
01511                if (!orig_appl) {
01512                   ast_free(tc);
01513                   continue;
01514                }
01515 
01516                appl = strsep(&stringp, "(");
01517 
01518                /* check if there are variables or expressions without an application, like: exten => 100,hint,DAHDI/g0/${GLOBAL(var)}  */
01519                if (strstr(appl, "${") || strstr(appl, "$[")){
01520                   /* set appl to original one */
01521                   strcpy(appl, orig_appl);
01522                   /* set no data */
01523                   data = "";
01524                /* no variable before application found -> go ahead */
01525                } else {
01526                   data = S_OR(stringp, "");
01527                   if ((end = strrchr(data, ')'))) {
01528                      *end = '\0';
01529                   } else {
01530                      ast_log(LOG_WARNING, "No closing parenthesis found? '%s(%s' at line %d\n", appl, data, v->lineno);
01531                   }
01532                }
01533                ast_free(orig_appl);
01534             }
01535 
01536             appl = ast_skip_blanks(appl);
01537             if (ipri) {
01538                if (plus) {
01539                   ipri += atoi(plus);
01540                }
01541                lastpri = ipri;
01542                if (!ast_opt_dont_warn && (!strcmp(realext, "_.") || !strcmp(realext, "_!"))) {
01543                   ast_log(LOG_WARNING, "The use of '%s' for an extension is strongly discouraged and can have unexpected behavior.  Please use '_X%c' instead at line %d\n", realext, realext[1], v->lineno);
01544                }
01545                if (ast_add_extension2(con, 0, realext, ipri, label, cidmatch, appl, strdup(data), ast_free_ptr, registrar)) {
01546                   ast_log(LOG_WARNING, "Unable to register extension at line %d\n", v->lineno);
01547                }
01548             }
01549             free(tc);
01550          } else if (!strcasecmp(v->name, "include")) {
01551             pbx_substitute_variables_helper(NULL, v->value, realvalue, sizeof(realvalue) - 1);
01552             if (ast_context_add_include2(con, realvalue, registrar)) {
01553                switch (errno) {
01554                   case ENOMEM:
01555                      ast_log(LOG_WARNING, "Out of memory for context addition\n");
01556                      break;
01557 
01558                   case EBUSY:
01559                      ast_log(LOG_WARNING, "Failed to lock context(s) list, please try again later\n");
01560                      break;
01561 
01562                   case EEXIST:
01563                      ast_log(LOG_WARNING, "Context '%s' already included in '%s' context on include at line %d\n",
01564                            v->value, cxt, v->lineno);
01565                      break;
01566 
01567                   case ENOENT:
01568                   case EINVAL:
01569                      ast_log(LOG_WARNING, "There is no existence of context '%s' included at line %d\n",
01570                            errno == ENOENT ? v->value : cxt, v->lineno);
01571                      break;
01572 
01573                   default:
01574                      ast_log(LOG_WARNING, "Failed to include '%s' in '%s' context at line %d\n",
01575                            v->value, cxt, v->lineno);
01576                      break;
01577                }
01578             }
01579          } else if (!strcasecmp(v->name, "ignorepat")) {
01580             pbx_substitute_variables_helper(NULL, v->value, realvalue, sizeof(realvalue) - 1);
01581             if (ast_context_add_ignorepat2(con, realvalue, registrar)) {
01582                ast_log(LOG_WARNING, "Unable to include ignorepat '%s' in context '%s' at line %d\n", v->value, cxt, v->lineno);
01583             }
01584          } else if (!strcasecmp(v->name, "switch") || !strcasecmp(v->name, "lswitch") || !strcasecmp(v->name, "eswitch")) {
01585             char *stringp = realvalue;
01586             char *appl, *data;
01587             
01588             if (!strcasecmp(v->name, "switch")) {
01589                pbx_substitute_variables_helper(NULL, v->value, realvalue, sizeof(realvalue) - 1);
01590             } else {
01591                ast_copy_string(realvalue, v->value, sizeof(realvalue));
01592             }
01593             appl = strsep(&stringp, "/");
01594             data = S_OR(stringp, "");
01595             if (ast_context_add_switch2(con, appl, data, !strcasecmp(v->name, "eswitch"), registrar)) {
01596                ast_log(LOG_WARNING, "Unable to include switch '%s' in context '%s' at line %d\n", v->value, cxt, v->lineno);
01597             }
01598          } else {
01599             ast_log(LOG_WARNING, "==!!== Unknown directive: %s at line %d -- IGNORING!!!\n", v->name, v->lineno);
01600          }
01601       }
01602    }
01603    ast_config_destroy(cfg);
01604    return 1;
01605 }
01606 
01607 static void append_interface(char *iface, int maxlen, char *add)
01608 {
01609    int len = strlen(iface);
01610    if (strlen(add) + len < maxlen - 2) {
01611       if (strlen(iface)) {
01612          iface[len] = '&';
01613          strcpy(iface + len + 1, add);
01614       } else
01615          strcpy(iface, add);
01616    }
01617 }
01618 
01619 static void pbx_load_users(void)
01620 {
01621    struct ast_config *cfg;
01622    char *cat, *chan;
01623    const char *dahdichan;
01624    const char *hasexten, *altexts;
01625    char tmp[256];
01626    char iface[256];
01627    char dahdicopy[256];
01628    char *ext, altcopy[256];
01629    char *c;
01630    int len;
01631    int hasvoicemail;
01632    int start, finish, x;
01633    struct ast_context *con = NULL;
01634    struct ast_flags config_flags = { 0 };
01635    
01636    cfg = ast_config_load("users.conf", config_flags);
01637    if (!cfg)
01638       return;
01639 
01640    for (cat = ast_category_browse(cfg, NULL); cat ; cat = ast_category_browse(cfg, cat)) {
01641       if (!strcasecmp(cat, "general"))
01642          continue;
01643       iface[0] = '\0';
01644       len = sizeof(iface);
01645       if (ast_true(ast_config_option(cfg, cat, "hassip"))) {
01646          snprintf(tmp, sizeof(tmp), "SIP/%s", cat);
01647          append_interface(iface, sizeof(iface), tmp);
01648       }
01649       if (ast_true(ast_config_option(cfg, cat, "hasiax"))) {
01650          snprintf(tmp, sizeof(tmp), "IAX2/%s", cat);
01651          append_interface(iface, sizeof(iface), tmp);
01652       }
01653       if (ast_true(ast_config_option(cfg, cat, "hash323"))) {
01654          snprintf(tmp, sizeof(tmp), "H323/%s", cat);
01655          append_interface(iface, sizeof(iface), tmp);
01656       }
01657       hasexten = ast_config_option(cfg, cat, "hasexten");
01658       if (hasexten && !ast_true(hasexten))
01659          continue;
01660       hasvoicemail = ast_true(ast_config_option(cfg, cat, "hasvoicemail"));
01661       dahdichan = ast_variable_retrieve(cfg, cat, "dahdichan");
01662       if (!dahdichan)
01663          dahdichan = ast_variable_retrieve(cfg, "general", "dahdichan");
01664       if (!ast_strlen_zero(dahdichan)) {
01665          ast_copy_string(dahdicopy, dahdichan, sizeof(dahdicopy));
01666          c = dahdicopy;
01667          chan = strsep(&c, ",");
01668          while (chan) {
01669             if (sscanf(chan, "%30d-%30d", &start, &finish) == 2) {
01670                /* Range */
01671             } else if (sscanf(chan, "%30d", &start)) {
01672                /* Just one */
01673                finish = start;
01674             } else {
01675                start = 0; finish = 0;
01676             }
01677             if (finish < start) {
01678                x = finish;
01679                finish = start;
01680                start = x;
01681             }
01682             for (x = start; x <= finish; x++) {
01683                snprintf(tmp, sizeof(tmp), "DAHDI/%d", x);
01684                append_interface(iface, sizeof(iface), tmp);
01685             }
01686             chan = strsep(&c, ",");
01687          }
01688       }
01689       if (!ast_strlen_zero(iface)) {
01690          /* Only create a context here when it is really needed. Otherwise default empty context
01691          created by pbx_config may conflict with the one explicitly created by pbx_ael */
01692          if (!con)
01693             con = ast_context_find_or_create(&local_contexts, local_table, userscontext, registrar);
01694 
01695          if (!con) {
01696             ast_log(LOG_ERROR, "Can't find/create user context '%s'\n", userscontext);
01697             return;
01698          }
01699 
01700          /* Add hint */
01701          ast_add_extension2(con, 0, cat, -1, NULL, NULL, iface, NULL, NULL, registrar);
01702          /* If voicemail, use "stdexten" else use plain old dial */
01703          if (hasvoicemail) {
01704             snprintf(tmp, sizeof(tmp), "stdexten,%s,${HINT}", cat);
01705             ast_add_extension2(con, 0, cat, 1, NULL, NULL, "Macro", strdup(tmp), ast_free_ptr, registrar);
01706          } else {
01707             ast_add_extension2(con, 0, cat, 1, NULL, NULL, "Dial", strdup("${HINT}"), ast_free_ptr, registrar);
01708          }
01709          altexts = ast_variable_retrieve(cfg, cat, "alternateexts");
01710          if (!ast_strlen_zero(altexts)) {
01711             snprintf(tmp, sizeof(tmp), "%s,1", cat);
01712             ast_copy_string(altcopy, altexts, sizeof(altcopy));
01713             c = altcopy;
01714             ext = strsep(&c, ",");
01715             while (ext) {
01716                ast_add_extension2(con, 0, ext, 1, NULL, NULL, "Goto", strdup(tmp), ast_free_ptr, registrar);
01717                ext = strsep(&c, ",");
01718             }
01719          }
01720       }
01721    }
01722    ast_config_destroy(cfg);
01723 }
01724 
01725 static int pbx_load_module(void)
01726 {
01727    struct ast_context *con;
01728 
01729    if (!local_table)
01730       local_table = ast_hashtab_create(17, ast_hashtab_compare_contexts, ast_hashtab_resize_java, ast_hashtab_newsize_java, ast_hashtab_hash_contexts, 0);
01731 
01732    if (!pbx_load_config(config))
01733       return AST_MODULE_LOAD_DECLINE;
01734    
01735    pbx_load_users();
01736 
01737    ast_merge_contexts_and_delete(&local_contexts, local_table, registrar);
01738    local_table = NULL; /* the local table has been moved into the global one. */
01739    local_contexts = NULL;
01740 
01741    for (con = NULL; (con = ast_walk_contexts(con));)
01742       ast_context_verify_includes(con);
01743 
01744    pbx_set_overrideswitch(overrideswitch_config);
01745    pbx_set_autofallthrough(autofallthrough_config);
01746    pbx_set_extenpatternmatchnew(extenpatternmatchnew_config);
01747 
01748    return AST_MODULE_LOAD_SUCCESS;
01749 }
01750 
01751 static int load_module(void)
01752 {
01753    if (static_config && !write_protect_config)
01754       ast_cli_register(&cli_dialplan_save);
01755    ast_cli_register_multiple(cli_pbx_config, ARRAY_LEN(cli_pbx_config));
01756 
01757    if (pbx_load_module())
01758       return AST_MODULE_LOAD_DECLINE;
01759 
01760    return AST_MODULE_LOAD_SUCCESS;
01761 }
01762 
01763 static int reload(void)
01764 {
01765    if (clearglobalvars_config)
01766       pbx_builtin_clear_globals();
01767    return pbx_load_module();
01768 }
01769 
01770 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Text Extension Configuration",
01771       .load = load_module,
01772       .unload = unload_module,
01773       .reload = reload,
01774           );