/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2006-2009 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
* Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
* Copyright (C) 2004-2008 Craig Edwards <craigedwards@brainbox.cc>
* Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "inspircd.h"
#include "m_override.h"
/* $ModDesc: Provides channel modes +a and +q */
#define PROTECT_VALUE 40000
#define FOUNDER_VALUE 50000
/** Handles basic operation of +qa channel modes
*/
class FounderProtectBase
{
private:
InspIRCd* MyInstance;
std::string extend;
std::string type;
int list;
int end;
protected:
bool& remove_own_privs;
bool& remove_other_privs;
public:
FounderProtectBase(InspIRCd* Instance, const std::string &ext, const std::string &mtype, int l, int e, bool &remove_own, bool &remove_others) :
MyInstance(Instance), extend(ext), type(mtype), list(l), end(e), remove_own_privs(remove_own), remove_other_privs(remove_others)
{
}
ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter)
{
User* x = MyInstance->FindNick(parameter);
if (x)
{
if (!channel->HasUser(x))
{
return std::make_pair(false, parameter);
}
else
{
std::string item = extend+std::string(channel->name);
if (x->GetExt(item))
{
return std::make_pair(true, x->nick);
}
else
{
return std::make_pair(false, parameter);
}
}
}
return std::make_pair(false, parameter);
}
void RemoveMode(Channel* channel, char mc, irc::modestacker* stack)
{
CUList* cl = channel->GetUsers();
std::string item = extend + std::string(channel->name);
std::vector<std::string> mode_junk;
mode_junk.push_back(channel->name);
irc::modestacker modestack(MyInstance, false);
std::deque<std::string> stackresult;
for (CUList::iterator i = cl->begin(); i != cl->end(); i++)
{
if (i->first->GetExt(item))
{
if (stack)
stack->Push(mc, i->first->nick);
else
modestack.Push(mc, i->first->nick);
}
}
if (stack)
return;
while (modestack.GetStackedLine(stackresult))
{
mode_junk.insert(mode_junk.end(), stackresult.begin(), stackresult.end());
MyInstance->SendMode(mode_junk, MyInstance->FakeClient);
mode_junk.erase(mode_junk.begin() + 1, mode_junk.end());
}
}
void DisplayList(User* user, Channel* channel)
{
CUList* cl = channel->GetUsers();
std::string item = extend+std::string(channel->name);
for (CUList::reverse_iterator i = cl->rbegin(); i != cl->rend(); ++i)
{
if (i->first->GetExt(item))
{
user->WriteServ("%d %s %s %s", list, user->nick.c_str(), channel->name.c_str(), i->first->nick.c_str());
}
}
user->WriteServ("%d %s %s :End of channel %s list", end, user->nick.c_str(), channel->name.c_str(), type.c_str());
}
User* FindAndVerify(std::string ¶meter, Channel* channel)
{
User* theuser = MyInstance->FindNick(parameter);
if ((!theuser) || (!channel->HasUser(theuser)))
{
parameter.clear();
return NULL;
}
return theuser;
}
bool CanRemoveOthers(User* u1, User* u2, Channel* c)
{
std::string item = extend+std::string(c->name);
return (remove_other_privs && u1->GetExt(item) && u2->GetExt(item));
}
ModeAction HandleChange(User* source, User* theuser, bool adding, Channel* channel, std::string ¶meter)
{
std::string item = extend+std::string(channel->name);
if (adding)
{
if (!theuser->GetExt(item))
{
theuser->Extend(item);
parameter = theuser->nick;
return MODEACTION_ALLOW;
}
}
else
{
if (theuser->GetExt(item))
{
theuser->Shrink(item);
parameter = theuser->nick;
return MODEACTION_ALLOW;
}
}
return MODEACTION_DENY;
}
};
/** Abstraction of FounderProtectBase for channel mode +q
*/
class ChanFounder : public ModeHandler, public FounderProtectBase
{
public:
ChanFounder(InspIRCd* Instance, char my_prefix, bool &depriv_self, bool &depriv_others)
: ModeHandler(Instance, 'q', 1, 1, true, MODETYPE_CHANNEL, false, my_prefix, 0, TR_NICK),
FounderProtectBase(Instance, "cm_founder_", "founder", 386, 387, depriv_self, depriv_others) { }
unsigned int GetPrefixRank()
{
return FOUNDER_VALUE;
}
ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter)
{
return FounderProtectBase::ModeSet(source, dest, channel, parameter);
}
void RemoveMode(Channel* channel, irc::modestacker* stack)
{
FounderProtectBase::RemoveMode(channel, this->GetModeChar(), stack);
}
void RemoveMode(User* user, irc::modestacker* stack)
{
}
ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
{
User* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
if (!theuser)
{
return MODEACTION_DENY;
}
if ((!adding) && FounderProtectBase::CanRemoveOthers(source, theuser, channel))
{
return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
}
char isoverride=0;
Module *Override = ServerInstance->Modules->FindFeature("Override");
if (Override)
{
OVRrequest ovr(NULL,Override,source,"OTHERMODE");
const char * tmp = ovr.Send();
isoverride = tmp[0];
}
// source is a server, or ulined, we'll let them +-q the user.
if (source == ServerInstance->FakeClient ||
((source == theuser) && (!adding) && (FounderProtectBase::remove_own_privs)) ||
(ServerInstance->ULine(source->nick.c_str())) ||
(ServerInstance->ULine(source->server)) ||
(!*source->server) ||
(!IS_LOCAL(source)) ||
isoverride)
{
return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
}
else
{
// whoops, someones being naughty!
source->WriteNumeric(468, "%s %s :Only servers may set channel mode +q", source->nick.c_str(), channel->name.c_str());
parameter.clear();
return MODEACTION_DENY;
}
}
void DisplayList(User* user, Channel* channel)
{
FounderProtectBase::DisplayList(user,channel);
}
};
/** Abstraction of FounderProtectBase for channel mode +a
*/
class ChanProtect : public ModeHandler, public FounderProtectBase
{
public:
ChanProtect(InspIRCd* Instance, char my_prefix, bool &depriv_self, bool &depriv_others)
: ModeHandler(Instance, 'a', 1, 1, true, MODETYPE_CHANNEL, false, my_prefix, 0, TR_NICK),
FounderProtectBase(Instance,"cm_protect_","protected user", 388, 389, depriv_self, depriv_others) { }
unsigned int GetPrefixRank()
{
return PROTECT_VALUE;
}
ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter)
{
return FounderProtectBase::ModeSet(source, dest, channel, parameter);
}
void RemoveMode(Channel* channel, irc::modestacker* stack)
{
FounderProtectBase::RemoveMode(channel, this->GetModeChar(), stack);
}
void RemoveMode(User* user, irc::modestacker* stack)
{
}
ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
{
User* theuser = FounderProtectBase::FindAndVerify(parameter, channel);
if (!theuser)
return MODEACTION_DENY;
std::string founder = "cm_founder_"+std::string(channel->name);
if ((!adding) && FounderProtectBase::CanRemoveOthers(source, theuser, channel))
{
return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
}
char isoverride=0;
Module *Override = ServerInstance->Modules->FindFeature("Override");
if (Override)
{
OVRrequest ovr(NULL,Override,source,"OTHERMODE");
const char * tmp = ovr.Send();
isoverride = tmp[0];
}
// source has +q, is a server, or ulined, we'll let them +-a the user.
if (source == ServerInstance->FakeClient ||
((source == theuser) && (!adding) && (FounderProtectBase::remove_own_privs)) ||
(ServerInstance->ULine(source->nick.c_str())) ||
(ServerInstance->ULine(source->server)) ||
(!*source->server) ||
(source->GetExt(founder)) ||
(!IS_LOCAL(source)) ||
isoverride
)
{
return FounderProtectBase::HandleChange(source, theuser, adding, channel, parameter);
}
else
{
// bzzzt, wrong answer!
source->WriteNumeric(482, "%s %s :You are not a channel founder", source->nick.c_str(), channel->name.c_str());
return MODEACTION_DENY;
}
}
virtual void DisplayList(User* user, Channel* channel)
{
FounderProtectBase::DisplayList(user, channel);
}
};
class ModuleChanProtect : public Module
{
bool FirstInGetsFounder;
char QPrefix;
char APrefix;
bool DeprivSelf;
bool DeprivOthers;
bool booting;
ChanProtect* cp;
ChanFounder* cf;
public:
ModuleChanProtect(InspIRCd* Me)
: Module(Me), FirstInGetsFounder(false), QPrefix(0), APrefix(0), DeprivSelf(false), DeprivOthers(false), booting(true), cp(NULL), cf(NULL)
{
/* Load config stuff */
LoadSettings();
booting = false;
/* Initialise module variables */
cp = new ChanProtect(ServerInstance, APrefix, DeprivSelf, DeprivOthers);
cf = new ChanFounder(ServerInstance, QPrefix, DeprivSelf, DeprivOthers);
if (!ServerInstance->Modes->AddMode(cp) || !ServerInstance->Modes->AddMode(cf))
{
delete cp;
delete cf;
throw ModuleException("Could not add new modes!");
}
Implementation eventlist[] = { I_OnUserKick, I_OnUserPart, I_OnUserPreJoin, I_OnAccessCheck };
ServerInstance->Modules->Attach(eventlist, this, 4);
}
virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
{
// 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));
}
virtual void OnUserPart(User* user, Channel* channel, std::string &partreason, bool &silent)
{
// 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));
}
void LoadSettings()
{
ConfigReader Conf(ServerInstance);
FirstInGetsFounder = Conf.ReadFlag("chanprotect", "noservices", 0);
std::string qpre = Conf.ReadValue("chanprotect", "qprefix", 0);
QPrefix = qpre.empty() ? 0 : qpre[0];
std::string apre = Conf.ReadValue("chanprotect", "aprefix", 0);
APrefix = apre.empty() ? 0 : apre[0];
if ((APrefix && QPrefix) && APrefix == QPrefix)
throw ModuleException("What the smeg, why are both your +q and +a prefixes the same character?");
if (cp && ServerInstance->Modes->FindPrefix(APrefix) == cp)
throw ModuleException("Looks like the +a prefix you picked for m_chanprotect is already in use. Pick another.");
if (cf && ServerInstance->Modes->FindPrefix(QPrefix) == cf)
throw ModuleException("Looks like the +q prefix you picked for m_chanprotect is already in use. Pick another.");
DeprivSelf = Conf.ReadFlag("chanprotect","deprotectself", "yes", 0);
DeprivOthers = Conf.ReadFlag("chanprotect","deprotectothers", "yes", 0);
}
virtual int 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 (FirstInGetsFounder && !chan)
privs = std::string(1, QPrefix) + "@";
return 0;
}
virtual int OnAccessCheck(User* source,User* dest,Channel* 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.
// don't allow action if:
// (A) Theyre founder (no matter what)
// (B) Theyre protected, unless you're founder or are protected and DeprivOthers is enabled
// 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.c_str())) || (ServerInstance->ULine(source->server)) || (!*source->server))
return ACR_ALLOW;
std::string founder("cm_founder_"+channel->name);
std::string protect("cm_protect_"+channel->name);
// Can do anything to yourself if deprotectself is enabled.
if (DeprivSelf && source == dest)
return ACR_DEFAULT;
bool candepriv_founder = (DeprivOthers && source->GetExt(founder));
bool candepriv_protected = (source->GetExt(founder) || (DeprivOthers && source->GetExt(protect))); // Can the source remove +a?
switch (access_type)
{
// a user has been deopped. Do we let them? hmmm...
case AC_DEOP:
if (dest->GetExt(founder) && !candepriv_founder)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't deop "+dest->nick+" as they're a channel founder");
return ACR_DENY;
}
if ((dest->GetExt(protect)) && !candepriv_protected)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't deop "+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:
if (dest->GetExt(founder) && !candepriv_founder)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't kick "+dest->nick+" as they're a channel founder");
return ACR_DENY;
}
if ((dest->GetExt(protect)) && !candepriv_protected)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't kick "+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) && !candepriv_founder)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't de-halfop "+dest->nick+" as they're a channel founder");
return ACR_DENY;
}
if ((dest->GetExt(protect)) && !candepriv_protected)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't de-halfop "+dest->nick+" as they're protected (+a)");
return ACR_DENY;
}
break;
// same with devoice.
case AC_DEVOICE:
if (dest->GetExt(founder) && !candepriv_founder)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't devoice "+dest->nick+" as they're a channel founder");
return ACR_DENY;
}
if ((dest->GetExt(protect)) && !candepriv_protected)
{
source->WriteNumeric(484, source->nick+" "+channel->name+" :Can't devoice "+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()
{
ServerInstance->Modes->DelMode(cp);
ServerInstance->Modes->DelMode(cf);
delete cp;
delete cf;
}
virtual Version GetVersion()
{
return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
}
};
MODULE_INIT(ModuleChanProtect)
