Add timezone to the possible fields in a timespec.
[asterisk/asterisk.git] / include / asterisk / pbx.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Core PBX routines and definitions.
21  */
22
23 #ifndef _ASTERISK_PBX_H
24 #define _ASTERISK_PBX_H
25
26 #include "asterisk/sched.h"
27 #include "asterisk/chanvars.h"
28 #include "asterisk/hashtab.h"
29 #include "asterisk/stringfields.h"
30
31 #if defined(__cplusplus) || defined(c_plusplus)
32 extern "C" {
33 #endif
34
35 #define AST_MAX_APP     32      /*!< Max length of an application */
36
37 #define AST_PBX_KEEP    0
38 #define AST_PBX_REPLACE 1
39
40 /*! \brief Special return values from applications to the PBX { */
41 #define AST_PBX_HANGUP                -1    /*!< Jump to the 'h' exten */
42 #define AST_PBX_OK                     0    /*!< No errors */
43 #define AST_PBX_ERROR                  1    /*!< Jump to the 'e' exten */
44 #define AST_PBX_KEEPALIVE              10   /*!< Destroy the thread, but don't hang up the channel */
45 #define AST_PBX_NO_HANGUP_PEER         11   /*!< The peer has been involved in a transfer */
46 #define AST_PBX_INCOMPLETE             12   /*!< Return to PBX matching, allowing more digits for the extension */
47 #define AST_PBX_NO_HANGUP_PEER_PARKED  13   /*!< Don't touch the peer channel - it was sent to the parking lot and might be gone by now */
48 /*! } */
49
50 #define PRIORITY_HINT   -1      /*!< Special Priority for a hint */
51
52 /*! \brief Extension states 
53         \note States can be combined 
54         - \ref AstExtState
55 */
56 enum ast_extension_states {
57         AST_EXTENSION_REMOVED = -2,     /*!< Extension removed */
58         AST_EXTENSION_DEACTIVATED = -1, /*!< Extension hint removed */
59         AST_EXTENSION_NOT_INUSE = 0,    /*!< No device INUSE or BUSY  */
60         AST_EXTENSION_INUSE = 1 << 0,   /*!< One or more devices INUSE */
61         AST_EXTENSION_BUSY = 1 << 1,    /*!< All devices BUSY */
62         AST_EXTENSION_UNAVAILABLE = 1 << 2, /*!< All devices UNAVAILABLE/UNREGISTERED */
63         AST_EXTENSION_RINGING = 1 << 3, /*!< All devices RINGING */
64         AST_EXTENSION_ONHOLD = 1 << 4,  /*!< All devices ONHOLD */
65 };
66
67
68 struct ast_context;
69 struct ast_exten;     
70 struct ast_include;
71 struct ast_ignorepat;
72 struct ast_sw;
73
74 /*! \brief Typedef for devicestate and hint callbacks */
75 typedef int (*ast_state_cb_type)(char *context, char* id, enum ast_extension_states state, void *data);
76
77 /*! \brief From where the documentation come from */
78 enum ast_doc_src {
79         AST_XML_DOC,            /*!< From XML documentation */
80         AST_STATIC_DOC          /*!< From application/function registration */
81 };
82
83 /*! \brief Data structure associated with a custom dialplan function */
84 struct ast_custom_function {
85         const char *name;                       /*!< Name */
86         AST_DECLARE_STRING_FIELDS(
87                 AST_STRING_FIELD(synopsis);     /*!< Synopsis text for 'show functions' */
88                 AST_STRING_FIELD(desc);         /*!< Description (help text) for 'show functions &lt;name&gt;' */
89                 AST_STRING_FIELD(syntax);       /*!< Syntax text for 'core show functions' */
90                 AST_STRING_FIELD(arguments);    /*!< Arguments description */
91                 AST_STRING_FIELD(seealso);      /*!< See also */
92         );
93         enum ast_doc_src docsrc;                /*!< Where the documentation come from */
94         int (*read)(struct ast_channel *, const char *, char *, char *, size_t);        /*!< Read function, if read is supported */
95         int (*write)(struct ast_channel *, const char *, char *, const char *);         /*!< Write function, if write is supported */
96         struct ast_module *mod;         /*!< Module this custom function belongs to */
97         AST_RWLIST_ENTRY(ast_custom_function) acflist;
98 };
99
100 /*! \brief All switch functions have the same interface, so define a type for them */
101 typedef int (ast_switch_f)(struct ast_channel *chan, const char *context,
102         const char *exten, int priority, const char *callerid, const char *data);
103
104 /*!< Data structure associated with an Asterisk switch */
105 struct ast_switch {
106         AST_LIST_ENTRY(ast_switch) list;
107         const char *name;                       /*!< Name of the switch */
108         const char *description;                /*!< Description of the switch */
109         
110         ast_switch_f *exists;
111         ast_switch_f *canmatch;
112         ast_switch_f *exec;
113         ast_switch_f *matchmore;
114 };
115
116 struct ast_timing {
117         int hastime;                    /*!< If time construct exists */
118         unsigned int monthmask;         /*!< Mask for month */
119         unsigned int daymask;           /*!< Mask for date */
120         unsigned int dowmask;           /*!< Mask for day of week (sun-sat) */
121         unsigned int minmask[48];       /*!< Mask for minute */
122         char *timezone;                 /*!< NULL, or zoneinfo style timezone */
123 };
124
125 /*!\brief Construct a timing bitmap, for use in time-based conditionals.
126  * \param i Pointer to an ast_timing structure.
127  * \param info Standard string containing a timerange, weekday range, monthday range, and month range, as well as an optional timezone.
128  * \retval Returns 1 on success or 0 on failure.
129  */
130 int ast_build_timing(struct ast_timing *i, const char *info);
131
132 /*!\brief Evaluate a pre-constructed bitmap as to whether the current time falls within the range specified.
133  * \param i Pointer to an ast_timing structure.
134  * \retval Returns 1, if the time matches or 0, if the current time falls outside of the specified range.
135  */
136 int ast_check_timing(const struct ast_timing *i);
137
138 /*!\brief Deallocates memory structures associated with a timing bitmap.
139  * \param i Pointer to an ast_timing structure.
140  * \retval Returns 0 on success or a number suitable for passing into strerror, otherwise.
141  */
142 int ast_destroy_timing(struct ast_timing *i);
143
144 struct ast_pbx {
145         int dtimeoutms;                         /*!< Timeout between digits (milliseconds) */
146         int rtimeoutms;                         /*!< Timeout for response (milliseconds) */
147 };
148
149
150 /*!
151  * \brief Register an alternative dialplan switch
152  *
153  * \param sw switch to register
154  *
155  * This function registers a populated ast_switch structure with the
156  * asterisk switching architecture.
157  *
158  * \return 0 on success, and other than 0 on failure
159  */
160 int ast_register_switch(struct ast_switch *sw);
161
162 /*!
163  * \brief Unregister an alternative switch
164  *
165  * \param sw switch to unregister
166  * 
167  * Unregisters a switch from asterisk.
168  *
169  * \return nothing
170  */
171 void ast_unregister_switch(struct ast_switch *sw);
172
173 /*!
174  * \brief Look up an application
175  *
176  * \param app name of the app
177  *
178  * This function searches for the ast_app structure within
179  * the apps that are registered for the one with the name
180  * you passed in.
181  *
182  * \return the ast_app structure that matches on success, or NULL on failure
183  */
184 struct ast_app *pbx_findapp(const char *app);
185
186 /*!
187  * \brief Execute an application
188  *
189  * \param c channel to execute on
190  * \param app which app to execute
191  * \param data the data passed into the app
192  *
193  * This application executes an application on a given channel.  It
194  * saves the stack and executes the given application passing in
195  * the given data.
196  *
197  * \return 0 on success, and -1 on failure
198  */
199 int pbx_exec(struct ast_channel *c, struct ast_app *app, void *data);
200
201 /*!
202  * \brief Register a new context or find an existing one
203  *
204  * \param extcontexts pointer to the ast_context structure pointer
205  * \param exttable pointer to the hashtable that contains all the elements in extcontexts
206  * \param name name of the new context
207  * \param registrar registrar of the context
208  *
209  * This function allows you to play in two environments: the global contexts (active dialplan)
210  * or an external context set of your choosing. To act on the external set, make sure extcontexts
211  * and exttable are set; for the globals, make sure both extcontexts and exttable are NULL.
212  *
213  * This will first search for a context with your name.  If it exists already, it will not
214  * create a new one.  If it does not exist, it will create a new one with the given name
215  * and registrar.
216  *
217  * \return NULL on failure, and an ast_context structure on success
218  */
219 struct ast_context *ast_context_find_or_create(struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *name, const char *registrar);
220
221 /*!
222  * \brief Merge the temporary contexts into a global contexts list and delete from the 
223  *        global list the ones that are being added
224  *
225  * \param extcontexts pointer to the ast_context structure
226  * \param exttable pointer to the ast_hashtab structure that contains all the elements in extcontexts
227  * \param registrar of the context; if it's set the routine will delete all contexts 
228  *        that belong to that registrar; if NULL only the contexts that are specified 
229  *        in extcontexts
230  */
231 void ast_merge_contexts_and_delete(struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *registrar);
232
233 /*!
234  * \brief Destroy a context (matches the specified context (or ANY context if NULL)
235  *
236  * \param con context to destroy
237  * \param registrar who registered it
238  *
239  * You can optionally leave out either parameter.  It will find it
240  * based on either the ast_context or the registrar name.
241  *
242  * \return nothing
243  */
244 void ast_context_destroy(struct ast_context *con, const char *registrar);
245
246 /*!
247  * \brief Find a context
248  *
249  * \param name name of the context to find
250  *
251  * Will search for the context with the given name.
252  *
253  * \return the ast_context on success, NULL on failure.
254  */
255 struct ast_context *ast_context_find(const char *name);
256
257 /*! \brief The result codes when starting the PBX on a channelwith \see ast_pbx_start.
258         AST_PBX_CALL_LIMIT refers to the maxcalls call limit in asterisk.conf
259  */
260 enum ast_pbx_result {
261         AST_PBX_SUCCESS = 0,
262         AST_PBX_FAILED = -1,
263         AST_PBX_CALL_LIMIT = -2,
264 };
265
266 /*!
267  * \brief Create a new thread and start the PBX
268  *
269  * \param c channel to start the pbx on
270  *
271  * \see ast_pbx_run for a synchronous function to run the PBX in the
272  * current thread, as opposed to starting a new one.
273  *
274  * \retval Zero on success
275  * \retval non-zero on failure
276  */
277 enum ast_pbx_result ast_pbx_start(struct ast_channel *c);
278
279 /*!
280  * \brief Execute the PBX in the current thread
281  *
282  * \param c channel to run the pbx on
283  *
284  * This executes the PBX on a given channel. It allocates a new
285  * PBX structure for the channel, and provides all PBX functionality.
286  * See ast_pbx_start for an asynchronous function to run the PBX in a
287  * new thread as opposed to the current one.
288  * 
289  * \retval Zero on success
290  * \retval non-zero on failure
291  */
292 enum ast_pbx_result ast_pbx_run(struct ast_channel *c);
293
294 /*! 
295  * \brief Add and extension to an extension context.  
296  * 
297  * \param context context to add the extension to
298  * \param replace
299  * \param extension extension to add
300  * \param priority priority level of extension addition
301  * \param label extension label
302  * \param callerid pattern to match CallerID, or NULL to match any CallerID
303  * \param application application to run on the extension with that priority level
304  * \param data data to pass to the application
305  * \param datad
306  * \param registrar who registered the extension
307  *
308  * \retval 0 success 
309  * \retval -1 failure
310  */
311 int ast_add_extension(const char *context, int replace, const char *extension, 
312         int priority, const char *label, const char *callerid,
313         const char *application, void *data, void (*datad)(void *), const char *registrar);
314
315 /*! 
316  * \brief Add an extension to an extension context, this time with an ast_context *.
317  *
318  * \note For details about the arguments, check ast_add_extension()
319  */
320 int ast_add_extension2(struct ast_context *con, int replace, const char *extension,
321         int priority, const char *label, const char *callerid, 
322         const char *application, void *data, void (*datad)(void *), const char *registrar);
323
324
325 /*! 
326  * \brief Uses hint and devicestate callback to get the state of an extension
327  *
328  * \param c this is not important
329  * \param context which context to look in
330  * \param exten which extension to get state
331  *
332  * \return extension state as defined in the ast_extension_states enum
333  */
334 int ast_extension_state(struct ast_channel *c, const char *context, const char *exten);
335
336 /*! 
337  * \brief Return string representation of the state of an extension
338  * 
339  * \param extension_state is the numerical state delivered by ast_extension_state
340  *
341  * \return the state of an extension as string
342  */
343 const char *ast_extension_state2str(int extension_state);
344
345 /*!
346  * \brief Registers a state change callback
347  * 
348  * \param context which context to look in
349  * \param exten which extension to get state
350  * \param callback callback to call if state changed
351  * \param data to pass to callback
352  *
353  * The callback is called if the state of an extension is changed.
354  *
355  * \retval -1 on failure
356  * \retval ID on success
357  */ 
358 int ast_extension_state_add(const char *context, const char *exten, 
359                             ast_state_cb_type callback, void *data);
360
361 /*! 
362  * \brief Deletes a registered state change callback by ID
363  * 
364  * \param id of the callback to delete
365  * \param callback callback
366  *
367  * Removes the callback from list of callbacks
368  *
369  * \retval 0 success 
370  * \retval -1 failure
371  */
372 int ast_extension_state_del(int id, ast_state_cb_type callback);
373
374 /*! 
375  * \brief If an extension hint exists, return non-zero
376  * 
377  * \param hint buffer for hint
378  * \param maxlen size of hint buffer
379  * \param name buffer for name portion of hint
380  * \param maxnamelen size of name buffer
381  * \param c this is not important
382  * \param context which context to look in
383  * \param exten which extension to search for
384  *
385  * \return If an extension within the given context with the priority PRIORITY_HINT
386  * is found a non zero value will be returned.
387  * Otherwise, 0 is returned.
388  */
389 int ast_get_hint(char *hint, int maxlen, char *name, int maxnamelen, 
390         struct ast_channel *c, const char *context, const char *exten);
391
392 /*!
393  * \brief Determine whether an extension exists
394  *
395  * \param c this is not important
396  * \param context which context to look in
397  * \param exten which extension to search for
398  * \param priority priority of the action within the extension
399  * \param callerid callerid to search for
400  *
401  * \note It is possible for autoservice to be started and stopped on c during this
402  * function call, it is important that c is not locked prior to calling this. Otherwise
403  * a deadlock may occur
404  *
405  * \return If an extension within the given context(or callerid) with the given priority 
406  *         is found a non zero value will be returned. Otherwise, 0 is returned.
407  */
408 int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, 
409         int priority, const char *callerid);
410
411 /*! 
412  * \brief Find the priority of an extension that has the specified label
413  * 
414  * \param c this is not important
415  * \param context which context to look in
416  * \param exten which extension to search for
417  * \param label label of the action within the extension to match to priority
418  * \param callerid callerid to search for
419  *
420  * \note It is possible for autoservice to be started and stopped on c during this
421  * function call, it is important that c is not locked prior to calling this. Otherwise
422  * a deadlock may occur
423  *
424  * \retval the priority which matches the given label in the extension
425  * \retval -1 if not found.
426  */
427 int ast_findlabel_extension(struct ast_channel *c, const char *context, 
428         const char *exten, const char *label, const char *callerid);
429
430 /*!
431  * \brief Find the priority of an extension that has the specified label
432  *
433  * \note It is possible for autoservice to be started and stopped on c during this
434  * function call, it is important that c is not locked prior to calling this. Otherwise
435  * a deadlock may occur
436  *
437  * \note This function is the same as ast_findlabel_extension, except that it accepts
438  * a pointer to an ast_context structure to specify the context instead of the
439  * name of the context. Otherwise, the functions behave the same.
440  */
441 int ast_findlabel_extension2(struct ast_channel *c, struct ast_context *con, 
442         const char *exten, const char *label, const char *callerid);
443
444 /*! 
445  * \brief Looks for a valid matching extension
446  * 
447  * \param c not really important
448  * \param context context to serach within
449  * \param exten extension to check
450  * \param priority priority of extension path
451  * \param callerid callerid of extension being searched for
452  *
453  * \note It is possible for autoservice to be started and stopped on c during this
454  * function call, it is important that c is not locked prior to calling this. Otherwise
455  * a deadlock may occur
456  *
457  * \return If "exten" *could be* a valid extension in this context with or without
458  * some more digits, return non-zero.  Basically, when this returns 0, no matter
459  * what you add to exten, it's not going to be a valid extension anymore
460  */
461 int ast_canmatch_extension(struct ast_channel *c, const char *context, 
462         const char *exten, int priority, const char *callerid);
463
464 /*! 
465  * \brief Looks to see if adding anything to this extension might match something. (exists ^ canmatch)
466  *
467  * \param c not really important XXX
468  * \param context context to serach within
469  * \param exten extension to check
470  * \param priority priority of extension path
471  * \param callerid callerid of extension being searched for
472  *
473  * \note It is possible for autoservice to be started and stopped on c during this
474  * function call, it is important that c is not locked prior to calling this. Otherwise
475  * a deadlock may occur
476  *
477  * \return If "exten" *could match* a valid extension in this context with
478  * some more digits, return non-zero.  Does NOT return non-zero if this is
479  * an exact-match only.  Basically, when this returns 0, no matter
480  * what you add to exten, it's not going to be a valid extension anymore
481  */
482 int ast_matchmore_extension(struct ast_channel *c, const char *context, 
483         const char *exten, int priority, const char *callerid);
484
485 /*! 
486  * \brief Determine if a given extension matches a given pattern (in NXX format)
487  * 
488  * \param pattern pattern to match
489  * \param extension extension to check against the pattern.
490  *
491  * Checks whether or not the given extension matches the given pattern.
492  *
493  * \retval 1 on match
494  * \retval 0 on failure
495  */
496 int ast_extension_match(const char *pattern, const char *extension);
497
498 int ast_extension_close(const char *pattern, const char *data, int needmore);
499
500 /*! 
501  * \brief Determine if one extension should match before another
502  * 
503  * \param a extension to compare with b
504  * \param b extension to compare with a
505  *
506  * Checks whether or extension a should match before extension b
507  *
508  * \retval 0 if the two extensions have equal matching priority
509  * \retval 1 on a > b
510  * \retval -1 on a < b
511  */
512 int ast_extension_cmp(const char *a, const char *b);
513
514 /*! 
515  * \brief Launch a new extension (i.e. new stack)
516  * 
517  * \param c not important
518  * \param context which context to generate the extension within
519  * \param exten new extension to add
520  * \param priority priority of new extension
521  * \param callerid callerid of extension
522  * \param found
523  * \param combined_find_spawn 
524  *
525  * This adds a new extension to the asterisk extension list.
526  *
527  * \note It is possible for autoservice to be started and stopped on c during this
528  * function call, it is important that c is not locked prior to calling this. Otherwise
529  * a deadlock may occur
530  *
531  * \retval 0 on success 
532  * \retval -1 on failure.
533  */
534 int ast_spawn_extension(struct ast_channel *c, const char *context, 
535       const char *exten, int priority, const char *callerid, int *found, int combined_find_spawn);
536
537 /*! 
538  * \brief Add a context include
539  *
540  * \param context context to add include to
541  * \param include new include to add
542  * \param registrar who's registering it
543  *
544  * Adds an include taking a char * string as the context parameter
545  *
546  * \retval 0 on success 
547  * \retval -1 on error
548 */
549 int ast_context_add_include(const char *context, const char *include, 
550         const char *registrar);
551
552 /*! 
553  * \brief Add a context include
554  * 
555  * \param con context to add the include to
556  * \param include include to add
557  * \param registrar who registered the context
558  *
559  * Adds an include taking a struct ast_context as the first parameter
560  *
561  * \retval 0 on success 
562  * \retval -1 on failure
563  */
564 int ast_context_add_include2(struct ast_context *con, const char *include, 
565         const char *registrar);
566
567 /*! 
568  * \brief Remove a context include
569  * 
570  * \note See ast_context_add_include for information on arguments
571  *
572  * \retval 0 on success
573  * \retval -1 on failure
574  */
575 int ast_context_remove_include(const char *context, const char *include, 
576         const char *registrar);
577
578 /*! 
579  * \brief Removes an include by an ast_context structure 
580  * 
581  * \note See ast_context_add_include2 for information on arguments
582  *
583  * \retval 0 on success
584  * \retval -1 on success
585  */
586 int ast_context_remove_include2(struct ast_context *con, const char *include, 
587         const char *registrar);
588
589 /*! 
590  * \brief Verifies includes in an ast_contect structure
591  * 
592  * \param con context in which to verify the includes
593  *
594  * \retval 0 if no problems found 
595  * \retval -1 if there were any missing context
596  */
597 int ast_context_verify_includes(struct ast_context *con);
598           
599 /*! 
600  * \brief Add a switch
601  * 
602  * \param context context to which to add the switch
603  * \param sw switch to add
604  * \param data data to pass to switch
605  * \param eval whether to evaluate variables when running switch
606  * \param registrar whoever registered the switch
607  *
608  * This function registers a switch with the asterisk switch architecture
609  *
610  * \retval 0 on success 
611  * \retval -1 on failure
612  */
613 int ast_context_add_switch(const char *context, const char *sw, const char *data, 
614         int eval, const char *registrar);
615
616 /*! 
617  * \brief Adds a switch (first param is a ast_context)
618  * 
619  * \note See ast_context_add_switch() for argument information, with the exception of
620  *       the first argument. In this case, it's a pointer to an ast_context structure
621  *       as opposed to the name.
622  */
623 int ast_context_add_switch2(struct ast_context *con, const char *sw, const char *data, 
624         int eval, const char *registrar);
625
626 /*! 
627  * \brief Remove a switch
628  * 
629  * Removes a switch with the given parameters
630  *
631  * \retval 0 on success 
632  * \retval -1 on failure
633  */
634 int ast_context_remove_switch(const char *context, const char *sw, 
635         const char *data, const char *registrar);
636
637 int ast_context_remove_switch2(struct ast_context *con, const char *sw, 
638         const char *data, const char *registrar);
639
640 /*! 
641  * \brief Simply remove extension from context
642  * 
643  * \param context context to remove extension from
644  * \param extension which extension to remove
645  * \param priority priority of extension to remove (0 to remove all)
646  * \param callerid NULL to remove all; non-NULL to match a single record per priority
647  * \param matchcid non-zero to match callerid element (if non-NULL); 0 to match default case
648  * \param registrar registrar of the extension
649  *
650  * This function removes an extension from a given context.
651  *
652  * \retval 0 on success 
653  * \retval -1 on failure
654  */
655 int ast_context_remove_extension(const char *context, const char *extension, int priority,
656         const char *registrar);
657
658 int ast_context_remove_extension2(struct ast_context *con, const char *extension,
659         int priority, const char *registrar, int already_locked);
660
661 int ast_context_remove_extension_callerid(const char *context, const char *extension,
662         int priority, const char *callerid, int matchcid, const char *registrar);
663
664 int ast_context_remove_extension_callerid2(struct ast_context *con, const char *extension,
665         int priority, const char *callerid, int matchcid, const char *registrar,
666         int already_locked);
667
668 /*! 
669  * \brief Add an ignorepat
670  * 
671  * \param context which context to add the ignorpattern to
672  * \param ignorepat ignorepattern to set up for the extension
673  * \param registrar registrar of the ignore pattern
674  *
675  * Adds an ignore pattern to a particular context.
676  *
677  * \retval 0 on success 
678  * \retval -1 on failure
679  */
680 int ast_context_add_ignorepat(const char *context, const char *ignorepat, const char *registrar);
681
682 int ast_context_add_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
683
684 /* 
685  * \brief Remove an ignorepat
686  * 
687  * \param context context from which to remove the pattern
688  * \param ignorepat the pattern to remove
689  * \param registrar the registrar of the ignore pattern
690  *
691  * This removes the given ignorepattern
692  *
693  * \retval 0 on success 
694  * \retval -1 on failure
695  */
696 int ast_context_remove_ignorepat(const char *context, const char *ignorepat, const char *registrar);
697
698 int ast_context_remove_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
699
700 /*! 
701  * \brief Checks to see if a number should be ignored
702  * 
703  * \param context context to search within
704  * \param pattern to check whether it should be ignored or not
705  *
706  * Check if a number should be ignored with respect to dialtone cancellation.
707  *
708  * \retval 0 if the pattern should not be ignored 
709  * \retval non-zero if the pattern should be ignored 
710  */
711 int ast_ignore_pattern(const char *context, const char *pattern);
712
713 /* Locking functions for outer modules, especially for completion functions */
714
715 /*! 
716  * \brief Write locks the context list
717  *
718  * \retval 0 on success 
719  * \retval -1 on error
720  */
721 int ast_wrlock_contexts(void);
722
723 /*!
724  * \brief Read locks the context list
725  *
726  * \retval 0 on success
727  * \retval -1 on error
728  */
729 int ast_rdlock_contexts(void);
730
731 /*! 
732  * \brief Unlocks contexts
733  * 
734  * \retval 0 on success 
735  * \retval -1 on failure
736  */
737 int ast_unlock_contexts(void);
738
739 /*! 
740  * \brief Write locks a given context
741  * 
742  * \param con context to lock
743  *
744  * \retval 0 on success 
745  * \retval -1 on failure
746  */
747 int ast_wrlock_context(struct ast_context *con);
748
749 /*!
750  * \brief Read locks a given context
751  *
752  * \param con context to lock
753  *
754  * \retval 0 on success
755  * \retval -1 on failure
756  */
757 int ast_rdlock_context(struct ast_context *con);
758
759 /*! 
760  * \retval Unlocks the given context
761  * 
762  * \param con context to unlock
763  *
764  * \retval 0 on success 
765  * \retval -1 on failure
766  */
767 int ast_unlock_context(struct ast_context *con);
768
769 /*! 
770  * \brief locks the macrolock in the given given context
771  *
772  * \param macrocontext name of the macro-context to lock
773  *
774  * Locks the given macro-context to ensure only one thread (call) can execute it at a time
775  *
776  * \retval 0 on success
777  * \retval -1 on failure
778  */
779 int ast_context_lockmacro(const char *macrocontext);
780
781 /*!
782  * \brief Unlocks the macrolock in the given context
783  *
784  * \param macrocontext name of the macro-context to unlock
785  *
786  * Unlocks the given macro-context so that another thread (call) can execute it
787  *
788  * \retval 0 on success
789  * \retval -1 on failure
790  */
791 int ast_context_unlockmacro(const char *macrocontext);
792
793 int ast_async_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
794
795 int ast_async_goto_by_name(const char *chan, const char *context, const char *exten, int priority);
796
797 /*! Synchronously or asynchronously make an outbound call and send it to a
798    particular extension */
799 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);
800
801 /*! Synchronously or asynchronously make an outbound call and send it to a
802    particular application with given extension */
803 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);
804
805 /*!
806  * \brief Evaluate a condition
807  *
808  * \retval 0 if the condition is NULL or of zero length
809  * \retval int If the string is an integer, the integer representation of
810  *             the integer is returned
811  * \retval 1 Any other non-empty string
812  */
813 int pbx_checkcondition(const char *condition);
814
815 /*! @name 
816  * Functions for returning values from structures */
817 /*! @{ */
818 const char *ast_get_context_name(struct ast_context *con);
819 const char *ast_get_extension_name(struct ast_exten *exten);
820 struct ast_context *ast_get_extension_context(struct ast_exten *exten);
821 const char *ast_get_include_name(struct ast_include *include);
822 const char *ast_get_ignorepat_name(struct ast_ignorepat *ip);
823 const char *ast_get_switch_name(struct ast_sw *sw);
824 const char *ast_get_switch_data(struct ast_sw *sw);
825 int ast_get_switch_eval(struct ast_sw *sw);
826         
827 /*! @} */
828
829 /*! @name Other Extension stuff */
830 /*! @{ */
831 int ast_get_extension_priority(struct ast_exten *exten);
832 int ast_get_extension_matchcid(struct ast_exten *e);
833 const char *ast_get_extension_cidmatch(struct ast_exten *e);
834 const char *ast_get_extension_app(struct ast_exten *e);
835 const char *ast_get_extension_label(struct ast_exten *e);
836 void *ast_get_extension_app_data(struct ast_exten *e);
837 /*! @} */
838
839 /*! @name Registrar info functions ... */
840 /*! @{ */
841 const char *ast_get_context_registrar(struct ast_context *c);
842 const char *ast_get_extension_registrar(struct ast_exten *e);
843 const char *ast_get_include_registrar(struct ast_include *i);
844 const char *ast_get_ignorepat_registrar(struct ast_ignorepat *ip);
845 const char *ast_get_switch_registrar(struct ast_sw *sw);
846 /*! @} */
847
848 /* Walking functions ... */
849 struct ast_context *ast_walk_contexts(struct ast_context *con);
850 struct ast_exten *ast_walk_context_extensions(struct ast_context *con,
851         struct ast_exten *priority);
852 struct ast_exten *ast_walk_extension_priorities(struct ast_exten *exten,
853         struct ast_exten *priority);
854 struct ast_include *ast_walk_context_includes(struct ast_context *con,
855         struct ast_include *inc);
856 struct ast_ignorepat *ast_walk_context_ignorepats(struct ast_context *con,
857         struct ast_ignorepat *ip);
858 struct ast_sw *ast_walk_context_switches(struct ast_context *con, struct ast_sw *sw);
859
860 /*!
861  * \note Will lock the channel.
862  */
863 int pbx_builtin_serialize_variables(struct ast_channel *chan, struct ast_str **buf);
864
865 /*!
866  * \note Will lock the channel.
867  *
868  * \note This function will return a pointer to the buffer inside the channel
869  * variable.  This value should only be accessed with the channel locked.  If
870  * the value needs to be kept around, it should be done by using the following
871  * thread-safe code:
872  * \code
873  *              const char *var;
874  *
875  *              ast_channel_lock(chan);
876  *              if ((var = pbx_builtin_getvar_helper(chan, "MYVAR"))) {
877  *                      var = ast_strdupa(var);
878  *              }
879  *              ast_channel_unlock(chan);
880  * \endcode
881  */
882 const char *pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name);
883
884 /*!
885  * \note Will lock the channel.
886  */
887 void pbx_builtin_pushvar_helper(struct ast_channel *chan, const char *name, const char *value);
888
889 /*!
890  * \note Will lock the channel.
891  */
892 void pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value);
893
894 /*!
895  * \note Will lock the channel.
896  */
897 void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp);
898 void pbx_builtin_clear_globals(void);
899
900 /*!
901  * \note Will lock the channel.
902  */
903 int pbx_builtin_setvar(struct ast_channel *chan, void *data);
904 int pbx_builtin_setvar_multiple(struct ast_channel *chan, void *data);
905
906 int pbx_builtin_raise_exception(struct ast_channel *chan, void *data);
907
908 void pbx_substitute_variables_helper(struct ast_channel *c,const char *cp1,char *cp2,int count);
909 void pbx_substitute_variables_varshead(struct varshead *headp, const char *cp1, char *cp2, int count);
910 void pbx_substitute_variables_helper_full(struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int cp2_size, size_t *used);
911 void ast_str_substitute_variables(struct ast_str **buf, size_t maxlen, struct ast_channel *chan, const char *templ);
912
913 int ast_extension_patmatch(const char *pattern, const char *data);
914
915 /*! Set "autofallthrough" flag, if newval is <0, does not acutally set.  If
916   set to 1, sets to auto fall through.  If newval set to 0, sets to no auto
917   fall through (reads extension instead).  Returns previous value. */
918 int pbx_set_autofallthrough(int newval);
919
920 /*! Set "extenpatternmatchnew" flag, if newval is <0, does not acutally set.  If
921   set to 1, sets to use the new Trie-based pattern matcher.  If newval set to 0, sets to use
922   the old linear-search algorithm.  Returns previous value. */
923 int pbx_set_extenpatternmatchnew(int newval);
924
925 /*! Set "overrideswitch" field.  If set and of nonzero length, all contexts
926  * will be tried directly through the named switch prior to any other
927  * matching within that context. */
928 void pbx_set_overrideswitch(const char *newval);
929
930 /*!
931  * \note This function will handle locking the channel as needed.
932  */
933 int ast_goto_if_exists(struct ast_channel *chan, const char *context, const char *exten, int priority);
934
935 /*!
936  * \note I can find neither parsable nor parseable at dictionary.com, 
937  *       but google gives me 169000 hits for parseable and only 49,800 
938  *       for parsable 
939  *
940  * \note This function will handle locking the channel as needed.
941  */
942 int ast_parseable_goto(struct ast_channel *chan, const char *goto_string);
943
944 /*!
945  * \note This function will handle locking the channel as needed.
946  */
947 int ast_async_parseable_goto(struct ast_channel *chan, const char *goto_string);
948
949 /*!
950  * \note This function will handle locking the channel as needed.
951  */
952 int ast_explicit_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
953
954 /*!
955  * \note This function will handle locking the channel as needed.
956  */
957 int ast_async_goto_if_exists(struct ast_channel *chan, const char *context, const char *exten, int priority);
958
959 struct ast_custom_function* ast_custom_function_find(const char *name);
960
961 /*!
962  * \brief Unregister a custom function
963  */
964 int ast_custom_function_unregister(struct ast_custom_function *acf);
965
966 /*!
967  * \brief Register a custom function
968  */
969 #define ast_custom_function_register(acf) __ast_custom_function_register(acf, ast_module_info->self)
970
971 /*!
972  * \brief Register a custom function
973  */
974 int __ast_custom_function_register(struct ast_custom_function *acf, struct ast_module *mod);
975
976 /*! 
977  * \brief Retrieve the number of active calls
978  */
979 int ast_active_calls(void);
980
981 /*! 
982  * \brief Retrieve the total number of calls processed through the PBX since last restart
983  */
984 int ast_processed_calls(void);
985         
986 /*!
987  * \brief executes a read operation on a function 
988  *
989  * \param chan Channel to execute on
990  * \param function Data containing the function call string (will be modified)
991  * \param workspace A pointer to safe memory to use for a return value 
992  * \param len the number of bytes in workspace
993  *
994  * This application executes a function in read mode on a given channel.
995  *
996  * \return zero on success, non-zero on failure
997  */
998 int ast_func_read(struct ast_channel *chan, const char *function, char *workspace, size_t len);
999
1000 /*!
1001  * \brief executes a write operation on a function
1002  *
1003  * \param chan Channel to execute on
1004  * \param function Data containing the function call string (will be modified)
1005  * \param value A value parameter to pass for writing
1006  *
1007  * This application executes a function in write mode on a given channel.
1008  *
1009  * \return zero on success, non-zero on failure
1010  */
1011 int ast_func_write(struct ast_channel *chan, const char *function, const char *value);
1012
1013 /*!
1014  * When looking up extensions, we can have different requests
1015  * identified by the 'action' argument, as follows.
1016  * Note that the coding is such that the low 4 bits are the
1017  * third argument to extension_match_core.
1018  */
1019
1020 enum ext_match_t {
1021         E_MATCHMORE =   0x00,   /* extension can match but only with more 'digits' */
1022         E_CANMATCH =    0x01,   /* extension can match with or without more 'digits' */
1023         E_MATCH =       0x02,   /* extension is an exact match */
1024         E_MATCH_MASK =  0x03,   /* mask for the argument to extension_match_core() */
1025         E_SPAWN =       0x12,   /* want to spawn an extension. Requires exact match */
1026         E_FINDLABEL =   0x22    /* returns the priority for a given label. Requires exact match */
1027 };
1028
1029 #define STATUS_NO_CONTEXT       1
1030 #define STATUS_NO_EXTENSION     2
1031 #define STATUS_NO_PRIORITY      3
1032 #define STATUS_NO_LABEL         4
1033 #define STATUS_SUCCESS          5 
1034 #define AST_PBX_MAX_STACK  128
1035
1036 /* request and result for pbx_find_extension */
1037 struct pbx_find_info {
1038 #if 0
1039         const char *context;
1040         const char *exten;
1041         int priority;
1042 #endif
1043
1044         char *incstack[AST_PBX_MAX_STACK];      /* filled during the search */
1045         int stacklen;                   /* modified during the search */
1046         int status;                     /* set on return */
1047         struct ast_switch *swo;         /* set on return */
1048         const char *data;               /* set on return */
1049         const char *foundcontext;       /* set on return */
1050 };
1051  
1052 struct ast_exten *pbx_find_extension(struct ast_channel *chan,
1053                                                                          struct ast_context *bypass, struct pbx_find_info *q,
1054                                                                          const char *context, const char *exten, int priority,
1055                                                                          const char *label, const char *callerid, enum ext_match_t action);
1056
1057
1058 /* every time a write lock is obtained for contexts,
1059    a counter is incremented. You can check this via the
1060    following func */
1061
1062 int ast_wrlock_contexts_version(void);
1063         
1064
1065 /* hashtable functions for contexts */
1066 int ast_hashtab_compare_contexts(const void *ah_a, const void *ah_b);
1067 unsigned int ast_hashtab_hash_contexts(const void *obj);
1068
1069 #if defined(__cplusplus) || defined(c_plusplus)
1070 }
1071 #endif
1072
1073 #endif /* _ASTERISK_PBX_H */