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