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 = setmetatable;
  12 local ipairs = 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 os_rename = os.rename;
  19 local tonumber = tonumber;
  20 local next = next;
  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;
  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("set", 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 local function atomic_store(filename, data)
 153         local scratch = filename.."~";
 154         local f, ok, msg;
 155         repeat
 156                 f, msg = io_open(scratch, "w");
 157                 if not f then break end
 158
 159                 ok, msg = f:write(data);
 160                 if not ok then break end
 161
 162                 ok, msg = f:close();
 163                 if not ok then break end
 164
 165                 return os_rename(scratch, filename);
 166         until false;
 167
 168         -- Cleanup
 169         if f then f:close(); end
 170         os_remove(scratch);
 171         return nil, msg;
 172 end
 173
 174 if prosody.platform ~= "posix" then
 175         -- os.rename does not overwrite existing files on Windows
 176         -- TODO We could use Transactional NTFS on Vista and above
 177         function atomic_store(filename, data)
 178                 local f, err = io_open(filename, "w");
 179                 if not f then return f, err; end
 180                 local ok, msg = f:write(data);
 181                 if not ok then f:close(); return ok, msg; end
 182                 return f:close();
 183         end
 184 end
 185
 186 function store(username, host, datastore, data)
 187         if not data then
 188                 data = {};
 189         end
 190
 191         username, host, datastore, data = callback(username, host, datastore, data);
 192         if username == false then
 193                 return true; -- Don't save this data at all
 194         end
 195
 196         -- save the datastore
 197         local d = "return " .. serialize(data) .. ";\n";
 198         local ok, msg = atomic_store(getpath(username, host, datastore, nil, true), d);
 199         if not ok then
 200                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
 201                 return nil, "Error saving to storage";
 202         end
 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));
 206         end
 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
 209         return true;
 210 end
 211
 212 function list_append(username, host, datastore, data)
 213         if not data then return; end
 214         if callback(username, host, datastore) == false then return true; end
 215         -- save the datastore
 216         local f, msg = io_open(getpath(username, host, datastore, "list", true), "a");
 217         if not f then
 218                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
 219                 return;
 220         end
 221         local data = "item(" ..  serialize(data) .. ");\n";
 222         local pos = f:seek("end");
 223         local ok, msg = fallocate(f, pos, #data);
 224         f:seek("set", pos);
 225         if ok then
 226                 f:write(data);
 227         else
 228                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
 229                 return ok, msg;
 230         end
 231         f:close();
 232         return true;
 233 end
 234
 235 function list_store(username, host, datastore, data)
 236         if not data then
 237                 data = {};
 238         end
 239         if callback(username, host, datastore) == false then return true; end
 240         -- save the datastore
 241         local d = {};
 242         for _, item in ipairs(data) do
 243                 d[#d+1] = "item(" .. serialize(item) .. ");\n";
 244         end
 245         local ok, msg = atomic_store(getpath(username, host, datastore, "list", true), t_concat(d));
 246         if not ok then
 247                 log("error", "Unable to write to %s storage ('%s') for user: %s@%s", datastore, msg, username or "nil", host or "nil");
 248                 return;
 249         end
 250         if next(data) == nil then -- try to delete empty datastore
 251                 log("debug", "Removing empty %s datastore for user %s@%s", datastore, username or "nil", host or "nil");
 252                 os_remove(getpath(username, host, datastore, "list"));
 253         end
 254         -- we write data even when we are deleting because lua doesn't have a
 255         -- platform independent way of checking for non-exisitng files
 256         return true;
 257 end
 258
 259 function list_load(username, host, datastore)
 260         local items = {};
 261         local data, ret = envloadfile(getpath(username, host, datastore, "list"), {item = function(i) t_insert(items, i); end});
 262         if not data then
 263                 local mode = lfs.attributes(getpath(username, host, datastore, "list"), "mode");
 264                 if not mode then
 265                         log("debug", "Assuming empty %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
 266                         return nil;
 267                 else -- file exists, but can't be read
 268                         -- TODO more detailed error checking and logging?
 269                         log("error", "Failed to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
 270                         return nil, "Error reading storage";
 271                 end
 272         end
 273
 274         local success, ret = pcall(data);
 275         if not success then
 276                 log("error", "Unable to load %s storage ('%s') for user: %s@%s", datastore, ret, username or "nil", host or "nil");
 277                 return nil, "Error reading storage";
 278         end
 279         return items;
 280 end
 281
 282 function list_stores(username, host)
 283         if not host then
 284                 return nil, "bad argument #2 to 'list_stores' (string expected, got nothing)";
 285         end
 286         local list = {};
 287         local host_dir = format("%s/%s/", data_path, encode(host));
 288         for node in lfs.dir(host_dir) do
 289                 if not node:match"^%." then -- dots should be encoded, this is probably . or ..
 290                         local store = decode(node);
 291                         local path = host_dir..node;
 292                         if username == true then
 293                                 if lfs.attributes(path, "mode") == "directory" then
 294                                         list[#list+1] = store;
 295                                 end
 296                         elseif username then
 297                                 if lfs.attributes(getpath(username, host, store), "mode")
 298                                         or lfs.attributes(getpath(username, host, store, "list"), "mode") then
 299                                         list[#list+1] = store;
 300                                 end
 301                         elseif lfs.attributes(path, "mode") == "file" then
 302                                 list[#list+1] = store:gsub("%.[dalist]+$","");
 303                         end
 304                 end
 305         end
 306         return list;
 307 end
 308
 309 function purge(username, host)
 310         local host_dir = format("%s/%s/", data_path, encode(host));
 311         local deleted = 0;
 312         for file in lfs.dir(host_dir) do
 313                 if lfs.attributes(host_dir..file, "mode") == "directory" then
 314                         local store = decode(file);
 315                         deleted = deleted + (os_remove(getpath(username, host, store)) and 1 or 0);
 316                         deleted = deleted + (os_remove(getpath(username, host, store, "list")) and 1 or 0);
 317                         -- We this will generate loads of "No such file or directory", but do we care?
 318                 end
 319         end
 320         return deleted > 0, deleted;
 321 end
 322
 323 return _M;