2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
10 local format = string.format;
11 local setmetatable = setmetatable;
12 local ipairs = ipairs;
13 local char = string.char;
15 local log = require "util.logger".init("datamanager");
16 local io_open = io.open;
17 local os_remove = os.remove;
18 local os_rename = os.rename;
19 local tonumber = tonumber;
21 local t_insert = table.insert;
22 local t_concat = table.concat;
23 local envloadfile = require"util.envload".envloadfile;
24 local serialize = require "util.serialization".serialize;
25 local path_separator = assert ( package.config:match ( "^([^\n]+)" ) , "package.config not in standard form" ) -- Extract directory seperator from package.config (an undocumented string that comes with lua)
26 local lfs = require "lfs";
27 local prosody = prosody;
29 local raw_mkdir = lfs.mkdir;
30 local function fallocate(f, offset, len)
31 -- This assumes that current position == offset
32 local fake_data = (" "):rep(len);
33 local ok, msg = f:write(fake_data);
37 f:seek("set", offset);
41 local pposix = require "util.pposix";
42 raw_mkdir = pposix.mkdir or raw_mkdir; -- Doesn't trample on umask
43 fallocate = pposix.fallocate or fallocate;
51 local urlcodes = setmetatable({}, { __index = function (t, k) t[k] = char(tonumber("0x"..k)); return t[k]; end });
54 return s and (s:gsub("+", " "):gsub("%%([a-fA-F0-9][a-fA-F0-9])", urlcodes));
58 return s and (s:gsub("%W", function (c) return format("%%%02x", c:byte()); end));
63 local function mkdir(path)
64 path = path:gsub("/", path_separator); -- TODO as an optimization, do this during path creation rather than here
65 if not _mkdir[path] then
72 local data_path = (prosody and prosody.paths and prosody.paths.data) or ".";
75 ------- API -------------
77 function set_data_path(path)
78 log("debug", "Setting data path to: %s", path);
82 local function callback(username, host, datastore, data)
83 for _, f in ipairs(callbacks) do
84 username, host, datastore, data = f(username, host, datastore, data);
85 if username == false then break; end
88 return username, host, datastore, data;
90 function add_callback(func)
91 if not callbacks[func] then -- Would you really want to set the same callback more than once?
92 callbacks[func] = true;
93 callbacks[#callbacks+1] = func;
97 function remove_callback(func)
98 if callbacks[func] then
99 for i, f in ipairs(callbacks) do
109 function getpath(username, host, datastore, ext, create)
111 host = (host and encode(host)) or "_global";
112 username = username and encode(username);
114 if create then mkdir(mkdir(mkdir(data_path).."/"..host).."/"..datastore); end
115 return format("%s/%s/%s/%s.%s", data_path, host, datastore, username, ext);
117 if create then mkdir(mkdir(data_path).."/"..host); end
118 return format("%s/%s/%s.%s", data_path, host, datastore, ext);
122 function load(username, host, datastore)
123 local data, ret = envloadfile(getpath(username, host, datastore), {});
125 local mode = lfs.attributes(getpath(username, host, datastore), "mode");
127 log("debug", "Assuming empty %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
129 else -- file exists, but can't be read
130 -- TODO more detailed error checking and logging?
131 log("error", "Failed to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
132 return nil, "Error reading storage";
136 local success, ret = pcall(data);
138 log("error", "Unable to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
139 return nil, "Error reading storage";
144 local function atomic_store(filename, data)
145 local scratch = filename.."~";
148 f, msg = io_open(scratch, "w");
149 if not f then break end
151 ok, msg = f:write(data);
152 if not ok then break end
155 f = nil; -- no longer valid
156 if not ok then break end
158 return os_rename(scratch, filename);
162 if f then f:close(); end
167 if prosody and prosody.platform ~= "posix" then
168 -- os.rename does not overwrite existing files on Windows
169 -- TODO We could use Transactional NTFS on Vista and above
170 function atomic_store(filename, data)
171 local f, err = io_open(filename, "w");
172 if not f then return f, err; end
173 local ok, msg = f:write(data);
174 if not ok then f:close(); return ok, msg; end
179 function store(username, host, datastore, data)
184 username, host, datastore, data = callback(username, host, datastore, data);
185 if username == false then
186 return true; -- Don't save this data at all
189 -- save the datastore
190 local d = "return " .. serialize(data) .. ";\n";
191 local mkdir_cache_cleared;
193 local ok, msg = atomic_store(getpath(username, host, datastore, nil, true), d);
195 if not mkdir_cache_cleared then -- We may need to recreate a removed directory
197 mkdir_cache_cleared = true;
199 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
200 return nil, "Error saving to storage";
203 if next(data) == nil then -- try to delete empty datastore
204 log("debug", "Removing empty %s datastore for user %s@%s", datastore, username or "nil", host or "nil");
205 os_remove(getpath(username, host, datastore));
207 -- we write data even when we are deleting because lua doesn't have a
208 -- platform independent way of checking for non-exisitng files
213 function list_append(username, host, datastore, data)
214 if not data then return; end
215 if callback(username, host, datastore) == false then return true; end
216 -- save the datastore
217 local f, msg = io_open(getpath(username, host, datastore, "list", true), "r+");
219 f, msg = io_open(getpath(username, host, datastore, "list", true), "w");
222 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
225 local data = "item(" .. serialize(data) .. ");\n";
226 local pos = f:seek("end");
227 local ok, msg = fallocate(f, pos, #data);
232 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
239 function list_store(username, host, datastore, data)
243 if callback(username, host, datastore) == false then return true; end
244 -- save the datastore
246 for _, item in ipairs(data) do
247 d[#d+1] = "item(" .. serialize(item) .. ");\n";
249 local ok, msg = atomic_store(getpath(username, host, datastore, "list", true), t_concat(d));
251 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
254 if next(data) == nil then -- try to delete empty datastore
255 log("debug", "Removing empty %s datastore for user %s@%s", datastore, username or "nil", host or "nil");
256 os_remove(getpath(username, host, datastore, "list"));
258 -- we write data even when we are deleting because lua doesn't have a
259 -- platform independent way of checking for non-exisitng files
263 function list_load(username, host, datastore)
265 local data, ret = envloadfile(getpath(username, host, datastore, "list"), {item = function(i) t_insert(items, i); end});
267 local mode = lfs.attributes(getpath(username, host, datastore, "list"), "mode");
269 log("debug", "Assuming empty %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
271 else -- file exists, but can't be read
272 -- TODO more detailed error checking and logging?
273 log("error", "Failed to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
274 return nil, "Error reading storage";
278 local success, ret = pcall(data);
280 log("error", "Unable to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
281 return nil, "Error reading storage";
291 function users(host, store, typ)
292 typ = type_map[typ or "keyval"];
293 local store_dir = format("%s/%s/%s", data_path, encode(host), store);
295 local mode, err = lfs.attributes(store_dir, "mode");
297 return function() log("debug", "%s", err or (store_dir .. " does not exist")) end
299 local next, state = lfs.dir(store_dir);
300 return function(state)
301 for node in next, state do
302 local file, ext = node:match("^(.*)%.([dalist]+)$");
303 if file and ext == typ then
310 function stores(username, host, typ)
311 typ = type_map[typ or "keyval"];
312 local store_dir = format("%s/%s/", data_path, encode(host));
314 local mode, err = lfs.attributes(store_dir, "mode");
316 return function() log("debug", err or (store_dir .. " does not exist")) end
318 local next, state = lfs.dir(store_dir);
319 return function(state)
320 for node in next, state do
321 if not node:match"^%." then
322 if username == true then
323 if lfs.attributes(store_dir..node, "mode") == "directory" then
327 local store = decode(node)
328 if lfs.attributes(getpath(username, host, store, typ), "mode") then
331 elseif lfs.attributes(node, "mode") == "file" then
332 local file, ext = node:match("^(.*)%.([dalist]+)$");
342 local function do_remove(path)
343 local ok, err = os_remove(path);
344 if not ok and lfs.attributes(path, "mode") then
350 function purge(username, host)
351 local host_dir = format("%s/%s/", data_path, encode(host));
352 local ok, iter, state, var = pcall(lfs.dir, host_dir);
357 for file in iter, state, var do
358 if lfs.attributes(host_dir..file, "mode") == "directory" then
359 local store = decode(file);
360 local ok, err = do_remove(getpath(username, host, store));
361 if not ok then errs[#errs+1] = err; end
363 local ok, err = do_remove(getpath(username, host, store, "list"));
364 if not ok then errs[#errs+1] = err; end
367 return #errs == 0, t_concat(errs, ", ");
370 _M.path_decode = decode;
371 _M.path_encode = encode;