]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_remove.cpp
fixed some indentation and spacing in modules
[user/henk/code/inspircd.git] / src / modules / m_remove.cpp
index 6d9be00adbd464e4cdcfefe6e6aa172fdf4d4a60..4dfa0bfb5c18300f3807c3b49953649f90da4e1e 100644 (file)
@@ -1 +1,282 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include <sstream>\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "configreader.h"\r\r/* $ModDesc: Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel */\r\r/*     \r * This module supports the use of the +q and +a usermodes, but should work without them too.\r * Usage of the command is restricted to +hoaq, and you cannot remove a user with a "higher" level than yourself.\r * eg: +h can remove +hv and users with no modes. +a can remove +aohv and users with no modes.\r*/\r\r/** Base class for /FPART and /REMOVE\r */\rclass RemoveBase\r{\r private: \r    bool& supportnokicks;\r  InspIRCd* ServerInstance;\r \r protected:\r        RemoveBase(InspIRCd* Instance, bool& snk) : supportnokicks(snk), ServerInstance(Instance)\r      {\r      }               \r \r     enum ModeLevel { PEON = 0, HALFOP = 1, OP = 2, ADMIN = 3, OWNER = 4, ULINE = 5 };        \r \r    /* This little function just converts a chanmode character (U ~ & @ & +) into an integer (5 4 3 2 1 0) */\r      /* XXX - We should probably use the new mode prefix rank stuff\r  * for this instead now -- Brain */\r    ModeLevel chartolevel(const std::string &privs)\r        {\r              if(privs.empty())\r              {\r                      return PEON;\r           }\r      \r               switch (privs[0])\r              {\r                      case 'U':\r                              /* Ulined */\r                           return ULINE;\r                  case '~':\r                              /* Owner */\r                            return OWNER;\r                  case '&':\r                              /* Admin */\r                            return ADMIN;\r                  case '@':\r                              /* Operator */\r                         return OP;\r                     case '%':\r                              /* Halfop */\r                           return HALFOP;\r                 default:\r                               /* Peon */\r                             return PEON;\r           }\r      }\r      \r       CmdResult Handle (const char** parameters, int pcnt, userrec *user, bool neworder)\r     {\r              const char* channame;\r          const char* username;\r          userrec* target;\r               chanrec* channel;\r              ModeLevel tlevel;\r              ModeLevel ulevel;\r              std::string reason;\r            std::string protectkey;\r                std::string founderkey;\r                bool hasnokicks;\r               \r               /* Set these to the parameters needed, the new version of this module switches it's parameters around\r           * supplying a new command with the new order while keeping the old /remove with the older order.\r               * /remove <nick> <channel> [reason ...]\r                * /fpart <channel> <nick> [reason ...]\r                 */\r            channame = parameters[ neworder ? 0 : 1];\r              username = parameters[ neworder ? 1 : 0];\r              \r               /* Look up the user we're meant to be removing from the channel */\r             target = ServerInstance->FindNick(username);\r           \r               /* And the channel we're meant to be removing them from */\r             channel = ServerInstance->FindChan(channame);\r\r         /* Fix by brain - someone needs to learn to validate their input! */\r           if (!target || !channel)\r               {\r                      user->WriteServ("401 %s %s :No such nick/channel", user->nick, !target ? username : channame);\r                 return CMD_FAILURE;\r            }\r\r             if (!channel->HasUser(target))\r         {\r                      user->WriteServ( "NOTICE %s :*** The user %s is not on channel %s", user->nick, target->nick, channel->name);\r                  return CMD_FAILURE;\r            }       \r               \r               /* This is adding support for the +q and +a channel modes, basically if they are enabled, and the remover has them set.\r                 * Then we change the @|%|+ to & if they are +a, or ~ if they are +q */\r                protectkey = "cm_protect_" + std::string(channel->name);\r               founderkey = "cm_founder_" + std::string(channel->name);\r               \r               if (ServerInstance->ULine(user->server) || ServerInstance->ULine(user->nick))\r          {\r                      ulevel = chartolevel("U");\r             }\r              if (user->GetExt(founderkey))\r          {\r                      ulevel = chartolevel("~");\r             }\r              else if (user->GetExt(protectkey))\r             {\r                      ulevel = chartolevel("&");\r             }\r              else\r           {\r                      ulevel = chartolevel(channel->GetPrefixChar(user));\r            }\r                      \r               /* 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 */\r           if (ServerInstance->ULine(target->server) || ServerInstance->ULine(target->nick))\r              {\r                      tlevel = chartolevel("U");\r             }\r              else if (target->GetExt(founderkey))\r           {\r                      tlevel = chartolevel("~");\r             }\r              else if (target->GetExt(protectkey))\r           {\r                      tlevel = chartolevel("&");\r             }\r              else\r           {\r                      tlevel = chartolevel(channel->GetPrefixChar(target));\r          }\r              \r               hasnokicks = (ServerInstance->FindModule("m_nokicks.so") && channel->IsModeSet('Q'));\r          \r               /* 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 */\r          if ((!IS_LOCAL(user)) || (!supportnokicks || !hasnokicks || (ulevel == ULINE)))\r                {\r                      /* We'll let everyone remove their level and below, eg:\r                         * ops can remove ops, halfops, voices, and those with no mode (no moders actually are set to 1)\r                        * a ulined target will get a higher level than it's possible for a /remover to get..so they're safe.\r                   * Nobody may remove a founder.\r                         */\r                    if ((!IS_LOCAL(user)) || ((ulevel > PEON) && (ulevel >= tlevel) && (tlevel != OWNER)))\r                 {\r                              // no you can't just go from a std::ostringstream to a std::string, Om. -nenolod\r                               // but you can do this, nenolod -brain\r\r                                std::string reasonparam("No reason given");\r                            \r                               /* If a reason is given, use it */\r                             if(pcnt > 2)\r                           {\r                                      /* Join params 2 ... pcnt - 1 (inclusive) into one */\r                                  irc::stringjoiner reason_join(" ", parameters, 2, pcnt - 1);\r                                   reasonparam = reason_join.GetJoined();\r                         }\r\r                             /* Build up the part reason string. */\r                         reason = std::string("Removed by ") + user->nick + ": " + reasonparam;\r\r                                channel->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :%s removed %s from the channel", channel->name, user->nick, target->nick);\r                               target->WriteServ("NOTICE %s :*** %s removed you from %s with the message: %s", target->nick, user->nick, channel->name, reasonparam.c_str());\r\r                                if (!channel->PartUser(target, reason.c_str()))\r                                        delete channel;\r                        }\r                      else\r                   {\r                              user->WriteServ( "NOTICE %s :*** You do not have access to /remove %s from %s", user->nick, target->nick, channel->name);\r                              return CMD_FAILURE;\r                    }\r              }\r              else\r           {\r                      /* m_nokicks.so was loaded and +Q was set, block! */\r                   user->WriteServ( "484 %s %s :Can't remove user %s from channel (+Q set)", user->nick, channel->name, target->nick);\r                    return CMD_FAILURE;\r            }\r\r             /* route me */\r         return CMD_SUCCESS;\r    }\r};\r\r/** Handle /REMOVE\r */\rclass cmd_remove : public command_t, public RemoveBase\r{\r public:\r cmd_remove(InspIRCd* Instance, bool& snk) : command_t(Instance, "REMOVE", 0, 2), RemoveBase(Instance, snk)\r     {\r              this->source = "m_remove.so";\r          syntax = "<nick> <channel> [<reason>]";\r        }\r      \r       CmdResult Handle (const char** parameters, int pcnt, userrec *user)\r    {\r              return RemoveBase::Handle(parameters, pcnt, user, false);\r      }\r};\r\r/** Handle /FPART\r */\rclass cmd_fpart : public command_t, public RemoveBase\r{\r public:\r   cmd_fpart(InspIRCd* Instance, bool& snk) : command_t(Instance, "FPART", 0, 2), RemoveBase(Instance, snk)\r       {\r              this->source = "m_remove.so";\r          syntax = "<channel> <nick> [<reason>]";\r        }\r\r     CmdResult Handle (const char** parameters, int pcnt, userrec *user)\r    {\r              return RemoveBase::Handle(parameters, pcnt, user, true);\r       }\r};\r\rclass ModuleRemove : public Module\r{\r     cmd_remove* mycommand;\r cmd_fpart* mycommand2;\r bool supportnokicks;\r   \r       \r public:\r      ModuleRemove(InspIRCd* Me)\r     : Module(Me)\r   {\r              mycommand = new cmd_remove(ServerInstance, supportnokicks);\r            mycommand2 = new cmd_fpart(ServerInstance, supportnokicks);\r            ServerInstance->AddCommand(mycommand);\r         ServerInstance->AddCommand(mycommand2);\r                OnRehash(NULL,"");\r     }\r\r     void Implements(char* List)\r    {\r              List[I_On005Numeric] = List[I_OnRehash] = 1;\r   }\r\r     virtual void On005Numeric(std::string &output)\r {\r              output.append(" REMOVE");\r      }\r      \r       virtual void OnRehash(userrec* user, const std::string&)\r       {\r              ConfigReader conf(ServerInstance);\r             supportnokicks = conf.ReadFlag("remove", "supportnokicks", 0);\r }\r      \r       virtual ~ModuleRemove()\r        {\r      }\r      \r       virtual Version GetVersion()\r   {\r              return Version(1,1,1,0,VF_VENDOR,API_VERSION);\r }\r      \r};\r\rMODULE_INIT(ModuleRemove)\r
\ No newline at end of file
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 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 "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.
+*/
+
+/** Base class for /FPART and /REMOVE
+ */
+class RemoveBase
+{
+ 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 - We should probably use the new mode prefix rank stuff
+        * for this instead now -- Brain */
+       ModeLevel chartolevel(const std::string &privs)
+       {
+               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;
+               }
+       }
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user, bool neworder)
+       {
+               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)
+               {
+                       user->WriteNumeric(401, "%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 */
+               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)))
+               {
+                       /* 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)))
+                       {
+                               // 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.c_str()))
+                                       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
+               {
+                       /* 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;
+       }
+};
+
+/** Handle /REMOVE
+ */
+class CommandRemove : public Command, public RemoveBase
+{
+ public:
+       CommandRemove(InspIRCd* Instance, bool& snk) : Command(Instance, "REMOVE", 0, 2), RemoveBase(Instance, snk)
+       {
+               this->source = "m_remove.so";
+               syntax = "<nick> <channel> [<reason>]";
+               TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END);
+       }
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       {
+               return RemoveBase::Handle(parameters, user, false);
+       }
+};
+
+/** Handle /FPART
+ */
+class CommandFpart : public Command, public RemoveBase
+{
+ public:
+       CommandFpart(InspIRCd* Instance, bool& snk) : Command(Instance, "FPART", 0, 2), RemoveBase(Instance, snk)
+       {
+               this->source = "m_remove.so";
+               syntax = "<channel> <nick> [<reason>]";
+       }
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       {
+               return RemoveBase::Handle(parameters, user, true);
+       }
+};
+
+class ModuleRemove : public Module
+{
+       CommandRemove* mycommand;
+       CommandFpart* mycommand2;
+       bool supportnokicks;
+
+
+ public:
+       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);
+       }
+
+
+       virtual void On005Numeric(std::string &output)
+       {
+               output.append(" REMOVE");
+       }
+
+       virtual void OnRehash(User* user, const std::string&)
+       {
+               ConfigReader conf(ServerInstance);
+               supportnokicks = conf.ReadFlag("remove", "supportnokicks", 0);
+       }
+
+       virtual ~ModuleRemove()
+       {
+       }
+
+       virtual Version GetVersion()
+       {
+               return Version(1, 2, 1, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+       }
+
+};
+
+MODULE_INIT(ModuleRemove)