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