Merged revisions 9581 via svnmerge from
[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 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
58 /* Export manager structures */
59 #define AST_MAX_MANHEADERS 80
60 #define AST_MAX_MANHEADER_LEN 256
61
62 struct eventqent {
63         struct eventqent *next;
64         char eventdata[1];
65 };
66
67 struct mansession {
68         /*! Execution thread */
69         pthread_t t;
70         /*! Thread lock -- don't use in action callbacks, it's already taken care of  */
71         ast_mutex_t __lock;
72         /*! socket address */
73         struct sockaddr_in sin;
74         /*! TCP socket */
75         int fd;
76         /*! Whether or not we're busy doing an action */
77         int busy;
78         /*! Whether or not we're "dead" */
79         int dead;
80         /*! Logged in username */
81         char username[80];
82         /*! Authentication challenge */
83         char challenge[10];
84         /*! Authentication status */
85         int authenticated;
86         /*! Authorization for reading */
87         int readperm;
88         /*! Authorization for writing */
89         int writeperm;
90         /*! Buffer */
91         char inbuf[AST_MAX_MANHEADER_LEN];
92         int inlen;
93         int send_events;
94         /* Queued events that we've not had the ability to send yet */
95         struct eventqent *eventq;
96         /* Timeout for ast_carefulwrite() */
97         int writetimeout;
98         struct mansession *next;
99 };
100
101
102 struct message {
103         int hdrcount;
104         char headers[AST_MAX_MANHEADERS][AST_MAX_MANHEADER_LEN];
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, struct message *m);
118         /*! For easy linking */
119         struct manager_action *next;
120 };
121
122 int ast_carefulwrite(int fd, char *s, int len, int timeoutms);
123
124 /* External routines may register/unregister manager callbacks this way */
125 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
126
127 /* Use ast_manager_register2 to register with help text for new manager commands */
128
129 /*! Register a manager command with the manager interface */
130 /*!     \param action Name of the requested Action:
131         \param authority Required authority for this command
132         \param func Function to call for this command
133         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
134         \param description Help text, several lines
135 */
136 int ast_manager_register2( 
137         const char *action, 
138         int authority, 
139         int (*func)(struct mansession *s, struct message *m), 
140         const char *synopsis,
141         const char *description);
142
143 /*! Unregister a registred manager command */
144 /*!     \param action Name of registred Action:
145 */
146 int ast_manager_unregister( char *action );
147
148 /*! External routines may send asterisk manager events this way */
149 /*!     \param category Event category, matches manager authorization
150         \param event    Event name
151         \param contents Contents of event
152 */ 
153 extern int manager_event(int category, const char *event, const char *contents, ...)
154         __attribute__ ((format (printf, 3,4)));
155
156 /*! Get header from mananger transaction */
157 extern char *astman_get_header(struct message *m, char *var);
158
159 /*! Get a linked list of the Variable: headers */
160 struct ast_variable *astman_get_variables(struct message *m);
161
162 /*! Send error in manager transaction */
163 extern void astman_send_error(struct mansession *s, struct message *m, char *error);
164 extern void astman_send_response(struct mansession *s, struct message *m, char *resp, char *msg);
165 extern void astman_send_ack(struct mansession *s, struct message *m, char *msg);
166
167 /*! Called by Asterisk initialization */
168 extern int init_manager(void);
169 /*! Called by Asterisk initialization */
170 extern int reload_manager(void);
171
172 #endif /* _ASTERISK_MANAGER_H */