X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fextensible.h;h=2e7b83a28b3d90324577b68b151e0db75add6016;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=10e96d8752d80d04ca56519c7311acb0fa8c8629;hpb=d5e36aa2b2ca26fe689ae9e29c74b3565dd018c7;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/extensible.h b/include/extensible.h index 10e96d875..2e7b83a28 100644 --- a/include/extensible.h +++ b/include/extensible.h @@ -1,110 +1,210 @@ -class Extensible; -class Module; +/* + * 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 + +/** DEPRECATED: use {To,From}{Human,Internal,Network} instead. */ enum SerializeFormat { - /** Shown to a human (does not need to be unserializable) */ FORMAT_USER, - /** Passed internally to this process (i.e. for /RELOADMODULE) */ FORMAT_INTERNAL, - /** Passed to other servers on the network (i.e. METADATA s2s command) */ FORMAT_NETWORK, - /** Stored on disk (i.e. permchannel database) */ FORMAT_PERSIST }; -/** Class represnting an extension of some object - */ -class CoreExport ExtensionItem +/** Base class for logic that extends an Extensible object. */ +class CoreExport ExtensionItem : public ServiceProvider, public usecountbase { public: - const std::string key; - Module* const owner; - ExtensionItem(const std::string& key, Module* owner); + /** 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 key The name of the extension item (e.g. ssl_cert). + * @param exttype The type of Extensible that this ExtensionItem applies to. + * @param owner The module which created this ExtensionItem. + */ + ExtensionItem(const std::string& key, ExtensibleType exttype, Module* owner); + + /** Destroys an instance of the ExtensionItem class. */ virtual ~ExtensionItem(); - /** Serialize this item into a string - * - * @param format The format to serialize to - * @param container The object containing this item - * @param item The item itself + + /** 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 std::string serialize(SerializeFormat format, const Extensible* container, void* item) = 0; - /** Convert the string form back into an item - * @param format The format to serialize from (not FORMAT_USER) - * @param container The object that this item applies to - * @param value The return from a serialize() call that was run elsewhere with this key + 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 unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0; - /** Free the item */ - virtual void free(void* item) = 0; + 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 free(Extensible* container, void* item) = 0; + + /** Registers this object with the ExtensionManager. */ + void RegisterService() CXX11_OVERRIDE; + + /** DEPRECATED: use To{Human,Internal,Network} instead. */ + DEPRECATED_METHOD(virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const); + + /** DEPRECATED: use From{Internal,Network} instead. */ + DEPRECATED_METHOD(virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value)); protected: - /** Get the item from the internal map */ - void* get_raw(const Extensible* container); - /** Set the item in the internal map; returns old value */ + /** 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* get_raw(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* set_raw(Extensible* container, void* value); - /** Remove the item from the internal map; returns old 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* unset_raw(Extensible* container); }; -/** A private data store for an Extensible class */ -typedef std::map ExtensibleStore; - /** 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 arbitary data storage). + * supports arbitrary data storage). */ -class CoreExport Extensible : public classbase +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; - typedef std::map ExtensibleTypes; - static ExtensibleTypes extension_types; + + /** 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; } - static inline const ExtensibleTypes& GetTypeList() { return extension_types; } - static inline ExtensionItem* GetItem(const std::string& name) - { - ExtensibleTypes::iterator i = extension_types.find(name); - if (i == extension_types.end()) - return NULL; - return i->second; - } + Extensible(); + CullResult cull() CXX11_OVERRIDE; virtual ~Extensible(); + void doUnhookExtensions(const std::vector >& toRemove); + + /** + * Free all extension items attached to this Extensible + */ + void FreeAllExtItems(); - static bool Register(ExtensionItem* item); - static std::vector BeginUnregister(Module* module); - void doUnhookExtensions(const std::vector& toRemove); + /** @copydoc Serializable::Deserialize */ + bool Deserialize(Data& data) CXX11_OVERRIDE; - // Friend access for the protected getter/setter - friend class ExtensionItem; + /** @copydoc Serializable::Deserialize */ + bool Serialize(Serializable::Data& data) CXX11_OVERRIDE; }; -/** Base class for items that are NOT synchronized between servers */ -class CoreExport LocalExtItem : public ExtensionItem +class CoreExport ExtensionManager { public: - LocalExtItem(const std::string& key, Module* owner); - virtual ~LocalExtItem(); - virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item); - virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value); - virtual void free(void* item) = 0; + 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; }; -template -class CoreExport SimpleExtItem : public LocalExtItem +/** DEPRECATED: use ExtensionItem instead. */ +typedef ExtensionItem LocalExtItem; + +template > +class SimpleExtItem : public ExtensionItem { public: - SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent) + SimpleExtItem(const std::string& Key, ExtensibleType exttype, Module* parent) + : ExtensionItem(Key, exttype, parent) { } @@ -112,75 +212,68 @@ class CoreExport SimpleExtItem : public LocalExtItem { } - inline T* get(const Extensible* container) + inline T* get(const Extensible* container) const { return static_cast(get_raw(container)); } - inline T* getNew(Extensible* container) - { - T* ptr = get(container); - if (!ptr) - { - ptr = new T; - set_raw(container, ptr); - } - return ptr; - } - inline void set(Extensible* container, const T& value) { T* ptr = new T(value); T* old = static_cast(set_raw(container, ptr)); - delete old; + free(container, old); } inline void set(Extensible* container, T* value) { T* old = static_cast(set_raw(container, value)); - delete old; + free(container, old); } inline void unset(Extensible* container) { T* old = static_cast(unset_raw(container)); - delete old; + free(container, old); } - virtual void free(void* item) + void free(Extensible* container, void* item) CXX11_OVERRIDE { - delete static_cast(item); + Del del; + del(static_cast(item)); } }; class CoreExport LocalStringExt : public SimpleExtItem { public: - LocalStringExt(const std::string& key, Module* owner); + LocalStringExt(const std::string& key, ExtensibleType exttype, Module* owner); virtual ~LocalStringExt(); - std::string serialize(SerializeFormat format, const Extensible* container, void* item); + std::string ToInternal(const Extensible* container, void* item) const CXX11_OVERRIDE; + void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE; }; -class CoreExport LocalIntExt : public LocalExtItem +class CoreExport LocalIntExt : public ExtensionItem { public: - LocalIntExt(const std::string& key, Module* owner); + LocalIntExt(const std::string& key, ExtensibleType exttype, Module* owner); virtual ~LocalIntExt(); - std::string serialize(SerializeFormat format, const Extensible* container, void* item); - intptr_t get(const Extensible* container); + std::string ToInternal(const Extensible* container, void* item) const CXX11_OVERRIDE; + void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE; + intptr_t get(const Extensible* container) const; intptr_t set(Extensible* container, intptr_t value); - void free(void* item); + void unset(Extensible* container) { set(container, 0); } + void free(Extensible* container, void* item) CXX11_OVERRIDE; }; class CoreExport StringExtItem : public ExtensionItem { public: - StringExtItem(const std::string& key, Module* owner); + StringExtItem(const std::string& key, ExtensibleType exttype, Module* owner); virtual ~StringExtItem(); - std::string* get(const Extensible* container); - std::string serialize(SerializeFormat format, const Extensible* container, void* item); - void unserialize(SerializeFormat format, Extensible* container, const std::string& value); + std::string* get(const Extensible* container) const; + std::string ToNetwork(const Extensible* container, void* item) const CXX11_OVERRIDE; + void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE; void set(Extensible* container, const std::string& value); void unset(Extensible* container); - void free(void* item); + void free(Extensible* container, void* item) CXX11_OVERRIDE; };