src/modules/m_remove.cpp

   1 /* Support for a dancer-style /remove command, an alternative to /kick to try and avoid auto-rejoin-on-kick scripts */
   2 /* Written by Om, 25-03-05 */
   3
   4 using namespace std;
   5
   6 #include <stdio.h>
   7 #include <string>
   8 #include "users.h"
   9 #include "channels.h"
  10 #include "modules.h"
  11
  12 /* $ModDesc: Provides a /remove command, this is mostly an alternative to /kick, except makes users appear to have parted the channel */
  13
  14 /*
  15  * This module supports the use of the +q and +a usermodes, but should work without them too.
  16  * Usage of the command is restricted to +hoaq, and you cannot remove a user with a "higher" level than yourself.
  17  * eg: +h can remove +hv and users with no modes. +a can remove +aohv and users with no modes.
  18 */
  19
  20 static Server *Srv;
  21
  22 /* This little function just converts a chanmode character (~ & @ & +) into an integer (5 4 3 2 1) */
  23 /* XXX - this could be handy in the core, so it can be used elsewhere */
  24 int chartolevel(std::string &privs)
  25 {
  26         const char* n = privs.c_str();
  27
  28         switch (*n)
  29         {
  30                 case '~':
  31                         return 5;
  32                 break;
  33                 case '&':
  34                         return 4;
  35                 break;
  36                 case '@':
  37                         return 3;
  38                 break;
  39                 case '%':
  40                         return 2;
  41                 break;
  42                 default:
  43                         return 1;
  44                 break;
  45         }
  46         return 1;
  47 }
  48
  49 class cmd_remove : public command_t
  50 {
  51  public:
  52         cmd_remove () : command_t("REMOVE", 0, 2)
  53         {
  54                 this->source = "m_remove.so";
  55         }
  56
  57         void Handle (char **parameters, int pcnt, userrec *user)
  58         {
  59                 /* Look up the user we're meant to be removing from the channel */
  60                 userrec* target = Srv->FindNick(std::string(parameters[0]));
  61                 /* And the channel we're meant to be removing them from */
  62                 chanrec* channel = Srv->FindChannel(std::string(parameters[1]));
  63                 /* And see if the person calling the command has access to use it on the channel */
  64                 std::string privs = Srv->ChanMode(user, channel);
  65                 /* Check what privs the person being removed has */
  66                 std::string targetprivs = Srv->ChanMode(target, channel);
  67                 int tlevel;
  68                 int ulevel;
  69                 int n = 2;
  70                 std::string result;
  71
  72                 /* This turns all the parameters after the first two into a single string, so the part reason can be multi-word */
  73                 while (n < pcnt)
  74                 {
  75                         result=result + std::string(" ") + std::string(parameters[n]);
  76                         n++;
  77                 }
  78
  79                 /* If the target nick exists... */
  80                 if (target && channel)
  81                 {
  82                         for (unsigned int x = 0; x < strlen(parameters[1]); x++)
  83                         {
  84                                         if ((parameters[1][0] != '#') || (parameters[1][x] == ' ') || (parameters[1][x] == ','))
  85                                         {
  86                                                 Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** Invalid characters in channel name");
  87                                                 return;
  88                                         }
  89                         }
  90
  91                         /* This is adding support for the +q and +a channel modes, basically if they are enabled, and the remover has them set. */
  92                         /* Then we change the @|%|+ to & if they are +a, or ~ if they are +q */
  93                         if (user->GetExt("cm_protect_"+std::string(channel->name)))
  94                                 privs = std::string("&");
  95                         if (user->GetExt("cm_founder_"+std::string(channel->name)))
  96                                 privs = std::string("~");
  97
  98                         /* Now it's the same idea, except for the target */
  99                         if (target->GetExt("cm_protect_"+std::string(channel->name)))
 100                                 targetprivs = std::string("&");
 101                         if (target->GetExt("cm_founder_"+std::string(channel->name)))
 102                                 targetprivs = std::string("~");
 103
 104                         tlevel = chartolevel(targetprivs);
 105                         ulevel = chartolevel(privs);
 106
 107                         /* If the user calling the command is either an admin, owner, operator or a half-operator on the channel */
 108                         if(ulevel > 1)
 109                         {
 110                                 /* 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) */
 111                                 if(ulevel >= tlevel)
 112                                 {
 113                                         Srv->PartUserFromChannel(target,std::string(parameters[1]), "Removed by "+std::string(user->nick)+":"+result);
 114                                         Srv->SendTo(NULL,user,"NOTICE "+std::string(channel->name)+" : "+std::string(user->nick)+" removed "+std::string(target->nick)+ " from the channel");
 115                                         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));
 116                                 }
 117                                 else
 118                                 {
 119                                         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));
 120                                 }
 121                         }
 122                         else
 123                         {
 124                                 Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** You do not have access to use /remove on "+std::string(channel->name));
 125                         }
 126                 }
 127         }
 128 };
 129
 130 class ModuleRemove : public Module
 131 {
 132         cmd_remove* mycommand;
 133  public:
 134         ModuleRemove(Server* Me)
 135                 : Module::Module(Me)
 136         {
 137                 Srv = Me;
 138                 mycommand = new cmd_remove();
 139                 Srv->AddCommand(mycommand);
 140         }
 141
 142         void Implements(char* List)
 143         {
 144                 List[I_On005Numeric] = 1;
 145         }
 146
 147         virtual void On005Numeric(std::string &output)
 148         {
 149                 output = output + std::string(" REMOVE");
 150         }
 151
 152         virtual ~ModuleRemove()
 153         {
 154         }
 155
 156         virtual Version GetVersion()
 157         {
 158                 return Version(1,0,0,1,VF_VENDOR);
 159         }
 160
 161 };
 162
 163 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 164
 165 class ModuleRemoveFactory : public ModuleFactory
 166 {
 167  public:
 168         ModuleRemoveFactory()
 169         {
 170         }
 171
 172         ~ModuleRemoveFactory()
 173         {
 174         }
 175
 176         virtual Module * CreateModule(Server* Me)
 177         {
 178                 return new ModuleRemove(Me);
 179         }
 180
 181 };
 182
 183
 184 extern "C" void * init_module( void )
 185 {
 186         return new ModuleRemoveFactory;
 187 }
 188