X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_chanhistory.cpp;h=25110b4954f49be8ea3155b57e7a9493c8fa713f;hb=5860247c3bf664daac1234f47f68ed30402fe13d;hp=cfc418cb0b69a2d2cdd093a1b4f81814d8c3e4b0;hpb=e8f873a96c7cd41b52e25131b0e938ce28ebc1cb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_chanhistory.cpp b/src/modules/m_chanhistory.cpp index cfc418cb0..25110b495 100644 --- a/src/modules/m_chanhistory.cpp +++ b/src/modules/m_chanhistory.cpp @@ -1,138 +1,276 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2010 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2018 linuxdaemon + * Copyright (C) 2013, 2017-2020 Sadie Powell + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012-2015, 2018 Attila Molnar + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2010 Craig Edwards + * Copyright (C) 2009-2010 Daniel De Graaf * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + #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 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 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 > { public: - SimpleExtItem ext; - int maxlines; - HistoryMode(Module* Creator) : ModeHandler(Creator, "history", 'H', PARAM_SETONLY, MODETYPE_CHANNEL), - ext("history", Creator) { } + unsigned int maxlines; + HistoryMode(Module* Creator) + : ParamMode >(Creator, "history", 'H') + { + syntax = ":"; + } - 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) { - std::string::size_type colon = parameter.find(':'); - if (colon == std::string::npos) - return MODEACTION_DENY; - int len = atoi(parameter.substr(0, colon).c_str()); - int time = ServerInstance->Duration(parameter.substr(colon+1)); - 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; - ext.set(channel, new HistoryList(len, time)); - channel->SetModeParam('H', parameter); + 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)))) + { + source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter)); + return MODEACTION_DENY; + } + + unsigned int len = ConvToNum(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; } 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; - public: - ModuleChanHistory() : m(this) +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 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) { + 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(*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 init() + void SendHistory(LocalUser* user, Channel* channel, HistoryList* list, time_t mintime) { - ServerInstance->Modules->AddService(m); + 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::iterator i = list->lines.begin(); i != list->lines.end(); ++i) + { + HistoryItem& item = *i; + if (item.ts >= mintime) + { + 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) { - m.maxlines = ServerInstance->Config->ConfValue("chanhistory")->getInt("maxlines", 50); } - ~ModuleChanHistory() + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - ServerInstance->Modes->DelMode(&m); + ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory"); + 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 { - HistoryList* list = m.ext.get(memb->chan); + if (target.type != MessageTarget::TYPE_CHANNEL || target.status) + return; + + std::string ctcpname; + if (details.IsCTCP(ctcpname) && !irc::equals(ctcpname, "ACTION")) + return; + + HistoryList* list = historymode.ext.get(target.Get()); if (!list) return; + + 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; + + if (memb->user->IsModeSet(botmode) && !dobots) + return; + + if (memb->user->IsModeSet(nohistorymode)) + return; + + HistoryList* list = historymode.ext.get(memb->chan); + if (!list) + return; + + 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(" from the last " + InspIRCd::DurationString(list->maxtime)); + memb->WriteNotice(message); + } + time_t mintime = 0; if (list->maxtime) mintime = ServerInstance->Time() - list->maxtime; - 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); - for(std::deque::iterator i = list->lines.begin(); i != list->lines.end(); ++i) - { - if (i->ts >= mintime) - memb->user->Write(i->line); - } + + SendHistory(localuser, memb->chan, list, mintime); } - 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); } };