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