X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fhttpd.h;h=56fd22da03820a166f63b03ee6695426f2184168;hb=402a1bb010522a35600325c1a3084e092b40ca22;hp=3f8ee215cdff88a723923ad7bc8601220edfb6b1;hpb=1ce6fe7525c8213682d6cfca2acd9420d4e72f36;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/httpd.h b/src/modules/httpd.h index 3f8ee215c..56fd22da0 100644 --- a/src/modules/httpd.h +++ b/src/modules/httpd.h @@ -1,78 +1,207 @@ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2008 Pippijn van Steenhoven + * Copyright (C) 2007 John Brooks + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 Craig Edwards + * + * 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 . + */ + + #include "base.h" -#ifndef __HTTPD_H__ -#define __HTTPD_H__ +#ifndef HTTPD_H +#define HTTPD_H #include #include +#include -class HTTPRequest : public classbase +/** A modifyable list of HTTP header fields + */ +class HTTPHeaders { protected: - - std::string type; - std::string document; - std::string ipaddr; - std::stringstream* headers; - + std::map headers; public: - void* sock; + /** 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; + } - HTTPRequest(const std::string &request_type, const std::string &uri, std::stringstream* hdr, void* opaque, const std::string &ip) - : type(request_type), document(uri), ipaddr(ip), headers(hdr), sock(opaque) + /** 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); } - std::stringstream* GetHeaders() + /** Remove the named header + */ + void RemoveHeader(const std::string &name) { - return headers; + headers.erase(name); } - std::string& GetType() + /** Remove all headers + */ + void Clear() { - return type; + headers.clear(); } - std::string& GetURI() + /** Get the value of a header + * @return The value of the header, or an empty string + */ + std::string GetHeader(const std::string &name) { - return document; + std::map::iterator it = headers.find(name); + if (it == headers.end()) + return std::string(); + + return it->second; } - std::string& GetIP() + /** Check if the given header is specified + * @return true if the header is specified + */ + bool IsSet(const std::string &name) { - return ipaddr; + std::map::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::iterator i = headers.begin(); i != headers.end(); i++) + re += i->first + ": " + i->second + "\r\n"; + + return re; } }; -class HTTPDocument : public classbase +class HttpServerSocket; + +/** This class represents a HTTP request. + */ +class HTTPRequest : public Event { protected: - std::stringstream* document; - int responsecode; + std::string type; + std::string document; + std::string ipaddr; + std::string postdata; public: - HTTPDocument(std::stringstream* doc, int response) : document(doc), responsecode(response) + + 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) { } - std::stringstream* GetDocument() + /** Get the post data (request content). + * All post data will be returned, including carriage returns and linefeeds. + * @return The postdata + */ + std::string& GetPostData() { - return this->document; + return postdata; } - std::stringstream* GetDocumentSize() + /** 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 this->document.size(); + return type; } - int GetResponseCode() + /** 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 this->responsecode; + 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; } }; -#endif +/** You must return a HTTPDocument to the httpd module by using the Request class. + * When you initialize this class you may initialize it with all components required to + * form a valid HTTP response, including document data, headers, and a response code. + */ +class HTTPDocumentResponse : public Request +{ + public: + std::stringstream* document; + int responsecode; + HTTPHeaders headers; + HTTPRequest& src; + + /** Initialize a HTTPRequest ready for sending to m_httpd.so. + * @param opaque The socket pointer 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. + * @param extra Any extra headers to include with the defaults, seperated by carriage return and linefeed. + */ + HTTPDocumentResponse(Module* me, HTTPRequest& req, std::stringstream* doc, int response) + : Request(me, req.source, "HTTP-DOC"), document(doc), responsecode(response), src(req) + { + } +}; -//httpr(request_type,uri,headers,this,this->GetIP()); +#endif