fdeea056f3cfdaa8189ccac16aecdcb00ecaaf79
[asterisk/asterisk.git] / include / asterisk / pbx.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Core PBX routines and definitions.
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13 #ifndef _ASTERISK_PBX_H
14 #define _ASTERISK_PBX_H
15
16 #include <asterisk/sched.h>
17 #include <asterisk/channel.h>
18
19 #if defined(__cplusplus) || defined(c_plusplus)
20 extern "C" {
21 #endif
22
23 #define AST_PBX_KEEP    0
24 #define AST_PBX_REPLACE 1
25
26 //! Max length of an application
27 #define AST_MAX_APP     32
28
29 //! Special return values from applications to the PBX
30 #define AST_PBX_KEEPALIVE       10              /* Destroy the thread, but don't hang up the channel */
31 #define AST_PBX_NO_HANGUP_PEER       11
32
33 //! Special Priority for an hint
34 #define PRIORITY_HINT   -1
35
36 //! Extension states
37 //! No device INUSE or BUSY 
38 #define AST_EXTENSION_NOT_INUSE         0
39 //! One or more devices INUSE
40 #define AST_EXTENSION_INUSE             1
41 //! All devices BUSY
42 #define AST_EXTENSION_BUSY              2
43 //! All devices UNAVAILABLE/UNREGISTERED
44 #define AST_EXTENSION_UNAVAILABLE       3
45
46 struct ast_context;
47 struct ast_exten;     
48 struct ast_include;
49 struct ast_ignorepat;
50 struct ast_sw;
51
52 typedef int (*ast_state_cb_type)(char *context, char* id, int state, void *data);
53
54 //! Data structure associated with an asterisk switch
55 struct ast_switch {
56         /*! NULL */
57         struct ast_switch *next;        
58         /*! Name of the switch */
59         const char *name;                               
60         /*! Description of the switch */
61         const char *description;                
62         
63         int (*exists)(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
64         
65         int (*canmatch)(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
66         
67         int (*exec)(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, int newstack, const char *data);
68
69         int (*matchmore)(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data);
70 };
71
72 struct ast_pbx {
73         int dtimeout;                                   /* Timeout between digits (seconds) */
74         int rtimeout;                                   /* Timeout for response
75                                                            (seconds) */
76 };
77
78
79 //! Register an alternative switch
80 /*!
81  * \param sw switch to register
82  * This function registers a populated ast_switch structure with the
83  * asterisk switching architecture.
84  * It returns 0 on success, and other than 0 on failure
85  */
86 extern int ast_register_switch(struct ast_switch *sw);
87
88 //! Unregister an alternative switch
89 /*!
90  * \param sw switch to unregister
91  * Unregisters a switch from asterisk.
92  * Returns nothing
93  */
94 extern void ast_unregister_switch(struct ast_switch *sw);
95
96 //! Look up an application
97 /*!
98  * \param app name of the app
99  * This function searches for the ast_app structure within
100  * the apps that are registered for the one with the name
101  * you passed in.
102  * Returns the ast_app structure that matches on success, or NULL on failure
103  */
104 extern struct ast_app *pbx_findapp(const char *app);
105
106 //! executes an application
107 /*!
108  * \param c channel to execute on
109  * \param app which app to execute
110  * \param data the data passed into the app
111  * \param newstack stack pointer
112  * This application executes an application on a given channel.  It
113  * saves the stack and executes the given appliation passing in
114  * the given data.
115  * It returns 0 on success, and -1 on failure
116  */
117 int pbx_exec(struct ast_channel *c, struct ast_app *app, void *data, int newstack);
118
119 //! Register a new context
120 /*!
121  * \param extcontexts pointer to the ast_context structure pointer
122  * \param name name of the new context
123  * \param registrar registrar of the context
124  * This will first search for a context with your name.  If it exists already, it will not
125  * create a new one.  If it does not exist, it will create a new one with the given name
126  * and registrar.
127  * It returns NULL on failure, and an ast_context structure on success
128  */
129 struct ast_context *ast_context_create(struct ast_context **extcontexts, const char *name, const char *registrar);
130
131 //! Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added
132 /*!
133  * \param extcontexts pointer to the ast_context structure pointer
134  * \param registar 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
135  */
136 void ast_merge_contexts_and_delete(struct ast_context **extcontexts, const char *registrar);
137
138 //! Destroy a context (matches the specified context (or ANY context if NULL)
139 /*!
140  * \param con context to destroy
141  * \param registrar who registered it
142  * You can optionally leave out either parameter.  It will find it
143  * based on either the ast_context or the registrar name.
144  * Returns nothing
145  */
146 void ast_context_destroy(struct ast_context *con, const char *registrar);
147
148 //! Find a context
149 /*!
150  * \param name name of the context to find
151  * Will search for the context with the given name.
152  * Returns the ast_context on success, NULL on failure.
153  */
154 struct ast_context *ast_context_find(const char *name);
155
156 //! Create a new thread and start the PBX (or whatever)
157 /*!
158  * \param c channel to start the pbx on
159  * Starts a pbx thread on a given channel
160  * It returns -1 on failure, and 0 on success
161  */
162 int ast_pbx_start(struct ast_channel *c);
163
164 //! Execute the PBX in the current thread
165 /*!
166  * \param c channel to run the pbx on
167  * This executes the PBX on a given channel.  It allocates a new
168  * PBX structure for the channel, and provides all PBX functionality.
169  */
170 int ast_pbx_run(struct ast_channel *c);
171
172 /*! 
173  * \param context context to add the extension to
174  * \param replace
175  * \param extension extension to add
176  * \param priority priority level of extension addition
177  * \param callerid callerid of extension
178  * \param application application to run on the extension with that priority level
179  * \param data data to pass to the application
180  * \param datad
181  * \param registrar who registered the extension
182  * Add and extension to an extension context.  
183  * Callerid is a pattern to match CallerID, or NULL to match any callerid
184  * Returns 0 on success, -1 on failure
185  */
186 int ast_add_extension(const char *context, int replace, const char *extension, int priority, const char *label, const char *callerid,
187         const char *application, void *data, void (*datad)(void *), const char *registrar);
188
189 //! Add an extension to an extension context, this time with an ast_context *.  CallerID is a pattern to match on callerid, or NULL to not care about callerid
190 /*! 
191  * For details about the arguements, check ast_add_extension()
192  */
193 int ast_add_extension2(struct ast_context *con,
194                                       int replace, const char *extension, int priority, const char *label, const char *callerid, 
195                                           const char *application, void *data, void (*datad)(void *),
196                                           const char *registrar);
197
198 //! Add an application.  The function 'execute' should return non-zero if the line needs to be hung up. 
199 /*!
200   \param app Short name of the application
201   \param execute a function callback to execute the application
202   \param synopsis a short description of the application
203   \param description long description of the application
204    Include a one-line synopsis (e.g. 'hangs up a channel') and a more lengthy, multiline
205    description with more detail, including under what conditions the application
206    will return 0 or -1.
207    This registers an application with asterisks internal application list.  Please note:
208    The individual applications themselves are responsible for registering and unregistering
209    CLI commands.
210    It returns 0 on success, -1 on failure.
211 */
212 int ast_register_application(const char *app, int (*execute)(struct ast_channel *, void *),
213                              const char *synopsis, const char *description);
214
215 //! Remove an application
216 /*!
217  * \param app name of the application (does not have to be the same string as the one that was registered)
218  * This unregisters an application from asterisk's internal registration mechanisms.
219  * It returns 0 on success, and -1 on failure.
220  */
221 int ast_unregister_application(const char *app);
222
223 //! Uses hint and devicestate callback to get the state of an extension
224 /*!
225  * \param c this is not important
226  * \param context which context to look in
227  * \param exten which extension to get state
228  * Returns extension state !! = AST_EXTENSION_???
229  */
230 int ast_extension_state(struct ast_channel *c, char *context, char *exten);
231
232 //! Tells Asterisk the State for Device is changed
233 /*!
234  * \param fmt devicename like a dialstring with format parameters
235  * Asterisk polls the new extensionstates and calls the registered
236  * callbacks for the changed extensions
237  * Returns 0 on success, -1 on failure
238  */
239 int ast_device_state_changed(const char *fmt, ...)
240         __attribute__ ((format (printf, 1, 2)));
241
242 //! Registers a state change callback
243 /*!
244  * \param context which context to look in
245  * \param exten which extension to get state
246  * \param callback callback to call if state changed
247  * \param data to pass to callback
248  * The callback is called if the state for extension is changed
249  * Return -1 on failure, ID on success
250  */ 
251 int ast_extension_state_add(const char *context, const char *exten, 
252                             ast_state_cb_type callback, void *data);
253
254 //! Deletes a registered state change callback by ID
255 /*!
256  * \param id of the callback to delete
257  * Removes the callback from list of callbacks
258  * Return 0 on success, -1 on failure
259  */
260 int ast_extension_state_del(int id, ast_state_cb_type callback);
261
262 //! If an extension exists, return non-zero
263 /*!
264  * \param hint buffer for hint
265  * \param maxlen size of hint buffer
266  * \param c this is not important
267  * \param context which context to look in
268  * \param exten which extension to search for
269  * If an extension within the given context with the priority PRIORITY_HINT
270  * is found a non zero value will be returned.
271  * Otherwise, 0 is returned.
272  */
273 int ast_get_hint(char *hint, int maxlen, struct ast_channel *c, const char *context, const char *exten);
274
275 //! If an extension exists, return non-zero
276 // work
277 /*!
278  * \param c this is not important
279  * \param context which context to look in
280  * \param exten which extension to search for
281  * \param priority priority of the action within the extension
282  * \param callerid callerid to search for
283  * If an extension within the given context(or callerid) with the given priority is found a non zero value will be returned.
284  * Otherwise, 0 is returned.
285  */
286 int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid);
287
288 //! If an extension exists, return non-zero
289 // work
290 /*!
291  * \param c this is not important
292  * \param context which context to look in
293  * \param exten which extension to search for
294  * \param labellabel of the action within the extension to match to priority
295  * \param callerid callerid to search for
296  * If an priority which matches given label in extension or -1 if not found.
297 \ */
298 int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid);
299
300 //! Looks for a valid matching extension
301 /*!
302   \param c not really important
303   \param context context to serach within
304   \param exten extension to check
305   \param priority priority of extension path
306   \param callerid callerid of extension being searched for
307    If "exten" *could be* a valid extension in this context with or without
308    some more digits, return non-zero.  Basically, when this returns 0, no matter
309    what you add to exten, it's not going to be a valid extension anymore
310 */
311 int ast_canmatch_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid);
312
313 //! Looks to see if adding anything to this extension might match something. (exists ^ canmatch)
314 /*!
315   \param c not really important
316   \param context context to serach within
317   \param exten extension to check
318   \param priority priority of extension path
319   \param callerid callerid of extension being searched for
320    If "exten" *could match* a valid extension in this context with
321    some more digits, return non-zero.  Does NOT return non-zero if this is
322    an exact-match only.  Basically, when this returns 0, no matter
323    what you add to exten, it's not going to be a valid extension anymore
324 */
325 int ast_matchmore_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid);
326
327 //! Determine if a given extension matches a given pattern (in NXX format)
328 /*!
329  * \param pattern pattern to match
330  * \param extension extension to check against the pattern.
331  * Checks whether or not the given extension matches the given pattern.
332  * Returns 1 on match, 0 on failure
333  */
334 int ast_extension_match(const char *pattern, const char *extension);
335
336 //! Launch a new extension (i.e. new stack)
337 /*!
338  * \param c not important
339  * \param context which context to generate the extension within
340  * \param exten new extension to add
341  * \param priority priority of new extension
342  * \param callerid callerid of extension
343  * This adds a new extension to the asterisk extension list.
344  * It returns 0 on success, -1 on failure.
345  */
346 int ast_spawn_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid);
347
348 //! Execute an extension.
349 /*!
350   \param c channel to execute upon
351   \param context which context extension is in
352   \param exten extension to execute
353   \param priority priority to execute within the given extension
354    If it's not available, do whatever you should do for
355    default extensions and halt the thread if necessary.  This function does not
356    return, except on error.
357 */
358 int ast_exec_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid);
359
360 //! Add an include
361 /*!
362   \param context context to add include to
363   \param include new include to add
364   \param registrar who's registering it
365    Adds an include taking a char * string as the context parameter
366    Returns 0 on success, -1 on error
367 */
368 int ast_context_add_include(const char *context, const char *include, const char *registrar);
369
370 //! Add an include
371 /*!
372   \param con context to add the include to
373   \param include include to add
374   \param registrar who registered the context
375    Adds an include taking a struct ast_context as the first parameter
376    Returns 0 on success, -1 on failure
377 */
378 int ast_context_add_include2(struct ast_context *con, const char *include, const char *registrar);
379
380 //! Removes an include
381 /*!
382  * See add_include
383  */
384 int ast_context_remove_include(const char *context, const char *include,const  char *registrar);
385 //! Removes an include by an ast_context structure
386 /*!
387  * See add_include2
388  */
389 int ast_context_remove_include2(struct ast_context *con, const char *include, const char *registrar);
390
391 //! Verifies includes in an ast_contect structure
392 /*!
393  * \param con context in which to verify the includes
394  * Returns 0 if no problems found, -1 if there were any missing context
395  */
396 int ast_context_verify_includes(struct ast_context *con);
397           
398 //! Add a switch
399 /*!
400  * \param context context to which to add the switch
401  * \param sw switch to add
402  * \param data data to pass to switch
403  * \param registrar whoever registered the switch
404  * This function registers a switch with the asterisk switch architecture
405  * It returns 0 on success, -1 on failure
406  */
407 int ast_context_add_switch(const char *context, const char *sw, const char *data, const char *registrar);
408 //! Adds a switch (first param is a ast_context)
409 /*!
410  * See ast_context_add_switch()
411  */
412 int ast_context_add_switch2(struct ast_context *con, const char *sw, const char *data, const char *registrar);
413
414 //! Remove a switch
415 /*!
416  * Removes a switch with the given parameters
417  * Returns 0 on success, -1 on failure
418  */
419 int ast_context_remove_switch(const char *context, const char *sw, const char *data, const char *registrar);
420 int ast_context_remove_switch2(struct ast_context *con, const char *sw, const char *data, const char *registrar);
421
422 //! Simply remove extension from context
423 /*!
424  * \param context context to remove extension from
425  * \param extension which extension to remove
426  * \param priority priority of extension to remove
427  * \param registrar registrar of the extension
428  * This function removes an extension from a given context.
429  * Returns 0 on success, -1 on failure
430  */
431 int ast_context_remove_extension(const char *context, const char *extension, int priority,
432         const char *registrar);
433 int ast_context_remove_extension2(struct ast_context *con, const char *extension,
434         int priority, const char *registrar);
435
436 //! Add an ignorepat
437 /*!
438  * \param context which context to add the ignorpattern to
439  * \param ignorpat ignorepattern to set up for the extension
440  * \param registrar registrar of the ignore pattern
441  * Adds an ignore pattern to a particular context.
442  * Returns 0 on success, -1 on failure
443  */
444 int ast_context_add_ignorepat(const char *context, const char *ignorepat, const char *registrar);
445 int ast_context_add_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
446
447 /* Remove an ignorepat */
448 /*!
449  * \param context context from which to remove the pattern
450  * \param ignorepat the pattern to remove
451  * \param registrar the registrar of the ignore pattern
452  * This removes the given ignorepattern
453  * Returns 0 on success, -1 on failure
454  */
455 int ast_context_remove_ignorepat(const char *context, const char *ignorepat, const char *registrar);
456 int ast_context_remove_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
457
458 //! Checks to see if a number should be ignored
459 /*!
460  * \param context context to search within
461  * \param extension to check whether it should be ignored or not
462  * Check if a number should be ignored with respect to dialtone cancellation.  
463  * Returns 0 if the pattern should not be ignored, or non-zero if the pattern should be ignored 
464  */
465 int ast_ignore_pattern(const char *context, const char *pattern);
466
467 /* Locking functions for outer modules, especially for completion functions */
468 //! Locks the contexts
469 /*! Locks the context list
470  * Returns 0 on success, -1 on error
471  */
472 int ast_lock_contexts(void);
473
474 //! Unlocks contexts
475 /*!
476  * Returns 0 on success, -1 on failure
477  */
478 int ast_unlock_contexts(void);
479
480 //! Locks a given context
481 /*!
482  * \param con context to lock
483  * Locks the context.
484  * Returns 0 on success, -1 on failure
485  */
486 int ast_lock_context(struct ast_context *con);
487 //! Unlocks the given context
488 /*!
489  * \param con context to unlock
490  * Unlocks the given context
491  * Returns 0 on success, -1 on failure
492  */
493 int ast_unlock_context(struct ast_context *con);
494
495
496 int ast_async_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
497
498 int ast_async_goto_by_name(const char *chan, const char *context, const char *exten, int priority);
499
500 /* Synchronously or asynchronously make an outbound call and send it to a
501    particular extension */
502 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, const char *variable, const char *account );
503
504 /* Synchronously or asynchronously make an outbound call and send it to a
505    particular application with given extension */
506 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, const char *variable, const char *account);
507
508 /* Functions for returning values from structures */
509 const char *ast_get_context_name(struct ast_context *con);
510 const char *ast_get_extension_name(struct ast_exten *exten);
511 const char *ast_get_include_name(struct ast_include *include);
512 const char *ast_get_ignorepat_name(struct ast_ignorepat *ip);
513 const char *ast_get_switch_name(struct ast_sw *sw);
514 const char *ast_get_switch_data(struct ast_sw *sw);
515
516 /* Other extension stuff */
517 int ast_get_extension_priority(struct ast_exten *exten);
518 int ast_get_extension_matchcid(struct ast_exten *e);
519 const char *ast_get_extension_cidmatch(struct ast_exten *e);
520 const char *ast_get_extension_app(struct ast_exten *e);
521 const char *ast_get_extension_label(struct ast_exten *e);
522 void *ast_get_extension_app_data(struct ast_exten *e);
523
524 /* Registrar info functions ... */
525 const char *ast_get_context_registrar(struct ast_context *c);
526 const char *ast_get_extension_registrar(struct ast_exten *e);
527 const char *ast_get_include_registrar(struct ast_include *i);
528 const char *ast_get_ignorepat_registrar(struct ast_ignorepat *ip);
529 const char *ast_get_switch_registrar(struct ast_sw *sw);
530
531 /* Walking functions ... */
532 struct ast_context *ast_walk_contexts(struct ast_context *con);
533 struct ast_exten *ast_walk_context_extensions(struct ast_context *con,
534         struct ast_exten *priority);
535 struct ast_exten *ast_walk_extension_priorities(struct ast_exten *exten,
536         struct ast_exten *priority);
537 struct ast_include *ast_walk_context_includes(struct ast_context *con,
538         struct ast_include *inc);
539 struct ast_ignorepat *ast_walk_context_ignorepats(struct ast_context *con,
540         struct ast_ignorepat *ip);
541 struct ast_sw *ast_walk_context_switches(struct ast_context *con, struct ast_sw *sw);
542
543 extern char *pbx_builtin_getvar_helper(struct ast_channel *chan, char *name);
544 extern void pbx_builtin_setvar_helper(struct ast_channel *chan, char *name, char *value);
545 extern void pbx_builtin_clear_globals(void);
546 extern int pbx_builtin_setvar(struct ast_channel *chan, void *data);
547 extern void pbx_substitute_variables_helper(struct ast_channel *c,const char *cp1,char *cp2,int count);
548
549 int ast_extension_patmatch(const char *pattern, const char *data);
550
551 #if defined(__cplusplus) || defined(c_plusplus)
552 }
553 #endif
554
555
556 #endif