summaryrefslogtreecommitdiffabout
path: root/include/kingate/cgi_gateway.h
blob: a5c40567cede4ad4bec1420e6c863753f2db4850 (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
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
#ifndef __KINGATE_CGI_GATEWAY_H
#define __KINGATE_CGI_GATEWAY_H

#include <map>
#include "kingate/cgi_interface.h"

#ifndef __deprecated
#if ( __GNUC__ == 3 && __GNUC_MINOR__ > 0 ) || __GNUC__ > 3
#define __deprecated    __attribute__((deprecated))
#else
#define __deprecated
#endif
#endif

/**
 * @file
 * @brief the cgi_gateway -- main interface to CGI.
 */

namespace kingate {
    using namespace std;

    /**
     * The main class interfacing with the CGI environment.
     */
    class cgi_gateway {
	public:
	    /**
	     * The interface to CGI environment (e.g. fastcgi).
	     */
	    cgi_interface& iface;
	    /**
	     * The type describing map holding parameters parsed from query string or input.
	     */
	    typedef multimap<string,string> params_t;
	    /**
	     * The GET-passed parameters.
	     */
	    params_t get;
	    /**
	     * The POST-passed parameters.
	     */
	    params_t post;
	    /**
	     * Was the stdin content parsed?
	     */
	    bool b_parsed_content;

	    /**
	     * @param ci the interface to use.
	     */
	    cgi_gateway(cgi_interface& ci);

	    /**
	     * Check whether there is an 'environment' meta-variable with specific name
	     * passed to CGI.
	     * @param n variable name.
	     * @return true if yes.
	     * @see cgi_interface::has_meta()
	     * @see get_meta()
	     */
	    bool has_meta(const string& n) const { return iface.has_meta(n); }
	    /**
	     * Retrieve the 'environment' meta-variable value.
	     * @param n variable name.
	     * @return variable contents.
	     * @see exception_notfound
	     * @see cgi_interface::get_meta()
	     */
	    const string& get_meta(const string& n) const { return iface.get_meta(n); }

	    /**
	     * fetch reference to the 'stdin' stream.
	     * @return the reference to the corresponding istream object.
	     * @see cgi_interface::in()
	     */
	    istream& in() { return iface.in(); }
	    /**
	     * fetch reference to the 'stdout' stream.
	     * @return the reference to the corresponding ostream object.
	     * @see cgi_interface::out()
	     */
	    ostream& out() { return iface.out(); }
	    /**
	     * fetch reference to the 'stderr' stream.
	     * @return the reference to the corresponding ostream object.
	     * @see cgi_interface::err()
	     */
	    ostream& err() { return iface.err(); }
	    /**
	     * cast to the ostream -- fetches the reference to the 'stdout'
	     * stream.
	     * @see out()
	     */
	    operator ostream& (void) { return out(); }

	    /**
	     * Check to see whether the parameter was passed via GET.
	     * @param n the parameter name.
	     * @return true if yes.
	     */
	    bool has_GET(const string& n) const;
	    /**
	     * Retrieve the parameter passed via GET.
	     * @param n the parameter name.
	     * @return the parameter contents.
	     * @see exception_notfound
	     */
	    const string& get_GET(const string& n) const;
	    /**
	     * Check to see whether the parameter was passed via POST.
	     * @param n the parameter name.
	     * @return true if yes.
	     */
	    bool has_POST(const string& n) const;
	    /**
	     * Retrieve the POST-parameter.
	     * @param n the parameter name.
	     * @return the parameter contents.
	     * @see exception_notfound
	     */
	    const string& get_POST(const string& n) const;
	    /**
	     * Check to see whether the parameter was passed either via POST or
	     * GET.
	     * @param n the parameter name.
	     * @return true if yes.
	     */
	    bool has_param(const string& n) const;
	    /**
	     * Retrieve the parameter passed either via POST or GET
	     * (GET-parameter takes precedence).
	     * @param n the parameter name.
	     * @return true if yes.
	     * @see exception_notfound.
	     */
	    const string& get_param(const string& n) const;

	    /**
	     * Retrieve the POST content-type (as passed via CONTENT_TYPE
	     * environment variable).
	     * @return the content type.
	     */
	    const string& __deprecated get_content_type() const;
	    /**
	     * Retrieve the POST content length (as passed via the
	     * CONTENT_LENGTH environment variable).
	     * @return the content length.
	     */
	    unsigned long __deprecated get_content_length() const;

	    /**
	     * Check to see whether the content from stdin stream was parsed.
	     * @return true if yes.
	     */
	    bool is_content_parsed() const { return b_parsed_content; }

	    /**
	     * Retrieve the HTTP header value from the HTTP_ meta-variable.
	     * (see RFC3875)
	     * @param hn header field name.
	     * @return the HTTP header value.
	     */
	    const string& http_request_header(const string& hn) const;

	    /**
	     * Retrieve the AUTH_TYPE meta-variable (see RFC3875)
	     * @return authentication type.
	     */
	    const string& auth_type() const;
	    /**
	     * Retrieve the CONTENT_LENGTH meta-variable (see RFC3875)
	     * @return size of the request message body.
	     */
	    unsigned long cgi_gateway::content_length() const;
	    /**
	     * Retrieve the CONTENT_TYPE meta-variable (see RFC3875)
	     * @return media type of the request message body.
	     */
	    const string& content_type() const;
	    /**
	     * Retrieve the GATEWAY_INTERFACE meta-variable (see RFC3875)
	     * @return the gateway interface dialect.
	     */
	    const string& gateway_interface() const;
	    /**
	     * Retrieve the PATH_INFO meta-variable (see RFC3875)
	     * @return path to be interpreted by the script.
	     */
	    const string& path_info() const;
	    /**
	     * Retrieve the PATH_TRANSLATED meta-variable (see RFC3875)
	     * @return the translated path to the document.
	     */
	    const string& path_translated() const;
	    /**
	     * Retrieve the QUERY_STRING meta-variable (see RFC3875)
	     * @return the query string.
	     */
	    const string& query_string() const;
	    /**
	     * Retrieve the REMOTE_ADDR meta-variable (see RFC3875)
	     * @return the network address of the remote host.
	     */
	    const string& remote_addr() const;
	    /**
	     * Retrieve the REMOTE_HOST meta-variable (see RFC3875)
	     * @return the fully qualified domain name of the client if
	     * available. REMOTE_ADDR otherwise.
	     * @see remote_addr()
	     */
	    const string& remote_host() const;
	    /**
	     * Retrieve the REMOTE_IDENT meta-variable (see RFC3875)
	     * @return remote user identity (see RFC1413).
	     */
	    const string& remote_ident() const;
	    /**
	     * Retrieve the REMOTE_USER meta-variable (see RFC3875)
	     * @return the authenticated user name.
	     */
	    const string& remote_user() const;
	    /**
	     * Retrieve the REQUEST_METHOD meta-variable (see RFC3875)
	     * @return the http request method.
	     */
	    const string& request_method() const;
	    /**
	     * Retrieve the SCRIPT_NAME meta-variable (see RFC3875)
	     * @return the uri path identifying the script.
	     */
	    const string& script_name() const;
	    /**
	     * Retrieve the SERVER_NAME meta-variable (see RFC3875)
	     * @return the server name of the script.
	     */
	    const string& server_name() const;
	    /**
	     * Retrieve the SERVER_PORT meta-variable (see RFC3875)
	     * @return the port on which request was received.
	     */
	    unsigned int server_port() const;
	    /**
	     * Retrieve the SERVER_PROTOCOL meta-variable (see RFC3875)
	     * @return the protocol used for the request.
	     */
	    const string& server_protocol() const;
	    /**
	     * Retrieve the SERVER_SOFTWARE meta-variable (see RFC3875)
	     * @return the name and version of server software.
	     */
	    const string& server_software() const;

	private:
	    /**
	     * Parse the query string, putting the parameters into the map
	     * specified.
	     * @param q the query string.
	     * @param p destination parameters map.
	     */
	    static void parse_query(string& q,params_t& p);
    };

}

#endif /* __KINGATE_CGI_GATEWAY_H */
/*
 * vim:set ft=cpp:
 */