src/modules/m_chanprotect.cpp

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