aboutsummaryrefslogtreecommitdiff
path: root/include/magi/request.h
blob: 03e0c43a2e9d183935932ad12420f50eaa32c339 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
#ifndef MAGI_INCLUDED_REQUEST
#define MAGI_INCLUDED_REQUEST
/** @file request.h
 * @brief blah...
 *
 * blah-blah...
 */
#include "cookie.h"
#include "error.h"
#include "file.h"
#include "param.h"


typedef struct magi_request_limits {
    int cookies;
    int params_meta;
    int params_head;
    int params_body;
} magi_request_limits;


/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**
 * Request handler.
 *
 * Can be created via 'magi_{gateway interface name}_head', but will have
 * nullified 'POST'-related fields ('params' & 'files').  Reason is unlimited
 * 'POST' body size, with possible dependence of wanted limits from data of
 * headers (e.g. session id from cookies, enabling some users to load more).
 * To proceed 'post' use 'magi_{gateway interface name}_body', specifying
 * settings if necessary.
 *
 * Or just use shortcut 'magi_{gateway interface_name}' to do both parts. */
typedef struct magi_request {
    magi_error  error;

    magi_cookies *cookies;
    magi_params  *meta;
    magi_params  *head;
    magi_params  *body;
    magi_files   *files;

    char *method;
    int   is_secure;
    char *address;
    int   port;
    char *script;
    char *path;

    magi_file_callback  callback;
    magi_request_limits limits;

    struct magi_response_implementation *response;
} magi_request;


void magi_request_init(magi_request *r);
void magi_request_free(magi_request *r);


char *magi_request_meta(magi_request *r, const char *name);

char *magi_request_param(magi_request *r, const char *name);
char *magi_request_urlparam(magi_request *r, const char *name);

magi_file *magi_request_file(magi_request *r, const char *name);

char        *magi_request_cookie(magi_request *r, const char *name);
magi_cookie *magi_request_cookie_complex(magi_request *r, const char *name);


#endif