2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
6 * Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 /** A modifyable list of HTTP header fields
38 std::map<std::string,std::string> headers;
41 /** Set the value of a header
42 * Sets the value of the named header. If the header is already present, it will be replaced
44 void SetHeader(const std::string &name, const std::string &data)
49 /** Set the value of a header, only if it doesn't exist already
50 * Sets the value of the named header. If the header is already present, it will NOT be updated
52 void CreateHeader(const std::string &name, const std::string &data)
55 SetHeader(name, data);
58 /** Remove the named header
60 void RemoveHeader(const std::string &name)
65 /** Remove all headers
72 /** Get the value of a header
73 * @return The value of the header, or an empty string
75 std::string GetHeader(const std::string &name)
77 std::map<std::string,std::string>::iterator it = headers.find(name);
78 if (it == headers.end())
84 /** Check if the given header is specified
85 * @return true if the header is specified
87 bool IsSet(const std::string &name)
89 std::map<std::string,std::string>::iterator it = headers.find(name);
90 return (it != headers.end());
93 /** Get all headers, formatted by the HTTP protocol
94 * @return Returns all headers, formatted according to the HTTP protocol. There is no request terminator at the end
96 std::string GetFormattedHeaders()
100 for (std::map<std::string,std::string>::iterator i = headers.begin(); i != headers.end(); i++)
101 re += i->first + ": " + i->second + "\r\n";
107 class HttpServerSocket;
109 /** This class represents a HTTP request.
115 std::string document;
117 std::string postdata;
121 HTTPHeaders *headers;
124 /** A socket pointer, which you must return in your HTTPDocument class
125 * if you reply to this request.
127 HttpServerSocket* sock;
129 /** Initialize HTTPRequest.
130 * This constructor is called by m_httpd.so to initialize the class.
131 * @param request_type The request type, e.g. GET, POST, HEAD
132 * @param uri The URI, e.g. /page
133 * @param hdr The headers sent with the request
134 * @param opaque An opaque pointer used internally by m_httpd, which you must pass back to the module in your reply.
135 * @param ip The IP address making the web request.
136 * @param pdata The post data (content after headers) received with the request, up to Content-Length in size
138 HTTPRequest(const std::string& request_type, const std::string& uri,
139 HTTPHeaders* hdr, HttpServerSocket* socket, const std::string &ip, const std::string &pdata)
140 : type(request_type), document(uri), ipaddr(ip), postdata(pdata), headers(hdr), sock(socket)
144 /** Get the post data (request content).
145 * All post data will be returned, including carriage returns and linefeeds.
146 * @return The postdata
148 std::string& GetPostData()
153 /** Get the request type.
154 * Any request type can be intercepted, even ones which are invalid in the HTTP/1.1 spec.
155 * @return The request type, e.g. GET, POST, HEAD
157 std::string& GetType()
163 * The URI string (URL minus hostname and scheme) will be provided by this function.
164 * @return The URI being requested
166 std::string& GetURI()
171 /** Get IP address of requester.
172 * The requesting system's ip address will be returned.
173 * @return The IP address as a string
181 /** If you want to reply to HTTP requests, you must return a HTTPDocumentResponse to
182 * the httpd module via the HTTPdAPI.
183 * When you initialize this class you initialize it with all components required to
184 * form a valid HTTP response: the document data and a response code.
185 * You can add additional HTTP headers, if you want.
187 class HTTPDocumentResponse
190 /** Module that generated this reply
192 Module* const module;
194 std::stringstream* document;
195 unsigned int responsecode;
197 /** Any extra headers to include with the defaults
203 /** Initialize a HTTPDocumentResponse ready for sending to the httpd module.
204 * @param mod A pointer to the module who responded to the request
205 * @param req The request you obtained from the HTTPRequest at an earlier time
206 * @param doc A stringstream containing the document body
207 * @param response A valid HTTP/1.0 or HTTP/1.1 response code. The response text will be determined for you
208 * based upon the response code.
210 HTTPDocumentResponse(Module* mod, HTTPRequest& req, std::stringstream* doc, unsigned int response)
211 : module(mod), document(doc), responsecode(response), src(req)
216 class HTTPdAPIBase : public DataProvider
219 HTTPdAPIBase(Module* parent)
220 : DataProvider(parent, "m_httpd_api")
224 /** Answer an incoming HTTP request with the provided document
225 * @param response The response created by your module that will be sent to the client
227 virtual void SendResponse(HTTPDocumentResponse& response) = 0;
230 /** The API provided by the httpd module that allows other modules to respond to incoming
233 class HTTPdAPI : public dynamic_reference<HTTPdAPIBase>
236 HTTPdAPI(Module* parent)
237 : dynamic_reference<HTTPdAPIBase>(parent, "m_httpd_api")
242 class HTTPACLEventListener : public Events::ModuleEventListener
245 HTTPACLEventListener(Module* mod)
246 : ModuleEventListener(mod, "event/http-acl")
250 virtual ModResult OnHTTPACLCheck(HTTPRequest& req) = 0;
253 class HTTPRequestEventListener : public Events::ModuleEventListener
256 HTTPRequestEventListener(Module* mod)
257 : ModuleEventListener(mod, "event/http-request")
261 virtual ModResult OnHTTPRequest(HTTPRequest& req) = 0;