Add pickup event to AMI. Also, fix AMI documentation.
[asterisk/asterisk.git] / include / asterisk / manager.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_MANAGER_H
20 #define _ASTERISK_MANAGER_H
21
22 #include "asterisk/network.h"
23 #include "asterisk/lock.h"
24 #include "asterisk/datastore.h"
25 #include "asterisk/xmldoc.h"
26
27 /*!
28  \file
29  \brief The AMI - Asterisk Manager Interface - is a TCP protocol created to
30  manage Asterisk with third-party software.
31
32  Manager protocol packages are text fields of the form a: b.  There is
33  always exactly one space after the colon.
34
35 \verbatim
36
37  For Actions replies, the first line of the reply is a "Response:" header with
38  values "success", "error" or "follows". "Follows" implies that the
39  response is coming as separate events with the same ActionID. If the
40  Action request has no ActionID, it will be hard matching events
41  to the Action request in the manager client.
42
43  The first header type is the "Event" header.  Other headers vary from
44  event to event.  Headers end with standard \\r\\n termination.
45  The last line of the manager response or event is an empty line.
46  (\\r\\n)
47
48 \endverbatim
49
50  \note Please try to \b re-use \b existing \b headers to simplify manager message parsing in clients.
51     Don't re-use an existing header with a new meaning, please.
52     You can find a reference of standard headers in doc/manager.txt
53
54 - \ref manager.c Main manager code file
55  */
56
57 #define AMI_VERSION                     "1.1"
58 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
59
60 /*! \name Manager event classes */
61 /*@{ */
62 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
63 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
64 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
65 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
66 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
67 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
68 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
69 #define EVENT_FLAG_CONFIG               (1 << 7) /* Ability to modify configurations */
70 #define EVENT_FLAG_DTMF                 (1 << 8) /* Ability to read DTMF events */
71 #define EVENT_FLAG_REPORTING            (1 << 9) /* Reporting events such as rtcp sent */
72 #define EVENT_FLAG_CDR                  (1 << 10) /* CDR events */
73 #define EVENT_FLAG_DIALPLAN             (1 << 11) /* Dialplan events (VarSet, NewExten) */
74 #define EVENT_FLAG_ORIGINATE    (1 << 12) /* Originate a call to an extension */
75 #define EVENT_FLAG_AGI                  (1 << 13) /* AGI events */
76 #define EVENT_FLAG_HOOKRESPONSE         (1 << 14) /* Hook Response */
77 /*@} */
78
79 /*! \brief Export manager structures */
80 #define AST_MAX_MANHEADERS 128
81
82 /*! \brief Manager Helper Function */
83 typedef int (*manager_hook_t)(int, const char *, char *); 
84
85
86 struct manager_custom_hook {
87         /*! Identifier */
88         char *file;
89         /*! helper function */
90         manager_hook_t helper;
91         /*! Linked list information */
92         AST_RWLIST_ENTRY(manager_custom_hook) list;
93 };
94
95 /*! \brief Check if AMI is enabled */
96 int check_manager_enabled(void);
97
98 /*! \brief Check if AMI/HTTP is enabled */
99 int check_webmanager_enabled(void);
100
101 /*! Add a custom hook to be called when an event is fired 
102  \param hook struct manager_custom_hook object to add
103 */
104 void ast_manager_register_hook(struct manager_custom_hook *hook);
105
106 /*! Delete a custom hook to be called when an event is fired
107     \param hook struct manager_custom_hook object to delete
108 */
109 void ast_manager_unregister_hook(struct manager_custom_hook *hook);
110
111 /*! \brief Registered hooks can call this function to invoke actions and they will receive responses through registered callback
112  * \param hookid the file identifier specified in manager_custom_hook struct when registering a hook
113  * \param msg ami action mesage string e.g. "Action: SipPeers\r\n"
114
115  * \retval 0 on Success
116  * \retval non-zero on Failure
117 */
118 int ast_hook_send_action(struct manager_custom_hook *hook, const char *msg);
119
120 struct mansession;
121
122 struct message {
123         unsigned int hdrcount;
124         const char *headers[AST_MAX_MANHEADERS];
125 };
126
127 struct manager_action {
128         /*! Name of the action */
129         const char *action;
130         AST_DECLARE_STRING_FIELDS(
131                 AST_STRING_FIELD(synopsis);     /*!< Synopsis text (short description). */
132                 AST_STRING_FIELD(description);  /*!< Description (help text) */
133                 AST_STRING_FIELD(syntax);       /*!< Syntax text */
134                 AST_STRING_FIELD(arguments);    /*!< Description of each argument. */
135                 AST_STRING_FIELD(seealso);      /*!< See also */
136         );
137         /*! Permission required for action.  EVENT_FLAG_* */
138         int authority;
139         /*! Function to be called */
140         int (*func)(struct mansession *s, const struct message *m);
141         /*! Where the documentation come from. */
142         enum ast_doc_src docsrc;
143         /*! For easy linking */
144         AST_RWLIST_ENTRY(manager_action) list;
145 };
146
147 /*! \brief External routines may register/unregister manager callbacks this way 
148  * \note  Use ast_manager_register2() to register with help text for new manager commands */
149 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
150
151 /*! \brief Register a manager callback using XML documentation to describe the manager. */
152 #define ast_manager_register_xml(a, b, c) ast_manager_register2(a, b, c, NULL, NULL)
153
154 /*! \brief Register a manager command with the manager interface 
155         \param action Name of the requested Action:
156         \param authority Required authority for this command
157         \param func Function to call for this command
158         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
159         \param description Help text, several lines
160 */
161 int ast_manager_register2(
162         const char *action,
163         int authority,
164         int (*func)(struct mansession *s, const struct message *m),
165         const char *synopsis,
166         const char *description);
167
168 /*! \brief Unregister a registered manager command 
169         \param action Name of registered Action:
170 */
171 int ast_manager_unregister( char *action );
172
173 /*! 
174  * \brief Verify a session's read permissions against a permission mask.  
175  * \param ident session identity
176  * \param perm permission mask to verify
177  * \retval 1 if the session has the permission mask capabilities
178  * \retval 0 otherwise
179  */
180 int astman_verify_session_readpermissions(uint32_t ident, int perm);
181
182 /*!
183  * \brief Verify a session's write permissions against a permission mask.  
184  * \param ident session identity
185  * \param perm permission mask to verify
186  * \retval 1 if the session has the permission mask capabilities, otherwise 0
187  * \retval 0 otherwise
188  */
189 int astman_verify_session_writepermissions(uint32_t ident, int perm);
190
191 /*! \brief External routines may send asterisk manager events this way 
192  *      \param category Event category, matches manager authorization
193         \param event    Event name
194         \param contents Contents of event
195 */
196
197 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
198  * between the last arg before VA_ARGS and the comma */
199 #define manager_event(category, event, contents , ...)  \
200         __ast_manager_event_multichan(category, event, 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
201 #define ast_manager_event(chan, category, event, contents , ...) \
202         do { \
203                 struct ast_channel *_chans[] = { chan, }; \
204                 __ast_manager_event_multichan(category, event, 1, _chans, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__); \
205         } while (0)
206 #define ast_manager_event_multichan(category, event, nchans, chans, contents , ...) \
207         __ast_manager_event_multichan(category, event, nchans, chans, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__);
208
209 /*! External routines may send asterisk manager events this way
210  * \param category Event category, matches manager authorization
211  * \param event Event name
212  * \param chancount Number of channels in chans parameter
213  * \param chans A pointer to an array of channels involved in the event
214  * \param contents Format string describing event
215  * \since 1.8
216 */
217 int __ast_manager_event_multichan(int category, const char *event, int chancount,
218                 struct ast_channel **chans, const char *file, int line, const char *func,
219                 const char *contents, ...) __attribute__((format(printf, 8, 9)));
220
221 /*! \brief Get header from mananger transaction */
222 const char *astman_get_header(const struct message *m, char *var);
223
224 /*! \brief Get a linked list of the Variable: headers */
225 struct ast_variable *astman_get_variables(const struct message *m);
226
227 /*! \brief Send error in manager transaction */
228 void astman_send_error(struct mansession *s, const struct message *m, char *error);
229
230 /*! \brief Send response in manager transaction */
231 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg);
232
233 /*! \brief Send ack in manager transaction */
234 void astman_send_ack(struct mansession *s, const struct message *m, char *msg);
235
236 /*! \brief Send ack in manager list transaction */
237 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag);
238
239 void __attribute__((format(printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...);
240
241 /*! \brief Determinie if a manager session ident is authenticated */
242 int astman_is_authed(uint32_t ident);
243
244 /*! \brief Called by Asterisk initialization */
245 int init_manager(void);
246
247 /*! \brief Called by Asterisk module functions and the CLI command */
248 int reload_manager(void);
249
250 /*! 
251  * \brief Add a datastore to a session
252  *
253  * \retval 0 success
254  * \retval non-zero failure
255  * \since 1.6.1
256  */
257
258 int astman_datastore_add(struct mansession *s, struct ast_datastore *datastore);
259
260 /*! 
261  * \brief Remove a datastore from a session
262  *
263  * \retval 0 success
264  * \retval non-zero failure
265  * \since 1.6.1
266  */
267 int astman_datastore_remove(struct mansession *s, struct ast_datastore *datastore);
268
269 /*! 
270  * \brief Find a datastore on a session
271  *
272  * \retval pointer to the datastore if found
273  * \retval NULL if not found
274  * \since 1.6.1
275  */
276 struct ast_datastore *astman_datastore_find(struct mansession *s, const struct ast_datastore_info *info, const char *uid);
277
278 #endif /* _ASTERISK_MANAGER_H */