include/extensible.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 #include <stdint.h>
  23
  24 enum SerializeFormat
  25 {
  26         /** Shown to a human (does not need to be unserializable) */
  27         FORMAT_USER,
  28         /** Passed internally to this process (i.e. for /RELOADMODULE) */
  29         FORMAT_INTERNAL,
  30         /** Passed to other servers on the network (i.e. METADATA s2s command) */
  31         FORMAT_NETWORK,
  32         /** Stored on disk (i.e. permchannel database) */
  33         FORMAT_PERSIST
  34 };
  35
  36 /** Class represnting an extension of some object
  37  */
  38 class CoreExport ExtensionItem : public ServiceProvider, public usecountbase
  39 {
  40  public:
  41     /** Extensible subclasses
  42      */
  43         enum ExtensibleType
  44         {
  45                 EXT_USER,
  46                 EXT_CHANNEL,
  47                 EXT_MEMBERSHIP
  48         };
  49
  50         /** Type (subclass) of Extensible that this ExtensionItem is valid for
  51          */
  52         const ExtensibleType type;
  53
  54         ExtensionItem(const std::string& key, ExtensibleType exttype, Module* owner);
  55         virtual ~ExtensionItem();
  56         /** Serialize this item into a string
  57          *
  58          * @param format The format to serialize to
  59          * @param container The object containing this item
  60          * @param item The item itself
  61          */
  62         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const = 0;
  63         /** Convert the string form back into an item
  64          * @param format The format to serialize from (not FORMAT_USER)
  65          * @param container The object that this item applies to
  66          * @param value The return from a serialize() call that was run elsewhere with this key
  67          */
  68         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0;
  69         /** Free the item */
  70         virtual void free(void* item) = 0;
  71
  72  protected:
  73         /** Get the item from the internal map */
  74         void* get_raw(const Extensible* container) const;
  75         /** Set the item in the internal map; returns old value */
  76         void* set_raw(Extensible* container, void* value);
  77         /** Remove the item from the internal map; returns old value */
  78         void* unset_raw(Extensible* container);
  79 };
  80
  81 /** class Extensible is the parent class of many classes such as User and Channel.
  82  * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
  83  * a map associated with the object. In this way modules can store their own custom information within user
  84  * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
  85  * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
  86  * supports arbitary data storage).
  87  */
  88 class CoreExport Extensible : public classbase
  89 {
  90  public:
  91         typedef insp::flat_map<reference<ExtensionItem>, void*> ExtensibleStore;
  92
  93         // Friend access for the protected getter/setter
  94         friend class ExtensionItem;
  95  private:
  96         /** Private data store.
  97          * Holds all extensible metadata for the class.
  98          */
  99         ExtensibleStore extensions;
 100
 101         /** True if this Extensible has been culled.
 102          * A warning is generated if false on destruction.
 103          */
 104         unsigned int culled:1;
 105  public:
 106         /**
 107          * Get the extension items for iteraton (i.e. for metadata sync during netburst)
 108          */
 109         inline const ExtensibleStore& GetExtList() const { return extensions; }
 110
 111         Extensible();
 112         virtual CullResult cull();
 113         virtual ~Extensible();
 114         void doUnhookExtensions(const std::vector<reference<ExtensionItem> >& toRemove);
 115
 116         /**
 117          * Free all extension items attached to this Extensible
 118          */
 119         void FreeAllExtItems();
 120 };
 121
 122 class CoreExport ExtensionManager
 123 {
 124  public:
 125         typedef std::map<std::string, reference<ExtensionItem> > ExtMap;
 126
 127         bool Register(ExtensionItem* item);
 128         void BeginUnregister(Module* module, std::vector<reference<ExtensionItem> >& list);
 129         ExtensionItem* GetItem(const std::string& name);
 130
 131         /** Get all registered extensions keyed by their names
 132          * @return Const map of ExtensionItem pointers keyed by their names
 133          */
 134         const ExtMap& GetExts() const { return types; }
 135
 136  private:
 137         ExtMap types;
 138 };
 139
 140 /** Base class for items that are NOT synchronized between servers */
 141 class CoreExport LocalExtItem : public ExtensionItem
 142 {
 143  public:
 144         LocalExtItem(const std::string& key, ExtensibleType exttype, Module* owner);
 145         virtual ~LocalExtItem();
 146         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 147         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 148         virtual void free(void* item) = 0;
 149 };
 150
 151 template <typename T, typename Del = stdalgo::defaultdeleter<T> >
 152 class SimpleExtItem : public LocalExtItem
 153 {
 154  public:
 155         SimpleExtItem(const std::string& Key, ExtensibleType exttype, Module* parent)
 156                 : LocalExtItem(Key, exttype, parent)
 157         {
 158         }
 159
 160         virtual ~SimpleExtItem()
 161         {
 162         }
 163
 164         inline T* get(const Extensible* container) const
 165         {
 166                 return static_cast<T*>(get_raw(container));
 167         }
 168
 169         inline void set(Extensible* container, const T& value)
 170         {
 171                 T* ptr = new T(value);
 172                 T* old = static_cast<T*>(set_raw(container, ptr));
 173                 Del del;
 174                 del(old);
 175         }
 176
 177         inline void set(Extensible* container, T* value)
 178         {
 179                 T* old = static_cast<T*>(set_raw(container, value));
 180                 Del del;
 181                 del(old);
 182         }
 183
 184         inline void unset(Extensible* container)
 185         {
 186                 T* old = static_cast<T*>(unset_raw(container));
 187                 Del del;
 188                 del(old);
 189         }
 190
 191         virtual void free(void* item)
 192         {
 193                 Del del;
 194                 del(static_cast<T*>(item));
 195         }
 196 };
 197
 198 class CoreExport LocalStringExt : public SimpleExtItem<std::string>
 199 {
 200  public:
 201         LocalStringExt(const std::string& key, ExtensibleType exttype, Module* owner);
 202         virtual ~LocalStringExt();
 203         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 204         void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 205 };
 206
 207 class CoreExport LocalIntExt : public LocalExtItem
 208 {
 209  public:
 210         LocalIntExt(const std::string& key, ExtensibleType exttype, Module* owner);
 211         virtual ~LocalIntExt();
 212         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 213         void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 214         intptr_t get(const Extensible* container) const;
 215         intptr_t set(Extensible* container, intptr_t value);
 216         void unset(Extensible* container) { set(container, 0); }
 217         void free(void* item);
 218 };
 219
 220 class CoreExport StringExtItem : public ExtensionItem
 221 {
 222  public:
 223         StringExtItem(const std::string& key, ExtensibleType exttype, Module* owner);
 224         virtual ~StringExtItem();
 225         std::string* get(const Extensible* container) const;
 226         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 227         void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 228         void set(Extensible* container, const std::string& value);
 229         void unset(Extensible* container);
 230         void free(void* item);
 231 };