clientprotocol.h

/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2018-2020 Sadie Powell <[email protected]>
 *   Copyright (C) 2018 Attila Molnar <[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 "event.h"
 
namespace ClientProtocol
{
        class EventHook;
        class MessageSource;
        struct RFCEvents;
        struct ParseOutput;
        class TagSelection;
}
 
struct ClientProtocol::ParseOutput
{
        std::string cmd;
 
        ClientProtocol::ParamList params;
 
        ClientProtocol::TagMap tags;
};
 
class ClientProtocol::TagSelection
{
        std::bitset<64> selection;
 
 public:
        bool IsSelected(const TagMap& tags, TagMap::const_iterator it) const
        {
                const size_t index = std::distance(tags.begin(), it);
                return ((index < selection.size()) && (selection[index]));
        }
 
        void Select(const TagMap& tags, TagMap::const_iterator it)
        {
                const size_t index = std::distance(tags.begin(), it);
                if (index < selection.size())
                        selection[index] = true;
        }
 
        bool operator==(const TagSelection& other) const
        {
                return (this->selection == other.selection);
        }
};
 
class ClientProtocol::MessageSource
{
        User* sourceuser;
        const std::string* sourcestr;
 
 public:
        MessageSource(User* Sourceuser = NULL)
        {
                SetSourceUser(Sourceuser);
        }
 
        MessageSource(const std::string& Sourcestr, User* Sourceuser = NULL)
        {
                SetSource(Sourcestr, Sourceuser);
        }
 
        const std::string* GetSource() const
        {
                // Return string if there's one explicitly set
                if (sourcestr)
                        return sourcestr;
                if (sourceuser)
                        return &sourceuser->GetFullHost();
                return NULL;
        }
 
        User* GetSourceUser() const { return sourceuser; }
 
        void SetSourceUser(User* Sourceuser)
        {
                sourceuser = Sourceuser;
                sourcestr = NULL;
        }
 
        void SetSource(const std::string& Sourcestr, User* Sourceuser = NULL)
        {
                sourcestr = &Sourcestr;
                sourceuser = Sourceuser;
        }
 
        void SetSource(const MessageSource& other)
        {
                sourcestr = other.sourcestr;
                sourceuser = other.sourceuser;
        }
};
 
class ClientProtocol::Message : public ClientProtocol::MessageSource
{
 public:
        struct SerializedInfo
        {
                const Serializer* serializer;
                TagSelection tagwl;
 
                SerializedInfo(const Serializer* Ser, const TagSelection& Tagwl)
                        : serializer(Ser)
                        , tagwl(Tagwl)
                {
                }
 
                bool operator==(const SerializedInfo& other) const
                {
                        return ((serializer == other.serializer) && (tagwl == other.tagwl));
                }
        };
 
        class Param
        {
                const std::string* ptr;
                insp::aligned_storage<std::string> str;
                bool owned;
 
                void InitFrom(const Param& other)
                {
                        owned = other.owned;
                        if (owned)
                                new(str) std::string(*other.str);
                        else
                                ptr = other.ptr;
                }
 
         public:
                operator const std::string&() const { return (owned ? *str : *ptr); }
 
                Param()
                        : ptr(NULL)
                        , owned(false)
                {
                }
 
                Param(const std::string& s)
                        : ptr(&s)
                        , owned(false)
                {
                }
 
                Param(int, const char* s)
                        : owned(true)
                {
                        new(str) std::string(s);
                }
 
                Param(int, const std::string& s)
                        : owned(true)
                {
                         new(str) std::string(s);
                }
 
                Param(const Param& other)
                {
                        InitFrom(other);
                }
 
                ~Param()
                {
                        using std::string;
                        if (owned)
                                str->~string();
                }
 
                Param& operator=(const Param& other)
                {
                        if (&other == this)
                                return *this;
 
                        using std::string;
                        if (owned)
                                str->~string();
                        InitFrom(other);
                        return *this;
                }
 
                bool IsOwned() const { return owned; }
        };
 
        typedef std::vector<Param> ParamList;
 
 private:
        typedef std::vector<std::pair<SerializedInfo, SerializedMessage> > SerializedList;
 
        ParamList params;
        TagMap tags;
        std::string command;
        bool msginit_done;
        mutable SerializedList serlist;
        bool sideeffect;
 
 protected:
        void SetCommand(const char* cmd)
        {
                command.clear();
                if (cmd)
                        command = cmd;
        }
 
 public:
        Message(const char* cmd, User* Sourceuser = NULL)
                : ClientProtocol::MessageSource(Sourceuser)
                , command(cmd ? cmd : std::string())
                , msginit_done(false)
                , sideeffect(false)
        {
                params.reserve(8);
                serlist.reserve(8);
        }
 
        Message(const char* cmd, const std::string& Sourcestr, User* Sourceuser = NULL)
                : ClientProtocol::MessageSource(Sourcestr, Sourceuser)
                , command(cmd ? cmd : std::string())
                , msginit_done(false)
                , sideeffect(false)
        {
                params.reserve(8);
                serlist.reserve(8);
        }
 
        const ParamList& GetParams() const { return params; }
 
        const TagMap& GetTags() const { return tags; }
 
        const char* GetCommand() const { return command.c_str(); }
 
        void PushParam(const char* str) { params.push_back(Param(0, str)); }
 
        void PushParam(const std::string& str) { params.push_back(Param(0, str)); }
 
        void PushParamRef(const std::string& str) { params.push_back(str); }
 
        void PushParamPlaceholder() { params.push_back(Param()); }
 
        void ReplaceParam(unsigned int index, const char* str) { params[index] = Param(0, str); }
 
        void ReplaceParam(unsigned int index, const std::string& str) { params[index] = Param(0, str); }
 
        void ReplaceParamRef(unsigned int index, const std::string& str) { params[index] = Param(str); }
 
        void AddTag(const std::string& tagname, MessageTagProvider* tagprov, const std::string& val, void* tagdata = NULL)
        {
                tags.insert(std::make_pair(tagname, MessageTagData(tagprov, val, tagdata)));
        }
 
        void AddTags(const ClientProtocol::TagMap& newtags)
        {
                tags.insert(newtags.begin(), newtags.end());
        }
 
        const SerializedMessage& GetSerialized(const SerializedInfo& serializeinfo) const;
 
        void ClearParams()
        {
                msginit_done = false;
                params.clear();
                tags.clear();
                InvalidateCache();
        }
 
        void InvalidateCache()
        {
                serlist.clear();
        }
 
        void CopyAll()
        {
                size_t j = 0;
                for (ParamList::iterator i = params.begin(); i != params.end(); ++i, j++)
                {
                        Param& curr = *i;
                        if (!curr.IsOwned())
                                ReplaceParam(j, curr);
                }
        }
 
        void SetSideEffect(bool Sideeffect) { sideeffect = Sideeffect; }
        bool IsSideEffect() const { return sideeffect; }
 
        friend class Serializer;
};
 
class ClientProtocol::Event
{
        EventProvider* event;
        Message* initialmsg;
        const MessageList* initialmsglist;
        bool eventinit_done;
 
 public:
        Event(EventProvider& protoeventprov)
                : event(&protoeventprov)
                , initialmsg(NULL)
                , initialmsglist(NULL)
                , eventinit_done(false)
        {
        }
 
        Event(EventProvider& protoeventprov, ClientProtocol::Message& msg)
                : event(&protoeventprov)
                , initialmsg(&msg)
                , initialmsglist(NULL)
                , eventinit_done(false)
        {
        }
 
        void SetMessage(Message* msg)
        {
                initialmsg = msg;
                initialmsglist = NULL;
        }
 
        void SetMessageList(const MessageList& msglist)
        {
                initialmsg = NULL;
                initialmsglist = &msglist;
        }
 
        void GetMessagesForUser(LocalUser* user, MessageList& messagelist);
};
 
class ClientProtocol::MessageTagEvent
        : public Events::ModuleEventProvider
{
 public:
        MessageTagEvent(Module* mod)
                : ModuleEventProvider(mod, "event/messagetag")
        {
        }
};
 
class ClientProtocol::MessageTagProvider : public Events::ModuleEventListener
{
 public:
        MessageTagProvider(Module* mod)
                : Events::ModuleEventListener(mod, "event/messagetag")
        {
        }
 
        virtual void OnPopulateTags(ClientProtocol::Message& msg)
        {
        }
 
        virtual ModResult OnProcessTag(User* user, const std::string& tagname, std::string& tagvalue)
        {
                return MOD_RES_PASSTHRU;
        }
 
        virtual bool ShouldSendTag(LocalUser* user, const MessageTagData& tagdata) = 0;
};
 
class ClientProtocol::EventHook : public Events::ModuleEventListener
{
 public:
        static std::string GetEventName(const std::string& name)
        {
                return "event/protoevent_" + name;
        }
 
        EventHook(Module* mod, const std::string& name, unsigned int priority = Events::ModuleEventListener::DefaultPriority)
                : Events::ModuleEventListener(mod, GetEventName(name), priority)
        {
        }
 
        virtual void OnEventInit(const ClientProtocol::Event& ev)
        {
        }
 
        virtual ModResult OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist) = 0;
};
 
class ClientProtocol::EventProvider : public Events::ModuleEventProvider
{
 public:
        EventProvider(Module* Mod, const std::string& eventname)
                : Events::ModuleEventProvider(Mod, ClientProtocol::EventHook::GetEventName(eventname))
        {
        }
};
 
struct ClientProtocol::RFCEvents
{
        EventProvider numeric;
        EventProvider join;
        EventProvider part;
        EventProvider kick;
        EventProvider quit;
        EventProvider nick;
        EventProvider mode;
        EventProvider topic;
        EventProvider privmsg;
        EventProvider invite;
        EventProvider ping;
        EventProvider pong;
        EventProvider error;
 
        RFCEvents()
                : numeric(NULL, "NUMERIC")
                , join(NULL, "JOIN")
                , part(NULL, "PART")
                , kick(NULL, "KICK")
                , quit(NULL, "QUIT")
                , nick(NULL, "NICK")
                , mode(NULL, "MODE")
                , topic(NULL, "TOPIC")
                , privmsg(NULL, "PRIVMSG")
                , invite(NULL, "INVITE")
                , ping(NULL, "PING")
                , pong(NULL, "PONG")
                , error(NULL, "ERROR")
        {
        }
};
 
class CoreExport ClientProtocol::Serializer : public DataProvider
{
 private:
        ClientProtocol::MessageTagEvent evprov;
 
        TagSelection MakeTagWhitelist(LocalUser* user, const TagMap& tagmap) const;
 
 public:
        Serializer(Module* mod, const char* Name);
 
        bool HandleTag(LocalUser* user, const std::string& tagname, std::string& tagvalue, TagMap& tags) const;
 
        const SerializedMessage& SerializeForUser(LocalUser* user, Message& msg);
 
        virtual std::string Serialize(const Message& msg, const TagSelection& tagwl) const = 0;
 
        virtual bool Parse(LocalUser* user, const std::string& line, ParseOutput& parseoutput) = 0;
};
 
inline ClientProtocol::MessageTagData::MessageTagData(MessageTagProvider* prov, const std::string& val, void* data)
        : tagprov(prov)
        , value(val)
        , provdata(data)
{
}