]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_chanhistory.cpp
Add support for the IRCv3 server-time specification.
[user/henk/code/inspircd.git] / src / modules / m_chanhistory.cpp
index d987fee1e5e4bbf22373c655587b01c55d654203..57db002a894c6d71bb69ac4cc7ff9a5e189cc27b 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *
- * 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 <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
 
-/* $ModDesc: Provides channel history for a given number of lines */
+#include "inspircd.h"
+#include "modules/ircv3_servertime.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) {}
+       std::string param;
+
+       HistoryList(unsigned int len, unsigned int time, const std::string& oparam)
+               : maxlen(len), maxtime(time), param(oparam) { }
 };
 
-class HistoryMode : public ModeHandler
+class HistoryMode : public ParamMode<HistoryMode, SimpleExtItem<HistoryList> >
 {
+       bool IsValidDuration(const std::string& duration)
+       {
+               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;
+               }
+               return true;
+       }
+
  public:
-       SimpleExtItem<HistoryList> ext;
-       HistoryMode(Module* Creator) : ModeHandler(Creator, "history", 'H', PARAM_SETONLY, MODETYPE_CHANNEL),
-               ext("history", Creator) { }
+       unsigned int maxlines;
+       HistoryMode(Module* Creator)
+               : ParamMode<HistoryMode, SimpleExtItem<HistoryList> >(Creator, "history", 'H')
+       {
+       }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, 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) || (!IsValidDuration(duration))))
+               {
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+                       return MODEACTION_DENY;
+               }
+
+               unsigned int len = ConvToInt(parameter.substr(0, colon));
+               unsigned int time = InspIRCd::Duration(duration);
+               if (len == 0 || (len > maxlines && IS_LOCAL(source)))
                {
-                       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 || len > 50)
-                               return MODEACTION_DENY;
-                       ext.set(channel, new HistoryList(len, time));
-                       channel->SetModeParam('H', parameter);
+                       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->param = parameter;
                }
                else
                {
-                       ext.unset(channel);
-                       channel->SetModeParam('H', "");
+                       ext.set(channel, new HistoryList(len, time, parameter));
                }
                return MODEACTION_ALLOW;
        }
+
+       void SerializeParam(Channel* chan, const HistoryList* history, std::string& out)
+       {
+               out.append(history->param);
+       }
 };
 
 class ModuleChanHistory : public Module
 {
        HistoryMode m;
+       bool sendnotice;
+       UserModeReference botmode;
+       bool dobots;
+       IRCv3::ServerTime::API servertimemanager;
+
  public:
-       ModuleChanHistory() : m(this)
+       ModuleChanHistory()
+               : m(this)
+               , botmode(this, "bot")
+               , servertimemanager(this)
        {
-               if (!ServerInstance->Modes->AddMode(&m))
-                       throw ModuleException("Could not add new modes!");
-
-               Implementation eventlist[] = { I_OnUserJoin, I_OnUserMessage };
-               ServerInstance->Modules->Attach(eventlist, this, 2);
        }
 
-       ~ModuleChanHistory()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ServerInstance->Modes->DelMode(&m);
+               ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
+               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&)
+       void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_CHANNEL && status == 0)
+               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)
                        {
-                               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));
+                               list->lines.push_back(HistoryItem(user, details.text));
                                if (list->lines.size() > list->maxlen)
                                        list->lines.pop_front();
                        }
                }
        }
 
-       void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list)
+       void OnPostJoin(Membership* memb) CXX11_OVERRIDE
        {
+               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;
-               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);
+
+               if (sendnotice)
+               {
+                       std::string message("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history");
+                       if (list->maxtime > 0)
+                               message.append(" spanning up to " + ConvToStr(list->maxtime) + " seconds");
+                       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);
+                       const HistoryItem& item = *i;
+                       if (item.ts >= mintime)
+                       {
+                               ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, item.sourcemask, memb->chan, item.text);
+                               if (servertimemanager)
+                                       servertimemanager->Set(msg, item.ts);
+                               localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
+                       }
                }
        }
 
-       Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides channel history replayed on join", VF_COMMON | VF_VENDOR);
+               return Version("Provides channel history replayed on join", VF_VENDOR);
        }
 };