2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
7 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "modules/httpd.h"
28 class ModuleHttpStats : public Module
30 static const insp::flat_map<char, char const*>& entities;
39 std::string Sanitize(const std::string &str)
42 ret.reserve(str.length() * 2);
44 for (std::string::const_iterator x = str.begin(); x != str.end(); ++x)
46 insp::flat_map<char, char const*>::const_iterator it = entities.find(*x);
48 if (it != entities.end())
54 else if (*x == 0x09 || *x == 0x0A || *x == 0x0D || ((*x >= 0x20) && (*x <= 0x7e)))
56 // The XML specification defines the following characters as valid inside an XML document:
57 // Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
62 // If we reached this point then the string contains characters which can
63 // not be represented in XML, even using a numeric escape. Therefore, we
64 // Base64 encode the entire string and wrap it in a CDATA.
67 ret += BinToBase64(str);
75 void DumpMeta(std::stringstream& data, Extensible* ext)
78 for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); i++)
80 ExtensionItem* item = i->first;
81 std::string value = item->serialize(FORMAT_USER, ext, i->second);
83 data << "<meta name=\"" << item->name << "\">" << Sanitize(value) << "</meta>";
84 else if (!item->name.empty())
85 data << "<meta name=\"" << item->name << "\"/>";
87 data << "</metadata>";
90 void OnEvent(Event& event) CXX11_OVERRIDE
92 std::stringstream data("");
94 if (event.id == "httpd_url")
96 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd event");
97 HTTPRequest* http = (HTTPRequest*)&event;
99 if ((http->GetURI() == "/stats") || (http->GetURI() == "/stats/"))
101 data << "<inspircdstats><server><name>" << ServerInstance->Config->ServerName << "</name><gecos>"
102 << Sanitize(ServerInstance->Config->ServerDesc) << "</gecos><version>"
103 << Sanitize(ServerInstance->GetVersionString()) << "</version></server>";
106 data << "<usercount>" << ServerInstance->Users->GetUsers().size() << "</usercount>";
107 data << "<channelcount>" << ServerInstance->GetChans().size() << "</channelcount>";
108 data << "<opercount>" << ServerInstance->Users->all_opers.size() << "</opercount>";
109 data << "<socketcount>" << (SocketEngine::GetUsedFds()) << "</socketcount><socketmax>" << SocketEngine::GetMaxFds() << "</socketmax><socketengine>" INSPIRCD_SOCKETENGINE_NAME "</socketengine>";
110 data << "<uptime><boot_time_t>" << ServerInstance->startup_time << "</boot_time_t></uptime>";
112 data << "<isupport>";
113 const std::vector<std::string>& isupport = ServerInstance->ISupport.GetLines();
114 for (std::vector<std::string>::const_iterator it = isupport.begin(); it != isupport.end(); it++)
116 data << Sanitize(*it) << std::endl;
118 data << "</isupport></general><xlines>";
119 std::vector<std::string> xltypes = ServerInstance->XLines->GetAllTypes();
120 for (std::vector<std::string>::iterator it = xltypes.begin(); it != xltypes.end(); ++it)
122 XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
126 for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
128 data << "<xline type=\"" << it->c_str() << "\"><mask>"
129 << Sanitize(i->second->Displayable()) << "</mask><settime>"
130 << i->second->set_time << "</settime><duration>" << i->second->duration
131 << "</duration><reason>" << Sanitize(i->second->reason)
132 << "</reason></xline>";
136 data << "</xlines><modulelist>";
137 const ModuleManager::ModuleMap& mods = ServerInstance->Modules->GetModules();
139 for (ModuleManager::ModuleMap::const_iterator i = mods.begin(); i != mods.end(); ++i)
141 Version v = i->second->GetVersion();
142 data << "<module><name>" << i->first << "</name><description>" << Sanitize(v.description) << "</description></module>";
144 data << "</modulelist><channellist>";
146 const chan_hash& chans = ServerInstance->GetChans();
147 for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i)
149 Channel* c = i->second;
152 data << "<usercount>" << c->GetUsers().size() << "</usercount><channelname>" << Sanitize(c->name) << "</channelname>";
153 data << "<channeltopic>";
154 data << "<topictext>" << Sanitize(c->topic) << "</topictext>";
155 data << "<setby>" << Sanitize(c->setby) << "</setby>";
156 data << "<settime>" << c->topicset << "</settime>";
157 data << "</channeltopic>";
158 data << "<channelmodes>" << Sanitize(c->ChanModes(true)) << "</channelmodes>";
160 const Channel::MemberMap& ulist = c->GetUsers();
161 for (Channel::MemberMap::const_iterator x = ulist.begin(); x != ulist.end(); ++x)
163 Membership* memb = x->second;
164 data << "<channelmember><uid>" << memb->user->uuid << "</uid><privs>"
165 << Sanitize(memb->GetAllPrefixChars()) << "</privs><modes>"
166 << memb->modes << "</modes>";
167 DumpMeta(data, memb);
168 data << "</channelmember>";
173 data << "</channel>";
176 data << "</channellist><userlist>";
178 const user_hash& users = ServerInstance->Users->GetUsers();
179 for (user_hash::const_iterator i = users.begin(); i != users.end(); ++i)
184 data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>"
185 << u->host << "</realhost><displayhost>" << u->dhost << "</displayhost><gecos>"
186 << Sanitize(u->fullname) << "</gecos><server>" << u->server->GetName() << "</server>";
188 data << "<away>" << Sanitize(u->awaymsg) << "</away><awaytime>" << u->awaytime << "</awaytime>";
190 data << "<opertype>" << Sanitize(u->oper->name) << "</opertype>";
191 data << "<modes>" << u->FormatModes() << "</modes><ident>" << Sanitize(u->ident) << "</ident>";
192 LocalUser* lu = IS_LOCAL(u);
194 data << "<port>" << lu->GetServerPort() << "</port><servaddr>"
195 << lu->server_sa.str() << "</servaddr>";
196 data << "<ipaddress>" << u->GetIPString() << "</ipaddress>";
203 data << "</userlist><serverlist>";
205 ProtocolInterface::ServerList sl;
206 ServerInstance->PI->GetServerList(sl);
208 for (ProtocolInterface::ServerList::const_iterator b = sl.begin(); b != sl.end(); ++b)
211 data << "<servername>" << b->servername << "</servername>";
212 data << "<parentname>" << b->parentname << "</parentname>";
213 data << "<gecos>" << b->gecos << "</gecos>";
214 data << "<usercount>" << b->usercount << "</usercount>";
215 // This is currently not implemented, so, commented out.
216 // data << "<opercount>" << b->opercount << "</opercount>";
217 data << "<lagmillisecs>" << b->latencyms << "</lagmillisecs>";
221 data << "</serverlist></inspircdstats>";
223 /* Send the document back to m_httpd */
224 HTTPDocumentResponse response(this, *http, &data, 200);
225 response.headers.SetHeader("X-Powered-By", MODNAME);
226 response.headers.SetHeader("Content-Type", "text/xml");
227 API->SendResponse(response);
232 Version GetVersion() CXX11_OVERRIDE
234 return Version("Provides statistics over HTTP via m_httpd.so", VF_VENDOR);
238 static const insp::flat_map<char, char const*>& init_entities()
240 static insp::flat_map<char, char const*> entities;
241 entities['<'] = "lt";
242 entities['>'] = "gt";
243 entities['&'] = "amp";
244 entities['"'] = "quot";
248 const insp::flat_map<char, char const*>& ModuleHttpStats::entities = init_entities();
250 MODULE_INIT(ModuleHttpStats)