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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
#ifndef MAGI_INCLUDED_REQUEST
#define MAGI_INCLUDED_REQUEST
#include "cookie.h"
#include "error.h"
#include "file.h"
#include "param.h"
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Request
*
* Can be created via 'magi_request_{gateway interface name}', 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_request_resume_{gateway interface name}',
* specifying settings if necessary.
*
*
* Cheatsheet on environment:
*
* Request URL: http[s]://{server_name}[:{server_port}]{uri}
* example.com 80
* uri: {document_uri}[?{urlencode(url_params)}]
* alfar=9973&veles=on
* document_uri: {script_name}{path_info}
* /bin/script /article/magic
*/
struct magi_request {
/* * * Results * * */
/* All pointers of this section must be valid as 'free' arguments. */
/* Parsed */
struct magi_cookie_list * cookies;
struct magi_param_list * http_params; /* HTTP Header parameters */
struct magi_param_list * url_params; /* Paramteres from URL */
struct magi_param_list * params; /* Parameters from 'post' body */
struct magi_file_list * files; /* 'Post' multipart files */
/* Environment Shortcuts */
char * method; /* REQUEST_METHOD */
char * uri; /* REQUEST_URI */
char * document_root; /* DOCUMENT_ROOT */
char * document_uri; /* DOCUMENT_URI */
char * script_name; /* SCRIPT_NAME */
char * script_filename; /* SCRIPT_FILENAME */
char * remote_addr; /* REMOTE_ADDR */
char * remote_port; /* REMOTE_PORT */
char * server_addr; /* SERVER_ADDR */
char * server_name; /* SERVER_NAME */
/* server_name can be not a domain name, even if request is done with it.
* (Use http_params["HTTP_HOST"] instead.) */
char * server_port; /* SERVER_PORT */
char * server_protocol; /* SERVER_PROTOCOL */
char * server_software; /* SERVER_COFTWARE */
char * path_info; /* PATH_INFO */
/* Request Error Code */
enum magi_error error;
/* * * Settings * * */
/* Callback for processing files */
void (*file_callback)(struct magi_file * file,
char * addon,
int addon_len,
int is_addon_last,
void * userdata);
void * file_callback_userdata;
int file_callback_addon_max;
/* Limits for memory used (null <=> unlimitted) */
int cookies_max;
int url_params_max;
int http_params_max;
int params_max;
};
/* Setup request with default settings. */
void magi_request_setup(struct magi_request * request);
/* Destroys request. */
void magi_request_destroy(struct magi_request * request);
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Tempfiles Callback
*/
struct magi_tempfile {
const char * param_name; /* Form field name, in which file is expected. */
const char * location; /* Location to load file in. */
int maximum; /* Null <=> unlimited. */
};
struct magi_tempfiles {
int count;
struct magi_tempfile * tmps;
};
void magi_tempfiles_add(struct magi_tempfiles * tmps,
const char * name,
const char * path,
int max);
void magi_tempfiles_destroy(struct magi_tempfiles * tmps);
/* Setup request callback with files loaded into corresponding to their
* parameter names locations; paths are in magi_tempfiles struct. */
void magi_request_setup_tempfiles(struct magi_request * request,
struct magi_tempfiles * table);
#endif
|
