00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * 00008 * See http://www.asterisk.org for more information about 00009 * the Asterisk project. Please do not directly contact 00010 * any of the maintainers of this project for assistance; 00011 * the project provides a web site, mailing lists and IRC 00012 * channels for your use. 00013 * 00014 * This program is free software, distributed under the terms of 00015 * the GNU General Public License Version 2. See the LICENSE file 00016 * at the top of the source tree. 00017 */ 00018 00019 #ifndef _ASTERISK_MANAGER_H 00020 #define _ASTERISK_MANAGER_H 00021 00022 #include <stdarg.h> 00023 #include <sys/types.h> 00024 #include <sys/socket.h> 00025 #include <netinet/in.h> 00026 #include <arpa/inet.h> 00027 00028 #include "asterisk/lock.h" 00029 00030 /*! 00031 \file 00032 \brief The AMI - Asterisk Manager Interface - is a TCP protocol created to 00033 manage Asterisk with third-party software. 00034 00035 Manager protocol packages are text fields of the form a: b. There is 00036 always exactly one space after the colon. 00037 00038 The first header type is the "Event" header. Other headers vary from 00039 event to event. Headers end with standard \r\n termination. 00040 The last line of the manager response or event is an empty line. 00041 (\r\n) 00042 00043 ** Please try to re-use existing headers to simplify manager message parsing in clients. 00044 Don't re-use an existing header with a new meaning, please. 00045 You can find a reference of standard headers in doc/manager.txt 00046 */ 00047 00048 #define DEFAULT_MANAGER_PORT 5038 /* Default port for Asterisk management via TCP */ 00049 00050 #define EVENT_FLAG_SYSTEM (1 << 0) /* System events such as module load/unload */ 00051 #define EVENT_FLAG_CALL (1 << 1) /* Call event, such as state change, etc */ 00052 #define EVENT_FLAG_LOG (1 << 2) /* Log events */ 00053 #define EVENT_FLAG_VERBOSE (1 << 3) /* Verbose messages */ 00054 #define EVENT_FLAG_COMMAND (1 << 4) /* Ability to read/set commands */ 00055 #define EVENT_FLAG_AGENT (1 << 5) /* Ability to read/set agent info */ 00056 #define EVENT_FLAG_USER (1 << 6) /* Ability to read/set user info */ 00057 #define EVENT_FLAG_CONFIG (1 << 7) /* Ability to modify configurations */ 00058 00059 /* Export manager structures */ 00060 #define AST_MAX_MANHEADERS 128 00061 00062 struct mansession; 00063 00064 struct message { 00065 unsigned int hdrcount; 00066 const char *headers[AST_MAX_MANHEADERS]; 00067 }; 00068 00069 struct manager_action { 00070 /*! Name of the action */ 00071 const char *action; 00072 /*! Short description of the action */ 00073 const char *synopsis; 00074 /*! Detailed description of the action */ 00075 const char *description; 00076 /*! Permission required for action. EVENT_FLAG_* */ 00077 int authority; 00078 /*! Function to be called */ 00079 int (*func)(struct mansession *s, const struct message *m); 00080 /*! For easy linking */ 00081 struct manager_action *next; 00082 }; 00083 00084 /* External routines may register/unregister manager callbacks this way */ 00085 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL) 00086 00087 /* Use ast_manager_register2 to register with help text for new manager commands */ 00088 00089 /*! Register a manager command with the manager interface */ 00090 /*! \param action Name of the requested Action: 00091 \param authority Required authority for this command 00092 \param func Function to call for this command 00093 \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands 00094 \param description Help text, several lines 00095 */ 00096 int ast_manager_register2( 00097 const char *action, 00098 int authority, 00099 int (*func)(struct mansession *s, const struct message *m), 00100 const char *synopsis, 00101 const char *description); 00102 00103 /*! Unregister a registred manager command */ 00104 /*! \param action Name of registred Action: 00105 */ 00106 int ast_manager_unregister( char *action ); 00107 00108 /*! 00109 * \brief Verify a session's read permissions against a permission mask. 00110 * \param ident session identity 00111 * \param perm permission mask to verify 00112 * \returns 1 if the session has the permission mask capabilities, otherwise 0 00113 */ 00114 int astman_verify_session_readpermissions(unsigned long ident, int perm); 00115 00116 /*! 00117 * \brief Verify a session's write permissions against a permission mask. 00118 * \param ident session identity 00119 * \param perm permission mask to verify 00120 * \returns 1 if the session has the permission mask capabilities, otherwise 0 00121 */ 00122 int astman_verify_session_writepermissions(unsigned long ident, int perm); 00123 00124 /*! External routines may send asterisk manager events this way */ 00125 /*! \param category Event category, matches manager authorization 00126 \param event Event name 00127 \param contents Contents of event 00128 */ 00129 int __attribute__ ((format (printf, 3,4))) manager_event(int category, const char *event, const char *contents, ...); 00130 00131 /*! Get header from mananger transaction */ 00132 const char *astman_get_header(const struct message *m, char *var); 00133 00134 /*! Get a linked list of the Variable: headers */ 00135 struct ast_variable *astman_get_variables(const struct message *m); 00136 00137 /*! Send error in manager transaction */ 00138 void astman_send_error(struct mansession *s, const struct message *m, char *error); 00139 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg); 00140 void astman_send_ack(struct mansession *s, const struct message *m, char *msg); 00141 00142 void __attribute__ ((format (printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...); 00143 00144 /*! Called by Asterisk initialization */ 00145 int init_manager(void); 00146 int reload_manager(void); 00147 00148 #endif /* _ASTERISK_MANAGER_H */