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                 User* target;
  51                 Channel* channel;
  52                 std::string reason;
  53                 std::string protectkey;
  54                 std::string founderkey;
  55                 bool hasnokicks;
  56
  57                 /* Set these to the parameters needed, the new version of this module switches it's parameters around
  58                  * supplying a new command with the new order while keeping the old /remove with the older order.
  59                  * /remove <nick> <channel> [reason ...]
  60                  * /fpart <channel> <nick> [reason ...]
  61                  */
  62                 const std::string& channame = parameters[neworder ? 0 : 1];
  63                 const std::string& username = parameters[neworder ? 1 : 0];
  64
  65                 /* Look up the user we're meant to be removing from the channel */
  66                 if (IS_LOCAL(user))
  67                         target = ServerInstance->FindNickOnly(username);
  68                 else
  69                         target = ServerInstance->FindNick(username);
  70
  71                 /* And the channel we're meant to be removing them from */
  72                 channel = ServerInstance->FindChan(channame);
  73
  74                 /* Fix by brain - someone needs to learn to validate their input! */
  75                 if ((!target) || (target->registered != REG_ALL) || (!channel))
  76                 {
  77                         user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), !channel ? channame.c_str() : username.c_str());
  78                         return CMD_FAILURE;
  79                 }
  80
  81                 if (!channel->HasUser(target))
  82                 {
  83                         user->WriteServ( "NOTICE %s :*** The user %s is not on channel %s", user->nick.c_str(), target->nick.c_str(), channel->name.c_str());
  84                         return CMD_FAILURE;
  85                 }
  86
  87                 int ulevel = channel->GetPrefixValue(user);
  88                 int tlevel = channel->GetPrefixValue(target);
  89
  90                 hasnokicks = (ServerInstance->Modules->Find("m_nokicks.so") && channel->IsModeSet('Q'));
  91
  92                 if (ServerInstance->ULine(target->server))
  93                 {
  94                         user->WriteNumeric(482, "%s %s :Only a u-line may remove a u-line from a channel.", user->nick.c_str(), channame.c_str());
  95                         return CMD_FAILURE;
  96                 }
  97
  98                 /* 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 */
  99                 if ((!IS_LOCAL(user)) || (!supportnokicks || !hasnokicks))
 100                 {
 101                         /* We'll let everyone remove their level and below, eg:
 102                          * ops can remove ops, halfops, voices, and those with no mode (no moders actually are set to 1)
 103                          * a ulined target will get a higher level than it's possible for a /remover to get..so they're safe.
 104                          * Nobody may remove a founder.
 105                          */
 106                         if ((!IS_LOCAL(user)) || ((ulevel > VOICE_VALUE) && (ulevel >= tlevel) && (tlevel != 50000)))
 107                         {
 108                                 // REMOVE/FPART will be sent to the target's server and it will reply with a PART (or do nothing if it doesn't understand the command)
 109                                 if (!IS_LOCAL(target))
 110                                         return CMD_SUCCESS;
 111
 112                                 std::string reasonparam;
 113
 114                                 /* If a reason is given, use it */
 115                                 if(parameters.size() > 2)
 116                                         reasonparam = parameters[2];
 117                                 else
 118                                         reasonparam = "No reason given";
 119
 120                                 /* Build up the part reason string. */
 121                                 reason = "Removed by " + user->nick + ": " + reasonparam;
 122
 123                                 channel->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :%s removed %s from the channel", channel->name.c_str(), user->nick.c_str(), target->nick.c_str());
 124                                 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());
 125
 126                                 channel->PartUser(target, reason);
 127                         }
 128                         else
 129                         {
 130                                 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());
 131                                 return CMD_FAILURE;
 132                         }
 133                 }
 134                 else
 135                 {
 136                         /* m_nokicks.so was loaded and +Q was set, block! */
 137                         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());
 138                         return CMD_FAILURE;
 139                 }
 140
 141                 return CMD_SUCCESS;
 142         }
 143         virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) = 0;
 144 };
 145
 146 /** Handle /REMOVE
 147  */
 148 class CommandRemove : public RemoveBase
 149 {
 150  public:
 151         CommandRemove(Module* Creator, bool& snk)
 152                 : RemoveBase(Creator, snk, "REMOVE")
 153         {
 154                 syntax = "<nick> <channel> [<reason>]";
 155                 TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END);
 156         }
 157
 158         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 159         {
 160                 return HandleRMB(parameters, user, false);
 161         }
 162
 163         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 164         {
 165                 User* dest = ServerInstance->FindNick(parameters[0]);
 166                 if (dest)
 167                         return ROUTE_OPT_UCAST(dest->server);
 168                 return ROUTE_LOCALONLY;
 169         }
 170 };
 171
 172 /** Handle /FPART
 173  */
 174 class CommandFpart : public RemoveBase
 175 {
 176  public:
 177         CommandFpart(Module* Creator, bool& snk)
 178                 : RemoveBase(Creator, snk, "FPART")
 179         {
 180                 syntax = "<channel> <nick> [<reason>]";
 181                 TRANSLATE4(TR_TEXT, TR_NICK, TR_TEXT, TR_END);
 182         }
 183
 184         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 185         {
 186                 return HandleRMB(parameters, user, true);
 187         }
 188
 189         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 190         {
 191                 User* dest = ServerInstance->FindNick(parameters[1]);
 192                 if (dest)
 193                         return ROUTE_OPT_UCAST(dest->server);
 194                 return ROUTE_LOCALONLY;
 195         }
 196 };
 197
 198 class ModuleRemove : public Module
 199 {
 200         CommandRemove cmd1;
 201         CommandFpart cmd2;
 202         bool supportnokicks;
 203
 204
 205  public:
 206         ModuleRemove() : cmd1(this, supportnokicks), cmd2(this, supportnokicks)
 207         {
 208         }
 209
 210         void init()
 211         {
 212                 ServerInstance->Modules->AddService(cmd1);
 213                 ServerInstance->Modules->AddService(cmd2);
 214                 OnRehash(NULL);
 215                 Implementation eventlist[] = { I_On005Numeric, I_OnRehash };
 216                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 217         }
 218
 219         virtual void On005Numeric(std::string &output)
 220         {
 221                 output.append(" REMOVE");
 222         }
 223
 224         virtual void OnRehash(User* user)
 225         {
 226                 supportnokicks = ServerInstance->Config->ConfValue("remove")->getBool("supportnokicks");
 227         }
 228
 229         virtual ~ModuleRemove()
 230         {
 231         }
 232
 233         virtual Version GetVersion()
 234         {
 235                 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);
 236         }
 237
 238 };
 239
 240 MODULE_INIT(ModuleRemove)