core/storagemanager.lua

   1
   2 local type, pairs = type, pairs;
   3 local setmetatable = setmetatable;
   4
   5 local config = require "core.configmanager";
   6 local datamanager = require "util.datamanager";
   7 local modulemanager = require "core.modulemanager";
   8 local multitable = require "util.multitable";
   9 local hosts = hosts;
  10 local log = require "util.logger".init("storagemanager");
  11
  12 local prosody = prosody;
  13
  14 local _ENV = nil;
  15
  16 local olddm = {}; -- maintain old datamanager, for backwards compatibility
  17 for k,v in pairs(datamanager) do olddm[k] = v; end
  18
  19 local null_storage_method = function () return false, "no data storage active"; end
  20 local null_storage_driver = setmetatable(
  21         {
  22                 name = "null",
  23                 open = function (self) return self; end
  24         }, {
  25                 __index = function (self, method) --luacheck: ignore 212
  26                         return null_storage_method;
  27                 end
  28         }
  29 );
  30
  31 local stores_available = multitable.new();
  32
  33 local function initialize_host(host)
  34         local host_session = hosts[host];
  35         host_session.events.add_handler("item-added/storage-provider", function (event)
  36                 local item = event.item;
  37                 stores_available:set(host, item.name, item);
  38         end);
  39
  40         host_session.events.add_handler("item-removed/storage-provider", function (event)
  41                 local item = event.item;
  42                 stores_available:set(host, item.name, nil);
  43         end);
  44 end
  45 prosody.events.add_handler("host-activated", initialize_host, 101);
  46
  47 local function load_driver(host, driver_name)
  48         if driver_name == "null" then
  49                 return null_storage_driver;
  50         end
  51         local driver = stores_available:get(host, driver_name);
  52         if driver then return driver; end
  53         local ok, err = modulemanager.load(host, "storage_"..driver_name);
  54         if not ok then
  55                 log("error", "Failed to load storage driver plugin %s on %s: %s", driver_name, host, err);
  56         end
  57         return stores_available:get(host, driver_name);
  58 end
  59
  60 local function get_storage_config(host)
  61         -- COMPAT w/ unreleased Prosody 0.10 and the once-experimental mod_storage_sql2 in peoples' config files
  62         local storage_config = config.get(host, "storage");
  63         local found_sql2;
  64         if storage_config == "sql2" then
  65                 storage_config, found_sql2 = "sql", true;
  66         elseif type(storage_config) == "table" then
  67                 for store_name, driver_name in pairs(storage_config) do
  68                         if driver_name == "sql2" then
  69                                 storage_config[store_name] = "sql";
  70                                 found_sql2 = true;
  71                         end
  72                 end
  73         end
  74         if found_sql2 then
  75                 log("error", "The temporary 'sql2' storage module has now been renamed to 'sql', please update your config file: https://prosody.im/doc/modules/mod_storage_sql2");
  76         end
  77         return storage_config;
  78 end
  79
  80 local function get_driver(host, store)
  81         local storage = get_storage_config(host);
  82         local driver_name;
  83         local option_type = type(storage);
  84         if option_type == "string" then
  85                 driver_name = storage;
  86         elseif option_type == "table" then
  87                 driver_name = storage[store];
  88         end
  89         if not driver_name then
  90                 driver_name = config.get(host, "default_storage") or "internal";
  91         end
  92
  93         local driver = load_driver(host, driver_name);
  94         if not driver then
  95                 log("warn", "Falling back to null driver for %s storage on %s", store, host);
  96                 driver_name = "null";
  97                 driver = null_storage_driver;
  98         end
  99         return driver, driver_name;
 100 end
 101
 102 local map_shim_mt = {
 103         __index = {
 104                 get = function(self, username, key)
 105                         local ret, err = self.keyval_store:get(username);
 106                         if ret == nil then return nil, err end
 107                         return ret[key];
 108                 end;
 109                 set = function(self, username, key, data)
 110                         local current, err = self.keyval_store:get(username);
 111                         if current == nil then
 112                                 if err then
 113                                         return nil, err;
 114                                 else
 115                                         current = {};
 116                                 end
 117                         end
 118                         current[key] = data;
 119                         return self.keyval_store:set(username, current);
 120                 end;
 121                 set_keys = function (self, username, keydatas)
 122                         local current, err = self.keyval_store:get(username);
 123                         if current == nil then
 124                                 if err then
 125                                         return nil, err;
 126                                 end
 127                                 current = {};
 128                         end
 129                         for k,v in pairs(keydatas) do
 130                                 if v == self.remove then v = nil; end
 131                                 current[k] = v;
 132                         end
 133                         return self.keyval_store:set(username, current);
 134                 end;
 135                 remove = {};
 136         };
 137 }
 138
 139 local open; -- forward declaration
 140
 141 local function create_map_shim(host, store)
 142         local keyval_store, err = open(host, store, "keyval");
 143         if keyval_store == nil then return nil, err end
 144         return setmetatable({
 145                 keyval_store = keyval_store;
 146         }, map_shim_mt);
 147 end
 148
 149 function open(host, store, typ)
 150         local driver, driver_name = get_driver(host, store);
 151         local ret, err = driver:open(store, typ);
 152         if not ret then
 153                 if err == "unsupported-store" then
 154                         if typ == "map" then -- Use shim on top of keyval store
 155                                 log("debug", "map storage driver unavailable, using shim on top of keyval store.");
 156                                 return create_map_shim(host, store);
 157                         end
 158                         log("debug", "Storage driver %s does not support store %s (%s), falling back to null driver",
 159                                 driver_name, store, typ or "<nil>");
 160                         ret = null_storage_driver;
 161                         err = nil;
 162                 end
 163         end
 164         return ret, err;
 165 end
 166
 167 local function purge(user, host)
 168         local storage = get_storage_config(host);
 169         if type(storage) == "table" then
 170                 -- multiple storage backends in use that we need to purge
 171                 local purged = {};
 172                 for store, driver_name in pairs(storage) do
 173                         if not purged[driver_name] then
 174                                 local driver = get_driver(host, store);
 175                                 if driver.purge then
 176                                         purged[driver_name] = driver:purge(user);
 177                                 else
 178                                         log("warn", "Storage driver %s does not support removing all user data, you may need to delete it manually", driver_name);
 179                                 end
 180                         end
 181                 end
 182         end
 183         get_driver(host):purge(user); -- and the default driver
 184
 185         olddm.purge(user, host); -- COMPAT list stores, like offline messages end up in the old datamanager
 186
 187         return true;
 188 end
 189
 190 function datamanager.load(username, host, datastore)
 191         return open(host, datastore):get(username);
 192 end
 193 function datamanager.store(username, host, datastore, data)
 194         return open(host, datastore):set(username, data);
 195 end
 196 function datamanager.users(host, datastore, typ)
 197         local driver = open(host, datastore, typ);
 198         if not driver.users then
 199                 return function() log("warn", "Storage driver %s does not support listing users", driver.name) end
 200         end
 201         return driver:users();
 202 end
 203 function datamanager.stores(username, host, typ)
 204         return get_driver(host):stores(username, typ);
 205 end
 206 function datamanager.purge(username, host)
 207         return purge(username, host);
 208 end
 209
 210 return {
 211         initialize_host = initialize_host;
 212         load_driver = load_driver;
 213         get_driver = get_driver;
 214         open = open;
 215         purge = purge;
 216
 217         olddm = olddm;
 218 };