src/modules/m_chanprotect.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "users.h"
  15 #include "channels.h"
  16 #include "modules.h"
  17 #include "inspircd.h"
  18
  19 /* $ModDesc: Provides channel modes +a and +q */
  20 /* $ModDep: ../../include/u_listmode.h */
  21
  22 #define PROTECT_VALUE 40000
  23 #define FOUNDER_VALUE 50000
  24
  25 const char* fakevalue = "on";
  26
  27 /* When this is set to true, no restrictions apply to setting or
  28  * removal of +qa. This is used while unloading so that the server
  29  * can freely clear all of its users of the modes.
  30  */
  31 bool unload_kludge = false;
  32
  33 /** Handles basic operation of +qa channel modes
  34  */
  35 class FounderProtectBase
  36 {
  37  private:
  38         InspIRCd* MyInstance;
  39         std::string extend;
  40         std::string type;
  41         int list;
  42         int end;
  43         char* dummyptr;
  44  protected:
  45         bool& remove_own_privs;
  46  public:
  47         FounderProtectBase(InspIRCd* Instance, const std::string &ext, const std::string &mtype, int l, int e, bool &remove_own) :
  48                 MyInstance(Instance), extend(ext), type(mtype), list(l), end(e), remove_own_privs(remove_own)
  49         {
  50         }
  51
  52         ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter)
  53         {
  54                 userrec* x = MyInstance->FindNick(parameter);
  55                 if (x)
  56                 {
  57                         if (!channel->HasUser(x))
  58                         {
  59                                 return std::make_pair(false, parameter);
  60                         }
  61                         else
  62                         {
  63                                 std::string item = extend+std::string(channel->name);
  64                                 if (x->GetExt(item,dummyptr))
  65                                 {
  66                                         return std::make_pair(true, x->nick);
  67                                 }
  68                                 else
  69                                 {
  70                                         return std::make_pair(false, parameter);
  71                                 }
  72                         }
  73                 }
  74                 return std::make_pair(false, parameter);
  75         }
  76
  77         void RemoveMode(chanrec* channel, char mc)
  78         {
  79                 unload_kludge = true;
  80                 CUList* cl = channel->GetUsers();
  81                 std::string item = extend + std::string(channel->name);
  82                 const char* mode_junk[MAXMODES+1];
  83                 userrec* n = new userrec(MyInstance);
  84                 n->SetFd(FD_MAGIC_NUMBER);
  85                 mode_junk[0] = channel->name;
  86                 irc::modestacker modestack(false);
  87                 std::deque<std::string> stackresult;
  88                 for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
  89                 {
  90                         if (i->second->GetExt(item, dummyptr))
  91                         {
  92                                 modestack.Push(mc, i->second->nick);
  93                         }
  94                 }
  95
  96                 while (modestack.GetStackedLine(stackresult))
  97                 {
  98                         for (size_t j = 0; j < stackresult.size(); j++)
  99                         {
 100                                 mode_junk[j+1] = stackresult[j].c_str();
 101                         }
 102                         MyInstance->SendMode(mode_junk, stackresult.size() + 1, n);
 103                 }
 104
 105                 delete n;
 106                 unload_kludge = false;
 107         }
 108
 109         void DisplayList(userrec* user, chanrec* channel)
 110         {
 111                 CUList* cl = channel->GetUsers();
 112                 std::string item = extend+std::string(channel->name);
 113                 for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
 114                 {
 115                         if (i->second->GetExt(item, dummyptr))
 116                         {
 117                                 user->WriteServ("%d %s %s %s", list, user->nick, channel->name,i->second->nick);
 118                         }
 119                 }
 120                 user->WriteServ("%d %s %s :End of channel %s list", end, user->nick, channel->name, type.c_str());
 121         }
 122
 123         userrec* FindAndVerify(std::string &parameter, chanrec* channel)
 124         {
 125                 userrec* theuser = MyInstance->FindNick(parameter);
 126                 if ((!theuser) || (!channel->HasUser(theuser)))
 127                 {
 128                         parameter = "";
 129                         return NULL;
 130                 }
 131                 return theuser;
 132         }
 133
 134         ModeAction HandleChange(userrec* source, userrec* theuser, bool adding, chanrec* channel, std::string &parameter)
 135         {
 136                 std::string item = extend+std::string(channel->name);
 137
 138                 if (adding)
 139                 {
 140                         if (!theuser->GetExt(item, dummyptr))
 141                         {
 142                                 theuser->Extend(item, fakevalue);
 143                                 parameter = theuser->nick;
 144                                 return MODEACTION_ALLOW;
 145                         }
 146                 }
 147                 else
 148                 {
 149                         if (theuser->GetExt(item, dummyptr))
 150                         {
 151                                 theuser->Shrink(item);
 152                                 parameter = theuser->nick;
 153                                 return MODEACTION_ALLOW;
 154                         }
 155                 }
 156                 return MODEACTION_DENY;
 157         }
 158 };
 159
 160 /** Abstraction of FounderProtectBase for channel mode +q
 161  */
 162 class ChanFounder : public ModeHandler, public FounderProtectBase
 163 {
 164         char* dummyptr;
 165  public:
 166         ChanFounder(InspIRCd* Instance, bool using_prefixes, bool &depriv_self)
 167                 : ModeHandler(Instance, 'q', 1, 1, true, MODETYPE_CHANNEL, false, using_prefixes ? '~' : 0),
 168                   FounderProtectBase(Instance, "cm_founder_", "founder", 386, 387, depriv_self) { }
 169
 170         unsigned int GetPrefixRank()
 171         {
 172                 return FOUNDER_VALUE;
 173         }
 174
 175         ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter)
 176         {
 177                 return FounderProtectBase::ModeSet(source, dest, channel, parameter);
 178         }
 179
 180         void RemoveMode(chanrec* channel)
 181         {
 182                 FounderProtectBase::RemoveMode(channel, this->GetModeChar());
 183         }
 184
 185         void RemoveMode(userrec* user)
 186         {
 187         }
 188
 189         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
 190         {
 191                 userrec* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
 192
 193                 if (!theuser)
 194                 {
 195                         return MODEACTION_DENY;
 196                 }
 197
 198                  // source is a server, or ulined, we'll let them +-q the user.
 199                 if ((unload_kludge) || ((source == theuser) && (!adding) && (FounderProtectBase::remove_own_privs)) || (ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server) || (!IS_LOCAL(source)))
 200                 {
 201                         return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
 202                 }
 203                 else
 204                 {
 205                         // whoops, someones being naughty!
 206                         source->WriteServ("468 %s %s :Only servers may set channel mode +q",source->nick, channel->name);
 207                         parameter = "";
 208                         return MODEACTION_DENY;
 209                 }
 210         }
 211
 212         void DisplayList(userrec* user, chanrec* channel)
 213         {
 214                 FounderProtectBase::DisplayList(user,channel);
 215         }
 216 };
 217
 218 /** Abstraction of FounderProtectBase for channel mode +a
 219  */
 220 class ChanProtect : public ModeHandler, public FounderProtectBase
 221 {
 222         char* dummyptr;
 223  public:
 224         ChanProtect(InspIRCd* Instance, bool using_prefixes, bool &depriv_self)
 225                 : ModeHandler(Instance, 'a', 1, 1, true, MODETYPE_CHANNEL, false, using_prefixes ? '&' : 0),
 226                   FounderProtectBase(Instance,"cm_protect_","protected user", 388, 389, depriv_self) { }
 227
 228         unsigned int GetPrefixRank()
 229         {
 230                 return PROTECT_VALUE;
 231         }
 232
 233         ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter)
 234         {
 235                 return FounderProtectBase::ModeSet(source, dest, channel, parameter);
 236         }
 237
 238         void RemoveMode(chanrec* channel)
 239         {
 240                 FounderProtectBase::RemoveMode(channel, this->GetModeChar());
 241         }
 242
 243         void RemoveMode(userrec* user)
 244         {
 245         }
 246
 247         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
 248         {
 249                 userrec* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
 250
 251                 if (!theuser)
 252                         return MODEACTION_DENY;
 253
 254                 std::string founder = "cm_founder_"+std::string(channel->name);
 255
 256                 // source has +q, is a server, or ulined, we'll let them +-a the user.
 257                 if ((unload_kludge) || ((source == theuser) && (!adding) && (FounderProtectBase::remove_own_privs)) || (ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server) || (source->GetExt(founder,dummyptr)) || (!IS_LOCAL(source)))
 258                 {
 259                         return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
 260                 }
 261                 else
 262                 {
 263                         // bzzzt, wrong answer!
 264                         source->WriteServ("482 %s %s :You are not a channel founder",source->nick, channel->name);
 265                         return MODEACTION_DENY;
 266                 }
 267         }
 268
 269         virtual void DisplayList(userrec* user, chanrec* channel)
 270         {
 271                 FounderProtectBase::DisplayList(user, channel);
 272         }
 273
 274 };
 275
 276 class ModuleChanProtect : public Module
 277 {
 278
 279         bool FirstInGetsFounder;
 280         bool QAPrefixes;
 281         bool DeprivSelf;
 282         bool booting;
 283         ChanProtect* cp;
 284         ChanFounder* cf;
 285         char* dummyptr;
 286
 287  public:
 288
 289         ModuleChanProtect(InspIRCd* Me)
 290                 : Module::Module(Me), FirstInGetsFounder(false), QAPrefixes(false), DeprivSelf(false), booting(true)
 291         {
 292                 /* Load config stuff */
 293                 OnRehash(NULL,"");
 294                 booting = false;
 295
 296                 /* Initialise module variables */
 297
 298                 cp = new ChanProtect(ServerInstance,QAPrefixes,DeprivSelf);
 299                 cf = new ChanFounder(ServerInstance,QAPrefixes,DeprivSelf);
 300
 301                 if (!ServerInstance->AddMode(cp, 'a') || !ServerInstance->AddMode(cf, 'q'))
 302                         throw ModuleException("Could not add new modes!");
 303         }
 304
 305         void Implements(char* List)
 306         {
 307                 List[I_OnUserKick] = List[I_OnUserPart] = List[I_OnRehash] = List[I_OnUserJoin] = List[I_OnAccessCheck] = List[I_OnSyncChannel] = 1;
 308         }
 309
 310         virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
 311         {
 312                 // FIX: when someone gets kicked from a channel we must remove their Extensibles!
 313                 user->Shrink("cm_founder_"+std::string(chan->name));
 314                 user->Shrink("cm_protect_"+std::string(chan->name));
 315         }
 316
 317         virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partreason)
 318         {
 319                 // FIX: when someone parts a channel we must remove their Extensibles!
 320                 user->Shrink("cm_founder_"+std::string(channel->name));
 321                 user->Shrink("cm_protect_"+std::string(channel->name));
 322         }
 323
 324         virtual void OnRehash(userrec* user, const std::string &parameter)
 325         {
 326                 /* Create a configreader class and read our flag,
 327                  * in old versions this was heap-allocated and the
 328                  * object was kept between rehashes...now we just
 329                  * stack-allocate it locally.
 330                  */
 331                 ConfigReader Conf(ServerInstance);
 332
 333                 bool old_qa = QAPrefixes;
 334
 335                 FirstInGetsFounder = Conf.ReadFlag("options","noservices",0);
 336                 QAPrefixes = Conf.ReadFlag("options","qaprefixes",0);
 337                 DeprivSelf = Conf.ReadFlag("options","deprotectself",0);
 338
 339                 /* Did the user change the QA prefixes on the fly?
 340                  * If so, remove all instances of the mode, and reinit
 341                  * the module with prefixes enabled.
 342                  */
 343                 if ((old_qa != QAPrefixes) && (!booting))
 344                 {
 345                         ServerInstance->Modes->DelMode(cp);
 346                         ServerInstance->Modes->DelMode(cf);
 347                         DELETE(cp);
 348                         DELETE(cf);
 349                         cp = new ChanProtect(ServerInstance,QAPrefixes,DeprivSelf);
 350                         cf = new ChanFounder(ServerInstance,QAPrefixes,DeprivSelf);
 351                         /* These wont fail, we already owned the mode characters before */
 352                         ServerInstance->AddMode(cp, 'a');
 353                         ServerInstance->AddMode(cf, 'q');
 354                         ServerInstance->WriteOpers("*** WARNING: +qa prefixes were enabled or disabled via a REHASH. Clients will probably need to reconnect to pick up this change.");
 355                 }
 356         }
 357
 358         virtual void OnUserJoin(userrec* user, chanrec* channel)
 359         {
 360                 // if the user is the first user into the channel, mark them as the founder, but only if
 361                 // the config option for it is set
 362                 if (FirstInGetsFounder)
 363                 {
 364                         if (channel->GetUserCounter() == 1)
 365                         {
 366                                 // we're using Extensible::Extend to add data into user objects.
 367                                 // this way is best as it adds data thats accessible to other modules
 368                                 // (so long as you document your code properly) without breaking anything
 369                                 // because its encapsulated neatly in a map.
 370
 371                                 // Change requested by katsklaw... when the first in is set to get founder,
 372                                 // to make it clearer that +q has been given, send that one user the +q notice
 373                                 // so that their client's syncronization and their sanity are left intact.
 374                                 user->WriteServ("MODE %s +q %s",channel->name,user->nick);
 375                                 user->Extend("cm_founder_"+std::string(channel->name),fakevalue);
 376                         }
 377                 }
 378         }
 379
 380         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type)
 381         {
 382                 // here we perform access checks, this is the important bit that actually stops kicking/deopping
 383                 // etc of protected users. There are many types of access check, we're going to handle
 384                 // a relatively small number of them relevent to our module using a switch statement.
 385                 // don't allow action if:
 386                 // (A) Theyre founder (no matter what)
 387                 // (B) Theyre protected, and you're not
 388                 // always allow the action if:
 389                 // (A) The source is ulined
 390
 391
 392                 // firstly, if a ulined nick, or a server, is setting the mode, then allow them to set the mode
 393                 // without any access checks, we're not worthy :p
 394                 if ((ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server))
 395                         return ACR_ALLOW;
 396
 397                 std::string founder = "cm_founder_"+std::string(channel->name);
 398                 std::string protect = "cm_protect_"+std::string(channel->name);
 399
 400                 switch (access_type)
 401                 {
 402                         // a user has been deopped. Do we let them? hmmm...
 403                         case AC_DEOP:
 404                                 if (dest->GetExt(founder,dummyptr))
 405                                 {
 406                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't deop "+std::string(dest->nick)+" as they're a channel founder");
 407                                         return ACR_DENY;
 408                                 }
 409                                 if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
 410                                 {
 411                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't deop "+std::string(dest->nick)+" as they're protected (+a)");
 412                                         return ACR_DENY;
 413                                 }
 414                         break;
 415
 416                         // a user is being kicked. do we chop off the end of the army boot?
 417                         case AC_KICK:
 418                                 if (dest->GetExt(founder,dummyptr))
 419                                 {
 420                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't kick "+std::string(dest->nick)+" as they're a channel founder");
 421                                         return ACR_DENY;
 422                                 }
 423                                 if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
 424                                 {
 425                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't kick "+std::string(dest->nick)+" as they're protected (+a)");
 426                                         return ACR_DENY;
 427                                 }
 428                         break;
 429
 430                         // a user is being dehalfopped. Yes, we do disallow -h of a +ha user
 431                         case AC_DEHALFOP:
 432                                 if (dest->GetExt(founder,dummyptr))
 433                                 {
 434                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't de-halfop "+std::string(dest->nick)+" as they're a channel founder");
 435                                         return ACR_DENY;
 436                                 }
 437                                 if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
 438                                 {
 439                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't de-halfop "+std::string(dest->nick)+" as they're protected (+a)");
 440                                         return ACR_DENY;
 441                                 }
 442                         break;
 443
 444                         // same with devoice.
 445                         case AC_DEVOICE:
 446                                 if (dest->GetExt(founder,dummyptr))
 447                                 {
 448                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't devoice "+std::string(dest->nick)+" as they're a channel founder");
 449                                         return ACR_DENY;
 450                                 }
 451                                 if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
 452                                 {
 453                                         source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't devoice "+std::string(dest->nick)+" as they're protected (+a)");
 454                                         return ACR_DENY;
 455                                 }
 456                         break;
 457                 }
 458
 459                 // we dont know what this access check is, or dont care. just carry on, nothing to see here.
 460                 return ACR_DEFAULT;
 461         }
 462
 463         virtual ~ModuleChanProtect()
 464         {
 465                 ServerInstance->Modes->DelMode(cp);
 466                 ServerInstance->Modes->DelMode(cf);
 467                 DELETE(cp);
 468                 DELETE(cf);
 469         }
 470
 471         virtual Version GetVersion()
 472         {
 473                 return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
 474         }
 475
 476         virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque)
 477         {
 478                 /* NOTE: If +qa prefix is on, this is propogated by the channel join,
 479                  * so we dont need to propogate it manually
 480                  */
 481                 if (!QAPrefixes)
 482                 {
 483                         // this is called when the server is linking into a net and wants to sync channel data.
 484                         // we should send our mode changes for the channel here to ensure that other servers
 485                         // know whos +q/+a on the channel.
 486                         CUList* cl = chan->GetUsers();
 487                         string_list commands;
 488                         std::string founder = "cm_founder_"+std::string(chan->name);
 489                         std::string protect = "cm_protect_"+std::string(chan->name);
 490                         irc::modestacker modestack(true);
 491                         std::deque<std::string> stackresult;
 492                         for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
 493                         {
 494                                 if (i->second->GetExt(founder,dummyptr))
 495                                 {
 496                                         modestack.Push('q',i->second->nick);
 497                                 }
 498                                 if (i->second->GetExt(protect,dummyptr))
 499                                 {
 500                                         modestack.Push('a',i->second->nick);
 501                                 }
 502                         }
 503                         while (modestack.GetStackedLine(stackresult))
 504                         {
 505                                 irc::stringjoiner mode_join(" ", stackresult, 0, stackresult.size() - 1);
 506                                 std::string line = mode_join.GetJoined();
 507                                 proto->ProtoSendMode(opaque,TYPE_CHANNEL,chan, line);
 508                         }
 509                 }
 510         }
 511
 512 };
 513
 514
 515 class ModuleChanProtectFactory : public ModuleFactory
 516 {
 517  public:
 518         ModuleChanProtectFactory()
 519         {
 520         }
 521
 522         ~ModuleChanProtectFactory()
 523         {
 524         }
 525
 526         virtual Module * CreateModule(InspIRCd* Me)
 527         {
 528                 return new ModuleChanProtect(Me);
 529         }
 530
 531 };
 532
 533
 534 extern "C" void * init_module( void )
 535 {
 536         return new ModuleChanProtectFactory;
 537 }