]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_httpd_stats.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_httpd_stats.cpp
index 37a7c34784d18ea73c7eb248031c102138ca4606..eb8e856acde4e150e28aab4917c916ed18673a31 100644 (file)
@@ -1,43 +1,40 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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 "protocol.h"
 
-/* $ModDesc: Provides statistics over HTTP via m_httpd.so */
-/* $ModDep: httpd.h */
+#include "inspircd.h"
+#include "modules/httpd.h"
+#include "xline.h"
 
-class ModuleHttpStats : public Module
+class ModuleHttpStats : public Module, public HTTPRequestEventListener
 {
-       static std::map<char, char const*> const &entities;
-       std::string stylesheet;
-       bool changed;
+       static const insp::flat_map<char, char const*>& entities;
+       HTTPdAPI API;
 
  public:
-
-       void ReadConfig()
+       ModuleHttpStats()
+               : HTTPRequestEventListener(this)
+               , API(this)
        {
-               ConfigReader c(ServerInstance);
-               this->stylesheet = c.ReadValue("httpstats", "stylesheet", 0);
-       }
-
-       ModuleHttpStats(InspIRCd* Me) : Module(Me)
-       {
-               ReadConfig();
-               this->changed = true;
-               Implementation eventlist[] = { I_OnEvent, I_OnRequest };
-               ServerInstance->Modules->Attach(eventlist, this, 2);
        }
 
        std::string Sanitize(const std::string &str)
@@ -47,7 +44,7 @@ class ModuleHttpStats : public Module
 
                for (std::string::const_iterator x = str.begin(); x != str.end(); ++x)
                {
-                       std::map<char, char const*>::const_iterator it = entities.find(*x);
+                       insp::flat_map<char, char const*>::const_iterator it = entities.find(*x);
 
                        if (it != entities.end())
                        {
@@ -55,154 +52,208 @@ class ModuleHttpStats : public Module
                                ret += it->second;
                                ret += ';';
                        }
-                       else if (*x < 32 || *x > 126)
+                       else if (*x == 0x09 ||  *x == 0x0A || *x == 0x0D || ((*x >= 0x20) && (*x <= 0x7e)))
                        {
-                               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;
        }
 
-       void OnEvent(Event* event)
+       void DumpMeta(std::stringstream& data, Extensible* ext)
+       {
+               data << "<metadata>";
+               for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); i++)
+               {
+                       ExtensionItem* item = i->first;
+                       std::string value = item->serialize(FORMAT_USER, ext, i->second);
+                       if (!value.empty())
+                               data << "<meta name=\"" << item->name << "\">" << Sanitize(value) << "</meta>";
+                       else if (!item->name.empty())
+                               data << "<meta name=\"" << item->name << "\"/>";
+               }
+               data << "</metadata>";
+       }
+
+       ModResult HandleRequest(HTTPRequest* http)
        {
                std::stringstream data("");
 
-               if (event->GetEventID() == "httpd_url")
                {
-                       ServerInstance->Logs->Log("m_http_stats", DEBUG,"Handling httpd event");
-                       HTTPRequest* http = (HTTPRequest*)event->GetData();
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd event");
 
                        if ((http->GetURI() == "/stats") || (http->GetURI() == "/stats/"))
                        {
-                               data << "<inspircdstats>";
-
-                               data << "<server><name>" << ServerInstance->Config->ServerName << "</name><gecos>" << Sanitize(ServerInstance->Config->ServerDesc) << "</gecos></server>";
+                               data << "<inspircdstats><server><name>" << ServerInstance->Config->ServerName << "</name><gecos>"
+                                       << Sanitize(ServerInstance->Config->ServerDesc) << "</gecos><version>"
+                                       << Sanitize(ServerInstance->GetVersionString()) << "</version></server>";
 
                                data << "<general>";
-                               data << "<usercount>" << ServerInstance->Users->clientlist->size() << "</usercount>";
-                               data << "<channelcount>" << ServerInstance->chanlist->size() << "</channelcount>";
+                               data << "<usercount>" << ServerInstance->Users->GetUsers().size() << "</usercount>";
+                               data << "<channelcount>" << ServerInstance->GetChans().size() << "</channelcount>";
                                data << "<opercount>" << ServerInstance->Users->all_opers.size() << "</opercount>";
-                               data << "<socketcount>" << (ServerInstance->SE->GetMaxFds() - ServerInstance->SE->GetRemainingFds()) << "</socketcount><socketmax>" << ServerInstance->SE->GetMaxFds() << "</socketmax><socketengine>" << ServerInstance->SE->GetName() << "</socketengine>";
+                               data << "<socketcount>" << (SocketEngine::GetUsedFds()) << "</socketcount><socketmax>" << SocketEngine::GetMaxFds() << "</socketmax><socketengine>" INSPIRCD_SOCKETENGINE_NAME "</socketengine>";
+                               data << "<uptime><boot_time_t>" << ServerInstance->startup_time << "</boot_time_t></uptime>";
 
-                               time_t current_time = 0;
-                               current_time = ServerInstance->Time();
-                               time_t server_uptime = current_time - ServerInstance->startup_time;
-                               struct tm* stime;
-                               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>";
+                               const std::vector<Numeric::Numeric>& isupport = ServerInstance->ISupport.GetLines();
+                               for (std::vector<Numeric::Numeric>::const_iterator i = isupport.begin(); i != isupport.end(); ++i)
+                               {
+                                       const Numeric::Numeric& num = *i;
+                                       for (std::vector<std::string>::const_iterator j = num.GetParams().begin(); j != num.GetParams().end()-1; ++j)
+                                               data << "<token>" << Sanitize(*j) << "</token>" << 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 << "</general>";
-                               data << "<modulelist>";
-                               std::vector<std::string> module_names = ServerInstance->Modules->GetAllModuleNames(0);
+                               data << "</xlines><modulelist>";
+                               const ModuleManager::ModuleMap& mods = ServerInstance->Modules->GetModules();
 
-                               for (std::vector<std::string>::iterator i = module_names.begin(); i != module_names.end(); ++i)
+                               for (ModuleManager::ModuleMap::const_iterator i = mods.begin(); i != mods.end(); ++i)
                                {
-                                       Module* m = ServerInstance->Modules->Find(i->c_str());
-                                       Version v = m->GetVersion();
-                                       data << "<module><name>" << *i << "</name><version>" << v.version << "</version></module>";
+                                       Version v = i->second->GetVersion();
+                                       data << "<module><name>" << i->first << "</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)
+                               const chan_hash& chans = ServerInstance->GetChans();
+                               for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i)
                                {
-                                       Channel* c = a->second;
+                                       Channel* c = i->second;
 
                                        data << "<channel>";
-                                       data << "<usercount>" << c->GetUsers()->size() << "</usercount><channelname>" << c->name << "</channelname>";
-                                       data << "<channelops>" << c->GetOppedUsers()->size() << "</channelops>";
-                                       data << "<channelhalfops>" << c->GetHalfoppedUsers()->size() << "</channelhalfops>";
-                                       data << "<channelvoices>" << c->GetVoicedUsers()->size() << "</channelvoices>";
+                                       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>";
                                        data << "<settime>" << c->topicset << "</settime>";
                                        data << "</channeltopic>";
                                        data << "<channelmodes>" << Sanitize(c->ChanModes(true)) << "</channelmodes>";
-                                       CUList* ulist = c->GetUsers();
 
-                                       for (CUList::iterator x = ulist->begin(); x != ulist->end(); ++x)
+                                       const Channel::MemberMap& ulist = c->GetUsers();
+                                       for (Channel::MemberMap::const_iterator x = ulist.begin(); x != ulist.end(); ++x)
                                        {
-                                               data << "<channelmember><uid>" << x->first->uuid << "</uid><privs>" << Sanitize(c->GetAllPrefixChars(x->first)) << "</privs></channelmember>";
+                                               Membership* memb = x->second;
+                                               data << "<channelmember><uid>" << memb->user->uuid << "</uid><privs>"
+                                                       << Sanitize(memb->GetAllPrefixChars()) << "</privs><modes>"
+                                                       << memb->modes << "</modes>";
+                                               DumpMeta(data, memb);
+                                               data << "</channelmember>";
                                        }
 
+                                       DumpMeta(data, c);
+
                                        data << "</channel>";
                                }
 
                                data << "</channellist><userlist>";
 
-                               for (user_hash::const_iterator a = ServerInstance->Users->clientlist->begin(); a != ServerInstance->Users->clientlist->end(); ++a)
+                               const user_hash& users = ServerInstance->Users->GetUsers();
+                               for (user_hash::const_iterator i = users.begin(); i != users.end(); ++i)
                                {
-                                       User* u = a->second;
+                                       User* u = i->second;
 
                                        data << "<user>";
-                                       data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>" << u->host << "</realhost><displayhost>" << u->dhost << "</displayhost>";
-                                       data << "<gecos>" << Sanitize(u->fullname) << "</gecos><server>" << u->server << "</server><away>" << Sanitize(u->awaymsg) << "</away><opertype>" << Sanitize(u->oper) << "</opertype><modes>";
-                                       std::string modes;
-                                       for (unsigned char n = 'A'; n <= 'z'; ++n)
-                                               if (u->IsModeSet(n))
-                                                       modes += n;
-
-                                       data << modes << "</modes><ident>" << Sanitize(u->ident) << "</ident><port>" << u->GetPort() << "</port><ipaddress>" << u->GetIPString() << "</ipaddress>";
+                                       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->GetName() << "</server>";
+                                       if (u->IsAway())
+                                               data << "<away>" << Sanitize(u->awaymsg) << "</away><awaytime>" << u->awaytime << "</awaytime>";
+                                       if (u->IsOper())
+                                               data << "<opertype>" << Sanitize(u->oper->name) << "</opertype>";
+                                       data << "<modes>" << u->FormatModes() << "</modes><ident>" << Sanitize(u->ident) << "</ident>";
+                                       LocalUser* lu = IS_LOCAL(u);
+                                       if (lu)
+                                               data << "<port>" << lu->GetServerPort() << "</port><servaddr>"
+                                                       << lu->server_sa.str() << "</servaddr>";
+                                       data << "<ipaddress>" << u->GetIPString() << "</ipaddress>";
+
+                                       DumpMeta(data, u);
+
                                        data << "</user>";
                                }
 
                                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>";
                                        data << "<parentname>" << b->parentname << "</parentname>";
                                        data << "<gecos>" << b->gecos << "</gecos>";
                                        data << "<usercount>" << b->usercount << "</usercount>";
-                                       data << "<opercount>" << b->opercount << "</opercount>";
+// This is currently not implemented, so, commented out.
+//                                     data << "<opercount>" << b->opercount << "</opercount>";
                                        data << "<lagmillisecs>" << b->latencyms << "</lagmillisecs>";
                                        data << "</server>";
                                }
 
-                               data << "</serverlist>";
+                               data << "</serverlist><commandlist>";
 
-                               data << "</inspircdstats>";
+                               const CommandParser::CommandMap& commands = ServerInstance->Parser.GetCommands();
+                               for (CommandParser::CommandMap::const_iterator i = commands.begin(); i != commands.end(); ++i)
+                               {
+                                       data << "<command><name>" << i->second->name << "</name><usecount>" << i->second->use_count << "</usecount></command>";
+                               }
+
+                               data << "</commandlist></inspircdstats>";
 
                                /* Send the document back to m_httpd */
-                               HTTPDocument response(http->sock, &data, 200);
-                               response.headers.SetHeader("X-Powered-By", "m_httpd_stats.so");
+                               HTTPDocumentResponse response(this, *http, &data, 200);
+                               response.headers.SetHeader("X-Powered-By", MODNAME);
                                response.headers.SetHeader("Content-Type", "text/xml");
-                               Request req((char*)&response, (Module*)this, event->GetSource());
-                               req.Send();
+                               API->SendResponse(response);
+                               return MOD_RES_DENY; // Handled
                        }
                }
+               return MOD_RES_PASSTHRU;
        }
 
-       const char* OnRequest(Request* request)
-       {
-               return NULL;
-       }
-
-
-       virtual ~ModuleHttpStats()
+       ModResult OnHTTPRequest(HTTPRequest& req) CXX11_OVERRIDE
        {
+               return HandleRequest(&req);
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_VENDOR, API_VERSION);
+               return Version("Provides statistics over HTTP via m_httpd.so", VF_VENDOR);
        }
 };
 
-static std::map<char, char const*> const &init_entities()
+static const insp::flat_map<char, char const*>& init_entities()
 {
-       static std::map<char, char const*> entities;
+       static insp::flat_map<char, char const*> entities;
        entities['<'] = "lt";
        entities['>'] = "gt";
        entities['&'] = "amp";
@@ -210,6 +261,6 @@ static std::map<char, char const*> const &init_entities()
        return entities;
 }
 
-std::map<char, char const*> const &ModuleHttpStats::entities = init_entities ();
+const insp::flat_map<char, char const*>& ModuleHttpStats::entities = init_entities();
 
 MODULE_INIT(ModuleHttpStats)