/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2017-2021 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
#include "inspircd.h"
+#include "modules/ircv3_servertime.h"
+#include "modules/ircv3_batch.h"
+#include "modules/server.h"
-/* $ModDesc: Provides channel history for a given number of lines */
+typedef insp::flat_map<std::string, std::string> HistoryTagMap;
struct HistoryItem
{
time_t ts;
- std::string line;
- HistoryItem(const std::string& Line) : ts(ServerInstance->Time()), line(Line) {}
+ std::string text;
+ MessageType type;
+ HistoryTagMap tags;
+ std::string sourcemask;
+
+ HistoryItem(User* source, const MessageDetails& details)
+ : ts(ServerInstance->Time())
+ , text(details.text)
+ , type(details.type)
+ , sourcemask(source->GetFullHost())
+ {
+ 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;
+ }
};
struct HistoryList
{
std::deque<HistoryItem> lines;
- unsigned int maxlen, maxtime;
- HistoryList(unsigned int len, unsigned int time) : maxlen(len), maxtime(time) {}
-};
+ unsigned int maxlen;
+ unsigned int maxtime;
-class HistoryMode : public ModeHandler
-{
- bool IsValidDuration(const std::string duration)
+ HistoryList(unsigned int len, unsigned int time)
+ : maxlen(len)
+ , maxtime(time)
{
- for (std::string::const_iterator i = duration.begin(); i != duration.end(); ++i)
- {
- unsigned char c = *i;
- if (((c >= '0') && (c <= '9')) || (c == 's') || (c != 'S'))
- continue;
+ }
- if (duration_multi[c] == 1)
- return false;
+ size_t Prune()
+ {
+ // Prune expired entries from the list.
+ if (maxtime)
+ {
+ time_t mintime = ServerInstance->Time() - maxtime;
+ while (!lines.empty() && lines.front().ts < mintime)
+ lines.pop_front();
}
- return true;
+ return lines.size();
}
+};
+class HistoryMode : public ParamMode<HistoryMode, SimpleExtItem<HistoryList> >
+{
public:
- SimpleExtItem<HistoryList> ext;
unsigned int maxlines;
- HistoryMode(Module* Creator) : ModeHandler(Creator, "history", 'H', PARAM_SETONLY, MODETYPE_CHANNEL),
- ext("history", Creator) { }
+ HistoryMode(Module* Creator)
+ : ParamMode<HistoryMode, SimpleExtItem<HistoryList> >(Creator, "history", 'H')
+ {
+ syntax = "<max-messages>:<max-duration>";
+ }
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
{
- if (adding)
+ std::string::size_type colon = parameter.find(':');
+ if (colon == std::string::npos)
+ {
+ source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+ return MODEACTION_DENY;
+ }
+
+ std::string duration(parameter, colon+1);
+ if ((IS_LOCAL(source)) && ((duration.length() > 10) || (!InspIRCd::IsValidDuration(duration))))
{
- std::string::size_type colon = parameter.find(':');
- if (colon == std::string::npos)
- return MODEACTION_DENY;
-
- std::string duration = parameter.substr(colon+1);
- if ((IS_LOCAL(source)) && ((duration.length() > 10) || (!IsValidDuration(duration))))
- return MODEACTION_DENY;
-
- unsigned int len = ConvToInt(parameter.substr(0, colon));
- int time = ServerInstance->Duration(duration);
- if (len == 0 || time < 0)
- return MODEACTION_DENY;
- if (len > maxlines && IS_LOCAL(source))
- return MODEACTION_DENY;
- if (len > maxlines)
- len = maxlines;
- if (parameter == channel->GetModeParameter(this))
- return MODEACTION_DENY;
-
- HistoryList* history = ext.get(channel);
- if (history)
- {
- // Shrink the list if the new line number limit is lower than the old one
- if (len < history->lines.size())
- history->lines.erase(history->lines.begin(), history->lines.begin() + (history->lines.size() - len));
-
- history->maxlen = len;
- history->maxtime = time;
- }
- else
- {
- ext.set(channel, new HistoryList(len, time));
- }
- channel->SetModeParam('H', parameter);
+ source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+ return MODEACTION_DENY;
+ }
+
+ unsigned int len = ConvToNum<unsigned int>(parameter.substr(0, colon));
+ unsigned long time;
+ if (!InspIRCd::Duration(duration, time) || len == 0 || (len > maxlines && IS_LOCAL(source)))
+ {
+ source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+ return MODEACTION_DENY;
+ }
+ if (len > maxlines)
+ len = maxlines;
+
+ HistoryList* history = ext.get(channel);
+ if (history)
+ {
+ // Shrink the list if the new line number limit is lower than the old one
+ if (len < history->lines.size())
+ history->lines.erase(history->lines.begin(), history->lines.begin() + (history->lines.size() - len));
+
+ history->maxlen = len;
+ history->maxtime = time;
+ history->Prune();
}
else
{
- if (!channel->IsModeSet('H'))
- return MODEACTION_DENY;
- ext.unset(channel);
- channel->SetModeParam('H', "");
+ ext.set(channel, new HistoryList(len, time));
}
return MODEACTION_ALLOW;
}
+
+ void SerializeParam(Channel* chan, const HistoryList* history, std::string& out)
+ {
+ out.append(ConvToStr(history->maxlen));
+ out.append(":");
+ out.append(InspIRCd::DurationString(history->maxtime));
+ }
};
-class ModuleChanHistory : public Module
+class NoHistoryMode : public SimpleUserModeHandler
{
- HistoryMode m;
- bool sendnotice;
- public:
- ModuleChanHistory() : m(this)
+public:
+ NoHistoryMode(Module* Creator)
+ : SimpleUserModeHandler(Creator, "nohistory", 'N')
{
+ if (!ServerInstance->Config->ConfValue("chanhistory")->getBool("enableumode"))
+ DisableAutoRegister();
}
+};
- void init()
+class ModuleChanHistory
+ : public Module
+ , public ServerProtocol::BroadcastEventListener
+{
+ private:
+ HistoryMode historymode;
+ NoHistoryMode nohistorymode;
+ bool prefixmsg;
+ UserModeReference botmode;
+ bool dobots;
+ IRCv3::Batch::CapReference batchcap;
+ IRCv3::Batch::API batchmanager;
+ IRCv3::Batch::Batch batch;
+ IRCv3::ServerTime::API servertimemanager;
+ ClientProtocol::MessageTagEvent tagevent;
+
+ void AddTag(ClientProtocol::Message& msg, const std::string& tagkey, std::string& tagval)
{
- ServerInstance->Modules->AddService(m);
+ const Events::ModuleEventProvider::SubscriberList& list = tagevent.GetSubscribers();
+ for (Events::ModuleEventProvider::SubscriberList::const_iterator i = list.begin(); i != list.end(); ++i)
+ {
+ ClientProtocol::MessageTagProvider* const tagprov = static_cast<ClientProtocol::MessageTagProvider*>(*i);
+ const ModResult res = tagprov->OnProcessTag(ServerInstance->FakeClient, tagkey, tagval);
+ if (res == MOD_RES_ALLOW)
+ msg.AddTag(tagkey, tagprov, tagval);
+ else if (res == MOD_RES_DENY)
+ break;
+ }
+ }
+
+ void SendHistory(LocalUser* user, Channel* channel, HistoryList* list)
+ {
+ if (batchmanager)
+ {
+ batchmanager->Start(batch);
+ batch.GetBatchStartMessage().PushParamRef(channel->name);
+ }
- Implementation eventlist[] = { I_OnPostJoin, I_OnUserMessage, I_OnRehash };
- ServerInstance->Modules->Attach(eventlist, this, 3);
- OnRehash(NULL);
+ for (std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
+ {
+ HistoryItem& item = *i;
+ 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)
+ servertimemanager->Set(msg, item.ts);
+ batch.AddToBatch(msg);
+ user->Send(ServerInstance->GetRFCEvents().privmsg, msg);
+ }
+
+ if (batchmanager)
+ batchmanager->End(batch);
}
- void OnRehash(User*)
+ public:
+ ModuleChanHistory()
+ : ServerProtocol::BroadcastEventListener(this)
+ , historymode(this)
+ , nohistorymode(this)
+ , botmode(this, "bot")
+ , batchcap(this)
+ , batchmanager(this)
+ , batch("chathistory")
+ , servertimemanager(this)
+ , tagevent(this)
+ {
+ }
+
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
- m.maxlines = tag->getInt("maxlines", 50);
- 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);
}
- void OnUserMessage(User* user,void* dest,int target_type, const std::string &text, char status, const CUList&)
+ ModResult OnBroadcastMessage(Channel* channel, const Server* server) CXX11_OVERRIDE
{
- if (target_type == TYPE_CHANNEL && status == 0)
- {
- Channel* c = (Channel*)dest;
- HistoryList* list = m.ext.get(c);
- if (list)
- {
- char buf[MAXBUF];
- snprintf(buf, MAXBUF, ":%s PRIVMSG %s :%s",
- user->GetFullHost().c_str(), c->name.c_str(), text.c_str());
- list->lines.push_back(HistoryItem(buf));
- if (list->lines.size() > list->maxlen)
- list->lines.pop_front();
- }
- }
+ return channel->IsModeSet(historymode) ? MOD_RES_ALLOW : MOD_RES_PASSTHRU;
}
- void OnPostJoin(Membership* memb)
+ void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
{
- if (IS_REMOTE(memb->user))
+ if (target.type != MessageTarget::TYPE_CHANNEL || target.status)
return;
- HistoryList* list = m.ext.get(memb->chan);
+ std::string ctcpname;
+ if (details.IsCTCP(ctcpname) && !irc::equals(ctcpname, "ACTION"))
+ return;
+
+ HistoryList* list = historymode.ext.get(target.Get<Channel>());
if (!list)
return;
- time_t mintime = 0;
- if (list->maxtime)
- mintime = ServerInstance->Time() - list->maxtime;
- if (sendnotice)
- {
- memb->user->WriteServ("NOTICE %s :Replaying up to %d lines of pre-join history spanning up to %d seconds",
- memb->chan->name.c_str(), list->maxlen, list->maxtime);
- }
+ list->lines.push_back(HistoryItem(user, details));
+ if (list->lines.size() > list->maxlen)
+ list->lines.pop_front();
+ }
+
+ void OnPostJoin(Membership* memb) CXX11_OVERRIDE
+ {
+ LocalUser* localuser = IS_LOCAL(memb->user);
+ if (!localuser)
+ return;
- for(std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
+ if (memb->user->IsModeSet(botmode) && !dobots)
+ return;
+
+ if (memb->user->IsModeSet(nohistorymode))
+ return;
+
+ HistoryList* list = historymode.ext.get(memb->chan);
+ if (!list || !list->Prune())
+ return;
+
+ if ((prefixmsg) && (!batchcap.get(localuser)))
{
- if (i->ts >= mintime)
- memb->user->Write(i->line);
+ std::string message("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history");
+ if (list->maxtime > 0)
+ message.append(" from the last " + InspIRCd::DurationString(list->maxtime));
+ memb->WriteNotice(message);
}
+
+ SendHistory(localuser, memb->chan, list);
}
- Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version("Provides channel history 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);
}
};
projects / user / henk / code / inspircd.git / blobdiff