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 struct AFB_clientCtx;
  21 struct json_object;
  22 struct hreq_data;
  23 struct afb_hsrv;
  24 struct afb_req_itf;
  25 struct locale_search;
  26
  27 extern const struct afb_req_itf afb_hreq_req_itf;
  28
  29 struct afb_hreq {
  30         /*
  31          * CAUTION: 'context' field should be the first because there
  32          * is an implicit convertion to struct afb_context
  33          */
  34         struct afb_context context;
  35         int refcount;
  36         struct afb_hsrv *hsrv;
  37         const char *cacheTimeout;
  38         struct MHD_Connection *connection;
  39         int method;
  40         int reqid;
  41         int scanned;
  42         int suspended;
  43         int replied;
  44         const char *version;
  45         const char *lang;
  46         const char *url;
  47         size_t lenurl;
  48         const char *tail;
  49         size_t lentail;
  50         struct MHD_PostProcessor *postform;
  51         struct hreq_data *data;
  52         struct json_object *json;
  53         int upgrade;
  54 };
  55
  56 extern int afb_hreq_unprefix(struct afb_hreq *request, const char *prefix, size_t length);
  57
  58 extern int afb_hreq_valid_tail(struct afb_hreq *request);
  59
  60 extern void afb_hreq_reply_error(struct afb_hreq *request, unsigned int status);
  61
  62 extern int afb_hreq_reply_file_if_exist(struct afb_hreq *request, int dirfd, const char *filename);
  63
  64 extern int afb_hreq_reply_file(struct afb_hreq *request, int dirfd, const char *filename);
  65
  66 extern int afb_hreq_reply_locale_file_if_exist(struct afb_hreq *hreq, struct locale_search *search, const char *filename);
  67
  68 extern int afb_hreq_reply_locale_file(struct afb_hreq *hreq, struct locale_search *search, const char *filename);
  69
  70 extern void afb_hreq_redirect_to(struct afb_hreq *request, const char *url, int add_query_part);
  71
  72 extern int afb_hreq_redirect_to_ending_slash_if_needed(struct afb_hreq *hreq);
  73
  74 extern const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name);
  75
  76 extern const char *afb_hreq_get_header(struct afb_hreq *hreq, const char *name);
  77
  78 extern const char *afb_hreq_get_argument(struct afb_hreq *hreq, const char *name);
  79
  80 extern int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *name, const char *file, const char *data, size_t size);
  81
  82 extern int afb_hreq_post_add(struct afb_hreq *hreq, const char *name, const char *data, size_t size);
  83
  84 extern struct afb_req afb_hreq_to_req(struct afb_hreq *hreq);
  85
  86 extern int afb_hreq_init_context(struct afb_hreq *hreq);
  87
  88 extern int afb_hreq_init_cookie(int port, const char *path, int maxage);
  89
  90 extern void afb_hreq_reply_static(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...);
  91
  92 extern void afb_hreq_reply_copy(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...);
  93
  94 extern void afb_hreq_reply_free(struct afb_hreq *hreq, unsigned status, size_t size, char *buffer, ...);
  95
  96 extern void afb_hreq_reply_empty(struct afb_hreq *hreq, unsigned status, ...);
  97
  98 extern int afb_hreq_init_download_path(const char *directory);
  99
 100 extern void afb_hreq_addref(struct afb_hreq *hreq);
 101
 102 extern void afb_hreq_unref(struct afb_hreq *hreq);
 103