util/datamanager.lua

   1 -- Prosody IM v0.4
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 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 loadfile, setfenv, pcall = loadfile, setfenv, pcall;
  15 local log = require "util.logger".init("datamanager");
  16 local io_open = io.open;
  17 local os_remove = os.remove;
  18 local io_popen = io.popen;
  19 local tostring, tonumber = tostring, tonumber;
  20 local error = error;
  21 local next = next;
  22 local t_insert = table.insert;
  23 local append = require "util.serialization".append;
  24 local path_separator = "/"; if os.getenv("WINDIR") then path_separator = "\\" end
  25
  26 module "datamanager"
  27
  28 ---- utils -----
  29 local encode, decode;
  30 do
  31         local urlcodes = setmetatable({}, { __index = function (t, k) t[k] = char(tonumber("0x"..k)); return t[k]; end });
  32
  33         decode = function (s)
  34                 return s and (s:gsub("+", " "):gsub("%%([a-fA-F0-9][a-fA-F0-9])", urlcodes));
  35         end
  36
  37         encode = function (s)
  38                 return s and (s:gsub("%W", function (c) return format("%%%02x", c:byte()); end));
  39         end
  40 end
  41
  42 local _mkdir = {};
  43 local function mkdir(path)
  44         path = path:gsub("/", path_separator); -- TODO as an optimization, do this during path creation rather than here
  45         if not _mkdir[path] then
  46                 local x = io_popen("mkdir \""..path.."\" 2>&1"):read("*a");
  47                 _mkdir[path] = true;
  48         end
  49         return path;
  50 end
  51
  52 local data_path = "data";
  53
  54 ------- API -------------
  55
  56 function set_data_path(path)
  57         log("info", "Setting data path to: %s", path);
  58         data_path = path;
  59 end
  60
  61 function getpath(username, host, datastore, ext, create)
  62         ext = ext or "dat";
  63         host = host and encode(host);
  64         username = username and encode(username);
  65         if username then
  66                 if create then mkdir(mkdir(mkdir(data_path).."/"..host).."/"..datastore); end
  67                 return format("%s/%s/%s/%s.%s", data_path, host, datastore, username, ext);
  68         elseif host then
  69                 if create then mkdir(mkdir(data_path).."/"..host); end
  70                 return format("%s/%s/%s.%s", data_path, host, datastore, ext);
  71         else
  72                 if create then mkdir(data_path); end
  73                 return format("%s/%s.%s", data_path, datastore, ext);
  74         end
  75 end
  76
  77 function load(username, host, datastore)
  78         local data, ret = loadfile(getpath(username, host, datastore));
  79         if not data then
  80                 log("debug", "Failed to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
  81                 return nil;
  82         end
  83         setfenv(data, {});
  84         local success, ret = pcall(data);
  85         if not success then
  86                 log("error", "Unable to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
  87                 return nil;
  88         end
  89         return ret;
  90 end
  91
  92 function store(username, host, datastore, data)
  93         if not data then
  94                 data = {};
  95         end
  96         -- save the datastore
  97         local f, msg = io_open(getpath(username, host, datastore, nil, true), "w+");
  98         if not f then
  99                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
 100                 return;
 101         end
 102         f:write("return ");
 103         append(f, data);
 104         f:close();
 105         if not next(data) then -- try to delete empty datastore
 106                 os_remove(getpath(username, host, datastore));
 107         end
 108         -- we write data even when we are deleting because lua doesn't have a
 109         -- platform independent way of checking for non-exisitng files
 110         return true;
 111 end
 112
 113 function list_append(username, host, datastore, data)
 114         if not data then return; end
 115         -- save the datastore
 116         local f, msg = io_open(getpath(username, host, datastore, "list", true), "a+");
 117         if not f then
 118                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
 119                 return;
 120         end
 121         f:write("item(");
 122         append(f, data);
 123         f:write(");\n");
 124         f:close();
 125         return true;
 126 end
 127
 128 function list_store(username, host, datastore, data)
 129         if not data then
 130                 data = {};
 131         end
 132         -- save the datastore
 133         local f, msg = io_open(getpath(username, host, datastore, "list", true), "w+");
 134         if not f then
 135                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
 136                 return;
 137         end
 138         for _, d in ipairs(data) do
 139                 f:write("item(");
 140                 append(f, d);
 141                 f:write(");\n");
 142         end
 143         f:close();
 144         if not next(data) then -- try to delete empty datastore
 145                 os_remove(getpath(username, host, datastore, "list"));
 146         end
 147         -- we write data even when we are deleting because lua doesn't have a
 148         -- platform independent way of checking for non-exisitng files
 149         return true;
 150 end
 151
 152 function list_load(username, host, datastore)
 153         local data, ret = loadfile(getpath(username, host, datastore, "list"));
 154         if not data then
 155                 log("debug", "Failed to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
 156                 return nil;
 157         end
 158         local items = {};
 159         setfenv(data, {item = function(i) t_insert(items, i); end});
 160         local success, ret = pcall(data);
 161         if not success then
 162                 log("error", "Unable to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
 163                 return nil;
 164         end
 165         return items;
 166 end
 167
 168 return _M;