pbx.h File Reference

Core PBX routines and definitions. More...

#include "asterisk/sched.h"
#include "asterisk/devicestate.h"
#include "asterisk/chanvars.h"
#include "asterisk/hashtab.h"

Include dependency graph for pbx.h:

Go to the source code of this file.

Data Structures
struct	ast_custom_function
	Data structure associated with a custom dialplan function. More...
struct	ast_pbx
struct	ast_pbx_args
	Options for ast_pbx_run(). More...
struct	ast_switch
struct	ast_timing
struct	pbx_find_info
Defines
#define	ast_custom_function_register(acf)   __ast_custom_function_register(acf, ast_module_info->self)
	Register a custom function.
#define	AST_MAX_APP   32
#define	AST_PBX_ERROR   1
#define	AST_PBX_HANGUP   -1
	Special return values from applications to the PBX {.
#define	AST_PBX_KEEP   0
#define	AST_PBX_MAX_STACK   128
#define	AST_PBX_OK   0
#define	AST_PBX_REPLACE   1
#define	PRIORITY_HINT   -1
#define	STATUS_NO_CONTEXT   1
#define	STATUS_NO_EXTENSION   2
#define	STATUS_NO_LABEL   4
#define	STATUS_NO_PRIORITY   3
#define	STATUS_SUCCESS   5
Typedefs
typedef int(*	ast_state_cb_type )(char *context, char *id, enum ast_extension_states state, void *data)
	Typedef for devicestate and hint callbacks.
typedef int(	ast_switch_f )(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)
	All switch functions have the same interface, so define a type for them.
Enumerations
enum	ast_extension_states {   AST_EXTENSION_REMOVED = -2, AST_EXTENSION_DEACTIVATED = -1, AST_EXTENSION_NOT_INUSE = 0, AST_EXTENSION_INUSE = 1 << 0,   AST_EXTENSION_BUSY = 1 << 1, AST_EXTENSION_UNAVAILABLE = 1 << 2, AST_EXTENSION_RINGING = 1 << 3, AST_EXTENSION_ONHOLD = 1 << 4 }
	Extension states. More...
enum	ast_pbx_result { AST_PBX_SUCCESS = 0, AST_PBX_FAILED = -1, AST_PBX_CALL_LIMIT = -2 }
	The result codes when starting the PBX on a channelwith. More...
enum	ext_match_t {   E_MATCHMORE = 0x00, E_CANMATCH = 0x01, E_MATCH = 0x02, E_MATCH_MASK = 0x03,   E_SPAWN = 0x12, E_FINDLABEL = 0x22, E_MATCHMORE = 0x00, E_CANMATCH = 0x01,   E_MATCH = 0x02, E_MATCH_MASK = 0x03, E_SPAWN = 0x12, E_FINDLABEL = 0x22 }
Functions
int	__ast_custom_function_register (struct ast_custom_function *acf, struct ast_module *mod)
	Register a custom function.
int	ast_active_calls (void)
	Retrieve the number of active calls.
int	ast_add_extension (const char *context, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar)
	Add and extension to an extension context.
int	ast_add_extension2 (struct ast_context *con, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar)
	Add an extension to an extension context, this time with an ast_context *.
int	ast_async_goto (struct ast_channel *chan, const char *context, const char *exten, int priority)
int	ast_async_goto_by_name (const char *chan, const char *context, const char *exten, int priority)
int	ast_async_goto_if_exists (struct ast_channel *chan, const char *context, const char *exten, int priority)
int	ast_async_parseable_goto (struct ast_channel *chan, const char *goto_string)
int	ast_build_timing (struct ast_timing *i, const char *info)
int	ast_canmatch_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
	Looks for a valid matching extension.
int	ast_check_timing (const struct ast_timing *i)
int	ast_context_add_ignorepat (const char *context, const char *ignorepat, const char *registrar)
	Add an ignorepat.
int	ast_context_add_ignorepat2 (struct ast_context *con, const char *ignorepat, const char *registrar)
int	ast_context_add_include (const char *context, const char *include, const char *registrar)
	Add a context include.
int	ast_context_add_include2 (struct ast_context *con, const char *include, const char *registrar)
	Add a context include.
int	ast_context_add_switch (const char *context, const char *sw, const char *data, int eval, const char *registrar)
	Add a switch.
int	ast_context_add_switch2 (struct ast_context *con, const char *sw, const char *data, int eval, const char *registrar)
	Adds a switch (first param is a ast_context).
void	ast_context_destroy (struct ast_context *con, const char *registrar)
	Destroy a context (matches the specified context (or ANY context if NULL).
struct ast_context *	ast_context_find (const char *name)
	Find a context.
struct ast_context *	ast_context_find_or_create (struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *name, const char *registrar)
	Register a new context or find an existing one.
int	ast_context_lockmacro (const char *macrocontext)
	locks the macrolock in the given given context
int	ast_context_remove_extension (const char *context, const char *extension, int priority, const char *registrar)
	Simply remove extension from context.
int	ast_context_remove_extension2 (struct ast_context *con, const char *extension, int priority, const char *registrar, int already_locked)
	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.
int	ast_context_remove_extension_callerid (const char *context, const char *extension, int priority, const char *callerid, int matchcid, const char *registrar)
int	ast_context_remove_extension_callerid2 (struct ast_context *con, const char *extension, int priority, const char *callerid, int matchcid, const char *registrar, int already_locked)
int	ast_context_remove_ignorepat (const char *context, const char *ignorepat, const char *registrar)
int	ast_context_remove_ignorepat2 (struct ast_context *con, const char *ignorepat, const char *registrar)
int	ast_context_remove_include (const char *context, const char *include, const char *registrar)
	Remove a context include.
int	ast_context_remove_include2 (struct ast_context *con, const char *include, const char *registrar)
	Removes an include by an ast_context structure.
int	ast_context_remove_switch (const char *context, const char *sw, const char *data, const char *registrar)
	Remove a switch.
int	ast_context_remove_switch2 (struct ast_context *con, const char *sw, const char *data, const char *registrar)
	This function locks given context, removes switch, unlock context and return.
int	ast_context_unlockmacro (const char *macrocontext)
	Unlocks the macrolock in the given context.
int	ast_context_verify_includes (struct ast_context *con)
	Verifies includes in an ast_contect structure.
struct ast_custom_function *	ast_custom_function_find (const char *name)
int	ast_custom_function_unregister (struct ast_custom_function *acf)
	Unregister a custom function.
enum ast_extension_states	ast_devstate_to_extenstate (enum ast_device_state devstate)
	Map devstate to an extension state.
int	ast_exists_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
	Determine whether an extension exists.
int	ast_explicit_goto (struct ast_channel *chan, const char *context, const char *exten, int priority)
int	ast_extension_close (const char *pattern, const char *data, int needmore)
int	ast_extension_cmp (const char *a, const char *b)
	Determine if one extension should match before another.
int	ast_extension_match (const char *pattern, const char *extension)
	Determine if a given extension matches a given pattern (in NXX format).
int	ast_extension_patmatch (const char *pattern, const char *data)
int	ast_extension_state (struct ast_channel *c, const char *context, const char *exten)
	Uses hint and devicestate callback to get the state of an extension.
const char *	ast_extension_state2str (int extension_state)
	Return string representation of the state of an extension.
int	ast_extension_state_add (const char *context, const char *exten, ast_state_cb_type callback, void *data)
	Registers a state change callback.
int	ast_extension_state_del (int id, ast_state_cb_type callback)
	Deletes a registered state change callback by ID.
int	ast_findlabel_extension (struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
	Find the priority of an extension that has the specified label.
int	ast_findlabel_extension2 (struct ast_channel *c, struct ast_context *con, const char *exten, const char *label, const char *callerid)
	Find the priority of an extension that has the specified label.
int	ast_func_read (struct ast_channel *chan, const char *function, char *workspace, size_t len)
	executes a read operation on a function
int	ast_func_write (struct ast_channel *chan, const char *function, const char *value)
	executes a write operation on a function
int	ast_get_hint (char *hint, int maxlen, char *name, int maxnamelen, struct ast_channel *c, const char *context, const char *exten)
	If an extension hint exists, return non-zero.
int	ast_goto_if_exists (struct ast_channel *chan, const char *context, const char *exten, int priority)
int	ast_hashtab_compare_contexts (const void *ah_a, const void *ah_b)
unsigned int	ast_hashtab_hash_contexts (const void *obj)
int	ast_ignore_pattern (const char *context, const char *pattern)
	Checks to see if a number should be ignored.
int	ast_matchmore_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
	Looks to see if adding anything to this extension might match something. (exists ^ canmatch).
void	ast_merge_contexts_and_delete (struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *registrar)
	Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added.
int	ast_parseable_goto (struct ast_channel *chan, const char *goto_string)
int	ast_pbx_outgoing_app (const char *type, int format, void *data, int timeout, const char *app, const char *appdata, int *reason, int sync, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel)
int	ast_pbx_outgoing_exten (const char *type, int format, void *data, int timeout, const char *context, const char *exten, int priority, int *reason, int sync, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel)
enum ast_pbx_result	ast_pbx_run (struct ast_channel *c)
	Execute the PBX in the current thread.
enum ast_pbx_result	ast_pbx_run_args (struct ast_channel *c, struct ast_pbx_args *args)
	Execute the PBX in the current thread.
enum ast_pbx_result	ast_pbx_start (struct ast_channel *c)
	Create a new thread and start the PBX.
int	ast_processed_calls (void)
	Retrieve the total number of calls processed through the PBX since last restart.
int	ast_rdlock_context (struct ast_context *con)
	Read locks a given context.
int	ast_rdlock_contexts (void)
	Read locks the context list.
int	ast_register_switch (struct ast_switch *sw)
	Register an alternative dialplan switch.
int	ast_spawn_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid, int *found, int combined_find_spawn)
	Launch a new extension (i.e. new stack).
int	ast_unlock_context (struct ast_context *con)
int	ast_unlock_contexts (void)
	Unlocks contexts.
void	ast_unregister_switch (struct ast_switch *sw)
	Unregister an alternative switch.
struct ast_exten *	ast_walk_context_extensions (struct ast_context *con, struct ast_exten *priority)
struct ast_ignorepat *	ast_walk_context_ignorepats (struct ast_context *con, struct ast_ignorepat *ip)
struct ast_include *	ast_walk_context_includes (struct ast_context *con, struct ast_include *inc)
struct ast_sw *	ast_walk_context_switches (struct ast_context *con, struct ast_sw *sw)
struct ast_context *	ast_walk_contexts (struct ast_context *con)
struct ast_exten *	ast_walk_extension_priorities (struct ast_exten *exten, struct ast_exten *priority)
int	ast_wrlock_context (struct ast_context *con)
	Write locks a given context.
int	ast_wrlock_contexts (void)
	Write locks the context list.
int	ast_wrlock_contexts_version (void)
void	pbx_builtin_clear_globals (void)
const char *	pbx_builtin_getvar_helper (struct ast_channel *chan, const char *name)
void	pbx_builtin_pushvar_helper (struct ast_channel *chan, const char *name, const char *value)
int	pbx_builtin_raise_exception (struct ast_channel *chan, void *data)
int	pbx_builtin_serialize_variables (struct ast_channel *chan, struct ast_str **buf)
int	pbx_builtin_setvar (struct ast_channel *chan, void *data)
void	pbx_builtin_setvar_helper (struct ast_channel *chan, const char *name, const char *value)
int	pbx_builtin_setvar_multiple (struct ast_channel *chan, void *data)
int	pbx_checkcondition (const char *condition)
	Evaluate a condition.
int	pbx_exec (struct ast_channel *c, struct ast_app *app, void *data)
	Execute an application.
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)
struct ast_app *	pbx_findapp (const char *app)
	Look up an application.
void	pbx_retrieve_variable (struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
	Support for Asterisk built-in variables in the dialplan.
int	pbx_set_autofallthrough (int newval)
int	pbx_set_extenpatternmatchnew (int newval)
void	pbx_substitute_variables_helper (struct ast_channel *c, const char *cp1, char *cp2, int count)
void	pbx_substitute_variables_varshead (struct varshead *headp, const char *cp1, char *cp2, int count)
Functions for returning values from structures
const char *	ast_get_context_name (struct ast_context *con)
struct ast_context *	ast_get_extension_context (struct ast_exten *exten)
const char *	ast_get_extension_name (struct ast_exten *exten)
const char *	ast_get_ignorepat_name (struct ast_ignorepat *ip)
const char *	ast_get_include_name (struct ast_include *include)
const char *	ast_get_switch_data (struct ast_sw *sw)
int	ast_get_switch_eval (struct ast_sw *sw)
const char *	ast_get_switch_name (struct ast_sw *sw)
Registrar info functions ...
const char *	ast_get_context_registrar (struct ast_context *c)
const char *	ast_get_extension_registrar (struct ast_exten *e)
const char *	ast_get_ignorepat_registrar (struct ast_ignorepat *ip)
const char *	ast_get_include_registrar (struct ast_include *i)
const char *	ast_get_switch_registrar (struct ast_sw *sw)
Other Extension stuff
const char *	ast_get_extension_app (struct ast_exten *e)
void *	ast_get_extension_app_data (struct ast_exten *e)
const char *	ast_get_extension_cidmatch (struct ast_exten *e)
const char *	ast_get_extension_label (struct ast_exten *e)
int	ast_get_extension_matchcid (struct ast_exten *e)
int	ast_get_extension_priority (struct ast_exten *exten)

---

Detailed Description

Core PBX routines and definitions.

Definition in file pbx.h.

---

Define Documentation

#define ast_custom_function_register

(

acf

)

__ast_custom_function_register(acf, ast_module_info->self)

Register a custom function.

Definition at line 969 of file pbx.h.

Referenced by load_module(), and reload().

#define AST_MAX_APP   32

Max length of an application

Definition at line 35 of file pbx.h.

Referenced by destroy_station(), handle_show_application(), handle_show_function(), and sla_build_station().

#define AST_PBX_ERROR   1

Jump to the 'e' exten

Definition at line 43 of file pbx.h.

Referenced by __ast_pbx_run().

#define AST_PBX_HANGUP   -1

Special return values from applications to the PBX {.

Jump to the 'h' exten

Definition at line 41 of file pbx.h.

#define AST_PBX_KEEP   0

Definition at line 37 of file pbx.h.

#define AST_PBX_MAX_STACK   128

Definition at line 1034 of file pbx.h.

#define AST_PBX_OK   0

No errors

Definition at line 42 of file pbx.h.

#define AST_PBX_REPLACE   1

Definition at line 38 of file pbx.h.

#define PRIORITY_HINT   -1

} Special Priority for a hint

Definition at line 46 of file pbx.h.

Referenced by add_pri_lockopt(), ast_add_extension2_lockopt(), ast_hint_extension(), ast_merge_contexts_and_delete(), destroy_exten(), destroy_station(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_remove_extension(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), park_add_hints(), pbx_load_config(), print_ext(), and sla_build_station().

#define STATUS_NO_CONTEXT   1

Definition at line 1029 of file pbx.h.

#define STATUS_NO_EXTENSION   2

Definition at line 1030 of file pbx.h.

#define STATUS_NO_LABEL   4

Definition at line 1032 of file pbx.h.

#define STATUS_NO_PRIORITY   3

Definition at line 1031 of file pbx.h.

#define STATUS_SUCCESS   5

Definition at line 1033 of file pbx.h.

---

Typedef Documentation

typedef int(* ast_state_cb_type)(char *context, char *id, enum ast_extension_states state, void *data)

Typedef for devicestate and hint callbacks.

Definition at line 71 of file pbx.h.

typedef int( ast_switch_f)(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data)

All switch functions have the same interface, so define a type for them.

Data structure associated with an Asterisk switch

Definition at line 86 of file pbx.h.

---

Enumeration Type Documentation

enum ast_extension_states

Extension states.

Note:

States can be combined

• Extension and device states in Asterisk

Enumerator:

AST_EXTENSION_REMOVED	Extension removed
AST_EXTENSION_DEACTIVATED	Extension hint removed
AST_EXTENSION_NOT_INUSE	No device INUSE or BUSY
AST_EXTENSION_INUSE	One or more devices INUSE
AST_EXTENSION_BUSY	All devices BUSY
AST_EXTENSION_UNAVAILABLE	All devices UNAVAILABLE/UNREGISTERED
AST_EXTENSION_RINGING	All devices RINGING
AST_EXTENSION_ONHOLD	All devices ONHOLD

Definition at line 52 of file pbx.h.

                          {
   AST_EXTENSION_REMOVED = -2,   /*!< Extension removed */
   AST_EXTENSION_DEACTIVATED = -1,  /*!< Extension hint removed */
   AST_EXTENSION_NOT_INUSE = 0,  /*!< No device INUSE or BUSY  */
   AST_EXTENSION_INUSE = 1 << 0, /*!< One or more devices INUSE */
   AST_EXTENSION_BUSY = 1 << 1,  /*!< All devices BUSY */
   AST_EXTENSION_UNAVAILABLE = 1 << 2, /*!< All devices UNAVAILABLE/UNREGISTERED */
   AST_EXTENSION_RINGING = 1 << 3,  /*!< All devices RINGING */
   AST_EXTENSION_ONHOLD = 1 << 4,   /*!< All devices ONHOLD */
};

enum ast_pbx_result

The result codes when starting the PBX on a channelwith.

See also:

ast_pbx_start. AST_PBX_CALL_LIMIT refers to the maxcalls call limit in asterisk.conf

Enumerator:

AST_PBX_SUCCESS
AST_PBX_FAILED
AST_PBX_CALL_LIMIT

Definition at line 228 of file pbx.h.

                    {
   AST_PBX_SUCCESS = 0,
   AST_PBX_FAILED = -1,
   AST_PBX_CALL_LIMIT = -2,
};

enum ext_match_t

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.

Enumerator:

E_MATCHMORE
E_CANMATCH
E_MATCH
E_MATCH_MASK
E_SPAWN
E_FINDLABEL
E_MATCHMORE
E_CANMATCH
E_MATCH
E_MATCH_MASK
E_SPAWN
E_FINDLABEL

Definition at line 1020 of file pbx.h.

                 {
   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 */
};

---

Function Documentation

int __ast_custom_function_register	(	struct ast_custom_function *	acf,
		struct ast_module *	mod
	)

Register a custom function.

Definition at line 2714 of file pbx.c.

References ast_custom_function::acflist, ast_log(), AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, COLOR_BRCYAN, LOG_ERROR, ast_custom_function::mod, ast_custom_function::name, and term_color().

Referenced by load_pbx().

{
   struct ast_custom_function *cur;
   char tmps[80];

   if (!acf)
      return -1;

   acf->mod = mod;

   AST_RWLIST_WRLOCK(&acf_root);

   AST_RWLIST_TRAVERSE(&acf_root, cur, acflist) {
      if (!strcmp(acf->name, cur->name)) {
         ast_log(LOG_ERROR, "Function %s already registered.\n", acf->name);
         AST_RWLIST_UNLOCK(&acf_root);
         return -1;
      }
   }

   /* Store in alphabetical order */
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&acf_root, cur, acflist) {
      if (strcasecmp(acf->name, cur->name) < 0) {
         AST_RWLIST_INSERT_BEFORE_CURRENT(acf, acflist);
         break;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   if (!cur)
      AST_RWLIST_INSERT_TAIL(&acf_root, acf, acflist);

   AST_RWLIST_UNLOCK(&acf_root);

   ast_verb(2, "Registered custom function '%s'\n", term_color(tmps, acf->name, COLOR_BRCYAN, 0, sizeof(tmps)));

   return 0;
}

int ast_active_calls

(

void

)

Retrieve the number of active calls.

Definition at line 3996 of file pbx.c.

Referenced by handle_chanlist(), handle_showcalls(), and sysinfo_helper().

{
   return countcalls;
}

int ast_add_extension	(	const char *	context,
		int	replace,
		const char *	extension,
		int	priority,
		const char *	label,
		const char *	callerid,
		const char *	application,
		void *	data,
		void(*)(void *)	datad,
		const char *	registrar
	)

Add and extension to an extension context.

Parameters:

	context	context to add the extension to
	replace
	extension	extension to add
	priority	priority level of extension addition
	label	extension label
	callerid	pattern to match CallerID, or NULL to match any CallerID
	application	application to run on the extension with that priority level
	data	data to pass to the application
	datad
	registrar	who registered the extension

Return values:

	0	success
	-1	failure

Definition at line 6434 of file pbx.c.

References ast_add_extension2(), ast_unlock_contexts(), and find_context_locked().

Referenced by handle_cli_dialplan_add_extension(), park_add_hints(), register_exten(), register_peer_exten(), and RegisterExtension().

{
   int ret = -1;
   struct ast_context *c = find_context_locked(context);

   if (c) {
      ret = ast_add_extension2(c, replace, extension, priority, label, callerid,
         application, data, datad, registrar);
      ast_unlock_contexts();
   }
   
   return ret;
}

int ast_add_extension2	(	struct ast_context *	con,
		int	replace,
		const char *	extension,
		int	priority,
		const char *	label,
		const char *	callerid,
		const char *	application,
		void *	data,
		void(*)(void *)	datad,
		const char *	registrar
	)

Add an extension to an extension context, this time with an ast_context *.

Note:

For details about the arguments, check ast_add_extension()

Add an extension to an extension context, this time with an ast_context *.

We sort extensions in order of matching preference, so that we can stop the search as soon as we find a suitable match. This ordering also takes care of wildcards such as '.' (meaning "one or more of any character") and '!' (which is 'earlymatch', meaning "zero or more of any character" but also impacts the return value from CANMATCH and EARLYMATCH.

The extension match rules defined in the devmeeting 2006.05.05 are quite simple: WE SELECT THE LONGEST MATCH. In detail, "longest" means the number of matched characters in the extension. In case of ties (e.g. _XXX and 333) in the length of a pattern, we give priority to entries with the smallest cardinality (e.g, [5-9] comes before [2-8] before the former has only 5 elements, while the latter has 7, etc. In case of same cardinality, the first element in the range counts. If we still have a tie, any final '!' will make this as a possibly less specific pattern.

EBUSY - can't lock EEXIST - extension with the same priority exist and no replace is set

Definition at line 6752 of file pbx.c.

References ast_add_extension2_lockopt().

Referenced by ast_add_extension(), context_merge(), do_parking_thread(), load_config(), load_module(), park_call_full(), pbx_load_config(), pbx_load_users(), sla_build_station(), and sla_build_trunk().

{
   return ast_add_extension2_lockopt(con, replace, extension, priority, label, callerid, application, data, datad, registrar, 1, 1);
}

int ast_async_goto	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Definition at line 6473 of file pbx.c.

References ast_channel::_state, ast_channel::accountcode, ast_channel::amaflags, ast_cdr_discard(), ast_cdr_dup(), ast_channel_alloc, ast_channel_lock, ast_channel_masquerade(), ast_channel_unlock, ast_do_masquerade(), ast_explicit_goto(), ast_hangup(), ast_log(), ast_pbx_start(), AST_SOFTHANGUP_ASYNCGOTO, ast_softhangup_nolock(), ast_channel::cdr, ast_channel::context, ast_channel::exten, LOG_WARNING, ast_channel::name, ast_channel::pbx, ast_channel::readformat, S_OR, and ast_channel::writeformat.

Referenced by __ast_goto_if_exists(), action_redirect(), ast_async_goto_by_name(), builtin_blindtransfer(), console_transfer(), dahdi_handle_dtmfup(), handle_request_bye(), handle_request_refer(), pbx_parseable_goto(), process_ast_dsp(), and socket_process().

{
   int res = 0;

   ast_channel_lock(chan);

   if (chan->pbx) { /* This channel is currently in the PBX */
      ast_explicit_goto(chan, context, exten, priority + 1);
      ast_softhangup_nolock(chan, AST_SOFTHANGUP_ASYNCGOTO);
   } else {
      /* In order to do it when the channel doesn't really exist within
         the PBX, we have to make a new channel, masquerade, and start the PBX
         at the new location */
      struct ast_channel *tmpchan = ast_channel_alloc(0, chan->_state, 0, 0, chan->accountcode, chan->exten, chan->context, chan->amaflags, "AsyncGoto/%s", chan->name);
      if (!tmpchan) {
         res = -1;
      } else {
         if (chan->cdr) {
            ast_cdr_discard(tmpchan->cdr);
            tmpchan->cdr = ast_cdr_dup(chan->cdr);  /* share the love */
         }
         /* Make formats okay */
         tmpchan->readformat = chan->readformat;
         tmpchan->writeformat = chan->writeformat;
         /* Setup proper location */
         ast_explicit_goto(tmpchan,
            S_OR(context, chan->context), S_OR(exten, chan->exten), priority);

         /* Masquerade into temp channel */
         if (ast_channel_masquerade(tmpchan, chan)) {
            /* Failed to set up the masquerade.  It's probably chan_local
             * in the middle of optimizing itself out.  Sad. :( */
            ast_hangup(tmpchan);
            tmpchan = NULL;
            res = -1;
         } else {
            /* Grab the locks and get going */
            ast_channel_lock(tmpchan);
            ast_do_masquerade(tmpchan);
            ast_channel_unlock(tmpchan);
            /* Start the PBX going on our stolen channel */
            if (ast_pbx_start(tmpchan)) {
               ast_log(LOG_WARNING, "Unable to start PBX on %s\n", tmpchan->name);
               ast_hangup(tmpchan);
               res = -1;
            }
         }
      }
   }
   ast_channel_unlock(chan);
   return res;
}

int ast_async_goto_by_name	(	const char *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Definition at line 6526 of file pbx.c.

References ast_async_goto(), ast_channel_unlock, and ast_get_channel_by_name_locked().

{
   struct ast_channel *chan;
   int res = -1;

   chan = ast_get_channel_by_name_locked(channame);
   if (chan) {
      res = ast_async_goto(chan, context, exten, priority);
      ast_channel_unlock(chan);
   }
   return res;
}

int ast_async_goto_if_exists	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Note:

This function will handle locking the channel as needed.

Definition at line 8633 of file pbx.c.

References __ast_goto_if_exists().

{
   return __ast_goto_if_exists(chan, context, exten, priority, 1);
}

int ast_async_parseable_goto	(	struct ast_channel *	chan,
		const char *	goto_string
	)

Note:

This function will handle locking the channel as needed.

Definition at line 8696 of file pbx.c.

References pbx_parseable_goto().

Referenced by asyncgoto_exec().

{
   return pbx_parseable_goto(chan, goto_string, 1);
}

int ast_build_timing	(	struct ast_timing *	i,
		const char *	info
	)

Definition at line 6113 of file pbx.c.

References ast_copy_string(), ast_strlen_zero(), ast_timing::daymask, days, ast_timing::dowmask, get_range(), get_timerange(), ast_timing::monthmask, months, and strsep().

Referenced by ast_context_add_include2(), iftime(), pbx_builtin_execiftime(), and pbx_builtin_gotoiftime().

{
   char info_save[256];
   char *info;

   /* Check for empty just in case */
   if (ast_strlen_zero(info_in))
      return 0;
   /* make a copy just in case we were passed a static string */
   ast_copy_string(info_save, info_in, sizeof(info_save));
   info = info_save;
   /* Assume everything except time */
   i->monthmask = 0xfff;   /* 12 bits */
   i->daymask = 0x7fffffffU; /* 31 bits */
   i->dowmask = 0x7f; /* 7 bits */
   /* on each call, use strsep() to move info to the next argument */
   get_timerange(i, strsep(&info, "|,"));
   if (info)
      i->dowmask = get_range(strsep(&info, "|,"), 7, days, "day of week");
   if (info)
      i->daymask = get_range(strsep(&info, "|,"), 31, NULL, "day");
   if (info)
      i->monthmask = get_range(strsep(&info, "|,"), 12, months, "month");
   return 1;
}

int ast_canmatch_extension	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten,
		int	priority,
		const char *	callerid
	)

Looks for a valid matching extension.

Parameters:

	c	not really important
	context	context to serach within
	exten	extension to check
	priority	priority of extension path
	callerid	callerid of extension being searched for

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

Returns:

If "exten" *could be* a valid extension in this context with or without some more digits, return non-zero. Basically, when this returns 0, no matter what you add to exten, it's not going to be a valid extension anymore

Definition at line 3574 of file pbx.c.

References E_CANMATCH, and pbx_extension_helper().

Referenced by background_detect_exec(), cb_events(), do_immediate_setup(), dp_lookup(), dundi_lookup_local(), get_also_info(), get_destination(), handle_link_data(), handle_link_phone_dtmf(), leave_voicemail(), local_dtmf_helper(), loopback_canmatch(), mgcp_ss(), phone_check_exception(), skinny_ss(), ss_thread(), and valid_exit().

{
   return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_CANMATCH, 0, 0);
}

int ast_check_timing

(

const struct ast_timing *

i

)

Definition at line 6139 of file pbx.c.

References ast_localtime(), ast_log(), ast_tvnow(), ast_timing::daymask, ast_timing::dowmask, LOG_WARNING, ast_timing::minmask, ast_timing::monthmask, ast_tm::tm_hour, ast_tm::tm_mday, ast_tm::tm_min, ast_tm::tm_mon, and ast_tm::tm_wday.

Referenced by iftime(), include_valid(), pbx_builtin_execiftime(), and pbx_builtin_gotoiftime().

{
   struct ast_tm tm;
   struct timeval tv = ast_tvnow();

   ast_localtime(&tv, &tm, NULL);

   /* If it's not the right month, return */
   if (!(i->monthmask & (1 << tm.tm_mon)))
      return 0;

   /* If it's not that time of the month.... */
   /* Warning, tm_mday has range 1..31! */
   if (!(i->daymask & (1 << (tm.tm_mday-1))))
      return 0;

   /* If it's not the right day of the week */
   if (!(i->dowmask & (1 << tm.tm_wday)))
      return 0;

   /* Sanity check the hour just to be safe */
   if ((tm.tm_hour < 0) || (tm.tm_hour > 23)) {
      ast_log(LOG_WARNING, "Insane time...\n");
      return 0;
   }

   /* Now the tough part, we calculate if it fits
      in the right time based on min/hour */
   if (!(i->minmask[tm.tm_hour] & (1 << (tm.tm_min / 2))))
      return 0;

   /* If we got this far, then we're good */
   return 1;
}

int ast_context_add_ignorepat	(	const char *	context,
		const char *	ignorepat,
		const char *	registrar
	)

Add an ignorepat.

Parameters:

	context	which context to add the ignorpattern to
	ignorepat	ignorepattern to set up for the extension
	registrar	registrar of the ignore pattern

Adds an ignore pattern to a particular context.

Return values:

	0	on success
	-1	on failure

Definition at line 6365 of file pbx.c.

References ast_context_add_ignorepat2(), ast_unlock_contexts(), and find_context_locked().

Referenced by handle_cli_dialplan_add_ignorepat().

{
   int ret = -1;
   struct ast_context *c = find_context_locked(context);

   if (c) {
      ret = ast_context_add_ignorepat2(c, value, registrar);
      ast_unlock_contexts();
   }
   return ret;
}

int ast_context_add_ignorepat2	(	struct ast_context *	con,
		const char *	ignorepat,
		const char *	registrar
	)

Definition at line 6377 of file pbx.c.

References ast_calloc, ast_unlock_context(), ast_wrlock_context(), errno, ast_context::ignorepats, ast_ignorepat::next, ast_ignorepat::pattern, and ast_ignorepat::registrar.

Referenced by ast_context_add_ignorepat(), context_merge_incls_swits_igps_other_registrars(), and pbx_load_config().

{
   struct ast_ignorepat *ignorepat, *ignorepatc, *ignorepatl = NULL;
   int length;
   char *pattern;
   length = sizeof(struct ast_ignorepat);
   length += strlen(value) + 1;
   if (!(ignorepat = ast_calloc(1, length)))
      return -1;
   /* The cast to char * is because we need to write the initial value.
    * The field is not supposed to be modified otherwise.  Also, gcc 4.2
    * sees the cast as dereferencing a type-punned pointer and warns about
    * it.  This is the workaround (we're telling gcc, yes, that's really
    * what we wanted to do).
    */
   pattern = (char *) ignorepat->pattern;
   strcpy(pattern, value);
   ignorepat->next = NULL;
   ignorepat->registrar = registrar;
   ast_wrlock_context(con);
   for (ignorepatc = con->ignorepats; ignorepatc; ignorepatc = ignorepatc->next) {
      ignorepatl = ignorepatc;
      if (!strcasecmp(ignorepatc->pattern, value)) {
         /* Already there */
         ast_unlock_context(con);
         errno = EEXIST;
         return -1;
      }
   }
   if (ignorepatl)
      ignorepatl->next = ignorepat;
   else
      con->ignorepats = ignorepat;
   ast_unlock_context(con);
   return 0;

}

int ast_context_add_include	(	const char *	context,
		const char *	include,
		const char *	registrar
	)

Add a context include.

Parameters:

	context	context to add include to
	include	new include to add
	registrar	who's registering it

Adds an include taking a char * string as the context parameter

Return values:

	0	on success
	-1	on error

Definition at line 5919 of file pbx.c.

References ast_context_add_include2(), ast_unlock_contexts(), and find_context_locked().

Referenced by handle_cli_dialplan_add_include().

{
   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;
}

int ast_context_add_include2	(	struct ast_context *	con,
		const char *	include,
		const char *	registrar
	)

Add a context include.

Parameters:

	con	context to add the include to
	include	include to add
	registrar	who registered the context

Adds an include taking a struct ast_context as the first parameter

Return values:

	0	on success
	-1	on failure

Definition at line 6181 of file pbx.c.

References ast_build_timing(), ast_calloc, ast_free, ast_get_context_name(), ast_unlock_context(), ast_verb, ast_wrlock_context(), errno, ast_include::hastime, ast_context::includes, ast_include::name, ast_include::next, ast_include::registrar, ast_include::rname, ast_include::stuff, and ast_include::timing.

Referenced by ast_context_add_include(), context_merge_incls_swits_igps_other_registrars(), and pbx_load_config().

{
   struct ast_include *new_include;
   char *c;
   struct ast_include *i, *il = NULL; /* include, include_last */
   int length;
   char *p;

   length = sizeof(struct ast_include);
   length += 2 * (strlen(value) + 1);

   /* allocate new include structure ... */
   if (!(new_include = ast_calloc(1, length)))
      return -1;
   /* Fill in this structure. Use 'p' for assignments, as the fields
    * in the structure are 'const char *'
    */
   p = new_include->stuff;
   new_include->name = p;
   strcpy(p, value);
   p += strlen(value) + 1;
   new_include->rname = p;
   strcpy(p, value);
   /* Strip off timing info, and process if it is there */
   if ( (c = strchr(p, ',')) ) {
      *c++ = '\0';
      new_include->hastime = ast_build_timing(&(new_include->timing), c);
   }
   new_include->next      = NULL;
   new_include->registrar = registrar;

   ast_wrlock_context(con);

   /* ... go to last include and check if context is already included too... */
   for (i = con->includes; i; i = i->next) {
      if (!strcasecmp(i->name, new_include->name)) {
         ast_free(new_include);
         ast_unlock_context(con);
         errno = EEXIST;
         return -1;
      }
      il = i;
   }

   /* ... include new context into context list, unlock, return */
   if (il)
      il->next = new_include;
   else
      con->includes = new_include;
   ast_verb(3, "Including context '%s' in context '%s'\n", new_include->name, ast_get_context_name(con));

   ast_unlock_context(con);

   return 0;
}

int ast_context_add_switch	(	const char *	context,
		const char *	sw,
		const char *	data,
		int	eval,
		const char *	registrar
	)

Add a switch.

Parameters:

	context	context to which to add the switch
	sw	switch to add
	data	data to pass to switch
	eval	whether to evaluate variables when running switch
	registrar	whoever registered the switch

This function registers a switch with the asterisk switch architecture

Return values:

	0	on success
	-1	on failure

Definition at line 6243 of file pbx.c.

References ast_context_add_switch2(), ast_unlock_contexts(), and find_context_locked().

{
   int ret = -1;
   struct ast_context *c = find_context_locked(context);

   if (c) { /* found, add switch to this context */
      ret = ast_context_add_switch2(c, sw, data, eval, registrar);
      ast_unlock_contexts();
   }
   return ret;
}

int ast_context_add_switch2	(	struct ast_context *	con,
		const char *	sw,
		const char *	data,
		int	eval,
		const char *	registrar
	)

Adds a switch (first param is a ast_context).

Note:

See ast_context_add_switch() for argument information, with the exception of the first argument. In this case, it's a pointer to an ast_context structure as opposed to the name.

Definition at line 6262 of file pbx.c.

References ast_context::alts, ast_calloc, ast_free, ast_get_context_name(), AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_unlock_context(), ast_verb, ast_wrlock_context(), ast_sw::data, errno, ast_sw::eval, ast_sw::list, ast_sw::name, ast_sw::registrar, and ast_sw::stuff.

Referenced by ast_context_add_switch(), context_merge_incls_swits_igps_other_registrars(), lua_register_switches(), and pbx_load_config().

{
   struct ast_sw *new_sw;
   struct ast_sw *i;
   int length;
   char *p;

   length = sizeof(struct ast_sw);
   length += strlen(value) + 1;
   if (data)
      length += strlen(data);
   length++;

   /* allocate new sw structure ... */
   if (!(new_sw = ast_calloc(1, length)))
      return -1;
   /* ... fill in this structure ... */
   p = new_sw->stuff;
   new_sw->name = p;
   strcpy(new_sw->name, value);
   p += strlen(value) + 1;
   new_sw->data = p;
   if (data) {
      strcpy(new_sw->data, data);
      p += strlen(data) + 1;
   } else {
      strcpy(new_sw->data, "");
      p++;
   }
   new_sw->eval     = eval;
   new_sw->registrar = registrar;

   /* ... try to lock this context ... */
   ast_wrlock_context(con);

   /* ... go to last sw and check if context is already swd too... */
   AST_LIST_TRAVERSE(&con->alts, i, list) {
      if (!strcasecmp(i->name, new_sw->name) && !strcasecmp(i->data, new_sw->data)) {
         ast_free(new_sw);
         ast_unlock_context(con);
         errno = EEXIST;
         return -1;
      }
   }

   /* ... sw new context into context list, unlock, return */
   AST_LIST_INSERT_TAIL(&con->alts, new_sw, list);

   ast_verb(3, "Including switch '%s/%s' in context '%s'\n", new_sw->name, new_sw->data, ast_get_context_name(con));

   ast_unlock_context(con);

   return 0;
}

void ast_context_destroy	(	struct ast_context *	con,
		const char *	registrar
	)

Destroy a context (matches the specified context (or ANY context if NULL).

Parameters:

	con	context to destroy
	registrar	who registered it

You can optionally leave out either parameter. It will find it based on either the ast_context or the registrar name.

Returns:

nothing

Definition at line 7540 of file pbx.c.

References __ast_context_destroy(), ast_unlock_contexts(), and ast_wrlock_contexts().

Referenced by __unload_module(), cleanup_stale_contexts(), sla_destroy(), and unload_module().

{
   ast_wrlock_contexts();
   __ast_context_destroy(contexts, contexts_table, con,registrar);
   ast_unlock_contexts();
}

struct ast_context* ast_context_find

(

const char *

name

)

[read]

Find a context.

Parameters:

name

name of the context to find

Will search for the context with the given name.

Returns:

the ast_context on success, NULL on failure.

Definition at line 2001 of file pbx.c.

References ast_hashtab_lookup(), ast_rdlock_contexts(), ast_unlock_contexts(), ast_walk_contexts(), ast_context::name, and fake_context::name.

Referenced by __unload_module(), _macro_exec(), ast_context_verify_includes(), ast_ignore_pattern(), cleanup_stale_contexts(), do_parking_thread(), isexten_function_read(), load_config(), park_exec(), register_exten(), register_peer_exten(), unload_module(), and unregister_exten().

{
   struct ast_context *tmp = NULL;
   struct fake_context item;
   strncpy(item.name,name,256);
   ast_rdlock_contexts();
   if( contexts_table ) {
      tmp = ast_hashtab_lookup(contexts_table,&item);
   } else {
      while ( (tmp = ast_walk_contexts(tmp)) ) {
         if (!name || !strcasecmp(name, tmp->name))
            break;
      }
   }
   ast_unlock_contexts();
   return tmp;
}

struct ast_context* ast_context_find_or_create	(	struct ast_context **	extcontexts,
		struct ast_hashtab *	exttable,
		const char *	name,
		const char *	registrar
	)			[read]

Register a new context or find an existing one.

Parameters:

	extcontexts	pointer to the ast_context structure pointer
	exttable	pointer to the hashtable that contains all the elements in extcontexts
	name	name of the new context
	registrar	registrar of the context

This function allows you to play in two environments: the global contexts (active dialplan) or an external context set of your choosing. To act on the external set, make sure extcontexts and exttable are set; for the globals, make sure both extcontexts and exttable are NULL.

This will first search for a context with your name. If it exists already, it will not create a new one. If it does not exist, it will create a new one with the given name and registrar.

Returns:

NULL on failure, and an ast_context structure on success

Definition at line 5578 of file pbx.c.

References ast_calloc, ast_debug, ast_hashtab_compare_contexts(), ast_hashtab_create(), ast_hashtab_hash_contexts(), ast_hashtab_insert_immediate(), ast_hashtab_insert_safe(), ast_hashtab_lookup(), ast_hashtab_newsize_java(), ast_hashtab_resize_java(), ast_log(), ast_mutex_init(), ast_rdlock_contexts(), ast_rwlock_init(), ast_strdup, ast_unlock_contexts(), ast_verb, ast_wrlock_contexts(), ast_context::ignorepats, ast_context::includes, local_contexts, ast_context::lock, LOG_ERROR, ast_context::macrolock, ast_context::name, fake_context::name, ast_context::next, ast_context::refcount, ast_context::registrar, ast_context::root, and ast_context::root_table.

Referenced by context_merge(), do_parking_thread(), load_config(), load_module(), lua_register_switches(), park_call_full(), pbx_load_config(), pbx_load_users(), reload_config(), set_config(), sla_build_station(), and sla_build_trunk().

{
   struct ast_context *tmp, **local_contexts;
   struct fake_context search;
   int length = sizeof(struct ast_context) + strlen(name) + 1;

   if (!contexts_table) {
      contexts_table = ast_hashtab_create(17,
                                 ast_hashtab_compare_contexts, 
                                 ast_hashtab_resize_java,
                                 ast_hashtab_newsize_java,
                                 ast_hashtab_hash_contexts,
                                 0);
   }
   
   strncpy(search.name,name,sizeof(search.name));
   if (!extcontexts) {
      ast_rdlock_contexts();
      local_contexts = &contexts;
      tmp = ast_hashtab_lookup(contexts_table, &search);
      ast_unlock_contexts();
      if (tmp) {
         tmp->refcount++;
         return tmp;
      }
   } else { /* local contexts just in a linked list; search there for the new context; slow, linear search, but not frequent */
      local_contexts = extcontexts;
      tmp = ast_hashtab_lookup(exttable, &search);
      if (tmp) {
         tmp->refcount++;
         return tmp;
      }
   }
   
   if ((tmp = ast_calloc(1, length))) {
      ast_rwlock_init(&tmp->lock);
      ast_mutex_init(&tmp->macrolock);
      strcpy(tmp->name, name);
      tmp->root = NULL;
      tmp->root_table = NULL;
      tmp->registrar = ast_strdup(registrar);
      tmp->includes = NULL;
      tmp->ignorepats = NULL;
      tmp->refcount = 1;
   } else {
      ast_log(LOG_ERROR, "Danger! We failed to allocate a context for %s!\n", name);
      return NULL;
   }
   
   if (!extcontexts) {
      ast_wrlock_contexts();
      tmp->next = *local_contexts;
      *local_contexts = tmp;
      ast_hashtab_insert_safe(contexts_table, tmp); /*put this context into the tree */
      ast_unlock_contexts();
      ast_debug(1, "Registered context '%s'(%p) in table %p registrar: %s\n", tmp->name, tmp, contexts_table, registrar);
      ast_verb(3, "Registered extension context '%s' (%p) in table %p; registrar: %s\n", tmp->name, tmp, contexts_table, registrar);
   } else {
      tmp->next = *local_contexts;
      if (exttable)
         ast_hashtab_insert_immediate(exttable, tmp); /*put this context into the tree */
      
      *local_contexts = tmp;
      ast_debug(1, "Registered context '%s'(%p) in local table %p; registrar: %s\n", tmp->name, tmp, exttable, registrar);
      ast_verb(3, "Registered extension context '%s' (%p) in local table %p; registrar: %s\n", tmp->name, tmp, exttable, registrar);
   }
   return tmp;
}

int ast_context_lockmacro

(

const char *

context

)

locks the macrolock in the given given context

Parameters:

macrocontext

name of the macro-context to lock

Locks the given macro-context to ensure only one thread (call) can execute it at a time

Return values:

	0	on success
	-1	on failure

Note:

This function locks contexts list by &conlist, searches for the right context structure, and locks the macrolock mutex in that context. macrolock is used to limit a macro to be executed by one call at a time.

Definition at line 4355 of file pbx.c.

References ast_get_context_name(), ast_hashtab_lookup(), ast_mutex_lock(), ast_rdlock_contexts(), ast_unlock_contexts(), ast_walk_contexts(), ast_context::macrolock, and fake_context::name.

Referenced by _macro_exec().

{
   struct ast_context *c = NULL;
   int ret = -1;
   struct fake_context item;

   ast_rdlock_contexts();

   strncpy(item.name,context,256);
   c = ast_hashtab_lookup(contexts_table,&item);
   if (c)
      ret = 0;


#ifdef NOTNOW

   while ((c = ast_walk_contexts(c))) {
      if (!strcmp(ast_get_context_name(c), context)) {
         ret = 0;
         break;
      }
   }

#endif
   ast_unlock_contexts();

   /* if we found context, lock macrolock */
   if (ret == 0) 
      ret = ast_mutex_lock(&c->macrolock);

   return ret;
}

int ast_context_remove_extension	(	const char *	context,
		const char *	extension,
		int	priority,
		const char *	registrar
	)

Simply remove extension from context.

Parameters:

	context	context to remove extension from
	extension	which extension to remove
	priority	priority of extension to remove (0 to remove all)
	callerid	NULL to remove all; non-NULL to match a single record per priority
	matchcid	non-zero to match callerid element (if non-NULL); 0 to match default case
	registrar	registrar of the extension

This function removes an extension from a given context.

Return values:

	0	on success
	-1	on failure

Definition at line 4162 of file pbx.c.

References ast_context_remove_extension_callerid().

Referenced by destroy_station(), destroy_trunk(), register_peer_exten(), unregister_exten(), and UnregisterExtension().

{
   return ast_context_remove_extension_callerid(context, extension, priority, NULL, 0, registrar);
}

int ast_context_remove_extension2	(	struct ast_context *	con,
		const char *	extension,
		int	priority,
		const char *	registrar,
		int	already_locked
	)

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.

Definition at line 4189 of file pbx.c.

References ast_context_remove_extension_callerid2().

Referenced by do_parking_thread(), load_config(), park_exec(), and unload_module().

{
   return ast_context_remove_extension_callerid2(con, extension, priority, NULL, 0, registrar, already_locked);
}

int ast_context_remove_extension_callerid	(	const char *	context,
		const char *	extension,
		int	priority,
		const char *	callerid,
		int	matchcid,
		const char *	registrar
	)

Definition at line 4167 of file pbx.c.

References ast_context_remove_extension_callerid2(), ast_unlock_contexts(), and find_context_locked().

Referenced by ast_context_remove_extension(), and handle_cli_dialplan_remove_extension().

{
   int ret = -1; /* default error return */
   struct ast_context *c = find_context_locked(context);

   if (c) { /* ... remove extension ... */
      ret = ast_context_remove_extension_callerid2(c, extension, priority, callerid, matchcid, registrar, 1);
      ast_unlock_contexts();
   }
   return ret;
}

int ast_context_remove_extension_callerid2	(	struct ast_context *	con,
		const char *	extension,
		int	priority,
		const char *	callerid,
		int	matchcid,
		const char *	registrar,
		int	already_locked
	)

Definition at line 4194 of file pbx.c.

References add_exten_to_pattern_tree(), ast_copy_string(), ast_hashtab_insert_immediate(), ast_hashtab_lookup(), ast_hashtab_remove_this_object(), ast_hashtab_size(), ast_log(), ast_strlen_zero(), ast_unlock_context(), ast_verb, ast_wrlock_context(), ast_exten::cidmatch, match_char::deleted, destroy_exten(), match_char::exten, ast_exten::exten, exten, ast_exten::label, LOG_ERROR, log_match_char_tree(), LOG_NOTICE, LOG_WARNING, ast_exten::matchcid, ast_context::name, ast_exten::next, ast_context::pattern_tree, ast_exten::peer, ast_exten::peer_label_table, ast_exten::peer_table, ast_exten::priority, ast_exten::registrar, ast_context::root, ast_context::root_table, and match_char::x.

Referenced by __ast_context_destroy(), ast_context_remove_extension2(), and ast_context_remove_extension_callerid().

{
   struct ast_exten *exten, *prev_exten = NULL;
   struct ast_exten *peer;
   struct ast_exten ex, *exten2, *exten3;
   char dummy_name[1024];
   struct ast_exten *previous_peer = NULL;
   struct ast_exten *next_peer = NULL;
   int found = 0;

   if (!already_locked)
      ast_wrlock_context(con);

   /* Handle this is in the new world */

   /* FIXME For backwards compatibility, if callerid==NULL, then remove ALL
    * peers, not just those matching the callerid. */
#ifdef NEED_DEBUG
   ast_verb(3,"Removing %s/%s/%d%s%s from trees, registrar=%s\n", con->name, extension, priority, matchcid ? "/" : "", matchcid ? callerid : "", registrar);
#endif
#ifdef CONTEXT_DEBUG
   check_contexts(__FILE__, __LINE__);
#endif
   /* find this particular extension */
   ex.exten = dummy_name;
   ex.matchcid = matchcid && !ast_strlen_zero(callerid); /* don't say match if there's no callerid */
   ex.cidmatch = callerid;
   ast_copy_string(dummy_name, extension, sizeof(dummy_name));
   exten = ast_hashtab_lookup(con->root_table, &ex);
   if (exten) {
      if (priority == 0) {
         exten2 = ast_hashtab_remove_this_object(con->root_table, exten);
         if (!exten2)
            ast_log(LOG_ERROR,"Trying to delete the exten %s from context %s, but could not remove from the root_table\n", extension, con->name);
         if (con->pattern_tree) {
            
            struct match_char *x = add_exten_to_pattern_tree(con, exten, 1);
            
            if (x->exten) { /* this test for safety purposes */
               x->deleted = 1; /* with this marked as deleted, it will never show up in the scoreboard, and therefore never be found */
               x->exten = 0; /* get rid of what will become a bad pointer */
            } else {
               ast_log(LOG_WARNING,"Trying to delete an exten from a context, but the pattern tree node returned isn't a full extension\n");
            }
         }
      } else {
         ex.priority = priority;
         exten2 = ast_hashtab_lookup(exten->peer_table, &ex);
         if (exten2) {
            
            if (exten2->label) { /* if this exten has a label, remove that, too */
               exten3 = ast_hashtab_remove_this_object(exten->peer_label_table,exten2);
               if (!exten3)
                  ast_log(LOG_ERROR,"Did not remove this priority label (%d/%s) from the peer_label_table of context %s, extension %s!\n", priority, exten2->label, con->name, exten2->exten);
            }
         
            exten3 = ast_hashtab_remove_this_object(exten->peer_table, exten2);
            if (!exten3)
               ast_log(LOG_ERROR,"Did not remove this priority (%d) from the peer_table of context %s, extension %s!\n", priority, con->name, exten2->exten);
            if (exten2 == exten && exten2->peer) {
               exten2 = ast_hashtab_remove_this_object(con->root_table, exten);
               ast_hashtab_insert_immediate(con->root_table, exten2->peer);
            }
            if (ast_hashtab_size(exten->peer_table) == 0) {
               /* well, if the last priority of an exten is to be removed,
                  then, the extension is removed, too! */
               exten3 = ast_hashtab_remove_this_object(con->root_table, exten);
               if (!exten3)
                  ast_log(LOG_ERROR,"Did not remove this exten (%s) from the context root_table (%s) (priority %d)\n", exten->exten, con->name, priority);
               if (con->pattern_tree) {
                  struct match_char *x = add_exten_to_pattern_tree(con, exten, 1);
                  if (x->exten) { /* this test for safety purposes */
                     x->deleted = 1; /* with this marked as deleted, it will never show up in the scoreboard, and therefore never be found */
                     x->exten = 0; /* get rid of what will become a bad pointer */
                  }
               }
            }
         } else {
            ast_log(LOG_ERROR,"Could not find priority %d of exten %s in context %s!\n",
                  priority, exten->exten, con->name);
         }
      }
   } else {
      /* hmmm? this exten is not in this pattern tree? */
      ast_log(LOG_WARNING,"Cannot find extension %s in root_table in context %s\n",
            extension, con->name);
   }
#ifdef NEED_DEBUG
   if (con->pattern_tree) {
      ast_log(LOG_NOTICE,"match char tree after exten removal:\n");
      log_match_char_tree(con->pattern_tree, " ");
   }
#endif

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

   /* scan the priority list to remove extension with exten->priority == priority */
   for (peer = exten, next_peer = exten->peer ? exten->peer : exten->next;
       peer && !strcmp(peer->exten, extension) && (!matchcid || (!ast_strlen_zero(callerid) && !ast_strlen_zero(peer->cidmatch) && !strcmp(peer->cidmatch,callerid)) || (ast_strlen_zero(callerid) && ast_strlen_zero(peer->cidmatch)));
         peer = next_peer, next_peer = next_peer ? (next_peer->peer ? next_peer->peer : next_peer->next) : NULL) {
      if ((priority == 0 || peer->priority == priority) &&
            (!callerid || !matchcid || (matchcid && !strcmp(peer->cidmatch, callerid))) &&
            (!registrar || !strcmp(peer->registrar, registrar) )) {
         found = 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 (peer->peer) {
               /* move the peer_table and peer_label_table down to the next peer, if
                  it is there */
               peer->peer->peer_table = peer->peer_table;
               peer->peer->peer_label_table = peer->peer_label_table;
               peer->peer_table = NULL;
               peer->peer_label_table = NULL;
            }
            if (!prev_exten) {   /* change the root... */
               con->root = next_node;
            } else {
               prev_exten->next = next_node; /* unlink */
            }
            if (peer->peer)   { /* 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);
      } else {
         previous_peer = peer;
      }
   }
   if (!already_locked)
      ast_unlock_context(con);
   return found ? 0 : -1;
}

int ast_context_remove_ignorepat	(	const char *	context,
		const char *	ignorepat,
		const char *	registrar
	)

Definition at line 6322 of file pbx.c.

References ast_context_remove_ignorepat2(), ast_unlock_contexts(), and find_context_locked().

Referenced by handle_cli_dialplan_remove_ignorepat().

{
   int ret = -1;
   struct ast_context *c = find_context_locked(context);

   if (c) {
      ret = ast_context_remove_ignorepat2(c, ignorepat, registrar);
      ast_unlock_contexts();
   }
   return ret;
}

int ast_context_remove_ignorepat2	(	struct ast_context *	con,
		const char *	ignorepat,
		const char *	registrar
	)

Definition at line 6334 of file pbx.c.

References ast_free, ast_unlock_context(), ast_wrlock_context(), errno, ast_context::ignorepats, ast_ignorepat::next, ast_ignorepat::pattern, and ast_ignorepat::registrar.

Referenced by ast_context_remove_ignorepat().

{
   struct ast_ignorepat *ip, *ipl = NULL;

   ast_wrlock_context(con);

   for (ip = con->ignorepats; ip; ip = ip->next) {
      if (!strcmp(ip->pattern, ignorepat) &&
         (!registrar || (registrar == ip->registrar))) {
         if (ipl) {
            ipl->next = ip->next;
            ast_free(ip);
         } else {
            con->ignorepats = ip->next;
            ast_free(ip);
         }
         ast_unlock_context(con);
         return 0;
      }
      ipl = ip;
   }

   ast_unlock_context(con);
   errno = EINVAL;
   return -1;
}

int ast_context_remove_include	(	const char *	context,
		const char *	include,
		const char *	registrar
	)

Remove a context include.

Note:

See ast_context_add_include for information on arguments

Return values:

	0	on success
	-1	on failure

Definition at line 4054 of file pbx.c.

References ast_context_remove_include2(), ast_unlock_contexts(), and find_context_locked().

Referenced by handle_cli_dialplan_remove_include().

{
   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;
}

int ast_context_remove_include2	(	struct ast_context *	con,
		const char *	include,
		const char *	registrar
	)

Removes an include by an ast_context structure.

Note:

See ast_context_add_include2 for information on arguments

Return values:

	0	on success
	-1	on success

Removes an include by an ast_context structure.

Return values:

	0	on success.
	-1	on failure.

Definition at line 4076 of file pbx.c.

References ast_free, ast_get_context_name(), ast_unlock_context(), ast_verb, ast_wrlock_context(), ast_context::includes, ast_include::name, ast_include::next, and ast_include::registrar.

Referenced by ast_context_remove_include().

{
   struct ast_include *i, *pi = NULL;
   int ret = -1;

   ast_wrlock_context(con);

   /* 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 */
         ast_verb(3, "Removing inclusion of context '%s' in context '%s; registrar=%s'\n", include, ast_get_context_name(con), registrar);
         if (pi)
            pi->next = i->next;
         else
            con->includes = i->next;
         /* free include and return */
         ast_free(i);
         ret = 0;
         break;
      }
   }

   ast_unlock_context(con);

   return ret;
}

int ast_context_remove_switch	(	const char *	context,
		const char *	sw,
		const char *	data,
		const char *	registrar
	)

Remove a switch.

Removes a switch with the given parameters

Return values:

	0	on success
	-1	on failure

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 ...

Definition at line 4110 of file pbx.c.

References ast_context_remove_switch2(), ast_unlock_contexts(), and find_context_locked().

{
   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;
}

int ast_context_remove_switch2	(	struct ast_context *	con,
		const char *	sw,
		const char *	data,
		const char *	registrar
	)

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.

Definition at line 4131 of file pbx.c.

References ast_context::alts, ast_free, ast_get_context_name(), AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_unlock_context(), ast_verb, ast_wrlock_context(), ast_sw::data, ast_sw::list, ast_sw::name, and ast_sw::registrar.

Referenced by ast_context_remove_switch().

{
   struct ast_sw *i;
   int ret = -1;

   ast_wrlock_context(con);

   /* 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_verb(3, "Removing switch '%s' from context '%s; registrar=%s'\n", sw, ast_get_context_name(con), registrar);
         AST_LIST_REMOVE_CURRENT(list);
         ast_free(i); /* free switch and return */
         ret = 0;
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;

   ast_unlock_context(con);

   return ret;
}

int ast_context_unlockmacro

(

const char *

context

)

Unlocks the macrolock in the given context.

Parameters:

macrocontext

name of the macro-context to unlock

Unlocks the given macro-context so that another thread (call) can execute it

Return values:

	0	on success
	-1	on failure

Note:

This function locks contexts list by &conlist, searches for the right context structure, and unlocks the macrolock mutex in that context. macrolock is used to limit a macro to be executed by one call at a time.

Definition at line 4393 of file pbx.c.

References ast_get_context_name(), ast_hashtab_lookup(), ast_mutex_unlock(), ast_rdlock_contexts(), ast_unlock_contexts(), ast_walk_contexts(), ast_context::macrolock, and fake_context::name.

Referenced by _macro_exec().

{
   struct ast_context *c = NULL;
   int ret = -1;
   struct fake_context item;

   ast_rdlock_contexts();

   strncpy(item.name, context, 256);
   c = ast_hashtab_lookup(contexts_table,&item);
   if (c)
      ret = 0;
#ifdef NOTNOW

   while ((c = ast_walk_contexts(c))) {
      if (!strcmp(ast_get_context_name(c), context)) {
         ret = 0;
         break;
      }
   }

#endif
   ast_unlock_contexts();

   /* if we found context, unlock macrolock */
   if (ret == 0) 
      ret = ast_mutex_unlock(&c->macrolock);

   return ret;
}

int ast_context_verify_includes

(

struct ast_context *

con

)

Verifies includes in an ast_contect structure.

Parameters:

con

context in which to verify the includes

Return values:

	0	if no problems found
	-1	if there were any missing context

Definition at line 8590 of file pbx.c.

References ast_context_find(), ast_get_context_name(), ast_log(), ast_walk_context_includes(), LOG_WARNING, and ast_include::rname.

Referenced by pbx_load_module().

{
   struct ast_include *inc = NULL;
   int res = 0;

   while ( (inc = ast_walk_context_includes(con, inc)) ) {
      if (ast_context_find(inc->rname))
         continue;

      res = -1;
      ast_log(LOG_WARNING, "Context '%s' tries to include nonexistent context '%s'\n",
         ast_get_context_name(con), inc->rname);
      break;
   }

   return res;
}

struct ast_custom_function* ast_custom_function_find

(

const char *

name

)

[read]

Definition at line 2685 of file pbx.c.

References ast_custom_function::acflist, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, and ast_custom_function::name.

Referenced by ast_func_read(), ast_func_write(), config_curl(), destroy_curl(), handle_show_function(), op_func(), realtime_curl(), realtime_multi_curl(), store_curl(), and update_curl().

{
   struct ast_custom_function *acf = NULL;

   AST_RWLIST_RDLOCK(&acf_root);
   AST_RWLIST_TRAVERSE(&acf_root, acf, acflist) {
      if (!strcmp(name, acf->name))
         break;
   }
   AST_RWLIST_UNLOCK(&acf_root);

   return acf;
}

int ast_custom_function_unregister

(

struct ast_custom_function *

acf

)

Unregister a custom function.

Definition at line 2699 of file pbx.c.

References ast_custom_function::acflist, AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, and ast_custom_function::name.

Referenced by reload(), and unload_module().

{
   struct ast_custom_function *cur;

   if (!acf)
      return -1;

   AST_RWLIST_WRLOCK(&acf_root);
   if ((cur = AST_RWLIST_REMOVE(&acf_root, acf, acflist)))
      ast_verb(2, "Unregistered custom function %s\n", cur->name);
   AST_RWLIST_UNLOCK(&acf_root);

   return cur ? 0 : -1;
}

enum ast_extension_states ast_devstate_to_extenstate

(

enum ast_device_state

devstate

)

Map devstate to an extension state.

Parameters:

[in]

device

state

Returns:

the extension state mapping.

Definition at line 3175 of file pbx.c.

References AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, AST_DEVICE_TOTAL, AST_DEVICE_UNAVAILABLE, AST_DEVICE_UNKNOWN, AST_EXTENSION_BUSY, AST_EXTENSION_INUSE, AST_EXTENSION_NOT_INUSE, AST_EXTENSION_ONHOLD, AST_EXTENSION_RINGING, and AST_EXTENSION_UNAVAILABLE.

Referenced by ast_extension_state2().

{
   switch (devstate) {
   case AST_DEVICE_ONHOLD:
      return AST_EXTENSION_ONHOLD;
   case AST_DEVICE_BUSY:
      return AST_EXTENSION_BUSY;
   case AST_DEVICE_UNAVAILABLE:
   case AST_DEVICE_UNKNOWN:
   case AST_DEVICE_INVALID:
      return AST_EXTENSION_UNAVAILABLE;
   case AST_DEVICE_RINGINUSE:
      return (AST_EXTENSION_INUSE | AST_EXTENSION_RINGING);
   case AST_DEVICE_RINGING:
      return AST_EXTENSION_RINGING;
   case AST_DEVICE_INUSE:
      return AST_EXTENSION_INUSE;
   case AST_DEVICE_NOT_INUSE:
      return AST_EXTENSION_NOT_INUSE;
   case AST_DEVICE_TOTAL: /* not a device state, included for completeness */
      break;
   }

   return AST_EXTENSION_NOT_INUSE;
}

int ast_exists_extension	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten,
		int	priority,
		const char *	callerid
	)

Determine whether an extension exists.

Parameters:

	c	this is not important
	context	which context to look in
	exten	which extension to search for
	priority	priority of the action within the extension
	callerid	callerid to search for

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

Returns:

If an extension within the given context(or callerid) with the given priority is found a non zero value will be returned. Otherwise, 0 is returned.

Definition at line 3559 of file pbx.c.

References E_MATCH, and pbx_extension_helper().

Referenced by __ast_goto_if_exists(), __ast_pbx_run(), _macro_exec(), acf_isexten_exec(), answer_call(), ast_app_dtget(), ast_bridge_call(), ast_pbx_outgoing_exten(), builtin_atxfer(), builtin_blindtransfer(), cb_events(), cli_console_dial(), conf_run(), console_dial(), console_transfer(), dahdi_handle_dtmfup(), dial_exec_full(), disa_exec(), dp_lookup(), dundi_lookup_local(), get_also_info(), get_destination(), get_refer_info(), gosub_exec(), handle_gosub(), handle_link_data(), handle_link_phone_dtmf(), handle_stimulus_message(), isexten_function_read(), leave_voicemail(), local_alloc(), local_devicestate(), local_dtmf_helper(), loopback_exists(), metermaidstate(), mgcp_ss(), minivm_greet_exec(), misdn_overlap_dial_task(), park_space_reserve(), parkandannounce_exec(), pbx_builtin_waitexten(), phone_check_exception(), process_ast_dsp(), readexten_exec(), register_peer_exten(), skinny_ss(), socket_process(), ss_thread(), and waitstream_core().

{
   return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCH, 0, 0);
}

int ast_explicit_goto	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Note:

This function will handle locking the channel as needed.

Definition at line 6450 of file pbx.c.

References ast_channel_lock, ast_channel_unlock, ast_copy_string(), AST_FLAG_IN_AUTOLOOP, ast_strlen_zero(), ast_test_flag, ast_channel::context, ast_channel::exten, and ast_channel::priority.

Referenced by __ast_goto_if_exists(), ast_async_goto(), builtin_atxfer(), disa_exec(), do_bridge_masquerade(), handle_setpriority(), pbx_parseable_goto(), and return_exec().

{
   if (!chan)
      return -1;

   ast_channel_lock(chan);

   if (!ast_strlen_zero(context))
      ast_copy_string(chan->context, context, sizeof(chan->context));
   if (!ast_strlen_zero(exten))
      ast_copy_string(chan->exten, exten, sizeof(chan->exten));
   if (priority > -1) {
      chan->priority = priority;
      /* see flag description in channel.h for explanation */
      if (ast_test_flag(chan, AST_FLAG_IN_AUTOLOOP))
         chan->priority--;
   }

   ast_channel_unlock(chan);

   return 0;
}

int ast_extension_close	(	const char *	pattern,
		const char *	data,
		int	needmore
	)

Definition at line 1978 of file pbx.c.

References ast_log(), E_CANMATCH, E_MATCHMORE, extension_match_core(), and LOG_WARNING.

Referenced by lua_find_extension(), and realtime_switch_common().

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

int ast_extension_cmp	(	const char *	a,
		const char *	b
	)

Determine if one extension should match before another.

Parameters:

	a	extension to compare with b
	b	extension to compare with a

Checks whether or extension a should match before extension b

Return values:

	0	if the two extensions have equal matching priority
	1	on a > b
	-1	on a < b

Definition at line 1780 of file pbx.c.

References ext_cmp().

Referenced by lua_extension_cmp().

{
   return ext_cmp(a, b);
}

int ast_extension_match	(	const char *	pattern,
		const char *	extension
	)

Determine if a given extension matches a given pattern (in NXX format).

Parameters:

	pattern	pattern to match
	extension	extension to check against the pattern.

Checks whether or not the given extension matches the given pattern.

Return values:

	1	on match
	0	on failure

Definition at line 1973 of file pbx.c.

References E_MATCH, and extension_match_core().

Referenced by ast_ignore_pattern(), do_say(), find_matching_priority(), load_module(), loopback_canmatch(), loopback_exists(), loopback_matchmore(), lua_find_extension(), manager_show_dialplan_helper(), matchcid(), misdn_cfg_is_msn_valid(), realtime_switch_common(), reload(), and show_dialplan_helper().

{
   return extension_match_core(pattern, data, E_MATCH);
}

int ast_extension_patmatch	(	const char *	pattern,
		const char *	data
	)

int ast_extension_state	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten
	)

Uses hint and devicestate callback to get the state of an extension.

Parameters:

	c	this is not important
	context	which context to look in
	exten	which extension to get state

Returns:

extension state as defined in the ast_extension_states enum

Definition at line 3236 of file pbx.c.

References ast_extension_state2(), and ast_hint_extension().

Referenced by action_extensionstate(), extstate_read(), and handle_request_subscribe().

{
   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 */
}

const char* ast_extension_state2str

(

int

extension_state

)

Return string representation of the state of an extension.

Parameters:

extension_state

is the numerical state delivered by ast_extension_state

Returns:

the state of an extension as string

Definition at line 3224 of file pbx.c.

References ARRAY_LEN, extension_states, and cfextension_states::text.

Referenced by cb_extensionstate(), handle_request_subscribe(), handle_show_hint(), handle_show_hints(), and show_channels_cb().

{
   int i;

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

int ast_extension_state_add	(	const char *	context,
		const char *	exten,
		ast_state_cb_type	callback,
		void *	data
	)

Registers a state change callback.

Parameters:

	context	which context to look in
	exten	which extension to get state
	callback	callback to call if state changed
	data	to pass to callback

The callback is called if the state of an extension is changed.

Return values:

	-1	on failure
	ID	on success

Definition at line 3334 of file pbx.c.

References ast_calloc, ast_hint_extension(), AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_state_cb::callback, ast_hint::callbacks, ast_state_cb::data, ast_hint::exten, ast_state_cb::id, ast_sw::list, and ast_state_cb::next.

Referenced by __init_manager(), handle_request_subscribe(), and skinny_register().

{
   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_RWLIST_WRLOCK(&hints);

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

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

      cblist->next = statecbs;
      statecbs = cblist;

      AST_RWLIST_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_RWLIST_WRLOCK(&hints);

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

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

   /* Now insert the callback in the callback list  */
   if (!(cblist = ast_calloc(1, sizeof(*cblist)))) {
      AST_RWLIST_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_RWLIST_UNLOCK(&hints);
   return cblist->id;
}

int ast_extension_state_del	(	int	id,
		ast_state_cb_type	callback
	)

Deletes a registered state change callback by ID.

Parameters:

	id	of the callback to delete
	callback	callback

Removes the callback from list of callbacks

Return values:

	0	success
	-1	failure

Definition at line 3409 of file pbx.c.

References ast_free, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_hint::callbacks, ast_sw::list, and ast_state_cb::next.

Referenced by __sip_destroy(), handle_request_subscribe(), and skinny_unregister().

{
   struct ast_state_cb **p_cur = NULL; /* address of pointer to us */
   int ret = -1;

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

   AST_RWLIST_WRLOCK(&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_RWLIST_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;
      ast_free(cur);
      ret = 0;
   }
   AST_RWLIST_UNLOCK(&hints);
   return ret;
}

int ast_findlabel_extension	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten,
		const char *	label,
		const char *	callerid
	)

Find the priority of an extension that has the specified label.

Parameters:

	c	this is not important
	context	which context to look in
	exten	which extension to search for
	label	label of the action within the extension to match to priority
	callerid	callerid to search for

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

Return values:

	the	priority which matches the given label in the extension
	-1	if not found.

Definition at line 3564 of file pbx.c.

References E_FINDLABEL, and pbx_extension_helper().

Referenced by action_originate(), action_redirect(), handle_gosub(), handle_setpriority(), isexten_function_read(), and pbx_parseable_goto().

{
   return pbx_extension_helper(c, NULL, context, exten, 0, label, callerid, E_FINDLABEL, 0, 0);
}

int ast_findlabel_extension2	(	struct ast_channel *	c,
		struct ast_context *	con,
		const char *	exten,
		const char *	label,
		const char *	callerid
	)

Find the priority of an extension that has the specified label.

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

This function is the same as ast_findlabel_extension, except that it accepts a pointer to an ast_context structure to specify the context instead of the name of the context. Otherwise, the functions behave the same.

Definition at line 3569 of file pbx.c.

References E_FINDLABEL, and pbx_extension_helper().

Referenced by pbx_load_config().

{
   return pbx_extension_helper(c, con, NULL, exten, 0, label, callerid, E_FINDLABEL, 0, 0);
}

int ast_func_read	(	struct ast_channel *	chan,
		const char *	function,
		char *	workspace,
		size_t	len
	)

executes a read operation on a function

Parameters:

	chan	Channel to execute on
	function	Data containing the function call string (will be modified)
	workspace	A pointer to safe memory to use for a return value
	len	the number of bytes in workspace

This application executes a function in read mode on a given channel.

Returns:

zero on success, non-zero on failure

Definition at line 2772 of file pbx.c.

References __ast_module_user_add(), __ast_module_user_remove(), ast_custom_function_find(), ast_log(), ast_strdupa, copy(), func_args(), LOG_ERROR, ast_custom_function::mod, and ast_custom_function::read.

Referenced by action_getvar(), handle_getvariable(), lua_get_variable_value(), and pbx_substitute_variables_helper_full().

{
   char *copy = ast_strdupa(function);
   char *args = func_args(copy);
   struct ast_custom_function *acfptr = ast_custom_function_find(copy);

   if (acfptr == NULL)
      ast_log(LOG_ERROR, "Function %s not registered\n", copy);
   else if (!acfptr->read)
      ast_log(LOG_ERROR, "Function %s cannot be read\n", copy);
   else {
      int res;
      struct ast_module_user *u = NULL;
      if (acfptr->mod)
         u = __ast_module_user_add(acfptr->mod, chan);
      res = acfptr->read(chan, copy, args, workspace, len);
      if (acfptr->mod && u)
         __ast_module_user_remove(acfptr->mod, u);
      return res;
   }
   return -1;
}

int ast_func_write	(	struct ast_channel *	chan,
		const char *	function,
		const char *	value
	)

executes a write operation on a function

Parameters:

	chan	Channel to execute on
	function	Data containing the function call string (will be modified)
	value	A value parameter to pass for writing

This application executes a function in write mode on a given channel.

Returns:

zero on success, non-zero on failure

Definition at line 2795 of file pbx.c.

References __ast_module_user_add(), __ast_module_user_remove(), ast_custom_function_find(), ast_log(), ast_strdupa, copy(), func_args(), LOG_ERROR, ast_custom_function::mod, and ast_custom_function::write.

Referenced by pbx_builtin_pushvar_helper(), and pbx_builtin_setvar_helper().

{
   char *copy = ast_strdupa(function);
   char *args = func_args(copy);
   struct ast_custom_function *acfptr = ast_custom_function_find(copy);

   if (acfptr == NULL)
      ast_log(LOG_ERROR, "Function %s not registered\n", copy);
   else if (!acfptr->write)
      ast_log(LOG_ERROR, "Function %s cannot be written to\n", copy);
   else {
      int res;
      struct ast_module_user *u = NULL;
      if (acfptr->mod)
         u = __ast_module_user_add(acfptr->mod, chan);
      res = acfptr->write(chan, copy, args, value);
      if (acfptr->mod && u)
         __ast_module_user_remove(acfptr->mod, u);
      return res;
   }

   return -1;
}

const char* ast_get_context_name

(

struct ast_context *

con

)

Definition at line 8442 of file pbx.c.

References ast_context::name.

Referenced by _macro_exec(), ast_context_add_include2(), ast_context_add_switch2(), ast_context_lockmacro(), ast_context_remove_include2(), ast_context_remove_switch2(), ast_context_unlockmacro(), ast_context_verify_includes(), complete_dialplan_add_extension(), complete_dialplan_add_ignorepat(), complete_dialplan_add_include(), complete_dialplan_remove_extension(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), complete_show_dialplan_context(), context_merge_incls_swits_igps_other_registrars(), dundi_precache_full(), find_context_locked(), find_matching_endwhile(), find_matching_priority(), handle_cli_dialplan_save(), handle_show_hint(), handle_show_hints(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return con ? con->name : NULL;
}

const char* ast_get_context_registrar

(

struct ast_context *

c

)

Definition at line 8480 of file pbx.c.

References ast_context::registrar.

Referenced by handle_cli_dialplan_save(), and show_dialplan_helper().

{
   return c ? c->registrar : NULL;
}

const char* ast_get_extension_app

(

struct ast_exten *

e

)

Definition at line 8510 of file pbx.c.

References ast_exten::app.

Referenced by _macro_exec(), ast_add_hint_nolock(), ast_extension_state2(), ast_get_hint(), find_matching_endwhile(), handle_cli_dialplan_save(), handle_show_hint(), handle_show_hints(), handle_statechange(), manager_show_dialplan_helper(), and print_ext().

{
   return e ? e->app : NULL;
}

void* ast_get_extension_app_data

(

struct ast_exten *

e

)

Definition at line 8515 of file pbx.c.

References ast_exten::data.

Referenced by _macro_exec(), ast_get_hint(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and print_ext().

{
   return e ? e->data : NULL;
}

const char* ast_get_extension_cidmatch

(

struct ast_exten *

e

)

Definition at line 8505 of file pbx.c.

References ast_exten::cidmatch.

Referenced by complete_dialplan_remove_extension(), find_matching_priority(), and handle_cli_dialplan_save().

{
   return e ? e->cidmatch : NULL;
}

struct ast_context* ast_get_extension_context

(

struct ast_exten *

exten

)

[read]

Definition at line 8447 of file pbx.c.

References ast_exten::parent.

Referenced by handle_show_hint(), and handle_show_hints().

{
   return exten ? exten->parent : NULL;
}

const char* ast_get_extension_label

(

struct ast_exten *

e

)

Definition at line 8457 of file pbx.c.

References ast_exten::label.

Referenced by handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return exten ? exten->label : NULL;
}

int ast_get_extension_matchcid

(

struct ast_exten *

e

)

Definition at line 8500 of file pbx.c.

References ast_exten::matchcid.

Referenced by complete_dialplan_remove_extension(), find_matching_priority(), and handle_cli_dialplan_save().

{
   return e ? e->matchcid : 0;
}

const char* ast_get_extension_name

(

struct ast_exten *

exten

)

Definition at line 8452 of file pbx.c.

References ast_exten::exten.

Referenced by ast_add_hint_nolock(), complete_core_show_hint(), complete_dialplan_remove_extension(), dundi_precache_full(), find_matching_priority(), handle_cli_dialplan_save(), handle_show_hint(), handle_show_hints(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return exten ? exten->exten : NULL;
}

int ast_get_extension_priority

(

struct ast_exten *

exten

)

Definition at line 8472 of file pbx.c.

References ast_exten::priority.

Referenced by complete_dialplan_remove_extension(), find_matching_priority(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and print_ext().

{
   return exten ? exten->priority : -1;
}

const char* ast_get_extension_registrar

(

struct ast_exten *

e

)

Definition at line 8485 of file pbx.c.

References ast_exten::registrar.

Referenced by handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return e ? e->registrar : NULL;
}

int ast_get_hint	(	char *	hint,
		int	hintsize,
		char *	name,
		int	namesize,
		struct ast_channel *	c,
		const char *	context,
		const char *	exten
	)

If an extension hint exists, return non-zero.

Parameters:

	hint	buffer for hint
	maxlen	size of hint buffer
	name	buffer for name portion of hint
	maxnamelen	size of name buffer
	c	this is not important
	context	which context to look in
	exten	which extension to search for

Returns:

If an extension within the given context with the priority PRIORITY_HINT is found a non zero value will be returned. Otherwise, 0 is returned.

Definition at line 3542 of file pbx.c.

References ast_copy_string(), ast_get_extension_app(), ast_get_extension_app_data(), and ast_hint_extension().

Referenced by action_extensionstate(), get_cid_name(), get_destination(), hint_read(), manager_state_cb(), pbx_retrieve_variable(), skinny_extensionstate_cb(), and transmit_state_notify().

{
   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;
}

const char* ast_get_ignorepat_name

(

struct ast_ignorepat *

ip

)

Definition at line 8467 of file pbx.c.

References ast_ignorepat::pattern.

Referenced by complete_dialplan_remove_ignorepat(), context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), lookup_c_ip(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return ip ? ip->pattern : NULL;
}

const char* ast_get_ignorepat_registrar

(

struct ast_ignorepat *

ip

)

Definition at line 8495 of file pbx.c.

References ast_ignorepat::registrar.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return ip ? ip->registrar : NULL;
}

const char* ast_get_include_name

(

struct ast_include *

include

)

Definition at line 8462 of file pbx.c.

References ast_include::name.

Referenced by complete_dialplan_remove_include(), context_merge_incls_swits_igps_other_registrars(), find_matching_priority(), handle_cli_dialplan_save(), lookup_ci(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return inc ? inc->name : NULL;
}

const char* ast_get_include_registrar

(

struct ast_include *

i

)

Definition at line 8490 of file pbx.c.

References ast_include::registrar.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return i ? i->registrar : NULL;
}

const char* ast_get_switch_data

(

struct ast_sw *

sw

)

Definition at line 8525 of file pbx.c.

References ast_sw::data.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return sw ? sw->data : NULL;
}

int ast_get_switch_eval

(

struct ast_sw *

sw

)

Definition at line 8530 of file pbx.c.

References ast_sw::eval.

Referenced by context_merge_incls_swits_igps_other_registrars().

{
   return sw->eval;
}

const char* ast_get_switch_name

(

struct ast_sw *

sw

)

Definition at line 8520 of file pbx.c.

References ast_sw::name.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return sw ? sw->name : NULL;
}

const char* ast_get_switch_registrar

(

struct ast_sw *

sw

)

Definition at line 8535 of file pbx.c.

References ast_sw::registrar.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return sw ? sw->registrar : NULL;
}

int ast_goto_if_exists	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Note:

This function will handle locking the channel as needed.

Definition at line 8628 of file pbx.c.

References __ast_goto_if_exists().

Referenced by background_detect_exec(), channel_spy(), common_exec(), conf_run(), goto_exten(), onedigit_goto(), select_entry(), and valid_exit().

{
   return __ast_goto_if_exists(chan, context, exten, priority, 0);
}

int ast_hashtab_compare_contexts	(	const void *	ah_a,
		const void *	ah_b
	)

unsigned int ast_hashtab_hash_contexts

(

const void *

obj

)

int ast_ignore_pattern	(	const char *	context,
		const char *	pattern
	)

Checks to see if a number should be ignored.

Parameters:

	context	context to search within
	pattern	to check whether it should be ignored or not

Check if a number should be ignored with respect to dialtone cancellation.

Return values:

	0	if the pattern should not be ignored
	non-zero	if the pattern should be ignored

Definition at line 6415 of file pbx.c.

References ast_context_find(), ast_extension_match(), ast_context::ignorepats, ast_ignorepat::next, and ast_ignorepat::pattern.

Referenced by ast_app_dtget(), disa_exec(), dp_lookup(), dundi_lookup_local(), handle_enbloc_call_message(), handle_soft_key_event_message(), handle_stimulus_message(), mgcp_ss(), skinny_ss(), and ss_thread().

{
   struct ast_context *con = ast_context_find(context);
   if (con) {
      struct ast_ignorepat *pat;
      for (pat = con->ignorepats; pat; pat = pat->next) {
         if (ast_extension_match(pat->pattern, pattern))
            return 1;
      }
   }

   return 0;
}

int ast_matchmore_extension	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten,
		int	priority,
		const char *	callerid
	)

Looks to see if adding anything to this extension might match something. (exists ^ canmatch).

Parameters:

	c	not really important XXX
	context	context to serach within
	exten	extension to check
	priority	priority of extension path
	callerid	callerid of extension being searched for

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

Returns:

If "exten" *could match* a valid extension in this context with some more digits, return non-zero. Does NOT return non-zero if this is an exact-match only. Basically, when this returns 0, no matter what you add to exten, it's not going to be a valid extension anymore

Definition at line 3579 of file pbx.c.

References E_MATCHMORE, and pbx_extension_helper().

Referenced by ast_app_dtget(), collect_digits(), disa_exec(), dp_lookup(), dundi_lookup_local(), loopback_matchmore(), mgcp_ss(), pbx_builtin_background(), readexten_exec(), skinny_ss(), and ss_thread().

{
   return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCHMORE, 0, 0);
}

void ast_merge_contexts_and_delete	(	struct ast_context **	extcontexts,
		struct ast_hashtab *	exttable,
		const char *	registrar
	)

Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added.

Parameters:

	extcontexts	pointer to the ast_context structure
	exttable	pointer to the ast_hashtab structure that contains all the elements in extcontexts
	registrar	of the context; if it's set the routine will delete all contexts that belong to that registrar; if NULL only the contexts that are specified in extcontexts

Definition at line 5777 of file pbx.c.

References __ast_internal_context_destroy(), ast_calloc, AST_EXTENSION_REMOVED, ast_free, ast_hashtab_destroy(), ast_hashtab_end_traversal(), ast_hashtab_next(), ast_hashtab_start_traversal(), AST_LIST_HEAD_INIT_VALUE, AST_LIST_INSERT_HEAD, AST_LIST_REMOVE_HEAD, ast_log(), ast_rdlock_contexts(), AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_tvdiff_us(), ast_tvnow(), ast_unlock_contexts(), ast_verb, ast_wrlock_contexts(), ast_wrlock_contexts_version(), ast_state_cb::callback, ast_hint::callbacks, context, context_merge(), ast_state_cb::data, E_MATCH, ast_exten::exten, ast_hint::exten, ast_hint::laststate, ast_sw::list, LOG_WARNING, ast_context::name, ast_context::next, ast_sw::next, ast_state_cb::next, ast_exten::parent, pbx_find_extension(), PRIORITY_HINT, ast_context::registrar, and pbx_find_info::stacklen.

Referenced by lua_reload_extensions(), and pbx_load_module().

{
   double ft;
   struct ast_context *tmp, *oldcontextslist;
   struct ast_hashtab *oldtable;
   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;
   struct ast_hashtab_iter *iter;
   
   /* 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
   */
   
   struct timeval begintime, writelocktime, endlocktime, enddeltime;
   int wrlock_ver;
   
   begintime = ast_tvnow();
   ast_rdlock_contexts();
   iter = ast_hashtab_start_traversal(contexts_table);
   while ((tmp=ast_hashtab_next(iter))) {
      context_merge(extcontexts, exttable, tmp, registrar);
   }
   ast_hashtab_end_traversal(iter);
   wrlock_ver = ast_wrlock_contexts_version();
   
   ast_unlock_contexts(); /* this feels real retarded, but you must do
                       what you must do If this isn't done, the following 
                        wrlock is a guraranteed deadlock */
   ast_wrlock_contexts();
   if (ast_wrlock_contexts_version() > wrlock_ver+1) {
      ast_log(LOG_WARNING,"==================!!!!!!!!!!!!!!!Something changed the contexts in the middle of merging contexts!\n");
   }
   
   AST_RWLIST_WRLOCK(&hints);
   writelocktime = ast_tvnow();

   /* preserve all watchers for hints associated with this registrar */
   AST_RWLIST_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);
      }
   }

   /* save the old table and list */
   oldtable = contexts_table;
   oldcontextslist = contexts;

   /* move in the new table and list */
   contexts_table = exttable;
   contexts = *extcontexts;
   
   /* restore the watchers for hints that can be found; notify those that
      cannot be restored
   */
   while ((this = AST_LIST_REMOVE_HEAD(&store, list))) {
      struct pbx_find_info q = { .stacklen = 0 };
      exten = pbx_find_extension(NULL, NULL, &q, this->context, this->exten, PRIORITY_HINT, NULL, "", E_MATCH);
      /* Find the hint in the list of hints */
      AST_RWLIST_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);
            ast_free(prevcb);
            }
      } else {
         thiscb = this->callbacks;
         while (thiscb->next)
            thiscb = thiscb->next;
         thiscb->next = hint->callbacks;
         hint->callbacks = this->callbacks;
         hint->laststate = this->laststate;
      }
      ast_free(this);
   }

   AST_RWLIST_UNLOCK(&hints);
   ast_unlock_contexts();
   endlocktime = ast_tvnow();
   
   /* the old list and hashtab no longer are relevant, delete them while the rest of asterisk
      is now freely using the new stuff instead */
   
   ast_hashtab_destroy(oldtable, NULL);
   
   for (tmp = oldcontextslist; tmp; ) {
      struct ast_context *next;  /* next starting point */
      next = tmp->next;
      __ast_internal_context_destroy(tmp);
      tmp = next;
   }
   enddeltime = ast_tvnow();
   
   ft = ast_tvdiff_us(writelocktime, begintime);
   ft /= 1000000.0;
   ast_verb(3,"Time to scan old dialplan and merge leftovers back into the new: %8.6f sec\n", ft);
   
   ft = ast_tvdiff_us(endlocktime, writelocktime);
   ft /= 1000000.0;
   ast_verb(3,"Time to restore hints and swap in new dialplan: %8.6f sec\n", ft);

   ft = ast_tvdiff_us(enddeltime, endlocktime);
   ft /= 1000000.0;
   ast_verb(3,"Time to delete the old dialplan: %8.6f sec\n", ft);

   ft = ast_tvdiff_us(enddeltime, begintime);
   ft /= 1000000.0;
   ast_verb(3,"Total time merge_contexts_delete: %8.6f sec\n", ft);
   return;
}

int ast_parseable_goto	(	struct ast_channel *	chan,
		const char *	goto_string
	)

Note:

I can find neither parsable nor parseable at dictionary.com, but google gives me 169000 hits for parseable and only 49,800 for parsable

This function will handle locking the channel as needed.

Definition at line 8691 of file pbx.c.

References pbx_parseable_goto().

Referenced by _while_exec(), check_goto_on_transfer(), dial_exec_full(), gosub_exec(), ivr_dispatch(), parkandannounce_exec(), pbx_builtin_goto(), rpt_exec(), and while_continue_exec().

{
   return pbx_parseable_goto(chan, goto_string, 0);
}

int ast_pbx_outgoing_app	(	const char *	type,
		int	format,
		void *	data,
		int	timeout,
		const char *	app,
		const char *	appdata,
		int *	reason,
		int	sync,
		const char *	cid_num,
		const char *	cid_name,
		struct ast_variable *	vars,
		const char *	account,
		struct ast_channel **	locked_channel
	)

Synchronously or asynchronously make an outbound call and send it to a particular application with given extension

Definition at line 7231 of file pbx.c.

References __ast_request_and_dial(), ast_channel::_state, outgoing_helper::account, async_stat::app, app_tmp::app, async_stat::appdata, ast_calloc, ast_cdr_disposition(), ast_cdr_failed(), ast_cdr_setaccount(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), ast_free, ast_hangup(), ast_log(), ast_pbx_outgoing_cdr_failed(), ast_pbx_run_app(), ast_pthread_create_detached, ast_set_variables(), AST_STATE_UP, ast_strlen_zero(), ast_variables_destroy(), ast_verb, async_wait(), ast_channel::cdr, async_stat::chan, app_tmp::chan, app_tmp::data, errno, ast_channel::hangupcause, LOG_WARNING, ast_channel::name, async_stat::p, app_tmp::t, async_stat::timeout, and outgoing_helper::vars.

Referenced by action_originate(), attempt_thread(), fast_originate(), and orig_app().

{
   struct ast_channel *chan;
   struct app_tmp *tmp;
   int res = -1, cdr_res = -1;
   struct outgoing_helper oh;

   memset(&oh, 0, sizeof(oh));
   oh.vars = vars;
   oh.account = account;

   if (locked_channel)
      *locked_channel = NULL;
   if (ast_strlen_zero(app)) {
      res = -1;
      goto outgoing_app_cleanup;
   }
   if (sync) {
      chan = __ast_request_and_dial(type, format, data, timeout, reason, cid_num, cid_name, &oh);
      if (chan) {
         ast_set_variables(chan, vars);
         if (account)
            ast_cdr_setaccount(chan, account);
         if (chan->_state == AST_STATE_UP) {
            res = 0;
            ast_verb(4, "Channel %s was answered.\n", chan->name);
            tmp = ast_calloc(1, sizeof(*tmp));
            if (!tmp)
               res = -1;
            else {
               ast_copy_string(tmp->app, app, sizeof(tmp->app));
               if (appdata)
                  ast_copy_string(tmp->data, appdata, sizeof(tmp->data));
               tmp->chan = chan;
               if (sync > 1) {
                  if (locked_channel)
                     ast_channel_unlock(chan);
                  ast_pbx_run_app(tmp);
               } else {
                  if (locked_channel)
                     ast_channel_lock(chan);
                  if (ast_pthread_create_detached(&tmp->t, NULL, ast_pbx_run_app, tmp)) {
                     ast_log(LOG_WARNING, "Unable to spawn execute thread on %s: %s\n", chan->name, strerror(errno));
                     ast_free(tmp);
                     if (locked_channel)
                        ast_channel_unlock(chan);
                     ast_hangup(chan);
                     res = -1;
                  } else {
                     if (locked_channel)
                        *locked_channel = chan;
                  }
               }
            }
         } else {
            ast_verb(4, "Channel %s was never answered.\n", chan->name);
            if (chan->cdr) { /* update the cdr */
               /* here we update the status of the call, which sould be busy.
                * if that fails then we set the status to failed */
               if (ast_cdr_disposition(chan->cdr, chan->hangupcause))
                  ast_cdr_failed(chan->cdr);
            }
            ast_hangup(chan);
         }
      }

      if (res < 0) { /* the call failed for some reason */
         if (*reason == 0) { /* if the call failed (not busy or no answer)
                        * update the cdr with the failed message */
            cdr_res = ast_pbx_outgoing_cdr_failed();
            if (cdr_res != 0) {
               res = cdr_res;
               goto outgoing_app_cleanup;
            }
         }
      }

   } else {
      struct async_stat *as;
      if (!(as = ast_calloc(1, sizeof(*as)))) {
         res = -1;
         goto outgoing_app_cleanup;
      }
      chan = __ast_request_and_dial(type, format, data, timeout, reason, cid_num, cid_name, &oh);
      if (!chan) {
         ast_free(as);
         res = -1;
         goto outgoing_app_cleanup;
      }
      as->chan = chan;
      ast_copy_string(as->app, app, sizeof(as->app));
      if (appdata)
         ast_copy_string(as->appdata,  appdata, sizeof(as->appdata));
      as->timeout = timeout;
      ast_set_variables(chan, vars);
      if (account)
         ast_cdr_setaccount(chan, account);
      /* Start a new thread, and get something handling this channel. */
      if (locked_channel)
         ast_channel_lock(chan);
      if (ast_pthread_create_detached(&as->p, NULL, async_wait, as)) {
         ast_log(LOG_WARNING, "Failed to start async wait\n");
         ast_free(as);
         if (locked_channel)
            ast_channel_unlock(chan);
         ast_hangup(chan);
         res = -1;
         goto outgoing_app_cleanup;
      } else {
         if (locked_channel)
            *locked_channel = chan;
      }
      res = 0;
   }
outgoing_app_cleanup:
   ast_variables_destroy(vars);
   return res;
}

int ast_pbx_outgoing_exten	(	const char *	type,
		int	format,
		void *	data,
		int	timeout,
		const char *	context,
		const char *	exten,
		int	priority,
		int *	reason,
		int	sync,
		const char *	cid_num,
		const char *	cid_name,
		struct ast_variable *	vars,
		const char *	account,
		struct ast_channel **	locked_channel
	)

Synchronously or asynchronously make an outbound call and send it to a particular extension

Definition at line 7065 of file pbx.c.

References __ast_request_and_dial(), ast_channel::_state, outgoing_helper::account, ast_calloc, ast_cdr_disposition(), ast_cdr_failed(), ast_cdr_setaccount(), ast_channel_alloc, ast_channel_lock, ast_channel_unlock, ast_copy_string(), ast_exists_extension(), ast_free, ast_hangup(), ast_log(), ast_pbx_outgoing_cdr_failed(), ast_pbx_run(), ast_pbx_start(), ast_pthread_create_detached, ast_request_and_dial(), ast_set_variables(), AST_STATE_DOWN, AST_STATE_UP, ast_strlen_zero(), ast_variables_destroy(), ast_verb, async_wait(), ast_channel::cdr, async_stat::chan, outgoing_helper::cid_name, outgoing_helper::cid_num, async_stat::context, ast_channel::context, outgoing_helper::context, outgoing_helper::exten, ast_channel::hangupcause, LOG_ERROR, LOG_WARNING, ast_channel::name, async_stat::p, outgoing_helper::parent_channel, pbx_builtin_setvar_helper(), outgoing_helper::priority, set_ext_pri(), async_stat::timeout, and outgoing_helper::vars.

Referenced by action_originate(), attempt_thread(), fast_originate(), and orig_exten().

{
   struct ast_channel *chan;
   struct async_stat *as;
   int res = -1, cdr_res = -1;
   struct outgoing_helper oh;

   if (sync) {
      oh.context = context;
      oh.exten = exten;
      oh.priority = priority;
      oh.cid_num = cid_num;
      oh.cid_name = cid_name;
      oh.account = account;
      oh.vars = vars;
      oh.parent_channel = NULL;

      chan = __ast_request_and_dial(type, format, data, timeout, reason, cid_num, cid_name, &oh);
      if (channel) {
         *channel = chan;
         if (chan)
            ast_channel_lock(chan);
      }
      if (chan) {
         if (chan->_state == AST_STATE_UP) {
               res = 0;
            ast_verb(4, "Channel %s was answered.\n", chan->name);

            if (sync > 1) {
               if (channel)
                  ast_channel_unlock(chan);
               if (ast_pbx_run(chan)) {
                  ast_log(LOG_ERROR, "Unable to run PBX on %s\n", chan->name);
                  if (channel)
                     *channel = NULL;
                  ast_hangup(chan);
                  chan = NULL;
                  res = -1;
               }
            } else {
               if (ast_pbx_start(chan)) {
                  ast_log(LOG_ERROR, "Unable to start PBX on %s\n", chan->name);
                  if (channel) {
                     *channel = NULL;
                     ast_channel_unlock(chan);
                  }
                  ast_hangup(chan);
                  res = -1;
               }
               chan = NULL;
            }
         } else {
            ast_verb(4, "Channel %s was never answered.\n", chan->name);

            if (chan->cdr) { /* update the cdr */
               /* here we update the status of the call, which sould be busy.
                * if that fails then we set the status to failed */
               if (ast_cdr_disposition(chan->cdr, chan->hangupcause))
                  ast_cdr_failed(chan->cdr);
            }

            if (channel) {
               *channel = NULL;
               ast_channel_unlock(chan);
            }
            ast_hangup(chan);
            chan = NULL;
         }
      }

      if (res < 0) { /* the call failed for some reason */
         if (*reason == 0) { /* if the call failed (not busy or no answer)
                        * update the cdr with the failed message */
            cdr_res = ast_pbx_outgoing_cdr_failed();
            if (cdr_res != 0) {
               res = cdr_res;
               goto outgoing_exten_cleanup;
            }
         }

         /* create a fake channel and execute the "failed" extension (if it exists) within the requested context */
         /* check if "failed" exists */
         if (ast_exists_extension(chan, context, "failed", 1, NULL)) {
            chan = ast_channel_alloc(0, AST_STATE_DOWN, 0, 0, "", "", "", 0, "OutgoingSpoolFailed");
            if (chan) {
               char failed_reason[4] = "";
               if (!ast_strlen_zero(context))
                  ast_copy_string(chan->context, context, sizeof(chan->context));
               set_ext_pri(chan, "failed", 1);
               ast_set_variables(chan, vars);
               snprintf(failed_reason, sizeof(failed_reason), "%d", *reason);
               pbx_builtin_setvar_helper(chan, "REASON", failed_reason);
               if (account)
                  ast_cdr_setaccount(chan, account);
               if (ast_pbx_run(chan)) {
                  ast_log(LOG_ERROR, "Unable to run PBX on %s\n", chan->name);
                  ast_hangup(chan);
               }
               chan = NULL;
            }
         }
      }
   } else {
      if (!(as = ast_calloc(1, sizeof(*as)))) {
         res = -1;
         goto outgoing_exten_cleanup;
      }
      chan = ast_request_and_dial(type, format, data, timeout, reason, cid_num, cid_name);
      if (channel) {
         *channel = chan;
         if (chan)
            ast_channel_lock(chan);
      }
      if (!chan) {
         ast_free(as);
         res = -1;
         goto outgoing_exten_cleanup;
      }
      as->chan = chan;
      ast_copy_string(as->context, context, sizeof(as->context));
      set_ext_pri(as->chan,  exten, priority);
      as->timeout = timeout;
      ast_set_variables(chan, vars);
      if (account)
         ast_cdr_setaccount(chan, account);
      if (ast_pthread_create_detached(&as->p, NULL, async_wait, as)) {
         ast_log(LOG_WARNING, "Failed to start async wait\n");
         ast_free(as);
         if (channel) {
            *channel = NULL;
            ast_channel_unlock(chan);
         }
         ast_hangup(chan);
         res = -1;
         goto outgoing_exten_cleanup;
      }
      res = 0;
   }
outgoing_exten_cleanup:
   ast_variables_destroy(vars);
   return res;
}

enum ast_pbx_result ast_pbx_run

(

struct ast_channel *

c

)

Execute the PBX in the current thread.

Parameters:

c

channel to run the pbx on

This executes the PBX on a given channel. It allocates a new PBX structure for the channel, and provides all PBX functionality. See ast_pbx_start for an asynchronous function to run the PBX in a new thread as opposed to the current one.

Return values:

	Zero	on success
	non-zero	on failure

Definition at line 3991 of file pbx.c.

References ast_pbx_run_args().

Referenced by ast_pbx_outgoing_exten(), async_wait(), mgcp_ss(), skinny_newcall(), ss_thread(), and unistim_ss().

{
   return ast_pbx_run_args(c, NULL);
}

enum ast_pbx_result ast_pbx_run_args	(	struct ast_channel *	c,
		struct ast_pbx_args *	args
	)

Execute the PBX in the current thread.

Parameters:

	c	channel to run the pbx on
	args	options for the pbx

This executes the PBX on a given channel. It allocates a new PBX structure for the channel, and provides all PBX functionality. See ast_pbx_start for an asynchronous function to run the PBX in a new thread as opposed to the current one.

Return values:

	Zero	on success
	non-zero	on failure

Definition at line 3976 of file pbx.c.

References __ast_pbx_run(), AST_PBX_CALL_LIMIT, AST_PBX_SUCCESS, decrease_call_count(), and increase_call_count().

Referenced by ast_pbx_run(), dial_exec_full(), handle_gosub(), and try_calling().

{
   enum ast_pbx_result res = AST_PBX_SUCCESS;

   if (increase_call_count(c)) {
      return AST_PBX_CALL_LIMIT;
   }

   res = __ast_pbx_run(c, args);

   decrease_call_count();

   return res;
}

enum ast_pbx_result ast_pbx_start

(

struct ast_channel *

c

)

Create a new thread and start the PBX.

Parameters:

c

channel to start the pbx on

See also:

ast_pbx_run for a synchronous function to run the PBX in the current thread, as opposed to starting a new one.

Return values:

	Zero	on success
	non-zero	on failure

Definition at line 3954 of file pbx.c.

References ast_log(), AST_PBX_CALL_LIMIT, AST_PBX_FAILED, AST_PBX_SUCCESS, ast_pthread_create_detached, decrease_call_count(), increase_call_count(), LOG_WARNING, and pbx_thread().

Referenced by __oh323_new(), alsa_new(), ast_async_goto(), ast_bridge_call_thread(), ast_iax2_new(), ast_pbx_outgoing_exten(), bridge_exec(), check_goto_on_transfer(), console_new(), dahdi_new(), dial_exec_full(), do_parking_thread(), gtalk_new(), gtalk_newcall(), handle_request_invite(), jingle_new(), jingle_newcall(), local_call(), mgcp_new(), nbs_new(), oss_new(), pbx_start_chan(), phone_new(), rpt_call(), sip_new(), skinny_new(), unistim_new(), and usbradio_new().

{
   pthread_t t;

   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. */
   if (ast_pthread_create_detached(&t, NULL, pbx_thread, c)) {
      ast_log(LOG_WARNING, "Failed to create new channel thread\n");
      decrease_call_count();
      return AST_PBX_FAILED;
   }

   return AST_PBX_SUCCESS;
}

int ast_processed_calls

(

void

)

Retrieve the total number of calls processed through the PBX since last restart.

Definition at line 4001 of file pbx.c.

Referenced by handle_chanlist(), and handle_showcalls().

{
   return totalcalls;
}

int ast_rdlock_context

(

struct ast_context *

con

)

Read locks a given context.

Parameters:

con

context to lock

Return values:

	0	on success
	-1	on failure

Definition at line 8429 of file pbx.c.

References ast_rwlock_rdlock(), and ast_context::lock.

Referenced by _macro_exec(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), dundi_precache_full(), find_matching_endwhile(), handle_cli_dialplan_save(), lookup_c_ip(), lookup_ci(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return ast_rwlock_rdlock(&con->lock);
}

int ast_rdlock_contexts

(

void

)

Read locks the context list.

Return values:

	0	on success
	-1	on error

Definition at line 8411 of file pbx.c.

References ast_rwlock_rdlock(), and conlock.

Referenced by _macro_exec(), ast_context_find(), ast_context_find_or_create(), ast_context_lockmacro(), ast_context_unlockmacro(), ast_hint_extension(), ast_merge_contexts_and_delete(), complete_dialplan_add_extension(), complete_dialplan_add_ignorepat(), complete_dialplan_add_include(), complete_dialplan_remove_extension(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), complete_show_dialplan_context(), dundi_precache_full(), find_context_locked(), find_matching_endwhile(), handle_cli_dialplan_save(), handle_statechange(), manager_show_dialplan_helper(), pbx_extension_helper(), show_dialplan_helper(), and unreference_cached_app().

{
   return ast_rwlock_rdlock(&conlock);
}

int ast_register_switch

(

struct ast_switch *

sw

)

Register an alternative dialplan switch.

Parameters:

sw

switch to register

This function registers a populated ast_switch structure with the asterisk switching architecture.

Returns:

0 on success, and other than 0 on failure

Definition at line 4476 of file pbx.c.

References ast_log(), AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sw::list, LOG_WARNING, and ast_switch::name.

Referenced by load_module().

{
   struct ast_switch *tmp;

   AST_RWLIST_WRLOCK(&switches);
   AST_RWLIST_TRAVERSE(&switches, tmp, list) {
      if (!strcasecmp(tmp->name, sw->name)) {
         AST_RWLIST_UNLOCK(&switches);
         ast_log(LOG_WARNING, "Switch '%s' already found\n", sw->name);
         return -1;
      }
   }
   AST_RWLIST_INSERT_TAIL(&switches, sw, list);
   AST_RWLIST_UNLOCK(&switches);

   return 0;
}

int ast_spawn_extension	(	struct ast_channel *	c,
		const char *	context,
		const char *	exten,
		int	priority,
		const char *	callerid,
		int *	found,
		int	combined_find_spawn
	)

Launch a new extension (i.e. new stack).

Parameters:

	c	not important
	context	which context to generate the extension within
	exten	new extension to add
	priority	priority of new extension
	callerid	callerid of extension
	found
	combined_find_spawn

This adds a new extension to the asterisk extension list.

Note:

It is possible for autoservice to be started and stopped on c during this function call, it is important that c is not locked prior to calling this. Otherwise a deadlock may occur

Return values:

	0	on success
	-1	on failure.

Definition at line 3584 of file pbx.c.

References E_SPAWN, and pbx_extension_helper().

Referenced by __ast_pbx_run(), _macro_exec(), ast_bridge_call(), dial_exec_full(), and loopback_exec().

{
   return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_SPAWN, found, combined_find_spawn);
}

int ast_unlock_context

(

struct ast_context *

con

)

Return values:

Unlocks

the given context

Parameters:

con

context to unlock

Return values:

	0	on success
	-1	on failure

Definition at line 8434 of file pbx.c.

References ast_rwlock_unlock(), and ast_context::lock.

Referenced by __ast_context_destroy(), _macro_exec(), ast_add_extension2_lockopt(), ast_context_add_ignorepat2(), ast_context_add_include2(), ast_context_add_switch2(), ast_context_remove_extension_callerid2(), ast_context_remove_ignorepat2(), ast_context_remove_include2(), ast_context_remove_switch2(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), dundi_precache_full(), find_matching_endwhile(), handle_cli_dialplan_save(), lookup_c_ip(), lookup_ci(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   return ast_rwlock_unlock(&con->lock);
}

int ast_unlock_contexts

(

void

)

Unlocks contexts.

Return values:

	0	on success
	-1	on failure

Definition at line 8416 of file pbx.c.

References ast_rwlock_unlock(), and conlock.

Referenced by _macro_exec(), ast_add_extension(), ast_context_add_ignorepat(), ast_context_add_include(), ast_context_add_switch(), ast_context_destroy(), ast_context_find(), ast_context_find_or_create(), ast_context_lockmacro(), ast_context_remove_extension_callerid(), ast_context_remove_ignorepat(), ast_context_remove_include(), ast_context_remove_switch(), ast_context_unlockmacro(), ast_hint_extension(), ast_merge_contexts_and_delete(), complete_dialplan_add_extension(), complete_dialplan_add_ignorepat(), complete_dialplan_add_include(), complete_dialplan_remove_extension(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), complete_show_dialplan_context(), dundi_precache_full(), find_context_locked(), find_matching_endwhile(), handle_cli_dialplan_save(), handle_statechange(), manager_show_dialplan_helper(), pbx_extension_helper(), show_dialplan_helper(), and unreference_cached_app().

{
   return ast_rwlock_unlock(&conlock);
}

void ast_unregister_switch

(

struct ast_switch *

sw

)

Unregister an alternative switch.

Parameters:

sw

switch to unregister

Unregisters a switch from asterisk.

Returns:

nothing

Definition at line 4494 of file pbx.c.

References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_sw::list.

Referenced by __unload_module(), and unload_module().

{
   AST_RWLIST_WRLOCK(&switches);
   AST_RWLIST_REMOVE(&switches, sw, list);
   AST_RWLIST_UNLOCK(&switches);
}

struct ast_exten* ast_walk_context_extensions	(	struct ast_context *	con,
		struct ast_exten *	priority
	)			[read]

Definition at line 8548 of file pbx.c.

References ast_exten::next, and ast_context::root.

Referenced by complete_dialplan_remove_extension(), dundi_precache_full(), find_matching_priority(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), pbx_find_extension(), show_dialplan_helper(), and unreference_cached_app().

{
   if (!exten)
      return con ? con->root : NULL;
   else
      return exten->next;
}

struct ast_ignorepat* ast_walk_context_ignorepats	(	struct ast_context *	con,
		struct ast_ignorepat *	ip
	)			[read]

Definition at line 8581 of file pbx.c.

References ast_context::ignorepats, and ast_ignorepat::next.

Referenced by complete_dialplan_remove_ignorepat(), context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), lookup_c_ip(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   if (!ip)
      return con ? con->ignorepats : NULL;
   else
      return ip->next;
}

struct ast_include* ast_walk_context_includes	(	struct ast_context *	con,
		struct ast_include *	inc
	)			[read]

Definition at line 8572 of file pbx.c.

References ast_context::includes, and ast_include::next.

Referenced by ast_context_verify_includes(), complete_dialplan_remove_include(), context_merge_incls_swits_igps_other_registrars(), find_matching_priority(), handle_cli_dialplan_save(), lookup_ci(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   if (!inc)
      return con ? con->includes : NULL;
   else
      return inc->next;
}

struct ast_sw* ast_walk_context_switches	(	struct ast_context *	con,
		struct ast_sw *	sw
	)			[read]

Definition at line 8557 of file pbx.c.

References ast_context::alts, AST_LIST_FIRST, AST_LIST_NEXT, and ast_sw::list.

Referenced by context_merge_incls_swits_igps_other_registrars(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), and show_dialplan_helper().

{
   if (!sw)
      return con ? AST_LIST_FIRST(&con->alts) : NULL;
   else
      return AST_LIST_NEXT(sw, list);
}

struct ast_context* ast_walk_contexts

(

struct ast_context *

con

)

[read]

Definition at line 8543 of file pbx.c.

References ast_context::next.

Referenced by _macro_exec(), ast_context_find(), ast_context_lockmacro(), ast_context_unlockmacro(), complete_dialplan_add_extension(), complete_dialplan_add_ignorepat(), complete_dialplan_add_include(), complete_dialplan_remove_extension(), complete_dialplan_remove_ignorepat(), complete_dialplan_remove_include(), complete_show_dialplan_context(), dundi_precache_full(), find_context_locked(), find_matching_endwhile(), find_matching_priority(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), pbx_find_extension(), pbx_load_module(), show_dialplan_helper(), and unreference_cached_app().

{
   return con ? con->next : contexts;
}

struct ast_exten* ast_walk_extension_priorities	(	struct ast_exten *	exten,
		struct ast_exten *	priority
	)			[read]

Definition at line 8566 of file pbx.c.

References ast_exten::peer.

Referenced by complete_dialplan_remove_extension(), find_matching_priority(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), pbx_find_extension(), show_dialplan_helper(), and unreference_cached_app().

{
   return priority ? priority->peer : exten;
}

int ast_wrlock_context

(

struct ast_context *

con

)

Write locks a given context.

Parameters:

con

context to lock

Return values:

	0	on success
	-1	on failure

Definition at line 8424 of file pbx.c.

References ast_rwlock_wrlock(), and ast_context::lock.

Referenced by __ast_context_destroy(), ast_add_extension2_lockopt(), ast_context_add_ignorepat2(), ast_context_add_include2(), ast_context_add_switch2(), ast_context_remove_extension_callerid2(), ast_context_remove_ignorepat2(), ast_context_remove_include2(), and ast_context_remove_switch2().

{
   return ast_rwlock_wrlock(&con->lock);
}

int ast_wrlock_contexts

(

void

)

Write locks the context list.

Return values:

	0	on success
	-1	on error

Definition at line 8403 of file pbx.c.

References ast_atomic_fetchadd_int(), ast_rwlock_wrlock(), conlock, and conlock_wrlock_version.

Referenced by ast_context_destroy(), ast_context_find_or_create(), ast_merge_contexts_and_delete(), and complete_dialplan_remove_include().

{
   int res = ast_rwlock_wrlock(&conlock);
   if (!res)
      ast_atomic_fetchadd_int(&conlock_wrlock_version, 1);
   return res;
}

int ast_wrlock_contexts_version

(

void

)

Definition at line 8395 of file pbx.c.

References conlock_wrlock_version.

Referenced by ast_merge_contexts_and_delete().

{
   return conlock_wrlock_version;
}

void pbx_builtin_clear_globals

(

void

)

Definition at line 8247 of file pbx.c.

References AST_LIST_REMOVE_HEAD, ast_rwlock_unlock(), ast_rwlock_wrlock(), ast_var_delete(), ast_var_t::entries, and globalslock.

Referenced by handle_cli_dialplan_reload(), and reload().

{
   struct ast_var_t *vardata;

   ast_rwlock_wrlock(&globalslock);
   while ((vardata = AST_LIST_REMOVE_HEAD(&globals, entries)))
      ast_var_delete(vardata);
   ast_rwlock_unlock(&globalslock);
}

const char* pbx_builtin_getvar_helper	(	struct ast_channel *	chan,
		const char *	name
	)

Note:

Will lock the channel.

This function will return a pointer to the buffer inside the channel variable. This value should only be accessed with the channel locked. If the value needs to be kept around, it should be done by using the following thread-safe code:

      const char *var;

      ast_channel_lock(chan);
      if ((var = pbx_builtin_getvar_helper(chan, "MYVAR"))) {
         var = ast_strdupa(var);
      }
      ast_channel_unlock(chan);

Definition at line 8017 of file pbx.c.

References ast_channel_lock, ast_channel_unlock, AST_LIST_TRAVERSE, ast_rwlock_rdlock(), ast_rwlock_unlock(), ast_var_name(), ast_var_value(), globalslock, and ast_channel::varshead.

Referenced by __ast_pbx_run(), _macro_exec(), _while_exec(), agent_hangup(), agent_read(), agentmonitoroutgoing_exec(), array(), ast_bridge_call(), ast_call_forward(), ast_eivr_getvariable(), ast_feature_interpret(), ast_monitor_stop(), builtin_automixmonitor(), builtin_automonitor(), check_goto_on_transfer(), common_exec(), conf_exec(), conf_run(), dahdi_call(), dahdi_hangup(), dial_exec_full(), do_forward(), do_timelimit(), dundi_exec(), dundi_helper(), get_also_info(), get_index(), get_refer_info(), global_read(), hash_read(), iax2_exec(), import_ch(), leave_voicemail(), local_hangup(), local_read(), login_exec(), macro_fixup(), minivm_delete_exec(), minivm_notify_exec(), misdn_answer(), misdn_hangup(), morsecode_exec(), notify_new_message(), oh323_call(), oh323_hangup(), park_call_full(), park_space_reserve(), pickup_by_mark(), queue_exec(), real_ctx(), retrydial_exec(), ring_entry(), run_agi(), set_config_flags(), set_local_info(), sip_addheader(), sla_trunk_exec(), speech_background(), try_calling(), try_suggested_sip_codec(), update_bridge_vars(), and wait_for_answer().

{
   struct ast_var_t *variables;
   const char *ret = NULL;
   int i;
   struct varshead *places[2] = { NULL, &globals };

   if (!name)
      return NULL;

   if (chan) {
      ast_channel_lock(chan);
      places[0] = &chan->varshead;
   }

   for (i = 0; i < 2; i++) {
      if (!places[i])
         continue;
      if (places[i] == &globals)
         ast_rwlock_rdlock(&globalslock);
      AST_LIST_TRAVERSE(places[i], variables, entries) {
         if (!strcmp(name, ast_var_name(variables))) {
            ret = ast_var_value(variables);
            break;
         }
      }
      if (places[i] == &globals)
         ast_rwlock_unlock(&globalslock);
      if (ret)
         break;
   }

   if (chan)
      ast_channel_unlock(chan);

   return ret;
}

void pbx_builtin_pushvar_helper	(	struct ast_channel *	chan,
		const char *	name,
		const char *	value
	)

Note:

Will lock the channel.

Definition at line 8055 of file pbx.c.

References ast_channel_lock, ast_channel_unlock, ast_func_write(), AST_LIST_INSERT_HEAD, ast_log(), ast_rwlock_unlock(), ast_rwlock_wrlock(), ast_strdupa, ast_var_assign(), ast_verb, globalslock, LOG_WARNING, and ast_channel::varshead.

Referenced by acf_odbc_read(), acf_odbc_write(), and frame_set_var().

{
   struct ast_var_t *newvariable;
   struct varshead *headp;

   if (name[strlen(name)-1] == ')') {
      char *function = ast_strdupa(name);

      ast_log(LOG_WARNING, "Cannot push a value onto a function\n");
      ast_func_write(chan, function, value);
      return;
   }

   if (chan) {
      ast_channel_lock(chan);
      headp = &chan->varshead;
   } else {
      ast_rwlock_wrlock(&globalslock);
      headp = &globals;
   }

   if (value) {
      if (headp == &globals)
         ast_verb(2, "Setting global variable '%s' to '%s'\n", name, value);
      newvariable = ast_var_assign(name, value);
      AST_LIST_INSERT_HEAD(headp, newvariable, entries);
   }

   if (chan)
      ast_channel_unlock(chan);
   else
      ast_rwlock_unlock(&globalslock);
}

int pbx_builtin_raise_exception	(	struct ast_channel *	chan,
		void *	data
	)

Definition at line 2498 of file pbx.c.

References ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_alloc(), ast_channel_datastore_find(), ast_channel_datastore_free(), ast_free, ast_string_field_init, ast_string_field_set, ast_channel::context, context, ast_datastore::data, exception_store_info, ast_channel::exten, exten, ast_channel::priority, pbx_exception::priority, and set_ext_pri().

Referenced by __ast_pbx_run().

{
   const char *reason = vreason;
   struct ast_datastore *ds = ast_channel_datastore_find(chan, &exception_store_info, NULL);
   struct pbx_exception *exception = NULL;

   if (!ds) {
      ds = ast_channel_datastore_alloc(&exception_store_info, NULL);
      if (!ds)
         return -1;
      exception = ast_calloc(1, sizeof(struct pbx_exception));
      if (!exception) {
         ast_channel_datastore_free(ds);
         return -1;
      }
      if (ast_string_field_init(exception, 128)) {
         ast_free(exception);
         ast_channel_datastore_free(ds);
         return -1;
      }
      ds->data = exception;
      ast_channel_datastore_add(chan, ds);
   } else
      exception = ds->data;

   ast_string_field_set(exception, reason, reason);
   ast_string_field_set(exception, context, chan->context);
   ast_string_field_set(exception, exten, chan->exten);
   exception->priority = chan->priority;
   set_ext_pri(chan, "e", 0);
   return 0;
}

int pbx_builtin_serialize_variables	(	struct ast_channel *	chan,
		struct ast_str **	buf
	)

Note:

Will lock the channel.

Definition at line 7985 of file pbx.c.

References ast_channel_lock, ast_channel_unlock, AST_LIST_TRAVERSE, ast_log(), ast_str_append(), ast_var_name(), ast_var_value(), ast_var_t::entries, LOG_ERROR, total, var, and ast_channel::varshead.

Referenced by dumpchan_exec(), handle_showchan(), and vars2manager().

{
   struct ast_var_t *variables;
   const char *var, *val;
   int total = 0;

   if (!chan)
      return 0;

   (*buf)->used = 0;
   (*buf)->str[0] = '\0';

   ast_channel_lock(chan);

   AST_LIST_TRAVERSE(&chan->varshead, variables, entries) {
      if ((var = ast_var_name(variables)) && (val = ast_var_value(variables))
         /* && !ast_strlen_zero(var) && !ast_strlen_zero(val) */
         ) {
         if (ast_str_append(buf, 0, "%s=%s\n", var, val) < 0) {
            ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
            break;
         } else
            total++;
      } else
         break;
   }

   ast_channel_unlock(chan);

   return total;
}

int pbx_builtin_setvar	(	struct ast_channel *	chan,
		void *	data
	)

Note:

Will lock the channel.

void pbx_builtin_setvar_helper	(	struct ast_channel *	chan,
		const char *	name,
		const char *	value
	)

Note:

Will lock the channel.

Definition at line 8089 of file pbx.c.

References ast_channel_lock, ast_channel_unlock, ast_func_write(), AST_LIST_INSERT_HEAD, AST_LIST_REMOVE, AST_LIST_TRAVERSE, ast_rwlock_unlock(), ast_rwlock_wrlock(), ast_strdupa, ast_var_assign(), ast_var_delete(), ast_var_name(), ast_verb, EVENT_FLAG_DIALPLAN, globalslock, manager_event, ast_channel::name, ast_channel::uniqueid, and ast_channel::varshead.

Referenced by __ast_pbx_run(), __oh323_new(), _macro_exec(), _while_exec(), acf_fetch(), acf_odbc_read(), acf_odbc_write(), action_setvar(), agi_exec_full(), aji_status_exec(), aqm_exec(), array(), ast_bridge_call(), ast_eivr_setvariable(), ast_feature_request_and_dial(), ast_iax2_new(), ast_monitor_start(), ast_pbx_outgoing_exten(), ast_set_variables(), asyncgoto_exec(), background_detect_exec(), bridge_exec(), builtin_automixmonitor(), builtin_automonitor(), builtin_blindtransfer(), cb_events(), chanavail_exec(), channel_spy(), conf_run(), controlplayback_exec(), count_exec(), dahdi_handle_dtmfup(), dahdi_new(), dial_exec_full(), disa_exec(), do_parking_thread(), do_waiting(), end_bridge_callback(), export_aoc_vars(), export_ch(), frame_set_var(), function_db_delete(), function_db_exists(), function_db_read(), function_realtime_store(), get_rdnis(), get_refer_info(), global_write(), gosub_release_frame(), handle_request_bye(), handle_request_refer(), handle_set_chanvar(), handle_set_global(), handle_setvariable(), hash_read(), hash_write(), isAnsweringMachine(), leave_voicemail(), local_hangup(), lua_set_variable(), lua_set_variable_value(), macro_fixup(), minivm_accmess_exec(), minivm_delete_exec(), minivm_greet_exec(), minivm_notify_exec(), minivm_record_exec(), misdn_call(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), park_exec(), parse_moved_contact(), pbx_builtin_background(), pbx_builtin_importvar(), pbx_builtin_setvar(), pbx_builtin_setvar_multiple(), pbx_load_config(), phase_e_handler(), play_message_datetime(), playback_exec(), pqm_exec(), prep_email_sub_vars(), privacy_exec(), process_ast_dsp(), read_exec(), readexten_exec(), readfile_exec(), record_exec(), return_exec(), rotate_file(), rqm_exec(), sendimage_exec(), sendtext_exec(), sendurl_exec(), set(), set_agentbycallerid(), set_queue_result(), sip_addheader(), sip_hangup(), sip_new(), skinny_new(), sla_calc_trunk_timeouts(), sla_station_exec(), sla_trunk_exec(), socket_process(), speech_create(), ss_thread(), start_monitor_exec(), system_exec_helper(), transfer_exec(), transmit(), tryexec_exec(), update_bridge_vars(), update_qe_rule(), upqm_exec(), vm_box_exists(), vm_exec(), vmauthenticate(), waituntil_exec(), and zapateller_exec().

{
   struct ast_var_t *newvariable;
   struct varshead *headp;
   const char *nametail = name;

   if (name[strlen(name) - 1] == ')') {
      char *function = ast_strdupa(name);

      ast_func_write(chan, function, value);
      return;
   }

   if (chan) {
      ast_channel_lock(chan);
      headp = &chan->varshead;
   } else {
      ast_rwlock_wrlock(&globalslock);
      headp = &globals;
   }

   /* For comparison purposes, we have to strip leading underscores */
   if (*nametail == '_') {
      nametail++;
      if (*nametail == '_')
         nametail++;
   }

   AST_LIST_TRAVERSE (headp, newvariable, entries) {
      if (strcasecmp(ast_var_name(newvariable), nametail) == 0) {
         /* there is already such a variable, delete it */
         AST_LIST_REMOVE(headp, newvariable, entries);
         ast_var_delete(newvariable);
         break;
      }
   }

   if (value) {
      if (headp == &globals)
         ast_verb(2, "Setting global variable '%s' to '%s'\n", name, value);
      newvariable = ast_var_assign(name, value);
      AST_LIST_INSERT_HEAD(headp, newvariable, entries);
      manager_event(EVENT_FLAG_DIALPLAN, "VarSet", 
         "Channel: %s\r\n"
         "Variable: %s\r\n"
         "Value: %s\r\n"
         "Uniqueid: %s\r\n", 
         chan ? chan->name : "none", name, value, 
         chan ? chan->uniqueid : "none");
   }

   if (chan)
      ast_channel_unlock(chan);
   else
      ast_rwlock_unlock(&globalslock);
}

int pbx_builtin_setvar_multiple	(	struct ast_channel *	chan,
		void *	data
	)

int pbx_checkcondition

(

const char *

condition

)

Evaluate a condition.

Return values:

	0	if the condition is NULL or of zero length
	int	If the string is an integer, the integer representation of the integer is returned
	1	Any other non-empty string

Definition at line 8257 of file pbx.c.

References ast_strlen_zero().

Referenced by _macro_exec(), _while_exec(), acf_if(), execif_exec(), gosubif_exec(), macroif_exec(), and pbx_builtin_gotoif().

{
   if (ast_strlen_zero(condition))  /* NULL or empty strings are false */
      return 0;
   else if (*condition >= '0' && *condition <= '9')   /* Numbers are evaluated for truth */
      return atoi(condition);
   else  /* Strings are true */
      return 1;
}

int pbx_exec	(	struct ast_channel *	c,
		struct ast_app *	app,
		void *	data
	)

Execute an application.

Parameters:

	c	channel to execute on
	app	which app to execute
	data	the data passed into the app

This application executes an application on a given channel. It saves the stack and executes the given application passing in the given data.

Returns:

0 on success, and -1 on failure

Parameters:

c	Channel
app	Application
data	Data for execution

Definition at line 925 of file pbx.c.

References __ast_module_user_add(), __ast_module_user_remove(), ast_channel::appl, ast_cdr_setapp(), ast_check_hangup(), ast_log(), ast_opt_dont_warn, ast_strlen_zero(), ast_channel::cdr, ast_channel::data, ast_app::execute, LOG_WARNING, ast_app::module, ast_app::name, and S_OR.

Referenced by answer_exec_run(), ast_bridge_call(), ast_pbx_run_app(), async_wait(), builtin_automixmonitor(), builtin_automonitor(), conf_run(), dial_exec_full(), dundi_exec(), exec_exec(), execif_exec(), feature_exec_app(), forward_message(), handle_exec(), handle_gosub(), iax2_exec(), lua_pbx_exec(), page_exec(), pbx_builtin_execiftime(), pbx_extension_helper(), realtime_exec(), try_calling(), and tryexec_exec().

{
   int res;
   struct ast_module_user *u = NULL;
   const char *saved_c_appl;
   const char *saved_c_data;

   if (c->cdr && !ast_check_hangup(c))
      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;
   if (app->module)
      u = __ast_module_user_add(app->module, c);
   if (strcasecmp(app->name, "system") && !ast_strlen_zero(data) &&
         strchr(data, '|') && !strchr(data, ',') && !ast_opt_dont_warn) {
      ast_log(LOG_WARNING, "The application delimiter is now the comma, not "
         "the pipe.  Did you forget to convert your dialplan?  (%s(%s))\n",
         app->name, (char *) data);
   }
   res = app->execute(c, S_OR(data, ""));
   if (app->module && u)
      __ast_module_user_remove(app->module, u);
   /* restore channel values */
   c->appl = saved_c_appl;
   c->data = saved_c_data;
   return res;
}

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
	)			[read]

Definition at line 2036 of file pbx.c.

References ast_context::alts, ast_autoservice_start(), ast_autoservice_stop(), ast_hashtab_lookup(), AST_LIST_TRAVERSE, ast_log(), AST_PBX_MAX_STACK, ast_str_thread_get(), ast_walk_context_extensions(), ast_walk_contexts(), ast_walk_extension_priorities(), ast_switch::canmatch, scoreboard::canmatch_exten, create_match_char_tree(), ast_sw::data, pbx_find_info::data, E_CANMATCH, E_FINDLABEL, E_MATCHMORE, ast_sw::eval, ast_switch::exists, ast_exten::exten, scoreboard::exten, extension_match_core(), pbx_find_info::foundcontext, include_valid(), ast_context::includes, pbx_find_info::incstack, ast_exten::label, scoreboard::last_char, ast_str::len, ast_sw::list, LOG_DEBUG, log_match_char_tree(), LOG_NOTICE, LOG_WARNING, match(), matchcid(), ast_switch::matchmore, ast_sw::name, ast_context::name, fake_context::name, new_find_extension(), ast_include::next, scoreboard::node, ast_context::pattern_tree, pbx_find_extension(), pbx_findswitch(), pbx_substitute_variables_helper(), ast_exten::priority, ast_include::rname, ast_context::root_table, pbx_find_info::stacklen, pbx_find_info::status, STATUS_NO_CONTEXT, STATUS_NO_EXTENSION, STATUS_NO_LABEL, STATUS_NO_PRIORITY, STATUS_SUCCESS, ast_str::str, switch_data, pbx_find_info::swo, scoreboard::total_length, scoreboard::total_specificity, and trie_find_next_match().

Referenced by ast_hint_extension(), ast_merge_contexts_and_delete(), pbx_extension_helper(), pbx_find_extension(), and register_peer_exten().

{
   int x, res;
   struct ast_context *tmp = NULL;
   struct ast_exten *e = NULL, *eroot = NULL;
   struct ast_include *i = NULL;
   struct ast_sw *sw = NULL;
   struct ast_exten pattern = {NULL, };
   struct scoreboard score = {0, };
   struct ast_str *tmpdata = NULL;

   pattern.label = label;
   pattern.priority = priority;
#ifdef NEED_DEBUG_HERE
   ast_log(LOG_NOTICE,"Looking for cont/ext/prio/label/action = %s/%s/%d/%s/%d\n", context, exten, priority, label, (int)action);
#endif
   /* Initialize status if appropriate */
   if (q->stacklen == 0) {
      q->status = STATUS_NO_CONTEXT;
      q->swo = NULL;
      q->data = NULL;
      q->foundcontext = NULL;
   } else 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 */
      struct fake_context item;
      strncpy(item.name,context,256);
      tmp = ast_hashtab_lookup(contexts_table,&item);
#ifdef NOTNOW
      tmp = NULL;
      while ((tmp = ast_walk_contexts(tmp)) ) {
         if (!strcmp(tmp->name, context))
            break;
      }
#endif
      if (!tmp)
         return NULL;
      
   }

   if (q->status < STATUS_NO_EXTENSION)
      q->status = STATUS_NO_EXTENSION;
   
   /* Do a search for matching extension */

   eroot = NULL;
   score.total_specificity = 0;
   score.exten = 0;
   score.total_length = 0;
   if (!tmp->pattern_tree && tmp->root_table)
   {
      create_match_char_tree(tmp);
#ifdef NEED_DEBUG
      ast_log(LOG_DEBUG,"Tree Created in context %s:\n", context);
      log_match_char_tree(tmp->pattern_tree," ");
#endif
   }
#ifdef NEED_DEBUG
   ast_log(LOG_NOTICE,"The Trie we are searching in:\n");
   log_match_char_tree(tmp->pattern_tree, "::  ");
#endif

   if (extenpatternmatchnew) {
      new_find_extension(exten, &score, tmp->pattern_tree, 0, 0, callerid, label, action);
      eroot = score.exten;
      
      if (score.last_char == '!' && action == E_MATCHMORE) {
         /* We match an extension ending in '!'.
          * The decision in this case is final and is NULL (no match).
          */
#ifdef NEED_DEBUG_HERE
         ast_log(LOG_NOTICE,"Returning MATCHMORE NULL with exclamation point.\n");
#endif
         return NULL;
      }
      
      if (!eroot && (action == E_CANMATCH || action == E_MATCHMORE) && score.canmatch_exten) {
         q->status = STATUS_SUCCESS;
#ifdef NEED_DEBUG_HERE
         ast_log(LOG_NOTICE,"Returning CANMATCH exten %s\n", score.canmatch_exten->exten);
#endif
         return score.canmatch_exten;
      }
      
      if ((action == E_MATCHMORE || action == E_CANMATCH)  && eroot) {
         if (score.node) {
            struct ast_exten *z = trie_find_next_match(score.node);
            if (z) {
#ifdef NEED_DEBUG_HERE
               ast_log(LOG_NOTICE,"Returning CANMATCH/MATCHMORE next_match exten %s\n", z->exten);
#endif
            } else {
               if (score.canmatch_exten) {
#ifdef NEED_DEBUG_HERE
                  ast_log(LOG_NOTICE,"Returning CANMATCH/MATCHMORE canmatchmatch exten %s(%p)\n", score.canmatch_exten->exten, score.canmatch_exten);
#endif
                  return score.canmatch_exten;
               } else {
#ifdef NEED_DEBUG_HERE
                  ast_log(LOG_NOTICE,"Returning CANMATCH/MATCHMORE next_match exten NULL\n");
#endif
               }
            }
            return z;
         }
#ifdef NEED_DEBUG_HERE
         ast_log(LOG_NOTICE,"Returning CANMATCH/MATCHMORE NULL (no next_match)\n");
#endif
         return NULL;  /* according to the code, complete matches are null matches in MATCHMORE mode */
      }
      
      if (eroot) {
         /* found entry, now look for the right priority */
         if (q->status < STATUS_NO_PRIORITY)
            q->status = STATUS_NO_PRIORITY;
         e = NULL;
         if (action == E_FINDLABEL && label ) {
            if (q->status < STATUS_NO_LABEL)
               q->status = STATUS_NO_LABEL;
            e = ast_hashtab_lookup(eroot->peer_label_table, &pattern);
         } else {
            e = ast_hashtab_lookup(eroot->peer_table, &pattern);
         }
         if (e) { /* found a valid match */
            q->status = STATUS_SUCCESS;
            q->foundcontext = context;
#ifdef NEED_DEBUG_HERE
            ast_log(LOG_NOTICE,"Returning complete match of exten %s\n", e->exten);
#endif
            return e;
         }
      }
   } else {   /* the old/current default exten pattern match algorithm */
      
      /* 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;
         if (action == E_FINDLABEL && label ) {
            if (q->status < STATUS_NO_LABEL)
               q->status = STATUS_NO_LABEL;
            e = ast_hashtab_lookup(eroot->peer_label_table, &pattern);
         } else {
            e = ast_hashtab_lookup(eroot->peer_table, &pattern);
         }
#ifdef NOTNOW
         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 */
         }
#endif
         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) {
         if (!(tmpdata = ast_str_thread_get(&switch_data, 512))) {
            ast_log(LOG_WARNING, "Can't evaluate switch?!");
            continue;
         }
         pbx_substitute_variables_helper(chan, sw->data, tmpdata->str, tmpdata->len);
      }

      /* 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 ? tmpdata->str : sw->data;
      if (!aswf)
         res = 0;
      else {
         if (chan)
            ast_autoservice_start(chan);
         res = aswf(chan, context, exten, priority, callerid, datap);
         if (chan)
            ast_autoservice_stop(chan);
      }
      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))) {
#ifdef NEED_DEBUG_HERE
            ast_log(LOG_NOTICE,"Returning recursive match of %s\n", e->exten);
#endif
            return e;
         }
         if (q->swo)
            return NULL;
      }
   }
   return NULL;
}

struct ast_app* pbx_findapp

(

const char *

app

)

[read]

Look up an application.

Parameters:

app

name of the app

This function searches for the ast_app structure within the apps that are registered for the one with the name you passed in.

Returns:

the ast_app structure that matches on success, or NULL on failure

Definition at line 966 of file pbx.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sw::list, and ast_app::name.

Referenced by answer_exec_run(), ast_bridge_call(), ast_pbx_run_app(), async_wait(), builtin_automixmonitor(), builtin_automonitor(), conf_run(), dial_exec_full(), dundi_exec(), exec_exec(), execif_exec(), feature_exec_app(), forward_message(), handle_exec(), handle_gosub(), iax2_exec(), lua_pbx_exec(), page_exec(), pbx_builtin_execiftime(), pbx_extension_helper(), realtime_exec(), try_calling(), and tryexec_exec().

{
   struct ast_app *tmp;

   AST_RWLIST_RDLOCK(&apps);
   AST_RWLIST_TRAVERSE(&apps, tmp, list) {
      if (!strcasecmp(tmp->name, app))
         break;
   }
   AST_RWLIST_UNLOCK(&apps);

   return tmp;
}

void pbx_retrieve_variable	(	struct ast_channel *	c,
		const char *	var,
		char **	ret,
		char *	workspace,
		int	workspacelen,
		struct varshead *	headp
	)

Support for Asterisk built-in variables in the dialplan.

Note:

Will lock the channel.

See also

• Globally predefined channel variables Channel variables
• Hangup Causes for Asterisk The HANGUPCAUSE variable

Definition at line 2373 of file pbx.c.

References ARRAY_LEN, ast_channel_lock, ast_channel_unlock, ast_config_AST_SYSTEM_NAME, ast_copy_string(), ast_get_hint(), AST_LIST_TRAVERSE, ast_rwlock_rdlock(), ast_rwlock_unlock(), ast_strdupa, ast_var_name(), ast_var_value(), ast_channel::cid, ast_callerid::cid_ani2, ast_callerid::cid_pres, ast_callerid::cid_tns, ast_callerid::cid_ton, ast_channel::context, ast_var_t::entries, ast_channel::exten, globalslock, ast_channel::hangupcause, ast_channel::name, parse_variable_name(), ast_channel::priority, s, substring(), ast_channel::uniqueid, and ast_channel::varshead.

Referenced by action_getvar(), handle_getvariable(), lua_get_variable(), lua_get_variable_value(), and pbx_substitute_variables_helper_full().

{
   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) {
      ast_channel_lock(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 < ARRAY_LEN(places); i++) {
      struct ast_var_t *variables;
      if (!places[i])
         continue;
      if (places[i] == &globals)
         ast_rwlock_rdlock(&globalslock);
      AST_LIST_TRAVERSE(places[i], variables, entries) {
         if (!strcasecmp(ast_var_name(variables), var)) {
            s = ast_var_value(variables);
            break;
         }
      }
      if (places[i] == &globals)
         ast_rwlock_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);
   }

   if (c)
      ast_channel_unlock(c);
}

int pbx_set_autofallthrough

(

int

newval

)

Set "autofallthrough" flag, if newval is <0, does not acutally set. If set to 1, sets to auto fall through. If newval set to 0, sets to no auto fall through (reads extension instead). Returns previous value.

Definition at line 4006 of file pbx.c.

Referenced by pbx_load_module().

{
   int oldval = autofallthrough;
   autofallthrough = newval;
   return oldval;
}

int pbx_set_extenpatternmatchnew

(

int

newval

)

Set "extenpatternmatchnew" flag, if newval is <0, does not acutally set. If set to 1, sets to use the new Trie-based pattern matcher. If newval set to 0, sets to use the old linear-search algorithm. Returns previous value.

Definition at line 4013 of file pbx.c.

Referenced by handle_set_extenpatternmatchnew(), handle_unset_extenpatternmatchnew(), and pbx_load_module().

{
   int oldval = extenpatternmatchnew;
   extenpatternmatchnew = newval;
   return oldval;
}

void pbx_substitute_variables_helper	(	struct ast_channel *	c,
		const char *	cp1,
		char *	cp2,
		int	count
	)

Definition at line 3011 of file pbx.c.

References pbx_substitute_variables_helper_full(), and ast_channel::varshead.

Referenced by _macro_exec(), acf_import(), acf_odbc_read(), acf_odbc_write(), config_curl(), custom_log(), cut_internal(), destroy_curl(), exec_exec(), function_eval(), function_fieldqty(), get_mapping_weight(), handle_cli_rpt_lstats(), handle_getvariablefull(), launch_monitor_thread(), make_email_file(), manager_log(), pbx_builtin_importvar(), pbx_find_extension(), pbx_load_config(), pbx_substitute_variables(), realtime_curl(), realtime_exec(), realtime_multi_curl(), rotate_file(), rpt_exec(), sendmail(), sendpage(), sqlite3_log(), store_curl(), substituted(), try_calling(), tryexec_exec(), and update_curl().

{
   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
	)

Definition at line 3016 of file pbx.c.

References pbx_substitute_variables_helper_full().

Referenced by ast_add_extension2_lockopt(), build_user(), build_user_routes(), do_say(), dundi_lookup_local(), loopback_subst(), phoneprov_callback(), and pp_each_user_exec().

{
   pbx_substitute_variables_helper_full(NULL, headp, cp1, cp2, count);
}