2 local type, pairs = type, pairs;
3 local setmetatable = setmetatable;
5 local config = require "core.configmanager";
6 local datamanager = require "util.datamanager";
7 local modulemanager = require "core.modulemanager";
8 local multitable = require "util.multitable";
10 local log = require "util.logger".init("storagemanager");
12 local prosody = prosody;
16 local olddm = {}; -- maintain old datamanager, for backwards compatibility
17 for k,v in pairs(datamanager) do olddm[k] = v; end
19 local null_storage_method = function () return false, "no data storage active"; end
20 local null_storage_driver = setmetatable(
23 open = function (self) return self; end
25 __index = function (self, method) --luacheck: ignore 212
26 return null_storage_method;
31 local stores_available = multitable.new();
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);
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);
45 prosody.events.add_handler("host-activated", initialize_host, 101);
47 local function load_driver(host, driver_name)
48 if driver_name == "null" then
49 return null_storage_driver;
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);
55 log("error", "Failed to load storage driver plugin %s on %s: %s", driver_name, host, err);
57 return stores_available:get(host, driver_name);
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");
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";
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");
77 return storage_config;
80 local function get_driver(host, store)
81 local storage = get_storage_config(host);
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];
89 if not driver_name then
90 driver_name = config.get(host, "default_storage") or "internal";
93 local driver = load_driver(host, driver_name);
95 log("warn", "Falling back to null driver for %s storage on %s", store, host);
97 driver = null_storage_driver;
99 return driver, driver_name;
102 local map_shim_mt = {
104 get = function(self, username, key)
105 local ret, err = self.keyval_store:get(username);
106 if ret == nil then return nil, err end
109 set = function(self, username, key, data)
110 local current, err = self.keyval_store:get(username);
111 if current == nil then
119 return self.keyval_store:set(username, current);
121 set_keys = function (self, username, keydatas)
122 local current, err = self.keyval_store:get(username);
123 if current == nil then
130 for k,v in pairs(keydatas) do
131 if v == self.remove then v = nil; end
135 return self.keyval_store:set(username, current);
141 local open; -- forward declaration
143 local function create_map_shim(host, store)
144 local keyval_store, err = open(host, store, "keyval");
145 if keyval_store == nil then return nil, err end
146 return setmetatable({
147 keyval_store = keyval_store;
151 function open(host, store, typ)
152 local driver, driver_name = get_driver(host, store);
153 local ret, err = driver:open(store, typ);
155 if err == "unsupported-store" then
156 if typ == "map" then -- Use shim on top of keyval store
157 log("debug", "map storage driver unavailable, using shim on top of keyval store.");
158 return create_map_shim(host, store);
160 log("debug", "Storage driver %s does not support store %s (%s), falling back to null driver",
161 driver_name, store, typ or "<nil>");
162 ret = null_storage_driver;
169 local function purge(user, host)
170 local storage = get_storage_config(host);
171 if type(storage) == "table" then
172 -- multiple storage backends in use that we need to purge
174 for store, driver_name in pairs(storage) do
175 if not purged[driver_name] then
176 local driver = get_driver(host, store);
178 purged[driver_name] = driver:purge(user);
180 log("warn", "Storage driver %s does not support removing all user data, you may need to delete it manually", driver_name);
185 get_driver(host):purge(user); -- and the default driver
187 olddm.purge(user, host); -- COMPAT list stores, like offline messages end up in the old datamanager
192 function datamanager.load(username, host, datastore)
193 return open(host, datastore):get(username);
195 function datamanager.store(username, host, datastore, data)
196 return open(host, datastore):set(username, data);
198 function datamanager.users(host, datastore, typ)
199 local driver = open(host, datastore, typ);
200 if not driver.users then
201 return function() log("warn", "storage driver %s does not support listing users", driver.name) end
203 return driver:users();
205 function datamanager.stores(username, host, typ)
206 return get_driver(host):stores(username, typ);
208 function datamanager.purge(username, host)
209 return purge(username, host);
213 initialize_host = initialize_host;
214 load_driver = load_driver;
215 get_driver = get_driver;