-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- 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.
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * 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/>.
*/
-using namespace std;
-#include <stdio.h>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
+#include "inspircd.h"
/* $ModDesc: Provides channel modes +a and +q */
-char fakevalue[] = "on";
+#define PROTECT_VALUE 40000
+#define FOUNDER_VALUE 50000
-class ModuleChanProtect : public Module
+struct ChanProtectSettings
{
- Server *Srv;
+ bool DeprivSelf;
+ bool DeprivOthers;
bool FirstInGetsFounder;
- ConfigReader *Conf;
-
+ bool booting;
+ ChanProtectSettings() : booting(true) {}
+};
+
+static ChanProtectSettings settings;
+
+/** Handles basic operation of +qa channel modes
+ */
+class FounderProtectBase
+{
+ private:
+ const std::string type;
+ const char mode;
+ const int list;
+ const int end;
public:
-
- ModuleChanProtect(Server* Me)
- : Module::Module(Me)
+ FounderProtectBase(char Mode, const std::string &mtype, int l, int e) :
+ type(mtype), mode(Mode), list(l), end(e)
{
-
- // here we initialise our module. Use new to create new instances of the required
- // classes.
-
- Srv = Me;
- Conf = new ConfigReader;
-
- // set up our modes. We're using listmodes and not normal extmodes here.
- // listmodes only need one parameter as everything else is assumed by the
- // nature of the mode thats being created.
- Srv->AddExtendedListMode('a');
- Srv->AddExtendedListMode('q');
-
- // read our config options (main config file)
- FirstInGetsFounder = Conf->ReadFlag("options","noservices",0);
}
- void Implements(char* List)
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
{
- List[I_On005Numeric] = List[I_OnUserKick] = List[I_OnUserPart] = List[I_OnRehash] = List[I_OnUserJoin] = List[I_OnAccessCheck] = List[I_OnExtendedMode] = List[I_OnSendList] = List[I_OnSyncChannel] = 1;
+ 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 (i->second->hasMode(mode))
+ {
+ if (stack)
+ stack->Push(mode, i->first->nick);
+ else
+ modestack.Push(mode, i->first->nick);
+ }
+ }
+
+ if (stack)
+ return;
+
+ while (modestack.GetStackedLine(stackresult))
+ {
+ 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());
+ }
}
-
- virtual void On005Numeric(std::string &output)
- {
- std::stringstream line(output);
- std::string temp1, temp2;
- while (!line.eof())
- {
- line >> temp1;
- if (temp1.substr(0,10) == "CHANMODES=")
- {
- // append the chanmode to the end
- temp1 = temp1.substr(10,temp1.length());
- temp1 = "CHANMODES=qa" + temp1;
- }
- temp2 = temp2 + temp1 + " ";
- }
- if (temp2.length())
- output = temp2.substr(0,temp2.length()-1);
- }
-
- virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason)
+
+ void DisplayList(User* user, Channel* channel)
{
- // 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));
+ const UserMembList* cl = channel->GetUsers();
+ for (UserMembCIter i = cl->begin(); i != cl->end(); ++i)
+ {
+ if (i->second->hasMode(mode))
+ {
+ 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());
}
- virtual void OnUserPart(userrec* user, chanrec* channel, std::string partreason)
+ bool CanRemoveOthers(User* u1, Channel* c)
{
- // 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));
+ Membership* m1 = c->GetUser(u1);
+ return (settings.DeprivOthers && m1 && m1->hasMode(mode));
}
+};
- virtual void OnRehash(std::string parameter)
+/** Abstraction of FounderProtectBase for channel mode +q
+ */
+class ChanFounder : public ModeHandler, public FounderProtectBase
+{
+ public:
+ ChanFounder(Module* Creator)
+ : ModeHandler(Creator, "founder", 'q', PARAM_ALWAYS, MODETYPE_CHANNEL),
+ FounderProtectBase('q', "founder", 386, 387)
{
- // on a rehash we delete our classes for good measure and create them again.
- delete Conf;
- Conf = new ConfigReader;
- // re-read our config options on a rehash
- FirstInGetsFounder = Conf->ReadFlag("options","noservices",0);
+ ModeHandler::list = true;
+ levelrequired = FOUNDER_VALUE;
+ m_paramtype = TR_NICK;
}
-
- virtual void OnUserJoin(userrec* user, chanrec* channel)
+
+ void setPrefix(int pfx)
{
- // 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 (Srv->CountUsers(channel) == 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.
- WriteServ(user->fd,"MODE %s +q %s",channel->name,user->nick);
- if (user->Extend("cm_founder_"+std::string(channel->name),fakevalue))
- {
- Srv->Log(DEBUG,"Marked user "+std::string(user->nick)+" as founder for "+std::string(channel->name));
- }
- }
- }
+ prefix = pfx;
}
-
- virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type)
+
+ unsigned int GetPrefixRank()
{
- // 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, 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 ((Srv->IsUlined(source->nick)) || (Srv->IsUlined(source->server)) || (!strcmp(source->server,"")))
- {
- return ACR_ALLOW;
- }
+ return FOUNDER_VALUE;
+ }
- switch (access_type)
- {
- // a user has been deopped. Do we let them? hmmm...
- case AC_DEOP:
- if (dest->GetExt("cm_founder_"+std::string(channel->name)))
- {
- Srv->SendServ(source->fd,"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;
- }
- if ((dest->GetExt("cm_protect_"+std::string(channel->name))) && (!source->GetExt("cm_protect_"+std::string(channel->name))))
- {
- Srv->SendServ(source->fd,"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:
- if (dest->GetExt("cm_founder_"+std::string(channel->name)))
- {
- Srv->SendServ(source->fd,"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("cm_protect_"+std::string(channel->name))) && (!source->GetExt("cm_protect_"+std::string(channel->name))))
- {
- Srv->SendServ(source->fd,"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("cm_founder_"+std::string(channel->name)))
- {
- Srv->SendServ(source->fd,"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("cm_protect_"+std::string(channel->name))) && (!source->GetExt("cm_protect_"+std::string(channel->name))))
- {
- Srv->SendServ(source->fd,"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("cm_founder_"+std::string(channel->name)))
- {
- Srv->SendServ(source->fd,"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("cm_protect_"+std::string(channel->name))) && (!source->GetExt("cm_protect_"+std::string(channel->name))))
- {
- Srv->SendServ(source->fd,"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;
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
+ {
+ FounderProtectBase::RemoveMode(channel, stack);
+ }
+
+ void RemoveMode(User* user, irc::modestacker* stack)
+ {
}
- virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms)
+ ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding)
{
- // not out mode, bail
- if ((modechar == 'q') && (type == MT_CHANNEL))
+ User* theuser = ServerInstance->FindNick(parameter);
+ // remove own privs?
+ if (source == theuser && !adding && settings.DeprivSelf)
+ return MOD_RES_ALLOW;
+
+ if (!adding && FounderProtectBase::CanRemoveOthers(source, channel))
{
- // set up parameters
- chanrec* chan = (chanrec*)target;
- userrec* theuser = Srv->FindNick(params[0]);
-
- // cant find the user given as the parameter, eat the mode change.
- if (!theuser)
- return -1;
-
- // given user isnt even on the channel, eat the mode change
- if (!Srv->IsOnChannel(theuser,chan))
- return -1;
-
- // source is a server, or ulined, we'll let them +-q the user.
- if ((Srv->IsUlined(user->nick)) || (Srv->IsUlined(user->server)) || (!strcmp(user->server,"")))
- {
- if (mode_on)
- {
- if (!theuser->GetExt("cm_founder_"+std::string(chan->name)))
- {
- theuser->Extend("cm_founder_"+std::string(chan->name),fakevalue);
- return 1;
- }
- }
- else
- {
- if (theuser->GetExt("cm_founder_"+std::string(chan->name)))
- {
- theuser->Shrink("cm_founder_"+std::string(chan->name));
- return 1;
- }
- }
-
- return -1;
- }
- else
- {
- // whoops, someones being naughty!
- WriteServ(user->fd,"468 %s %s :Only servers may set channel mode +q",user->nick, chan->name);
- return -1;
- }
+ return MOD_RES_PASSTHRU;
}
- if ((modechar == 'a') && (type == MT_CHANNEL))
+ else
{
- // set up parameters
- chanrec* chan = (chanrec*)target;
- userrec* theuser = Srv->FindNick(params[0]);
-
- // cant find the user given as the parameter, eat the mode change.
- if (!theuser)
- return -1;
-
- // given user isnt even on the channel, eat the mode change
- if (!Srv->IsOnChannel(theuser,chan))
- return -1;
-
- // source has +q, is a server, or ulined, we'll let them +-a the user.
- if ((Srv->IsUlined(user->nick)) || (Srv->IsUlined(user->server)) || (!strcmp(user->server,"")) || (user->GetExt("cm_founder_"+std::string(chan->name))))
- {
- if (mode_on)
- {
- if (!theuser->GetExt("cm_protect_"+std::string(chan->name)))
- {
- theuser->Extend("cm_protect_"+std::string(chan->name),fakevalue);
- return 1;
- }
- }
- else
- {
- if (theuser->GetExt("cm_protect_"+std::string(chan->name)))
- {
- theuser->Shrink("cm_protect_"+std::string(chan->name));
- return 1;
- }
- }
-
- return -1;
- }
- else
- {
- // bzzzt, wrong answer!
- WriteServ(user->fd,"482 %s %s :You are not a channel founder",user->nick, chan->name);
- return -1;
- }
+ source->WriteNumeric(468, "%s %s :Only servers may set channel mode +q", source->nick.c_str(), channel->name.c_str());
+ return MOD_RES_DENY;
}
- return 0;
}
- virtual void OnSendList(userrec* user, chanrec* channel, char mode)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
{
- if (mode == 'q')
- {
- chanuserlist cl = Srv->GetUsers(channel);
- for (unsigned int i = 0; i < cl.size(); i++)
- {
- if (cl[i]->GetExt("cm_founder_"+std::string(channel->name)))
- {
- WriteServ(user->fd,"386 %s %s %s",user->nick, channel->name,cl[i]->nick);
- }
- }
- WriteServ(user->fd,"387 %s %s :End of channel founder list",user->nick, channel->name);
- }
- if (mode == 'a')
- {
- chanuserlist cl = Srv->GetUsers(channel);
- for (unsigned int i = 0; i < cl.size(); i++)
- {
- if (cl[i]->GetExt("cm_protect_"+std::string(channel->name)))
- {
- WriteServ(user->fd,"388 %s %s %s",user->nick, channel->name,cl[i]->nick);
- }
- }
- WriteServ(user->fd,"389 %s %s :End of channel protected user list",user->nick, channel->name);
- }
+ return MODEACTION_ALLOW;
+ }
+ void DisplayList(User* user, Channel* channel)
+ {
+ FounderProtectBase::DisplayList(user,channel);
}
-
- virtual ~ModuleChanProtect()
+};
+
+/** Abstraction of FounderProtectBase for channel mode +a
+ */
+class ChanProtect : public ModeHandler, public FounderProtectBase
+{
+ public:
+ ChanProtect(Module* Creator)
+ : ModeHandler(Creator, "admin", 'a', PARAM_ALWAYS, MODETYPE_CHANNEL),
+ FounderProtectBase('a',"protected user", 388, 389)
{
- delete Conf;
+ ModeHandler::list = true;
+ levelrequired = PROTECT_VALUE;
+ m_paramtype = TR_NICK;
}
-
- virtual Version GetVersion()
+
+ void setPrefix(int pfx)
{
- return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
+ prefix = pfx;
}
-
- virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque)
+
+
+ unsigned int GetPrefixRank()
{
- // 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.
- chanuserlist cl = Srv->GetUsers(chan);
- string_list commands;
- for (unsigned int i = 0; i < cl.size(); i++)
+ return PROTECT_VALUE;
+ }
+
+ void RemoveMode(Channel* channel, irc::modestacker* stack)
+ {
+ FounderProtectBase::RemoveMode(channel, stack);
+ }
+
+ void RemoveMode(User* user, irc::modestacker* stack)
+ {
+ }
+
+ 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;
+
+ // removing own privs?
+ if (source == theuser && !adding && settings.DeprivSelf)
+ return MOD_RES_ALLOW;
+
+ if (!adding && FounderProtectBase::CanRemoveOthers(source, channel))
{
- if (cl[i]->GetExt("cm_founder_"+std::string(chan->name)))
- {
- proto->ProtoSendMode(opaque,TYPE_CHANNEL,chan,"+q "+std::string(cl[i]->nick));
- }
- if (cl[i]->GetExt("cm_protect_"+std::string(chan->name)))
- {
- proto->ProtoSendMode(opaque,TYPE_CHANNEL,chan,"+a "+std::string(cl[i]->nick));
- }
+ return MOD_RES_PASSTHRU;
+ }
+ else
+ {
+ source->WriteNumeric(482, "%s %s :You are not a channel founder", source->nick.c_str(), channel->name.c_str());
+ return MOD_RES_DENY;
}
}
-};
+ 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 ModuleChanProtectFactory : public ModuleFactory
+class ModuleChanProtect : public Module
{
+ ChanProtect cp;
+ ChanFounder cf;
public:
- ModuleChanProtectFactory()
+ ModuleChanProtect() : cp(this), cf(this)
{
}
-
- ~ModuleChanProtectFactory()
+
+ void init()
{
+ /* Load config stuff */
+ LoadSettings();
+ settings.booting = false;
+
+ ServerInstance->Modules->AddService(cf);
+ ServerInstance->Modules->AddService(cp);
+
+ Implementation eventlist[] = { I_OnUserPreJoin };
+ ServerInstance->Modules->Attach(eventlist, this, 1);
}
-
- virtual Module * CreateModule(Server* Me)
+
+ void LoadSettings()
{
- return new ModuleChanProtect(Me);
+ ConfigReader Conf;
+
+ settings.FirstInGetsFounder = Conf.ReadFlag("chanprotect", "noservices", 0);
+
+ std::string qpre = Conf.ReadValue("chanprotect", "qprefix", 0);
+ char QPrefix = qpre.empty() ? 0 : qpre[0];
+
+ std::string apre = Conf.ReadValue("chanprotect", "aprefix", 0);
+ char 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 (settings.booting)
+ {
+ if (APrefix && 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 (QPrefix && 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.");
+
+ 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';
-extern "C" void * init_module( void )
-{
- return new ModuleChanProtectFactory;
-}
+ return MOD_RES_PASSTHRU;
+ }
+
+ Version GetVersion()
+ {
+ return Version("Founder and Protect modes (+qa)", VF_VENDOR);
+ }
+};
+MODULE_INIT(ModuleChanProtect)