/* * 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) 2008-2009 Robin Burchell * Copyright (C) 2008 Pippijn van Steenhoven * 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 * 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 "inspircd.h" #include "modules/httpd.h" #include "xline.h" namespace Stats { struct Entities { static const insp::flat_map& entities; }; static const insp::flat_map& init_entities() { static insp::flat_map entities; entities['<'] = "lt"; entities['>'] = "gt"; entities['&'] = "amp"; entities['"'] = "quot"; return entities; } 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) { insp::flat_map::const_iterator it = Entities::entities.find(*x); if (it != Entities::entities.end()) { ret += '&'; ret += it->second; ret += ';'; } 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] ret += *x; } else { // 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 += ""; break; } } return ret; } void DumpMeta(std::ostream& data, Extensible* ext) { data << ""; for (Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); i++) { ExtensionItem* item = i->first; std::string value = item->ToHuman(ext, i->second); if (!value.empty()) data << "name << "\">" << Sanitize(value) << ""; else if (!item->name.empty()) data << "name << "\"/>"; } data << ""; } 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) { 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(); for (ModuleManager::ModuleMap::const_iterator i = mods.begin(); i != mods.end(); ++i) { Version v = i->second->GetVersion(); data << "" << i->first << "" << Sanitize(v.description) << ""; } return data << ""; } std::ostream& Channels(std::ostream& data) { data << ""; 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) { 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 << ""; } 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) {} template inline bool Compare(const T& a, const T& b) { return desc ? a > b : a < b; } 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) { } 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"); } ModResult HandleRequest(HTTPRequest* http) { 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 } ModResult OnHTTPRequest(HTTPRequest& req) CXX11_OVERRIDE { return HandleRequest(&req); } 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)