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