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         ExtensionItem(const std::string& key, Module* owner);
  42         virtual ~ExtensionItem();
  43         /** Serialize this item into a string
  44          *
  45          * @param format The format to serialize to
  46          * @param container The object containing this item
  47          * @param item The item itself
  48          */
  49         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const = 0;
  50         /** Convert the string form back into an item
  51          * @param format The format to serialize from (not FORMAT_USER)
  52          * @param container The object that this item applies to
  53          * @param value The return from a serialize() call that was run elsewhere with this key
  54          */
  55         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value) = 0;
  56         /** Free the item */
  57         virtual void free(void* item) = 0;
  58
  59  protected:
  60         /** Get the item from the internal map */
  61         void* get_raw(const Extensible* container) const;
  62         /** Set the item in the internal map; returns old value */
  63         void* set_raw(Extensible* container, void* value);
  64         /** Remove the item from the internal map; returns old value */
  65         void* unset_raw(Extensible* container);
  66 };
  67
  68 /** class Extensible is the parent class of many classes such as User and Channel.
  69  * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
  70  * a map associated with the object. In this way modules can store their own custom information within user
  71  * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
  72  * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
  73  * supports arbitary data storage).
  74  */
  75 class CoreExport Extensible : public classbase
  76 {
  77  public:
  78         typedef std::map<reference<ExtensionItem>,void*> ExtensibleStore;
  79
  80         // Friend access for the protected getter/setter
  81         friend class ExtensionItem;
  82  private:
  83         /** Private data store.
  84          * Holds all extensible metadata for the class.
  85          */
  86         ExtensibleStore extensions;
  87  public:
  88         /**
  89          * Get the extension items for iteraton (i.e. for metadata sync during netburst)
  90          */
  91         inline const ExtensibleStore& GetExtList() const { return extensions; }
  92
  93         Extensible();
  94         virtual CullResult cull();
  95         virtual ~Extensible();
  96         void doUnhookExtensions(const std::vector<reference<ExtensionItem> >& toRemove);
  97
  98         /**
  99          * Free all extension items attached to this Extensible
 100          */
 101         void FreeAllExtItems();
 102 };
 103
 104 class CoreExport ExtensionManager
 105 {
 106         std::map<std::string, reference<ExtensionItem> > types;
 107  public:
 108         bool Register(ExtensionItem* item);
 109         void BeginUnregister(Module* module, std::vector<reference<ExtensionItem> >& list);
 110         ExtensionItem* GetItem(const std::string& name);
 111 };
 112
 113 /** Base class for items that are NOT synchronized between servers */
 114 class CoreExport LocalExtItem : public ExtensionItem
 115 {
 116  public:
 117         LocalExtItem(const std::string& key, Module* owner);
 118         virtual ~LocalExtItem();
 119         virtual std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 120         virtual void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 121         virtual void free(void* item) = 0;
 122 };
 123
 124 template<typename T>
 125 class SimpleExtItem : public LocalExtItem
 126 {
 127  public:
 128         SimpleExtItem(const std::string& Key, Module* parent) : LocalExtItem(Key, parent)
 129         {
 130         }
 131
 132         virtual ~SimpleExtItem()
 133         {
 134         }
 135
 136         inline T* get(const Extensible* container) const
 137         {
 138                 return static_cast<T*>(get_raw(container));
 139         }
 140
 141         inline void set(Extensible* container, const T& value)
 142         {
 143                 T* ptr = new T(value);
 144                 T* old = static_cast<T*>(set_raw(container, ptr));
 145                 delete old;
 146         }
 147
 148         inline void set(Extensible* container, T* value)
 149         {
 150                 T* old = static_cast<T*>(set_raw(container, value));
 151                 delete old;
 152         }
 153
 154         inline void unset(Extensible* container)
 155         {
 156                 T* old = static_cast<T*>(unset_raw(container));
 157                 delete old;
 158         }
 159
 160         virtual void free(void* item)
 161         {
 162                 delete static_cast<T*>(item);
 163         }
 164 };
 165
 166 class CoreExport LocalStringExt : public SimpleExtItem<std::string>
 167 {
 168  public:
 169         LocalStringExt(const std::string& key, Module* owner);
 170         virtual ~LocalStringExt();
 171         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 172 };
 173
 174 class CoreExport LocalIntExt : public LocalExtItem
 175 {
 176  public:
 177         LocalIntExt(const std::string& key, Module* owner);
 178         virtual ~LocalIntExt();
 179         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 180         intptr_t get(const Extensible* container) const;
 181         intptr_t set(Extensible* container, intptr_t value);
 182         void free(void* item);
 183 };
 184
 185 class CoreExport StringExtItem : public ExtensionItem
 186 {
 187  public:
 188         StringExtItem(const std::string& key, Module* owner);
 189         virtual ~StringExtItem();
 190         std::string* get(const Extensible* container) const;
 191         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const;
 192         void unserialize(SerializeFormat format, Extensible* container, const std::string& value);
 193         void set(Extensible* container, const std::string& value);
 194         void unset(Extensible* container);
 195         void free(void* item);
 196 };