Factorize common code for handling requests
[src/app-framework-binder.git] / src / afb-hreq.h
1 /*
2  * Copyright (C) 2016, 2017 "IoT.bzh"
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #pragma once
19
20 #include "afb-xreq.h"
21
22 struct afb_session;
23 struct json_object;
24 struct hreq_data;
25 struct afb_hsrv;
26 struct locale_search;
27
28 struct afb_hreq {
29         struct afb_xreq xreq;
30         struct afb_hsrv *hsrv;
31         const char *cacheTimeout;
32         struct MHD_Connection *connection;
33         int method;
34         int reqid;
35         int scanned;
36         int suspended;
37         int replied;
38         const char *version;
39         const char *lang;
40         const char *url;
41         size_t lenurl;
42         const char *tail;
43         size_t lentail;
44         struct MHD_PostProcessor *postform;
45         struct hreq_data *data;
46         struct json_object *json;
47         int upgrade;
48 };
49
50 extern int afb_hreq_unprefix(struct afb_hreq *request, const char *prefix, size_t length);
51
52 extern int afb_hreq_valid_tail(struct afb_hreq *request);
53
54 extern void afb_hreq_reply_error(struct afb_hreq *request, unsigned int status);
55
56 extern int afb_hreq_reply_file_if_exist(struct afb_hreq *request, int dirfd, const char *filename);
57
58 extern int afb_hreq_reply_file(struct afb_hreq *request, int dirfd, const char *filename);
59
60 extern int afb_hreq_reply_locale_file_if_exist(struct afb_hreq *hreq, struct locale_search *search, const char *filename);
61
62 extern int afb_hreq_reply_locale_file(struct afb_hreq *hreq, struct locale_search *search, const char *filename);
63
64 extern void afb_hreq_redirect_to(struct afb_hreq *request, const char *url, int add_query_part);
65
66 extern int afb_hreq_redirect_to_ending_slash_if_needed(struct afb_hreq *hreq);
67
68 extern const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name);
69
70 extern const char *afb_hreq_get_header(struct afb_hreq *hreq, const char *name);
71
72 extern const char *afb_hreq_get_argument(struct afb_hreq *hreq, const char *name);
73
74 extern int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *name, const char *file, const char *data, size_t size);
75
76 extern int afb_hreq_post_add(struct afb_hreq *hreq, const char *name, const char *data, size_t size);
77
78 extern int afb_hreq_init_req_call(struct afb_hreq *hreq, const char *api, size_t lenapi, const char *verb, size_t lenverb);
79
80 extern int afb_hreq_init_context(struct afb_hreq *hreq);
81
82 extern int afb_hreq_init_cookie(int port, const char *path, int maxage);
83
84 extern void afb_hreq_reply_static(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...);
85
86 extern void afb_hreq_reply_copy(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...);
87
88 extern void afb_hreq_reply_free(struct afb_hreq *hreq, unsigned status, size_t size, char *buffer, ...);
89
90 extern void afb_hreq_reply_empty(struct afb_hreq *hreq, unsigned status, ...);
91
92 extern int afb_hreq_init_download_path(const char *directory);
93
94 extern void afb_hreq_addref(struct afb_hreq *hreq);
95
96 extern void afb_hreq_unref(struct afb_hreq *hreq);
97
98 extern struct afb_hreq *afb_hreq_create();