]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_httpd_stats.cpp
Fix the 'w' extban not being added to the EXTBAN 005 numeric.
[user/henk/code/inspircd.git] / src / modules / m_httpd_stats.cpp
index 4b18eadc44803ca07dbd02e53f02741e3d72546d..1e9f4ef4b92f6d8a33809b5b70d4778b6cfed8e1 100644 (file)
@@ -1,11 +1,19 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2018 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2016 Johanna A <johanna-a@users.noreply.github.com>
+ *   Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017, 2019-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008-2009 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 John Brooks <special@inspircd.org>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
@@ -86,7 +94,7 @@ namespace Stats
                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 << "<meta name=\"" << item->name << "\">" << Sanitize(value) << "</meta>";
                        else if (!item->name.empty())
@@ -99,7 +107,7 @@ namespace Stats
        {
                return data << "<server><name>" << ServerInstance->Config->ServerName << "</name><description>"
                        << Sanitize(ServerInstance->Config->ServerDesc) << "</description><version>"
-                       << Sanitize(ServerInstance->GetVersionString()) << "</version></server>";
+                       << Sanitize(ServerInstance->GetVersionString(true)) << "</version></server>";
        }
 
        std::ostream& ISupport(std::ostream& data)
@@ -124,6 +132,7 @@ namespace Stats
                data << "<opercount>" << ServerInstance->Users->all_opers.size() << "</opercount>";
                data << "<socketcount>" << (SocketEngine::GetUsedFds()) << "</socketcount><socketmax>" << SocketEngine::GetMaxFds() << "</socketmax>";
                data << "<uptime><boot_time_t>" << ServerInstance->startup_time << "</boot_time_t></uptime>";
+               data << "<currenttime>" << ServerInstance->Time() << "</currenttime>";
 
                data << ISupport;
                return data << "</general>";
@@ -201,6 +210,37 @@ namespace Stats
                return data << "</channellist>";
        }
 
+       std::ostream& DumpUser(std::ostream& data, User* u)
+       {
+               data << "<user>";
+               data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>"
+                       << u->GetRealHost() << "</realhost><displayhost>" << u->GetDisplayedHost() << "</displayhost><realname>"
+                       << Sanitize(u->GetRealName()) << "</realname><server>" << u->server->GetName() << "</server><signon>"
+                       << u->signon << "</signon><age>" << u->age << "</age>";
+
+               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->GetModeLetters().substr(1) << "</modes><ident>" << Sanitize(u->ident) << "</ident>";
+
+               LocalUser* lu = IS_LOCAL(u);
+               if (lu)
+                       data << "<local/><port>" << lu->server_sa.port() << "</port><servaddr>"
+                               << lu->server_sa.str() << "</servaddr><connectclass>"
+                               << lu->GetClass()->GetName() << "</connectclass><lastmsg>"
+                               << lu->idle_lastmsg << "</lastmsg>";
+
+               data << "<ipaddress>" << u->GetIPString() << "</ipaddress>";
+
+               DumpMeta(data, u);
+
+               data << "</user>";
+               return data;
+       }
+
        std::ostream& Users(std::ostream& data)
        {
                data << "<userlist>";
@@ -209,24 +249,10 @@ namespace Stats
                {
                        User* u = i->second;
 
-                       data << "<user>";
-                       data << "<nickname>" << u->nick << "</nickname><uuid>" << u->uuid << "</uuid><realhost>"
-                               << u->GetRealHost() << "</realhost><displayhost>" << u->GetDisplayedHost() << "</displayhost><realname>"
-                               << Sanitize(u->GetRealName()) << "</realname><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->GetModeLetters().substr(1) << "</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);
+                       if (u->registered != REG_ALL)
+                               continue;
 
-                       data << "</user>";
+                       DumpUser(data, u);
                }
                return data << "</userlist>";
        }
@@ -265,49 +291,164 @@ namespace Stats
                }
                return data << "</commandlist>";
        }
+
+       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 <typename T>
+               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 << "<userlist>";
+
+               // Filters
+               size_t limit = params.getNum<size_t>("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<User*> 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 << "</userlist>";
+               return data;
+       }
 }
 
 class ModuleHttpStats : public Module, public HTTPRequestEventListener
 {
        HTTPdAPI API;
+       bool enableparams;
 
  public:
        ModuleHttpStats()
                : HTTPRequestEventListener(this)
                , API(this)
+               , enableparams(false)
        {
        }
 
-       ModResult HandleRequest(HTTPRequest* http)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               std::string uri = http->GetURI();
+               ConfigTag* conf = ServerInstance->Config->ConfValue("httpstats");
 
-               if (uri != "/stats" && uri.substr(0, 7) != "/stats/")
-                       return MOD_RES_PASSTHRU;
+               // Parameterized queries may cause a performance issue
+               // Due to the sheer volume of data
+               // So default them to disabled
+               enableparams = conf->getBool("enableparams");
+       }
 
-               if (uri[uri.size() - 1] == '/')
-                       uri.erase(uri.size() - 1, 1);
+       ModResult HandleRequest(HTTPRequest* http)
+       {
+               if (http->GetPath() != "/stats")
+                       return MOD_RES_PASSTHRU;
 
-               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd event");
+               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling HTTP request for %s", http->GetPath().c_str());
 
                bool found = true;
                std::stringstream data;
                data << "<inspircdstats>";
 
-               if (uri == "/stats")
+               if (http->GetPath() == "/stats")
                {
                        data << Stats::ServerInfo << Stats::General
                                << Stats::XLines << Stats::Modules
                                << Stats::Channels << Stats::Users
                                << Stats::Servers << Stats::Commands;
                }
-               else if (uri == "/stats/general")
+               else if (http->GetPath() == "/stats/general")
                {
                        data << Stats::General;
                }
-               else if (uri == "/stats/users")
+               else if (http->GetPath() == "/stats/users")
                {
-                       data << Stats::Users;
+                       if (enableparams)
+                               Stats::ListUsers(data, http->GetParsedURI().query_params);
+                       else
+                               data << Stats::Users;
                }
                else
                {
@@ -339,7 +480,7 @@ class ModuleHttpStats : public Module, public HTTPRequestEventListener
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides statistics over HTTP via m_httpd", VF_VENDOR);
+               return Version("Provides XML-serialised statistics about the server, channels, and users over HTTP via the /stats path.", VF_VENDOR);
        }
 };