summaryrefslogtreecommitdiffabout
path: root/include/kingate/cgi_gateway.h
blob: f683580733d9c2f68e5e29d7c4ced6dc9e8cffa6 (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
#ifndef __KINGATE_CGI_GATEWAY_H
#define __KINGATE_CGI_GATEWAY_H

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

/**
 * @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()
	     */
	    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
	     */
	    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
	     */
	    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.
	     */
	    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& get_content_type() const;
	    /**
	     * Retrieve the POST content length (as passed via the
	     * CONTENT_LENGTH environment variable).
	     * @return the content length.
	     */
	    unsigned long 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; }
	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:
 */