]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/coremods/core_whois.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / coremods / core_whois.cpp
index 81e62c8e5474a580e9b8f473c0bdea224576d350..c1c4777ef24c397b4bcaff5c555ed290a47ce811 100644 (file)
@@ -1,9 +1,17 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2018 Dylan Frank <b00mx0r@aureus.pw>
+ *   Copyright (C) 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   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
 
 
 #include "inspircd.h"
+#include "modules/whois.h"
+
+enum SplitWhoisState
+{
+       // Don't split private/secret channels into a separate RPL_WHOISCHANNELS numeric.
+       SPLITWHOIS_NONE,
+
+       // Split private/secret channels into a separate RPL_WHOISCHANNELS numeric.
+       SPLITWHOIS_SPLIT,
+
+       // Split private/secret channels into a separate RPL_WHOISCHANNELS numeric with RPL_CHANNELSMSG to explain the split.
+       SPLITWHOIS_SPLITMSG
+};
 
 class WhoisContextImpl : public Whois::Context
 {
@@ -55,10 +76,18 @@ class CommandWhois : public SplitCommand
        Events::ModuleEventProvider evprov;
        Events::ModuleEventProvider lineevprov;
 
-       void DoWhois(LocalUser* user, User* dest, unsigned long signon, unsigned long idle);
+       void DoWhois(LocalUser* user, User* dest, time_t signon, unsigned long idle);
        void SendChanList(WhoisContextImpl& whois);
 
  public:
+        /** If true then all opers are shown with a generic 'is a server operator' line rather than the oper type. */
+       bool genericoper;
+
+        /** How to handle private/secret channels in the WHOIS response. */
+       SplitWhoisState splitwhois;
+
+
+
        /** Constructor for whois.
         */
        CommandWhois(Module* parent)
@@ -70,7 +99,7 @@ class CommandWhois : public SplitCommand
                , lineevprov(parent, "event/whoisline")
        {
                Penalty = 2;
-               syntax = "<nick>{,<nick>}";
+               syntax = "[<servername>] <nick>[,<nick>]+";
        }
 
        /** Handle command.
@@ -78,8 +107,8 @@ class CommandWhois : public SplitCommand
         * @param user The user issuing the command
         * @return A value from CmdResult to indicate command success or failure.
         */
-       CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
-       CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* target);
+       CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE;
+       CmdResult HandleRemote(RemoteUser* target, const Params& parameters) CXX11_OVERRIDE;
 };
 
 class WhoisNumericSink
@@ -101,7 +130,7 @@ class WhoisChanListNumericBuilder : public Numeric::GenericBuilder<' ', false, W
 {
  public:
        WhoisChanListNumericBuilder(WhoisContextImpl& whois)
-               : Numeric::GenericBuilder<' ', false, WhoisNumericSink>(WhoisNumericSink(whois), 319, false, whois.GetSource()->nick.size() + whois.GetTarget()->nick.size() + 1)
+               : Numeric::GenericBuilder<' ', false, WhoisNumericSink>(WhoisNumericSink(whois), RPL_WHOISCHANNELS, false, whois.GetSource()->nick.size() + whois.GetTarget()->nick.size() + 1)
        {
                GetNumeric().push(whois.GetTarget()->nick).push(std::string());
        }
@@ -109,9 +138,9 @@ class WhoisChanListNumericBuilder : public Numeric::GenericBuilder<' ', false, W
 
 class WhoisChanList
 {
-       const ServerConfig::OperSpyWhoisState spywhois;
+       const SplitWhoisState& splitwhois;
        WhoisChanListNumericBuilder num;
-       WhoisChanListNumericBuilder spynum;
+       WhoisChanListNumericBuilder secretnum;
        std::string prefixstr;
 
        void AddMember(Membership* memb, WhoisChanListNumericBuilder& out)
@@ -124,10 +153,10 @@ class WhoisChanList
        }
 
  public:
-       WhoisChanList(WhoisContextImpl& whois)
-               : spywhois(whois.GetSource()->HasPrivPermission("users/auspex") ? ServerInstance->Config->OperSpyWhois : ServerConfig::SPYWHOIS_NONE)
+       WhoisChanList(WhoisContextImpl& whois, const SplitWhoisState& sws)
+               : splitwhois(sws)
                , num(whois)
-               , spynum(whois)
+               , secretnum(whois)
        {
        }
 
@@ -138,102 +167,105 @@ class WhoisChanList
 
        void AddHidden(Membership* memb)
        {
-               if (spywhois == ServerConfig::SPYWHOIS_NONE)
-                       return;
-               AddMember(memb, (spywhois == ServerConfig::SPYWHOIS_SPLITMSG ? spynum : num));
+               AddMember(memb, splitwhois == SPLITWHOIS_NONE ? num : secretnum);
        }
 
        void Flush(WhoisContextImpl& whois)
        {
                num.Flush();
-               if (!spynum.IsEmpty())
-                       whois.SendLine(336, "is on private/secret channels:");
-               spynum.Flush();
+               if (!secretnum.IsEmpty() && splitwhois == SPLITWHOIS_SPLITMSG)
+                       whois.SendLine(RPL_CHANNELSMSG, "is on private/secret channels:");
+               secretnum.Flush();
        }
 };
 
 void CommandWhois::SendChanList(WhoisContextImpl& whois)
 {
-       WhoisChanList chanlist(whois);
+       WhoisChanList chanlist(whois, splitwhois);
 
        User* const target = whois.GetTarget();
+       bool hasoperpriv = whois.GetSource()->HasPrivPermission("users/channel-spy");
        for (User::ChanList::iterator i = target->chans.begin(); i != target->chans.end(); ++i)
        {
                Membership* memb = *i;
                Channel* c = memb->chan;
-               /* If the target is the sender, neither +p nor +s is set, or
-                * the channel contains the user, it is not a spy channel
-                */
-               if ((whois.IsSelfWhois()) || ((!c->IsModeSet(privatemode)) && (!c->IsModeSet(secretmode))) || (c->HasUser(whois.GetSource())))
+
+               // Anyone can view channels which are not private or secret.
+               if (!c->IsModeSet(privatemode) && !c->IsModeSet(secretmode))
                        chanlist.AddVisible(memb);
-               else
+
+               // Hidden channels are visible when the following conditions are true:
+               // (1) The source user and the target user are the same.
+               // (2) The source user is a member of the hidden channel.
+               // (3) The source user is an oper with the users/channel-spy privilege.
+               else if (whois.IsSelfWhois() || c->HasUser(whois.GetSource()) || hasoperpriv)
                        chanlist.AddHidden(memb);
        }
 
        chanlist.Flush(whois);
 }
 
-void CommandWhois::DoWhois(LocalUser* user, User* dest, unsigned long signon, unsigned long idle)
+void CommandWhois::DoWhois(LocalUser* user, User* dest, time_t signon, unsigned long idle)
 {
        WhoisContextImpl whois(user, dest, lineevprov);
 
-       whois.SendLine(311, dest->ident, dest->dhost, '*', dest->fullname);
+       whois.SendLine(RPL_WHOISUSER, dest->ident, dest->GetDisplayedHost(), '*', dest->GetRealName());
        if (whois.IsSelfWhois() || user->HasPrivPermission("users/auspex"))
        {
-               whois.SendLine(378, InspIRCd::Format("is connecting from %s@%s %s", dest->ident.c_str(), dest->host.c_str(), dest->GetIPString().c_str()));
+               whois.SendLine(RPL_WHOISHOST, InspIRCd::Format("is connecting from %s@%s %s", dest->ident.c_str(), dest->GetRealHost().c_str(), dest->GetIPString().c_str()));
        }
 
        SendChanList(whois);
 
-       if (!whois.IsSelfWhois() && !ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"))
+       if (!whois.IsSelfWhois() && !ServerInstance->Config->HideServer.empty() && !user->HasPrivPermission("servers/auspex"))
        {
-               whois.SendLine(312, ServerInstance->Config->HideWhoisServer, ServerInstance->Config->Network);
+               whois.SendLine(RPL_WHOISSERVER, ServerInstance->Config->HideServer, ServerInstance->Config->Network);
        }
        else
        {
-               whois.SendLine(312, dest->server->GetName(), dest->server->GetDesc());
+               whois.SendLine(RPL_WHOISSERVER, dest->server->GetName(), dest->server->GetDesc());
        }
 
        if (dest->IsAway())
        {
-               whois.SendLine(301, dest->awaymsg);
+               whois.SendLine(RPL_AWAY, dest->awaymsg);
        }
 
        if (dest->IsOper())
        {
-               if (ServerInstance->Config->GenericOper)
-                       whois.SendLine(313, "is an IRC operator");
+               if (genericoper)
+                       whois.SendLine(RPL_WHOISOPERATOR, "is a server operator");
                else
-                       whois.SendLine(313, InspIRCd::Format("is %s %s on %s", (strchr("AEIOUaeiou",dest->oper->name[0]) ? "an" : "a"), dest->oper->name.c_str(), ServerInstance->Config->Network.c_str()));
+                       whois.SendLine(RPL_WHOISOPERATOR, InspIRCd::Format("is %s %s on %s", (strchr("AEIOUaeiou",dest->oper->name[0]) ? "an" : "a"), dest->oper->name.c_str(), ServerInstance->Config->Network.c_str()));
        }
 
        if (whois.IsSelfWhois() || user->HasPrivPermission("users/auspex"))
        {
                if (dest->IsModeSet(snomaskmode))
                {
-                       whois.SendLine(379, InspIRCd::Format("is using modes %s %s", dest->GetModeLetters().c_str(), snomaskmode->GetUserParameter(dest).c_str()));
+                       whois.SendLine(RPL_WHOISMODES, InspIRCd::Format("is using modes %s %s", dest->GetModeLetters().c_str(), snomaskmode->GetUserParameter(dest).c_str()));
                }
                else
                {
-                       whois.SendLine(379, InspIRCd::Format("is using modes %s", dest->GetModeLetters().c_str()));
+                       whois.SendLine(RPL_WHOISMODES, InspIRCd::Format("is using modes %s", dest->GetModeLetters().c_str()));
                }
        }
 
        FOREACH_MOD_CUSTOM(evprov, Whois::EventListener, OnWhois, (whois));
 
        /*
-        * We only send these if we've been provided them. That is, if hidewhois is turned off, and user is local, or
+        * We only send these if we've been provided them. That is, if hideserver is turned off, and user is local, or
         * if remote whois is queried, too. This is to keep the user hidden, and also since you can't reliably tell remote time. -- w00t
         */
        if ((idle) || (signon))
        {
-               whois.SendLine(317, idle, signon, "seconds idle, signon time");
+               whois.SendLine(RPL_WHOISIDLE, idle, signon, "seconds idle, signon time");
        }
 
-       whois.SendLine(318, "End of /WHOIS list.");
+       whois.SendLine(RPL_ENDOFWHOIS, "End of /WHOIS list.");
 }
 
-CmdResult CommandWhois::HandleRemote(const std::vector<std::string>& parameters, RemoteUser* target)
+CmdResult CommandWhois::HandleRemote(RemoteUser* target, const Params& parameters)
 {
        if (parameters.size() < 2)
                return CMD_FAILURE;
@@ -247,24 +279,25 @@ CmdResult CommandWhois::HandleRemote(const std::vector<std::string>& parameters,
        if (!localuser)
                return CMD_FAILURE;
 
-       unsigned long idle = ConvToInt(parameters.back());
+       unsigned long idle = ConvToNum<unsigned long>(parameters.back());
        DoWhois(localuser, target, target->signon, idle);
 
        return CMD_SUCCESS;
 }
 
-CmdResult CommandWhois::HandleLocal(const std::vector<std::string>& parameters, LocalUser* user)
+CmdResult CommandWhois::HandleLocal(LocalUser* user, const Params& parameters)
 {
        User *dest;
-       int userindex = 0;
-       unsigned long idle = 0, signon = 0;
+       unsigned int userindex = 0;
+       unsigned long idle = 0;
+       time_t signon = 0;
 
        if (CommandParser::LoopCall(user, this, parameters, 0))
                return CMD_SUCCESS;
 
        /*
-        * If 2 paramters are specified (/whois nick nick), ignore the first one like spanningtree
-        * does, and use the second one, otherwise, use the only paramter. -- djGrrr
+        * If 2 parameters are specified (/whois nick nick), ignore the first one like spanningtree
+        * does, and use the second one, otherwise, use the only parameter. -- djGrrr
         */
        if (parameters.size() > 1)
                userindex = 1;
@@ -275,14 +308,14 @@ CmdResult CommandWhois::HandleLocal(const std::vector<std::string>& parameters,
        {
                /*
                 * Okay. Umpteenth attempt at doing this, so let's re-comment...
-                * For local users (/w localuser), we show idletime if hidewhois is disabled
+                * For local users (/w localuser), we show idletime if hideserver is disabled
                 * For local users (/w localuser localuser), we always show idletime, hence parameters.size() > 1 check.
                 * For remote users (/w remoteuser), we do NOT show idletime
                 * For remote users (/w remoteuser remoteuser), spanningtree will handle calling do_whois, so we can ignore this case.
                 * Thanks to djGrrr for not being impatient while I have a crap day coding. :p -- w00t
                 */
                LocalUser* localuser = IS_LOCAL(dest);
-               if (localuser && (ServerInstance->Config->HideWhoisServer.empty() || parameters.size() > 1))
+               if (localuser && (ServerInstance->Config->HideServer.empty() || parameters.size() > 1))
                {
                        idle = labs((long)((localuser->idle_lastmsg)-ServerInstance->Time()));
                        signon = dest->signon;
@@ -301,4 +334,40 @@ CmdResult CommandWhois::HandleLocal(const std::vector<std::string>& parameters,
        return CMD_SUCCESS;
 }
 
-COMMAND_INIT(CommandWhois)
+class CoreModWhois : public Module
+{
+ private:
+       CommandWhois cmd;
+
+ public:
+       CoreModWhois()
+               : cmd(this)
+       {
+       }
+
+       void ReadConfig(ConfigStatus&) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("options");
+               const std::string splitwhois = tag->getString("splitwhois", "no", 1);
+               SplitWhoisState newsplitstate;
+               if (stdalgo::string::equalsci(splitwhois, "no"))
+                       newsplitstate = SPLITWHOIS_NONE;
+               else if (stdalgo::string::equalsci(splitwhois, "split"))
+                       newsplitstate = SPLITWHOIS_SPLIT;
+               else if (stdalgo::string::equalsci(splitwhois, "splitmsg"))
+                       newsplitstate = SPLITWHOIS_SPLITMSG;
+               else
+                       throw ModuleException(splitwhois + " is an invalid <options:splitwhois> value, at " + tag->getTagLocation());
+
+               ConfigTag* security = ServerInstance->Config->ConfValue("security");
+               cmd.genericoper = security->getBool("genericoper");
+               cmd.splitwhois = newsplitstate;
+       }
+
+       Version GetVersion() CXX11_OVERRIDE
+       {
+               return Version("Provides the WHOIS command", VF_VENDOR|VF_CORE);
+       }
+};
+
+MODULE_INIT(CoreModWhois)