f20a901064d25195f63f1ff1961f0589ffee7dd5
[asterisk/asterisk.git] / include / asterisk / stasis_http.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_STASIS_HTTP_H
20 #define _ASTERISK_STASIS_HTTP_H
21
22 /*! \file
23  *
24  * \brief Stasis RESTful API hooks.
25  *
26  * This header file is used mostly as glue code between generated declarations
27  * and res_stasis_http.c.
28  *
29  * \author David M. Lee, II <dlee@digium.com>
30  */
31
32 #include "asterisk/http.h"
33 #include "asterisk/json.h"
34 #include "asterisk/http_websocket.h"
35
36 struct stasis_http_response;
37
38 /*!
39  * \brief Callback type for RESTful method handlers.
40  * \param get_params GET parameters from the HTTP request.
41  * \param path_vars Path variables from any wildcard path segments.
42  * \param headers HTTP headers from the HTTP requiest.
43  * \param[out] response The RESTful response.
44  */
45 typedef void (*stasis_rest_callback)(struct ast_variable *get_params,
46                                      struct ast_variable *path_vars,
47                                      struct ast_variable *headers,
48                                      struct stasis_http_response *response);
49
50 /*!
51  * \brief Handler for a single RESTful path segment.
52  */
53 struct stasis_rest_handlers {
54         /*! Path segement to handle */
55         const char *path_segment;
56         /*! If true (non-zero), path_segment is a wildcard, and will match all values.
57          *
58          * Value of the segement will be passed into the \a path_vars parameter of the callback.
59          */
60         int is_wildcard;
61         /*! Callbacks for all handled HTTP methods. */
62         stasis_rest_callback callbacks[AST_HTTP_MAX_METHOD];
63         /*! Number of children in the children array */
64         size_t num_children;
65         /*! Handlers for sub-paths */
66         struct stasis_rest_handlers *children[];
67 };
68
69 /*!
70  * Response type for RESTful requests
71  */
72 struct stasis_http_response {
73         /*! Response message */
74         struct ast_json *message;
75         /*! \r\n seperated response headers */
76         struct ast_str *headers;
77         /*! HTTP response code.
78          * See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html */
79         int response_code;
80         /*! Corresponding text for the response code */
81         const char *response_text; // Shouldn't http.c handle this?
82 };
83
84 /*!
85  * Add a resource for REST handling.
86  * \param handler Handler to add.
87  * \return 0 on success.
88  * \return non-zero on failure.
89  */
90 int stasis_http_add_handler(struct stasis_rest_handlers *handler);
91
92 /*!
93  * Remove a resource for REST handling.
94  * \param handler Handler to add.
95  * \return 0 on success.
96  * \return non-zero on failure.
97  */
98 int stasis_http_remove_handler(struct stasis_rest_handlers *handler);
99
100 /*!
101  * \internal
102  * \brief Stasis RESTful invocation handler.
103  *
104  * Only call from res_stasis_http and test_stasis_http. Only public to allow
105  * for unit testing.
106  *
107  * \param uri HTTP URI, relative to the API path.
108  * \param method HTTP method.
109  * \param get_params HTTP \c GET parameters.
110  * \param headers HTTP headers.
111  * \param[out] response RESTful HTTP response.
112  */
113 void stasis_http_invoke(const char *uri, enum ast_http_method method, struct ast_variable *get_params,
114                         struct ast_variable *headers, struct stasis_http_response *response);
115
116 /*!
117  * \internal
118  * \brief Service function for API declarations.
119  *
120  * Only call from res_stasis_http and test_stasis_http. Only public to allow
121  * for unit testing.
122  *
123  * \param uri Requested URI, relative to the docs path.
124  * \param headers HTTP headers.
125  * \param[out] response RESTful HTTP response.
126  */
127 void stasis_http_get_docs(const char *uri, struct ast_variable *headers, struct stasis_http_response *response);
128
129 /*!
130  * \internal
131  * \brief Stasis WebSocket connection handler
132  * \param session WebSocket session.
133  * \param parameters HTTP \c GET parameters.
134  * \param headers HTTP headers.
135  */
136 void stasis_websocket_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers);
137
138 /*!
139  * \brief Fill in an error \a stasis_http_response.
140  * \param response Response to fill in.
141  * \param response_code HTTP response code.
142  * \param response_text Text corresponding to the HTTP response code.
143  * \param message_fmt Error message format string.
144  */
145 void stasis_http_response_error(struct stasis_http_response *response,
146                                 int response_code,
147                                 const char *response_text,
148                                 const char *message_fmt, ...)
149 __attribute__((format(printf, 4, 5)));
150
151 /*!
152  * \brief Fill in an \c OK (200) \a stasis_http_response.
153  * \param response Response to fill in.
154  * \param message JSON response.  This reference is stolen, so just \ref
155  *                ast_json_incref if you need to keep a reference to it.
156  */
157 void stasis_http_response_ok(struct stasis_http_response *response,
158                              struct ast_json *message);
159
160 /*!
161  * \brief Fill in a <tt>No Content</tt> (204) \a stasis_http_response.
162  */
163 void stasis_http_response_no_content(struct stasis_http_response *response);
164
165 /*!
166  * \brief Fill in a <tt>Created</tt> (201) \a stasis_http_response.
167  */
168 void stasis_http_response_created(struct stasis_http_response *response,
169         const char *url, struct ast_json *message);
170
171 /*!
172  * \brief Fill in \a response with a 500 message for allocation failures.
173  * \param response Response to fill in.
174  */
175 void stasis_http_response_alloc_failed(struct stasis_http_response *response);
176
177 #endif /* _ASTERISK_STASIS_HTTP_H */