res_ari: Add http prefix to generated docs
[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         /*! File descriptor for whatever file we want to respond with */
99         int fd;
100         /*! Corresponding text for the response code */
101         const char *response_text; /* Shouldn't http.c handle this? */
102         /*! Flag to indicate that no further response is needed */
103         int no_response:1;
104 };
105
106 /*!
107  * Add a resource for REST handling.
108  * \param handler Handler to add.
109  * \return 0 on success.
110  * \return non-zero on failure.
111  */
112 int ast_ari_add_handler(struct stasis_rest_handlers *handler);
113
114 /*!
115  * Remove a resource for REST handling.
116  * \param handler Handler to add.
117  * \return 0 on success.
118  * \return non-zero on failure.
119  */
120 int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
121
122 /*!
123  * \internal
124  * \brief Stasis RESTful invocation handler.
125  *
126  * Only call from res_ari and test_ari. Only public to allow
127  * for unit testing.
128  *
129  * \param ser TCP/TLS connection.
130  * \param uri HTTP URI, relative to the API path.
131  * \param method HTTP method.
132  * \param get_params HTTP \c GET parameters.
133  * \param headers HTTP headers.
134  * \param[out] response RESTful HTTP response.
135  */
136 void ast_ari_invoke(struct ast_tcptls_session_instance *ser,
137         const char *uri, enum ast_http_method method,
138         struct ast_variable *get_params, struct ast_variable *headers,
139         struct ast_ari_response *response);
140
141 /*!
142  * \internal
143  * \brief Service function for API declarations.
144  *
145  * Only call from res_ari and test_ari. Only public to allow
146  * for unit testing.
147  *
148  * \param uri Requested URI, relative to the docs path.
149  * \param prefix prefix that prefixes all http requests
150  * \param headers HTTP headers.
151  * \param[out] response RESTful HTTP response.
152  */
153 void ast_ari_get_docs(const char *uri, const char *prefix, struct ast_variable *headers, struct ast_ari_response *response);
154
155 /*! \brief Abstraction for reading/writing JSON to a WebSocket */
156 struct ast_ari_websocket_session;
157
158 /*!
159  * \brief Create an ARI WebSocket session.
160  *
161  * If \c NULL is given for the validator function, no validation will be
162  * performed.
163  *
164  * \param ws_session Underlying WebSocket session.
165  * \param validator Function to validate outgoing messages.
166  * \return New ARI WebSocket session.
167  * \return \c NULL on error.
168  */
169 struct ast_ari_websocket_session *ast_ari_websocket_session_create(
170         struct ast_websocket *ws_session, int (*validator)(struct ast_json *));
171
172 /*!
173  * \brief Read a message from an ARI WebSocket.
174  *
175  * \param session Session to read from.
176  * \return Message received.
177  * \return \c NULL if WebSocket could not be read.
178  */
179 struct ast_json *ast_ari_websocket_session_read(
180         struct ast_ari_websocket_session *session);
181
182 /*!
183  * \brief Send a message to an ARI WebSocket.
184  *
185  * \param session Session to write to.
186  * \param message Message to send.
187  * \return 0 on success.
188  * \return Non-zero on error.
189  */
190 int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
191         struct ast_json *message);
192
193 /*!
194  * \brief Get the Session ID for an ARI WebSocket.
195  *
196  * \param session Session to query.
197  * \return Session ID.
198  * \return \c NULL on error.
199  */
200 const char *ast_ari_websocket_session_id(
201         const struct ast_ari_websocket_session *session);
202
203 /*!
204  * \brief The stock message to return when out of memory.
205  *
206  * The refcount is NOT bumped on this object, so ast_json_ref() if you want to
207  * keep the reference.
208  *
209  * \return JSON message specifying an out-of-memory error.
210  */
211 struct ast_json *ast_ari_oom_json(void);
212
213 /*!
214  * \brief Fill in an error \a ast_ari_response.
215  * \param response Response to fill in.
216  * \param response_code HTTP response code.
217  * \param response_text Text corresponding to the HTTP response code.
218  * \param message_fmt Error message format string.
219  */
220 void ast_ari_response_error(struct ast_ari_response *response,
221                                 int response_code,
222                                 const char *response_text,
223                                 const char *message_fmt, ...)
224 __attribute__((format(printf, 4, 5)));
225
226 /*!
227  * \brief Fill in an \c OK (200) \a ast_ari_response.
228  * \param response Response to fill in.
229  * \param message JSON response.  This reference is stolen, so just \ref
230  *                ast_json_ref if you need to keep a reference to it.
231  */
232 void ast_ari_response_ok(struct ast_ari_response *response,
233                              struct ast_json *message);
234
235 /*!
236  * \brief Fill in a <tt>No Content</tt> (204) \a ast_ari_response.
237  */
238 void ast_ari_response_no_content(struct ast_ari_response *response);
239
240 /*!
241  * \brief Fill in a <tt>Accepted</tt> (202) \a ast_ari_response.
242  */
243 void ast_ari_response_accepted(struct ast_ari_response *response);
244
245 /*!
246  * \brief Fill in a <tt>Created</tt> (201) \a ast_ari_response.
247  * \param response Response to fill in.
248  * \param url URL to the created resource.
249  * \param message JSON response.  This reference is stolen, so just \ref
250  *                ast_json_ref if you need to keep a reference to it.
251  */
252 void ast_ari_response_created(struct ast_ari_response *response,
253         const char *url, struct ast_json *message);
254
255 /*!
256  * \brief Fill in \a response with a 500 message for allocation failures.
257  * \param response Response to fill in.
258  */
259 void ast_ari_response_alloc_failed(struct ast_ari_response *response);
260
261 #endif /* _ASTERISK_ARI_H */