-/* 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 */
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
-#include <stdio.h>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
+#include "inspircd.h"
/* $ModDesc: Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel */
-/*
+/*
* 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.
*/
-Server *Srv;
-
-/* This little function just converts a chanmode character (~ & @ & +) into an integer (5 4 3 2 1) */
-int chartolevel(std::string privs)
+/** Base class for /FPART and /REMOVE
+ */
+class RemoveBase
{
- int level;
- if(privs == "~")
- level = 5;
- else
- if(privs == "&")
- level = 4;
- else
- if(privs == "@")
- level = 3;
- else
- if(privs == "%") {
- level = 2;
- } else {
- level = 1;
+ private:
+ bool& supportnokicks;
+ InspIRCd* ServerInstance;
+
+ protected:
+ RemoveBase(InspIRCd* Instance, bool& snk) : supportnokicks(snk), ServerInstance(Instance)
+ {
}
- return level;
-}
-
-void handle_remove(char **parameters, int pcnt, userrec *user)
-{
- /* Look up the user we're meant to be removing from the channel */
- userrec* target = Srv->FindNick(std::string(parameters[0]));
- /* And the channel we're meant to be removing them from */
- chanrec* channel = Srv->FindChannel(std::string(parameters[1]));
- /* And see if the person calling the command has access to use it on the channel */
- std::string privs = Srv->ChanMode(user, channel);
- /* Check what privs the person being removed has */
- std::string targetprivs = Srv->ChanMode(target, channel);
- int tlevel;
- int ulevel;
- int n = 2;
- std::string result;
-
- /* This turns all the parameters after the first two into a single string, so the part reason can be multi-word */
- while (n < pcnt)
+
+ 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 - We should probably use the new mode prefix rank stuff
+ * for this instead now -- Brain */
+ ModeLevel chartolevel(const std::string &privs)
{
- result=result + std::string(" ") + std::string(parameters[n]);
- n++;
+ 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;
+ }
}
-
- /* If the target nick exists... */
- if (target && channel)
+
+ CmdResult Handle (const std::vector<std::string>& parameters, User *user, bool neworder)
{
- for (int x = 0; x < strlen(parameters[1]); x++)
+ const char* channame;
+ const char* username;
+ User* target;
+ Channel* channel;
+ ModeLevel tlevel;
+ ModeLevel ulevel;
+ std::string reason;
+ std::string protectkey;
+ std::string founderkey;
+ bool hasnokicks;
+
+ /* 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].c_str();
+ username = parameters[ neworder ? 1 : 0].c_str();
+
+ /* 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 ((parameters[1][0] != '#') || (parameters[1][x] == ' ') || (parameters[1][x] == ','))
- {
- Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** Invalid characters in channel name");
- return;
- }
+ user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), !target ? username : channame);
+ return CMD_FAILURE;
+ }
+
+ if (!channel->HasUser(target))
+ {
+ 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;
}
-
- /* 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 */
- if (user->GetExt("cm_protect_"+std::string(channel->name)))
- privs = std::string("&");
- if (user->GetExt("cm_founder_"+std::string(channel->name)))
- privs = std::string("~");
-
- /* Now it's the same idea, except for the target */
- if (target->GetExt("cm_protect_"+std::string(channel->name)))
- targetprivs = std::string("&");
- if (target->GetExt("cm_founder_"+std::string(channel->name)))
- targetprivs = std::string("~");
-
- tlevel = chartolevel(targetprivs);
- ulevel = chartolevel(privs);
-
- /* If the user calling the command is either an admin, owner, operator or a half-operator on the channel */
- if(ulevel > 1)
+
+ /* 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 (ServerInstance->ULine(user->server) || ServerInstance->ULine(user->nick.c_str()))
+ {
+ ulevel = chartolevel("U");
+ }
+ if (user->GetExt(founderkey))
+ {
+ ulevel = chartolevel("~");
+ }
+ else if (user->GetExt(protectkey))
+ {
+ ulevel = chartolevel("&");
+ }
+ else
+ {
+ ulevel = chartolevel(channel->GetPrefixChar(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 (ServerInstance->ULine(target->server) || ServerInstance->ULine(target->nick.c_str()))
+ {
+ tlevel = chartolevel("U");
+ }
+ else if (target->GetExt(founderkey))
+ {
+ tlevel = chartolevel("~");
+ }
+ else if (target->GetExt(protectkey))
+ {
+ tlevel = chartolevel("&");
+ }
+ else
+ {
+ tlevel = chartolevel(channel->GetPrefixChar(target));
+ }
+
+ hasnokicks = (ServerInstance->Modules->Find("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 ((!IS_LOCAL(user)) || (!supportnokicks || !hasnokicks || (ulevel == ULINE)))
{
- /* For now, 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) */
- if(ulevel >= tlevel)
+ /* 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 ((!IS_LOCAL(user)) || ((ulevel > PEON) && (ulevel >= tlevel) && (tlevel != OWNER)))
{
- Srv->PartUserFromChannel(target,std::string(parameters[1]), "Remove by "+std::string(user->nick)+":"+result);
- Srv->SendTo(NULL,user,"NOTICE "+std::string(channel->name)+" : "+std::string(user->nick)+" removed "+std::string(target->nick)+ " from the channel");
- Srv->SendTo(NULL,target,"NOTICE "+std::string(target->nick)+" :*** "+std::string(user->nick)+" removed you from "+std::string(channel->name)+" with the message:"+std::string(result));
- } else {
- Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** You do not have access to remove "+std::string(target->nick)+" from the "+std::string(channel->name));
+ // no you can't just go from a std::ostringstream to a std::string, Om. -nenolod
+ // but you can do this, nenolod -brain
+
+ std::string reasonparam("No reason given");
+
+ /* If a reason is given, use it */
+ if(parameters.size() > 2)
+ {
+ /* Join params 2 ... pcnt - 1 (inclusive) into one */
+ irc::stringjoiner reason_join(" ", parameters, 2, parameters.size() - 1);
+ reasonparam = reason_join.GetJoined();
+ }
+
+ /* Build up the part reason string. */
+ reason = std::string("Removed by ") + user->nick + ": " + reasonparam;
+
+ 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->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());
+
+ if (!channel->PartUser(target, reason))
+ delete channel;
+ }
+ else
+ {
+ 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 {
- Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** You do not have access to use /remove on "+std::string(channel->name));
}
- }
-}
+ 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.c_str(), channel->name.c_str(), target->nick.c_str());
+ return CMD_FAILURE;
+ }
+ /* route me */
+ return CMD_SUCCESS;
+ }
+};
-class ModuleRemove : public Module
+/** Handle /REMOVE
+ */
+class CommandRemove : public Command, public RemoveBase
{
public:
- ModuleRemove()
+ CommandRemove(InspIRCd* Instance, bool& snk) : Command(Instance, "REMOVE", 0, 2), RemoveBase(Instance, snk)
{
- Srv = new Server;
- Srv->AddCommand("REMOVE", handle_remove, 0, 3);
+ this->source = "m_remove.so";
+ syntax = "<nick> <channel> [<reason>]";
+ TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END);
}
-
- virtual ~ModuleRemove()
+
+ CmdResult Handle (const std::vector<std::string>& parameters, User *user)
{
- delete Srv;
+ return RemoveBase::Handle(parameters, user, false);
}
-
- virtual Version GetVersion()
+};
+
+/** Handle /FPART
+ */
+class CommandFpart : public Command, public RemoveBase
+{
+ public:
+ CommandFpart(InspIRCd* Instance, bool& snk) : Command(Instance, "FPART", 0, 2), RemoveBase(Instance, snk)
{
- return Version(1,0,0,0);
+ this->source = "m_remove.so";
+ syntax = "<channel> <nick> [<reason>]";
}
-
-};
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
+ CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+ {
+ return RemoveBase::Handle(parameters, user, true);
+ }
+};
-class ModuleRemoveFactory : public ModuleFactory
+class ModuleRemove : public Module
{
+ CommandRemove* mycommand;
+ CommandFpart* mycommand2;
+ bool supportnokicks;
+
+
public:
- ModuleRemoveFactory()
+ ModuleRemove(InspIRCd* Me)
+ : Module(Me)
{
+ mycommand = new CommandRemove(ServerInstance, supportnokicks);
+ mycommand2 = new CommandFpart(ServerInstance, supportnokicks);
+ ServerInstance->AddCommand(mycommand);
+ ServerInstance->AddCommand(mycommand2);
+ OnRehash(NULL,"");
+ Implementation eventlist[] = { I_On005Numeric, I_OnRehash };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
}
-
- ~ModuleRemoveFactory()
+
+
+ virtual void On005Numeric(std::string &output)
{
+ output.append(" REMOVE");
}
-
- virtual Module * CreateModule()
+
+ virtual void OnRehash(User* user, const std::string&)
{
- return new ModuleRemove;
+ ConfigReader conf(ServerInstance);
+ supportnokicks = conf.ReadFlag("remove", "supportnokicks", 0);
}
-
-};
+ virtual ~ModuleRemove()
+ {
+ }
-extern "C" void * init_module( void )
-{
- return new ModuleRemoveFactory;
-}
+ virtual Version GetVersion()
+ {
+ return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+ }
+
+};
+MODULE_INIT(ModuleRemove)