src/modules/m_chanhistory.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #include "inspircd.h"
  21
  22 /* $ModDesc: Provides channel history for a given number of lines */
  23
  24 struct HistoryItem
  25 {
  26         time_t ts;
  27         std::string line;
  28         HistoryItem(const std::string& Line) : ts(ServerInstance->Time()), line(Line) {}
  29 };
  30
  31 struct HistoryList
  32 {
  33         std::deque<HistoryItem> lines;
  34         unsigned int maxlen, maxtime;
  35         HistoryList(unsigned int len, unsigned int time) : maxlen(len), maxtime(time) {}
  36 };
  37
  38 class HistoryMode : public ModeHandler
  39 {
  40         bool IsValidDuration(const std::string& duration)
  41         {
  42                 for (std::string::const_iterator i = duration.begin(); i != duration.end(); ++i)
  43                 {
  44                         unsigned char c = *i;
  45                         if (((c >= '0') && (c <= '9')) || (c == 's') || (c == 'S'))
  46                                 continue;
  47
  48                         if (duration_multi[c] == 1)
  49                                 return false;
  50                 }
  51                 return true;
  52         }
  53
  54  public:
  55         SimpleExtItem<HistoryList> ext;
  56         unsigned int maxlines;
  57         HistoryMode(Module* Creator) : ModeHandler(Creator, "history", 'H', PARAM_SETONLY, MODETYPE_CHANNEL),
  58                 ext("history", Creator) { }
  59
  60         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  61         {
  62                 if (adding)
  63                 {
  64                         std::string::size_type colon = parameter.find(':');
  65                         if (colon == std::string::npos)
  66                                 return MODEACTION_DENY;
  67
  68                         std::string duration = parameter.substr(colon+1);
  69                         if ((IS_LOCAL(source)) && ((duration.length() > 10) || (!IsValidDuration(duration))))
  70                                 return MODEACTION_DENY;
  71
  72                         unsigned int len = ConvToInt(parameter.substr(0, colon));
  73                         int time = InspIRCd::Duration(duration);
  74                         if (len == 0 || time < 0)
  75                                 return MODEACTION_DENY;
  76                         if (len > maxlines && IS_LOCAL(source))
  77                                 return MODEACTION_DENY;
  78                         if (len > maxlines)
  79                                 len = maxlines;
  80                         if (parameter == channel->GetModeParameter(this))
  81                                 return MODEACTION_DENY;
  82
  83                         HistoryList* history = ext.get(channel);
  84                         if (history)
  85                         {
  86                                 // Shrink the list if the new line number limit is lower than the old one
  87                                 if (len < history->lines.size())
  88                                         history->lines.erase(history->lines.begin(), history->lines.begin() + (history->lines.size() - len));
  89
  90                                 history->maxlen = len;
  91                                 history->maxtime = time;
  92                         }
  93                         else
  94                         {
  95                                 ext.set(channel, new HistoryList(len, time));
  96                         }
  97                         channel->SetModeParam('H', parameter);
  98                 }
  99                 else
 100                 {
 101                         if (!channel->IsModeSet('H'))
 102                                 return MODEACTION_DENY;
 103                         ext.unset(channel);
 104                         channel->SetModeParam('H', "");
 105                 }
 106                 return MODEACTION_ALLOW;
 107         }
 108 };
 109
 110 class ModuleChanHistory : public Module
 111 {
 112         HistoryMode m;
 113         bool sendnotice;
 114  public:
 115         ModuleChanHistory() : m(this)
 116         {
 117         }
 118
 119         void init() CXX11_OVERRIDE
 120         {
 121                 ServerInstance->Modules->AddService(m);
 122                 ServerInstance->Modules->AddService(m.ext);
 123
 124                 Implementation eventlist[] = { I_OnPostJoin, I_OnUserMessage, I_OnRehash };
 125                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 126                 OnRehash(NULL);
 127         }
 128
 129         void OnRehash(User*) CXX11_OVERRIDE
 130         {
 131                 ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
 132                 m.maxlines = tag->getInt("maxlines", 50);
 133                 sendnotice = tag->getBool("notice", true);
 134         }
 135
 136         void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList&, MessageType msgtype) CXX11_OVERRIDE
 137         {
 138                 if ((target_type == TYPE_CHANNEL) && (status == 0) && (msgtype == MSG_PRIVMSG))
 139                 {
 140                         Channel* c = (Channel*)dest;
 141                         HistoryList* list = m.ext.get(c);
 142                         if (list)
 143                         {
 144                                 const std::string line = ":" + user->GetFullHost() + " PRIVMSG " + c->name + " :" + text;
 145                                 list->lines.push_back(HistoryItem(line));
 146                                 if (list->lines.size() > list->maxlen)
 147                                         list->lines.pop_front();
 148                         }
 149                 }
 150         }
 151
 152         void OnPostJoin(Membership* memb) CXX11_OVERRIDE
 153         {
 154                 if (IS_REMOTE(memb->user))
 155                         return;
 156
 157                 HistoryList* list = m.ext.get(memb->chan);
 158                 if (!list)
 159                         return;
 160                 time_t mintime = 0;
 161                 if (list->maxtime)
 162                         mintime = ServerInstance->Time() - list->maxtime;
 163
 164                 if (sendnotice)
 165                 {
 166                         memb->user->WriteNotice("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history spanning up to " + ConvToStr(list->maxtime) + " seconds");
 167                 }
 168
 169                 for(std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
 170                 {
 171                         if (i->ts >= mintime)
 172                                 memb->user->Write(i->line);
 173                 }
 174         }
 175
 176         Version GetVersion() CXX11_OVERRIDE
 177         {
 178                 return Version("Provides channel history replayed on join", VF_VENDOR);
 179         }
 180 };
 181
 182 MODULE_INIT(ModuleChanHistory)