Improve the timed ban notices (#1722).

[user/henk/code/inspircd.git] / src / modules / m_timedbans.cpp

diff --git a/src/modules/m_timedbans.cpp b/src/modules/m_timedbans.cpp
index 1898ea88a6ce0e3debe392dcde8cef118b877888..ef3382e4bea0335980b3ee9037ab89c45382573b 100644 (file)
--- a/src/modules/m_timedbans.cpp
+++ b/src/modules/m_timedbans.cpp
@@ -23,12 +23,12 @@
 #include "inspircd.h"
 #include "listmode.h"
 
-/** Holds a timed ban
- */
+// Holds a timed ban
 class TimedBan
 {
  public:
        std::string mask;
+       std::string setter;
        time_t expire;
        Channel* chan;
 };
@@ -36,8 +36,7 @@ class TimedBan
 typedef std::vector<TimedBan> timedbans;
 timedbans TimedBanList;
 
-/** Handle /TBAN
- */
+// Handle /TBAN
 class CommandTban : public Command
 {
        ChanModeReference banmode;
@@ -45,6 +44,9 @@ class CommandTban : public Command
        bool IsBanSet(Channel* chan, const std::string& mask)
        {
                ListModeBase* banlm = static_cast<ListModeBase*>(*banmode);
+               if (!banlm)
+                       return false;
+
                const ListModeBase::ModeList* bans = banlm->GetList(chan);
                if (bans)
                {
@@ -60,20 +62,22 @@ class CommandTban : public Command
        }
 
  public:
-       CommandTban(Module* Creator) : Command(Creator,"TBAN", 3)
+       CommandTban(Module* Creator)
+               : Command(Creator,"TBAN", 3)
                , banmode(Creator, "ban")
        {
                syntax = "<channel> <duration> <banmask>";
        }
 
-       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                Channel* channel = ServerInstance->FindChan(parameters[0]);
                if (!channel)
                {
-                       user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
+                       user->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
                        return CMD_FAILURE;
                }
+
                unsigned int cm = channel->GetPrefixValue(user);
                if (cm < HALFOP_VALUE)
                {
@@ -82,13 +86,14 @@ class CommandTban : public Command
                }
 
                TimedBan T;
-               unsigned long duration = InspIRCd::Duration(parameters[1]);
-               unsigned long expire = duration + ServerInstance->Time();
-               if (duration < 1)
+               unsigned long duration;
+               if (!InspIRCd::Duration(parameters[1], duration))
                {
                        user->WriteNotice("Invalid ban time");
                        return CMD_FAILURE;
                }
+               unsigned long expire = duration + ServerInstance->Time();
+
                std::string mask = parameters[2];
                bool isextban = ((mask.size() > 2) && (mask[1] == ':'));
                if (!isextban && !InspIRCd::IsValidMask(mask))
@@ -105,29 +110,31 @@ class CommandTban : public Command
                // Pass the user (instead of ServerInstance->FakeClient) to ModeHandler::Process() to
                // make it so that the user sets the mode themselves
                ServerInstance->Modes->Process(user, channel, NULL, setban);
-               if (ServerInstance->Modes->GetLastParse().empty())
+               if (ServerInstance->Modes->GetLastChangeList().empty())
                {
                        user->WriteNotice("Invalid ban mask");
                        return CMD_FAILURE;
                }
 
-               CUList tmp;
                T.mask = mask;
+               T.setter = user->nick;
                T.expire = expire + (IS_REMOTE(user) ? 5 : 0);
                T.chan = channel;
                TimedBanList.push_back(T);
 
-               const std::string addban = user->nick + " added a timed ban on " + mask + " lasting for " + ConvToStr(duration) + " seconds.";
+               const std::string message = InspIRCd::Format("Timed ban %s added by %s on %s lasting for %s.",
+                       mask.c_str(), user->nick.c_str(), channel->name.c_str(), InspIRCd::DurationString(duration).c_str());
                // If halfop is loaded, send notice to halfops and above, otherwise send to ops and above
                PrefixMode* mh = ServerInstance->Modes->FindPrefixMode('h');
                char pfxchar = (mh && mh->name == "halfop") ? mh->GetPrefix() : '@';
 
-               channel->WriteAllExcept(ServerInstance->FakeClient, true, pfxchar, tmp, "NOTICE %s :%s", channel->name.c_str(), addban.c_str());
-               ServerInstance->PI->SendChannelNotice(channel, pfxchar, addban);
+               ClientProtocol::Messages::Privmsg notice(ServerInstance->FakeClient, channel, message, MSG_NOTICE);
+               channel->Write(ServerInstance->GetRFCEvents().privmsg, notice, pfxchar);
+               ServerInstance->PI->SendChannelNotice(channel, pfxchar, message);
                return CMD_SUCCESS;
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                return ROUTE_BROADCAST;
        }
@@ -141,7 +148,7 @@ class BanWatcher : public ModeWatcher
        {
        }
 
-       void AfterMode(User* source, User* dest, Channel* chan, const std::string& banmask, bool adding)
+       void AfterMode(User* source, User* dest, Channel* chan, const std::string& banmask, bool adding) CXX11_OVERRIDE
        {
                if (adding)
                        return;
@@ -205,22 +212,22 @@ class ModuleTimedBans : public Module
 
                for (timedbans::iterator i = expired.begin(); i != expired.end(); i++)
                {
-                       std::string mask = i->mask;
+                       const std::string mask = i->mask;
                        Channel* cr = i->chan;
-                       {
-                               CUList empty;
-                               const std::string expiry = "*** Timed ban on " + cr->name + " expired.";
-                               // If halfop is loaded, send notice to halfops and above, otherwise send to ops and above
-                               PrefixMode* mh = ServerInstance->Modes->FindPrefixMode('h');
-                               char pfxchar = (mh && mh->name == "halfop") ? mh->GetPrefix() : '@';
-
-                               cr->WriteAllExcept(ServerInstance->FakeClient, true, pfxchar, empty, "NOTICE %s :%s", cr->name.c_str(), expiry.c_str());
-                               ServerInstance->PI->SendChannelNotice(cr, pfxchar, expiry);
-
-                               Modes::ChangeList setban;
-                               setban.push_remove(ServerInstance->Modes->FindMode('b', MODETYPE_CHANNEL), mask);
-                               ServerInstance->Modes->Process(ServerInstance->FakeClient, cr, NULL, setban);
-                       }
+
+                       const std::string message = InspIRCd::Format("Timed ban %s set by %s on %s has expired.",
+                               mask.c_str(), i->setter.c_str(), cr->name.c_str());
+                       // If halfop is loaded, send notice to halfops and above, otherwise send to ops and above
+                       PrefixMode* mh = ServerInstance->Modes->FindPrefixMode('h');
+                       char pfxchar = (mh && mh->name == "halfop") ? mh->GetPrefix() : '@';
+
+                       ClientProtocol::Messages::Privmsg notice(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, cr, message, MSG_NOTICE);
+                       cr->Write(ServerInstance->GetRFCEvents().privmsg, notice, pfxchar);
+                       ServerInstance->PI->SendChannelNotice(cr, pfxchar, message);
+
+                       Modes::ChangeList setban;
+                       setban.push_remove(ServerInstance->Modes->FindMode('b', MODETYPE_CHANNEL), mask);
+                       ServerInstance->Modes->Process(ServerInstance->FakeClient, cr, NULL, setban);
                }
        }
 
@@ -232,7 +239,7 @@ class ModuleTimedBans : public Module
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Adds timed bans", VF_COMMON | VF_VENDOR);
+               return Version("Provides the TBAN command, timed channel bans", VF_COMMON | VF_VENDOR);
        }
 };