mode.h

/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2013-2016 Attila Molnar <[email protected]>
 *   Copyright (C) 2012-2013, 2017-2020 Sadie Powell <[email protected]>
 *   Copyright (C) 2012 Robby <[email protected]>
 *   Copyright (C) 2009 Daniel De Graaf <[email protected]>
 *   Copyright (C) 2008 Thomas Stagner <[email protected]>
 *   Copyright (C) 2007-2008 Robin Burchell <[email protected]>
 *   Copyright (C) 2007 Dennis Friis <[email protected]>
 *   Copyright (C) 2006-2008, 2010 Craig Edwards <[email protected]>
 *
 * 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/>.
 */
 
 
#pragma once
 
#include "ctables.h"
#include "modechange.h"
 
enum ModeType
{
        MODETYPE_USER = 0,
        MODETYPE_CHANNEL = 1
};
 
enum ModeAction
{
        MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
        MODEACTION_ALLOW = 1 /* Allow the mode */
};
 
enum PrefixModeValue
{
        /* +v */
        VOICE_VALUE     =       10000,
        /* +h */
        HALFOP_VALUE    =       20000,
        /* +o */
        OP_VALUE        =       30000
};
 
enum ParamSpec
{
        PARAM_NONE,
        PARAM_SETONLY,
        PARAM_ALWAYS
};
 
class PrefixMode;
class ListModeBase;
class ParamModeBase;
 
class CoreExport ModeHandler : public ServiceProvider
{
 public:
        typedef size_t Id;
 
        enum Class
        {
                MC_PREFIX,
                MC_LIST,
                MC_PARAM,
                MC_OTHER
        };
 
 private:
        Id modeid;
 
 protected:
        ParamSpec parameters_taken;
 
        char mode;
 
        bool oper;
 
        bool list;
 
        ModeType m_type;
 
        const Class type_id;
 
        unsigned int ranktoset;
 
        unsigned int ranktounset;
 
        std::string syntax;
 
 public:
        ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type, Class mclass = MC_OTHER);
        CullResult cull() CXX11_OVERRIDE;
        virtual ~ModeHandler();
 
        void RegisterService() CXX11_OVERRIDE;
 
        bool IsListMode() const { return list; }
 
        PrefixMode* IsPrefixMode();
 
        const PrefixMode* IsPrefixMode() const;
 
        ListModeBase* IsListModeBase();
 
        const ListModeBase* IsListModeBase() const;
 
        ParamModeBase* IsParameterMode();
 
        const ParamModeBase* IsParameterMode() const;
 
        inline ModeType GetModeType() const { return m_type; }
        inline bool NeedsOper() const { return oper; }
        bool NeedsParam(bool adding) const;
        char GetModeChar() const { return mode; }
 
        Id GetId() const { return modeid; }
 
        virtual std::string GetUserParameter(const User* user) const;
 
        virtual ModResult AccessCheck(User* source, Channel* channel, std::string &parameter, bool adding);
 
        virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
        virtual void DisplayList(User* user, Channel* channel);
 
        virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
 
        virtual void DisplayEmptyList(User* user, Channel* channel);
 
        virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
 
        void RemoveMode(User* user);
 
        virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist);
 
        inline unsigned int GetLevelRequired(bool adding) const
        {
                return adding ? ranktoset : ranktounset;
        }
 
        const std::string& GetSyntax() const { return syntax; }
 
        friend class ModeParser;
};
 
class CoreExport PrefixMode : public ModeHandler
{
 protected:
        char prefix;
 
        unsigned int prefixrank;
 
        bool selfremove;
 
 public:
        PrefixMode(Module* Creator, const std::string& Name, char ModeLetter, unsigned int Rank = 0, char PrefixChar = 0);
 
        ModResult AccessCheck(User* source, Channel* channel, std::string &parameter, bool adding) CXX11_OVERRIDE;
 
        ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& param, bool adding) CXX11_OVERRIDE;
 
        void Update(unsigned int rank, unsigned int setrank, unsigned int unsetrank, bool selfrm);
 
        void RemoveMode(Channel* channel, Modes::ChangeList& changelist) CXX11_OVERRIDE;
 
 
        bool CanSelfRemove() const { return selfremove; }
 
        char GetPrefix() const { return prefix; }
 
        unsigned int GetPrefixRank() const { return prefixrank; }
};
 
class CoreExport SimpleUserModeHandler : public ModeHandler
{
 public:
        SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false)
                : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER)
        {
                oper = operonly;
        }
 
        ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE;
};
 
class CoreExport SimpleChannelModeHandler : public ModeHandler
{
 public:
        SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false)
                : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL)
        {
                oper = operonly;
        }
 
        ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE;
};
 
class CoreExport ModeWatcher : public classbase
{
 private:
        const std::string mode;
 
        ModeType m_type;
 
 public:
        ModuleRef creator;
        ModeWatcher(Module* creator, const std::string& modename, ModeType type);
        virtual ~ModeWatcher();
 
        const std::string& GetModeName() const { return mode; }
 
        ModeType GetModeType() const { return m_type; }
 
        virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string& parameter, bool adding);
        virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string& parameter, bool adding);
};
 
class CoreExport ModeParser : public fakederef<ModeParser>
{
 public:
        static const ModeHandler::Id MODEID_MAX = 64;
 
        static const size_t MODE_PARAM_MAX = 250;
 
        typedef TR1NS::unordered_map<std::string, ModeHandler*, irc::insensitive, irc::StrHashComp> ModeHandlerMap;
 
 private:
        typedef insp::flat_multimap<std::string, ModeWatcher*> ModeWatcherMap;
 
        static const unsigned int MODETYPE_LAST = 2;
 
        ModeHandler* modehandlers[MODETYPE_LAST][128];
 
        ModeHandler* modehandlersbyid[MODETYPE_LAST][MODEID_MAX];
 
        ModeHandlerMap modehandlersbyname[MODETYPE_LAST];
 
        struct
        {
                std::vector<ListModeBase*> list;
 
                std::vector<PrefixMode*> prefix;
        } mhlist;
 
        ModeWatcherMap modewatchermap;
 
        Modes::ChangeList LastChangeList;
 
        ModeAction TryMode(User* user, User* targu, Channel* targc, Modes::Change& mcitem, bool SkipACL);
 
        ModeHandler::Id AllocateModeId(ModeType mt);
 
 public:
        typedef std::vector<ListModeBase*> ListModeList;
        typedef std::vector<PrefixMode*> PrefixModeList;
 
        typedef unsigned int ModeProcessFlag;
        enum ModeProcessFlags
        {
                MODE_NONE = 0,
 
                MODE_MERGE = 1,
 
                MODE_LOCALONLY = 2,
 
                MODE_CHECKACCESS = 4
        };
 
        ModeParser();
        ~ModeParser();
 
        static bool IsModeChar(char chr);
 
        static void CleanMask(std::string &mask);
 
        const Modes::ChangeList& GetLastChangeList() const { return LastChangeList; }
 
        void AddMode(ModeHandler* mh);
 
        bool DelMode(ModeHandler* mh);
 
        void AddModeWatcher(ModeWatcher* mw);
 
        bool DelModeWatcher(ModeWatcher* mw);
 
        void Process(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags = MODE_NONE);
 
        unsigned int ProcessSingle(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags = MODE_NONE, unsigned int beginindex = 0);
 
        void ModeParamsToChangeList(User* user, ModeType type, const std::vector<std::string>& parameters, Modes::ChangeList& changelist, unsigned int beginindex = 1, unsigned int endindex = UINT_MAX);
 
        ModeHandler* FindMode(const std::string& modename, ModeType mt);
 
        ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
 
        PrefixMode* FindPrefixMode(unsigned char modeletter);
 
        PrefixMode* FindPrefix(unsigned const char pfxletter);
 
        std::string GiveModeList(ModeType mt);
 
        std::string BuildPrefixes(bool lettersAndModes = true);
 
        const ListModeList& GetListModes() const { return mhlist.list; }
 
        const PrefixModeList& GetPrefixModes() const { return mhlist.prefix; }
 
        const ModeHandlerMap& GetModes(ModeType mt) const { return modehandlersbyname[mt]; }
 
        void ShowListModeList(User* user, Channel* chan, ModeHandler* mh);
};
 
inline PrefixMode* ModeHandler::IsPrefixMode()
{
        return (this->type_id == MC_PREFIX ? static_cast<PrefixMode*>(this) : NULL);
}
 
inline const PrefixMode* ModeHandler::IsPrefixMode() const
{
        return (this->type_id == MC_PREFIX ? static_cast<const PrefixMode*>(this) : NULL);
}
 
inline ListModeBase* ModeHandler::IsListModeBase()
{
        return (this->type_id == MC_LIST ? reinterpret_cast<ListModeBase*>(this) : NULL);
}
 
inline const ListModeBase* ModeHandler::IsListModeBase() const
{
        return (this->type_id == MC_LIST ? reinterpret_cast<const ListModeBase*>(this) : NULL);
}
 
inline ParamModeBase* ModeHandler::IsParameterMode()
{
        return (this->type_id == MC_PARAM ? reinterpret_cast<ParamModeBase*>(this) : NULL);
}
 
inline const ParamModeBase* ModeHandler::IsParameterMode() const
{
        return (this->type_id == MC_PARAM ? reinterpret_cast<const ParamModeBase*>(this) : NULL);
}