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