]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_httpd_stats.cpp
Clean up the protocol interface
[user/henk/code/inspircd.git] / src / modules / m_httpd_stats.cpp
index 5288130ce359c246ca3557e5956acc22740a1a40..022d91f1e7d0836b0f70819d72cdb07dfaaac0a6 100644 (file)
@@ -1,41 +1,40 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *          the file COPYING for details.
+ * 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/>.
  */
 
+
 #include "inspircd.h"
-#include "httpd.h"
+#include "modules/httpd.h"
+#include "xline.h"
 #include "protocol.h"
 
-/* $ModDesc: Provides statistics over HTTP via m_httpd.so */
-
 class ModuleHttpStats : public Module
 {
        static std::map<char, char const*> const &entities;
-       std::string stylesheet;
-       bool changed;
+       HTTPdAPI API;
 
  public:
-
-       void ReadConfig()
+       ModuleHttpStats()
+               : API(this)
        {
-               ConfigReader c;
-               this->stylesheet = c.ReadValue("httpstats", "stylesheet", 0);
-       }
-
-       ModuleHttpStats()       {
-               ReadConfig();
-               this->changed = true;
-               Implementation eventlist[] = { I_OnEvent };
-               ServerInstance->Modules->Attach(eventlist, this, 1);
        }
 
        std::string Sanitize(const std::string &str)
@@ -53,14 +52,22 @@ class ModuleHttpStats : public Module
                                ret += it->second;
                                ret += ';';
                        }
-                       else if (*x < 32 || *x > 126)
+                       else if (*x == 0x9 ||  *x == 0xA || *x == 0xD || *x >= 0x20)
                        {
-                               int n = (unsigned char)*x;
-                               ret += ("&#" + ConvToStr(n) + ";");
+                               // The XML specification defines the following characters as valid inside an XML document:
+                               // Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
+                               ret += *x;
                        }
                        else
                        {
-                               ret += *x;
+                               // If we reached this point then the string contains characters which can
+                               // not be represented in XML, even using a numeric escape. Therefore, we
+                               // Base64 encode the entire string and wrap it in a CDATA.
+                               ret.clear();
+                               ret += "<![CDATA[";
+                               ret += BinToBase64(str);
+                               ret += "]]>";
+                               break;
                        }
                }
                return ret;
@@ -74,30 +81,27 @@ class ModuleHttpStats : public Module
                        ExtensionItem* item = i->first;
                        std::string value = item->serialize(FORMAT_USER, ext, i->second);
                        if (!value.empty())
-                               data << "<meta name=\"" << item->key << "\">" << Sanitize(value) << "</meta>";
-                       else if (!item->key.empty())
-                               data << "<meta name=\"" << item->key << "\"/>";
+                               data << "<meta name=\"" << item->name << "\">" << Sanitize(value) << "</meta>";
+                       else if (!item->name.empty())
+                               data << "<meta name=\"" << item->name << "\"/>";
                }
                data << "</metadata>";
        }
 
-       void OnEvent(Event& event)
+       void OnEvent(Event& event) CXX11_OVERRIDE
        {
                std::stringstream data("");
 
                if (event.id == "httpd_url")
                {
-                       ServerInstance->Logs->Log("m_http_stats", DEBUG,"Handling httpd event");
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd event");
                        HTTPRequest* http = (HTTPRequest*)&event;
 
                        if ((http->GetURI() == "/stats") || (http->GetURI() == "/stats/"))
                        {
-                               data << "<inspircdstats>";
-
-                               data << "<server><name>" << ServerInstance->Config->ServerName << "</name><gecos>"
+                               data << "<inspircdstats><server><name>" << ServerInstance->Config->ServerName << "</name><gecos>"
                                        << Sanitize(ServerInstance->Config->ServerDesc) << "</gecos><version>"
-                                       << Sanitize(ServerInstance->GetVersionString()) << "</version><revision>"
-                                       << Sanitize(ServerInstance->GetRevision()) << "</revision></server>";
+                                       << Sanitize(ServerInstance->GetVersionString()) << "</version></server>";
 
                                data << "<general>";
                                data << "<usercount>" << ServerInstance->Users->clientlist->size() << "</usercount>";
@@ -112,25 +116,47 @@ class ModuleHttpStats : public Module
                                stime = gmtime(&server_uptime);
                                data << "<uptime><days>" << stime->tm_yday << "</days><hours>" << stime->tm_hour << "</hours><mins>" << stime->tm_min << "</mins><secs>" << stime->tm_sec << "</secs><boot_time_t>" << ServerInstance->startup_time << "</boot_time_t></uptime>";
 
-                               data << "<isupport>" << Sanitize(ServerInstance->Config->data005) << "</isupport></general>";
-                               data << "<modulelist>";
+                               data << "<isupport>";
+                               const std::vector<std::string>& isupport = ServerInstance->ISupport.GetLines();
+                               for (std::vector<std::string>::const_iterator it = isupport.begin(); it != isupport.end(); it++)
+                               {
+                                       data << Sanitize(*it) << std::endl;
+                               }
+                               data << "</isupport></general><xlines>";
+                               std::vector<std::string> xltypes = ServerInstance->XLines->GetAllTypes();
+                               for (std::vector<std::string>::iterator it = xltypes.begin(); it != xltypes.end(); ++it)
+                               {
+                                       XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
+
+                                       if (!lookup)
+                                               continue;
+                                       for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
+                                       {
+                                               data << "<xline type=\"" << it->c_str() << "\"><mask>"
+                                                       << Sanitize(i->second->Displayable()) << "</mask><settime>"
+                                                       << i->second->set_time << "</settime><duration>" << i->second->duration
+                                                       << "</duration><reason>" << Sanitize(i->second->reason)
+                                                       << "</reason></xline>";
+                                       }
+                               }
+
+                               data << "</xlines><modulelist>";
                                std::vector<std::string> module_names = ServerInstance->Modules->GetAllModuleNames(0);
 
                                for (std::vector<std::string>::iterator i = module_names.begin(); i != module_names.end(); ++i)
                                {
                                        Module* m = ServerInstance->Modules->Find(i->c_str());
                                        Version v = m->GetVersion();
-                                       data << "<module><name>" << *i << "</name><version>" << v.version << "</version><description>" << Sanitize(v.description) << "</description></module>";
+                                       data << "<module><name>" << *i << "</name><description>" << Sanitize(v.description) << "</description></module>";
                                }
-                               data << "</modulelist>";
-                               data << "<channellist>";
+                               data << "</modulelist><channellist>";
 
                                for (chan_hash::const_iterator a = ServerInstance->chanlist->begin(); a != ServerInstance->chanlist->end(); ++a)
                                {
                                        Channel* c = a->second;
 
                                        data << "<channel>";
-                                       data << "<usercount>" << c->GetUsers()->size() << "</usercount><channelname>" << c->name << "</channelname>";
+                                       data << "<usercount>" << c->GetUsers()->size() << "</usercount><channelname>" << Sanitize(c->name) << "</channelname>";
                                        data << "<channeltopic>";
                                        data << "<topictext>" << Sanitize(c->topic) << "</topictext>";
                                        data << "<setby>" << Sanitize(c->setby) << "</setby>";
@@ -164,13 +190,15 @@ class ModuleHttpStats : public Module
                                        data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>"
                                                << u->host << "</realhost><displayhost>" << u->dhost << "</displayhost><gecos>"
                                                << Sanitize(u->fullname) << "</gecos><server>" << u->server << "</server>";
-                                       if (IS_AWAY(u))
+                                       if (u->IsAway())
                                                data << "<away>" << Sanitize(u->awaymsg) << "</away><awaytime>" << u->awaytime << "</awaytime>";
-                                       if (IS_OPER(u))
-                                               data << "<opertype>" << Sanitize(u->oper) << "</opertype>";
+                                       if (u->IsOper())
+                                               data << "<opertype>" << Sanitize(u->oper->name) << "</opertype>";
                                        data << "<modes>" << u->FormatModes() << "</modes><ident>" << Sanitize(u->ident) << "</ident>";
-                                       if (IS_LOCAL(u))
-                                               data << "<port>" << u->GetServerPort() << "</port><servaddr>" << irc::sockets::satouser(&u->server_sa) << "</servaddr>";
+                                       LocalUser* lu = IS_LOCAL(u);
+                                       if (lu)
+                                               data << "<port>" << lu->GetServerPort() << "</port><servaddr>"
+                                                       << irc::sockets::satouser(lu->server_sa) << "</servaddr>";
                                        data << "<ipaddress>" << u->GetIPString() << "</ipaddress>";
 
                                        DumpMeta(data, u);
@@ -180,10 +208,10 @@ class ModuleHttpStats : public Module
 
                                data << "</userlist><serverlist>";
 
-                               ProtoServerList sl;
+                               ProtocolInterface::ServerList sl;
                                ServerInstance->PI->GetServerList(sl);
 
-                               for (ProtoServerList::iterator b = sl.begin(); b != sl.end(); ++b)
+                               for (ProtocolInterface::ServerList::const_iterator b = sl.begin(); b != sl.end(); ++b)
                                {
                                        data << "<server>";
                                        data << "<servername>" << b->servername << "</servername>";
@@ -196,24 +224,18 @@ class ModuleHttpStats : public Module
                                        data << "</server>";
                                }
 
-                               data << "</serverlist>";
-
-                               data << "</inspircdstats>";
+                               data << "</serverlist></inspircdstats>";
 
                                /* Send the document back to m_httpd */
                                HTTPDocumentResponse response(this, *http, &data, 200);
-                               response.headers.SetHeader("X-Powered-By", "m_httpd_stats.so");
+                               response.headers.SetHeader("X-Powered-By", MODNAME);
                                response.headers.SetHeader("Content-Type", "text/xml");
-                               response.Send();
+                               API->SendResponse(response);
                        }
                }
        }
 
-       virtual ~ModuleHttpStats()
-       {
-       }
-
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
                return Version("Provides statistics over HTTP via m_httpd.so", VF_VENDOR);
        }