1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2012 - 2013, Digium, Inc.
*
* David M. Lee, II <dlee@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
#ifndef _ASTERISK_STASIS_HTTP_H
#define _ASTERISK_STASIS_HTTP_H
/*! \file
*
* \brief Stasis RESTful API hooks.
*
* This header file is used mostly as glue code between generated declarations
* and res_stasis_http.c.
*
* \author David M. Lee, II <dlee@digium.com>
*/
#include "asterisk/http.h"
#include "asterisk/json.h"
#include "asterisk/http_websocket.h"
struct stasis_http_response;
/*!
* \brief Callback type for RESTful method handlers.
* \param get_params GET parameters from the HTTP request.
* \param path_vars Path variables from any wildcard path segments.
* \param headers HTTP headers from the HTTP requiest.
* \param[out] response The RESTful response.
*/
typedef void (*stasis_rest_callback)(struct ast_variable *get_params,
struct ast_variable *path_vars,
struct ast_variable *headers,
struct stasis_http_response *response);
/*!
* \brief Handler for a single RESTful path segment.
*/
struct stasis_rest_handlers {
/*! Path segement to handle */
const char *path_segment;
/*! If true (non-zero), path_segment is a wildcard, and will match all
* values.
*
* Value of the segement will be passed into the \a path_vars parameter
* of the callback.
*/
int is_wildcard;
/*! Callbacks for all handled HTTP methods. */
stasis_rest_callback callbacks[AST_HTTP_MAX_METHOD];
/*! WebSocket server for handling WebSocket upgrades. */
struct ast_websocket_server *ws_server;
/*! Number of children in the children array */
size_t num_children;
/*! Handlers for sub-paths */
struct stasis_rest_handlers *children[];
};
/*!
* Response type for RESTful requests
*/
struct stasis_http_response {
/*! Response message */
struct ast_json *message;
/*! \r\n seperated response headers */
struct ast_str *headers;
/*! HTTP response code.
* See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html */
int response_code;
/*! Corresponding text for the response code */
const char *response_text; /* Shouldn't http.c handle this? */
/*! Flag to indicate that no further response is needed */
int no_response:1;
};
/*!
* Add a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
*/
int stasis_http_add_handler(struct stasis_rest_handlers *handler);
/*!
* Remove a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
*/
int stasis_http_remove_handler(struct stasis_rest_handlers *handler);
/*!
* \internal
* \brief Stasis RESTful invocation handler.
*
* Only call from res_stasis_http and test_stasis_http. Only public to allow
* for unit testing.
*
* \param ser TCP/TLS connection.
* \param uri HTTP URI, relative to the API path.
* \param method HTTP method.
* \param get_params HTTP \c GET parameters.
* \param headers HTTP headers.
* \param[out] response RESTful HTTP response.
*/
void stasis_http_invoke(struct ast_tcptls_session_instance *ser,
const char *uri, enum ast_http_method method,
struct ast_variable *get_params, struct ast_variable *headers,
struct stasis_http_response *response);
/*!
* \internal
* \brief Service function for API declarations.
*
* Only call from res_stasis_http and test_stasis_http. Only public to allow
* for unit testing.
*
* \param uri Requested URI, relative to the docs path.
* \param headers HTTP headers.
* \param[out] response RESTful HTTP response.
*/
void stasis_http_get_docs(const char *uri, struct ast_variable *headers, struct stasis_http_response *response);
/*! \brief Abstraction for reading/writing JSON to a WebSocket */
struct ari_websocket_session;
/*!
* \brief Create an ARI WebSocket session.
*
* \param ws_session Underlying WebSocket session.
* \return New ARI WebSocket session.
* \return \c NULL on error.
*/
struct ari_websocket_session *ari_websocket_session_create(
struct ast_websocket *ws_session);
/*!
* \brief Read a message from an ARI WebSocket.
*
* \param session Session to read from.
* \return Message received.
* \return \c NULL if WebSocket could not be read.
*/
struct ast_json *ari_websocket_session_read(
struct ari_websocket_session *session);
/*!
* \brief Send a message to an ARI WebSocket.
*
* \param session Session to write to.
* \param message Message to send.
* \return 0 on success.
* \return Non-zero on error.
*/
int ari_websocket_session_write(struct ari_websocket_session *session,
struct ast_json *message);
/*!
* \brief The stock message to return when out of memory.
*
* The refcount is NOT bumped on this object, so ast_json_ref() if you want to
* keep the reference.
*
* \return JSON message specifying an out-of-memory error.
*/
struct ast_json *ari_oom_json(void);
/*!
* \brief Fill in an error \a stasis_http_response.
* \param response Response to fill in.
* \param response_code HTTP response code.
* \param response_text Text corresponding to the HTTP response code.
* \param message_fmt Error message format string.
*/
void stasis_http_response_error(struct stasis_http_response *response,
int response_code,
const char *response_text,
const char *message_fmt, ...)
__attribute__((format(printf, 4, 5)));
/*!
* \brief Fill in an \c OK (200) \a stasis_http_response.
* \param response Response to fill in.
* \param message JSON response. This reference is stolen, so just \ref
* ast_json_incref if you need to keep a reference to it.
*/
void stasis_http_response_ok(struct stasis_http_response *response,
struct ast_json *message);
/*!
* \brief Fill in a <tt>No Content</tt> (204) \a stasis_http_response.
*/
void stasis_http_response_no_content(struct stasis_http_response *response);
/*!
* \brief Fill in a <tt>Created</tt> (201) \a stasis_http_response.
*/
void stasis_http_response_created(struct stasis_http_response *response,
const char *url, struct ast_json *message);
/*!
* \brief Fill in \a response with a 500 message for allocation failures.
* \param response Response to fill in.
*/
void stasis_http_response_alloc_failed(struct stasis_http_response *response);
#endif /* _ASTERISK_STASIS_HTTP_H */
|
