More "moremanager" changes - doxygen docs and changing manager version (finally)
[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  ** Please try to re-use existing 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
53 #define AMI_VERSION                     "1.1"
54 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
55
56 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
57 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
58 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
59 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
60 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
61 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
62 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
63 #define EVENT_FLAG_CONFIG               (1 << 7) /* Ability to modify configurations */
64 #define EVENT_FLAG_DTMF                 (1 << 8) /* Ability to read DTMF events */
65 #define EVENT_FLAG_REPORTING            (1 << 9) /* Reporting events such as rtcp sent */
66 /* Export manager structures */
67 #define AST_MAX_MANHEADERS 128
68
69 /* Manager Helper Function */
70 typedef int (*manager_hook_t)(int, const char *, char *); 
71
72
73 struct manager_custom_hook {
74         /*! Identifier */
75         char *file;
76         /*! helper function */
77         manager_hook_t helper;
78         /*! Linked list information */
79         AST_RWLIST_ENTRY(manager_custom_hook) list;
80 };
81
82 /*! \brief Check if AMI is enabled */
83 int check_manager_enabled(void);
84
85 /*! \brief Check if AMI/HTTP is enabled */
86 int check_webmanager_enabled(void);
87
88 /*! Add a custom hook to be called when an event is fired */
89 /*! \param hook struct manager_custom_hook object to add
90 */
91 void ast_manager_register_hook(struct manager_custom_hook *hook);
92
93 /*! Delete a custom hook to be called when an event is fired */
94 /*! \param hook struct manager_custom_hook object to delete
95 */
96 void ast_manager_unregister_hook(struct manager_custom_hook *hook);
97
98 struct mansession;
99
100 struct message {
101         unsigned int hdrcount;
102         const char *headers[AST_MAX_MANHEADERS];
103 };
104
105 struct manager_action {
106         /*! Name of the action */
107         const char *action;
108         /*! Short description of the action */
109         const char *synopsis;
110         /*! Detailed description of the action */
111         const char *description;
112         /*! Permission required for action.  EVENT_FLAG_* */
113         int authority;
114         /*! Function to be called */
115         int (*func)(struct mansession *s, const struct message *m);
116         /*! For easy linking */
117         AST_RWLIST_ENTRY(manager_action) list;
118 };
119
120 /* External routines may register/unregister manager callbacks this way */
121 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
122
123 /* Use ast_manager_register2 to register with help text for new manager commands */
124
125 /*! Register a manager command with the manager interface */
126 /*!     \param action Name of the requested Action:
127         \param authority Required authority for this command
128         \param func Function to call for this command
129         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
130         \param description Help text, several lines
131 */
132 int ast_manager_register2(
133         const char *action,
134         int authority,
135         int (*func)(struct mansession *s, const struct message *m),
136         const char *synopsis,
137         const char *description);
138
139 /*! Unregister a registred manager command */
140 /*!     \param action Name of registred Action:
141 */
142 int ast_manager_unregister( char *action );
143
144 /*! 
145  * \brief Verify a session's read permissions against a permission mask.  
146  * \param ident session identity
147  * \param perm permission mask to verify
148  * \retval 1 if the session has the permission mask capabilities
149  * \retval 0 otherwise
150  */
151 int astman_verify_session_readpermissions(unsigned long ident, int perm);
152
153 /*!
154  * \brief Verify a session's write 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, otherwise 0
158  * \retval 0 otherwise
159  */
160 int astman_verify_session_writepermissions(unsigned long ident, int perm);
161
162 /*! External routines may send asterisk manager events this way */
163 /*!     \param category Event category, matches manager authorization
164         \param event    Event name
165         \param contents Contents of event
166 */
167
168 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
169  * between the last arg before VA_ARGS and the comma */
170 #define manager_event(category, event, contents , ...)  \
171         __manager_event(category, event, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
172
173 int __attribute__ ((format(printf, 6, 7))) __manager_event(int category, const char *event,
174                                                            const char *file, int line, const char *func,
175                                                            const char *contents, ...);
176
177 /*! Get header from mananger transaction */
178 const char *astman_get_header(const struct message *m, char *var);
179
180 /*! Get a linked list of the Variable: headers */
181 struct ast_variable *astman_get_variables(const struct message *m);
182
183 /*! Send error in manager transaction */
184 void astman_send_error(struct mansession *s, const struct message *m, char *error);
185 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg);
186 void astman_send_ack(struct mansession *s, const struct message *m, char *msg);
187 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag);
188
189 void __attribute__ ((format (printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...);
190
191 /*! Called by Asterisk initialization */
192 int init_manager(void);
193 int reload_manager(void);
194
195 #endif /* _ASTERISK_MANAGER_H */