src/listmode.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 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 #include "inspircd.h"
  20 #include "listmode.h"
  21
  22 ListModeBase::ListModeBase(Module* Creator, const std::string& Name, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag)
  23         : ModeHandler(Creator, Name, modechar, PARAM_ALWAYS, MODETYPE_CHANNEL),
  24         listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy),
  25         configtag(ctag), extItem("listbase_mode_" + name + "_list", Creator)
  26 {
  27         list = true;
  28 }
  29
  30 void ListModeBase::DisplayList(User* user, Channel* channel)
  31 {
  32         ChanData* cd = extItem.get(channel);
  33         if (cd)
  34         {
  35                 for (ModeList::reverse_iterator it = cd->list.rbegin(); it != cd->list.rend(); ++it)
  36                 {
  37                         user->WriteNumeric(listnumeric, "%s %s %s %s %lu", user->nick.c_str(), channel->name.c_str(), it->mask.c_str(), (!it->setter.empty() ? it->setter.c_str() : ServerInstance->Config->ServerName.c_str()), (unsigned long) it->time);
  38                 }
  39         }
  40         user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
  41 }
  42
  43 void ListModeBase::DisplayEmptyList(User* user, Channel* channel)
  44 {
  45         user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
  46 }
  47
  48 void ListModeBase::RemoveMode(Channel* channel, irc::modestacker& stack)
  49 {
  50         ChanData* cd = extItem.get(channel);
  51         if (cd)
  52         {
  53                 for (ModeList::iterator it = cd->list.begin(); it != cd->list.end(); it++)
  54                 {
  55                         stack.Push(this->GetModeChar(), it->mask);
  56                 }
  57         }
  58 }
  59
  60 void ListModeBase::DoRehash()
  61 {
  62         ConfigTagList tags = ServerInstance->Config->ConfTags(configtag);
  63
  64         limitlist oldlimits = chanlimits;
  65         chanlimits.clear();
  66
  67         for (ConfigIter i = tags.first; i != tags.second; i++)
  68         {
  69                 // For each <banlist> tag
  70                 ConfigTag* c = i->second;
  71                 ListLimit limit(c->getString("chan"), c->getInt("limit"));
  72
  73                 if (limit.mask.size() && limit.limit > 0)
  74                         chanlimits.push_back(limit);
  75         }
  76
  77         if (chanlimits.empty())
  78                 chanlimits.push_back(ListLimit("*", 64));
  79
  80         // Most of the time our settings are unchanged, so we can avoid iterating the chanlist
  81         if (oldlimits == chanlimits)
  82                 return;
  83
  84         for (chan_hash::const_iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); ++i)
  85         {
  86                 ChanData* cd = extItem.get(i->second);
  87                 if (cd)
  88                         cd->maxitems = -1;
  89         }
  90 }
  91
  92 void ListModeBase::DoImplements(Module* m)
  93 {
  94         ServerInstance->Modules->AddService(extItem);
  95         this->DoRehash();
  96         Implementation eventlist[] = { I_OnSyncChannel, I_OnRehash };
  97         ServerInstance->Modules->Attach(eventlist, m, sizeof(eventlist)/sizeof(Implementation));
  98 }
  99
 100 unsigned int ListModeBase::FindLimit(const std::string& channame)
 101 {
 102         for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); ++it)
 103         {
 104                 if (InspIRCd::Match(channame, it->mask))
 105                 {
 106                         // We have a pattern matching the channel
 107                         return it->limit;
 108                 }
 109         }
 110         return 64;
 111 }
 112
 113 unsigned int ListModeBase::GetLimitInternal(const std::string& channame, ChanData* cd)
 114 {
 115         if (cd->maxitems < 0)
 116                 cd->maxitems = FindLimit(channame);
 117         return cd->maxitems;
 118 }
 119
 120 unsigned int ListModeBase::GetLimit(Channel* channel)
 121 {
 122         ChanData* cd = extItem.get(channel);
 123         if (!cd) // just find the limit
 124                 return FindLimit(channel->name);
 125
 126         return GetLimitInternal(channel->name, cd);
 127 }
 128
 129 ModeAction ListModeBase::OnModeChange(User* source, User*, Channel* channel, std::string &parameter, bool adding)
 130 {
 131         // Try and grab the list
 132         ChanData* cd = extItem.get(channel);
 133
 134         if (adding)
 135         {
 136                 if (tidy)
 137                         ModeParser::CleanMask(parameter);
 138
 139                 if (parameter.length() > 250)
 140                         return MODEACTION_DENY;
 141
 142                 // If there was no list
 143                 if (!cd)
 144                 {
 145                         // Make one
 146                         cd = new ChanData;
 147                         extItem.set(channel, cd);
 148                 }
 149
 150                 // Check if the item already exists in the list
 151                 for (ModeList::iterator it = cd->list.begin(); it != cd->list.end(); it++)
 152                 {
 153                         if (parameter == it->mask)
 154                         {
 155                                 /* Give a subclass a chance to error about this */
 156                                 TellAlreadyOnList(source, channel, parameter);
 157
 158                                 // it does, deny the change
 159                                 return MODEACTION_DENY;
 160                         }
 161                 }
 162
 163                 if ((IS_LOCAL(source)) && (cd->list.size() >= GetLimitInternal(channel->name, cd)))
 164                 {
 165                         /* List is full, give subclass a chance to send a custom message */
 166                         TellListTooLong(source, channel, parameter);
 167                         parameter.clear();
 168                         return MODEACTION_DENY;
 169                 }
 170
 171                 /* Ok, it *could* be allowed, now give someone subclassing us
 172                  * a chance to validate the parameter.
 173                  * The param is passed by reference, so they can both modify it
 174                  * and tell us if we allow it or not.
 175                  *
 176                  * eg, the subclass could:
 177                  * 1) allow
 178                  * 2) 'fix' parameter and then allow
 179                  * 3) deny
 180                  */
 181                 if (ValidateParam(source, channel, parameter))
 182                 {
 183                         // And now add the mask onto the list...
 184                         cd->list.push_back(ListItem(parameter, source->nick, ServerInstance->Time()));
 185                         return MODEACTION_ALLOW;
 186                 }
 187                 else
 188                 {
 189                         /* If they deny it they have the job of giving an error message */
 190                         return MODEACTION_DENY;
 191                 }
 192         }
 193         else
 194         {
 195                 // We're taking the mode off
 196                 if (cd)
 197                 {
 198                         for (ModeList::iterator it = cd->list.begin(); it != cd->list.end(); ++it)
 199                         {
 200                                 if (parameter == it->mask)
 201                                 {
 202                                         cd->list.erase(it);
 203                                         return MODEACTION_ALLOW;
 204                                 }
 205                         }
 206                 }
 207
 208                 /* Tried to remove something that wasn't set */
 209                 TellNotSet(source, channel, parameter);
 210                 parameter.clear();
 211                 return MODEACTION_DENY;
 212         }
 213 }
 214
 215 void ListModeBase::DoSyncChannel(Channel* chan, Module* proto, void* opaque)
 216 {
 217         ChanData* cd = extItem.get(chan);
 218         if (!cd)
 219                 return;
 220
 221         irc::modestacker modestack(true);
 222         std::vector<std::string> stackresult;
 223         std::vector<TranslateType> types;
 224         types.push_back(TR_TEXT);
 225
 226         for (ModeList::iterator it = cd->list.begin(); it != cd->list.end(); it++)
 227                 modestack.Push(mode, it->mask);
 228
 229         while (modestack.GetStackedLine(stackresult))
 230         {
 231                 types.assign(stackresult.size(), this->GetTranslateType());
 232                 proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, stackresult, types);
 233                 stackresult.clear();
 234         }
 235 }
 236
 237 bool ListModeBase::ValidateParam(User*, Channel*, std::string&)
 238 {
 239         return true;
 240 }
 241
 242 void ListModeBase::TellListTooLong(User* source, Channel* channel, std::string& parameter)
 243 {
 244         source->WriteNumeric(478, "%s %s %s :Channel ban list is full", source->nick.c_str(), channel->name.c_str(), parameter.c_str());
 245 }
 246
 247 void ListModeBase::TellAlreadyOnList(User*, Channel*, std::string&)
 248 {
 249 }
 250
 251 void ListModeBase::TellNotSet(User*, Channel*, std::string&)
 252 {
 253 }