portmanager, s2smanager, sessionmanager, stanza_router, storagemanager, usermanager...
[prosody.git] / core / storagemanager.lua
index e0c12190bd4e9fdc70a5586af786cacd6ada8c93..0b6679d87c8acd237dcfcd2f92091e3f5c39bd06 100644 (file)
@@ -1,5 +1,5 @@
 
-local error, type = error, type;
+local type, pairs = type, pairs;
 local setmetatable = setmetatable;
 
 local config = require "core.configmanager";
@@ -9,52 +9,57 @@ local multitable = require "util.multitable";
 local hosts = hosts;
 local log = require "util.logger".init("storagemanager");
 
-local olddm = {}; -- maintain old datamanager, for backwards compatibility
-for k,v in pairs(datamanager) do olddm[k] = v; end
 local prosody = prosody;
 
 module("storagemanager")
 
-local default_driver_mt = { name = "internal" };
-default_driver_mt.__index = default_driver_mt;
-function default_driver_mt:open(store)
-       return setmetatable({ host = self.host, store = store }, default_driver_mt);
-end
-function default_driver_mt:get(user) return olddm.load(user, self.host, self.store); end
-function default_driver_mt:set(user, data) return olddm.store(user, self.host, self.store, data); end
+local olddm = {}; -- maintain old datamanager, for backwards compatibility
+for k,v in pairs(datamanager) do olddm[k] = v; end
+_M.olddm = olddm;
+
+local null_storage_method = function () return false, "no data storage active"; end
+local null_storage_driver = setmetatable(
+       {
+               name = "null",
+               open = function (self) return self; end
+       }, {
+               __index = function (self, method) --luacheck: ignore 212
+                       return null_storage_method;
+               end
+       }
+);
 
 local stores_available = multitable.new();
 
 function initialize_host(host)
        local host_session = hosts[host];
-       host_session.events.add_handler("item-added/data-driver", function (event)
+       host_session.events.add_handler("item-added/storage-provider", function (event)
                local item = event.item;
                stores_available:set(host, item.name, item);
        end);
-       
-       host_session.events.add_handler("item-removed/data-driver", function (event)
+
+       host_session.events.add_handler("item-removed/storage-provider", function (event)
                local item = event.item;
                stores_available:set(host, item.name, nil);
        end);
 end
 prosody.events.add_handler("host-activated", initialize_host, 101);
 
-local function load_driver(host, driver_name)
-       if not driver_name then
-               return;
+function load_driver(host, driver_name)
+       if driver_name == "null" then
+               return null_storage_driver;
        end
        local driver = stores_available:get(host, driver_name);
        if driver then return driver; end
-       if driver_name ~= "internal" then
-               modulemanager.load(host, "storage_"..driver_name);
-               return stores_available:get(host, driver_name);
-       else
-               return setmetatable({host = host}, default_driver_mt);
+       local ok, err = modulemanager.load(host, "storage_"..driver_name);
+       if not ok then
+               log("error", "Failed to load storage driver plugin %s on %s: %s", driver_name, host, err);
        end
+       return stores_available:get(host, driver_name);
 end
 
-function open(host, store, typ)
-       local storage = config.get(host, "core", "storage");
+function get_driver(host, store)
+       local storage = config.get(host, "storage");
        local driver_name;
        local option_type = type(storage);
        if option_type == "string" then
@@ -62,37 +67,69 @@ function open(host, store, typ)
        elseif option_type == "table" then
                driver_name = storage[store];
        end
-       
+       if not driver_name then
+               driver_name = config.get(host, "default_storage") or "internal";
+       end
+
        local driver = load_driver(host, driver_name);
        if not driver then
-               driver_name = config.get(host, "core", "default_storage");
-               driver = load_driver(host, driver_name);
-               if not driver then
-                       if storage or driver_name then
-                               log("warn", "Falling back to default driver for %s storage on %s", store, host);
-                       end
-                       driver_name = "internal";
-                       driver = load_driver(host, driver_name);
-               end
+               log("warn", "Falling back to null driver for %s storage on %s", store, host);
+               driver_name = "null";
+               driver = null_storage_driver;
        end
-       
+       return driver, driver_name;
+end
+
+function open(host, store, typ)
+       local driver, driver_name = get_driver(host, store);
        local ret, err = driver:open(store, typ);
        if not ret then
                if err == "unsupported-store" then
-                       log("debug", "Storage driver %s does not support store %s (%s), falling back to internal driver",
-                               driver_name, store, typ);
-                       ret = setmetatable({ host = host, store = store }, default_driver_mt); -- default to default driver
+                       log("debug", "Storage driver %s does not support store %s (%s), falling back to null driver",
+                               driver_name, store, typ or "<nil>");
+                       ret = null_storage_driver;
                        err = nil;
                end
        end
        return ret, err;
 end
 
+function purge(user, host)
+       local storage = config.get(host, "storage");
+       if type(storage) == "table" then
+               -- multiple storage backends in use that we need to purge
+               local purged = {};
+               for store, driver in pairs(storage) do
+                       if not purged[driver] then
+                               purged[driver] = get_driver(host, store):purge(user);
+                       end
+               end
+       end
+       get_driver(host):purge(user); -- and the default driver
+
+       olddm.purge(user, host); -- COMPAT list stores, like offline messages end up in the old datamanager
+
+       return true;
+end
+
 function datamanager.load(username, host, datastore)
        return open(host, datastore):get(username);
 end
 function datamanager.store(username, host, datastore, data)
        return open(host, datastore):set(username, data);
 end
+function datamanager.users(host, datastore, typ)
+       local driver = open(host, datastore, typ);
+       if not driver.users then
+               return function() log("warn", "storage driver %s does not support listing users", driver.name) end
+       end
+       return driver:users();
+end
+function datamanager.stores(username, host, typ)
+       return get_driver(host):stores(username, typ);
+end
+function datamanager.purge(username, host)
+       return purge(username, host);
+end
 
 return _M;