src/modules/m_remove.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2005, 2007 Robin Burchell <robin+git@viroteck.net>
   8  *   Copyright (C) 2005-2006 Craig Edwards <craigedwards@brainbox.cc>
   9  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #include "inspircd.h"
  26
  27 /* $ModDesc: Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel */
  28
  29 /*
  30  * This module supports the use of the +q and +a usermodes, but should work without them too.
  31  * Usage of the command is restricted to +hoaq, and you cannot remove a user with a "higher" level than yourself.
  32  * eg: +h can remove +hv and users with no modes. +a can remove +aohv and users with no modes.
  33 */
  34
  35 /** Base class for /FPART and /REMOVE
  36  */
  37 class RemoveBase : public Command
  38 {
  39  private:
  40         bool& supportnokicks;
  41
  42  public:
  43         RemoveBase(Module* Creator, bool& snk, const char* cmdn)
  44                 : Command(Creator, cmdn, 2, 3), supportnokicks(snk)
  45         {
  46         }
  47
  48         CmdResult HandleRMB(const std::vector<std::string>& parameters, User *user, bool neworder)
  49         {
  50                 const char* channame;
  51                 const char* username;
  52                 User* target;
  53                 Channel* channel;
  54                 std::string reason;
  55                 std::string protectkey;
  56                 std::string founderkey;
  57                 bool hasnokicks;
  58
  59                 /* Set these to the parameters needed, the new version of this module switches it's parameters around
  60                  * supplying a new command with the new order while keeping the old /remove with the older order.
  61                  * /remove <nick> <channel> [reason ...]
  62                  * /fpart <channel> <nick> [reason ...]
  63                  */
  64                 channame = parameters[ neworder ? 0 : 1].c_str();
  65                 username = parameters[ neworder ? 1 : 0].c_str();
  66
  67                 /* Look up the user we're meant to be removing from the channel */
  68                 target = ServerInstance->FindNick(username);
  69
  70                 /* And the channel we're meant to be removing them from */
  71                 channel = ServerInstance->FindChan(channame);
  72
  73                 /* Fix by brain - someone needs to learn to validate their input! */
  74                 if (!target || !channel)
  75                 {
  76                         user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), !target ? username : channame);
  77                         return CMD_FAILURE;
  78                 }
  79
  80                 if (!channel->HasUser(target))
  81                 {
  82                         user->WriteServ( "NOTICE %s :*** The user %s is not on channel %s", user->nick.c_str(), target->nick.c_str(), channel->name.c_str());
  83                         return CMD_FAILURE;
  84                 }
  85
  86                 int ulevel = channel->GetPrefixValue(user);
  87                 int tlevel = channel->GetPrefixValue(target);
  88
  89                 hasnokicks = (ServerInstance->Modules->Find("m_nokicks.so") && channel->IsModeSet('Q'));
  90
  91                 if((ServerInstance->ULine(target->server) || ServerInstance->ULine(target->nick.c_str()))){
  92                         user->WriteNumeric(482, "%s %s :Only a u-line may remove a u-line from a channel.", user->nick.c_str(), channame);
  93                         return CMD_FAILURE;
  94                 }
  95
  96                 /* We support the +Q channel mode via. the m_nokicks module, if the module is loaded and the mode is set then disallow the /remove */
  97                 if ((!IS_LOCAL(user)) || (!supportnokicks || !hasnokicks))
  98                 {
  99                         /* We'll let everyone remove their level and below, eg:
 100                          * ops can remove ops, halfops, voices, and those with no mode (no moders actually are set to 1)
 101                          * a ulined target will get a higher level than it's possible for a /remover to get..so they're safe.
 102                          * Nobody may remove a founder.
 103                          */
 104                         if ((!IS_LOCAL(user)) || ((ulevel > VOICE_VALUE) && (ulevel >= tlevel) && (tlevel != 50000)))
 105                         {
 106                                 // no you can't just go from a std::ostringstream to a std::string, Om. -nenolod
 107                                 // but you can do this, nenolod -brain
 108
 109                                 std::string reasonparam("No reason given");
 110
 111                                 /* If a reason is given, use it */
 112                                 if(parameters.size() > 2)
 113                                 {
 114                                         /* Join params 2 ... pcnt - 1 (inclusive) into one */
 115                                         irc::stringjoiner reason_join(" ", parameters, 2, parameters.size() - 1);
 116                                         reasonparam = reason_join.GetJoined();
 117                                 }
 118
 119                                 /* Build up the part reason string. */
 120                                 reason = "Removed by " + user->nick + ": " + reasonparam;
 121
 122                                 channel->WriteChannelWithServ(ServerInstance->Config->ServerName.c_str(), "NOTICE %s :%s removed %s from the channel", channel->name.c_str(), user->nick.c_str(), target->nick.c_str());
 123                                 target->WriteServ("NOTICE %s :*** %s removed you from %s with the message: %s", target->nick.c_str(), user->nick.c_str(), channel->name.c_str(), reasonparam.c_str());
 124
 125                                 channel->PartUser(target, reason);
 126                         }
 127                         else
 128                         {
 129                                 user->WriteServ( "NOTICE %s :*** You do not have access to /remove %s from %s", user->nick.c_str(), target->nick.c_str(), channel->name.c_str());
 130                                 return CMD_FAILURE;
 131                         }
 132                 }
 133                 else
 134                 {
 135                         /* m_nokicks.so was loaded and +Q was set, block! */
 136                         user->WriteServ( "484 %s %s :Can't remove user %s from channel (+Q set)", user->nick.c_str(), channel->name.c_str(), target->nick.c_str());
 137                         return CMD_FAILURE;
 138                 }
 139
 140                 return CMD_SUCCESS;
 141         }
 142         virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) = 0;
 143 };
 144
 145 /** Handle /REMOVE
 146  */
 147 class CommandRemove : public RemoveBase
 148 {
 149  public:
 150         CommandRemove(Module* Creator, bool& snk)
 151                 : RemoveBase(Creator, snk, "REMOVE")
 152         {
 153                 syntax = "<nick> <channel> [<reason>]";
 154                 TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END);
 155         }
 156
 157         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 158         {
 159                 return HandleRMB(parameters, user, false);
 160         }
 161
 162         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 163         {
 164                 User* dest = ServerInstance->FindNick(parameters[0]);
 165                 if (dest)
 166                         return ROUTE_OPT_UCAST(dest->server);
 167                 return ROUTE_LOCALONLY;
 168         }
 169 };
 170
 171 /** Handle /FPART
 172  */
 173 class CommandFpart : public RemoveBase
 174 {
 175  public:
 176         CommandFpart(Module* Creator, bool& snk)
 177                 : RemoveBase(Creator, snk, "FPART")
 178         {
 179                 syntax = "<channel> <nick> [<reason>]";
 180                 TRANSLATE4(TR_TEXT, TR_NICK, TR_TEXT, TR_END);
 181         }
 182
 183         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 184         {
 185                 return HandleRMB(parameters, user, true);
 186         }
 187
 188         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 189         {
 190                 User* dest = ServerInstance->FindNick(parameters[1]);
 191                 if (dest)
 192                         return ROUTE_OPT_UCAST(dest->server);
 193                 return ROUTE_LOCALONLY;
 194         }
 195 };
 196
 197 class ModuleRemove : public Module
 198 {
 199         CommandRemove cmd1;
 200         CommandFpart cmd2;
 201         bool supportnokicks;
 202
 203
 204  public:
 205         ModuleRemove() : cmd1(this, supportnokicks), cmd2(this, supportnokicks)
 206         {
 207                 ServerInstance->AddCommand(&cmd1);
 208                 ServerInstance->AddCommand(&cmd2);
 209                 OnRehash(NULL);
 210                 Implementation eventlist[] = { I_On005Numeric, I_OnRehash };
 211                 ServerInstance->Modules->Attach(eventlist, this, 2);
 212         }
 213
 214
 215         virtual void On005Numeric(std::string &output)
 216         {
 217                 output.append(" REMOVE");
 218         }
 219
 220         virtual void OnRehash(User* user)
 221         {
 222                 ConfigReader conf;
 223                 supportnokicks = conf.ReadFlag("remove", "supportnokicks", 0);
 224         }
 225
 226         virtual ~ModuleRemove()
 227         {
 228         }
 229
 230         virtual Version GetVersion()
 231         {
 232                 return Version("Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel", VF_OPTCOMMON | VF_VENDOR);
 233         }
 234
 235 };
 236
 237 MODULE_INIT(ModuleRemove)