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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
* Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "base.h"
#include "event.h"
#include <string>
#include <sstream>
#include <map>
/** A modifyable list of HTTP header fields
*/
class HTTPHeaders
{
protected:
std::map<std::string,std::string> headers;
public:
/** Set the value of a header
* Sets the value of the named header. If the header is already present, it will be replaced
*/
void SetHeader(const std::string &name, const std::string &data)
{
headers[name] = data;
}
/** Set the value of a header, only if it doesn't exist already
* Sets the value of the named header. If the header is already present, it will NOT be updated
*/
void CreateHeader(const std::string &name, const std::string &data)
{
if (!IsSet(name))
SetHeader(name, data);
}
/** Remove the named header
*/
void RemoveHeader(const std::string &name)
{
headers.erase(name);
}
/** Remove all headers
*/
void Clear()
{
headers.clear();
}
/** Get the value of a header
* @return The value of the header, or an empty string
*/
std::string GetHeader(const std::string &name)
{
std::map<std::string,std::string>::iterator it = headers.find(name);
if (it == headers.end())
return std::string();
return it->second;
}
/** Check if the given header is specified
* @return true if the header is specified
*/
bool IsSet(const std::string &name)
{
std::map<std::string,std::string>::iterator it = headers.find(name);
return (it != headers.end());
}
/** Get all headers, formatted by the HTTP protocol
* @return Returns all headers, formatted according to the HTTP protocol. There is no request terminator at the end
*/
std::string GetFormattedHeaders()
{
std::string re;
for (std::map<std::string,std::string>::iterator i = headers.begin(); i != headers.end(); i++)
re += i->first + ": " + i->second + "\r\n";
return re;
}
};
class HttpServerSocket;
/** This class represents a HTTP request.
*/
class HTTPRequest : public Event
{
protected:
std::string type;
std::string document;
std::string ipaddr;
std::string postdata;
public:
HTTPHeaders *headers;
int errorcode;
/** A socket pointer, which you must return in your HTTPDocument class
* if you reply to this request.
*/
HttpServerSocket* sock;
/** Initialize HTTPRequest.
* This constructor is called by m_httpd.so to initialize the class.
* @param request_type The request type, e.g. GET, POST, HEAD
* @param uri The URI, e.g. /page
* @param hdr The headers sent with the request
* @param opaque An opaque pointer used internally by m_httpd, which you must pass back to the module in your reply.
* @param ip The IP address making the web request.
* @param pdata The post data (content after headers) received with the request, up to Content-Length in size
*/
HTTPRequest(Module* me, const std::string &eventid, const std::string &request_type, const std::string &uri,
HTTPHeaders* hdr, HttpServerSocket* socket, const std::string &ip, const std::string &pdata)
: Event(me, eventid), type(request_type), document(uri), ipaddr(ip), postdata(pdata), headers(hdr), sock(socket)
{
}
/** Get the post data (request content).
* All post data will be returned, including carriage returns and linefeeds.
* @return The postdata
*/
std::string& GetPostData()
{
return postdata;
}
/** Get the request type.
* Any request type can be intercepted, even ones which are invalid in the HTTP/1.1 spec.
* @return The request type, e.g. GET, POST, HEAD
*/
std::string& GetType()
{
return type;
}
/** Get URI.
* The URI string (URL minus hostname and scheme) will be provided by this function.
* @return The URI being requested
*/
std::string& GetURI()
{
return document;
}
/** Get IP address of requester.
* The requesting system's ip address will be returned.
* @return The IP address as a string
*/
std::string& GetIP()
{
return ipaddr;
}
};
/** If you want to reply to HTTP requests, you must return a HTTPDocumentResponse to
* the httpd module via the HTTPdAPI.
* When you initialize this class you initialize it with all components required to
* form a valid HTTP response: the document data and a response code.
* You can add additional HTTP headers, if you want.
*/
class HTTPDocumentResponse
{
public:
/** Module that generated this reply
*/
Module* const module;
std::stringstream* document;
unsigned int responsecode;
/** Any extra headers to include with the defaults
*/
HTTPHeaders headers;
HTTPRequest& src;
/** Initialize a HTTPDocumentResponse ready for sending to the httpd module.
* @param mod A pointer to the module who responded to the request
* @param req The request you obtained from the HTTPRequest at an earlier time
* @param doc A stringstream containing the document body
* @param response A valid HTTP/1.0 or HTTP/1.1 response code. The response text will be determined for you
* based upon the response code.
*/
HTTPDocumentResponse(Module* mod, HTTPRequest& req, std::stringstream* doc, unsigned int response)
: module(mod), document(doc), responsecode(response), src(req)
{
}
};
class HTTPdAPIBase : public DataProvider
{
public:
HTTPdAPIBase(Module* parent)
: DataProvider(parent, "m_httpd_api")
{
}
/** Answer an incoming HTTP request with the provided document
* @param response The response created by your module that will be sent to the client
*/
virtual void SendResponse(HTTPDocumentResponse& response) = 0;
};
/** The API provided by the httpd module that allows other modules to respond to incoming
* HTTP requests
*/
class HTTPdAPI : public dynamic_reference<HTTPdAPIBase>
{
public:
HTTPdAPI(Module* parent)
: dynamic_reference<HTTPdAPIBase>(parent, "m_httpd_api")
{
}
};
class HTTPACLEventListener : public Events::ModuleEventListener
{
public:
HTTPACLEventListener(Module* mod)
: ModuleEventListener(mod, "event/http-acl")
{
}
virtual ModResult OnHTTPACLCheck(HTTPRequest& req) = 0;
};
|
