util.datamanager: Use pposix.fallocate() to make sure appends succeed. Also add a...
[prosody.git] / util / datamanager.lua
1 -- Prosody IM
2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
4 --
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
7 --
8
9
10 local format = string.format;
11 local setmetatable, type = setmetatable, type;
12 local pairs, ipairs = pairs, ipairs;
13 local char = string.char;
14 local pcall = pcall;
15 local log = require "util.logger".init("datamanager");
16 local io_open = io.open;
17 local os_remove = os.remove;
18 local tostring, tonumber = tostring, tonumber;
19 local error = error;
20 local next = next;
21 local t_insert = table.insert;
22 local append = require "util.serialization".append;
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;
28 local raw_mkdir;
29 local fallocate;
30
31 if prosody.platform == "posix" then
32         raw_mkdir = require "util.pposix".mkdir; -- Doesn't trample on umask
33         fallocate = require "util.pposix".fallocate;
34 else
35         raw_mkdir = lfs.mkdir;
36 end
37
38 if not fallocate then -- Fallback
39         function fallocate(f, offset, len)
40                 -- This assumes that current position == offset
41                 local fake_data = (" "):rep(len);
42                 local ok, msg = f:write(fake_data);
43                 if not ok then
44                         return ok, msg;
45                 end
46                 f:seek(offset);
47                 return true;
48         end
49 end
50
51 module "datamanager"
52
53 ---- utils -----
54 local encode, decode;
55 do
56         local urlcodes = setmetatable({}, { __index = function (t, k) t[k] = char(tonumber("0x"..k)); return t[k]; end });
57
58         decode = function (s)
59                 return s and (s:gsub("+", " "):gsub("%%([a-fA-F0-9][a-fA-F0-9])", urlcodes));
60         end
61
62         encode = function (s)
63                 return s and (s:gsub("%W", function (c) return format("%%%02x", c:byte()); end));
64         end
65 end
66
67 local _mkdir = {};
68 local function mkdir(path)
69         path = path:gsub("/", path_separator); -- TODO as an optimization, do this during path creation rather than here
70         if not _mkdir[path] then
71                 raw_mkdir(path);
72                 _mkdir[path] = true;
73         end
74         return path;
75 end
76
77 local data_path = (prosody and prosody.paths and prosody.paths.data) or ".";
78 local callbacks = {};
79
80 ------- API -------------
81
82 function set_data_path(path)
83         log("debug", "Setting data path to: %s", path);
84         data_path = path;
85 end
86
87 local function callback(username, host, datastore, data)
88         for _, f in ipairs(callbacks) do
89                 username, host, datastore, data = f(username, host, datastore, data);
90                 if username == false then break; end
91         end
92
93         return username, host, datastore, data;
94 end
95 function add_callback(func)
96         if not callbacks[func] then -- Would you really want to set the same callback more than once?
97                 callbacks[func] = true;
98                 callbacks[#callbacks+1] = func;
99                 return true;
100         end
101 end
102 function remove_callback(func)
103         if callbacks[func] then
104                 for i, f in ipairs(callbacks) do
105                         if f == func then
106                                 callbacks[i] = nil;
107                                 callbacks[f] = nil;
108                                 return true;
109                         end
110                 end
111         end
112 end
113
114 function getpath(username, host, datastore, ext, create)
115         ext = ext or "dat";
116         host = (host and encode(host)) or "_global";
117         username = username and encode(username);
118         if username then
119                 if create then mkdir(mkdir(mkdir(data_path).."/"..host).."/"..datastore); end
120                 return format("%s/%s/%s/%s.%s", data_path, host, datastore, username, ext);
121         elseif host then
122                 if create then mkdir(mkdir(data_path).."/"..host); end
123                 return format("%s/%s/%s.%s", data_path, host, datastore, ext);
124         else
125                 if create then mkdir(data_path); end
126                 return format("%s/%s.%s", data_path, datastore, ext);
127         end
128 end
129
130 function load(username, host, datastore)
131         local data, ret = envloadfile(getpath(username, host, datastore), {});
132         if not data then
133                 local mode = lfs.attributes(getpath(username, host, datastore), "mode");
134                 if not mode then
135                         log("debug", "Assuming empty %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
136                         return nil;
137                 else -- file exists, but can't be read
138                         -- TODO more detailed error checking and logging?
139                         log("error", "Failed to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
140                         return nil, "Error reading storage";
141                 end
142         end
143
144         local success, ret = pcall(data);
145         if not success then
146                 log("error", "Unable to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
147                 return nil, "Error reading storage";
148         end
149         return ret;
150 end
151
152 function store(username, host, datastore, data)
153         if not data then
154                 data = {};
155         end
156
157         username, host, datastore, data = callback(username, host, datastore, data);
158         if username == false then
159                 return true; -- Don't save this data at all
160         end
161
162         -- save the datastore
163         local f, msg = io_open(getpath(username, host, datastore, nil, true), "w+");
164         if not f then
165                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
166                 return nil, "Error saving to storage";
167         end
168         f:write("return ");
169         append(f, data);
170         f:close();
171         if next(data) == nil then -- try to delete empty datastore
172                 log("debug", "Removing empty %s datastore for user %s@%s", datastore, username or "nil", host or "nil");
173                 os_remove(getpath(username, host, datastore));
174         end
175         -- we write data even when we are deleting because lua doesn't have a
176         -- platform independent way of checking for non-exisitng files
177         return true;
178 end
179
180 function list_append(username, host, datastore, data)
181         if not data then return; end
182         if callback(username, host, datastore) == false then return true; end
183         -- save the datastore
184         local f, msg = io_open(getpath(username, host, datastore, "list", true), "a");
185         if not f then
186                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
187                 return;
188         end
189         local data = "item(" ..  serialize(data) .. ");\n";
190         local pos = f:seek("end");
191         local ok, msg = fallocate(f, pos, #data);
192         f:seek("set", pos);
193         if ok then
194                 f:write(data);
195         else
196                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
197                 return ok, msg;
198         end
199         f:close();
200         return true;
201 end
202
203 function list_store(username, host, datastore, data)
204         if not data then
205                 data = {};
206         end
207         if callback(username, host, datastore) == false then return true; end
208         -- save the datastore
209         local f, msg = io_open(getpath(username, host, datastore, "list", true), "w+");
210         if not f then
211                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
212                 return;
213         end
214         for _, d in ipairs(data) do
215                 f:write("item(");
216                 append(f, d);
217                 f:write(");\n");
218         end
219         f:close();
220         if next(data) == nil then -- try to delete empty datastore
221                 log("debug", "Removing empty %s datastore for user %s@%s", datastore, username or "nil", host or "nil");
222                 os_remove(getpath(username, host, datastore, "list"));
223         end
224         -- we write data even when we are deleting because lua doesn't have a
225         -- platform independent way of checking for non-exisitng files
226         return true;
227 end
228
229 function list_load(username, host, datastore)
230         local items = {};
231         local data, ret = envloadfile(getpath(username, host, datastore, "list"), {item = function(i) t_insert(items, i); end});
232         if not data then
233                 local mode = lfs.attributes(getpath(username, host, datastore, "list"), "mode");
234                 if not mode then
235                         log("debug", "Assuming empty %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
236                         return nil;
237                 else -- file exists, but can't be read
238                         -- TODO more detailed error checking and logging?
239                         log("error", "Failed to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
240                         return nil, "Error reading storage";
241                 end
242         end
243
244         local success, ret = pcall(data);
245         if not success then
246                 log("error", "Unable to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
247                 return nil, "Error reading storage";
248         end
249         return items;
250 end
251
252 function list_stores(username, host)
253         if not host then
254                 return nil, "bad argument #2 to 'list_stores' (string expected, got nothing)";
255         end
256         local list = {};
257         local host_dir = format("%s/%s/", data_path, encode(host));
258         for node in lfs.dir(host_dir) do
259                 if not node:match"^%." then -- dots should be encoded, this is probably . or ..
260                         local store = decode(node);
261                         local path = host_dir..node;
262                         if username == true then
263                                 if lfs.attributes(path, "mode") == "directory" then
264                                         list[#list+1] = store;
265                                 end
266                         elseif username then
267                                 if lfs.attributes(getpath(username, host, store), "mode")
268                                         or lfs.attributes(getpath(username, host, store, "list"), "mode") then
269                                         list[#list+1] = store;
270                                 end
271                         elseif lfs.attributes(path, "mode") == "file" then
272                                 list[#list+1] = store:gsub("%.[dalist]+$","");
273                         end
274                 end
275         end
276         return list;
277 end
278
279 function purge(username, host)
280         local host_dir = format("%s/%s/", data_path, encode(host));
281         local deleted = 0;
282         for file in lfs.dir(host_dir) do
283                 if lfs.attributes(host_dir..file, "mode") == "directory" then
284                         local store = decode(file);
285                         deleted = deleted + (os_remove(getpath(username, host, store)) and 1 or 0);
286                         deleted = deleted + (os_remove(getpath(username, host, store, "list")) and 1 or 0);
287                         -- We this will generate loads of "No such file or directory", but do we care?
288                 end
289         end
290         return deleted > 0, deleted;
291 end
292
293 return _M;