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 #define EVENT_FLAG_CONFIG               (1 << 7) /* Ability to modify configurations */
  58
  59 /* Export manager structures */
  60 #define AST_MAX_MANHEADERS 80
  61
  62 /* Manager Helper Function */
  63 typedef int (*manager_hook_t)(int, const char *, char *);
  64
  65 struct manager_custom_hook {
  66         /*! Identifier */
  67         char *file;
  68         /*! helper function */
  69         manager_hook_t helper;
  70         /*! Linked list information */
  71         AST_RWLIST_ENTRY(manager_custom_hook) list;
  72 };
  73
  74 /*! Add a custom hook to be called when an event is fired */
  75 /*! \param hook struct manager_custom_hook object to add
  76 */
  77 void ast_manager_register_hook(struct manager_custom_hook *hook);
  78
  79 /*! Delete a custom hook to be called when an event is fired */
  80 /*! \param hook struct manager_custom_hook object to delete
  81 */
  82 void ast_manager_unregister_hook(struct manager_custom_hook *hook);
  83
  84 struct mansession;
  85
  86 struct message {
  87         unsigned int hdrcount;
  88         const char *headers[AST_MAX_MANHEADERS];
  89 };
  90
  91 struct manager_action {
  92         /*! Name of the action */
  93         const char *action;
  94         /*! Short description of the action */
  95         const char *synopsis;
  96         /*! Detailed description of the action */
  97         const char *description;
  98         /*! Permission required for action.  EVENT_FLAG_* */
  99         int authority;
 100         /*! Function to be called */
 101         int (*func)(struct mansession *s, const struct message *m);
 102         /*! For easy linking */
 103         struct manager_action *next;
 104 };
 105
 106 /* External routines may register/unregister manager callbacks this way */
 107 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
 108
 109 /* Use ast_manager_register2 to register with help text for new manager commands */
 110
 111 /*! Register a manager command with the manager interface */
 112 /*!     \param action Name of the requested Action:
 113         \param authority Required authority for this command
 114         \param func Function to call for this command
 115         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
 116         \param description Help text, several lines
 117 */
 118 int ast_manager_register2(
 119         const char *action,
 120         int authority,
 121         int (*func)(struct mansession *s, const struct message *m),
 122         const char *synopsis,
 123         const char *description);
 124
 125 /*! Unregister a registred manager command */
 126 /*!     \param action Name of registred Action:
 127 */
 128 int ast_manager_unregister( char *action );
 129
 130 /*! External routines may send asterisk manager events this way */
 131 /*!     \param category Event category, matches manager authorization
 132         \param event    Event name
 133         \param contents Contents of event
 134 */
 135
 136 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
 137  * between the last arg before VA_ARGS and the comma */
 138 #define manager_event(category, event, contents , ...)  \
 139         __manager_event(category, event, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
 140
 141 int __attribute__ ((format(printf, 6, 7))) __manager_event(int category, const char *event,
 142                                                            const char *file, int line, const char *func,
 143                                                            const char *contents, ...);
 144
 145 /*! Get header from mananger transaction */
 146 const char *astman_get_header(const struct message *m, char *var);
 147
 148 /*! Get a linked list of the Variable: headers */
 149 struct ast_variable *astman_get_variables(const struct message *m);
 150
 151 /*! Send error in manager transaction */
 152 void astman_send_error(struct mansession *s, const struct message *m, char *error);
 153 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg);
 154 void astman_send_ack(struct mansession *s, const struct message *m, char *msg);
 155 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag);
 156
 157 void __attribute__ ((format (printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...);
 158
 159 /*! Called by Asterisk initialization */
 160 int init_manager(void);
 161 int reload_manager(void);
 162
 163 #endif /* _ASTERISK_MANAGER_H */