loader: Add dependency fields to module structures.
[asterisk/asterisk.git] / rest-api-templates / res_ari_resource.c.mustache
1 {{#api_declaration}}
2 /*
3  * Asterisk -- An open source telephony toolkit.
4  *
5  * {{{copyright}}}
6  *
7  * {{{author}}}
8 {{! Template Copyright
9  * Copyright (C) 2013, Digium, Inc.
10  *
11  * David M. Lee, II <dlee@digium.com>
12 }}
13  *
14  * See http://www.asterisk.org for more information about
15  * the Asterisk project. Please do not directly contact
16  * any of the maintainers of this project for assistance;
17  * the project provides a web site, mailing lists and IRC
18  * channels for your use.
19  *
20  * This program is free software, distributed under the terms of
21  * the GNU General Public License Version 2. See the LICENSE file
22  * at the top of the source tree.
23  */
24
25 {{! Template for rendering the res_ module for an HTTP resource. }}
26 /*
27 {{> do-not-edit}}
28  * This file is generated by a mustache template. Please see the original
29  * template in rest-api-templates/res_ari_resource.c.mustache
30  */
31
32 /*! \file
33  *
34  * \brief {{{description}}}
35  *
36  * \author {{{author}}}
37  */
38
39 /*** MODULEINFO
40         <depend type="module">res_ari</depend>
41         <depend type="module">res_ari_model</depend>
42         <depend type="module">res_stasis</depend>
43         <support_level>core</support_level>
44  ***/
45
46 #include "asterisk.h"
47
48 #include "asterisk/app.h"
49 #include "asterisk/module.h"
50 #include "asterisk/stasis_app.h"
51 #include "ari/resource_{{c_name}}.h"
52 #if defined(AST_DEVMODE)
53 #include "ari/ari_model_validators.h"
54 #endif
55 {{^has_websocket}}
56 {{! Only include http_websocket if necessary. Otherwise we'll do a lot of
57  *  unnecessary optional_api intialization, which makes optional_api harder
58  *  to debug
59  }}
60 #include "asterisk/http_websocket.h"
61 {{/has_websocket}}
62
63 #define MAX_VALS 128
64
65 {{#apis}}
66 {{#operations}}
67 {{#is_req}}
68 {{> body_parsing}}
69 /*!
70  * \brief Parameter parsing callback for {{path}}.
71  * \param get_params GET parameters in the HTTP request.
72  * \param path_vars Path variables extracted from the request.
73  * \param headers HTTP headers.
74  * \param[out] response Response to the HTTP request.
75  */
76 static void ast_ari_{{c_name}}_{{c_nickname}}_cb(
77         struct ast_tcptls_session_instance *ser,
78         struct ast_variable *get_params, struct ast_variable *path_vars,
79         struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
80 {
81         struct ast_ari_{{c_name}}_{{c_nickname}}_args args = {};
82 {{#has_parameters}}
83         struct ast_variable *i;
84 {{/has_parameters}}
85 #if defined(AST_DEVMODE)
86         int is_valid;
87         int code;
88 #endif /* AST_DEVMODE */
89
90 {{> param_parsing}}
91 {{^is_binary_response}}
92         ast_ari_{{c_name}}_{{c_nickname}}(headers, &args, response);
93 {{/is_binary_response}}
94 {{#is_binary_response}}
95         ast_ari_{{c_name}}_{{c_nickname}}(ser, headers, &args, response);
96 {{/is_binary_response}}
97 #if defined(AST_DEVMODE)
98         code = response->response_code;
99
100         switch (code) {
101         case 0: /* Implementation is still a stub, or the code wasn't set */
102                 is_valid = response->message == NULL;
103                 break;
104         case 500: /* Internal Server Error */
105         case 501: /* Not Implemented */
106 {{#error_responses}}
107         case {{code}}: /* {{{reason}}} */
108 {{/error_responses}}
109                 is_valid = 1;
110                 break;
111         default:
112                 if (200 <= code && code <= 299) {
113 {{#response_class}}
114 {{#is_list}}
115                         is_valid = ast_ari_validate_list(response->message,
116                                 ast_ari_validate_{{c_singular_name}}_fn());
117 {{/is_list}}
118 {{^is_list}}
119 {{^is_binary_response}}
120                         is_valid = ast_ari_validate_{{c_name}}(
121                                 response->message);
122 {{/is_binary_response}}
123 {{#is_binary_response}}
124                         /* No validation on a raw binary response */
125                         is_valid = 1;
126 {{/is_binary_response}}
127 {{/is_list}}
128 {{/response_class}}
129                 } else {
130                         ast_log(LOG_ERROR, "Invalid error response %d for {{path}}\n", code);
131                         is_valid = 0;
132                 }
133         }
134
135         if (!is_valid) {
136                 ast_log(LOG_ERROR, "Response validation failed for {{path}}\n");
137                 ast_ari_response_error(response, 500,
138                         "Internal Server Error", "Response validation failed");
139         }
140 #endif /* AST_DEVMODE */
141
142 fin: __attribute__((unused))
143 {{> param_cleanup}}
144         return;
145 }
146 {{/is_req}}
147 {{#is_websocket}}
148 static int ast_ari_{{c_name}}_{{c_nickname}}_ws_attempted_cb(struct ast_tcptls_session_instance *ser,
149         struct ast_variable *get_params, struct ast_variable *headers, const char *session_id)
150 {
151         struct ast_ari_{{c_name}}_{{c_nickname}}_args args = {};
152 {{#has_parameters}}
153         int res = 0;
154         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
155         struct ast_variable *i;
156 {{/has_parameters}}
157
158 {{#has_parameters}}
159         response = ast_calloc(1, sizeof(*response));
160         if (!response) {
161                 ast_log(LOG_ERROR, "Failed to create response.\n");
162                 goto fin;
163         }
164 {{/has_parameters}}
165
166 {{> param_parsing}}
167
168         res = ast_ari_websocket_{{c_name}}_{{c_nickname}}_attempted(ser, headers, &args, session_id);
169
170 fin: __attribute__((unused))
171         if (!response) {
172                 ast_http_error(ser, 500, "Server Error", "Memory allocation error");
173                 res = -1;
174         } else if (response->response_code != 0) {
175                 /* Param parsing failure */
176                 RAII_VAR(char *, msg, NULL, ast_json_free);
177                 if (response->message) {
178                         msg = ast_json_dump_string(response->message);
179                 } else {
180                         ast_log(LOG_ERROR, "Missing response message\n");
181                 }
182
183                 if (msg) {
184                         ast_http_error(ser, response->response_code, response->response_text, msg);
185                 }
186                 res = -1;
187         }
188 {{> param_cleanup}}
189 {{#has_parameters}}
190         return res;
191 {{/has_parameters}}
192 }
193
194 static void ast_ari_{{c_name}}_{{c_nickname}}_ws_established_cb(struct ast_websocket *ws_session,
195         struct ast_variable *get_params, struct ast_variable *headers)
196 {
197         struct ast_ari_{{c_name}}_{{c_nickname}}_args args = {};
198 {{#has_parameters}}
199         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
200         struct ast_variable *i;
201 {{/has_parameters}}
202         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
203         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
204 {{#has_path_parameters}}
205         /* TODO: It's not immediately obvious how to pass path params through
206          * the websocket code to this callback. Not needed right now, so we'll
207          * just punt. */
208         struct ast_variable *path_vars = NULL;
209 {{/has_path_parameters}}
210
211 {{#has_parameters}}
212         response = ast_calloc(1, sizeof(*response));
213         if (!response) {
214                 ast_log(LOG_ERROR, "Failed to create response.\n");
215                 goto fin;
216         }
217 {{/has_parameters}}
218
219 #if defined(AST_DEVMODE)
220         session = ast_ari_websocket_session_create(ws_session,
221                 ast_ari_validate_{{response_class.c_name}}_fn());
222 #else
223         session = ast_ari_websocket_session_create(ws_session, NULL);
224 #endif
225         if (!session) {
226                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
227                 goto fin;
228         }
229
230 {{> param_parsing}}
231
232         ast_ari_websocket_{{c_name}}_{{c_nickname}}_established(session, headers, &args);
233
234 fin: __attribute__((unused))
235         if (response && response->response_code != 0) {
236                 /* Param parsing failure */
237                 RAII_VAR(char *, msg, NULL, ast_json_free);
238                 if (response->message) {
239                         msg = ast_json_dump_string(response->message);
240                 } else {
241                         ast_log(LOG_ERROR, "Missing response message\n");
242                 }
243                 if (msg) {
244                         ast_websocket_write(ws_session,
245                                 AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
246                 }
247         }
248 {{> param_cleanup}}
249 }
250 {{/is_websocket}}
251 {{/operations}}
252 {{/apis}}
253
254 {{! The rest_handler partial expands to the tree of stasis_rest_handlers }}
255 {{#root_path}}
256 {{> rest_handler}}
257 {{/root_path}}
258
259 static int unload_module(void)
260 {
261         ast_ari_remove_handler(&{{root_full_name}});
262 {{#apis}}
263 {{#has_websocket}}
264         ao2_cleanup({{full_name}}.ws_server);
265         {{full_name}}.ws_server = NULL;
266         ast_ari_websocket_events_event_websocket_dtor();
267 {{/has_websocket}}
268 {{/apis}}
269         stasis_app_unref();
270         return 0;
271 }
272
273 static int load_module(void)
274 {
275         int res = 0;
276
277         CHECK_ARI_MODULE_LOADED();
278
279 {{#apis}}
280 {{#operations}}
281 {{#has_websocket}}
282         /* This is scoped to not conflict with CHECK_ARI_MODULE_LOADED */
283         {
284                 struct ast_websocket_protocol *protocol;
285
286                 if (ast_ari_websocket_{{c_name}}_{{c_nickname}}_init() == -1) {
287                         return AST_MODULE_LOAD_DECLINE;
288                 }
289
290                 {{full_name}}.ws_server = ast_websocket_server_create();
291                 if (!{{full_name}}.ws_server) {
292                         ast_ari_websocket_events_event_websocket_dtor();
293                         return AST_MODULE_LOAD_DECLINE;
294                 }
295
296                 protocol = ast_websocket_sub_protocol_alloc("{{websocket_protocol}}");
297                 if (!protocol) {
298                         ao2_ref({{full_name}}.ws_server, -1);
299                         {{full_name}}.ws_server = NULL;
300                         ast_ari_websocket_events_event_websocket_dtor();
301                         return AST_MODULE_LOAD_DECLINE;
302                 }
303                 protocol->session_attempted = ast_ari_{{c_name}}_{{c_nickname}}_ws_attempted_cb;
304                 protocol->session_established = ast_ari_{{c_name}}_{{c_nickname}}_ws_established_cb;
305 {{/has_websocket}}
306 {{#is_websocket}}
307                 res |= ast_websocket_server_add_protocol2({{full_name}}.ws_server, protocol);
308         }
309 {{/is_websocket}}
310 {{/operations}}
311 {{/apis}}
312
313         stasis_app_ref();
314         res |= ast_ari_add_handler(&{{root_full_name}});
315         if (res) {
316                 unload_module();
317                 return AST_MODULE_LOAD_DECLINE;
318         }
319
320         return AST_MODULE_LOAD_SUCCESS;
321 }
322
323 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - {{{description}}}",
324         .support_level = AST_MODULE_SUPPORT_CORE,
325         .load = load_module,
326         .unload = unload_module,
327         .requires = "res_ari,res_ari_model,res_stasis",
328 );
329 {{/api_declaration}}