Rename everything Stasis-HTTP to ARI
[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_stasis</depend>
42         <support_level>core</support_level>
43  ***/
44
45 #include "asterisk.h"
46
47 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
48
49 #include "asterisk/module.h"
50 #include "asterisk/stasis_app.h"
51 #include "ari/resource_{{name}}.h"
52 #if defined(AST_DEVMODE)
53 #include "ari/ari_model_validators.h"
54 #endif
55
56 {{#apis}}
57 {{#operations}}
58 {{#is_req}}
59 /*!
60  * \brief Parameter parsing callback for {{path}}.
61  * \param get_params GET parameters in the HTTP request.
62  * \param path_vars Path variables extracted from the request.
63  * \param headers HTTP headers.
64  * \param[out] response Response to the HTTP request.
65  */
66 static void ast_ari_{{c_nickname}}_cb(
67         struct ast_variable *get_params, struct ast_variable *path_vars,
68         struct ast_variable *headers, struct ast_ari_response *response)
69 {
70 #if defined(AST_DEVMODE)
71         int is_valid;
72         int code;
73 #endif /* AST_DEVMODE */
74
75 {{> param_parsing}}
76         ast_ari_{{c_nickname}}(headers, &args, response);
77 #if defined(AST_DEVMODE)
78         code = response->response_code;
79
80         switch (code) {
81         case 0: /* Implementation is still a stub, or the code wasn't set */
82                 is_valid = response->message == NULL;
83                 break;
84         case 500: /* Internal Server Error */
85         case 501: /* Not Implemented */
86 {{#error_responses}}
87         case {{code}}: /* {{{reason}}} */
88 {{/error_responses}}
89                 is_valid = 1;
90                 break;
91         default:
92                 if (200 <= code && code <= 299) {
93 {{#response_class}}
94 {{#is_list}}
95                         is_valid = ast_ari_validate_list(response->message,
96                                 ast_ari_validate_{{c_singular_name}}_fn());
97 {{/is_list}}
98 {{^is_list}}
99                         is_valid = ast_ari_validate_{{c_name}}(
100                                 response->message);
101 {{/is_list}}
102 {{/response_class}}
103                 } else {
104                         ast_log(LOG_ERROR, "Invalid error response %d for {{path}}\n", code);
105                         is_valid = 0;
106                 }
107         }
108
109         if (!is_valid) {
110                 ast_log(LOG_ERROR, "Response validation failed for {{path}}\n");
111                 ast_ari_response_error(response, 500,
112                         "Internal Server Error", "Response validation failed");
113         }
114 #endif /* AST_DEVMODE */
115 }
116 {{/is_req}}
117 {{#is_websocket}}
118 static void ast_ari_{{c_nickname}}_ws_cb(struct ast_websocket *ws_session,
119         struct ast_variable *get_params, struct ast_variable *headers)
120 {
121         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
122         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
123 {{#has_path_parameters}}
124         /* TODO: It's not immediately obvious how to pass path params through
125          * the websocket code to this callback. Not needed right now, so we'll
126          * just punt. */
127         struct ast_variable *path_vars = NULL;
128 {{/has_path_parameters}}
129 {{> param_parsing}}
130 #if defined(AST_DEVMODE)
131         session = ast_ari_websocket_session_create(ws_session,
132                 ast_ari_validate_{{response_class.c_name}}_fn());
133 #else
134         session = ast_ari_websocket_session_create(ws_session, NULL);
135 #endif
136         if (!session) {
137                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
138                 return;
139         }
140         ast_ari_websocket_{{c_nickname}}(session, headers, &args);
141 }
142 {{/is_websocket}}
143 {{/operations}}
144 {{/apis}}
145
146 {{! The rest_handler partial expands to the tree of stasis_rest_handlers }}
147 {{#root_path}}
148 {{> rest_handler}}
149 {{/root_path}}
150
151 static int load_module(void)
152 {
153         int res = 0;
154 {{#apis}}
155 {{#has_websocket}}
156         {{full_name}}.ws_server = ast_websocket_server_create();
157         if (!{{full_name}}.ws_server) {
158                 return AST_MODULE_LOAD_FAILURE;
159         }
160 {{/has_websocket}}
161 {{#operations}}
162 {{#is_websocket}}
163         res |= ast_websocket_server_add_protocol({{full_name}}.ws_server,
164                 "{{websocket_protocol}}", ast_ari_{{c_nickname}}_ws_cb);
165 {{/is_websocket}}
166 {{/operations}}
167 {{/apis}}
168         stasis_app_ref();
169         res |= ast_ari_add_handler(&{{root_full_name}});
170         return res;
171 }
172
173 static int unload_module(void)
174 {
175         ast_ari_remove_handler(&{{root_full_name}});
176 {{#apis}}
177 {{#has_websocket}}
178         ao2_cleanup({{full_name}}.ws_server);
179         {{full_name}}.ws_server = NULL;
180 {{/has_websocket}}
181 {{/apis}}
182         stasis_app_unref();
183         return 0;
184 }
185
186 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - {{{description}}}",
187         .load = load_module,
188         .unload = unload_module,
189         .nonoptreq = "res_ari,res_stasis",
190         );
191 {{/api_declaration}}