ecc047829363d65800b96088f501be0035873dbe
[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
25 /*!
26  \file
27  \brief The AMI - Asterisk Manager Interface - is a TCP protocol created to
28  manage Asterisk with third-party software.
29
30  Manager protocol packages are text fields of the form a: b.  There is
31  always exactly one space after the colon.
32
33 \verbatim
34
35  For Actions replies, the first line of the reply is a "Response:" header with
36  values "success", "error" or "follows". "Follows" implies that the
37  response is coming as separate events with the same ActionID. If the
38  Action request has no ActionID, it will be hard matching events
39  to the Action request in the manager client.
40
41  The first header type is the "Event" header.  Other headers vary from
42  event to event.  Headers end with standard \\r\\n termination.
43  The last line of the manager response or event is an empty line.
44  (\\r\\n)
45
46 \endverbatim
47
48  \note Please try to \b re-use \b existing \b headers to simplify manager message parsing in clients.
49     Don't re-use an existing header with a new meaning, please.
50     You can find a reference of standard headers in doc/manager.txt
51
52 - \ref manager.c Main manager code file
53  */
54
55 #define AMI_VERSION                     "1.1"
56 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
57
58 /*! \name Manager event classes */
59 /*@{ */
60 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
61 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
62 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
63 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
64 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
65 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
66 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
67 #define EVENT_FLAG_CONFIG               (1 << 7) /* Ability to modify configurations */
68 #define EVENT_FLAG_DTMF                 (1 << 8) /* Ability to read DTMF events */
69 #define EVENT_FLAG_REPORTING            (1 << 9) /* Reporting events such as rtcp sent */
70 #define EVENT_FLAG_CDR                  (1 << 10) /* CDR events */
71 #define EVENT_FLAG_DIALPLAN             (1 << 11) /* Dialplan events (VarSet, NewExten) */
72 #define EVENT_FLAG_ORIGINATE    (1 << 12) /* Originate a call to an extension */
73 /*@} */
74
75 /*! \brief Export manager structures */
76 #define AST_MAX_MANHEADERS 128
77
78 /*! \brief Manager Helper Function */
79 typedef int (*manager_hook_t)(int, const char *, char *); 
80
81
82 struct manager_custom_hook {
83         /*! Identifier */
84         char *file;
85         /*! helper function */
86         manager_hook_t helper;
87         /*! Linked list information */
88         AST_RWLIST_ENTRY(manager_custom_hook) list;
89 };
90
91 /*! \brief Check if AMI is enabled */
92 int check_manager_enabled(void);
93
94 /*! \brief Check if AMI/HTTP is enabled */
95 int check_webmanager_enabled(void);
96
97 /*! Add a custom hook to be called when an event is fired 
98  \param hook struct manager_custom_hook object to add
99 */
100 void ast_manager_register_hook(struct manager_custom_hook *hook);
101
102 /*! Delete a custom hook to be called when an event is fired
103     \param hook struct manager_custom_hook object to delete
104 */
105 void ast_manager_unregister_hook(struct manager_custom_hook *hook);
106
107 struct mansession;
108
109 struct message {
110         unsigned int hdrcount;
111         const char *headers[AST_MAX_MANHEADERS];
112 };
113
114 struct manager_action {
115         /*! Name of the action */
116         const char *action;
117         /*! Short description of the action */
118         const char *synopsis;
119         /*! Detailed description of the action */
120         const char *description;
121         /*! Permission required for action.  EVENT_FLAG_* */
122         int authority;
123         /*! Function to be called */
124         int (*func)(struct mansession *s, const struct message *m);
125         /*! For easy linking */
126         AST_RWLIST_ENTRY(manager_action) list;
127 };
128
129 /*! \brief External routines may register/unregister manager callbacks this way 
130  * \note  Use ast_manager_register2() to register with help text for new manager commands */
131 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
132
133
134 /*! \brief Register a manager command with the manager interface 
135         \param action Name of the requested Action:
136         \param authority Required authority for this command
137         \param func Function to call for this command
138         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
139         \param description Help text, several lines
140 */
141 int ast_manager_register2(
142         const char *action,
143         int authority,
144         int (*func)(struct mansession *s, const struct message *m),
145         const char *synopsis,
146         const char *description);
147
148 /*! \brief Unregister a registred manager command 
149         \param action Name of registred Action:
150 */
151 int ast_manager_unregister( char *action );
152
153 /*! 
154  * \brief Verify a session's read permissions against a permission mask.  
155  * \param ident session identity
156  * \param perm permission mask to verify
157  * \retval 1 if the session has the permission mask capabilities
158  * \retval 0 otherwise
159  */
160 int astman_verify_session_readpermissions(uint32_t ident, int perm);
161
162 /*!
163  * \brief Verify a session's write permissions against a permission mask.  
164  * \param ident session identity
165  * \param perm permission mask to verify
166  * \retval 1 if the session has the permission mask capabilities, otherwise 0
167  * \retval 0 otherwise
168  */
169 int astman_verify_session_writepermissions(uint32_t ident, int perm);
170
171 /*! \brief External routines may send asterisk manager events this way 
172  *      \param category Event category, matches manager authorization
173         \param event    Event name
174         \param contents Contents of event
175 */
176
177 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
178  * between the last arg before VA_ARGS and the comma */
179 #define manager_event(category, event, contents , ...)  \
180         __manager_event(category, event, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
181
182 int __attribute__ ((format(printf, 6, 7))) __manager_event(int category, const char *event,
183                                                            const char *file, int line, const char *func,
184                                                            const char *contents, ...);
185
186 /*! \brief Get header from mananger transaction */
187 const char *astman_get_header(const struct message *m, char *var);
188
189 /*! \brief Get a linked list of the Variable: headers */
190 struct ast_variable *astman_get_variables(const struct message *m);
191
192 /*! \brief Send error in manager transaction */
193 void astman_send_error(struct mansession *s, const struct message *m, char *error);
194
195 /*! \brief Send response in manager transaction */
196 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg);
197
198 /*! \brief Send ack in manager transaction */
199 void astman_send_ack(struct mansession *s, const struct message *m, char *msg);
200
201 /*! \brief Send ack in manager list transaction */
202 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag);
203
204 void __attribute__ ((format (printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...);
205
206 /*! \brief Determinie if a manager session ident is authenticated */
207 int astman_is_authed(uint32_t ident);
208
209 /*! \brief Called by Asterisk initialization */
210 int init_manager(void);
211
212 /*! \brief Called by Asterisk module functions and the CLI command */
213 int reload_manager(void);
214
215 #endif /* _ASTERISK_MANAGER_H */