]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_shun.cpp
Refactor the shun module slightly.
[user/henk/code/inspircd.git] / src / modules / m_shun.cpp
index 6453ace81485958a0060e4c4d28adbc2d4a3202f..4e7d979d1fa6d7caf95f09f71e38581e24831694 100644 (file)
@@ -1,9 +1,20 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2017-2018 B00mX0r <b00mx0r@aureus.pw>
+ *   Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2018-2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 Jens Voss <DukePyrolator@anope.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2009 Matt Smith <dz@inspircd.org>
+ *   Copyright (C) 2009 John Brooks <special@inspircd.org>
+ *   Copyright (C) 2009 Dennis Friis <peavey@inspircd.org>
  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008-2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -46,14 +57,13 @@ class ShunFactory : public XLineFactory
        }
 };
 
-//typedef std::vector<Shun> shunlist;
-
 class CommandShun : public Command
 {
  public:
        CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
        {
-               flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
+               flags_needed = 'o';
+               syntax = "<nick!user@host> [<duration> :<reason>]";
        }
 
        CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
@@ -69,17 +79,19 @@ class CommandShun : public Command
 
                if (parameters.size() == 1)
                {
-                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", user))
+                       std::string reason;
+
+                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", reason, user))
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s", user->nick.c_str(), parameters[0].c_str());
+                               ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s: %s", user->nick.c_str(), parameters[0].c_str(), reason.c_str());
                        }
-                       else if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", user))
+                       else if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", reason, user))
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x',"%s removed SHUN on %s", user->nick.c_str(), target.c_str());
+                               ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s: %s", user->nick.c_str(), target.c_str(), reason.c_str());
                        }
                        else
                        {
-                               user->WriteNotice("*** Shun " + parameters[0] + " not found in list, try /stats H.");
+                               user->WriteNotice("*** Shun " + parameters[0] + " not found on the list.");
                                return CMD_FAILURE;
                        }
                }
@@ -108,15 +120,14 @@ class CommandShun : public Command
                        {
                                if (!duration)
                                {
-                                       ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
+                                       ServerInstance->SNO->WriteToSnoMask('x', "%s added permanent SHUN for %s: %s",
                                                user->nick.c_str(), target.c_str(), expr.c_str());
                                }
                                else
                                {
-                                       time_t c_requires_crap = duration + ServerInstance->Time();
-                                       std::string timestr = InspIRCd::TimeString(c_requires_crap);
-                                       ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
-                                               user->nick.c_str(), target.c_str(), timestr.c_str(), expr.c_str());
+                                       ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s, expires in %s (on %s): %s",
+                                               user->nick.c_str(), target.c_str(), InspIRCd::DurationString(duration).c_str(),
+                                               InspIRCd::TimeString(ServerInstance->Time() + duration).c_str(), expr.c_str());
                                }
                        }
                        else
@@ -140,11 +151,26 @@ class CommandShun : public Command
 
 class ModuleShun : public Module, public Stats::EventListener
 {
+ private:
        CommandShun cmd;
-       ShunFactory f;
-       insp::flat_set<std::string> ShunEnabledCommands;
-       bool NotifyOfShun;
+       ShunFactory shun;
+       insp::flat_set<std::string, irc::insensitive_swo> enabledcommands;
        bool affectopers;
+       bool notifyuser;
+
+       bool IsShunned(LocalUser* user)
+       {
+               // Exempt the user from shuns if they are an oper and affectopers is disabled.
+               if (!affectopers && user->IsOper())
+                       return false;
+
+               // Exempt the user from shuns if they are an oper with the servers/ignore-shun privilege.
+               if (user->HasPrivPermission("servers/ignore-shun"))
+                       return false;
+
+               // Check whether the user is actually shunned.
+               return ServerInstance->XLines->MatchesLine("SHUN", user);
+       }
 
  public:
        ModuleShun()
@@ -155,13 +181,13 @@ class ModuleShun : public Module, public Stats::EventListener
 
        void init() CXX11_OVERRIDE
        {
-               ServerInstance->XLines->RegisterFactory(&f);
+               ServerInstance->XLines->RegisterFactory(&shun);
        }
 
        ~ModuleShun()
        {
                ServerInstance->XLines->DelAll("SHUN");
-               ServerInstance->XLines->UnregisterFactory(&f);
+               ServerInstance->XLines->UnregisterFactory(&shun);
        }
 
        void Prioritize() CXX11_OVERRIDE
@@ -175,54 +201,32 @@ class ModuleShun : public Module, public Stats::EventListener
                if (stats.GetSymbol() != 'H')
                        return MOD_RES_PASSTHRU;
 
-               ServerInstance->XLines->InvokeStats("SHUN", 223, stats);
+               ServerInstance->XLines->InvokeStats("SHUN", stats);
                return MOD_RES_DENY;
        }
 
        void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
                ConfigTag* tag = ServerInstance->Config->ConfValue("shun");
-               std::string cmds = tag->getString("enabledcommands");
-               std::transform(cmds.begin(), cmds.end(), cmds.begin(), ::toupper);
-
-               if (cmds.empty())
-                       cmds = "PING PONG QUIT";
-
-               ShunEnabledCommands.clear();
-
-               irc::spacesepstream dcmds(cmds);
-               std::string thiscmd;
 
-               while (dcmds.GetToken(thiscmd))
-               {
-                       ShunEnabledCommands.insert(thiscmd);
-               }
+               enabledcommands.clear();
+               irc::spacesepstream enabledcmds(tag->getString("enabledcommands", "ADMIN OPER PING PONG QUIT", 1));
+               for (std::string enabledcmd; enabledcmds.GetToken(enabledcmd); )
+                       enabledcommands.insert(enabledcmd);
 
-               NotifyOfShun = tag->getBool("notifyuser", true);
                affectopers = tag->getBool("affectopers", false);
+               notifyuser = tag->getBool("notifyuser", true);
        }
 
        ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
        {
-               if (validated)
-                       return MOD_RES_PASSTHRU;
-
-               if (!ServerInstance->XLines->MatchesLine("SHUN", user))
-               {
-                       /* Not shunned, don't touch. */
+               if (validated || !IsShunned(user))
                        return MOD_RES_PASSTHRU;
-               }
-
-               if (!affectopers && user->IsOper())
-               {
-                       /* Don't do anything if the user is an operator and affectopers isn't set */
-                       return MOD_RES_PASSTHRU;
-               }
 
-               if (!ShunEnabledCommands.count(command))
+               if (!enabledcommands.count(command))
                {
-                       if (NotifyOfShun)
-                               user->WriteNotice("*** Command " + command + " not processed, as you have been blocked from issuing commands (SHUN)");
+                       if (notifyuser)
+                               user->WriteNotice("*** " + command + " command not processed as you have been blocked from issuing commands.");
                        return MOD_RES_DENY;
                }
 
@@ -243,7 +247,7 @@ class ModuleShun : public Module, public Stats::EventListener
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
+               return Version("Adds the /SHUN command which allows server operators to prevent users from executing commands.", VF_VENDOR|VF_COMMON);
        }
 };