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;
14 module("storagemanager")
16 local olddm = {}; -- maintain old datamanager, for backwards compatibility
17 for k,v in pairs(datamanager) do olddm[k] = v; end
20 local null_storage_method = function () return false, "no data storage active"; end
21 local null_storage_driver = setmetatable(
24 open = function (self) return self; end
26 __index = function (self, method)
27 return null_storage_method;
32 local stores_available = multitable.new();
34 function initialize_host(host)
35 local host_session = hosts[host];
36 host_session.events.add_handler("item-added/storage-provider", function (event)
37 local item = event.item;
38 stores_available:set(host, item.name, item);
41 host_session.events.add_handler("item-removed/storage-provider", function (event)
42 local item = event.item;
43 stores_available:set(host, item.name, nil);
46 prosody.events.add_handler("host-activated", initialize_host, 101);
48 function load_driver(host, driver_name)
49 if driver_name == "null" then
50 return null_storage_driver;
52 local driver = stores_available:get(host, driver_name);
53 if driver then return driver; end
54 local ok, err = modulemanager.load(host, "storage_"..driver_name);
56 log("error", "Failed to load storage driver plugin %s on %s: %s", driver_name, host, err);
58 return stores_available:get(host, driver_name);
61 function get_driver(host, store)
62 local storage = config.get(host, "storage");
64 local option_type = type(storage);
65 if option_type == "string" then
66 driver_name = storage;
67 elseif option_type == "table" then
68 driver_name = storage[store];
70 if not driver_name then
71 driver_name = config.get(host, "default_storage") or "internal";
74 local driver = load_driver(host, driver_name);
76 log("warn", "Falling back to null driver for %s storage on %s", store, host);
78 driver = null_storage_driver;
80 return driver, driver_name;
85 get = function(self, username, key)
86 local ret, err = self.keyval_store:get(username);
87 if ret == nil then return nil, err end
90 set = function(self, username, key, data)
91 local current, err = self.keyval_store:get(username);
92 if current == nil then
100 return self.keyval_store:set(username, current);
104 local function create_map_shim(host, store)
105 local keyval_store, err = open(host, store, "keyval");
106 if keyval_store == nil then return nil, err end
107 return setmetatable({
108 keyval_store = keyval_store;
112 function open(host, store, typ)
113 local driver, driver_name = get_driver(host, store);
114 local ret, err = driver:open(store, typ);
116 if err == "unsupported-store" then
117 if typ == "map" then -- Use shim on top of keyval store
118 log("debug", "map storage driver unavailable, using shim on top of keyval store.");
119 return create_map_shim(host, store);
121 log("debug", "Storage driver %s does not support store %s (%s), falling back to null driver",
122 driver_name, store, typ or "<nil>");
123 ret = null_storage_driver;
130 function purge(user, host)
131 local storage = config.get(host, "storage");
132 if type(storage) == "table" then
133 -- multiple storage backends in use that we need to purge
135 for store, driver in pairs(storage) do
136 if not purged[driver] then
137 purged[driver] = get_driver(host, store):purge(user);
141 get_driver(host):purge(user); -- and the default driver
143 olddm.purge(user, host); -- COMPAT list stores, like offline messages end up in the old datamanager
148 function datamanager.load(username, host, datastore)
149 return open(host, datastore):get(username);
151 function datamanager.store(username, host, datastore, data)
152 return open(host, datastore):set(username, data);
154 function datamanager.users(host, datastore, typ)
155 local driver = open(host, datastore, typ);
156 if not driver.users then
157 return function() log("warn", "storage driver %s does not support listing users", driver.name) end
159 return driver:users();
161 function datamanager.stores(username, host, typ)
162 return get_driver(host):stores(username, typ);
164 function datamanager.purge(username, host)
165 return purge(username, host);