* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2010 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
#include "inspircd.h"
/* $ModDesc: Provides channel modes +a and +q */
#define PROTECT_VALUE 40000
#define FOUNDER_VALUE 50000
-const char* fakevalue = "on";
+struct ChanProtectSettings
+{
+ bool DeprivSelf;
+ bool DeprivOthers;
+ bool FirstInGetsFounder;
+ bool booting;
+ ChanProtectSettings() : booting(true) {}
+};
+
+static ChanProtectSettings settings;
+/** Handles basic operation of +qa channel modes
+ */
class FounderProtectBase
{
private:
- InspIRCd* MyInstance;
- std::string extend;
- std::string type;
- int list;
- int end;
- char* dummyptr;
+ const std::string type;
+ const char mode;
+ const int list;
+ const int end;
public:
- FounderProtectBase(InspIRCd* Instance, const std::string &ext, const std::string &mtype, int l, int e) : MyInstance(Instance), extend(ext), type(mtype), list(l), end(e)
+ FounderProtectBase(char Mode, const std::string &mtype, int l, int e) :
+ type(mtype), mode(Mode), list(l), end(e)
{
}
- ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
{
- userrec* x = MyInstance->FindNick(parameter);
- if (x)
+ const UserMembList* cl = channel->GetUsers();
+ std::vector<std::string> mode_junk;
+ mode_junk.push_back(channel->name);
+ irc::modestacker modestack(false);
+ std::deque<std::string> stackresult;
+
+ for (UserMembCIter i = cl->begin(); i != cl->end(); i++)
{
- if (!channel->HasUser(x))
+ if (i->second->hasMode(mode))
{
- return std::make_pair(false, parameter);
- }
- else
- {
- std::string item = extend+std::string(channel->name);
- if (x->GetExt(item,dummyptr))
- {
- return std::make_pair(true, x->nick);
- }
+ if (stack)
+ stack->Push(mode, i->first->nick);
else
- {
- return std::make_pair(false, parameter);
- }
+ modestack.Push(mode, i->first->nick);
}
}
- return std::make_pair(false, parameter);
- }
- void DisplayList(userrec* user, chanrec* channel)
- {
- CUList* cl = channel->GetUsers();
- std::string item = extend+std::string(channel->name);
- for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
- {
- if (i->second->GetExt(item, dummyptr))
- {
- user->WriteServ("%d %s %s %s", list, user->nick, channel->name,i->second->nick);
- }
- }
- user->WriteServ("%d %s %s :End of channel %s list", end, user->nick, channel->name, type.c_str());
- }
+ if (stack)
+ return;
- userrec* FindAndVerify(std::string ¶meter, chanrec* channel)
- {
- userrec* theuser = MyInstance->FindNick(parameter);
- if ((!theuser) || (!channel->HasUser(theuser)))
+ while (modestack.GetStackedLine(stackresult))
{
- parameter = "";
- return NULL;
+ mode_junk.insert(mode_junk.end(), stackresult.begin(), stackresult.end());
+ ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);
+ mode_junk.erase(mode_junk.begin() + 1, mode_junk.end());
}
- return theuser;
}
- ModeAction HandleChange(userrec* source, userrec* theuser, bool adding, chanrec* channel, std::string ¶meter)
+ void DisplayList(User* user, Channel* channel)
{
- std::string item = extend+std::string(channel->name);
-
- if (adding)
- {
- if (!theuser->GetExt(item, dummyptr))
- {
- theuser->Extend(item, fakevalue);
- parameter = theuser->nick;
- return MODEACTION_ALLOW;
- }
- }
- else
+ const UserMembList* cl = channel->GetUsers();
+ for (UserMembCIter i = cl->begin(); i != cl->end(); ++i)
{
- if (theuser->GetExt(item, dummyptr))
+ if (i->second->hasMode(mode))
{
- theuser->Shrink(item);
- parameter = theuser->nick;
- return MODEACTION_ALLOW;
+ user->WriteServ("%d %s %s %s", list, user->nick.c_str(), channel->name.c_str(), i->first->nick.c_str());
}
}
- return MODEACTION_DENY;
+ user->WriteServ("%d %s %s :End of channel %s list", end, user->nick.c_str(), channel->name.c_str(), type.c_str());
+ }
+
+ bool CanRemoveOthers(User* u1, Channel* c)
+ {
+ Membership* m1 = c->GetUser(u1);
+ return (settings.DeprivOthers && m1 && m1->hasMode(mode));
}
};
+/** Abstraction of FounderProtectBase for channel mode +q
+ */
class ChanFounder : public ModeHandler, public FounderProtectBase
{
- char* dummyptr;
public:
- ChanFounder(InspIRCd* Instance, bool using_prefixes)
- : ModeHandler(Instance, 'q', 1, 1, true, MODETYPE_CHANNEL, false, using_prefixes ? '~' : 0),
- FounderProtectBase(Instance, "cm_founder_", "founder", 386, 387) { }
+ ChanFounder(Module* Creator)
+ : ModeHandler(Creator, "founder", 'q', PARAM_ALWAYS, MODETYPE_CHANNEL),
+ FounderProtectBase('q', "founder", 386, 387)
+ {
+ ModeHandler::list = true;
+ levelrequired = FOUNDER_VALUE;
+ m_paramtype = TR_NICK;
+ }
+
+ void setPrefix(int pfx)
+ {
+ prefix = pfx;
+ }
unsigned int GetPrefixRank()
{
return FOUNDER_VALUE;
}
- ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
{
- return FounderProtectBase::ModeSet(source, dest, channel, parameter);
+ FounderProtectBase::RemoveMode(channel, stack);
}
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ void RemoveMode(User* user, irc::modestacker* stack)
{
- userrec* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
-
- if (!theuser)
- {
- return MODEACTION_DENY;
- }
+ }
+
+ ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding)
+ {
+ User* theuser = ServerInstance->FindNick(parameter);
+ // remove own privs?
+ if (source == theuser && !adding && settings.DeprivSelf)
+ return MOD_RES_ALLOW;
- // source is a server, or ulined, we'll let them +-q the user.
- if ((ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server) || (!IS_LOCAL(source)))
+ if (!adding && FounderProtectBase::CanRemoveOthers(source, channel))
{
- return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
+ return MOD_RES_PASSTHRU;
}
else
{
- // whoops, someones being naughty!
- source->WriteServ("468 %s %s :Only servers may set channel mode +q",source->nick, channel->name);
- parameter = "";
- return MODEACTION_DENY;
+ source->WriteNumeric(468, "%s %s :Only servers may set channel mode +q", source->nick.c_str(), channel->name.c_str());
+ return MOD_RES_DENY;
}
}
- void DisplayList(userrec* user, chanrec* channel)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ {
+ return MODEACTION_ALLOW;
+ }
+
+ void DisplayList(User* user, Channel* channel)
{
FounderProtectBase::DisplayList(user,channel);
}
};
+/** Abstraction of FounderProtectBase for channel mode +a
+ */
class ChanProtect : public ModeHandler, public FounderProtectBase
{
- char* dummyptr;
public:
- ChanProtect(InspIRCd* Instance, bool using_prefixes)
- : ModeHandler(Instance, 'a', 1, 1, true, MODETYPE_CHANNEL, false, using_prefixes ? '&' : 0),
- FounderProtectBase(Instance,"cm_protect_","protected user", 388, 389) { }
+ ChanProtect(Module* Creator)
+ : ModeHandler(Creator, "protected", 'a', PARAM_ALWAYS, MODETYPE_CHANNEL),
+ FounderProtectBase('a',"protected user", 388, 389)
+ {
+ ModeHandler::list = true;
+ levelrequired = PROTECT_VALUE;
+ m_paramtype = TR_NICK;
+ }
+
+ void setPrefix(int pfx)
+ {
+ prefix = pfx;
+ }
+
unsigned int GetPrefixRank()
{
return PROTECT_VALUE;
}
- ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
{
- return FounderProtectBase::ModeSet(source, dest, channel, parameter);
+ FounderProtectBase::RemoveMode(channel, stack);
}
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ void RemoveMode(User* user, irc::modestacker* stack)
{
- userrec* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
+ }
- if (!theuser)
- return MODEACTION_DENY;
+ ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding)
+ {
+ User* theuser = ServerInstance->FindNick(parameter);
+ // source has +q
+ if (channel->GetPrefixValue(source) > PROTECT_VALUE)
+ return MOD_RES_ALLOW;
- std::string founder = "cm_founder_"+std::string(channel->name);
+ // removing own privs?
+ if (source == theuser && !adding && settings.DeprivSelf)
+ return MOD_RES_ALLOW;
- // source has +q, is a server, or ulined, we'll let them +-a the user.
- if ((ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server) || (source->GetExt(founder,dummyptr)) || (!IS_LOCAL(source)))
+ if (!adding && FounderProtectBase::CanRemoveOthers(source, channel))
{
- return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
+ return MOD_RES_PASSTHRU;
}
else
{
- // bzzzt, wrong answer!
- source->WriteServ("482 %s %s :You are not a channel founder",source->nick, channel->name);
- return MODEACTION_DENY;
+ source->WriteNumeric(482, "%s %s :You are not a channel founder", source->nick.c_str(), channel->name.c_str());
+ return MOD_RES_DENY;
}
}
- virtual void DisplayList(userrec* user, chanrec* channel)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ {
+ return MODEACTION_ALLOW;
+ }
+
+ void DisplayList(User* user, Channel* channel)
{
FounderProtectBase::DisplayList(user, channel);
}
class ModuleChanProtect : public Module
{
-
- bool FirstInGetsFounder;
- bool QAPrefixes;
- ChanProtect* cp;
- ChanFounder* cf;
- char* dummyptr;
-
+ ChanProtect cp;
+ ChanFounder cf;
public:
-
- ModuleChanProtect(InspIRCd* Me) : Module::Module(Me)
- {
- /* Load config stuff */
- OnRehash("");
+ ModuleChanProtect() : cp(this), cf(this)
+ {
+ }
- /* Initialise module variables */
+ void init()
+ {
+ /* Load config stuff */
+ LoadSettings();
+ settings.booting = false;
- cp = new ChanProtect(ServerInstance,QAPrefixes);
- cf = new ChanFounder(ServerInstance,QAPrefixes);
+ ServerInstance->Modules->AddService(cf);
+ ServerInstance->Modules->AddService(cp);
- ServerInstance->AddMode(cp, 'a');
- ServerInstance->AddMode(cf, 'q');
+ Implementation eventlist[] = { I_OnUserPreJoin };
+ ServerInstance->Modules->Attach(eventlist, this, 1);
}
- void Implements(char* List)
+ void LoadSettings()
{
- List[I_OnUserKick] = List[I_OnUserPart] = List[I_OnRehash] = List[I_OnUserJoin] = List[I_OnAccessCheck] = List[I_OnSyncChannel] = 1;
- }
+ ConfigReader Conf;
- virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
- {
- // FIX: when someone gets kicked from a channel we must remove their Extensibles!
- user->Shrink("cm_founder_"+std::string(chan->name));
- user->Shrink("cm_protect_"+std::string(chan->name));
- }
+ settings.FirstInGetsFounder = Conf.ReadFlag("chanprotect", "noservices", 0);
- virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partreason)
- {
- // FIX: when someone parts a channel we must remove their Extensibles!
- user->Shrink("cm_founder_"+std::string(channel->name));
- user->Shrink("cm_protect_"+std::string(channel->name));
- }
+ std::string qpre = Conf.ReadValue("chanprotect", "qprefix", 0);
+ char QPrefix = qpre.empty() ? 0 : qpre[0];
- virtual void OnRehash(const std::string ¶meter)
- {
- /* Create a configreader class and read our flag,
- * in old versions this was heap-allocated and the
- * object was kept between rehashes...now we just
- * stack-allocate it locally.
- */
- ConfigReader Conf(ServerInstance);
-
- FirstInGetsFounder = Conf.ReadFlag("options","noservices",0);
- QAPrefixes = Conf.ReadFlag("options","qaprefixes",0);
- }
-
- virtual void OnUserJoin(userrec* user, chanrec* channel)
- {
- // if the user is the first user into the channel, mark them as the founder, but only if
- // the config option for it is set
- if (FirstInGetsFounder)
- {
- if (channel->GetUserCounter() == 1)
- {
- // we're using Extensible::Extend to add data into user objects.
- // this way is best as it adds data thats accessible to other modules
- // (so long as you document your code properly) without breaking anything
- // because its encapsulated neatly in a map.
-
- // Change requested by katsklaw... when the first in is set to get founder,
- // to make it clearer that +q has been given, send that one user the +q notice
- // so that their client's syncronization and their sanity are left intact.
- user->WriteServ("MODE %s +q %s",channel->name,user->nick);
- if (user->Extend("cm_founder_"+std::string(channel->name),fakevalue))
- {
- ServerInstance->Log(DEBUG,"Marked user "+std::string(user->nick)+" as founder for "+std::string(channel->name));
- }
- }
- }
- }
-
- virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type)
- {
- // here we perform access checks, this is the important bit that actually stops kicking/deopping
- // etc of protected users. There are many types of access check, we're going to handle
- // a relatively small number of them relevent to our module using a switch statement.
-
- ServerInstance->Log(DEBUG,"chanprotect OnAccessCheck %d",access_type);
- // don't allow action if:
- // (A) Theyre founder (no matter what)
- // (B) Theyre protected, and you're not
- // always allow the action if:
- // (A) The source is ulined
-
-
- // firstly, if a ulined nick, or a server, is setting the mode, then allow them to set the mode
- // without any access checks, we're not worthy :p
- if ((ServerInstance->ULine(source->nick)) || (ServerInstance->ULine(source->server)) || (!*source->server))
- {
- return ACR_ALLOW;
- }
+ std::string apre = Conf.ReadValue("chanprotect", "aprefix", 0);
+ char APrefix = apre.empty() ? 0 : apre[0];
- std::string founder = "cm_founder_"+std::string(channel->name);
- std::string protect = "cm_protect_"+std::string(channel->name);
+ if ((APrefix && QPrefix) && APrefix == QPrefix)
+ throw ModuleException("What the smeg, why are both your +q and +a prefixes the same character?");
- switch (access_type)
- {
- // a user has been deopped. Do we let them? hmmm...
- case AC_DEOP:
- ServerInstance->Log(DEBUG,"OnAccessCheck AC_DEOP");
- if (dest->GetExt(founder,dummyptr))
- {
- ServerInstance->Log(DEBUG,"Has %s",founder.c_str());
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't deop "+std::string(dest->nick)+" as they're a channel founder");
- return ACR_DENY;
- }
- else
- {
- ServerInstance->Log(DEBUG,"Doesnt have %s",founder.c_str());
- }
- if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't deop "+std::string(dest->nick)+" as they're protected (+a)");
- return ACR_DENY;
- }
- break;
-
- // a user is being kicked. do we chop off the end of the army boot?
- case AC_KICK:
- ServerInstance->Log(DEBUG,"OnAccessCheck AC_KICK");
- if (dest->GetExt(founder,dummyptr))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't kick "+std::string(dest->nick)+" as they're a channel founder");
- return ACR_DENY;
- }
- if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't kick "+std::string(dest->nick)+" as they're protected (+a)");
- return ACR_DENY;
- }
- break;
-
- // a user is being dehalfopped. Yes, we do disallow -h of a +ha user
- case AC_DEHALFOP:
- if (dest->GetExt(founder,dummyptr))
- {
- 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");
- return ACR_DENY;
- }
- if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't de-halfop "+std::string(dest->nick)+" as they're protected (+a)");
- return ACR_DENY;
- }
- break;
-
- // same with devoice.
- case AC_DEVOICE:
- if (dest->GetExt(founder,dummyptr))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't devoice "+std::string(dest->nick)+" as they're a channel founder");
- return ACR_DENY;
- }
- if ((dest->GetExt(protect,dummyptr)) && (!source->GetExt(protect,dummyptr)))
- {
- source->WriteServ("484 "+std::string(source->nick)+" "+std::string(channel->name)+" :Can't devoice "+std::string(dest->nick)+" as they're protected (+a)");
- return ACR_DENY;
- }
- break;
- }
-
- // we dont know what this access check is, or dont care. just carry on, nothing to see here.
- return ACR_DEFAULT;
- }
-
- virtual ~ModuleChanProtect()
- {
- DELETE(cp);
- DELETE(cf);
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
- }
-
- virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque)
- {
- // this is called when the server is linking into a net and wants to sync channel data.
- // we should send our mode changes for the channel here to ensure that other servers
- // know whos +q/+a on the channel.
- CUList* cl = chan->GetUsers();
- string_list commands;
- std::string founder = "cm_founder_"+std::string(chan->name);
- std::string protect = "cm_protect_"+std::string(chan->name);
- for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
+ if (ServerInstance->Modes->FindPrefix(APrefix) && ServerInstance->Modes->FindPrefix(APrefix) != &cp)
+ throw ModuleException("Looks like the +a prefix you picked for m_chanprotect is already in use. Pick another.");
+
+ if (ServerInstance->Modes->FindPrefix(QPrefix) && ServerInstance->Modes->FindPrefix(QPrefix) != &cf)
+ throw ModuleException("Looks like the +q prefix you picked for m_chanprotect is already in use. Pick another.");
+
+ if (settings.booting)
{
- if (i->second->GetExt(founder,dummyptr))
- {
- proto->ProtoSendMode(opaque,TYPE_CHANNEL,chan,"+q "+std::string(i->second->nick));
- }
- if (i->second->GetExt(protect,dummyptr))
- {
- proto->ProtoSendMode(opaque,TYPE_CHANNEL,chan,"+a "+std::string(i->second->nick));
- }
+ cp.setPrefix(APrefix);
+ cf.setPrefix(QPrefix);
}
+ settings.DeprivSelf = Conf.ReadFlag("chanprotect","deprotectself", "yes", 0);
+ settings.DeprivOthers = Conf.ReadFlag("chanprotect","deprotectothers", "yes", 0);
}
-};
+ ModResult OnUserPreJoin(User *user, Channel *chan, const char *cname, std::string &privs, const std::string &keygiven)
+ {
+ // if the user is the first user into the channel, mark them as the founder, but only if
+ // the config option for it is set
+ if (settings.FirstInGetsFounder && !chan)
+ privs += 'q';
-class ModuleChanProtectFactory : public ModuleFactory
-{
- public:
- ModuleChanProtectFactory()
- {
- }
-
- ~ModuleChanProtectFactory()
- {
+ return MOD_RES_PASSTHRU;
}
-
- virtual Module * CreateModule(InspIRCd* Me)
+
+ Version GetVersion()
{
- return new ModuleChanProtect(Me);
+ return Version("Founder and Protect modes (+qa)", VF_VENDOR);
}
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleChanProtectFactory;
-}
+MODULE_INIT(ModuleChanProtect)