X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_httpd_stats.cpp;h=1e9f4ef4b92f6d8a33809b5b70d4778b6cfed8e1;hb=e2b0f3dc9ef4d56c71d7abda13e6139ca092e387;hp=9115fedaf71a9443c38b2bfac25fd3e5fc8e44eb;hpb=66b90807bb94d88c8a34ec8a1fd7c1558941c47a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_httpd_stats.cpp b/src/modules/m_httpd_stats.cpp index 9115fedaf..1e9f4ef4b 100644 --- a/src/modules/m_httpd_stats.cpp +++ b/src/modules/m_httpd_stats.cpp @@ -1,11 +1,19 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2019 linuxdaemon + * Copyright (C) 2018 Matt Schatz + * Copyright (C) 2016 Johanna A + * Copyright (C) 2013-2016 Attila Molnar + * Copyright (C) 2013, 2017, 2019-2020 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009 Uli Schlachter * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2008-2009 Robin Burchell * Copyright (C) 2008 Pippijn van Steenhoven - * Copyright (C) 2006-2008 Craig Edwards + * Copyright (C) 2007 John Brooks * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2008, 2010 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 @@ -22,40 +30,44 @@ #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 +namespace Stats { - static std::map const &entities; - - public: + struct Entities + { + static const insp::flat_map& entities; + }; - void init() + static const insp::flat_map& init_entities() { - Implementation eventlist[] = { I_OnEvent }; - ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); + static insp::flat_map entities; + entities['<'] = "lt"; + entities['>'] = "gt"; + entities['&'] = "amp"; + entities['"'] = "quot"; + return entities; } - std::string Sanitize(const std::string &str) + const insp::flat_map& Entities::entities = init_entities(); + + std::string Sanitize(const std::string& str) { std::string ret; ret.reserve(str.length() * 2); for (std::string::const_iterator x = str.begin(); x != str.end(); ++x) { - std::map::const_iterator it = entities.find(*x); + insp::flat_map::const_iterator it = Entities::entities.find(*x); - if (it != entities.end()) + if (it != Entities::entities.end()) { ret += '&'; ret += it->second; ret += ';'; } - else if (*x == 0x9 || *x == 0xA || *x == 0xD || *x >= 0x20) + else if (*x == 0x09 || *x == 0x0A || *x == 0x0D || ((*x >= 0x20) && (*x <= 0x7e))) { // The XML specification defines the following characters as valid inside an XML document: // Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] @@ -76,13 +88,13 @@ class ModuleHttpStats : public Module return ret; } - void DumpMeta(std::stringstream& data, Extensible* ext) + void DumpMeta(std::ostream& data, Extensible* ext) { data << ""; - for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); i++) + 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); + std::string value = item->ToHuman(ext, i->second); if (!value.empty()) data << "name << "\">" << Sanitize(value) << ""; else if (!item->name.empty()) @@ -91,167 +103,385 @@ class ModuleHttpStats : public Module data << ""; } - void OnEvent(Event& event) + std::ostream& ServerInfo(std::ostream& data) + { + return data << "" << ServerInstance->Config->ServerName << "" + << Sanitize(ServerInstance->Config->ServerDesc) << "" + << Sanitize(ServerInstance->GetVersionString(true)) << ""; + } + + std::ostream& ISupport(std::ostream& data) + { + data << ""; + const std::vector& isupport = ServerInstance->ISupport.GetLines(); + for (std::vector::const_iterator i = isupport.begin(); i != isupport.end(); ++i) + { + const Numeric::Numeric& num = *i; + for (std::vector::const_iterator j = num.GetParams().begin(); j != num.GetParams().end() - 1; ++j) + data << "" << Sanitize(*j) << ""; + } + return data << ""; + } + + std::ostream& General(std::ostream& data) + { + data << ""; + data << "" << ServerInstance->Users->GetUsers().size() << ""; + data << "" << ServerInstance->Users->GetLocalUsers().size() << ""; + data << "" << ServerInstance->GetChans().size() << ""; + data << "" << ServerInstance->Users->all_opers.size() << ""; + data << "" << (SocketEngine::GetUsedFds()) << "" << SocketEngine::GetMaxFds() << ""; + data << "" << ServerInstance->startup_time << ""; + data << "" << ServerInstance->Time() << ""; + + data << ISupport; + return data << ""; + } + + std::ostream& XLines(std::ostream& data) { - std::stringstream data(""); + data << ""; + std::vector xltypes = ServerInstance->XLines->GetAllTypes(); + for (std::vector::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 << "c_str() << "\">" + << Sanitize(i->second->Displayable()) << "" + << i->second->set_time << "" << i->second->duration + << "" << Sanitize(i->second->reason) + << ""; + } + } + return data << ""; + } + + std::ostream& Modules(std::ostream& data) + { + data << ""; + const ModuleManager::ModuleMap& mods = ServerInstance->Modules->GetModules(); - if (event.id == "httpd_url") + for (ModuleManager::ModuleMap::const_iterator i = mods.begin(); i != mods.end(); ++i) { - ServerInstance->Logs->Log("m_http_stats", DEBUG,"Handling httpd event"); - HTTPRequest* http = (HTTPRequest*)&event; + Version v = i->second->GetVersion(); + data << "" << i->first << "" << Sanitize(v.description) << ""; + } + return data << ""; + } + + std::ostream& Channels(std::ostream& data) + { + data << ""; - if ((http->GetURI() == "/stats") || (http->GetURI() == "/stats/")) + const chan_hash& chans = ServerInstance->GetChans(); + for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i) + { + Channel* c = i->second; + + data << ""; + data << "" << c->GetUsers().size() << "" << Sanitize(c->name) << ""; + data << ""; + data << "" << Sanitize(c->topic) << ""; + data << "" << Sanitize(c->setby) << ""; + data << "" << c->topicset << ""; + data << ""; + data << "" << Sanitize(c->ChanModes(true)) << ""; + + const Channel::MemberMap& ulist = c->GetUsers(); + for (Channel::MemberMap::const_iterator x = ulist.begin(); x != ulist.end(); ++x) { - data << "" << ServerInstance->Config->ServerName << "" - << Sanitize(ServerInstance->Config->ServerDesc) << "" - << Sanitize(ServerInstance->GetVersionString()) << ""; - - data << ""; - data << "" << ServerInstance->Users->clientlist->size() << ""; - data << "" << ServerInstance->chanlist->size() << ""; - data << "" << ServerInstance->Users->all_opers.size() << ""; - data << "" << (ServerInstance->SE->GetUsedFds()) << "" << ServerInstance->SE->GetMaxFds() << "" << ServerInstance->SE->GetName() << ""; - - 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 << "" << stime->tm_yday << "" << stime->tm_hour << "" << stime->tm_min << "" << stime->tm_sec << "" << ServerInstance->startup_time << ""; - - data << "" << Sanitize(ServerInstance->Config->data005) << ""; - std::vector xltypes = ServerInstance->XLines->GetAllTypes(); - for (std::vector::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 << "c_str() << "\">" - << Sanitize(i->second->Displayable()) << "" - << i->second->set_time << "" << i->second->duration - << "" << Sanitize(i->second->reason) - << ""; - } - } - - data << ""; - std::vector module_names = ServerInstance->Modules->GetAllModuleNames(0); - - for (std::vector::iterator i = module_names.begin(); i != module_names.end(); ++i) - { - Module* m = ServerInstance->Modules->Find(i->c_str()); - Version v = m->GetVersion(); - data << "" << *i << "" << Sanitize(v.description) << ""; - } - data << ""; - - for (chan_hash::const_iterator a = ServerInstance->chanlist->begin(); a != ServerInstance->chanlist->end(); ++a) - { - Channel* c = a->second; - - data << ""; - data << "" << c->GetUsers()->size() << "" << Sanitize(c->name) << ""; - data << ""; - data << "" << Sanitize(c->topic) << ""; - data << "" << Sanitize(c->setby) << ""; - data << "" << c->topicset << ""; - data << ""; - data << "" << Sanitize(c->ChanModes(true)) << ""; - const UserMembList* ulist = c->GetUsers(); - - for (UserMembCIter x = ulist->begin(); x != ulist->end(); ++x) - { - Membership* memb = x->second; - data << "" << memb->user->uuid << "" - << Sanitize(c->GetAllPrefixChars(x->first)) << "" - << memb->modes << ""; - DumpMeta(data, memb); - data << ""; - } - - DumpMeta(data, c); - - data << ""; - } - - data << ""; - - for (user_hash::const_iterator a = ServerInstance->Users->clientlist->begin(); a != ServerInstance->Users->clientlist->end(); ++a) - { - User* u = a->second; - - data << ""; - data << "" << u->nick << "" << u->uuid << "" - << u->host << "" << u->dhost << "" - << Sanitize(u->fullname) << "" << u->server << ""; - if (IS_AWAY(u)) - data << "" << Sanitize(u->awaymsg) << "" << u->awaytime << ""; - if (IS_OPER(u)) - data << "" << Sanitize(u->oper->NameStr()) << ""; - data << "" << u->FormatModes() << "" << Sanitize(u->ident) << ""; - LocalUser* lu = IS_LOCAL(u); - if (lu) - data << "" << lu->GetServerPort() << "" - << irc::sockets::satouser(lu->server_sa) << ""; - data << "" << u->GetIPString() << ""; - - DumpMeta(data, u); - - data << ""; - } - - data << ""; - - ProtoServerList sl; - ServerInstance->PI->GetServerList(sl); - - for (ProtoServerList::iterator b = sl.begin(); b != sl.end(); ++b) - { - data << ""; - data << "" << b->servername << ""; - data << "" << b->parentname << ""; - data << "" << b->gecos << ""; - data << "" << b->usercount << ""; + Membership* memb = x->second; + data << "" << memb->user->uuid << "" + << Sanitize(memb->GetAllPrefixChars()) << "" + << memb->modes << ""; + DumpMeta(data, memb); + data << ""; + } + + DumpMeta(data, c); + + data << ""; + } + + return data << ""; + } + + std::ostream& DumpUser(std::ostream& data, User* u) + { + data << ""; + data << "" << u->nick << "" << u->uuid << "" + << u->GetRealHost() << "" << u->GetDisplayedHost() << "" + << Sanitize(u->GetRealName()) << "" << u->server->GetName() << "" + << u->signon << "" << u->age << ""; + + if (u->IsAway()) + data << "" << Sanitize(u->awaymsg) << "" << u->awaytime << ""; + + if (u->IsOper()) + data << "" << Sanitize(u->oper->name) << ""; + + data << "" << u->GetModeLetters().substr(1) << "" << Sanitize(u->ident) << ""; + + LocalUser* lu = IS_LOCAL(u); + if (lu) + data << "" << lu->server_sa.port() << "" + << lu->server_sa.str() << "" + << lu->GetClass()->GetName() << "" + << lu->idle_lastmsg << ""; + + data << "" << u->GetIPString() << ""; + + DumpMeta(data, u); + + data << ""; + return data; + } + + std::ostream& Users(std::ostream& data) + { + data << ""; + const user_hash& users = ServerInstance->Users->GetUsers(); + for (user_hash::const_iterator i = users.begin(); i != users.end(); ++i) + { + User* u = i->second; + + if (u->registered != REG_ALL) + continue; + + DumpUser(data, u); + } + return data << ""; + } + + std::ostream& Servers(std::ostream& data) + { + data << ""; + + ProtocolInterface::ServerList sl; + ServerInstance->PI->GetServerList(sl); + + for (ProtocolInterface::ServerList::const_iterator b = sl.begin(); b != sl.end(); ++b) + { + data << ""; + data << "" << b->servername << ""; + data << "" << b->parentname << ""; + data << "" << Sanitize(b->description) << ""; + data << "" << b->usercount << ""; // This is currently not implemented, so, commented out. // data << "" << b->opercount << ""; - data << "" << b->latencyms << ""; - data << ""; - } + data << "" << b->latencyms << ""; + data << ""; + } + + return data << ""; + } + + std::ostream& Commands(std::ostream& data) + { + data << ""; + + const CommandParser::CommandMap& commands = ServerInstance->Parser.GetCommands(); + for (CommandParser::CommandMap::const_iterator i = commands.begin(); i != commands.end(); ++i) + { + data << "" << i->second->name << "" << i->second->use_count << ""; + } + return data << ""; + } + + enum OrderBy + { + OB_NICK, + OB_LASTMSG, + + OB_NONE + }; + + struct UserSorter + { + OrderBy order; + bool desc; + + UserSorter(OrderBy Order, bool Desc = false) : order(Order), desc(Desc) {} - data << ""; + template + inline bool Compare(const T& a, const T& b) + { + return desc ? a > b : a < b; + } - /* 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("Content-Type", "text/xml"); - response.Send(); + bool operator()(User* u1, User* u2) + { + switch (order) { + case OB_LASTMSG: + return Compare(IS_LOCAL(u1)->idle_lastmsg, IS_LOCAL(u2)->idle_lastmsg); + break; + case OB_NICK: + return Compare(u1->nick, u2->nick); + break; + default: + case OB_NONE: + return false; + break; } } + }; + + std::ostream& ListUsers(std::ostream& data, const HTTPQueryParameters& params) + { + if (params.empty()) + return Users(data); + + data << ""; + + // Filters + size_t limit = params.getNum("limit"); + bool showunreg = params.getBool("showunreg"); + bool localonly = params.getBool("localonly"); + + // Minimum time since a user's last message + unsigned long min_idle = params.getDuration("minidle"); + time_t maxlastmsg = ServerInstance->Time() - min_idle; + + if (min_idle) + // We can only check idle times on local users + localonly = true; + + // Sorting + const std::string& sortmethod = params.getString("sortby"); + bool desc = params.getBool("desc", false); + + OrderBy orderby; + if (stdalgo::string::equalsci(sortmethod, "nick")) + orderby = OB_NICK; + else if (stdalgo::string::equalsci(sortmethod, "lastmsg")) + { + orderby = OB_LASTMSG; + // We can only check idle times on local users + localonly = true; + } + else + orderby = OB_NONE; + + typedef std::list NewUserList; + NewUserList user_list; + user_hash users = ServerInstance->Users->GetUsers(); + for (user_hash::iterator i = users.begin(); i != users.end(); ++i) + { + User* u = i->second; + if (!showunreg && u->registered != REG_ALL) + continue; + + LocalUser* lu = IS_LOCAL(u); + if (localonly && !lu) + continue; + + if (min_idle && lu->idle_lastmsg > maxlastmsg) + continue; + + user_list.push_back(u); + } + + UserSorter sorter(orderby, desc); + if (sorter.order != OB_NONE && !(!localonly && sorter.order == OB_LASTMSG)) + user_list.sort(sorter); + + size_t count = 0; + for (NewUserList::const_iterator i = user_list.begin(); i != user_list.end() && (!limit || count < limit); ++i, ++count) + DumpUser(data, *i); + + data << ""; + return data; + } +} + +class ModuleHttpStats : public Module, public HTTPRequestEventListener +{ + HTTPdAPI API; + bool enableparams; + + public: + ModuleHttpStats() + : HTTPRequestEventListener(this) + , API(this) + , enableparams(false) + { } - virtual ~ModuleHttpStats() + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { + ConfigTag* conf = ServerInstance->Config->ConfValue("httpstats"); + + // Parameterized queries may cause a performance issue + // Due to the sheer volume of data + // So default them to disabled + enableparams = conf->getBool("enableparams"); } - virtual Version GetVersion() + ModResult HandleRequest(HTTPRequest* http) { - return Version("Provides statistics over HTTP via m_httpd.so", VF_VENDOR); + if (http->GetPath() != "/stats") + return MOD_RES_PASSTHRU; + + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling HTTP request for %s", http->GetPath().c_str()); + + bool found = true; + std::stringstream data; + data << ""; + + if (http->GetPath() == "/stats") + { + data << Stats::ServerInfo << Stats::General + << Stats::XLines << Stats::Modules + << Stats::Channels << Stats::Users + << Stats::Servers << Stats::Commands; + } + else if (http->GetPath() == "/stats/general") + { + data << Stats::General; + } + else if (http->GetPath() == "/stats/users") + { + if (enableparams) + Stats::ListUsers(data, http->GetParsedURI().query_params); + else + data << Stats::Users; + } + else + { + found = false; + } + + if (found) + { + data << ""; + } + else + { + data.clear(); + data.str(std::string()); + } + + /* Send the document back to m_httpd */ + HTTPDocumentResponse response(this, *http, &data, found ? 200 : 404); + response.headers.SetHeader("X-Powered-By", MODNAME); + response.headers.SetHeader("Content-Type", "text/xml"); + API->SendResponse(response); + return MOD_RES_DENY; // Handled } -}; -static std::map const &init_entities() -{ - static std::map entities; - entities['<'] = "lt"; - entities['>'] = "gt"; - entities['&'] = "amp"; - entities['"'] = "quot"; - return entities; -} + ModResult OnHTTPRequest(HTTPRequest& req) CXX11_OVERRIDE + { + return HandleRequest(&req); + } -std::map const &ModuleHttpStats::entities = init_entities (); + Version GetVersion() CXX11_OVERRIDE + { + return Version("Provides XML-serialised statistics about the server, channels, and users over HTTP via the /stats path.", VF_VENDOR); + } +}; MODULE_INIT(ModuleHttpStats)