]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_operprefix.cpp
Minor spelling errors in m_spanningtree.so
[user/henk/code/inspircd.git] / src / modules / m_operprefix.cpp
index 838cf5fcaa00ab6d5efb8b4e1e43f0c07f24445e..7d5e6d1181151f0cfae5c7b243205fed2d910248 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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/>.
  */
 
-/* 
-   by Chernov-Phoenix Alexey (Phoenix@RusNet) mailto:phoenix /email address separator/ pravmail.ru */
-
-#include "inspircd.h"
-
-static char prefixchar;
-
-std::set<std::string>* SetupExt(User* user)
-{
-       std::set<std::string>* ext;
-       if (!user->GetExt("m_operprefix",ext))
-       {
-               ext=new std::set<std::string>;
-               ext->clear();
-               user->Extend("m_operprefix",ext);
-       }
-       return ext;
-}
-
 
-void DelPrefixChan(User* user, Channel* channel)
-{
-       std::set<std::string>* chans = SetupExt(user);
-       chans->erase(channel->name);
-}
+/*
+ * Originally by Chernov-Phoenix Alexey (Phoenix@RusNet) mailto:phoenix /email address separator/ pravmail.ru
+ */
 
+/* $ModDesc: Gives opers cmode +y which provides a staff prefix. */
 
-void AddPrefixChan(User* user, Channel* channel)
-{
-       std::set<std::string>* chans = SetupExt(user);
-       chans->insert(channel->name);
-}
+#include "inspircd.h"
 
+#define OPERPREFIX_VALUE 1000000
 
 class OperPrefixMode : public ModeHandler
 {
        public:
-               OperPrefixMode(InspIRCd* Instance) : ModeHandler(Instance, 'y', 1, 1, true, MODETYPE_CHANNEL, false, prefixchar) { }
+               OperPrefixMode(Module* Creator) : ModeHandler(Creator, "operprefix", 'y', PARAM_ALWAYS, MODETYPE_CHANNEL)
+               {
+                       std::string pfx = ServerInstance->Config->ConfValue("operprefix")->getString("prefix", "!");
+                       list = true;
+                       prefix = pfx.empty() ? '!' : pfx[0];
+                       levelrequired = OPERPREFIX_VALUE;
+                       m_paramtype = TR_NICK;
+               }
 
-               ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode)
+               unsigned int GetPrefixRank()
                {
-                       if (servermode || (source && ServerInstance->ULine(source->server)))
+                       return OPERPREFIX_VALUE;
+               }
+
+               ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+               {
+                       if (IS_SERVER(source) || ServerInstance->ULine(source->server))
                                return MODEACTION_ALLOW;
                        else
                        {
-                               if (source && channel)
+                               if (channel)
                                        source->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :Only servers are permitted to change channel mode '%c'", source->nick.c_str(), channel->name.c_str(), 'y');
                                return MODEACTION_DENY;
                        }
                }
 
-               ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string &parameter)
+               bool NeedsOper() { return true; }
+
+               void RemoveMode(Channel* chan, irc::modestacker* stack)
                {
-                       User* x = ServerInstance->FindNick(parameter);
-                       if (x)
+                       irc::modestacker modestack(false);
+                       const UserMembList* users = chan->GetUsers();
+                       for (UserMembCIter i = users->begin(); i != users->end(); ++i)
                        {
-                               if (!channel->HasUser(x))
+                               if (i->second->hasMode(mode))
                                {
-                                       return std::make_pair(false, parameter);
-                               }
-                               else
-                               {
-                                       std::set<std::string>* ext;
-                                       if (x->GetExt("m_operprefix",ext))
-                                       {
-                                               if (ext->find(channel->name)!=ext->end())
-                                               {
-                                                       return std::make_pair(true, x->nick);
-                                               }
-                                               else
-                                                       return std::make_pair(false, parameter);
-                                       }
+                                       if (stack)
+                                               stack->Push(this->GetModeChar(), i->first->nick);
                                        else
-                                       {
-                                               return std::make_pair(false, parameter);
-                                       }
+                                               modestack.Push(this->GetModeChar(), i->first->nick);
                                }
                        }
-                       return std::make_pair(false, parameter);
+
+                       if (stack)
+                               return;
+
+                       std::deque<std::string> stackresult;
+                       std::vector<std::string> mode_junk;
+                       mode_junk.push_back(chan->name);
+                       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());
+                       }
                }
 
-               bool NeedsOper() { return true; }
+               void RemoveMode(User* user, irc::modestacker* stack)
+               {
+               }
+};
+
+class ModuleOperPrefixMode;
+class HideOperWatcher : public ModeWatcher
+{
+       ModuleOperPrefixMode* parentmod;
+ public:
+       HideOperWatcher(ModuleOperPrefixMode* parent) : ModeWatcher((Module*) parent, 'H', MODETYPE_USER), parentmod(parent) {}
+       void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type);
 };
 
 class ModuleOperPrefixMode : public Module
 {
  private:
-       OperPrefixMode* opm;
+       OperPrefixMode opm;
+       bool mw_added;
+       HideOperWatcher hideoperwatcher;
  public:
-       ModuleOperPrefixMode(InspIRCd* Me) : Module(Me)
+       ModuleOperPrefixMode()
+               : opm(this), mw_added(false), hideoperwatcher(this)
        {
-               ConfigReader Conf(ServerInstance);
-               std::string tmp;
-               tmp = Conf.ReadValue("operprefix", "prefix", "!", 0, false);
-               strlcpy(&prefixchar,tmp.c_str(),2);
-
-               opm = new OperPrefixMode(ServerInstance);
-               if ((!ServerInstance->Modes->AddMode(opm)))
-                       throw ModuleException("Could not add a new mode!");
-                       
-               Implementation eventlist[] = { I_OnPostJoin, I_OnCleanup, I_OnUserQuit, I_OnUserKick, I_OnUserPart };
-               ServerInstance->Modules->Attach(eventlist, this, 6);
        }
 
-       virtual void PushChanMode(Channel* channel, User* user, bool negate = false)
+       void init()
        {
-               if (negate)
-                       DelPrefixChan(user, channel);
-               else
-                       AddPrefixChan(user, channel);
-               char modeline[]="+y";
-               if (negate)
-                       modeline [0]='-';
-               std::vector<std::string> modechange;
-               modechange.push_back(channel->name);
-               modechange.push_back(modeline);
-               modechange.push_back(user->nick);
-               ServerInstance->SendMode(modechange,this->ServerInstance->FakeClient);
-       }
+               ServerInstance->Modules->AddService(opm);
 
-       virtual void OnPostJoin(User *user, Channel *channel)
-       {
-               // This may look wrong, but I don't think it is.. PushChanMode will send FMODE which should sort it all out.
-               if (!IS_LOCAL(user))
-                       return;
+               Implementation eventlist[] = { I_OnUserPreJoin, I_OnPostOper, I_OnLoadModule, I_OnUnloadModule, I_OnPostJoin };
+               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 
-               if (user && IS_OPER(user))
-               {
-                       if (user->IsModeSet('H'))
-                       {
-                               /* we respect your wish to be invisible */
-                               return;
-                       }
-                       PushChanMode(channel, user);
-               }
-       }
+               /* To give clients a chance to learn about the new prefix we don't give +y to opers
+                * right now. That means if the module was loaded after opers have joined channels
+                * they need to rejoin them in order to get the oper prefix.
+                */
 
-       // XXX: is there a better way to do this?
-       virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string &param, bool adding, int pcnt, bool servermode)
-       {
-               /* force event propagation to its ModeHandler */
-               if (!servermode && chan && (mode == 'y'))
-                       return ACR_ALLOW;
-               return 0;
+               if (ServerInstance->Modules->Find("m_hideoper.so"))
+                       mw_added = ServerInstance->Modes->AddModeWatcher(&hideoperwatcher);
        }
 
-       virtual ~ModuleOperPrefixMode()
+       ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string& privs, const std::string& keygiven)
        {
-               ServerInstance->Modes->DelMode(opm);
-               delete opm;
+               /* The user may have the +H umode on himself, but +H does not necessarily correspond
+                * to the +H of m_hideoper.
+                * However we only add the modewatcher when m_hideoper is loaded, so these
+                * conditions (mw_added and the user being +H) together mean the user is a hidden oper.
+                */
+
+               if (IS_OPER(user) && (!mw_added || !user->IsModeSet('H')))
+                       privs.push_back('y');
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual void CleanUser(User* user, bool quitting=false)
+       void OnPostJoin(Membership* memb)
        {
-               if (!IS_LOCAL(user))
+               if ((!IS_LOCAL(memb->user)) || (!IS_OPER(memb->user)) || (((mw_added) && (memb->user->IsModeSet('H')))))
                        return;
 
-               std::set<std::string>* ext;
-               if (user->GetExt("m_operprefix",ext))
-               {
-                       // Don't want to announce -mode when they're quitting anyway..
-                       if (!quitting)
-                       {
-                               for (UCListIter v = user->chans.begin(); v != user->chans.end(); v++)
-                               {
-                                       ModePair ms=opm->ModeSet(NULL, NULL , v->first, user->nick);
-                                       if (ms.first)
-                                       {
-                                               PushChanMode(v->first, user, true);
-                                       }
-                               }
-                       }
-                       ext->clear();
-                       delete ext;
-                       user->Shrink("m_operprefix");
-               }
+               if (memb->hasMode(opm.GetModeChar()))
+                       return;
+
+               // The user was force joined and OnUserPreJoin() did not run. Set the operprefix now.
+               std::vector<std::string> modechange;
+               modechange.push_back(memb->chan->name);
+               modechange.push_back("+y");
+               modechange.push_back(memb->user->nick);
+               ServerInstance->SendGlobalMode(modechange, ServerInstance->FakeClient);
        }
 
-       virtual void OnCleanup(int target_type, void* item)
+       void SetOperPrefix(User* user, bool add)
        {
-               if (target_type == TYPE_USER)
+               std::vector<std::string> modechange;
+               modechange.push_back("");
+               modechange.push_back(add ? "+y" : "-y");
+               modechange.push_back(user->nick);
+               for (UCListIter v = user->chans.begin(); v != user->chans.end(); v++)
                {
-                       User* user = (User*)item;
-                       CleanUser(user);
+                       modechange[0] = (*v)->name;
+                       ServerInstance->SendGlobalMode(modechange, ServerInstance->FakeClient);
                }
        }
 
-       virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+       void OnPostOper(User* user, const std::string& opername, const std::string& opertype)
        {
-               CleanUser(user,true);
+               if (IS_LOCAL(user) && (!mw_added || !user->IsModeSet('H')))
+                       SetOperPrefix(user, true);
        }
 
-       virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
+       void OnLoadModule(Module* mod)
        {
-               DelPrefixChan(user, chan);
+               if ((!mw_added) && (mod->ModuleSourceFile == "m_hideoper.so"))
+                       mw_added = ServerInstance->Modes->AddModeWatcher(&hideoperwatcher);
        }
 
-       virtual void OnUserPart(User* user, Channel* channel, std::string &partreason, bool &silent)
+       void OnUnloadModule(Module* mod)
        {
-               DelPrefixChan(user, channel);
+               if ((mw_added) && (mod->ModuleSourceFile == "m_hideoper.so") && (ServerInstance->Modes->DelModeWatcher(&hideoperwatcher)))
+                       mw_added = false;
        }
 
-       virtual Version GetVersion()
+       ~ModuleOperPrefixMode()
        {
-               return Version("$Id$", VF_COMMON, API_VERSION);
+               if (mw_added)
+                       ServerInstance->Modes->DelModeWatcher(&hideoperwatcher);
+       }
+
+       Version GetVersion()
+       {
+               return Version("Gives opers cmode +y which provides a staff prefix.", VF_VENDOR);
+       }
+
+       void Prioritize()
+       {
+               // m_opermodes may set +H on the oper to hide him, we don't want to set the oper prefix in that case
+               Module* opermodes = ServerInstance->Modules->Find("m_opermodes.so");
+               ServerInstance->Modules->SetPriority(this, I_OnPostOper, PRIORITY_AFTER, opermodes);
        }
 };
 
-MODULE_INIT(ModuleOperPrefixMode)
+void HideOperWatcher::AfterMode(User* source, User* dest, Channel* channel, const std::string& parameter, bool adding, ModeType type)
+{
+       // If hideoper is being unset because the user is deopering, don't set +y
+       if (IS_LOCAL(dest) && IS_OPER(dest))
+               parentmod->SetOperPrefix(dest, !adding);
+}
 
+MODULE_INIT(ModuleOperPrefixMode)