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 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         /* XXX - if we just passed this a char, we could do a switch. Look nicer, really. */
  27
  28         if (privs == "~")
  29                 return 5;
  30         else if (privs == "&")
  31                 return 4;
  32         else if (privs == "@")
  33                 return 3;
  34         else if (privs == "%")
  35                 return 2;
  36         else
  37                 return 1;
  38 }
  39
  40 void handle_remove(char **parameters, int pcnt, userrec *user)
  41 {
  42         /* Look up the user we're meant to be removing from the channel */
  43         userrec* target = Srv->FindNick(std::string(parameters[0]));
  44         /* And the channel we're meant to be removing them from */
  45         chanrec* channel = Srv->FindChannel(std::string(parameters[1]));
  46         /* And see if the person calling the command has access to use it on the channel */
  47         std::string privs = Srv->ChanMode(user, channel);
  48         /* Check what privs the person being removed has */
  49         std::string targetprivs = Srv->ChanMode(target, channel);
  50         int tlevel;
  51         int ulevel;
  52         int n = 2;
  53         std::string result;
  54
  55         /* This turns all the parameters after the first two into a single string, so the part reason can be multi-word */
  56         while (n < pcnt)
  57         {
  58                 result=result + std::string(" ") + std::string(parameters[n]);
  59                 n++;
  60         }
  61
  62         /* If the target nick exists... */
  63         if (target && channel)
  64         {
  65                 for (unsigned int x = 0; x < strlen(parameters[1]); x++)
  66                 {
  67                                 if ((parameters[1][0] != '#') || (parameters[1][x] == ' ') || (parameters[1][x] == ','))
  68                                 {
  69                                         Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** Invalid characters in channel name");
  70                                         return;
  71                                 }
  72                 }
  73
  74                 /* This is adding support for the +q and +a channel modes, basically if they are enabled, and the remover has them set. */
  75                 /* Then we change the @|%|+ to & if they are +a, or ~ if they are +q */
  76                 if (user->GetExt("cm_protect_"+std::string(channel->name)))
  77                         privs = std::string("&");
  78                 if (user->GetExt("cm_founder_"+std::string(channel->name)))
  79                         privs = std::string("~");
  80
  81                 /* Now it's the same idea, except for the target */
  82                 if (target->GetExt("cm_protect_"+std::string(channel->name)))
  83                         targetprivs = std::string("&");
  84                 if (target->GetExt("cm_founder_"+std::string(channel->name)))
  85                         targetprivs = std::string("~");
  86
  87                 tlevel = chartolevel(targetprivs);
  88                 ulevel = chartolevel(privs);
  89
  90                 /* If the user calling the command is either an admin, owner, operator or a half-operator on the channel */
  91                 if(ulevel > 1)
  92                 {
  93                         /* 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) */
  94                         if(ulevel >= tlevel)
  95                         {
  96                                 Srv->PartUserFromChannel(target,std::string(parameters[1]), "Remove by "+std::string(user->nick)+":"+result);
  97                                 Srv->SendTo(NULL,user,"NOTICE "+std::string(channel->name)+" : "+std::string(user->nick)+" removed "+std::string(target->nick)+ " from the channel");
  98                                 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));
  99                         }
 100                         else
 101                         {
 102                                 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));
 103                         }
 104                 }
 105                 else
 106                 {
 107                         Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** You do not have access to use /remove on "+std::string(channel->name));
 108                 }
 109         }
 110 }
 111
 112
 113 class ModuleRemove : public Module
 114 {
 115  public:
 116         ModuleRemove(Server* Me)
 117                 : Module::Module(Me)
 118         {
 119                 Srv = Me;
 120                 Srv->AddCommand("REMOVE", handle_remove, 0, 3, "m_remove.so");
 121         }
 122
 123         virtual void On005Numeric(std::string &output)
 124         {
 125                 output = output + std::string(" REMOVE");
 126         }
 127
 128         virtual ~ModuleRemove()
 129         {
 130         }
 131
 132         virtual Version GetVersion()
 133         {
 134                 return Version(1,0,0,1,VF_VENDOR);
 135         }
 136
 137 };
 138
 139 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 140
 141 class ModuleRemoveFactory : public ModuleFactory
 142 {
 143  public:
 144         ModuleRemoveFactory()
 145         {
 146         }
 147
 148         ~ModuleRemoveFactory()
 149         {
 150         }
 151
 152         virtual Module * CreateModule(Server* Me)
 153         {
 154                 return new ModuleRemove(Me);
 155         }
 156
 157 };
 158
 159
 160 extern "C" void * init_module( void )
 161 {
 162         return new ModuleRemoveFactory;
 163 }
 164