util/datamanager.lua

   1 -- Prosody IM v0.1
   2 -- Copyright (C) 2008 Matthew Wild
   3 -- Copyright (C) 2008 Waqas Hussain
   4 --
   5 -- This program is free software; you can redistribute it and/or
   6 -- modify it under the terms of the GNU General Public License
   7 -- as published by the Free Software Foundation; either version 2
   8 -- of the License, or (at your option) any later version.
   9 --
  10 -- This program is distributed in the hope that it will be useful,
  11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 -- GNU General Public License for more details.
  14 --
  15 -- You should have received a copy of the GNU General Public License
  16 -- along with this program; if not, write to the Free Software
  17 -- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 --
  19
  20
  21 local format = string.format;
  22 local setmetatable, type = setmetatable, type;
  23 local pairs, ipairs = pairs, ipairs;
  24 local char = string.char;
  25 local loadfile, setfenv, pcall = loadfile, setfenv, pcall;
  26 local log = require "util.logger".init("datamanager");
  27 local io_open = io.open;
  28 local os_remove = os.remove;
  29 local tostring, tonumber = tostring, tonumber;
  30 local error = error;
  31 local next = next;
  32 local t_insert = table.insert;
  33 local append = require "util.serialization".append;
  34
  35 module "datamanager"
  36
  37 ---- utils -----
  38 local encode, decode;
  39 do
  40         local urlcodes = setmetatable({}, { __index = function (t, k) t[k] = char(tonumber("0x"..k)); return t[k]; end });
  41
  42         decode = function (s)
  43                 return s and (s:gsub("+", " "):gsub("%%([a-fA-F0-9][a-fA-F0-9])", urlcodes));
  44         end
  45
  46         encode = function (s)
  47                 return s and (s:gsub("%W", function (c) return format("%%%x", c:byte()); end));
  48         end
  49 end
  50
  51 ------- API -------------
  52
  53 local data_path = "data";
  54 function set_data_path(path)
  55         data_path = path;
  56 end
  57
  58 function getpath(username, host, datastore, ext)
  59         ext = ext or "dat";
  60         if username then
  61                 return format("%s/%s/%s/%s.%s", data_path, encode(host), datastore, encode(username), ext);
  62         elseif host then
  63                 return format("%s/%s/%s.%s", data_path, encode(host), datastore, ext);
  64         else
  65                 return format("%s/%s.%s", data_path, datastore, ext);
  66         end
  67 end
  68
  69 function load(username, host, datastore)
  70         local data, ret = loadfile(getpath(username, host, datastore));
  71         if not data then
  72                 log("warn", "Failed to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
  73                 return nil;
  74         end
  75         setfenv(data, {});
  76         local success, ret = pcall(data);
  77         if not success then
  78                 log("error", "Unable to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
  79                 return nil;
  80         end
  81         return ret;
  82 end
  83
  84 function store(username, host, datastore, data)
  85         if not data then
  86                 data = {};
  87         end
  88         -- save the datastore
  89         local f, msg = io_open(getpath(username, host, datastore), "w+");
  90         if not f then
  91                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
  92                 return;
  93         end
  94         f:write("return ");
  95         append(f, data);
  96         f:close();
  97         if not next(data) then -- try to delete empty datastore
  98                 os_remove(getpath(username, host, datastore));
  99         end
 100         -- we write data even when we are deleting because lua doesn't have a
 101         -- platform independent way of checking for non-exisitng files
 102         return true;
 103 end
 104
 105 function list_append(username, host, datastore, data)
 106         if not data then return; end
 107         -- save the datastore
 108         local f, msg = io_open(getpath(username, host, datastore, "list"), "a+");
 109         if not f then
 110                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
 111                 return;
 112         end
 113         f:write("item(");
 114         append(f, data);
 115         f:write(");\n");
 116         f:close();
 117         return true;
 118 end
 119
 120 function list_store(username, host, datastore, data)
 121         if not data then
 122                 data = {};
 123         end
 124         -- save the datastore
 125         local f, msg = io_open(getpath(username, host, datastore, "list"), "w+");
 126         if not f then
 127                 log("error", "Unable to write to "..datastore.." storage ('"..msg.."') for user: "..(username or "nil").."@"..(host or "nil"));
 128                 return;
 129         end
 130         for _, d in ipairs(data) do
 131                 f:write("item(");
 132                 append(f, d);
 133                 f:write(");\n");
 134         end
 135         f:close();
 136         if not next(data) then -- try to delete empty datastore
 137                 os_remove(getpath(username, host, datastore, "list"));
 138         end
 139         -- we write data even when we are deleting because lua doesn't have a
 140         -- platform independent way of checking for non-exisitng files
 141         return true;
 142 end
 143
 144 function list_load(username, host, datastore)
 145         local data, ret = loadfile(getpath(username, host, datastore, "list"));
 146         if not data then
 147                 log("warn", "Failed to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
 148                 return nil;
 149         end
 150         local items = {};
 151         setfenv(data, {item = function(i) t_insert(items, i); end});
 152         local success, ret = pcall(data);
 153         if not success then
 154                 log("error", "Unable to load "..datastore.." storage ('"..ret.."') for user: "..(username or "nil").."@"..(host or "nil"));
 155                 return nil;
 156         end
 157         return items;
 158 end
 159
 160 return _M;