]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_remove.cpp
Automatically register ServiceProviders created by modules
[user/henk/code/inspircd.git] / src / modules / m_remove.cpp
index be23649344433e7f5c6921c5d81e85979e65e017..48f0f02764108f05a4cbb0b335d7ddf06c56055c 100644 (file)
-/* Support for a dancer-style /remove command, an alternative to /kick to try and avoid auto-rejoin-on-kick scripts */
-/* Written by Om, 25-03-05 */
-
-#include <sstream>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-#include "configreader.h"
-#include "commands.h"
-#include "inspircd.h"
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005, 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2005-2006 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
 
-/* $ModDesc: Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel */
+#include "inspircd.h"
 
-/*     
+/*
  * This module supports the use of the +q and +a usermodes, but should work without them too.
  * Usage of the command is restricted to +hoaq, and you cannot remove a user with a "higher" level than yourself.
  * eg: +h can remove +hv and users with no modes. +a can remove +aohv and users with no modes.
 */
 
-class RemoveBase
+/** Base class for /FPART and /REMOVE
+ */
+class RemoveBase : public Command
 {
- private: 
        bool& supportnokicks;
-       InspIRCd* ServerInstance;
- protected:
-       RemoveBase(InspIRCd* Instance, bool& snk) : supportnokicks(snk), ServerInstance(Instance)
-       {
-       }               
-       enum ModeLevel { PEON = 0, HALFOP = 1, OP = 2, ADMIN = 3, OWNER = 4, ULINE = 5 };        
-       /* This little function just converts a chanmode character (U ~ & @ & +) into an integer (5 4 3 2 1 0) */
-       /* XXX - this could be handy in the core, so it can be used elsewhere */
-       ModeLevel chartolevel(const std::string &privs)
+       ChanModeReference& nokicksmode;
+
+ public:
+       RemoveBase(Module* Creator, bool& snk, ChanModeReference& nkm, const char* cmdn)
+               : Command(Creator, cmdn, 2, 3)
+               , supportnokicks(snk)
+               , nokicksmode(nkm)
        {
-               if(privs.empty())
-               {
-                       return PEON;
-               }
-       
-               switch (privs[0])
-               {
-                       case 'U':
-                               /* Ulined */
-                               return ULINE;
-                       case '~':
-                               /* Owner */
-                               return OWNER;
-                       case '&':
-                               /* Admin */
-                               return ADMIN;
-                       case '@':
-                               /* Operator */
-                               return OP;
-                       case '%':
-                               /* Halfop */
-                               return HALFOP;
-                       default:
-                               /* Peon */
-                               return PEON;
-               }
        }
-       
-       void Handle (const char** parameters, int pcnt, userrec *user, bool neworder)
+
+       CmdResult HandleRMB(const std::vector<std::string>& parameters, User *user, bool neworder)
        {
-               const char* channame;
-               const char* username;
-               userrec* target;
-               chanrec* channel;
-               ModeLevel tlevel;
-               ModeLevel ulevel;
-               std::ostringstream reason;
-               std::string protectkey;
-               std::string founderkey;
-               bool hasnokicks;
-               
+               User* target;
+               Channel* channel;
+               std::string reason;
+
                /* Set these to the parameters needed, the new version of this module switches it's parameters around
                 * supplying a new command with the new order while keeping the old /remove with the older order.
                 * /remove <nick> <channel> [reason ...]
                 * /fpart <channel> <nick> [reason ...]
                 */
-               channame = parameters[ neworder ? 0 : 1];
-               username = parameters[ neworder ? 1 : 0];
-               
+               const std::string& channame = parameters[neworder ? 0 : 1];
+               const std::string& username = parameters[neworder ? 1 : 0];
+
                /* Look up the user we're meant to be removing from the channel */
                target = ServerInstance->FindNick(username);
-               
+
                /* And the channel we're meant to be removing them from */
                channel = ServerInstance->FindChan(channame);
 
                /* Fix by brain - someone needs to learn to validate their input! */
-               if (!target || !channel)
+               if ((!target) || (target->registered != REG_ALL) || (!channel))
                {
-                       user->WriteServ("401 %s %s :No such nick/channel", user->nick, !target ? username : channame);
-                       return;
+                       user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), !channel ? channame.c_str() : username.c_str());
+                       return CMD_FAILURE;
                }
 
                if (!channel->HasUser(target))
                {
-                       user->WriteServ( "NOTICE %s :*** The user %s is not on channel %s", user->nick, target->nick, channel->name);
-                       return;
-               }       
-               
-               /* This is adding support for the +q and +a channel modes, basically if they are enabled, and the remover has them set.
-                * Then we change the @|%|+ to & if they are +a, or ~ if they are +q */
-               protectkey = "cm_protect_" + std::string(channel->name);
-               founderkey = "cm_founder_" + std::string(channel->name);
-               
-               if (is_uline(user->server) || is_uline(user->nick))
-               {
-                       log(DEBUG, "Setting ulevel to U");
-                       ulevel = chartolevel("U");
+                       user->WriteServ( "NOTICE %s :*** The user %s is not on channel %s", user->nick.c_str(), target->nick.c_str(), channel->name.c_str());
+                       return CMD_FAILURE;
                }
-               if (user->GetExt(founderkey))
-               {
-                       log(DEBUG, "Setting ulevel to ~");
-                       ulevel = chartolevel("~");
-               }
-               else if (user->GetExt(protectkey))
-               {
-                       log(DEBUG, "Setting ulevel to &");
-                       ulevel = chartolevel("&");
-               }
-               else
-               {
-                       log(DEBUG, "Setting ulevel to %s", channel->GetStatusChar(user));
-                       ulevel = chartolevel(channel->GetStatusChar(user));
-               }
-                       
-               /* Now it's the same idea, except for the target. If they're ulined make sure they get a higher level than the sender can */
-               if (is_uline(target->server) || is_uline(target->nick))
-               {
-                       log(DEBUG, "Setting tlevel to U");
-                       tlevel = chartolevel("U");
-               }
-               else if (target->GetExt(founderkey))
-               {
-                       log(DEBUG, "Setting tlevel to ~");
-                       tlevel = chartolevel("~");
-               }
-               else if (target->GetExt(protectkey))
-               {
-                       log(DEBUG, "Setting tlevel to &");
-                       tlevel = chartolevel("&");
-               }
-               else
+
+               int ulevel = channel->GetPrefixValue(user);
+               int tlevel = channel->GetPrefixValue(target);
+
+               if (ServerInstance->ULine(target->server))
                {
-                       log(DEBUG, "Setting tlevel to %s", channel->GetStatusChar(target));
-                       tlevel = chartolevel(channel->GetStatusChar(target));
+                       user->WriteNumeric(482, "%s %s :Only a u-line may remove a u-line from a channel.", user->nick.c_str(), channame.c_str());
+                       return CMD_FAILURE;
                }
-               
-               hasnokicks = (ServerInstance->FindModule("m_nokicks.so") && channel->IsModeSet('Q'));
-               
+
                /* 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 */
-               if(!supportnokicks || !hasnokicks || (ulevel == ULINE))
+               if ((!IS_LOCAL(user)) || (!supportnokicks) || (!channel->IsModeSet(nokicksmode)))
                {
                        /* We'll let everyone remove their level and below, eg:
                         * ops can remove ops, halfops, voices, and those with no mode (no moders actually are set to 1)
                         * a ulined target will get a higher level than it's possible for a /remover to get..so they're safe.
                         * Nobody may remove a founder.
                         */
-                       if ((ulevel > PEON) && (ulevel >= tlevel) && (tlevel != OWNER))
+                       if ((!IS_LOCAL(user)) || ((ulevel > VOICE_VALUE) && (ulevel >= tlevel) && (tlevel != 50000)))
                        {
+                               // 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)
+                               if (!IS_LOCAL(target))
+                                       return CMD_SUCCESS;
+
                                std::string reasonparam;
-                               
+
                                /* If a reason is given, use it */
-                               if(pcnt > 2)
-                               {
-                                        reason <<  ":";
-                                       
-                                       /* Use all the remaining parameters as the reason */
-                                       for(int i = 2; i < pcnt; i++)
-                                       {
-                                               reason << " " << parameters[i];
-                                       }
-                                       
-                                       reasonparam = reason.str();
-                                       reason.clear();
-                               }
+                               if(parameters.size() > 2)
+                                       reasonparam = parameters[2];
+                               else
+                                       reasonparam = "No reason given";
 
                                /* Build up the part reason string. */
-                               reason << "Removed by " << user->nick << reasonparam;
+                               reason = "Removed by " + user->nick + ": " + reasonparam;
 
-                               channel->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :%s removed %s from the channel", channel->name, user->nick, target->nick);
-                               target->WriteServ("NOTICE %s :*** %s removed you from %s with the message: %s", target->nick, user->nick, channel->name, reasonparam.c_str());
+                               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());
+                               target->WriteNotice("*** " + user->nick + " removed you from " + channel->name + " with the message: " + reasonparam);
 
-                               if (!channel->PartUser(target, reason.str().c_str()))
-                                       delete channel;
+                               channel->PartUser(target, reason);
                        }
                        else
                        {
-                               user->WriteServ( "NOTICE %s :*** You do not have access to /remove %s from %s", user->nick, target->nick, channel->name);
+                               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());
+                               return CMD_FAILURE;
                        }
                }
                else
                {
                        /* m_nokicks.so was loaded and +Q was set, block! */
-                       user->WriteServ( "484 %s %s :Can't remove user %s from channel (+Q set)", user->nick, channel->name, target->nick);
+                       user->WriteServ( "484 %s %s :Can't remove user %s from channel (nokicks mode is set)", user->nick.c_str(), channel->name.c_str(), target->nick.c_str());
+                       return CMD_FAILURE;
                }
+
+               return CMD_SUCCESS;
        }
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) = 0;
 };
 
-class cmd_remove : public command_t, public RemoveBase
+/** Handle /REMOVE
+ */
+class CommandRemove : public RemoveBase
 {
  public:
-       cmd_remove(InspIRCd* Instance, bool& snk) : command_t(Instance, "REMOVE", 0, 2), RemoveBase(Instance, snk)
+       CommandRemove(Module* Creator, bool& snk, ChanModeReference& nkm)
+               : RemoveBase(Creator, snk, nkm, "REMOVE")
        {
-               this->source = "m_remove.so";
                syntax = "<nick> <channel> [<reason>]";
+               TRANSLATE3(TR_NICK, TR_TEXT, TR_TEXT);
        }
-       
-       void Handle (const char** parameters, int pcnt, userrec *user)
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
-               RemoveBase::Handle(parameters, pcnt, user, false);
+               return HandleRMB(parameters, user, false);
+       }
+
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               User* dest = ServerInstance->FindNick(parameters[0]);
+               if (dest)
+                       return ROUTE_OPT_UCAST(dest->server);
+               return ROUTE_LOCALONLY;
        }
 };
 
-class cmd_fpart : public command_t, public RemoveBase
+/** Handle /FPART
+ */
+class CommandFpart : public RemoveBase
 {
  public:
-       cmd_fpart(InspIRCd* Instance, bool& snk) : command_t(Instance, "FPART", 0, 2), RemoveBase(Instance, snk)
+       CommandFpart(Module* Creator, bool& snk, ChanModeReference& nkm)
+               : RemoveBase(Creator, snk, nkm, "FPART")
        {
-               this->source = "m_remove.so";
                syntax = "<channel> <nick> [<reason>]";
+               TRANSLATE3(TR_TEXT, TR_NICK, TR_TEXT);
+       }
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       {
+               return HandleRMB(parameters, user, true);
        }
 
-       void Handle (const char** parameters, int pcnt, userrec *user)
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
        {
-               RemoveBase::Handle(parameters, pcnt, user, true);
+               User* dest = ServerInstance->FindNick(parameters[1]);
+               if (dest)
+                       return ROUTE_OPT_UCAST(dest->server);
+               return ROUTE_LOCALONLY;
        }
 };
 
 class ModuleRemove : public Module
 {
-       cmd_remove* mycommand;
-       cmd_fpart* mycommand2;
+       ChanModeReference nokicksmode;
+       CommandRemove cmd1;
+       CommandFpart cmd2;
        bool supportnokicks;
-       
-       
+
  public:
-       ModuleRemove(InspIRCd* Me)
-       : Module::Module(Me)
+       ModuleRemove()
+               : nokicksmode(this, "nokick")
+               , cmd1(this, supportnokicks, nokicksmode)
+               , cmd2(this, supportnokicks, nokicksmode)
        {
-               mycommand = new cmd_remove(ServerInstance, supportnokicks);
-               mycommand2 = new cmd_fpart(ServerInstance, supportnokicks);
-               ServerInstance->AddCommand(mycommand);
-               ServerInstance->AddCommand(mycommand2);
-               OnRehash("");
        }
 
-       void Implements(char* List)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               List[I_On005Numeric] = List[I_OnRehash] = 1;
+               tokens["REMOVE"];
        }
 
-       virtual void On005Numeric(std::string &output)
-       {
-               output.append(" REMOVE");
-       }
-       
-       virtual void OnRehash(const std::string&)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ConfigReader conf;
-               
-               supportnokicks = conf.ReadFlag("remove", "supportnokicks", 0);
+               supportnokicks = ServerInstance->Config->ConfValue("remove")->getBool("supportnokicks");
        }
-       
-       virtual ~ModuleRemove()
-       {
-               delete mycommand;
-               delete mycommand2;
-       }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1,0,1,0,VF_VENDOR);
-       }
-       
-};
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
 
-class ModuleRemoveFactory : public ModuleFactory
-{
- public:
-       ModuleRemoveFactory()
-       {
-       }
-       
-       ~ModuleRemoveFactory()
+       Version GetVersion() CXX11_OVERRIDE
        {
+               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);
        }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
-       {
-               return new ModuleRemove(Me);
-       }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleRemoveFactory;
-}
+MODULE_INIT(ModuleRemove)