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 (const char** parameters, int pcnt, userrec *user)
  59         {
  60                 userrec* target;
  61                 chanrec* channel;
  62                 int tlevel, ulevel;
  63                 char* dummy;
  64                 std::string tprivs, uprivs, reason;
  65
  66
  67                 /* Look up the user we're meant to be removing from the channel */
  68                 target = Srv->FindNick(parameters[0]);
  69
  70                 /* And the channel we're meant to be removing them from */
  71                 channel = Srv->FindChannel(parameters[1]);
  72
  73                 /* Fix by brain - someone needs to learn to validate their input! */
  74                 if (!target || !channel)
  75                 {
  76                         WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, !target ? parameters[0] : parameters[1]);
  77                         return;
  78                 }
  79
  80                 if (!channel->HasUser(target))
  81                 {
  82                         Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+" :*** The user "+target->nick+" is not on channel "+channel->name);
  83                         return;
  84                 }
  85
  86                 /* And see if the person calling the command has access to use it on the channel */
  87                 uprivs = Srv->ChanMode(user, channel);
  88
  89                 /* Check what privs the person being removed has */
  90                 tprivs = Srv->ChanMode(target, channel);
  91
  92                 if(pcnt > 2)
  93                         reason = "Removed by " + std::string(user->nick) + ":";
  94                 else
  95                         reason = "Removed by " + std::string(user->nick);
  96
  97                 /* This turns all the parameters after the first two into a single string, so the part reason can be multi-word */
  98                 for (int n = 2; n < pcnt; n++)
  99                 {
 100                         reason += " ";
 101                         reason += parameters[n];
 102                 }
 103
 104                 /* This is adding support for the +q and +a channel modes, basically if they are enabled, and the remover has them set. */
 105                 /* Then we change the @|%|+ to & if they are +a, or ~ if they are +q */
 106
 107                 std::string protect = "cm_protect_" + std::string(channel->name);
 108                 std::string founder = "cm_founder_"+std::string(channel->name);
 109
 110                 if (user->GetExt(protect, dummy))
 111                         uprivs = "&";
 112                 if (user->GetExt(founder, dummy))
 113                         uprivs = "~";
 114
 115                 /* Now it's the same idea, except for the target */
 116                 if (target->GetExt(protect, dummy))
 117                         tprivs = "&";
 118                 if (target->GetExt(founder, dummy))
 119                         tprivs = "~";
 120
 121                 tlevel = chartolevel(tprivs);
 122                 ulevel = chartolevel(uprivs);
 123
 124                 /* If the user calling the command is either an admin, owner, operator or a half-operator on the channel */
 125                 if (ulevel > 1)
 126                 {
 127                         /* 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) */
 128                         if ((ulevel >= tlevel && tlevel != 5) && (!Srv->IsUlined(target->server)))
 129                         {
 130                                 Srv->PartUserFromChannel(target, channel->name, reason);
 131                                 WriteServ(user->fd, "NOTICE %s :%s removed %s from the channel", channel->name, user->nick, target->nick);
 132                                 WriteServ(target->fd, "NOTICE %s :*** %s removed you from %s with the message:%s", target->nick, user->nick, channel->name, reason.c_str());
 133                         }
 134                         else
 135                         {
 136                                 WriteServ(user->fd, "NOTICE %s :*** You do not have access to /remove %s from %s", user->nick, target->nick, channel->name);
 137                         }
 138                 }
 139                 else
 140                 {
 141                         WriteServ(user->fd, "NOTICE %s :*** You do not have access to use /remove on %s", user->nick, channel->name);
 142                 }
 143         }
 144 };
 145
 146 class ModuleRemove : public Module
 147 {
 148         cmd_remove* mycommand;
 149  public:
 150         ModuleRemove(Server* Me)
 151                 : Module::Module(Me)
 152         {
 153                 Srv = Me;
 154                 mycommand = new cmd_remove();
 155                 Srv->AddCommand(mycommand);
 156         }
 157
 158         void Implements(char* List)
 159         {
 160                 List[I_On005Numeric] = 1;
 161         }
 162
 163         virtual void On005Numeric(std::string &output)
 164         {
 165                 output = output + std::string(" REMOVE");
 166         }
 167
 168         virtual ~ModuleRemove()
 169         {
 170         }
 171
 172         virtual Version GetVersion()
 173         {
 174                 return Version(1,0,0,1,VF_VENDOR);
 175         }
 176
 177 };
 178
 179 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 180
 181 class ModuleRemoveFactory : public ModuleFactory
 182 {
 183  public:
 184         ModuleRemoveFactory()
 185         {
 186         }
 187
 188         ~ModuleRemoveFactory()
 189         {
 190         }
 191
 192         virtual Module * CreateModule(Server* Me)
 193         {
 194                 return new ModuleRemove(Me);
 195         }
 196
 197 };
 198
 199
 200 extern "C" void * init_module( void )
 201 {
 202         return new ModuleRemoveFactory;
 203 }