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