X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fextensible.h;h=f327cf75c0144dbef88afbe0a92de4504c1d936b;hb=74ee9af96639323d852a8b15be72ee9974e0a826;hp=0a33470b51ccabd9c5bf4b4cd38b58c41ca501d0;hpb=6d57bbe05c31c79eaad02fe81cfb9c1ed6b79c58;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/extensible.h b/include/extensible.h index 0a33470b5..f327cf75c 100644 --- a/include/extensible.h +++ b/include/extensible.h @@ -1,33 +1,71 @@ -class Extensible; -class Module; +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * 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 . + */ + + +#ifndef EXTENSIBLE_H +#define EXTENSIBLE_H + +#include + +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 +class CoreExport ExtensionItem : public ServiceProvider, public usecountbase { public: - const std::string key; - Module* const owner; ExtensionItem(const std::string& key, Module* owner); - /** Serialize this item into a string */ - virtual std::string serialize(Module* requestor, const Extensible* container, void* item) = 0; - /** Convert the string form back into an item */ - virtual void unserialize(Module* requestor, Extensible* container, const std::string& value) = 0; + 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 + */ + virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const = 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 unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0; /** Free the item */ virtual void free(void* item) = 0; protected: /** Get the item from the internal map */ - void* get_raw(const Extensible* container); + void* get_raw(const Extensible* container) const; /** Set the item in the internal map; returns old value */ void* set_raw(Extensible* container, void* value); /** Remove the item from the internal map; returns old value */ 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 @@ -37,33 +75,35 @@ typedef std::map ExtensibleStore; */ class CoreExport Extensible : public classbase { + public: + typedef std::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; 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(); + virtual CullResult cull(); virtual ~Extensible(); + void doUnhookExtensions(const std::vector >& toRemove); +}; - static bool Register(ExtensionItem* item); - static void UnRegister(Module* module); - - // Friend access for the protected getter/setter - friend class ExtensionItem; +class CoreExport ExtensionManager +{ + std::map > types; + public: + void Register(ExtensionItem* item); + void BeginUnregister(Module* module, std::vector >& list); + ExtensionItem* GetItem(const std::string& name); }; /** Base class for items that are NOT synchronized between servers */ @@ -71,34 +111,27 @@ class CoreExport LocalExtItem : public ExtensionItem { public: LocalExtItem(const std::string& key, Module* owner); - // this is deliberately NOT virtual; don't subclass LocalExtItem if you want to sync data! - std::string serialize(Module* requestor, const Extensible* container, void* item); - void unserialize(Module* requestor, Extensible* container, const std::string& value); + virtual ~LocalExtItem(); + virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; + virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value); virtual void free(void* item) = 0; }; template -class CoreExport SimpleExtItem : public LocalExtItem +class SimpleExtItem : public LocalExtItem { public: SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent) { } - inline T* get(const Extensible* container) + virtual ~SimpleExtItem() { - return static_cast(get_raw(container)); } - inline T* getNew(Extensible* container) + inline T* get(const Extensible* container) const { - T* ptr = get(container); - if (!ptr) - { - ptr = new T; - set_raw(container, ptr); - } - return ptr; + return static_cast(get_raw(container)); } inline void set(Extensible* container, const T& value) @@ -126,13 +159,21 @@ class CoreExport SimpleExtItem : public LocalExtItem } }; -typedef SimpleExtItem LocalStringExt; +class CoreExport LocalStringExt : public SimpleExtItem +{ + public: + LocalStringExt(const std::string& key, Module* owner); + virtual ~LocalStringExt(); + std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; +}; class CoreExport LocalIntExt : public LocalExtItem { public: LocalIntExt(const std::string& key, Module* owner); - intptr_t get(const Extensible* container); + virtual ~LocalIntExt(); + std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; + intptr_t get(const Extensible* container) const; intptr_t set(Extensible* container, intptr_t value); void free(void* item); }; @@ -141,10 +182,13 @@ class CoreExport StringExtItem : public ExtensionItem { public: StringExtItem(const std::string& key, Module* owner); - std::string* get(const Extensible* container); - std::string serialize(Module* requestor, const Extensible* container, void* item); - void unserialize(Module* requestor, Extensible* container, const std::string& value); + virtual ~StringExtItem(); + std::string* get(const Extensible* container) const; + std::string serialize(SerializeFormat format, const Extensible* container, void* item) const; + void unserialize(SerializeFormat format, Extensible* container, const std::string& value); void set(Extensible* container, const std::string& value); void unset(Extensible* container); void free(void* item); }; + +#endif