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/>.
29 /* $ModDesc: Provides statistics over HTTP via m_httpd.so */
31 class ModuleHttpStats : public Module
33 static std::map<char, char const*> const &entities;
39 Implementation eventlist[] = { I_OnEvent };
40 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
43 std::string Sanitize(const std::string &str)
46 ret.reserve(str.length() * 2);
48 for (std::string::const_iterator x = str.begin(); x != str.end(); ++x)
50 std::map<char, char const*>::const_iterator it = entities.find(*x);
52 if (it != entities.end())
58 else if (*x == 0x9 || *x == 0xA || *x == 0xD || *x >= 0x20)
60 // The XML specification defines the following characters as valid inside an XML document:
61 // Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
66 // If we reached this point then the string contains characters which can
67 // not be represented in XML, even using a numeric escape. Therefore, we
68 // Base64 encode the entire string and wrap it in a CDATA.
71 ret += BinToBase64(str);
79 void DumpMeta(std::stringstream& data, Extensible* ext)
82 for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); i++)
84 ExtensionItem* item = i->first;
85 std::string value = item->serialize(FORMAT_USER, ext, i->second);
87 data << "<meta name=\"" << item->name << "\">" << Sanitize(value) << "</meta>";
88 else if (!item->name.empty())
89 data << "<meta name=\"" << item->name << "\"/>";
91 data << "</metadata>";
94 void OnEvent(Event& event)
96 std::stringstream data("");
98 if (event.id == "httpd_url")
100 ServerInstance->Logs->Log("m_http_stats", DEBUG,"Handling httpd event");
101 HTTPRequest* http = (HTTPRequest*)&event;
103 if ((http->GetURI() == "/stats") || (http->GetURI() == "/stats/"))
105 data << "<inspircdstats><server><name>" << ServerInstance->Config->ServerName << "</name><gecos>"
106 << Sanitize(ServerInstance->Config->ServerDesc) << "</gecos><version>"
107 << Sanitize(ServerInstance->GetVersionString()) << "</version></server>";
110 data << "<usercount>" << ServerInstance->Users->clientlist->size() << "</usercount>";
111 data << "<channelcount>" << ServerInstance->chanlist->size() << "</channelcount>";
112 data << "<opercount>" << ServerInstance->Users->all_opers.size() << "</opercount>";
113 data << "<socketcount>" << (ServerInstance->SE->GetUsedFds()) << "</socketcount><socketmax>" << ServerInstance->SE->GetMaxFds() << "</socketmax><socketengine>" << ServerInstance->SE->GetName() << "</socketengine>";
115 time_t current_time = 0;
116 current_time = ServerInstance->Time();
117 time_t server_uptime = current_time - ServerInstance->startup_time;
119 stime = gmtime(&server_uptime);
120 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>";
122 data << "<isupport>" << Sanitize(ServerInstance->Config->data005) << "</isupport></general><xlines>";
123 std::vector<std::string> xltypes = ServerInstance->XLines->GetAllTypes();
124 for (std::vector<std::string>::iterator it = xltypes.begin(); it != xltypes.end(); ++it)
126 XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
130 for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
132 data << "<xline type=\"" << it->c_str() << "\"><mask>"
133 << Sanitize(i->second->Displayable()) << "</mask><settime>"
134 << i->second->set_time << "</settime><duration>" << i->second->duration
135 << "</duration><reason>" << Sanitize(i->second->reason)
136 << "</reason></xline>";
140 data << "</xlines><modulelist>";
141 std::vector<std::string> module_names = ServerInstance->Modules->GetAllModuleNames(0);
143 for (std::vector<std::string>::iterator i = module_names.begin(); i != module_names.end(); ++i)
145 Module* m = ServerInstance->Modules->Find(i->c_str());
146 Version v = m->GetVersion();
147 data << "<module><name>" << *i << "</name><description>" << Sanitize(v.description) << "</description></module>";
149 data << "</modulelist><channellist>";
151 for (chan_hash::const_iterator a = ServerInstance->chanlist->begin(); a != ServerInstance->chanlist->end(); ++a)
153 Channel* c = a->second;
156 data << "<usercount>" << c->GetUsers()->size() << "</usercount><channelname>" << Sanitize(c->name) << "</channelname>";
157 data << "<channeltopic>";
158 data << "<topictext>" << Sanitize(c->topic) << "</topictext>";
159 data << "<setby>" << Sanitize(c->setby) << "</setby>";
160 data << "<settime>" << c->topicset << "</settime>";
161 data << "</channeltopic>";
162 data << "<channelmodes>" << Sanitize(c->ChanModes(true)) << "</channelmodes>";
163 const UserMembList* ulist = c->GetUsers();
165 for (UserMembCIter x = ulist->begin(); x != ulist->end(); ++x)
167 Membership* memb = x->second;
168 data << "<channelmember><uid>" << memb->user->uuid << "</uid><privs>"
169 << Sanitize(c->GetAllPrefixChars(x->first)) << "</privs><modes>"
170 << memb->modes << "</modes>";
171 DumpMeta(data, memb);
172 data << "</channelmember>";
177 data << "</channel>";
180 data << "</channellist><userlist>";
182 for (user_hash::const_iterator a = ServerInstance->Users->clientlist->begin(); a != ServerInstance->Users->clientlist->end(); ++a)
187 data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>"
188 << u->host << "</realhost><displayhost>" << u->dhost << "</displayhost><gecos>"
189 << Sanitize(u->fullname) << "</gecos><server>" << u->server << "</server>";
191 data << "<away>" << Sanitize(u->awaymsg) << "</away><awaytime>" << u->awaytime << "</awaytime>";
193 data << "<opertype>" << Sanitize(u->oper->NameStr()) << "</opertype>";
194 data << "<modes>" << u->FormatModes() << "</modes><ident>" << Sanitize(u->ident) << "</ident>";
195 LocalUser* lu = IS_LOCAL(u);
197 data << "<port>" << lu->GetServerPort() << "</port><servaddr>"
198 << irc::sockets::satouser(lu->server_sa) << "</servaddr>";
199 data << "<ipaddress>" << u->GetIPString() << "</ipaddress>";
206 data << "</userlist><serverlist>";
209 ServerInstance->PI->GetServerList(sl);
211 for (ProtoServerList::iterator b = sl.begin(); b != sl.end(); ++b)
214 data << "<servername>" << b->servername << "</servername>";
215 data << "<parentname>" << b->parentname << "</parentname>";
216 data << "<gecos>" << b->gecos << "</gecos>";
217 data << "<usercount>" << b->usercount << "</usercount>";
218 // This is currently not implemented, so, commented out.
219 // data << "<opercount>" << b->opercount << "</opercount>";
220 data << "<lagmillisecs>" << b->latencyms << "</lagmillisecs>";
224 data << "</serverlist></inspircdstats>";
226 /* Send the document back to m_httpd */
227 HTTPDocumentResponse response(this, *http, &data, 200);
228 response.headers.SetHeader("X-Powered-By", "m_httpd_stats.so");
229 response.headers.SetHeader("Content-Type", "text/xml");
235 virtual Version GetVersion()
237 return Version("Provides statistics over HTTP via m_httpd.so", VF_VENDOR);
241 static std::map<char, char const*> const &init_entities()
243 static std::map<char, char const*> entities;
244 entities['<'] = "lt";
245 entities['>'] = "gt";
246 entities['&'] = "amp";
247 entities['"'] = "quot";
251 std::map<char, char const*> const &ModuleHttpStats::entities = init_entities ();
253 MODULE_INIT(ModuleHttpStats)