/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2013, 2017-2020 Sadie Powell * Copyright (C) 2012, 2014-2015 Attila Molnar * Copyright (C) 2012 Robby * Copyright (C) 2009 Daniel De Graaf * * 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 . */ #pragma once /** Base class for logic that extends an Extensible object. */ class CoreExport ExtensionItem : public ServiceProvider , public usecountbase { public: /** Types of Extensible that an ExtensionItem can apply to. */ enum ExtensibleType { /** The ExtensionItem applies to a User object. */ EXT_USER, /** The ExtensionItem applies to a Channel object. */ EXT_CHANNEL, /** The ExtensionItem applies to a Membership object. */ EXT_MEMBERSHIP }; /** The type of Extensible that this ExtensionItem applies to. */ const ExtensibleType type; /** Initializes an instance of the ExtensionItem class. * @param owner The module which created this ExtensionItem. * @param key The name of the extension item (e.g. ssl_cert). * @param exttype The type of Extensible that this ExtensionItem applies to. */ ExtensionItem(Module* owner, const std::string& key, ExtensibleType exttype); /** Destroys an instance of the ExtensionItem class. */ virtual ~ExtensionItem() = default; /** Sets an ExtensionItem using a value in the internal format. * @param container A container the ExtensionItem should be set on. * @param value A value in the internal format. */ virtual void FromInternal(Extensible* container, const std::string& value); /** Sets an ExtensionItem using a value in the network format. * @param container A container the ExtensionItem should be set on. * @param value A value in the network format. */ virtual void FromNetwork(Extensible* container, const std::string& value); /** Gets an ExtensionItem's value in a human-readable format. * @param container The container the ExtensionItem is set on. * @param item The value to convert to a human-readable format. * @return The value specified in \p item in a human readable format. */ virtual std::string ToHuman(const Extensible* container, void* item) const; /** Gets an ExtensionItem's value in the internal format. * @param container The container the ExtensionItem is set on. * @param item The value to convert to the internal format. * @return The value specified in \p item in the internal format. */ virtual std::string ToInternal(const Extensible* container, void* item) const ; /** Gets an ExtensionItem's value in the network format. * @param container The container the ExtensionItem is set on. * @param item The value to convert to the network format. * @return The value specified in \p item in the network format. */ virtual std::string ToNetwork(const Extensible* container, void* item) const; /** Deallocates the specified ExtensionItem value. * @param container The container that the ExtensionItem is set on. * @param item The item to deallocate. */ virtual void Delete(Extensible* container, void* item) = 0; /** Registers this object with the ExtensionManager. */ void RegisterService() override; protected: /** Retrieves the value for this ExtensionItem from the internal map. * @param container The container that the ExtensionItem is set on. * @return Either the value of this ExtensionItem or NULL if it is not set. */ void* GetRaw(const Extensible* container) const; /** Stores a value for this ExtensionItem in the internal map and returns the old value if one was set. * @param container A container the ExtensionItem should be set on. * @param value The value to set on the specified container. * @return Either the old value or NULL if one is not set. */ void* SetRaw(Extensible* container, void* value); /** Removes the value for this ExtensionItem from the internal map and returns it. * @param container A container the ExtensionItem should be removed from. * @return Either the old value or NULL if one is not set. */ void* UnsetRaw(Extensible* container); }; /** class Extensible is the parent class of many classes such as User and Channel. * class Extensible implements a system which allows modules to 'extend' the class by attaching data within * a map associated with the object. In this way modules can store their own custom information within user * objects, channel objects and server objects, without breaking other modules (this is more sensible than using * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and * supports arbitrary data storage). */ class CoreExport Extensible : public classbase , public Serializable { public: typedef insp::flat_map, void*> ExtensibleStore; // Friend access for the protected getter/setter friend class ExtensionItem; private: /** Private data store. * Holds all extensible metadata for the class. */ ExtensibleStore extensions; /** True if this Extensible has been culled. * A warning is generated if false on destruction. */ unsigned int culled:1; public: /** * Get the extension items for iteraton (i.e. for metadata sync during netburst) */ inline const ExtensibleStore& GetExtList() const { return extensions; } Extensible(); CullResult cull() override; virtual ~Extensible(); void UnhookExtensions(const std::vector>& toRemove); /** * Free all extension items attached to this Extensible */ void FreeAllExtItems(); /** @copydoc Serializable::Deserialize */ bool Deserialize(Data& data) override; /** @copydoc Serializable::Deserialize */ bool Serialize(Serializable::Data& data) override; }; class CoreExport ExtensionManager { public: typedef std::map > ExtMap; bool Register(ExtensionItem* item); void BeginUnregister(Module* module, std::vector >& list); ExtensionItem* GetItem(const std::string& name); /** Get all registered extensions keyed by their names * @return Const map of ExtensionItem pointers keyed by their names */ const ExtMap& GetExts() const { return types; } private: ExtMap types; }; /** Represents a simple ExtensionItem. */ template > class SimpleExtItem : public ExtensionItem { public: /** Initializes an instance of the SimpleExtItem class. * @param parent The module which created this SimpleExtItem. * @param Key The name of the extension item (e.g. ssl_cert). * @param exttype The type of Extensible that this SimpleExtItem applies to. */ SimpleExtItem(Module* parent, const std::string& Key, ExtensibleType exttype) : ExtensionItem(parent, Key, exttype) { } /** Destroys an instance of the SimpleExtItem class. */ virtual ~SimpleExtItem() = default; inline T* get(const Extensible* container) const { return static_cast(GetRaw(container)); } inline void set(Extensible* container, const T& value) { T* ptr = new T(value); T* old = static_cast(SetRaw(container, ptr)); Delete(container, old); } inline void set(Extensible* container, T* value) { T* old = static_cast(SetRaw(container, value)); Delete(container, old); } inline void unset(Extensible* container) { T* old = static_cast(UnsetRaw(container)); Delete(container, old); } void Delete(Extensible* container, void* item) override { Del del; del(static_cast(item)); } }; /** Encapsulates an ExtensionItem which has a string value. */ class CoreExport StringExtItem : public SimpleExtItem { protected: /** Whether to sync this StringExtItem across the network. */ bool synced; public: /** Initializes an instance of the StringExtItem class. * @param owner The module which created this StringExtItem. * @param key The name of the extension item (e.g. ssl_cert). * @param exttype The type of Extensible that this IntExtItem applies to. * @param sync Whether this StringExtItem should be broadcast to other servers. */ StringExtItem(Module* owner, const std::string& key, ExtensibleType exttype, bool sync = false); /** Destroys an instance of the StringExtItem class. */ virtual ~StringExtItem() = default; /** @copydoc ExtensionItem::FromInternal */ void FromInternal(Extensible* container, const std::string& value) override; /** @copydoc ExtensionItem::FromNetwork */ void FromNetwork(Extensible* container, const std::string& value) override; /** @copydoc ExtensionItem::ToInternal */ std::string ToInternal(const Extensible* container, void* item) const override; /** @copydoc ExtensionItem::ToNetwork */ std::string ToNetwork(const Extensible* container, void* item) const override; }; /** Encapsulates an ExtensionItem which has a integer value. */ class CoreExport IntExtItem : public ExtensionItem { protected: /** Whether to sync this IntExtItem across the network. */ bool synced; public: /** Initializes an instance of the IntExtItem class. * @param owner The module which created this IntExtItem. * @param key The name of the extension item (e.g. ssl_cert). * @param exttype The type of Extensible that this IntExtItem applies to. * @param sync Whether this IntExtItem should be broadcast to other servers. */ IntExtItem(Module* owner, const std::string& key, ExtensibleType exttype, bool sync = false); /** Destroys an instance of the IntExtItem class. */ virtual ~IntExtItem() = default; /** @copydoc ExtensionItem::Delete */ void Delete(Extensible* container, void* item) override; /** Retrieves the value for this IntExtItem. * @param container The container that the IntExtItem is set on. * @return Either the value of this IntExtItem or NULL if it is not set. */ intptr_t get(const Extensible* container) const; /** @copydoc ExtensionItem::FromInternal */ void FromInternal(Extensible* container, const std::string& value) override; /** @copydoc ExtensionItem::FromNetwork */ void FromNetwork(Extensible* container, const std::string& value) override; /** Sets a value for this IntExtItem. * @param container A container that the IntExtItem should be set on. */ void set(Extensible* container, intptr_t value); /** @copydoc ExtensionItem::ToInternal */ std::string ToInternal(const Extensible* container, void* item) const override; /** @copydoc ExtensionItem::ToNetwork */ std::string ToNetwork(const Extensible* container, void* item) const override; /** Removes the value for this IntExtItem. * @param container A container the ExtensionItem should be removed from. */ void unset(Extensible* container); };