Add a user mode which allows disabling receiving channel history.

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

diff --git a/src/modules/m_chanhistory.cpp b/src/modules/m_chanhistory.cpp
index 8c73d4cd68dccabd2d85a63c763c3b7d56443a8b..4bd230a7c649c1278717696dcb84feb4efc6d7df 100644 (file)
--- a/src/modules/m_chanhistory.cpp
+++ b/src/modules/m_chanhistory.cpp
@@ -1,6 +1,12 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
+ *   Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -28,16 +34,18 @@ struct HistoryItem
 {
        time_t ts;
        std::string text;
+       MessageType type;
        HistoryTagMap tags;
        std::string sourcemask;
 
-       HistoryItem(User* source, const std::string& Text, const ClientProtocol::TagMap& Tags)
+       HistoryItem(User* source, const MessageDetails& details)
                : ts(ServerInstance->Time())
-               , text(Text)
+               , text(details.text)
+               , type(details.type)
                , sourcemask(source->GetFullHost())
        {
-               tags.reserve(Tags.size());
-               for (ClientProtocol::TagMap::const_iterator iter = Tags.begin(); iter != Tags.end(); ++iter)
+               tags.reserve(details.tags_out.size());
+               for (ClientProtocol::TagMap::const_iterator iter = details.tags_out.begin(); iter != details.tags_out.end(); ++iter)
                        tags[iter->first] = iter->second.value;
        }
 };
@@ -116,13 +124,25 @@ class HistoryMode : public ParamMode<HistoryMode, SimpleExtItem<HistoryList> >
        }
 };
 
+class NoHistoryMode : public SimpleUserModeHandler
+{
+public:
+       NoHistoryMode(Module* Creator)
+               : SimpleUserModeHandler(Creator, "nohistory", 'N')
+       {
+               if (!ServerInstance->Config->ConfValue("chanhistory")->getBool("enableumode"))
+                       DisableAutoRegister();
+       }
+};
+
 class ModuleChanHistory
        : public Module
        , public ServerProtocol::BroadcastEventListener
 {
  private:
-       HistoryMode m;
-       bool sendnotice;
+       HistoryMode historymode;
+       NoHistoryMode nohistorymode;
+       bool prefixmsg;
        UserModeReference botmode;
        bool dobots;
        IRCv3::Batch::CapReference batchcap;
@@ -158,7 +178,7 @@ class ModuleChanHistory
                        HistoryItem& item = *i;
                        if (item.ts >= mintime)
                        {
-                               ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, item.sourcemask, channel, item.text);
+                               ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, item.sourcemask, channel, item.text, item.type);
                                for (HistoryTagMap::iterator iter = item.tags.begin(); iter != item.tags.end(); ++iter)
                                        AddTag(msg, iter->first, iter->second);
                                if (servertimemanager)
@@ -175,7 +195,8 @@ class ModuleChanHistory
  public:
        ModuleChanHistory()
                : ServerProtocol::BroadcastEventListener(this)
-               , m(this)
+               , historymode(this)
+               , nohistorymode(this)
                , botmode(this, "bot")
                , batchcap(this)
                , batchmanager(this)
@@ -188,25 +209,26 @@ class ModuleChanHistory
        void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
                ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
-               m.maxlines = tag->getUInt("maxlines", 50, 1);
-               sendnotice = tag->getBool("notice", true);
+               historymode.maxlines = tag->getUInt("maxlines", 50, 1);
+               prefixmsg = tag->getBool("prefixmsg", tag->getBool("notice", true));
                dobots = tag->getBool("bots", true);
        }
 
        ModResult OnBroadcastMessage(Channel* channel, const Server* server) CXX11_OVERRIDE
        {
-               return channel->IsModeSet(m) ? MOD_RES_ALLOW : MOD_RES_PASSTHRU;
+               return channel->IsModeSet(historymode) ? MOD_RES_ALLOW : MOD_RES_PASSTHRU;
        }
 
        void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
        {
-               if ((target.type == MessageTarget::TYPE_CHANNEL) && (target.status == 0) && (details.type == MSG_PRIVMSG))
+               std::string ctcpname;
+               if ((target.type == MessageTarget::TYPE_CHANNEL) && (target.status == 0) && (!details.IsCTCP(ctcpname) || irc::equals(ctcpname, "ACTION")))
                {
                        Channel* c = target.Get<Channel>();
-                       HistoryList* list = m.ext.get(c);
+                       HistoryList* list = historymode.ext.get(c);
                        if (list)
                        {
-                               list->lines.push_back(HistoryItem(user, details.text, details.tags_out));
+                               list->lines.push_back(HistoryItem(user, details));
                                if (list->lines.size() > list->maxlen)
                                        list->lines.pop_front();
                        }
@@ -222,15 +244,18 @@ class ModuleChanHistory
                if (memb->user->IsModeSet(botmode) && !dobots)
                        return;
 
-               HistoryList* list = m.ext.get(memb->chan);
+               if (memb->user->IsModeSet(nohistorymode))
+                       return;
+
+               HistoryList* list = historymode.ext.get(memb->chan);
                if (!list)
                        return;
 
-               if ((sendnotice) && (!batchcap.get(localuser)))
+               if ((prefixmsg) && (!batchcap.get(localuser)))
                {
                        std::string message("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history");
                        if (list->maxtime > 0)
-                               message.append(" spanning up to " + InspIRCd::DurationString(list->maxtime));
+                               message.append(" from the last " + InspIRCd::DurationString(list->maxtime));
                        memb->WriteNotice(message);
                }
 
@@ -243,7 +268,7 @@ class ModuleChanHistory
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides channel mode +H, allows for the channel message history to be replayed on join", VF_VENDOR);
+               return Version("Adds channel mode H (history) which allows message history to be viewed on joining the channel.", VF_VENDOR);
        }
 };