c9f47a6e5876997be8d6a2859027cb01ad0907c7
[asterisk/asterisk.git] / include / asterisk / ari.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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_ARI_H
20 #define _ASTERISK_ARI_H
21
22 /*! \file
23  *
24  * \brief Asterisk RESTful API hooks.
25  *
26  * This header file is used mostly as glue code between generated declarations
27  * and res_ari.c.
28  *
29  * \author David M. Lee, II <dlee@digium.com>
30  */
31
32 #include "asterisk/http.h"
33 #include "asterisk/json.h"
34
35 /* Forward-declare websocket structs. This avoids including http_websocket.h,
36  * which causes optional_api stuff to happen, which makes optional_api more
37  * difficult to debug. */
38
39 struct ast_websocket_server;
40
41 struct ast_websocket;
42
43 /*!
44  * \brief Configured encoding format for JSON output.
45  * \return JSON output encoding (compact, pretty, etc.)
46  */
47 enum ast_json_encoding_format ast_ari_json_format(void);
48
49 struct ast_ari_response;
50
51 /*!
52  * \brief Callback type for RESTful method handlers.
53  * \param ser TCP/TLS session object
54  * \param get_params GET parameters from the HTTP request.
55  * \param path_vars Path variables from any wildcard path segments.
56  * \param headers HTTP headers from the HTTP requiest.
57  * \param[out] response The RESTful response.
58  */
59 typedef void (*stasis_rest_callback)(
60         struct ast_tcptls_session_instance *ser,
61         struct ast_variable *get_params, struct ast_variable *path_vars,
62         struct ast_variable *headers, struct ast_ari_response *response);
63
64 /*!
65  * \brief Handler for a single RESTful path segment.
66  */
67 struct stasis_rest_handlers {
68         /*! Path segement to handle */
69         const char *path_segment;
70         /*! If true (non-zero), path_segment is a wildcard, and will match all
71          * values.
72          *
73          * Value of the segement will be passed into the \a path_vars parameter
74          * of the callback.
75          */
76         int is_wildcard;
77         /*! Callbacks for all handled HTTP methods. */
78         stasis_rest_callback callbacks[AST_HTTP_MAX_METHOD];
79         /*! WebSocket server for handling WebSocket upgrades. */
80         struct ast_websocket_server *ws_server;
81         /*! Number of children in the children array */
82         size_t num_children;
83         /*! Handlers for sub-paths */
84         struct stasis_rest_handlers *children[];
85 };
86
87 /*!
88  * Response type for RESTful requests
89  */
90 struct ast_ari_response {
91         /*! Response message */
92         struct ast_json *message;
93         /*! \r\n seperated response headers */
94         struct ast_str *headers;
95         /*! HTTP response code.
96          * See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html */
97         int response_code;
98         /*! Corresponding text for the response code */
99         const char *response_text; /* Shouldn't http.c handle this? */
100         /*! Flag to indicate that no further response is needed */
101         int no_response:1;
102 };
103
104 /*!
105  * Add a resource for REST handling.
106  * \param handler Handler to add.
107  * \return 0 on success.
108  * \return non-zero on failure.
109  */
110 int ast_ari_add_handler(struct stasis_rest_handlers *handler);
111
112 /*!
113  * Remove a resource for REST handling.
114  * \param handler Handler to add.
115  * \return 0 on success.
116  * \return non-zero on failure.
117  */
118 int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
119
120 /*!
121  * \internal
122  * \brief Stasis RESTful invocation handler.
123  *
124  * Only call from res_ari and test_ari. Only public to allow
125  * for unit testing.
126  *
127  * \param ser TCP/TLS connection.
128  * \param uri HTTP URI, relative to the API path.
129  * \param method HTTP method.
130  * \param get_params HTTP \c GET parameters.
131  * \param headers HTTP headers.
132  * \param[out] response RESTful HTTP response.
133  */
134 void ast_ari_invoke(struct ast_tcptls_session_instance *ser,
135         const char *uri, enum ast_http_method method,
136         struct ast_variable *get_params, struct ast_variable *headers,
137         struct ast_ari_response *response);
138
139 /*!
140  * \internal
141  * \brief Service function for API declarations.
142  *
143  * Only call from res_ari and test_ari. Only public to allow
144  * for unit testing.
145  *
146  * \param uri Requested URI, relative to the docs path.
147  * \param headers HTTP headers.
148  * \param[out] response RESTful HTTP response.
149  */
150 void ast_ari_get_docs(const char *uri, struct ast_variable *headers, struct ast_ari_response *response);
151
152 /*! \brief Abstraction for reading/writing JSON to a WebSocket */
153 struct ast_ari_websocket_session;
154
155 /*!
156  * \brief Create an ARI WebSocket session.
157  *
158  * If \c NULL is given for the validator function, no validation will be
159  * performed.
160  *
161  * \param ws_session Underlying WebSocket session.
162  * \param validator Function to validate outgoing messages.
163  * \return New ARI WebSocket session.
164  * \return \c NULL on error.
165  */
166 struct ast_ari_websocket_session *ast_ari_websocket_session_create(
167         struct ast_websocket *ws_session, int (*validator)(struct ast_json *));
168
169 /*!
170  * \brief Read a message from an ARI WebSocket.
171  *
172  * \param session Session to read from.
173  * \return Message received.
174  * \return \c NULL if WebSocket could not be read.
175  */
176 struct ast_json *ast_ari_websocket_session_read(
177         struct ast_ari_websocket_session *session);
178
179 /*!
180  * \brief Send a message to an ARI WebSocket.
181  *
182  * \param session Session to write to.
183  * \param message Message to send.
184  * \return 0 on success.
185  * \return Non-zero on error.
186  */
187 int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
188         struct ast_json *message);
189
190 /*!
191  * \brief Get the Session ID for an ARI WebSocket.
192  *
193  * \param session Session to query.
194  * \return Session ID.
195  * \return \c NULL on error.
196  */
197 const char *ast_ari_websocket_session_id(
198         const struct ast_ari_websocket_session *session);
199
200 /*!
201  * \brief The stock message to return when out of memory.
202  *
203  * The refcount is NOT bumped on this object, so ast_json_ref() if you want to
204  * keep the reference.
205  *
206  * \return JSON message specifying an out-of-memory error.
207  */
208 struct ast_json *ast_ari_oom_json(void);
209
210 /*!
211  * \brief Fill in an error \a ast_ari_response.
212  * \param response Response to fill in.
213  * \param response_code HTTP response code.
214  * \param response_text Text corresponding to the HTTP response code.
215  * \param message_fmt Error message format string.
216  */
217 void ast_ari_response_error(struct ast_ari_response *response,
218                                 int response_code,
219                                 const char *response_text,
220                                 const char *message_fmt, ...)
221 __attribute__((format(printf, 4, 5)));
222
223 /*!
224  * \brief Fill in an \c OK (200) \a ast_ari_response.
225  * \param response Response to fill in.
226  * \param message JSON response.  This reference is stolen, so just \ref
227  *                ast_json_ref if you need to keep a reference to it.
228  */
229 void ast_ari_response_ok(struct ast_ari_response *response,
230                              struct ast_json *message);
231
232 /*!
233  * \brief Fill in a <tt>No Content</tt> (204) \a ast_ari_response.
234  */
235 void ast_ari_response_no_content(struct ast_ari_response *response);
236
237 /*!
238  * \brief Fill in a <tt>Accepted</tt> (202) \a ast_ari_response.
239  */
240 void ast_ari_response_accepted(struct ast_ari_response *response);
241
242 /*!
243  * \brief Fill in a <tt>Created</tt> (201) \a ast_ari_response.
244  * \param response Response to fill in.
245  * \param url URL to the created resource.
246  * \param message JSON response.  This reference is stolen, so just \ref
247  *                ast_json_ref if you need to keep a reference to it.
248  */
249 void ast_ari_response_created(struct ast_ari_response *response,
250         const char *url, struct ast_json *message);
251
252 /*!
253  * \brief Fill in \a response with a 500 message for allocation failures.
254  * \param response Response to fill in.
255  */
256 void ast_ari_response_alloc_failed(struct ast_ari_response *response);
257
258 #endif /* _ASTERISK_ARI_H */