[asterisk/asterisk.git] / pbx.c

/*
 * 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 Core PBX routines.
 *
 * \author Mark Spencer <markster@digium.com>
 */

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision$")

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

#include "asterisk/lock.h"
#include "asterisk/cli.h"
#include "asterisk/pbx.h"
#include "asterisk/channel.h"
#include "asterisk/options.h"
#include "asterisk/logger.h"
#include "asterisk/file.h"
#include "asterisk/callerid.h"
#include "asterisk/cdr.h"
#include "asterisk/config.h"
#include "asterisk/term.h"
#include "asterisk/manager.h"
#include "asterisk/ast_expr.h"
#include "asterisk/linkedlists.h"
#define SAY_STUBS       /* generate declarations and stubs for say methods */
#include "asterisk/say.h"
#include "asterisk/utils.h"
#include "asterisk/causes.h"
#include "asterisk/musiconhold.h"
#include "asterisk/app.h"
#include "asterisk/devicestate.h"
#include "asterisk/stringfields.h"

/*!
 * \note I M P O R T A N T :
 *
 *              The speed of extension handling will likely be among the most important
 * aspects of this PBX.  The switching scheme as it exists right now isn't
 * terribly bad (it's O(N+M), where N is the # of extensions and M is the avg #
 * of priorities, but a constant search time here would be great ;-)
 *
 */

#ifdef LOW_MEMORY
#define EXT_DATA_SIZE 256
#else
#define EXT_DATA_SIZE 8192
#endif

#define SWITCH_DATA_LENGTH 256

#define VAR_BUF_SIZE 4096

#define VAR_NORMAL              1
#define VAR_SOFTTRAN    2
#define VAR_HARDTRAN    3

#define BACKGROUND_SKIP         (1 << 0)
#define BACKGROUND_NOANSWER     (1 << 1)
#define BACKGROUND_MATCHEXTEN   (1 << 2)
#define BACKGROUND_PLAYBACK     (1 << 3)

AST_APP_OPTIONS(background_opts, {
        AST_APP_OPTION('s', BACKGROUND_SKIP),
        AST_APP_OPTION('n', BACKGROUND_NOANSWER),
        AST_APP_OPTION('m', BACKGROUND_MATCHEXTEN),
        AST_APP_OPTION('p', BACKGROUND_PLAYBACK),
});

#define WAITEXTEN_MOH           (1 << 0)

AST_APP_OPTIONS(waitexten_opts, {
        AST_APP_OPTION_ARG('m', WAITEXTEN_MOH, 1),
});

struct ast_context;

/*!
   \brief ast_exten: An extension
        The dialplan is saved as a linked list with each context
        having it's own linked list of extensions - one item per
        priority.
*/
struct ast_exten {
        char *exten;                    /*!< Extension name */
        int matchcid;                   /*!< Match caller id ? */
        const char *cidmatch;           /*!< Caller id to match for this extension */
        int priority;                   /*!< Priority */
        const char *label;              /*!< Label */
        struct ast_context *parent;     /*!< The context this extension belongs to  */
        const char *app;                /*!< Application to execute */
        void *data;                     /*!< Data to use (arguments) */
        void (*datad)(void *);          /*!< Data destructor */
        struct ast_exten *peer;         /*!< Next higher priority with our extension */
        const char *registrar;          /*!< Registrar */
        struct ast_exten *next;         /*!< Extension with a greater ID */
        char stuff[0];
};

/*! \brief ast_include: include= support in extensions.conf */
struct ast_include {
        const char *name;
        const char *rname;                      /*!< Context to include */
        const char *registrar;                  /*!< Registrar */
        int hastime;                            /*!< If time construct exists */
        struct ast_timing timing;               /*!< time construct */
        struct ast_include *next;               /*!< Link them together */
        char stuff[0];
};

/*! \brief ast_sw: Switch statement in extensions.conf */
struct ast_sw {
        char *name;
        const char *registrar;                  /*!< Registrar */
        char *data;                             /*!< Data load */
        int eval;
        AST_LIST_ENTRY(ast_sw) list;
        char *tmpdata;
        char stuff[0];
};

/*! \brief ast_ignorepat: Ignore patterns in dial plan */
struct ast_ignorepat {
        const char *registrar;
        struct ast_ignorepat *next;
        const char pattern[0];
};

/*! \brief ast_context: An extension context */
struct ast_context {
        ast_mutex_t lock;                       /*!< A lock to prevent multiple threads from clobbering the context */
        struct ast_exten *root;                 /*!< The root of the list of extensions */
        struct ast_context *next;               /*!< Link them together */
        struct ast_include *includes;           /*!< Include other contexts */
        struct ast_ignorepat *ignorepats;       /*!< Patterns for which to continue playing dialtone */
        const char *registrar;                  /*!< Registrar */
        AST_LIST_HEAD_NOLOCK(, ast_sw) alts;    /*!< Alternative switches */
        char name[0];                           /*!< Name of the context */
};


/*! \brief ast_app: A registered application */
struct ast_app {
        int (*execute)(struct ast_channel *chan, void *data);
        const char *synopsis;                   /*!< Synopsis text for 'show applications' */
        const char *description;                /*!< Description (help text) for 'show application &lt;name&gt;' */
        AST_LIST_ENTRY(ast_app) list;           /*!< Next app in list */
        struct module *module;                  /*!< Module this app belongs to */
        char name[0];                           /*!< Name of the application */
};

/*! \brief ast_state_cb: An extension state notify register item */
struct ast_state_cb {
        int id;
        void *data;
        ast_state_cb_type callback;
        struct ast_state_cb *next;
};

/*! \brief Structure for dial plan hints

  \note Hints are pointers from an extension in the dialplan to one or
  more devices (tech/name) */
struct ast_hint {
        struct ast_exten *exten;        /*!< Extension */
        int laststate;                  /*!< Last known state */
        struct ast_state_cb *callbacks; /*!< Callback list for this extension */
        AST_LIST_ENTRY(ast_hint) list;  /*!< Pointer to next hint in list */
};

static const struct cfextension_states {
        int extension_state;
        const char * const text;
} extension_states[] = {
        { AST_EXTENSION_NOT_INUSE,                     "Idle" },
        { AST_EXTENSION_INUSE,                         "InUse" },
        { AST_EXTENSION_BUSY,                          "Busy" },
        { AST_EXTENSION_UNAVAILABLE,                   "Unavailable" },
        { AST_EXTENSION_RINGING,                       "Ringing" },
        { AST_EXTENSION_INUSE | AST_EXTENSION_RINGING, "InUse&Ringing" },
        { AST_EXTENSION_ONHOLD,                        "Hold" },
        { AST_EXTENSION_INUSE | AST_EXTENSION_ONHOLD,  "InUse&Hold" }
};

static int pbx_builtin_answer(struct ast_channel *, void *);
static int pbx_builtin_goto(struct ast_channel *, void *);
static int pbx_builtin_hangup(struct ast_channel *, void *);
static int pbx_builtin_background(struct ast_channel *, void *);
static int pbx_builtin_wait(struct ast_channel *, void *);
static int pbx_builtin_waitexten(struct ast_channel *, void *);
static int pbx_builtin_resetcdr(struct ast_channel *, void *);
static int pbx_builtin_setamaflags(struct ast_channel *, void *);
static int pbx_builtin_ringing(struct ast_channel *, void *);
static int pbx_builtin_progress(struct ast_channel *, void *);
static int pbx_builtin_congestion(struct ast_channel *, void *);
static int pbx_builtin_busy(struct ast_channel *, void *);
static int pbx_builtin_setglobalvar(struct ast_channel *, void *);
static int pbx_builtin_noop(struct ast_channel *, void *);
static int pbx_builtin_gotoif(struct ast_channel *, void *);
static int pbx_builtin_gotoiftime(struct ast_channel *, void *);
static int pbx_builtin_execiftime(struct ast_channel *, void *);
static int pbx_builtin_saynumber(struct ast_channel *, void *);
static int pbx_builtin_saydigits(struct ast_channel *, void *);
static int pbx_builtin_saycharacters(struct ast_channel *, void *);
static int pbx_builtin_sayphonetic(struct ast_channel *, void *);
int pbx_builtin_setvar(struct ast_channel *, void *);
static int pbx_builtin_importvar(struct ast_channel *, void *);

AST_MUTEX_DEFINE_STATIC(globalslock);
static struct varshead globals;

static int autofallthrough = 0;

AST_MUTEX_DEFINE_STATIC(maxcalllock);
static int countcalls = 0;

static AST_LIST_HEAD_STATIC(acf_root, ast_custom_function);

/*! \brief Declaration of builtin applications */
static struct pbx_builtin {
        char name[AST_MAX_APP];
        int (*execute)(struct ast_channel *chan, void *data);
        char *synopsis;
        char *description;
} builtins[] =
{
        /* These applications are built into the PBX core and do not
           need separate modules */

        { "Answer", pbx_builtin_answer,
        "Answer a channel if ringing",
        "  Answer([delay]): If the call has not been answered, this application will\n"
        "answer it. Otherwise, it has no effect on the call. If a delay is specified,\n"
        "Asterisk will wait this number of milliseconds before answering the call.\n"
        },

        { "BackGround", pbx_builtin_background,
        "Play an audio file while waiting for digits of an extension to go to.",
        "  Background(filename1[&filename2...][|options[|langoverride][|context]]):\n"
        "This application will play the given list of files while waiting for an\n"
        "extension to be dialed by the calling channel. To continue waiting for digits\n"
        "after this application has finished playing files, the WaitExten application\n"
        "should be used. The 'langoverride' option explicitly specifies which language\n"
        "to attempt to use for the requested sound files. If a 'context' is specified,\n"
        "this is the dialplan context that this application will use when exiting to a\n"
        "dialed extension."
        "  If one of the requested sound files does not exist, call processing will be\n"
        "terminated.\n"
        "  Options:\n"
        "    s - Causes the playback of the message to be skipped\n"
        "          if the channel is not in the 'up' state (i.e. it\n"
        "          hasn't been answered yet). If this happens, the\n"
        "          application will return immediately.\n"
        "    n - Don't answer the channel before playing the files.\n"
        "    m - Only break if a digit hit matches a one digit\n"
        "          extension in the destination context.\n"
        },

        { "Busy", pbx_builtin_busy,
        "Indicate the Busy condition",
        "  Busy([timeout]): This application will indicate the busy condition to\n"
        "the calling channel. If the optional timeout is specified, the calling channel\n"
        "will be hung up after the specified number of seconds. Otherwise, this\n"
        "application will wait until the calling channel hangs up.\n"
        },

        { "Congestion", pbx_builtin_congestion,
        "Indicate the Congestion condition",
        "  Congestion([timeout]): This application will indicate the congestion\n"
        "condition to the calling channel. If the optional timeout is specified, the\n"
        "calling channel will be hung up after the specified number of seconds.\n"
        "Otherwise, this application will wait until the calling channel hangs up.\n"
        },

        { "Goto", pbx_builtin_goto,
        "Jump to a particular priority, extension, or context",
        "  Goto([[context|]extension|]priority): This application will cause the\n"
        "calling channel to continue dialplan execution at the specified priority.\n"
        "If no specific extension, or extension and context, are specified, then this\n"
        "application will jump to the specified priority of the current extension.\n"
        "  If the attempt to jump to another location in the dialplan is not successful,\n"
        "then the channel will continue at the next priority of the current extension.\n"
        },

        { "GotoIf", pbx_builtin_gotoif,
        "Conditional goto",
        "  GotoIf(condition?[labeliftrue]:[labeliffalse]): This application will cause\n"
        "the calling channel to jump to the specified location in the dialplan based on\n"
        "the evaluation of the given condition. The channel will continue at\n"
        "'labeliftrue' if the condition is true, or 'labeliffalse' if the condition is\n"
        "false. The labels are specified with the same syntax as used within the Goto\n"
        "application.  If the label chosen by the condition is omitted, no jump is\n"
        "performed, but execution continues with the next priority in the dialplan.\n"
        },

        { "GotoIfTime", pbx_builtin_gotoiftime,
        "Conditional Goto based on the current time",
        "  GotoIfTime(<times>|<weekdays>|<mdays>|<months>?[[context|]exten|]priority):\n"
        "This application will have the calling channel jump to the specified location\n"
        "in the dialplan if the current time matches the given time specification.\n"
        },

        { "ExecIfTime", pbx_builtin_execiftime,
        "Conditional application execution based on the current time",
        "  ExecIfTime(<times>|<weekdays>|<mdays>|<months>?appname[|appargs]):\n"
        "This application will execute the specified dialplan application, with optional\n"
        "arguments, if the current time matches the given time specification.\n"
        },

        { "Hangup", pbx_builtin_hangup,
        "Hang up the calling channel",
        "  Hangup([causecode]): This application will hang up the calling channel.\n"
        "If a causecode is given the channel's hangup cause will be set to the given\n"
        "value.\n"
        },

        { "NoOp", pbx_builtin_noop,
        "Do Nothing",
        "  NoOp(): This applicatiion does nothing. However, it is useful for debugging\n"
        "purposes. Any text that is provided as arguments to this application can be\n"
        "viewed at the Asterisk CLI. This method can be used to see the evaluations of\n"
        "variables or functions without having any effect."
        },

        { "Progress", pbx_builtin_progress,
        "Indicate progress",
        "  Progress(): This application will request that in-band progress information\n"
        "be provided to the calling channel.\n"
        },

        { "ResetCDR", pbx_builtin_resetcdr,
        "Resets the Call Data Record",
        "  ResetCDR([options]):  This application causes the Call Data Record to be\n"
        "reset.\n"
        "  Options:\n"
        "    w -- Store the current CDR record before resetting it.\n"
        "    a -- Store any stacked records.\n"
        "    v -- Save CDR variables.\n"
        },

        { "Ringing", pbx_builtin_ringing,
        "Indicate ringing tone",
        "  Ringing(): This application will request that the channel indicate a ringing\n"
        "tone to the user.\n"
        },

        { "SayNumber", pbx_builtin_saynumber,
        "Say Number",
        "  SayNumber(digits[,gender]): This application will play the sounds that\n"
        "correspond to the given number. Optionally, a gender may be specified.\n"
        "This will use the language that is currently set for the channel. See the\n"
        "LANGUAGE function for more information on setting the language for the channel.\n"
        },

        { "SayDigits", pbx_builtin_saydigits,
        "Say Digits",
        "  SayDigits(digits): This application will play the sounds that correspond\n"
        "to the digits of the given number. This will use the language that is currently\n"
        "set for the channel. See the LANGUAGE function for more information on setting\n"
        "the language for the channel.\n"
        },

        { "SayAlpha", pbx_builtin_saycharacters,
        "Say Alpha",
        "  SayAlpha(string): This application will play the sounds that correspond to\n"
        "the letters of the given string.\n"
        },

        { "SayPhonetic", pbx_builtin_sayphonetic,
        "Say Phonetic",
        "  SayPhonetic(string): This application will play the sounds from the phonetic\n"
        "alphabet that correspond to the letters in the given string.\n"
        },

        { "SetAMAFlags", pbx_builtin_setamaflags,
        "Set the AMA Flags",
        "  SetAMAFlags([flag]): This application will set the channel's AMA Flags for\n"
        "  billing purposes.\n"
        },

        { "SetGlobalVar", pbx_builtin_setglobalvar,
        "Set a global variable to a given value",
        "  SetGlobalVar(variable=value): This application sets a given global variable to\n"
        "the specified value.\n"
        },

        { "Set", pbx_builtin_setvar,
        "Set channel variable(s) or function value(s)",
        "  Set(name1=value1|name2=value2|..[|options])\n"
        "This function can be used to set the value of channel variables or dialplan\n"
        "functions. It will accept up to 24 name/value pairs. When setting variables,\n"
        "if the variable name is prefixed with _, the variable will be inherited into\n"
        "channels created from the current channel. If the variable name is prefixed\n"
        "with __, the variable will be inherited into channels created from the current\n"
        "channel and all children channels.\n"
        "  Options:\n"
        "    g - Set variable globally instead of on the channel\n"
        "        (applies only to variables, not functions)\n"
        },

        { "ImportVar", pbx_builtin_importvar,
        "Import a variable from a channel into a new variable",
        "  ImportVar(newvar=channelname|variable): This application imports a variable\n"
        "from the specified channel (as opposed to the current one) and stores it as\n"
        "a variable in the current channel (the channel that is calling this\n"
        "application). Variables created by this application have the same inheritance\n"
        "properties as those created with the Set application. See the documentation for\n"
        "Set for more information.\n"
        },

        { "Wait", pbx_builtin_wait,
        "Waits for some time",
        "  Wait(seconds): This application waits for a specified number of seconds.\n"
        "Then, dialplan execution will continue at the next priority.\n"
        "  Note that the seconds can be passed with fractions of a second. For example,\n"
        "'1.5' will ask the application to wait for 1.5 seconds.\n"
        },

        { "WaitExten", pbx_builtin_waitexten,
        "Waits for an extension to be entered",
        "  WaitExten([seconds][|options]): This application waits for the user to enter\n"
        "a new extension for a specified number of seconds.\n"
        "  Note that the seconds can be passed with fractions of a second. For example,\n"
        "'1.5' will ask the application to wait for 1.5 seconds.\n"
        "  Options:\n"
        "    m[(x)] - Provide music on hold to the caller while waiting for an extension.\n"
        "               Optionally, specify the class for music on hold within parenthesis.\n"
        },

};

static struct ast_context *contexts = NULL;
AST_MUTEX_DEFINE_STATIC(conlock);               /*!< Lock for the ast_context list */

static AST_LIST_HEAD_STATIC(apps, ast_app);

static AST_LIST_HEAD_STATIC(switches, ast_switch);

static int stateid = 1;
/* WARNING:
   When holding this list's lock, do _not_ do anything that will cause conlock
   to be taken, unless you _already_ hold it. The ast_merge_contexts_and_delete
   function will take the locks in conlock/hints order, so any other
   paths that require both locks must also take them in that order.
*/
static AST_LIST_HEAD_STATIC(hints, ast_hint);
struct ast_state_cb *statecbs = NULL;

/*
   \note This function is special. It saves the stack so that no matter
   how many times it is called, it returns to the same place */
int pbx_exec(struct ast_channel *c,             /*!< Channel */
                struct ast_app *app,            /*!< Application */
                void *data)                     /*!< Data for execution */
{
        int res;

        const char *saved_c_appl;
        const char *saved_c_data;

        if (c->cdr)
                ast_cdr_setapp(c->cdr, app->name, data);

        /* save channel values */
        saved_c_appl= c->appl;
        saved_c_data= c->data;

        c->appl = app->name;
        c->data = data;
        /* XXX remember what to to when we have linked apps to modules */
        if (app->module) {
                /* XXX LOCAL_USER_ADD(app->module) */
        }
        res = app->execute(c, data);
        if (app->module) {
                /* XXX LOCAL_USER_REMOVE(app->module) */
        }
        /* restore channel values */
        c->appl = saved_c_appl;
        c->data = saved_c_data;
        return res;
}


/*! Go no deeper than this through includes (not counting loops) */
#define AST_PBX_MAX_STACK       128

/*! \brief Find application handle in linked list
 */
struct ast_app *pbx_findapp(const char *app)
{
        struct ast_app *tmp;

        AST_LIST_LOCK(&apps);
        AST_LIST_TRAVERSE(&apps, tmp, list) {
                if (!strcasecmp(tmp->name, app))
                        break;
        }
        AST_LIST_UNLOCK(&apps);

        return tmp;
}

static struct ast_switch *pbx_findswitch(const char *sw)
{
        struct ast_switch *asw;

        AST_LIST_LOCK(&switches);
        AST_LIST_TRAVERSE(&switches, asw, list) {
                if (!strcasecmp(asw->name, sw))
                        break;
        }
        AST_LIST_UNLOCK(&switches);

        return asw;
}

static inline int include_valid(struct ast_include *i)
{
        if (!i->hastime)
                return 1;

        return ast_check_timing(&(i->timing));
}

static void pbx_destroy(struct ast_pbx *p)
{
        free(p);
}

/*
 * Special characters used in patterns:
 *      '_'     underscore is the leading character of a pattern.
 *              In other position it is treated as a regular char.
 *      ' ' '-' space and '-' are separator and ignored.
 *      .       one or more of any character. Only allowed at the end of
 *              a pattern.
 *      !       zero or more of anything. Also impacts the result of CANMATCH
 *              and MATCHMORE. Only allowed at the end of a pattern.
 *              In the core routine, ! causes a match with a return code of 2.
 *              In turn, depending on the search mode: (XXX check if it is implemented)
 *              - E_MATCH retuns 1 (does match)
 *              - E_MATCHMORE returns 0 (no match)
 *              - E_CANMATCH returns 1 (does match)
 *
 *      /       should not appear as it is considered the separator of the CID info.
 *              XXX at the moment we may stop on this char.
 *
 *      X Z N   match ranges 0-9, 1-9, 2-9 respectively.
 *      [       denotes the start of a set of character. Everything inside
 *              is considered literally. We can have ranges a-d and individual
 *              characters. A '[' and '-' can be considered literally if they
 *              are just before ']'.
 *              XXX currently there is no way to specify ']' in a range, nor \ is
 *              considered specially.
 *
 * When we compare a pattern with a specific extension, all characters in the extension
 * itself are considered literally with the only exception of '-' which is considered
 * as a separator and thus ignored.
 * XXX do we want to consider space as a separator as well ?
 * XXX do we want to consider the separators in non-patterns as well ?
 */

/*!
 * \brief helper functions to sort extensions and patterns in the desired way,
 * so that more specific patterns appear first.
 *
 * ext_cmp1 compares individual characters (or sets of), returning
 * an int where bits 0-7 are the ASCII code of the first char in the set,
 * while bit 8-15 are the cardinality of the set minus 1.
 * This way more specific patterns (smaller cardinality) appear first.
 * Wildcards have a special value, so that we can directly compare them to
 * sets by subtracting the two values. In particular:
 *      0x000xx         one character, xx
 *      0x0yyxx         yy character set starting with xx
 *      0x10000         '.' (one or more of anything)
 *      0x20000         '!' (zero or more of anything)
 *      0x30000         NUL (end of string)
 *      0x40000         error in set.
 * The pointer to the string is advanced according to needs.
 * NOTES:
 *      1. the empty set is equivalent to NUL.
 *      2. given that a full set has always 0 as the first element,
 *         we could encode the special cases as 0xffXX where XX
 *         is 1, 2, 3, 4 as used above.
 */
static int ext_cmp1(const char **p)
{
        uint32_t chars[8];
        int c, cmin = 0xff, count = 0;
        const char *end;

        /* load, sign extend and advance pointer until we find
         * a valid character.
         */
        while ( (c = *(*p)++) && (c == ' ' || c == '-') )
                ;       /* ignore some characters */

        /* always return unless we have a set of chars */
        switch (c) {
        default:        /* ordinary character */
                return 0x0000 | (c & 0xff);

        case 'N':       /* 2..9 */
                return 0x0700 | '2' ;

        case 'X':       /* 0..9 */
                return 0x0900 | '0';

        case 'Z':       /* 1..9 */
                return 0x0800 | '1';

        case '.':       /* wildcard */
                return 0x10000;

        case '!':       /* earlymatch */
                return 0x20000; /* less specific than NULL */

        case '\0':      /* empty string */
                *p = NULL;
                return 0x30000;

        case '[':       /* pattern */
                break;
        }
        /* locate end of set */
        end = strchr(*p, ']');  

        if (end == NULL) {
                ast_log(LOG_WARNING, "Wrong usage of [] in the extension\n");
                return 0x40000; /* XXX make this entry go last... */
        }

        bzero(chars, sizeof(chars));    /* clear all chars in the set */
        for (; *p < end  ; (*p)++) {
                unsigned char c1, c2;   /* first-last char in range */
                c1 = (unsigned char)((*p)[0]);
                if (*p + 2 < end && (*p)[1] == '-') { /* this is a range */
                        c2 = (unsigned char)((*p)[2]);
                        *p += 2;        /* skip a total of 3 chars */
                } else                  /* individual character */
                        c2 = c1;
                if (c1 < cmin)
                        cmin = c1;
                for (; c1 <= c2; c1++) {
                        uint32_t mask = 1 << (c1 % 32);
                        if ( (chars[ c1 / 32 ] & mask) == 0)
                                count += 0x100;
                        chars[ c1 / 32 ] |= mask;
                }
        }
        (*p)++;
        return count == 0 ? 0x30000 : (count | cmin);
}

/*!
 * \brief the full routine to compare extensions in rules.
 */
static int ext_cmp(const char *a, const char *b)
{
        /* make sure non-patterns come first.
         * If a is not a pattern, it either comes first or
         * we use strcmp to compare the strings.
         */
        int ret = 0;

        if (a[0] != '_')
                return (b[0] == '_') ? -1 : strcmp(a, b);

        /* Now we know a is a pattern; if b is not, a comes first */
        if (b[0] != '_')
                return 1;
#if 0   /* old mode for ext matching */
        return strcmp(a, b);
#endif
        /* ok we need full pattern sorting routine */
        while (!ret && a && b)
                ret = ext_cmp1(&a) - ext_cmp1(&b);
        if (ret == 0)
                return 0;
        else
                return (ret > 0) ? 1 : -1;
}

/*!
 * When looking up extensions, we can have different requests
 * identified by the 'action' argument, as follows.
 * Note that the coding is such that the low 4 bits are the
 * third argument to extension_match_core.
 */
enum ext_match_t {
        E_MATCHMORE =   0x00,   /* extension can match but only with more 'digits' */
        E_CANMATCH =    0x01,   /* extension can match with or without more 'digits' */
        E_MATCH =       0x02,   /* extension is an exact match */
        E_MATCH_MASK =  0x03,   /* mask for the argument to extension_match_core() */
        E_SPAWN =       0x12,   /* want to spawn an extension. Requires exact match */
        E_FINDLABEL =   0x22    /* returns the priority for a given label. Requires exact match */
};

/*
 * Internal function for ast_extension_{match|close}
 * return 0 on no-match, 1 on match, 2 on early match.
 * mode is as follows:
 *      E_MATCH         success only on exact match
 *      E_MATCHMORE     success only on partial match (i.e. leftover digits in pattern)
 *      E_CANMATCH      either of the above.
 */
static int _extension_match_core(const char *pattern, const char *data, enum ext_match_t mode)
{
        mode &= E_MATCH_MASK;   /* only consider the relevant bits */

        if (pattern[0] != '_') { /* not a pattern, try exact or partial match */
                int ld = strlen(data), lp = strlen(pattern);

                if (lp < ld)            /* pattern too short, cannot match */
                        return 0;
                /* depending on the mode, accept full or partial match or both */
                if (mode == E_MATCH)
                        return !strcmp(pattern, data); /* 1 on match, 0 on fail */
                if (ld == 0 || !strncasecmp(pattern, data, ld)) /* partial or full match */
                        return (mode == E_MATCHMORE) ? lp > ld : 1; /* XXX should consider '!' and '/' ? */
                else
                        return 0;
        }
        pattern++; /* skip leading _ */
        /*
         * XXX below we stop at '/' which is a separator for the CID info. However we should
         * not store '/' in the pattern at all. When we insure it, we can remove the checks.
         */
        while (*data && *pattern && *pattern != '/') {
                const char *end;

                if (*data == '-') { /* skip '-' in data (just a separator) */
                        data++;
                        continue;
                }
                switch (toupper(*pattern)) {
                case '[':       /* a range */
                        end = strchr(pattern+1, ']'); /* XXX should deal with escapes ? */
                        if (end == NULL) {
                                ast_log(LOG_WARNING, "Wrong usage of [] in the extension\n");
                                return 0;       /* unconditional failure */
                        }
                        for (pattern++; pattern != end; pattern++) {
                                if (pattern+2 < end && pattern[1] == '-') { /* this is a range */
                                        if (*data >= pattern[0] && *data <= pattern[2])
                                                break;  /* match found */
                                        else {
                                                pattern += 2; /* skip a total of 3 chars */
                                                continue;
                                        }
                                } else if (*data == pattern[0])
                                        break;  /* match found */
                        }
                        if (pattern == end)
                                return 0;
                        pattern = end;  /* skip and continue */
                        break;
                case 'N':
                        if (*data < '2' || *data > '9')
                                return 0;
                        break;
                case 'X':
                        if (*data < '0' || *data > '9')
                                return 0;
                        break;
                case 'Z':
                        if (*data < '1' || *data > '9')
                                return 0;
                        break;
                case '.':       /* Must match, even with more digits */
                        return 1;
                case '!':       /* Early match */
                        return 2;
                case ' ':
                case '-':       /* Ignore these in patterns */
                        data--; /* compensate the final data++ */
                        break;
                default:
                        if (*data != *pattern)
                                return 0;
                }
                data++;
                pattern++;
        }
        if (*data)                      /* data longer than pattern, no match */
                return 0;
        /*
         * match so far, but ran off the end of the data.
         * Depending on what is next, determine match or not.
         */
        if (*pattern == '\0' || *pattern == '/')        /* exact match */
                return (mode == E_MATCHMORE) ? 0 : 1;   /* this is a failure for E_MATCHMORE */
        else if (*pattern == '!')                       /* early match */
                return 2;
        else                                            /* partial match */
                return (mode == E_MATCH) ? 0 : 1;       /* this is a failure for E_MATCH */
}

/*
 * Wrapper around _extension_match_core() to do performance measurement
 * using the profiling code.
 */
static int extension_match_core(const char *pattern, const char *data, enum ext_match_t mode)
{
        int i;
        static int prof_id = -2;        /* marker for 'unallocated' id */
        if (prof_id == -2)
                prof_id = ast_add_profile("ext_match", 0);
        ast_mark(prof_id, 1);
        i = _extension_match_core(pattern, data, mode);
        ast_mark(prof_id, 0);
        return i;
}

int ast_extension_match(const char *pattern, const char *data)
{
        return extension_match_core(pattern, data, E_MATCH);
}

int ast_extension_close(const char *pattern, const char *data, int needmore)
{
        if (needmore != E_MATCHMORE && needmore != E_CANMATCH)
                ast_log(LOG_WARNING, "invalid argument %d\n", needmore);
        return extension_match_core(pattern, data, needmore);
}

struct ast_context *ast_context_find(const char *name)
{
        struct ast_context *tmp = NULL;
        ast_mutex_lock(&conlock);
        while ( (tmp = ast_walk_contexts(tmp)) ) {
                if (!name || !strcasecmp(name, tmp->name))
                        break;
        }
        ast_mutex_unlock(&conlock);
        return tmp;
}

#define STATUS_NO_CONTEXT       1
#define STATUS_NO_EXTENSION     2
#define STATUS_NO_PRIORITY      3
#define STATUS_NO_LABEL         4
#define STATUS_SUCCESS          5

static int matchcid(const char *cidpattern, const char *callerid)
{
        /* If the Caller*ID pattern is empty, then we're matching NO Caller*ID, so
           failing to get a number should count as a match, otherwise not */

        if (ast_strlen_zero(callerid))
                return ast_strlen_zero(cidpattern) ? 1 : 0;

        return ast_extension_match(cidpattern, callerid);
}

/* request and result for pbx_find_extension */
struct pbx_find_info {
#if 0
        const char *context;
        const char *exten;
        int priority;
#endif

        char *incstack[AST_PBX_MAX_STACK];      /* filled during the search */
        int stacklen;                   /* modified during the search */
        int status;                     /* set on return */
        struct ast_switch *swo;         /* set on return */
        const char *data;               /* set on return */
        const char *foundcontext;       /* set on return */
};

static struct ast_exten *pbx_find_extension(struct ast_channel *chan,
        struct ast_context *bypass, struct pbx_find_info *q,
        const char *context, const char *exten, int priority,
        const char *label, const char *callerid, enum ext_match_t action)
{
        int x, res;
        struct ast_context *tmp;
        struct ast_exten *e, *eroot;
        struct ast_include *i;
        struct ast_sw *sw;

        /* Initialize status if appropriate */
        if (q->stacklen == 0) {
                q->status = STATUS_NO_CONTEXT;
                q->swo = NULL;
                q->data = NULL;
                q->foundcontext = NULL;
        }
        /* Check for stack overflow */
        if (q->stacklen >= AST_PBX_MAX_STACK) {
                ast_log(LOG_WARNING, "Maximum PBX stack exceeded\n");
                return NULL;
        }
        /* Check first to see if we've already been checked */
        for (x = 0; x < q->stacklen; x++) {
                if (!strcasecmp(q->incstack[x], context))
                        return NULL;
        }
        if (bypass)     /* bypass means we only look there */
                tmp = bypass;
        else {  /* look in contexts */
                tmp = NULL;
                while ((tmp = ast_walk_contexts(tmp)) ) {
                        if (!strcmp(tmp->name, context))
                                break;
                }
                if (!tmp)
                        return NULL;
        }
        if (q->status < STATUS_NO_EXTENSION)
                q->status = STATUS_NO_EXTENSION;

        /* scan the list trying to match extension and CID */
        eroot = NULL;
        while ( (eroot = ast_walk_context_extensions(tmp, eroot)) ) {
                int match = extension_match_core(eroot->exten, exten, action);
                /* 0 on fail, 1 on match, 2 on earlymatch */

                if (!match || (eroot->matchcid && !matchcid(eroot->cidmatch, callerid)))
                        continue;       /* keep trying */
                if (match == 2 && action == E_MATCHMORE) {
                        /* We match an extension ending in '!'.
                         * The decision in this case is final and is NULL (no match).
                         */
                        return NULL;
                }
                /* found entry, now look for the right priority */
                if (q->status < STATUS_NO_PRIORITY)
                        q->status = STATUS_NO_PRIORITY;
                e = NULL;
                while ( (e = ast_walk_extension_priorities(eroot, e)) ) {
                        /* Match label or priority */
                        if (action == E_FINDLABEL) {
                                if (q->status < STATUS_NO_LABEL)
                                        q->status = STATUS_NO_LABEL;
                                if (label && e->label && !strcmp(label, e->label))
                                        break;  /* found it */
                        } else if (e->priority == priority) {
                                break;  /* found it */
                        } /* else keep searching */
                }
                if (e) {        /* found a valid match */
                        q->status = STATUS_SUCCESS;
                        q->foundcontext = context;
                        return e;
                }
        }
        /* Check alternative switches */
        AST_LIST_TRAVERSE(&tmp->alts, sw, list) {
                struct ast_switch *asw = pbx_findswitch(sw->name);
                ast_switch_f *aswf = NULL;
                char *datap;

                if (!asw) {
                        ast_log(LOG_WARNING, "No such switch '%s'\n", sw->name);
                        continue;
                }
                /* Substitute variables now */
                if (sw->eval)
                        pbx_substitute_variables_helper(chan, sw->data, sw->tmpdata, SWITCH_DATA_LENGTH - 1);

                /* equivalent of extension_match_core() at the switch level */
                if (action == E_CANMATCH)
                        aswf = asw->canmatch;
                else if (action == E_MATCHMORE)
                        aswf = asw->matchmore;
                else /* action == E_MATCH */
                        aswf = asw->exists;
                datap = sw->eval ? sw->tmpdata : sw->data;
                res = !aswf ? 0 : aswf(chan, context, exten, priority, callerid, datap);
                if (res) {      /* Got a match */
                        q->swo = asw;
                        q->data = datap;
                        q->foundcontext = context;
                        /* XXX keep status = STATUS_NO_CONTEXT ? */
                        return NULL;
                }
        }
        q->incstack[q->stacklen++] = tmp->name; /* Setup the stack */
        /* Now try any includes we have in this context */
        for (i = tmp->includes; i; i = i->next) {
                if (include_valid(i)) {
                        if ((e = pbx_find_extension(chan, bypass, q, i->rname, exten, priority, label, callerid, action)))
                                return e;
                        if (q->swo)
                                return NULL;
                }
        }
        return NULL;
}

/*! \brief extract offset:length from variable name.
 * Returns 1 if there is a offset:length part, which is
 * trimmed off (values go into variables)
 */
static int parse_variable_name(char *var, int *offset, int *length, int *isfunc)
{
        int parens=0;

        *offset = 0;
        *length = INT_MAX;
        *isfunc = 0;
        for (; *var; var++) {
                if (*var == '(') {
                        (*isfunc)++;
                        parens++;
                } else if (*var == ')') {
                        parens--;
                } else if (*var == ':' && parens == 0) {
                        *var++ = '\0';
                        sscanf(var, "%d:%d", offset, length);
                        return 1; /* offset:length valid */
                }
        }
        return 0;
}

/*! \brief takes a substring. It is ok to call with value == workspace.
 *
 * offset < 0 means start from the end of the string and set the beginning
 *   to be that many characters back.
 * length is the length of the substring.  A value less than 0 means to leave
 * that many off the end.
 * Always return a copy in workspace.
 */
static char *substring(const char *value, int offset, int length, char *workspace, size_t workspace_len)
{
        char *ret = workspace;
        int lr; /* length of the input string after the copy */

        ast_copy_string(workspace, value, workspace_len); /* always make a copy */

        lr = strlen(ret); /* compute length after copy, so we never go out of the workspace */

        /* Quick check if no need to do anything */
        if (offset == 0 && length >= lr)        /* take the whole string */
                return ret;

        if (offset < 0) {       /* translate negative offset into positive ones */
                offset = lr + offset;
                if (offset < 0) /* If the negative offset was greater than the length of the string, just start at the beginning */
                        offset = 0;
        }

        /* too large offset result in empty string so we know what to return */
        if (offset >= lr)
                return ret + lr;        /* the final '\0' */

        ret += offset;          /* move to the start position */
        if (length >= 0 && length < lr - offset)        /* truncate if necessary */
                ret[length] = '\0';
        else if (length < 0) {
                if (lr > offset - length) /* After we remove from the front and from the rear, is there anything left? */
                        ret[lr + length - offset] = '\0';
                else
                        ret[0] = '\0';
        }

        return ret;
}

/*! \brief  pbx_retrieve_variable: Support for Asterisk built-in variables and
      functions in the dialplan
  ---*/
void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
{
        const char not_found = '\0';
        char *tmpvar;
        const char *s;  /* the result */
        int offset, length;
        int i, need_substring;
        struct varshead *places[2] = { headp, &globals };       /* list of places where we may look */

        if (c) {
                places[0] = &c->varshead;
        }
        /*
         * Make a copy of var because parse_variable_name() modifies the string.
         * Then if called directly, we might need to run substring() on the result;
         * remember this for later in 'need_substring', 'offset' and 'length'
         */
        tmpvar = ast_strdupa(var);      /* parse_variable_name modifies the string */
        need_substring = parse_variable_name(tmpvar, &offset, &length, &i /* ignored */);

        /*
         * Look first into predefined variables, then into variable lists.
         * Variable 's' points to the result, according to the following rules:
         * s == &not_found (set at the beginning) means that we did not find a
         *      matching variable and need to look into more places.
         * If s != &not_found, s is a valid result string as follows:
         * s = NULL if the variable does not have a value;
         *      you typically do this when looking for an unset predefined variable.
         * s = workspace if the result has been assembled there;
         *      typically done when the result is built e.g. with an snprintf(),
         *      so we don't need to do an additional copy.
         * s != workspace in case we have a string, that needs to be copied
         *      (the ast_copy_string is done once for all at the end).
         *      Typically done when the result is already available in some string.
         */
        s = &not_found; /* default value */
        if (c) {        /* This group requires a valid channel */
                /* Names with common parts are looked up a piece at a time using strncmp. */
                if (!strncmp(var, "CALL", 4)) {
                        if (!strncmp(var + 4, "ING", 3)) {
                                if (!strcmp(var + 7, "PRES")) {                 /* CALLINGPRES */
                                        snprintf(workspace, workspacelen, "%d", c->cid.cid_pres);
                                        s = workspace;
                                } else if (!strcmp(var + 7, "ANI2")) {          /* CALLINGANI2 */
                                        snprintf(workspace, workspacelen, "%d", c->cid.cid_ani2);
                                        s = workspace;
                                } else if (!strcmp(var + 7, "TON")) {           /* CALLINGTON */
                                        snprintf(workspace, workspacelen, "%d", c->cid.cid_ton);
                                        s = workspace;
                                } else if (!strcmp(var + 7, "TNS")) {           /* CALLINGTNS */
                                        snprintf(workspace, workspacelen, "%d", c->cid.cid_tns);
                                        s = workspace;
                                }
                        }
                } else if (!strcmp(var, "HINT")) {
                        s = ast_get_hint(workspace, workspacelen, NULL, 0, c, c->context, c->exten) ? workspace : NULL;
                } else if (!strcmp(var, "HINTNAME")) {
                        s = ast_get_hint(NULL, 0, workspace, workspacelen, c, c->context, c->exten) ? workspace : NULL;
                } else if (!strcmp(var, "EXTEN")) {
                        s = c->exten;
                } else if (!strcmp(var, "CONTEXT")) {
                        s = c->context;
                } else if (!strcmp(var, "PRIORITY")) {
                        snprintf(workspace, workspacelen, "%d", c->priority);
                        s = workspace;
                } else if (!strcmp(var, "CHANNEL")) {
                        s = c->name;
                } else if (!strcmp(var, "UNIQUEID")) {
                        s = c->uniqueid;
                } else if (!strcmp(var, "HANGUPCAUSE")) {
                        snprintf(workspace, workspacelen, "%d", c->hangupcause);
                        s = workspace;
                }
        }
        if (s == &not_found) { /* look for more */
                if (!strcmp(var, "EPOCH")) {
                        snprintf(workspace, workspacelen, "%u",(int)time(NULL));
                        s = workspace;
                } else if (!strcmp(var, "SYSTEMNAME")) {
                        s = ast_config_AST_SYSTEM_NAME;
                }
        }
        /* if not found, look into chanvars or global vars */
        for (i = 0; s == &not_found && i < (sizeof(places) / sizeof(places[0])); i++) {
                struct ast_var_t *variables;
                if (!places[i])
                        continue;
                if (places[i] == &globals)
                        ast_mutex_lock(&globalslock);
                AST_LIST_TRAVERSE(places[i], variables, entries) {
                        if (strcasecmp(ast_var_name(variables), var)==0) {
                                s = ast_var_value(variables);
                                break;
                        }
                }
                if (places[i] == &globals)
                        ast_mutex_unlock(&globalslock);
        }
        if (s == &not_found || s == NULL)
                *ret = NULL;
        else {
                if (s != workspace)
                        ast_copy_string(workspace, s, workspacelen);
                *ret = workspace;
                if (need_substring)
                        *ret = substring(*ret, offset, length, workspace, workspacelen);
        }
}

/*! \brief CLI function to show installed custom functions
    \addtogroup CLI_functions
 */
static int handle_show_functions(int fd, int argc, char *argv[])
{
        struct ast_custom_function *acf;
        int count_acf = 0;
        int like = 0;

        if (argc == 4 && (!strcmp(argv[2], "like")) ) {
                like = 1;
        } else if (argc != 2) {
                return RESULT_SHOWUSAGE;
        }

        ast_cli(fd, "%s Custom Functions:\n--------------------------------------------------------------------------------\n", like ? "Matching" : "Installed");

        AST_LIST_LOCK(&acf_root);
        AST_LIST_TRAVERSE(&acf_root, acf, acflist) {
                if (!like || strstr(acf->name, argv[3])) {
                        count_acf++;
                        ast_cli(fd, "%-20.20s  %-35.35s  %s\n", acf->name, acf->syntax, acf->synopsis);
                }
        }
        AST_LIST_UNLOCK(&acf_root);

        ast_cli(fd, "%d %scustom functions installed.\n", count_acf, like ? "matching " : "");

        return RESULT_SUCCESS;
}

static int handle_show_function(int fd, int argc, char *argv[])
{
        struct ast_custom_function *acf;
        /* Maximum number of characters added by terminal coloring is 22 */
        char infotitle[64 + AST_MAX_APP + 22], syntitle[40], destitle[40];
        char info[64 + AST_MAX_APP], *synopsis = NULL, *description = NULL;
        char stxtitle[40], *syntax = NULL;
        int synopsis_size, description_size, syntax_size;

        if (argc < 3)
                return RESULT_SHOWUSAGE;

        if (!(acf = ast_custom_function_find(argv[2]))) {
                ast_cli(fd, "No function by that name registered.\n");
                return RESULT_FAILURE;

        }

        if (acf->synopsis)
                synopsis_size = strlen(acf->synopsis) + 23;
        else
                synopsis_size = strlen("Not available") + 23;
        synopsis = alloca(synopsis_size);

        if (acf->desc)
                description_size = strlen(acf->desc) + 23;
        else
                description_size = strlen("Not available") + 23;
        description = alloca(description_size);

        if (acf->syntax)
                syntax_size = strlen(acf->syntax) + 23;
        else
                syntax_size = strlen("Not available") + 23;
        syntax = alloca(syntax_size);

        snprintf(info, 64 + AST_MAX_APP, "\n  -= Info about function '%s' =- \n\n", acf->name);
        term_color(infotitle, info, COLOR_MAGENTA, 0, 64 + AST_MAX_APP + 22);
        term_color(stxtitle, "[Syntax]\n", COLOR_MAGENTA, 0, 40);
        term_color(syntitle, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
        term_color(destitle, "[Description]\n", COLOR_MAGENTA, 0, 40);
        term_color(syntax,
                   acf->syntax ? acf->syntax : "Not available",
                   COLOR_CYAN, 0, syntax_size);
        term_color(synopsis,
                   acf->synopsis ? acf->synopsis : "Not available",
                   COLOR_CYAN, 0, synopsis_size);
        term_color(description,
                   acf->desc ? acf->desc : "Not available",
                   COLOR_CYAN, 0, description_size);

        ast_cli(fd,"%s%s%s\n\n%s%s\n\n%s%s\n", infotitle, stxtitle, syntax, syntitle, synopsis, destitle, description);

        return RESULT_SUCCESS;
}

static char *complete_show_function(const char *line, const char *word, int pos, int state)
{
        struct ast_custom_function *acf;
        char *ret = NULL;
        int which = 0;
        int wordlen = strlen(word);

        /* case-insensitive for convenience in this 'complete' function */
        AST_LIST_LOCK(&acf_root);
        AST_LIST_TRAVERSE(&acf_root, acf, acflist) {
                if (!strncasecmp(word, acf->name, wordlen) && ++which > state) {
                        ret = strdup(acf->name);
                        break;
                }
        }
        AST_LIST_UNLOCK(&acf_root);

        return ret;
}

struct ast_custom_function *ast_custom_function_find(const char *name)
{
        struct ast_custom_function *acf = NULL;

        AST_LIST_LOCK(&acf_root);
        AST_LIST_TRAVERSE(&acf_root, acf, acflist) {
                if (!strcmp(name, acf->name))
                        break;
        }
        AST_LIST_UNLOCK(&acf_root);

        return acf;
}

int ast_custom_function_unregister(struct ast_custom_function *acf)
{
        struct ast_custom_function *cur;

        if (!acf)
                return -1;

        AST_LIST_LOCK(&acf_root);
        AST_LIST_TRAVERSE_SAFE_BEGIN(&acf_root, cur, acflist) {
                if (cur == acf) {
                        AST_LIST_REMOVE_CURRENT(&acf_root, acflist);
                        if (option_verbose > 1)
                                ast_verbose(VERBOSE_PREFIX_2 "Unregistered custom function %s\n", acf->name);
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END
        AST_LIST_UNLOCK(&acf_root);

        return acf ? 0 : -1;
}

int ast_custom_function_register(struct ast_custom_function *acf)
{
        struct ast_custom_function *cur;

        if (!acf)
                return -1;

        AST_LIST_LOCK(&acf_root);

        if (ast_custom_function_find(acf->name)) {
                ast_log(LOG_ERROR, "Function %s already registered.\n", acf->name);
                AST_LIST_UNLOCK(&acf_root);
                return -1;
        }

        /* Store in alphabetical order */
        AST_LIST_TRAVERSE_SAFE_BEGIN(&acf_root, cur, acflist) {
                if (strcasecmp(acf->name, cur->name) < 0) {
                        AST_LIST_INSERT_BEFORE_CURRENT(&acf_root, acf, acflist);
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END
        if (!cur)
                AST_LIST_INSERT_TAIL(&acf_root, acf, acflist);

        AST_LIST_UNLOCK(&acf_root);

        if (option_verbose > 1)
                ast_verbose(VERBOSE_PREFIX_2 "Registered custom function %s\n", acf->name);

        return 0;
}

/*! \brief return a pointer to the arguments of the function,
 * and terminates the function name with '\\0'
 */
static char *func_args(char *function)
{
        char *args = strchr(function, '(');

        if (!args)
                ast_log(LOG_WARNING, "Function doesn't contain parentheses.  Assuming null argument.\n");
        else {
                char *p;
                *args++ = '\0';
                if ((p = strrchr(args, ')')) )
                        *p = '\0';
                else
                        ast_log(LOG_WARNING, "Can't find trailing parenthesis?\n");
        }
        return args;
}

int ast_func_read(struct ast_channel *chan, char *function, char *workspace, size_t len)
{
        char *args = func_args(function);
        struct ast_custom_function *acfptr = ast_custom_function_find(function);

        if (acfptr == NULL)
                ast_log(LOG_ERROR, "Function %s not registered\n", function);
        else if (!acfptr->read)
                ast_log(LOG_ERROR, "Function %s cannot be read\n", function);
        else
                return acfptr->read(chan, function, args, workspace, len);
        return -1;
}

int ast_func_write(struct ast_channel *chan, char *function, const char *value)
{
        char *args = func_args(function);
        struct ast_custom_function *acfptr = ast_custom_function_find(function);

        if (acfptr == NULL)
                ast_log(LOG_ERROR, "Function %s not registered\n", function);
        else if (!acfptr->write)
                ast_log(LOG_ERROR, "Function %s cannot be written to\n", function);
        else
                return acfptr->write(chan, function, args, value);

        return -1;
}

static void pbx_substitute_variables_helper_full(struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int count)
{
        /* Substitutes variables into cp2, based on string cp1, and assuming cp2 to be
           zero-filled */
        char *cp4;
        const char *tmp, *whereweare;
        int length, offset, offset2, isfunction;
        char *workspace = NULL;
        char *ltmp = NULL, *var = NULL;
        char *nextvar, *nextexp, *nextthing;
        char *vars, *vare;
        int pos, brackets, needsub, len;

        whereweare=tmp=cp1;
        while (!ast_strlen_zero(whereweare) && count) {
                /* Assume we're copying the whole remaining string */
                pos = strlen(whereweare);
                nextvar = NULL;
                nextexp = NULL;
                nextthing = strchr(whereweare, '$');
                if (nextthing) {
                        switch(nextthing[1]) {
                        case '{':
                                nextvar = nextthing;
                                pos = nextvar - whereweare;
                                break;
                        case '[':
                                nextexp = nextthing;
                                pos = nextexp - whereweare;
                                break;
                        }
                }

                if (pos) {
                        /* Can't copy more than 'count' bytes */
                        if (pos > count)
                                pos = count;

                        /* Copy that many bytes */
                        memcpy(cp2, whereweare, pos);

                        count -= pos;
                        cp2 += pos;
                        whereweare += pos;
                }

                if (nextvar) {
                        /* We have a variable.  Find the start and end, and determine
                           if we are going to have to recursively call ourselves on the
                           contents */
                        vars = vare = nextvar + 2;
                        brackets = 1;
                        needsub = 0;

                        /* Find the end of it */
                        while (brackets && *vare) {
                                if ((vare[0] == '$') && (vare[1] == '{')) {
                                        needsub++;
                                } else if (vare[0] == '{') {
                                        brackets++;
                                } else if (vare[0] == '}') {
                                        brackets--;
                                } else if ((vare[0] == '$') && (vare[1] == '['))
                                        needsub++;
                                vare++;
                        }
                        if (brackets)
                                ast_log(LOG_NOTICE, "Error in extension logic (missing '}')\n");
                        len = vare - vars - 1;

                        /* Skip totally over variable string */
                        whereweare += (len + 3);

                        if (!var)
                                var = alloca(VAR_BUF_SIZE);

                        /* Store variable name (and truncate) */
                        ast_copy_string(var, vars, len + 1);

                        /* Substitute if necessary */
                        if (needsub) {
                                if (!ltmp)
                                        ltmp = alloca(VAR_BUF_SIZE);

                                memset(ltmp, 0, VAR_BUF_SIZE);
                                pbx_substitute_variables_helper_full(c, headp, var, ltmp, VAR_BUF_SIZE - 1);
                                vars = ltmp;
                        } else {
                                vars = var;
                        }

                        if (!workspace)
                                workspace = alloca(VAR_BUF_SIZE);

                        workspace[0] = '\0';

                        parse_variable_name(vars, &offset, &offset2, &isfunction);
                        if (isfunction) {
                                /* Evaluate function */
                                cp4 = ast_func_read(c, vars, workspace, VAR_BUF_SIZE) ? NULL : workspace;

                                ast_log(LOG_DEBUG, "Function result is '%s'\n", cp4 ? cp4 : "(null)");
                        } else {
                                /* Retrieve variable value */
                                pbx_retrieve_variable(c, vars, &cp4, workspace, VAR_BUF_SIZE, headp);
                        }
                        if (cp4) {
                                cp4 = substring(cp4, offset, offset2, workspace, VAR_BUF_SIZE);

                                length = strlen(cp4);
                                if (length > count)
                                        length = count;
                                memcpy(cp2, cp4, length);
                                count -= length;
                                cp2 += length;
                        }
                } else if (nextexp) {
                        /* We have an expression.  Find the start and end, and determine
                           if we are going to have to recursively call ourselves on the
                           contents */
                        vars = vare = nextexp + 2;
                        brackets = 1;
                        needsub = 0;

                        /* Find the end of it */
                        while(brackets && *vare) {
                                if ((vare[0] == '$') && (vare[1] == '[')) {
                                        needsub++;
                                        brackets++;
                                        vare++;
                                } else if (vare[0] == '[') {
                                        brackets++;
                                } else if (vare[0] == ']') {
                                        brackets--;
                                } else if ((vare[0] == '$') && (vare[1] == '{')) {
                                        needsub++;
                                        vare++;
                                }
                                vare++;
                        }
                        if (brackets)
                                ast_log(LOG_NOTICE, "Error in extension logic (missing ']')\n");
                        len = vare - vars - 1;

                        /* Skip totally over expression */
                        whereweare += (len + 3);

                        if (!var)
                                var = alloca(VAR_BUF_SIZE);

                        /* Store variable name (and truncate) */
                        ast_copy_string(var, vars, len + 1);

                        /* Substitute if necessary */
                        if (needsub) {
                                if (!ltmp)
                                        ltmp = alloca(VAR_BUF_SIZE);

                                memset(ltmp, 0, VAR_BUF_SIZE);
                                pbx_substitute_variables_helper_full(c, headp, var, ltmp, VAR_BUF_SIZE - 1);
                                vars = ltmp;
                        } else {
                                vars = var;
                        }

                        length = ast_expr(vars, cp2, count);

                        if (length) {
                                ast_log(LOG_DEBUG, "Expression result is '%s'\n", cp2);
                                count -= length;
                                cp2 += length;
                        }
                } else
                        break;
        }
}

void pbx_substitute_variables_helper(struct ast_channel *c, const char *cp1, char *cp2, int count)
{
        pbx_substitute_variables_helper_full(c, (c) ? &c->varshead : NULL, cp1, cp2, count);
}

void pbx_substitute_variables_varshead(struct varshead *headp, const char *cp1, char *cp2, int count)
{
        pbx_substitute_variables_helper_full(NULL, headp, cp1, cp2, count);
}

static void pbx_substitute_variables(char *passdata, int datalen, struct ast_channel *c, struct ast_exten *e)
{
        memset(passdata, 0, datalen);

        /* No variables or expressions in e->data, so why scan it? */
        if (!strchr(e->data, '$') && !strstr(e->data,"${") && !strstr(e->data,"$[") && !strstr(e->data,"$(")) {
                ast_copy_string(passdata, e->data, datalen);
                return;
        }

        pbx_substitute_variables_helper(c, e->data, passdata, datalen - 1);
}

/*! \brief The return value depends on the action:
 *
 * E_MATCH, E_CANMATCH, E_MATCHMORE require a real match,
 *      and return 0 on failure, -1 on match;
 * E_FINDLABEL maps the label to a priority, and returns
 *      the priority on success, ... XXX
 * E_SPAWN, spawn an application,
 *      and return 0 on success, -1 on failure.
 */
static int pbx_extension_helper(struct ast_channel *c, struct ast_context *con,
        const char *context, const char *exten, int priority,
        const char *label, const char *callerid, enum ext_match_t action)
{
        struct ast_exten *e;
        struct ast_app *app;
        int res;
        struct pbx_find_info q = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
        char passdata[EXT_DATA_SIZE];

        int matching_action = (action == E_MATCH || action == E_CANMATCH || action == E_MATCHMORE);

        ast_mutex_lock(&conlock);
        e = pbx_find_extension(c, con, &q, context, exten, priority, label, callerid, action);
        if (e) {
                if (matching_action) {
                        ast_mutex_unlock(&conlock);
                        return -1;      /* success, we found it */
                } else if (action == E_FINDLABEL) { /* map the label to a priority */
                        res = e->priority;
                        ast_mutex_unlock(&conlock);
                        return res;     /* the priority we were looking for */
                } else {        /* spawn */
                        app = pbx_findapp(e->app);
                        ast_mutex_unlock(&conlock);
                        if (!app) {
                                ast_log(LOG_WARNING, "No application '%s' for extension (%s, %s, %d)\n", e->app, context, exten, priority);
                                return -1;
                        }
                        if (c->context != context)
                                ast_copy_string(c->context, context, sizeof(c->context));
                        if (c->exten != exten)
                                ast_copy_string(c->exten, exten, sizeof(c->exten));
                        c->priority = priority;
                        pbx_substitute_variables(passdata, sizeof(passdata), c, e);
                        if (option_debug) {
                                char atmp[80];
                                char atmp2[EXT_DATA_SIZE+100];
                                ast_log(LOG_DEBUG, "Launching '%s'\n", app->name);
                                snprintf(atmp, sizeof(atmp), "STACK-%s-%s-%d", context, exten, priority);
                                snprintf(atmp2, sizeof(atmp2), "%s(\"%s\", \"%s\") %s",
                                        app->name, c->name, passdata, "in new stack");
                                pbx_builtin_setvar_helper(c, atmp, atmp2);
                        }
                        if (option_verbose > 2) {
                                char tmp[80], tmp2[80], tmp3[EXT_DATA_SIZE];
                                ast_verbose( VERBOSE_PREFIX_3 "Executing [%s@%s:%d] %s(\"%s\", \"%s\") %s\n",
                                        exten, context, priority,
                                        term_color(tmp, app->name, COLOR_BRCYAN, 0, sizeof(tmp)),
                                        term_color(tmp2, c->name, COLOR_BRMAGENTA, 0, sizeof(tmp2)),
                                        term_color(tmp3, passdata, COLOR_BRMAGENTA, 0, sizeof(tmp3)),
                                        "in new stack");
                        }
                        manager_event(EVENT_FLAG_CALL, "Newexten",
                                        "Channel: %s\r\n"
                                        "Context: %s\r\n"
                                        "Extension: %s\r\n"
                                        "Priority: %d\r\n"
                                        "Application: %s\r\n"
                                        "AppData: %s\r\n"
                                        "Uniqueid: %s\r\n",
                                        c->name, c->context, c->exten, c->priority, app->name, passdata, c->uniqueid);
                        return pbx_exec(c, app, passdata);      /* 0 on success, -1 on failure */
                }
        } else if (q.swo) {     /* not found here, but in another switch */
                ast_mutex_unlock(&conlock);
                if (matching_action)
                        return -1;
                else {
                        if (!q.swo->exec) {
                                ast_log(LOG_WARNING, "No execution engine for switch %s\n", q.swo->name);
                                res = -1;
                        }
                        return q.swo->exec(c, q.foundcontext ? q.foundcontext : context, exten, priority, callerid, q.data);
                }
        } else {        /* not found anywhere, see what happened */
                ast_mutex_unlock(&conlock);
                switch (q.status) {
                case STATUS_NO_CONTEXT:
                        if (!matching_action)
                                ast_log(LOG_NOTICE, "Cannot find extension context '%s'\n", context);
                        break;
                case STATUS_NO_EXTENSION:
                        if (!matching_action)
                                ast_log(LOG_NOTICE, "Cannot find extension '%s' in context '%s'\n", exten, context);
                        break;
                case STATUS_NO_PRIORITY:
                        if (!matching_action)
                                ast_log(LOG_NOTICE, "No such priority %d in extension '%s' in context '%s'\n", priority, exten, context);
                        break;
                case STATUS_NO_LABEL:
                        if (context)
                                ast_log(LOG_NOTICE, "No such label '%s' in extension '%s' in context '%s'\n", label, exten, context);
                        break;
                default:
                        ast_log(LOG_DEBUG, "Shouldn't happen!\n");
                }

                return (matching_action) ? 0 : -1;
        }
}

/*! \brief  ast_hint_extension: Find hint for given extension in context */
static struct ast_exten *ast_hint_extension(struct ast_channel *c, const char *context, const char *exten)
{
        struct ast_exten *e;
        struct pbx_find_info q = { .stacklen = 0 }; /* the rest is set in pbx_find_context */

        ast_mutex_lock(&conlock);
        e = pbx_find_extension(c, NULL, &q, context, exten, PRIORITY_HINT, NULL, "", E_MATCH);
        ast_mutex_unlock(&conlock);

        return e;
}

/*! \brief  ast_extensions_state2: Check state of extension by using hints */
static int ast_extension_state2(struct ast_exten *e)
{
        char hint[AST_MAX_EXTENSION];
        char *cur, *rest;
        int allunavailable = 1, allbusy = 1, allfree = 1, allonhold = 1;
        int busy = 0, inuse = 0, ring = 0;

        if (!e)
                return -1;

        ast_copy_string(hint, ast_get_extension_app(e), sizeof(hint));

        rest = hint;    /* One or more devices separated with a & character */
        while ( (cur = strsep(&rest, "&")) ) {
                int res = ast_device_state(cur);
                switch (res) {
                case AST_DEVICE_NOT_INUSE:
                        allunavailable = 0;
                        allbusy = 0;
                        allonhold = 0;
                        break;
                case AST_DEVICE_INUSE:
                        inuse = 1;
                        allunavailable = 0;
                        allfree = 0;
                        allonhold = 0;
                        break;
                case AST_DEVICE_RINGING:
                        ring = 1;
                        allunavailable = 0;
                        allfree = 0;
                        allonhold = 0;
                        break;
                case AST_DEVICE_RINGINUSE:
                        inuse = 1;
                        ring = 1;
                        allunavailable = 0;
                        allfree = 0;
                        allonhold = 0;
                        break;
                case AST_DEVICE_ONHOLD:
                        allunavailable = 0;
                        allfree = 0;
                        break;
                case AST_DEVICE_BUSY:
                        allunavailable = 0;
                        allfree = 0;
                        allonhold = 0;
                        busy = 1;
                        break;
                case AST_DEVICE_UNAVAILABLE:
                case AST_DEVICE_INVALID:
                        allbusy = 0;
                        allfree = 0;
                        allonhold = 0;
                        break;
                default:
                        allunavailable = 0;
                        allbusy = 0;
                        allfree = 0;
                        allonhold = 0;
                }
        }

        if (!inuse && ring)
                return AST_EXTENSION_RINGING;
        if (inuse && ring)
                return (AST_EXTENSION_INUSE | AST_EXTENSION_RINGING);
        if (inuse)
                return AST_EXTENSION_INUSE;
        if (allfree)
                return AST_EXTENSION_NOT_INUSE;
        if (allonhold)
                return AST_EXTENSION_ONHOLD;
        if (allbusy)
                return AST_EXTENSION_BUSY;
        if (allunavailable)
                return AST_EXTENSION_UNAVAILABLE;
        if (busy)
                return AST_EXTENSION_INUSE;

        return AST_EXTENSION_NOT_INUSE;
}

/*! \brief  ast_extension_state2str: Return extension_state as string */
const char *ast_extension_state2str(int extension_state)
{
        int i;

        for (i = 0; (i < (sizeof(extension_states) / sizeof(extension_states[0]))); i++) {
                if (extension_states[i].extension_state == extension_state)
                        return extension_states[i].text;
        }
        return "Unknown";
}

/*! \brief  ast_extension_state: Check extension state for an extension by using hint */
int ast_extension_state(struct ast_channel *c, const char *context, const char *exten)
{
        struct ast_exten *e;

        e = ast_hint_extension(c, context, exten);      /* Do we have a hint for this extension ? */
        if (!e)
                return -1;                              /* No hint, return -1 */

        return ast_extension_state2(e);                 /* Check all devices in the hint */
}

void ast_hint_state_changed(const char *device)
{
        struct ast_hint *hint;

        AST_LIST_LOCK(&hints);

        AST_LIST_TRAVERSE(&hints, hint, list) {
                struct ast_state_cb *cblist;
                char buf[AST_MAX_EXTENSION];
                char *parse = buf;
                char *cur;
                int state;

                ast_copy_string(buf, ast_get_extension_app(hint->exten), sizeof(buf));
                while ( (cur = strsep(&parse, "&")) ) {
                        if (!strcasecmp(cur, device))
                                break;
                }
                if (!cur)
                        continue;

                /* Get device state for this hint */
                state = ast_extension_state2(hint->exten);

                if ((state == -1) || (state == hint->laststate))
                        continue;

                /* Device state changed since last check - notify the watchers */

                /* For general callbacks */
                for (cblist = statecbs; cblist; cblist = cblist->next)
                        cblist->callback(hint->exten->parent->name, hint->exten->exten, state, cblist->data);

                /* For extension callbacks */
                for (cblist = hint->callbacks; cblist; cblist = cblist->next)
                        cblist->callback(hint->exten->parent->name, hint->exten->exten, state, cblist->data);

                hint->laststate = state;        /* record we saw the change */
        }

        AST_LIST_UNLOCK(&hints);
}

/*! \brief  ast_extension_state_add: Add watcher for extension states */
int ast_extension_state_add(const char *context, const char *exten,
                            ast_state_cb_type callback, void *data)
{
        struct ast_hint *hint;
        struct ast_state_cb *cblist;
        struct ast_exten *e;

        /* If there's no context and extension:  add callback to statecbs list */
        if (!context && !exten) {
                AST_LIST_LOCK(&hints);

                for (cblist = statecbs; cblist; cblist = cblist->next) {
                        if (cblist->callback == callback) {
                                cblist->data = data;
                                AST_LIST_UNLOCK(&hints);
                                return 0;
                        }
                }

                /* Now insert the callback */
                if (!(cblist = ast_calloc(1, sizeof(*cblist)))) {
                        AST_LIST_UNLOCK(&hints);
                        return -1;
                }
                cblist->id = 0;
                cblist->callback = callback;
                cblist->data = data;

                cblist->next = statecbs;
                statecbs = cblist;

                AST_LIST_UNLOCK(&hints);
                return 0;
        }

        if (!context || !exten)
                return -1;

        /* This callback type is for only one hint, so get the hint */
        e = ast_hint_extension(NULL, context, exten);
        if (!e) {
                return -1;
        }

        /* Find the hint in the list of hints */
        AST_LIST_LOCK(&hints);

        AST_LIST_TRAVERSE(&hints, hint, list) {
                if (hint->exten == e)
                        break;
        }

        if (!hint) {
                /* We have no hint, sorry */
                AST_LIST_UNLOCK(&hints);
                return -1;
        }

        /* Now insert the callback in the callback list  */
        if (!(cblist = ast_calloc(1, sizeof(*cblist)))) {
                AST_LIST_UNLOCK(&hints);
                return -1;
        }
        cblist->id = stateid++;         /* Unique ID for this callback */
        cblist->callback = callback;    /* Pointer to callback routine */
        cblist->data = data;            /* Data for the callback */

        cblist->next = hint->callbacks;
        hint->callbacks = cblist;

        AST_LIST_UNLOCK(&hints);
        return cblist->id;
}

/*! \brief  ast_extension_state_del: Remove a watcher from the callback list */
int ast_extension_state_del(int id, ast_state_cb_type callback)
{
        struct ast_state_cb **p_cur = NULL;     /* address of pointer to us */
        int ret = -1;

        if (!id && !callback)
                return -1;

        AST_LIST_LOCK(&hints);

        if (!id) {      /* id == 0 is a callback without extension */
                for (p_cur = &statecbs; *p_cur; p_cur = &(*p_cur)->next) {
                        if ((*p_cur)->callback == callback)
                                break;
                }
        } else { /* callback with extension, find the callback based on ID */
                struct ast_hint *hint;
                AST_LIST_TRAVERSE(&hints, hint, list) {
                        for (p_cur = &hint->callbacks; *p_cur; p_cur = &(*p_cur)->next) {
                                if ((*p_cur)->id == id)
                                        break;
                        }
                        if (*p_cur)     /* found in the inner loop */
                                break;
                }
        }
        if (p_cur && *p_cur) {
                struct ast_state_cb *cur = *p_cur;
                *p_cur = cur->next;
                free(cur);
                ret = 0;
        }
        AST_LIST_UNLOCK(&hints);
        return ret;
}

/*! \brief  ast_add_hint: Add hint to hint list, check initial extension state */
static int ast_add_hint(struct ast_exten *e)
{
        struct ast_hint *hint;

        if (!e)
                return -1;

        AST_LIST_LOCK(&hints);

        /* Search if hint exists, do nothing */
        AST_LIST_TRAVERSE(&hints, hint, list) {
                if (hint->exten == e) {
                        AST_LIST_UNLOCK(&hints);
                        if (option_debug > 1)
                                ast_log(LOG_DEBUG, "HINTS: Not re-adding existing hint %s: %s\n", ast_get_extension_name(e), ast_get_extension_app(e));
                        return -1;
                }
        }

        if (option_debug > 1)
                ast_log(LOG_DEBUG, "HINTS: Adding hint %s: %s\n", ast_get_extension_name(e), ast_get_extension_app(e));

        if (!(hint = ast_calloc(1, sizeof(*hint)))) {
                AST_LIST_UNLOCK(&hints);
                return -1;
        }
        /* Initialize and insert new item at the top */
        hint->exten = e;
        hint->laststate = ast_extension_state2(e);
        AST_LIST_INSERT_HEAD(&hints, hint, list);

        AST_LIST_UNLOCK(&hints);
        return 0;
}

/*! \brief  ast_change_hint: Change hint for an extension */
static int ast_change_hint(struct ast_exten *oe, struct ast_exten *ne)
{
        struct ast_hint *hint;
        int res = -1;

        AST_LIST_LOCK(&hints);
        AST_LIST_TRAVERSE(&hints, hint, list) {
                if (hint->exten == oe) {
                        hint->exten = ne;
                        res = 0;
                        break;
                }
        }
        AST_LIST_UNLOCK(&hints);

        return res;
}

/*! \brief  ast_remove_hint: Remove hint from extension */
static int ast_remove_hint(struct ast_exten *e)
{
        /* Cleanup the Notifys if hint is removed */
        struct ast_hint *hint;
        struct ast_state_cb *cblist, *cbprev;
        int res = -1;

        if (!e)
                return -1;

        AST_LIST_LOCK(&hints);
        AST_LIST_TRAVERSE_SAFE_BEGIN(&hints, hint, list) {
                if (hint->exten == e) {
                        cbprev = NULL;
                        cblist = hint->callbacks;
                        while (cblist) {
                                /* Notify with -1 and remove all callbacks */
                                cbprev = cblist;
                                cblist = cblist->next;
                                cbprev->callback(hint->exten->parent->name, hint->exten->exten, AST_EXTENSION_DEACTIVATED, cbprev->data);
                                free(cbprev);
                        }
                        hint->callbacks = NULL;
                        AST_LIST_REMOVE_CURRENT(&hints, list);
                        free(hint);
                        res = 0;
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END
        AST_LIST_UNLOCK(&hints);

        return res;
}


/*! \brief  ast_get_hint: Get hint for channel */
int ast_get_hint(char *hint, int hintsize, char *name, int namesize, struct ast_channel *c, const char *context, const char *exten)
{
        struct ast_exten *e = ast_hint_extension(c, context, exten);

        if (e) {
                if (hint)
                        ast_copy_string(hint, ast_get_extension_app(e), hintsize);
                if (name) {
                        const char *tmp = ast_get_extension_app_data(e);
                        if (tmp)
                                ast_copy_string(name, tmp, namesize);
                }
                return -1;
        }
        return 0;
}

int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
{
        return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCH);
}

int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
{
        return pbx_extension_helper(c, NULL, context, exten, 0, label, callerid, E_FINDLABEL);
}

int ast_findlabel_extension2(struct ast_channel *c, struct ast_context *con, const char *exten, const char *label, const char *callerid)
{
        return pbx_extension_helper(c, con, NULL, exten, 0, label, callerid, E_FINDLABEL);
}

int ast_canmatch_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
{
        return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_CANMATCH);
}

int ast_matchmore_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
{
        return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCHMORE);
}

int ast_spawn_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
{
        return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_SPAWN);
}

/* helper function to set extension and priority */
static void set_ext_pri(struct ast_channel *c, const char *exten, int pri)
{
        ast_copy_string(c->exten, exten, sizeof(c->exten));
        c->priority = pri;
}

/*!
 * \brief collect digits from the channel into the buffer,
 * return -1 on error, 0 on timeout or done.
 */
static int collect_digits(struct ast_channel *c, int waittime, char *buf, int buflen, int pos)
{
        int digit;

        buf[pos] = '\0';        /* make sure it is properly terminated */
        while (ast_matchmore_extension(c, c->context, buf, 1, c->cid.cid_num)) {
                /* As long as we're willing to wait, and as long as it's not defined,
                   keep reading digits until we can't possibly get a right answer anymore.  */
                digit = ast_waitfordigit(c, waittime * 1000);
                if (c->_softhangup == AST_SOFTHANGUP_ASYNCGOTO) {
                        c->_softhangup = 0;
                } else {
                        if (!digit)     /* No entry */
                                break;
                        if (digit < 0)  /* Error, maybe a  hangup */
                                return -1;
                        if (pos < buflen - 1) { /* XXX maybe error otherwise ? */
                                buf[pos++] = digit;
                                buf[pos] = '\0';
                        }
                        waittime = c->pbx->dtimeout;
                }
        }
        return 0;
}

static int __ast_pbx_run(struct ast_channel *c)
{
        int found = 0;  /* set if we find at least one match */
        int res = 0;
        int autoloopflag;
        int error = 0;          /* set an error conditions */

        /* A little initial setup here */
        if (c->pbx) {
                ast_log(LOG_WARNING, "%s already has PBX structure??\n", c->name);
                /* XXX and now what ? */
                free(c->pbx);
        }
        if (!(c->pbx = ast_calloc(1, sizeof(*c->pbx))))
                return -1;
        if (c->amaflags) {
                if (!c->cdr) {
                        c->cdr = ast_cdr_alloc();
                        if (!c->cdr) {
                                ast_log(LOG_WARNING, "Unable to create Call Detail Record\n");
                                free(c->pbx);
                                return -1;
                        }
                        ast_cdr_init(c->cdr, c);
                }
        }
        /* Set reasonable defaults */
        c->pbx->rtimeout = 10;
        c->pbx->dtimeout = 5;

        autoloopflag = ast_test_flag(c, AST_FLAG_IN_AUTOLOOP);  /* save value to restore at the end */
        ast_set_flag(c, AST_FLAG_IN_AUTOLOOP);

        /* Start by trying whatever the channel is set to */
        if (!ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
                /* If not successful fall back to 's' */
                if (option_verbose > 1)
                        ast_verbose( VERBOSE_PREFIX_2 "Starting %s at %s,%s,%d failed so falling back to exten 's'\n", c->name, c->context, c->exten, c->priority);
                /* XXX the original code used the existing priority in the call to
                 * ast_exists_extension(), and reset it to 1 afterwards.
                 * I believe the correct thing is to set it to 1 immediately.
                 */
                set_ext_pri(c, "s", 1);
                if (!ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
                        /* JK02: And finally back to default if everything else failed */
                        if (option_verbose > 1)
                                ast_verbose( VERBOSE_PREFIX_2 "Starting %s at %s,%s,%d still failed so falling back to context 'default'\n", c->name, c->context, c->exten, c->priority);
                        ast_copy_string(c->context, "default", sizeof(c->context));
                }
        }
        if (c->cdr && ast_tvzero(c->cdr->start))
                ast_cdr_start(c->cdr);
        for (;;) {
                char dst_exten[256];    /* buffer to accumulate digits */
                int pos = 0;            /* XXX should check bounds */
                int digit = 0;

                /* loop on priorities in this context/exten */
                while (ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
                        found = 1;
                        if ((res = ast_spawn_extension(c, c->context, c->exten, c->priority, c->cid.cid_num))) {
                                /* Something bad happened, or a hangup has been requested. */
                                if (strchr("0123456789ABCDEF*#", res)) {
                                        ast_log(LOG_DEBUG, "Oooh, got something to jump out with ('%c')!\n", res);
                                        pos = 0;
                                        dst_exten[pos++] = digit = res;
                                        dst_exten[pos] = '\0';
                                        break;
                                }
                                if (res == AST_PBX_KEEPALIVE) {
                                        if (option_debug)
                                                ast_log(LOG_DEBUG, "Spawn extension (%s,%s,%d) exited KEEPALIVE on '%s'\n", c->context, c->exten, c->priority, c->name);
                                        else if (option_verbose > 1)
                                                ast_verbose( VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited KEEPALIVE on '%s'\n", c->context, c->exten, c->priority, c->name);
                                        error = 1;
                                        break;
                                }
                                if (option_debug)
                                        ast_log(LOG_DEBUG, "Spawn extension (%s,%s,%d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
                                else if (option_verbose > 1)
                                        ast_verbose( VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
                                if (c->_softhangup == AST_SOFTHANGUP_ASYNCGOTO) {
                                        c->_softhangup =0;
                                } else if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT) {
                                        /* atimeout, nothing bad */
                                } else {
                                        if (c->cdr)
                                                ast_cdr_update(c);
                                        error = 1;
                                        break;
                                }
                        }
                        if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT && ast_exists_extension(c,c->context,"T",1,c->cid.cid_num)) {
                                set_ext_pri(c, "T", 0); /* 0 will become 1 with the c->priority++; at the end */
                                /* If the AbsoluteTimeout is not reset to 0, we'll get an infinite loop */
                                c->whentohangup = 0;
                                c->_softhangup &= ~AST_SOFTHANGUP_TIMEOUT;
                        } else if (c->_softhangup) {
                                ast_log(LOG_DEBUG, "Extension %s, priority %d returned normally even though call was hung up\n",
                                        c->exten, c->priority);
                                error = 1;
                                break;
                        }
                        c->priority++;
                } /* end while  - from here on we can use 'break' to go out */
                if (error)
                        break;

                /* XXX we get here on non-existing extension or a keypress or hangup ? */

                if (!ast_exists_extension(c, c->context, c->exten, 1, c->cid.cid_num)) {
                        /* If there is no match at priority 1, it is not a valid extension anymore.
                         * Try to continue at "i", 1 or exit if the latter does not exist.
                         */
                        if (ast_exists_extension(c, c->context, "i", 1, c->cid.cid_num)) {
                                if (option_verbose > 2)
                                        ast_verbose(VERBOSE_PREFIX_3 "Sent into invalid extension '%s' in context '%s' on %s\n", c->exten, c->context, c->name);
                                pbx_builtin_setvar_helper(c, "INVALID_EXTEN", c->exten);
                                set_ext_pri(c, "i", 1);
                        } else {
                                ast_log(LOG_WARNING, "Channel '%s' sent into invalid extension '%s' in context '%s', but no invalid handler\n",
                                        c->name, c->exten, c->context);
                                error = 1; /* we know what to do with it */
                                break;
                        }
                } else if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT) {
                        /* If we get this far with AST_SOFTHANGUP_TIMEOUT, then we know that the "T" extension is next. */
                        c->_softhangup = 0;
                } else {        /* keypress received, get more digits for a full extension */
                        int waittime = 0;
                        if (digit)
                                waittime = c->pbx->dtimeout;
                        else if (!autofallthrough)
                                waittime = c->pbx->rtimeout;
                        if (!waittime) {
                                const char *status = pbx_builtin_getvar_helper(c, "DIALSTATUS");
                                if (!status)
                                        status = "UNKNOWN";
                                if (option_verbose > 2)
                                        ast_verbose(VERBOSE_PREFIX_2 "Auto fallthrough, channel '%s' status is '%s'\n", c->name, status);
                                if (!strcasecmp(status, "CONGESTION"))
                                        res = pbx_builtin_congestion(c, "10");
                                else if (!strcasecmp(status, "CHANUNAVAIL"))
                                        res = pbx_builtin_congestion(c, "10");
                                else if (!strcasecmp(status, "BUSY"))
                                        res = pbx_builtin_busy(c, "10");
                                error = 1; /* XXX disable message */
                                break;  /* exit from the 'for' loop */
                        }

                        if (collect_digits(c, waittime, dst_exten, sizeof(dst_exten), pos))
                                break;
                        if (ast_exists_extension(c, c->context, dst_exten, 1, c->cid.cid_num)) /* Prepare the next cycle */
                                set_ext_pri(c, dst_exten, 1);
                        else {
                                /* No such extension */
                                if (!ast_strlen_zero(dst_exten)) {
                                        /* An invalid extension */
                                        if (ast_exists_extension(c, c->context, "i", 1, c->cid.cid_num)) {
                                                if (option_verbose > 2)
                                                        ast_verbose( VERBOSE_PREFIX_3 "Invalid extension '%s' in context '%s' on %s\n", dst_exten, c->context, c->name);
                                                pbx_builtin_setvar_helper(c, "INVALID_EXTEN", dst_exten);
                                                set_ext_pri(c, "i", 1);
                                        } else {
                                                ast_log(LOG_WARNING, "Invalid extension '%s', but no rule 'i' in context '%s'\n", dst_exten, c->context);
                                                found = 1; /* XXX disable message */
                                                break;
                                        }
                                } else {
                                        /* A simple timeout */
                                        if (ast_exists_extension(c, c->context, "t", 1, c->cid.cid_num)) {
                                                if (option_verbose > 2)
                                                        ast_verbose( VERBOSE_PREFIX_3 "Timeout on %s\n", c->name);
                                                set_ext_pri(c, "t", 1);
                                        } else {
                                                ast_log(LOG_WARNING, "Timeout, but no rule 't' in context '%s'\n", c->context);
                                                found = 1; /* XXX disable message */
                                                break;
                                        }
                                }
                        }
                        if (c->cdr) {
                                if (option_verbose > 2)
                                        ast_verbose(VERBOSE_PREFIX_2 "CDR updated on %s\n",c->name);
                                ast_cdr_update(c);
                        }
                }
        }
        if (!found && !error)
                ast_log(LOG_WARNING, "Don't know what to do with '%s'\n", c->name);
        if ((res != AST_PBX_KEEPALIVE) && ast_exists_extension(c, c->context, "h", 1, c->cid.cid_num)) {
                if (c->cdr && ast_opt_end_cdr_before_h_exten)
                        ast_cdr_end(c->cdr);
                set_ext_pri(c, "h", 1);
                while(ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
                        if ((res = ast_spawn_extension(c, c->context, c->exten, c->priority, c->cid.cid_num))) {
                                /* Something bad happened, or a hangup has been requested. */
                                if (option_debug)
                                        ast_log(LOG_DEBUG, "Spawn extension (%s,%s,%d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
                                else if (option_verbose > 1)
                                        ast_verbose( VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
                                break;
                        }
                        c->priority++;
                }
        }
        ast_set2_flag(c, autoloopflag, AST_FLAG_IN_AUTOLOOP);

        pbx_destroy(c->pbx);
        c->pbx = NULL;
        if (res != AST_PBX_KEEPALIVE)
                ast_hangup(c);
        return 0;
}

/* Returns 0 on success, non-zero if call limit was reached */
static int increase_call_count(const struct ast_channel *c)
{
        int failed = 0;
        double curloadavg;
        ast_mutex_lock(&maxcalllock);
        if (option_maxcalls) {
                if (countcalls >= option_maxcalls) {
                        ast_log(LOG_NOTICE, "Maximum call limit of %d calls exceeded by '%s'!\n", option_maxcalls, c->name);
                        failed = -1;
                }
        }
        if (option_maxload) {
                getloadavg(&curloadavg, 1);
                if (curloadavg >= option_maxload) {
                        ast_log(LOG_NOTICE, "Maximum loadavg limit of %f load exceeded by '%s' (currently %f)!\n", option_maxload, c->name, curloadavg);
                        failed = -1;
                }
        }
        if (!failed)
                countcalls++;
        ast_mutex_unlock(&maxcalllock);

        return failed;
}

static void decrease_call_count(void)
{
        ast_mutex_lock(&maxcalllock);
        if (countcalls > 0)
                countcalls--;
        ast_mutex_unlock(&maxcalllock);
}

static void destroy_exten(struct ast_exten *e)
{
        if (e->priority == PRIORITY_HINT)
                ast_remove_hint(e);

        if (e->datad)
                e->datad(e->data);
        free(e);
}

static void *pbx_thread(void *data)
{
        /* Oh joyeous kernel, we're a new thread, with nothing to do but
           answer this channel and get it going.
        */
        /* NOTE:
           The launcher of this function _MUST_ increment 'countcalls'
           before invoking the function; it will be decremented when the
           PBX has finished running on the channel
         */
        struct ast_channel *c = data;

        __ast_pbx_run(c);
        decrease_call_count();

        pthread_exit(NULL);

        return NULL;
}

enum ast_pbx_result ast_pbx_start(struct ast_channel *c)
{
        pthread_t t;
        pthread_attr_t attr;

        if (!c) {
                ast_log(LOG_WARNING, "Asked to start thread on NULL channel?\n");
                return AST_PBX_FAILED;
        }

        if (increase_call_count(c))
                return AST_PBX_CALL_LIMIT;

        /* Start a new thread, and get something handling this channel. */
        pthread_attr_init(&attr);
        pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
        if (ast_pthread_create(&t, &attr, pbx_thread, c)) {
                ast_log(LOG_WARNING, "Failed to create new channel thread\n");
                return AST_PBX_FAILED;
        }

        return AST_PBX_SUCCESS;
}

enum ast_pbx_result ast_pbx_run(struct ast_channel *c)
{
        enum ast_pbx_result res = AST_PBX_SUCCESS;

        if (increase_call_count(c))
                return AST_PBX_CALL_LIMIT;

        res = __ast_pbx_run(c);
        decrease_call_count();

        return res;
}

int ast_active_calls(void)
{
        return countcalls;
}

int pbx_set_autofallthrough(int newval)
{
        int oldval = autofallthrough;
        autofallthrough = newval;
        return oldval;
}

/* lookup for a context with a given name,
 * return with conlock held if found, NULL if not found
 */
static struct ast_context *find_context_locked(const char *context)
{
        struct ast_context *c = NULL;

        ast_lock_contexts();
        while ( (c = ast_walk_contexts(c)) ) {
                if (!strcmp(ast_get_context_name(c), context))
                        return c;
        }
        ast_unlock_contexts();

        return NULL;
}

/*
 * This function locks contexts list by &conlist, search for the right context
 * structure, leave context list locked and call ast_context_remove_include2
 * which removes include, unlock contexts list and return ...
 */
int ast_context_remove_include(const char *context, const char *include, const char *registrar)
{
        int ret = -1;
        struct ast_context *c = find_context_locked(context);

        if (c) {
                /* found, remove include from this context ... */
                ret = ast_context_remove_include2(c, include, registrar);
                ast_unlock_contexts();
        }
        return ret;
}

/*
 * When we call this function, &conlock lock must be locked, because when
 * we giving *con argument, some process can remove/change this context
 * and after that there can be segfault.
 *
 * This function locks given context, removes include, unlock context and
 * return.
 */
int ast_context_remove_include2(struct ast_context *con, const char *include, const char *registrar)
{
        struct ast_include *i, *pi = NULL;
        int ret = -1;

        ast_mutex_lock(&con->lock);

        /* find our include */
        for (i = con->includes; i; pi = i, i = i->next) {
                if (!strcmp(i->name, include) &&
                                (!registrar || !strcmp(i->registrar, registrar))) {
                        /* remove from list */
                        if (pi)
                                pi->next = i->next;
                        else
                                con->includes = i->next;
                        /* free include and return */
                        free(i);
                        ret = 0;
                        break;
                }
        }

        ast_mutex_unlock(&con->lock);
        return ret;
}

/*!
 * \note This function locks contexts list by &conlist, search for the rigt context
 * structure, leave context list locked and call ast_context_remove_switch2
 * which removes switch, unlock contexts list and return ...
 */
int ast_context_remove_switch(const char *context, const char *sw, const char *data, const char *registrar)
{
        int ret = -1; /* default error return */
        struct ast_context *c = find_context_locked(context);

        if (c) {
                /* remove switch from this context ... */
                ret = ast_context_remove_switch2(c, sw, data, registrar);
                ast_unlock_contexts();
        }
        return ret;
}

/*!
 * \brief This function locks given context, removes switch, unlock context and
 * return.
 * \note When we call this function, &conlock lock must be locked, because when
 * we giving *con argument, some process can remove/change this context
 * and after that there can be segfault.
 *
 */
int ast_context_remove_switch2(struct ast_context *con, const char *sw, const char *data, const char *registrar)
{
        struct ast_sw *i;
        int ret = -1;

        ast_mutex_lock(&con->lock);

        /* walk switches */
        AST_LIST_TRAVERSE_SAFE_BEGIN(&con->alts, i, list) {
                if (!strcmp(i->name, sw) && !strcmp(i->data, data) &&
                        (!registrar || !strcmp(i->registrar, registrar))) {
                        /* found, remove from list */
                        AST_LIST_REMOVE_CURRENT(&con->alts, list);
                        free(i); /* free switch and return */
                        ret = 0;
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END

        ast_mutex_unlock(&con->lock);

        return ret;
}

/*
 * \note This functions lock contexts list, search for the right context,
 * call ast_context_remove_extension2, unlock contexts list and return.
 * In this function we are using
 */
int ast_context_remove_extension(const char *context, const char *extension, int priority, const char *registrar)
{
        int ret = -1; /* default error return */
        struct ast_context *c = find_context_locked(context);

        if (c) { /* ... remove extension ... */
                ret = ast_context_remove_extension2(c, extension, priority, registrar);
                ast_unlock_contexts();
        }
        return ret;
}

/*!
 * \brief This functionc locks given context, search for the right extension and
 * fires out all peer in this extensions with given priority. If priority
 * is set to 0, all peers are removed. After that, unlock context and
 * return.
 * \note When do you want to call this function, make sure that &conlock is locked,
 * because some process can handle with your *con context before you lock
 * it.
 *
 */
int ast_context_remove_extension2(struct ast_context *con, const char *extension, int priority, const char *registrar)
{
        struct ast_exten *exten, *prev_exten = NULL;
        struct ast_exten *peer;

        ast_mutex_lock(&con->lock);

        /* scan the extension list to find matching extension-registrar */
        for (exten = con->root; exten; prev_exten = exten, exten = exten->next) {
                if (!strcmp(exten->exten, extension) &&
                        (!registrar || !strcmp(exten->registrar, registrar)))
                        break;
        }
        if (!exten) {
                /* we can't find right extension */
                ast_mutex_unlock(&con->lock);
                return -1;
        }

        /* should we free all peers in this extension? (priority == 0)? */
        if (priority == 0) {
                /* remove this extension from context list */
                if (prev_exten)
                        prev_exten->next = exten->next;
                else
                        con->root = exten->next;

                /* fire out all peers */
                while ( (peer = exten) ) {
                        exten = peer->peer; /* prepare for next entry */
                        destroy_exten(peer);
                }
        } else {
                /* scan the priority list to remove extension with exten->priority == priority */
                struct ast_exten *previous_peer = NULL;

                for (peer = exten; peer; previous_peer = peer, peer = peer->peer) {
                        if (peer->priority == priority &&
                                        (!registrar || !strcmp(peer->registrar, registrar) ))
                                break; /* found our priority */
                }
                if (!peer) { /* not found */
                        ast_mutex_unlock(&con->lock);
                        return -1;
                }
                /* we are first priority extension? */
                if (!previous_peer) {
                        /*
                         * We are first in the priority chain, so must update the extension chain.
                         * The next node is either the next priority or the next extension
                         */
                        struct ast_exten *next_node = peer->peer ? peer->peer : peer->next;

                        if (!prev_exten)        /* change the root... */
                                con->root = next_node;
                        else
                                prev_exten->next = next_node; /* unlink */
                        if (peer->peer) /* XXX update the new head of the pri list */
                                peer->peer->next = peer->next;
                } else { /* easy, we are not first priority in extension */
                        previous_peer->peer = peer->peer;
                }

                /* now, free whole priority extension */
                destroy_exten(peer);
                /* XXX should we return -1 ? */
        }
        ast_mutex_unlock(&con->lock);
        return 0;
}


/*! \brief Dynamically register a new dial plan application */
int ast_register_application(const char *app, int (*execute)(struct ast_channel *, void *), const char *synopsis, const char *description)
{
        struct ast_app *tmp, *cur = NULL;
        char tmps[80];
        int length;

        AST_LIST_LOCK(&apps);
        AST_LIST_TRAVERSE(&apps, tmp, list) {
                if (!strcasecmp(app, tmp->name)) {
                        ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
                        AST_LIST_UNLOCK(&apps);
                        return -1;
                }
        }

        length = sizeof(*tmp) + strlen(app) + 1;

        if (!(tmp = ast_calloc(1, length))) {
                AST_LIST_UNLOCK(&apps);
                return -1;
        }

        strcpy(tmp->name, app);
        tmp->execute = execute;
        tmp->synopsis = synopsis;
        tmp->description = description;

        /* Store in alphabetical order */
        AST_LIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
                if (strcasecmp(tmp->name, cur->name) < 0) {
                        AST_LIST_INSERT_BEFORE_CURRENT(&apps, tmp, list);
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END
        if (!cur)
                AST_LIST_INSERT_TAIL(&apps, tmp, list);

        if (option_verbose > 1)
                ast_verbose( VERBOSE_PREFIX_2 "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));

        AST_LIST_UNLOCK(&apps);

        return 0;
}

/*
 * Append to the list. We don't have a tail pointer because we need
 * to scan the list anyways to check for duplicates during insertion.
 */
int ast_register_switch(struct ast_switch *sw)
{
        struct ast_switch *tmp;

        AST_LIST_LOCK(&switches);
        AST_LIST_TRAVERSE(&switches, tmp, list) {
                if (!strcasecmp(tmp->name, sw->name)) {
                        AST_LIST_UNLOCK(&switches);
                        ast_log(LOG_WARNING, "Switch '%s' already found\n", sw->name);
                        return -1;
                }
        }
        AST_LIST_INSERT_TAIL(&switches, sw, list);
        AST_LIST_UNLOCK(&switches);

        return 0;
}

void ast_unregister_switch(struct ast_switch *sw)
{
        AST_LIST_LOCK(&switches);
        AST_LIST_REMOVE(&switches, sw, list);
        AST_LIST_UNLOCK(&switches);
}

/*
 * Help for CLI commands ...
 */
static char show_application_help[] =
"Usage: show application <application> [<application> [<application> [...]]]\n"
"       Describes a particular application.\n";

static char show_functions_help[] =
"Usage: show functions [like <text>]\n"
"       List builtin functions, optionally only those matching a given string\n";

static char show_function_help[] =
"Usage: show function <function>\n"
"       Describe a particular dialplan function.\n";

static char show_applications_help[] =
"Usage: show applications [{like|describing} <text>]\n"
"       List applications which are currently available.\n"
"       If 'like', <text> will be a substring of the app name\n"
"       If 'describing', <text> will be a substring of the description\n";

static char show_dialplan_help[] =
"Usage: show dialplan [exten@][context]\n"
"       Show dialplan\n";

static char show_switches_help[] =
"Usage: show switches\n"
"       Show registered switches\n";

static char show_hints_help[] =
"Usage: show hints\n"
"       Show registered hints\n";

static char show_globals_help[] =
"Usage: show globals\n"
"       Show current global dialplan variables and their values\n";

static char set_global_help[] =
"Usage: set global <name> <value>\n"
"       Set global dialplan variable <name> to <value>\n";


/*
 * IMPLEMENTATION OF CLI FUNCTIONS IS IN THE SAME ORDER AS COMMANDS HELPS
 *
 */

/*
 * \brief 'show application' CLI command implementation functions ...
 */

/*
 * There is a possibility to show informations about more than one
 * application at one time. You can type 'show application Dial Echo' and
 * you will see informations about these two applications ...
 */
static char *complete_show_application(const char *line, const char *word, int pos, int state)
{
        struct ast_app *a;
        char *ret = NULL;
        int which = 0;
        int wordlen = strlen(word);

        /* return the n-th [partial] matching entry */
        AST_LIST_LOCK(&apps);
        AST_LIST_TRAVERSE(&apps, a, list) {
                if (!strncasecmp(word, a->name, wordlen) && ++which > state) {
                        ret = strdup(a->name);
                        break;
                }
        }
        AST_LIST_UNLOCK(&apps);

        return ret;
}

static int handle_show_application(int fd, int argc, char *argv[])
{
        struct ast_app *a;
        int app, no_registered_app = 1;

        if (argc < 3)
                return RESULT_SHOWUSAGE;

        /* ... go through all applications ... */
        AST_LIST_LOCK(&apps);
        AST_LIST_TRAVERSE(&apps, a, list) {
                /* ... compare this application name with all arguments given
                 * to 'show application' command ... */
                for (app = 2; app < argc; app++) {
                        if (!strcasecmp(a->name, argv[app])) {
                                /* Maximum number of characters added by terminal coloring is 22 */
                                char infotitle[64 + AST_MAX_APP + 22], syntitle[40], destitle[40];
                                char info[64 + AST_MAX_APP], *synopsis = NULL, *description = NULL;
                                int synopsis_size, description_size;

                                no_registered_app = 0;

                                if (a->synopsis)
                                        synopsis_size = strlen(a->synopsis) + 23;
                                else
                                        synopsis_size = strlen("Not available") + 23;
                                synopsis = alloca(synopsis_size);

                                if (a->description)
                                        description_size = strlen(a->description) + 23;
                                else
                                        description_size = strlen("Not available") + 23;
                                description = alloca(description_size);

                                if (synopsis && description) {
                                        snprintf(info, 64 + AST_MAX_APP, "\n  -= Info about application '%s' =- \n\n", a->name);
                                        term_color(infotitle, info, COLOR_MAGENTA, 0, 64 + AST_MAX_APP + 22);
                                        term_color(syntitle, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
                                        term_color(destitle, "[Description]\n", COLOR_MAGENTA, 0, 40);
                                        term_color(synopsis,
                                                                        a->synopsis ? a->synopsis : "Not available",
                                                                        COLOR_CYAN, 0, synopsis_size);
                                        term_color(description,
                                                                        a->description ? a->description : "Not available",
                                                                        COLOR_CYAN, 0, description_size);

                                        ast_cli(fd,"%s%s%s\n\n%s%s\n", infotitle, syntitle, synopsis, destitle, description);
                                } else {
                                        /* ... one of our applications, show info ...*/
                                        ast_cli(fd,"\n  -= Info about application '%s' =- \n\n"
                                                "[Synopsis]\n  %s\n\n"
                                                "[Description]\n%s\n",
                                                a->name,
                                                a->synopsis ? a->synopsis : "Not available",
                                                a->description ? a->description : "Not available");
                                }
                        }
                }
        }
        AST_LIST_UNLOCK(&apps);

        /* we found at least one app? no? */
        if (no_registered_app) {
                ast_cli(fd, "Your application(s) is (are) not registered\n");
                return RESULT_FAILURE;
        }

        return RESULT_SUCCESS;
}

/*! \brief  handle_show_hints: CLI support for listing registred dial plan hints */
static int handle_show_hints(int fd, int argc, char *argv[])
{
        struct ast_hint *hint;
        int num = 0;
        int watchers;
        struct ast_state_cb *watcher;

        if (AST_LIST_EMPTY(&hints)) {
                ast_cli(fd, "There are no registered dialplan hints\n");
                return RESULT_SUCCESS;
        }
        /* ... we have hints ... */
        ast_cli(fd, "\n    -= Registered Asterisk Dial Plan Hints =-\n");
        AST_LIST_LOCK(&hints);
        AST_LIST_TRAVERSE(&hints, hint, list) {
                watchers = 0;
                for (watcher = hint->callbacks; watcher; watcher = watcher->next)
                        watchers++;
                ast_cli(fd, "   %20s@%-20.20s: %-20.20s  State:%-15.15s Watchers %2d\n",
                        ast_get_extension_name(hint->exten),
                        ast_get_context_name(ast_get_extension_context(hint->exten)),
                        ast_get_extension_app(hint->exten),
                        ast_extension_state2str(hint->laststate), watchers);
                num++;
        }
        ast_cli(fd, "----------------\n");
        ast_cli(fd, "- %d hints registered\n", num);
        AST_LIST_UNLOCK(&hints);
        return RESULT_SUCCESS;
}

/*! \brief  handle_show_switches: CLI support for listing registred dial plan switches */
static int handle_show_switches(int fd, int argc, char *argv[])
{
        struct ast_switch *sw;

        AST_LIST_LOCK(&switches);

        if (AST_LIST_EMPTY(&switches)) {
                AST_LIST_UNLOCK(&switches);
                ast_cli(fd, "There are no registered alternative switches\n");
                return RESULT_SUCCESS;
        }

        ast_cli(fd, "\n    -= Registered Asterisk Alternative Switches =-\n");
        AST_LIST_TRAVERSE(&switches, sw, list)
                ast_cli(fd, "%s: %s\n", sw->name, sw->description);

        AST_LIST_UNLOCK(&switches);

        return RESULT_SUCCESS;
}

/*
 * 'show applications' CLI command implementation functions ...
 */
static int handle_show_applications(int fd, int argc, char *argv[])
{
        struct ast_app *a;
        int like = 0, describing = 0;
        int total_match = 0;    /* Number of matches in like clause */
        int total_apps = 0;     /* Number of apps registered */

        AST_LIST_LOCK(&apps);

        if (AST_LIST_EMPTY(&apps)) {
                ast_cli(fd, "There are no registered applications\n");
                AST_LIST_UNLOCK(&apps);
                return -1;
        }

        /* show applications like <keyword> */
        if ((argc == 4) && (!strcmp(argv[2], "like"))) {
                like = 1;
        } else if ((argc > 3) && (!strcmp(argv[2], "describing"))) {
                describing = 1;
        }

        /* show applications describing <keyword1> [<keyword2>] [...] */
        if ((!like) && (!describing)) {
                ast_cli(fd, "    -= Registered Asterisk Applications =-\n");
        } else {
                ast_cli(fd, "    -= Matching Asterisk Applications =-\n");
        }

        AST_LIST_TRAVERSE(&apps, a, list) {
                int printapp = 0;
                total_apps++;
                if (like) {
                        if (strcasestr(a->name, argv[3])) {
                                printapp = 1;
                                total_match++;
                        }
                } else if (describing) {
                        if (a->description) {
                                /* Match all words on command line */
                                int i;
                                printapp = 1;
                                for (i = 3; i < argc; i++) {
                                        if (!strcasestr(a->description, argv[i])) {
                                                printapp = 0;
                                        } else {
                                                total_match++;
                                        }
                                }
                        }
                } else {
                        printapp = 1;
                }

                if (printapp) {
                        ast_cli(fd,"  %20s: %s\n", a->name, a->synopsis ? a->synopsis : "<Synopsis not available>");
                }
        }
        if ((!like) && (!describing)) {
                ast_cli(fd, "    -= %d Applications Registered =-\n",total_apps);
        } else {
                ast_cli(fd, "    -= %d Applications Matching =-\n",total_match);
        }

        AST_LIST_UNLOCK(&apps);

        return RESULT_SUCCESS;
}

static char *complete_show_applications(const char *line, const char *word, int pos, int state)
{
        static char* choices[] = { "like", "describing", NULL };

        return (pos != 2) ? NULL : ast_cli_complete(word, choices, state);
}

/*
 * 'show dialplan' CLI command implementation functions ...
 */
static char *complete_show_dialplan_context(const char *line, const char *word, int pos,
        int state)
{
        struct ast_context *c = NULL;
        char *ret = NULL;
        int which = 0;
        int wordlen;

        /* we are do completion of [exten@]context on second position only */
        if (pos != 2)
                return NULL;

        ast_lock_contexts();

        wordlen = strlen(word);

        /* walk through all contexts and return the n-th match */
        while ( (c = ast_walk_contexts(c)) ) {
                if (!strncasecmp(word, ast_get_context_name(c), wordlen) && ++which > state) {
                        ret = ast_strdup(ast_get_context_name(c));
                        break;
                }
        }

        ast_unlock_contexts();

        return ret;
}

struct dialplan_counters {
        int total_context;
        int total_exten;
        int total_prio;
        int context_existence;
        int extension_existence;
};

/*! \brief helper function to print an extension */
static void print_ext(struct ast_exten *e, char * buf, int buflen)
{
        int prio = ast_get_extension_priority(e);
        if (prio == PRIORITY_HINT) {
                snprintf(buf, buflen, "hint: %s",
                        ast_get_extension_app(e));
        } else {
                snprintf(buf, buflen, "%d. %s(%s)",
                        prio, ast_get_extension_app(e),
                        (char *)ast_get_extension_app_data(e));
        }
}

/* XXX not verified */
static int show_dialplan_helper(int fd, const char *context, const char *exten, struct dialplan_counters *dpc, struct ast_include *rinclude, int includecount, const char *includes[])
{
        struct ast_context *c = NULL;
        int res = 0, old_total_exten = dpc->total_exten;

        ast_lock_contexts();

        /* walk all contexts ... */
        while ( (c = ast_walk_contexts(c)) ) {
                struct ast_exten *e;
                struct ast_include *i;
                struct ast_ignorepat *ip;
                char buf[256], buf2[256];
                int context_info_printed = 0;

                if (context && strcmp(ast_get_context_name(c), context))
                        continue;       /* skip this one, name doesn't match */

                dpc->context_existence = 1;

                ast_lock_context(c);

                /* are we looking for exten too? if yes, we print context
                 * only if we find our extension.
                 * Otherwise print context even if empty ?
                 * XXX i am not sure how the rinclude is handled.
                 * I think it ought to go inside.
                 */
                if (!exten) {
                        dpc->total_context++;
                        ast_cli(fd, "[ Context '%s' created by '%s' ]\n",
                                ast_get_context_name(c), ast_get_context_registrar(c));
                        context_info_printed = 1;
                }

                /* walk extensions ... */
                e = NULL;
                while ( (e = ast_walk_context_extensions(c, e)) ) {
                        struct ast_exten *p;

                        if (exten && !ast_extension_match(ast_get_extension_name(e), exten))
                                continue;       /* skip, extension match failed */

                        dpc->extension_existence = 1;

                        /* may we print context info? */
                        if (!context_info_printed) {
                                dpc->total_context++;
                                if (rinclude) { /* TODO Print more info about rinclude */
                                        ast_cli(fd, "[ Included context '%s' created by '%s' ]\n",
                                                ast_get_context_name(c), ast_get_context_registrar(c));
                                } else {
                                        ast_cli(fd, "[ Context '%s' created by '%s' ]\n",
                                                ast_get_context_name(c), ast_get_context_registrar(c));
                                }
                                context_info_printed = 1;
                        }
                        dpc->total_prio++;

                        /* write extension name and first peer */
                        snprintf(buf, sizeof(buf), "'%s' =>", ast_get_extension_name(e));

                        print_ext(e, buf2, sizeof(buf2));

                        ast_cli(fd, "  %-17s %-45s [%s]\n", buf, buf2,
                                ast_get_extension_registrar(e));

                        dpc->total_exten++;
                        /* walk next extension peers */
                        p = e;  /* skip the first one, we already got it */
                        while ( (p = ast_walk_extension_priorities(e, p)) ) {
                                const char *el = ast_get_extension_label(p);
                                dpc->total_prio++;
                                if (el)
                                        snprintf(buf, sizeof(buf), "   [%s]", el);
                                else
                                        buf[0] = '\0';
                                print_ext(p, buf2, sizeof(buf2));

                                ast_cli(fd,"  %-17s %-45s [%s]\n", buf, buf2,
                                        ast_get_extension_registrar(p));
                        }
                }

                /* walk included and write info ... */
                i = NULL;
                while ( (i = ast_walk_context_includes(c, i)) ) {
                        snprintf(buf, sizeof(buf), "'%s'", ast_get_include_name(i));
                        if (exten) {
                                /* Check all includes for the requested extension */
                                if (includecount >= AST_PBX_MAX_STACK) {
                                        ast_log(LOG_NOTICE, "Maximum include depth exceeded!\n");
                                } else {
                                        int dupe=0;
                                        int x;
                                        for (x=0;x<includecount;x++) {
                                                if (!strcasecmp(includes[x], ast_get_include_name(i))) {
                                                        dupe++;
                                                        break;
                                                }
                                        }
                                        if (!dupe) {
                                                includes[includecount] = ast_get_include_name(i);
                                                show_dialplan_helper(fd, ast_get_include_name(i), exten, dpc, i, includecount + 1, includes);
                                        } else {
                                                ast_log(LOG_WARNING, "Avoiding circular include of %s within %s\n", ast_get_include_name(i), context);
                                        }
                                }
                        } else {
                                ast_cli(fd, "  Include =>        %-45s [%s]\n",
                                        buf, ast_get_include_registrar(i));
                        }
                }

                /* walk ignore patterns and write info ... */
                ip = NULL;
                while ( (ip = ast_walk_context_ignorepats(c, ip)) ) {
                        const char *ipname = ast_get_ignorepat_name(ip);
                        char ignorepat[AST_MAX_EXTENSION];
                        snprintf(buf, sizeof(buf), "'%s'", ipname);
                        snprintf(ignorepat, sizeof(ignorepat), "_%s.", ipname);
                        if (!exten || ast_extension_match(ignorepat, exten)) {
                                ast_cli(fd, "  Ignore pattern => %-45s [%s]\n",
                                        buf, ast_get_ignorepat_registrar(ip));
                        }
                }
                if (!rinclude) {
                        struct ast_sw *sw = NULL;
                        while ( (sw = ast_walk_context_switches(c, sw)) ) {
                                snprintf(buf, sizeof(buf), "'%s/%s'",
                                        ast_get_switch_name(sw),
                                        ast_get_switch_data(sw));
                                ast_cli(fd, "  Alt. Switch =>    %-45s [%s]\n",
                                        buf, ast_get_switch_registrar(sw));
                        }
                }

                ast_unlock_context(c);

                /* if we print something in context, make an empty line */
                if (context_info_printed)
                        ast_cli(fd, "\r\n");
        }
        ast_unlock_contexts();

        return (dpc->total_exten == old_total_exten) ? -1 : res;
}

static int handle_show_dialplan(int fd, int argc, char *argv[])
{
        char *exten = NULL, *context = NULL;
        /* Variables used for different counters */
        struct dialplan_counters counters;

        const char *incstack[AST_PBX_MAX_STACK];
        memset(&counters, 0, sizeof(counters));

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

        /* we obtain [exten@]context? if yes, split them ... */
        if (argc == 3) {
                if (strchr(argv[2], '@')) {     /* split into exten & context */
                        context = ast_strdupa(argv[2]);
                        exten = strsep(&context, "@");
                        /* change empty strings to NULL */
                        if (ast_strlen_zero(exten))
                                exten = NULL;
                } else { /* no '@' char, only context given */
                        context = argv[2];
                }
                if (ast_strlen_zero(context))
                        context = NULL;
        }
        /* else Show complete dial plan, context and exten are NULL */
        show_dialplan_helper(fd, context, exten, &counters, NULL, 0, incstack);

        /* check for input failure and throw some error messages */
        if (context && !counters.context_existence) {
                ast_cli(fd, "There is no existence of '%s' context\n", context);
                return RESULT_FAILURE;
        }

        if (exten && !counters.extension_existence) {
                if (context)
                        ast_cli(fd, "There is no existence of %s@%s extension\n",
                                exten, context);
                else
                        ast_cli(fd,
                                "There is no existence of '%s' extension in all contexts\n",
                                exten);
                return RESULT_FAILURE;
        }

        ast_cli(fd,"-= %d %s (%d %s) in %d %s. =-\n",
                                counters.total_exten, counters.total_exten == 1 ? "extension" : "extensions",
                                counters.total_prio, counters.total_prio == 1 ? "priority" : "priorities",
                                counters.total_context, counters.total_context == 1 ? "context" : "contexts");

        /* everything ok */
        return RESULT_SUCCESS;
}

/*! \brief CLI support for listing global variables in a parseable way */
static int handle_show_globals(int fd, int argc, char *argv[])
{
        int i = 0;
        struct ast_var_t *newvariable;

        ast_mutex_lock(&globalslock);
        AST_LIST_TRAVERSE (&globals, newvariable, entries) {
                i++;
                ast_cli(fd, "   %s=%s\n", ast_var_name(newvariable), ast_var_value(newvariable));
        }
        ast_mutex_unlock(&globalslock);
        ast_cli(fd, "\n    -- %d variables\n", i);

        return RESULT_SUCCESS;
}

/*! \brief  CLI support for setting global variables */
static int handle_set_global(int fd, int argc, char *argv[])
{
        if (argc != 4)
                return RESULT_SHOWUSAGE;

        pbx_builtin_setvar_helper(NULL, argv[2], argv[3]);
        ast_cli(fd, "\n    -- Global variable %s set to %s\n", argv[2], argv[3]);

        return RESULT_SUCCESS;
}



/*
 * CLI entries for upper commands ...
 */
static struct ast_cli_entry pbx_cli[] = {
        { { "show", "applications", NULL }, handle_show_applications,
          "Shows registered dialplan applications", show_applications_help, complete_show_applications },
        { { "show", "functions", NULL }, handle_show_functions,
          "Shows registered dialplan functions", show_functions_help },
        { { "show" , "function", NULL }, handle_show_function,
          "Describe a specific dialplan function", show_function_help, complete_show_function },
        { { "show", "application", NULL }, handle_show_application,
          "Describe a specific dialplan application", show_application_help, complete_show_application },
        { { "show", "dialplan", NULL }, handle_show_dialplan,
          "Show dialplan", show_dialplan_help, complete_show_dialplan_context },
        { { "show", "switches", NULL }, handle_show_switches,
          "Show alternative switches", show_switches_help },
        { { "show", "hints", NULL }, handle_show_hints,
          "Show dialplan hints", show_hints_help },
        { { "show", "globals", NULL }, handle_show_globals,
          "Show global dialplan variables", show_globals_help },
        { { "set", "global", NULL }, handle_set_global,
          "Set global dialplan variable", set_global_help },
};

int ast_unregister_application(const char *app)
{
        struct ast_app *tmp;

        AST_LIST_LOCK(&apps);
        AST_LIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
                if (!strcasecmp(app, tmp->name)) {
                        AST_LIST_REMOVE_CURRENT(&apps, list);
                        if (option_verbose > 1)
                                ast_verbose( VERBOSE_PREFIX_2 "Unregistered application '%s'\n", tmp->name);
                        free(tmp);
                        break;
                }
        }
        AST_LIST_TRAVERSE_SAFE_END
        AST_LIST_UNLOCK(&apps);

        return tmp ? 0 : -1;
}

struct ast_context *ast_context_create(struct ast_context **extcontexts, const char *name, const char *registrar)
{
        struct ast_context *tmp, **local_contexts;
        int length = sizeof(struct ast_context) + strlen(name) + 1;

        if (!extcontexts) {
                ast_mutex_lock(&conlock);
                local_contexts = &contexts;
        } else
                local_contexts = extcontexts;

        for (tmp = *local_contexts; tmp; tmp = tmp->next) {
                if (!strcasecmp(tmp->name, name)) {
                        ast_log(LOG_WARNING, "Tried to register context '%s', already in use\n", name);
                        if (!extcontexts)
                                ast_mutex_unlock(&conlock);
                        return NULL;
                }
        }
        if ((tmp = ast_calloc(1, length))) {
                ast_mutex_init(&tmp->lock);
                strcpy(tmp->name, name);
                tmp->root = NULL;
                tmp->registrar = registrar;
                tmp->next = *local_contexts;
                tmp->includes = NULL;
                tmp->ignorepats = NULL;
                *local_contexts = tmp;
                if (option_debug)
                        ast_log(LOG_DEBUG, "Registered context '%s'\n", tmp->name);
                else if (option_verbose > 2)
                        ast_verbose( VERBOSE_PREFIX_3 "Registered extension context '%s'\n", tmp->name);
        }

        if (!extcontexts)
                ast_mutex_unlock(&conlock);
        return tmp;
}

void __ast_context_destroy(struct ast_context *con, const char *registrar);

struct store_hint {
        char *context;
        char *exten;
        struct ast_state_cb *callbacks;
        int laststate;
        AST_LIST_ENTRY(store_hint) list;
        char data[1];
};

AST_LIST_HEAD(store_hints, store_hint);

/* XXX this does not check that multiple contexts are merged */
void ast_merge_contexts_and_delete(struct ast_context **extcontexts, const char *registrar)
{
        struct ast_context *tmp, *lasttmp = NULL;
        struct store_hints store = AST_LIST_HEAD_INIT_VALUE;
        struct store_hint *this;
        struct ast_hint *hint;
        struct ast_exten *exten;
        int length;
        struct ast_state_cb *thiscb, *prevcb;

        /* it is very important that this function hold the hint list lock _and_ the conlock
           during its operation; not only do we need to ensure that the list of contexts
           and extensions does not change, but also that no hint callbacks (watchers) are
           added or removed during the merge/delete process

           in addition, the locks _must_ be taken in this order, because there are already
           other code paths that use this order
        */
        ast_mutex_lock(&conlock);
        AST_LIST_LOCK(&hints);

        /* preserve all watchers for hints associated with this registrar */
        AST_LIST_TRAVERSE(&hints, hint, list) {
                if (hint->callbacks && !strcmp(registrar, hint->exten->parent->registrar)) {
                        length = strlen(hint->exten->exten) + strlen(hint->exten->parent->name) + 2 + sizeof(*this);
                        if (!(this = ast_calloc(1, length)))
                                continue;
                        this->callbacks = hint->callbacks;
                        hint->callbacks = NULL;
                        this->laststate = hint->laststate;
                        this->context = this->data;
                        strcpy(this->data, hint->exten->parent->name);
                        this->exten = this->data + strlen(this->context) + 1;
                        strcpy(this->exten, hint->exten->exten);
                        AST_LIST_INSERT_HEAD(&store, this, list);
                }
        }

        tmp = *extcontexts;
        if (registrar) {
                /* XXX remove previous contexts from same registrar */
                ast_log(LOG_DEBUG, "must remove any reg %s\n", registrar);
                __ast_context_destroy(NULL,registrar);
                while (tmp) {
                        lasttmp = tmp;
                        tmp = tmp->next;
                }
        } else {
                /* XXX remove contexts with the same name */
                while (tmp) {
                        ast_log(LOG_WARNING, "must remove %s  reg %s\n", tmp->name, tmp->registrar);
                        __ast_context_destroy(tmp,tmp->registrar);
                        lasttmp = tmp;
                        tmp = tmp->next;
                }
        }
        if (lasttmp) {
                lasttmp->next = contexts;
                contexts = *extcontexts;
                *extcontexts = NULL;
        } else
                ast_log(LOG_WARNING, "Requested contexts didn't get merged\n");

        /* restore the watchers for hints that can be found; notify those that
           cannot be restored
        */
        while ((this = AST_LIST_REMOVE_HEAD(&store, list))) {
                exten = ast_hint_extension(NULL, this->context, this->exten);
                /* Find the hint in the list of hints */
                AST_LIST_TRAVERSE(&hints, hint, list) {
                        if (hint->exten == exten)
                                break;
                }
                if (!exten || !hint) {
                        /* this hint has been removed, notify the watchers */
                        prevcb = NULL;
                        thiscb = this->callbacks;
                        while (thiscb) {
                                prevcb = thiscb;
                                thiscb = thiscb->next;
                                prevcb->callback(this->context, this->exten, AST_EXTENSION_REMOVED, prevcb->data);
                                free(prevcb);
                        }
                } else {
                        thiscb = this->callbacks;
                        while (thiscb->next)
                                thiscb = thiscb->next;
                        thiscb->next = hint->callbacks;
                        hint->callbacks = this->callbacks;
                        hint->laststate = this->laststate;
                }
                free(this);
        }

        AST_LIST_UNLOCK(&hints);
        ast_mutex_unlock(&conlock);

        return;
}

/*
 * errno values
 *  EBUSY  - can't lock
 *  ENOENT - no existence of context
 */
int ast_context_add_include(const char *context, const char *include, const char *registrar)
{
        int ret = -1;
        struct ast_context *c = find_context_locked(context);

        if (c) {
                ret = ast_context_add_include2(c, include, registrar);
                ast_unlock_contexts();
        }
        return ret;
}

/*! \brief Helper for get_range.
 * return the index of the matching entry, starting from 1.
 * If names is not supplied, try numeric values.
 */
static int lookup_name(const char *s, char *const names[], int max)
{
        int i;

        if (names) {
                for (i = 0; names[i]; i++) {
                        if (!strcasecmp(s, names[i]))
                                return i+1;
                }
        } else if (sscanf(s, "%d", &i) == 1 && i >= 1 && i <= max) {
                return i;
        }
        return 0; /* error return */
}

/*! \brief helper function to return a range up to max (7, 12, 31 respectively).
 * names, if supplied, is an array of names that should be mapped to numbers.
 */
static unsigned get_range(char *src, int max, char *const names[], const char *msg)
{
        int s, e; /* start and ending position */
        unsigned int mask = 0;

        /* Check for whole range */
        if (ast_strlen_zero(src) || !strcmp(src, "*")) {
                s = 0;
                e = max - 1;
        } else {
                /* Get start and ending position */
                char *c = strchr(src, '-');
                if (c)
                        *c++ = '\0';
                /* Find the start */
                s = lookup_name(src, names, max);
                if (!s) {
                        ast_log(LOG_WARNING, "Invalid %s '%s', assuming none\n", msg, src);
                        return 0;
                }
                s--;
                if (c) { /* find end of range */
                        e = lookup_name(c, names, max);
                        if (!e) {
                                ast_log(LOG_WARNING, "Invalid end %s '%s', assuming none\n", msg, c);
                                return 0;
                        }
                        e--;
                } else
                        e = s;
        }
        /* Fill the mask. Remember that ranges are cyclic */
        mask = 1 << e;  /* initialize with last element */
        while (s != e) {
                if (s >= max) {
                        s = 0;
                        mask |= (1 << s);
                } else {
                      &n