Merge james's patch (bug #7)
[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         char *name;                             
60         /*! Description of the switch */
61         char *description;              
62         
63         int (*exists)(struct ast_channel *chan, char *context, char *exten, int priority, char *callerid, char *data);
64         
65         int (*canmatch)(struct ast_channel *chan, char *context, char *exten, int priority, char *callerid, char *data);
66         
67         int (*exec)(struct ast_channel *chan, char *context, char *exten, int priority, char *callerid, int newstack, char *data);
68
69         int (*matchmore)(struct ast_channel *chan, char *context, char *exten, int priority, char *callerid, 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(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, char *name, 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, 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, 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(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(char *context, int replace, char *extension, int priority, char *callerid,
187         char *application, void *data, void (*datad)(void *), 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, char *extension, int priority, char *callerid, 
195                                           char *application, void *data, void (*datad)(void *),
196                                           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(char *app, int (*execute)(struct ast_channel *, void *),
213                              char *synopsis, 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(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(char *context, 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, char *context, 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, char *context, char *exten, int priority, char *callerid);
287
288 //! Looks for a valid matching extension
289 /*!
290   \param c not really important
291   \param context context to serach within
292   \param exten extension to check
293   \param priority priority of extension path
294   \param callerid callerid of extension being searched for
295    If "exten" *could be* a valid extension in this context with or without
296    some more digits, return non-zero.  Basically, when this returns 0, no matter
297    what you add to exten, it's not going to be a valid extension anymore
298 */
299 int ast_canmatch_extension(struct ast_channel *c, char *context, char *exten, int priority, char *callerid);
300
301 //! Looks to see if adding anything to this extension might match something. (exists ^ canmatch)
302 /*!
303   \param c not really important
304   \param context context to serach within
305   \param exten extension to check
306   \param priority priority of extension path
307   \param callerid callerid of extension being searched for
308    If "exten" *could match* a valid extension in this context with
309    some more digits, return non-zero.  Does NOT return non-zero if this is
310    an exact-match only.  Basically, when this returns 0, no matter
311    what you add to exten, it's not going to be a valid extension anymore
312 */
313 int ast_matchmore_extension(struct ast_channel *c, char *context, char *exten, int priority, char *callerid);
314
315 //! Determine if a given extension matches a given pattern (in NXX format)
316 /*!
317  * \param pattern pattern to match
318  * \param extension extension to check against the pattern.
319  * Checks whether or not the given extension matches the given pattern.
320  * Returns 1 on match, 0 on failure
321  */
322 int ast_extension_match(char *pattern, char *extension);
323
324 //! Launch a new extension (i.e. new stack)
325 /*!
326  * \param c not important
327  * \param context which context to generate the extension within
328  * \param exten new extension to add
329  * \param priority priority of new extension
330  * \param callerid callerid of extension
331  * This adds a new extension to the asterisk extension list.
332  * It returns 0 on success, -1 on failure.
333  */
334 int ast_spawn_extension(struct ast_channel *c, char *context, char *exten, int priority, char *callerid);
335
336 //! Execute an extension.
337 /*!
338   \param c channel to execute upon
339   \param context which context extension is in
340   \param exten extension to execute
341   \param priority priority to execute within the given extension
342    If it's not available, do whatever you should do for
343    default extensions and halt the thread if necessary.  This function does not
344    return, except on error.
345 */
346 int ast_exec_extension(struct ast_channel *c, char *context, char *exten, int priority, char *callerid);
347
348 //! Add an include
349 /*!
350   \param context context to add include to
351   \param include new include to add
352   \param registrar who's registering it
353    Adds an include taking a char * string as the context parameter
354    Returns 0 on success, -1 on error
355 */
356 int ast_context_add_include(char *context, char *include, char *registrar);
357
358 //! Add an include
359 /*!
360   \param con context to add the include to
361   \param include include to add
362   \param registrar who registered the context
363    Adds an include taking a struct ast_context as the first parameter
364    Returns 0 on success, -1 on failure
365 */
366 int ast_context_add_include2(struct ast_context *con, char *include, char *registrar);
367
368 //! Removes an include
369 /*!
370  * See add_include
371  */
372 int ast_context_remove_include(char *context, char *include, char *registrar);
373 //! Removes an include by an ast_context structure
374 /*!
375  * See add_include2
376  */
377 int ast_context_remove_include2(struct ast_context *con, char *include, char *registrar);
378
379 //! Add a switch
380 /*!
381  * \param context context to which to add the switch
382  * \param sw switch to add
383  * \param data data to pass to switch
384  * \param registrar whoever registered the switch
385  * This function registers a switch with the asterisk switch architecture
386  * It returns 0 on success, -1 on failure
387  */
388 int ast_context_add_switch(char *context, char *sw, char *data, char *registrar);
389 //! Adds a switch (first param is a ast_context)
390 /*!
391  * See ast_context_add_switch()
392  */
393 int ast_context_add_switch2(struct ast_context *con, char *sw, char *data, char *registrar);
394
395 //! Remove a switch
396 /*!
397  * Removes a switch with the given parameters
398  * Returns 0 on success, -1 on failure
399  */
400 int ast_context_remove_switch(char *context, char *sw, char *data, char *registrar);
401 int ast_context_remove_switch2(struct ast_context *con, char *sw, char *data, char *registrar);
402
403 //! Simply remove extension from context
404 /*!
405  * \param context context to remove extension from
406  * \param extension which extension to remove
407  * \param priority priority of extension to remove
408  * \param registrar registrar of the extension
409  * This function removes an extension from a given context.
410  * Returns 0 on success, -1 on failure
411  */
412 int ast_context_remove_extension(char *context, char *extension, int priority,
413         char *registrar);
414 int ast_context_remove_extension2(struct ast_context *con, char *extension,
415         int priority, char *registrar);
416
417 //! Add an ignorepat
418 /*!
419  * \param context which context to add the ignorpattern to
420  * \param ignorpat ignorepattern to set up for the extension
421  * \param registrar registrar of the ignore pattern
422  * Adds an ignore pattern to a particular context.
423  * Returns 0 on success, -1 on failure
424  */
425 int ast_context_add_ignorepat(char *context, char *ignorepat, char *registrar);
426 int ast_context_add_ignorepat2(struct ast_context *con, char *ignorepat, char *registrar);
427
428 /* Remove an ignorepat */
429 /*!
430  * \param context context from which to remove the pattern
431  * \param ignorepat the pattern to remove
432  * \param registrar the registrar of the ignore pattern
433  * This removes the given ignorepattern
434  * Returns 0 on success, -1 on failure
435  */
436 int ast_context_remove_ignorepat(char *context, char *ignorepat, char *registrar);
437 int ast_context_remove_ignorepat2(struct ast_context *con, char *ignorepat, char *registrar);
438
439 //! Checks to see if a number should be ignored
440 /*!
441  * \param context context to search within
442  * \param extension to check whether it should be ignored or not
443  * Check if a number should be ignored with respect to dialtone cancellation.  
444  * Returns 0 if the pattern should not be ignored, or non-zero if the pattern should be ignored 
445  */
446 int ast_ignore_pattern(char *context, char *pattern);
447
448 /* Locking functions for outer modules, especially for completion functions */
449 //! Locks the contexts
450 /*! Locks the context list
451  * Returns 0 on success, -1 on error
452  */
453 int ast_lock_contexts(void);
454
455 //! Unlocks contexts
456 /*!
457  * Returns 0 on success, -1 on failure
458  */
459 int ast_unlock_contexts(void);
460
461 //! Locks a given context
462 /*!
463  * \param con context to lock
464  * Locks the context.
465  * Returns 0 on success, -1 on failure
466  */
467 int ast_lock_context(struct ast_context *con);
468 //! Unlocks the given context
469 /*!
470  * \param con context to unlock
471  * Unlocks the given context
472  * Returns 0 on success, -1 on failure
473  */
474 int ast_unlock_context(struct ast_context *con);
475
476
477 int ast_async_goto(struct ast_channel *chan, char *context, char *exten, int priority, int needlock);
478
479 int ast_async_goto_by_name(char *chan, char *context, char *exten, int priority);
480
481 /* Synchronously or asynchronously make an outbound call and send it to a
482    particular extension */
483 int ast_pbx_outgoing_exten(char *type, int format, void *data, int timeout, char *context, char *exten, int priority, int *reason, int sync, char *callerid, char *variable );
484
485 /* Synchronously or asynchronously make an outbound call and send it to a
486    particular application with given extension */
487 int ast_pbx_outgoing_app(char *type, int format, void *data, int timeout, char *app, char *appdata, int *reason, int sync, char *callerid, char *variable);
488
489 /* Functions for returning values from structures */
490 char *ast_get_context_name(struct ast_context *con);
491 char *ast_get_extension_name(struct ast_exten *exten);
492 char *ast_get_include_name(struct ast_include *include);
493 char *ast_get_ignorepat_name(struct ast_ignorepat *ip);
494 char *ast_get_switch_name(struct ast_sw *sw);
495 char *ast_get_switch_data(struct ast_sw *sw);
496
497 /* Other extension stuff */
498 int ast_get_extension_priority(struct ast_exten *exten);
499 char *ast_get_extension_app(struct ast_exten *e);
500 void *ast_get_extension_app_data(struct ast_exten *e);
501
502 /* Registrar info functions ... */
503 char *ast_get_context_registrar(struct ast_context *c);
504 char *ast_get_extension_registrar(struct ast_exten *e);
505 char *ast_get_include_registrar(struct ast_include *i);
506 char *ast_get_ignorepat_registrar(struct ast_ignorepat *ip);
507 char *ast_get_switch_registrar(struct ast_sw *sw);
508
509 /* Walking functions ... */
510 struct ast_context *ast_walk_contexts(struct ast_context *con);
511 struct ast_exten *ast_walk_context_extensions(struct ast_context *con,
512         struct ast_exten *priority);
513 struct ast_exten *ast_walk_extension_priorities(struct ast_exten *exten,
514         struct ast_exten *priority);
515 struct ast_include *ast_walk_context_includes(struct ast_context *con,
516         struct ast_include *inc);
517 struct ast_ignorepat *ast_walk_context_ignorepats(struct ast_context *con,
518         struct ast_ignorepat *ip);
519 struct ast_sw *ast_walk_context_switches(struct ast_context *con, struct ast_sw *sw);
520
521 extern char *pbx_builtin_getvar_helper(struct ast_channel *chan, char *name);
522 extern void pbx_builtin_setvar_helper(struct ast_channel *chan, char *name, char *value);
523 extern void pbx_builtin_clear_globals(void);
524 extern void pbx_substitute_variables_helper(struct ast_channel *c,const char *cp1,char *cp2,int count);
525
526 #if defined(__cplusplus) || defined(c_plusplus)
527 }
528 #endif
529
530
531 #endif