#include "inspircd.h"
-
-/* $ModDesc: Provides channel history for a given number of lines */
+#include "modules/ircv3_servertime.h"
+#include "modules/ircv3_batch.h"
+#include "modules/server.h"
struct HistoryItem
{
time_t ts;
- std::string line;
- HistoryItem(const std::string& Line) : ts(ServerInstance->Time()), line(Line) {}
+ std::string text;
+ std::string sourcemask;
+
+ HistoryItem(User* source, const std::string& Text)
+ : ts(ServerInstance->Time())
+ , text(Text)
+ , sourcemask(source->GetFullHost())
+ {
+ }
};
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;
+
+ HistoryList(unsigned int len, unsigned int time)
+ : maxlen(len)
+ , maxtime(time)
+ {
+ }
};
-class HistoryMode : public ModeHandler
+class HistoryMode : public ParamMode<HistoryMode, SimpleExtItem<HistoryList> >
{
- bool IsValidDuration(const std::string& duration)
+ public:
+ unsigned int maxlines;
+ HistoryMode(Module* Creator)
+ : ParamMode<HistoryMode, SimpleExtItem<HistoryList> >(Creator, "history", 'H')
{
- for (std::string::const_iterator i = duration.begin(); i != duration.end(); ++i)
+ syntax = "<max-messages>:<max-duration>";
+ }
+
+ ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
+ {
+ std::string::size_type colon = parameter.find(':');
+ if (colon == std::string::npos)
{
- unsigned char c = *i;
- if (((c >= '0') && (c <= '9')) || (c == 's') || (c == 'S'))
- continue;
+ source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+ return MODEACTION_DENY;
+ }
- if (duration_multi[c] == 1)
- return false;
+ std::string duration(parameter, colon+1);
+ if ((IS_LOCAL(source)) && ((duration.length() > 10) || (!InspIRCd::IsValidDuration(duration))))
+ {
+ source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+ return MODEACTION_DENY;
}
- return true;
- }
- public:
- SimpleExtItem<HistoryList> ext;
- unsigned int maxlines;
- HistoryMode(Module* Creator) : ModeHandler(Creator, "history", 'H', PARAM_SETONLY, MODETYPE_CHANNEL),
- ext("history", Creator) { }
+ 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;
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
- {
- if (adding)
+ HistoryList* history = ext.get(channel);
+ if (history)
{
- 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 = InspIRCd::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));
+ // 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));
- }
+ history->maxlen = len;
+ history->maxtime = time;
}
else
{
- if (!channel->IsModeSet(this))
- return MODEACTION_DENY;
- ext.unset(channel);
+ 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 ModuleChanHistory
+ : public Module
+ , public ServerProtocol::BroadcastEventListener
{
+ private:
HistoryMode m;
bool sendnotice;
- public:
- ModuleChanHistory() : m(this)
+ UserModeReference botmode;
+ bool dobots;
+ IRCv3::Batch::CapReference batchcap;
+ IRCv3::Batch::API batchmanager;
+ IRCv3::Batch::Batch batch;
+ IRCv3::ServerTime::API servertimemanager;
+
+ void SendHistory(LocalUser* user, Channel* channel, HistoryList* list, time_t mintime)
{
+ if (batchmanager)
+ {
+ batchmanager->Start(batch);
+ batch.GetBatchStartMessage().PushParamRef(channel->name);
+ }
+
+ for(std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
+ {
+ const HistoryItem& item = *i;
+ if (item.ts >= mintime)
+ {
+ ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, item.sourcemask, channel, item.text);
+ if (servertimemanager)
+ servertimemanager->Set(msg, item.ts);
+ batch.AddToBatch(msg);
+ user->Send(ServerInstance->GetRFCEvents().privmsg, msg);
+ }
+ }
+
+ if (batchmanager)
+ batchmanager->End(batch);
}
- void init() CXX11_OVERRIDE
+ public:
+ ModuleChanHistory()
+ : ServerProtocol::BroadcastEventListener(this)
+ , m(this)
+ , botmode(this, "bot")
+ , batchcap(this)
+ , batchmanager(this)
+ , batch("chathistory")
+ , servertimemanager(this)
{
- ServerInstance->Modules->AddService(m);
- ServerInstance->Modules->AddService(m.ext);
-
- Implementation eventlist[] = { I_OnPostJoin, I_OnUserMessage, I_OnRehash };
- ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
- OnRehash(NULL);
}
- void OnRehash(User*) CXX11_OVERRIDE
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
- m.maxlines = tag->getInt("maxlines", 50);
+ m.maxlines = tag->getUInt("maxlines", 50, 1);
sendnotice = 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&, MessageType msgtype) CXX11_OVERRIDE
+ ModResult OnBroadcastMessage(Channel* channel, const Server* server) CXX11_OVERRIDE
{
- if ((target_type == TYPE_CHANNEL) && (status == 0) && (msgtype == MSG_PRIVMSG))
+ return channel->IsModeSet(m) ? 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))
{
- Channel* c = (Channel*)dest;
+ Channel* c = target.Get<Channel>();
HistoryList* list = m.ext.get(c);
if (list)
{
- const std::string line = ":" + user->GetFullHost() + " PRIVMSG " + c->name + " :" + text;
- list->lines.push_back(HistoryItem(line));
+ list->lines.push_back(HistoryItem(user, details.text));
if (list->lines.size() > list->maxlen)
list->lines.pop_front();
}
void OnPostJoin(Membership* memb) CXX11_OVERRIDE
{
- if (IS_REMOTE(memb->user))
+ LocalUser* localuser = IS_LOCAL(memb->user);
+ if (!localuser)
+ return;
+
+ if (memb->user->IsModeSet(botmode) && !dobots)
return;
HistoryList* list = m.ext.get(memb->chan);
if (!list)
return;
- time_t mintime = 0;
- if (list->maxtime)
- mintime = ServerInstance->Time() - list->maxtime;
- if (sendnotice)
+ if ((sendnotice) && (!batchcap.get(localuser)))
{
- memb->user->WriteNotice("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history spanning up to " + ConvToStr(list->maxtime) + " seconds");
+ 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));
+ memb->WriteNotice(message);
}
- for(std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
- {
- if (i->ts >= mintime)
- memb->user->Write(i->line);
- }
+ time_t mintime = 0;
+ if (list->maxtime)
+ mintime = ServerInstance->Time() - list->maxtime;
+
+ SendHistory(localuser, memb->chan, list, mintime);
}
Version GetVersion() CXX11_OVERRIDE
{
- return Version("Provides channel history replayed on join", VF_VENDOR);
+ return Version("Provides channel mode +H, allows for the channel message history to be replayed on join", VF_VENDOR);
}
};