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