plugins/mod_storage_sql.lua

   1
   2 --[[
   3
   4 DB Tables:
   5         Prosody - key-value, map
   6                 | host | user | store | key | type | value |
   7         ProsodyArchive - list
   8                 | host | user | store | key | time | stanzatype | jsonvalue |
   9
  10 Mapping:
  11         Roster - Prosody
  12                 | host | user | "roster" | "contactjid" | type | value |
  13                 | host | user | "roster" | NULL | "json" | roster[false] data |
  14         Account - Prosody
  15                 | host | user | "accounts" | "username" | type | value |
  16
  17         Offline - ProsodyArchive
  18                 | host | user | "offline" | "contactjid" | time | "message" | json|XML |
  19
  20 ]]
  21
  22 local type = type;
  23 local tostring = tostring;
  24 local tonumber = tonumber;
  25 local pairs = pairs;
  26 local next = next;
  27 local setmetatable = setmetatable;
  28 local xpcall = xpcall;
  29 local json = require "util.json";
  30
  31 local connection;
  32 local host,user,store = module.host;
  33 local params = module:get_option("sql");
  34
  35 do -- process options to get a db connection
  36         local DBI = require "DBI";
  37
  38         params = params or { driver = "SQLite3", database = "prosody.sqlite" };
  39         assert(params.driver and params.database, "invalid params");
  40
  41         prosody.unlock_globals();
  42         local dbh, err = DBI.Connect(
  43                 params.driver, params.database,
  44                 params.username, params.password,
  45                 params.host, params.port
  46         );
  47         prosody.lock_globals();
  48         assert(dbh, err);
  49
  50         dbh:autocommit(false); -- don't commit automatically
  51         connection = dbh;
  52
  53         if params.driver == "SQLite3" then -- auto initialize
  54                 local stmt = assert(connection:prepare("SELECT COUNT(*) FROM `sqlite_master` WHERE `type`='table' AND `name`='Prosody';"));
  55                 local ok = assert(stmt:execute());
  56                 local count = stmt:fetch()[1];
  57                 if count == 0 then
  58                         local stmt = assert(connection:prepare("CREATE TABLE `Prosody` (`host` TEXT, `user` TEXT, `store` TEXT, `key` TEXT, `type` TEXT, `value` TEXT);"));
  59                         assert(stmt:execute());
  60                         module:log("debug", "Initialized new SQLite3 database");
  61                 end
  62                 assert(connection:commit());
  63                 --print("===", json.encode())
  64         end
  65 end
  66
  67 local function serialize(value)
  68         local t = type(value);
  69         if t == "string" or t == "boolean" or t == "number" then
  70                 return t, tostring(value);
  71         elseif t == "table" then
  72                 local value,err = json.encode(value);
  73                 if value then return "json", value; end
  74                 return nil, err;
  75         end
  76         return nil, "Unhandled value type: "..t;
  77 end
  78 local function deserialize(t, value)
  79         if t == "string" then return value;
  80         elseif t == "boolean" then
  81                 if value == "true" then return true;
  82                 elseif value == "false" then return false; end
  83         elseif t == "number" then return tonumber(value);
  84         elseif t == "json" then
  85                 return json.decode(value);
  86         end
  87 end
  88
  89 local function getsql(sql, ...)
  90         if params.driver == "PostgreSQL" then
  91                 sql = sql:gsub("`", "\"");
  92         end
  93         -- do prepared statement stuff
  94         local stmt, err = connection:prepare(sql);
  95         if not stmt then module:log("error", "QUERY FAILED: %s %s", err, debug.traceback()); return nil, err; end
  96         -- run query
  97         local ok, err = stmt:execute(host or "", user or "", store or "", ...);
  98         if not ok then return nil, err; end
  99
 100         return stmt;
 101 end
 102 local function setsql(sql, ...)
 103         local stmt, err = getsql(sql, ...);
 104         if not stmt then return stmt, err; end
 105         return stmt:affected();
 106 end
 107 local function transact(...)
 108         -- ...
 109 end
 110 local function rollback(...)
 111         connection:rollback(); -- FIXME check for rollback error?
 112         return ...;
 113 end
 114 local function commit(...)
 115         if not connection:commit() then return nil, "SQL commit failed"; end
 116         return ...;
 117 end
 118
 119 local function keyval_store_get()
 120         local stmt, err = getsql("SELECT * FROM `Prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 121         if not stmt then return nil, err; end
 122
 123         local haveany;
 124         local result = {};
 125         for row in stmt:rows(true) do
 126                 haveany = true;
 127                 local k = row.key;
 128                 local v = deserialize(row.type, row.value);
 129                 if k and v then
 130                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 131                                 for a,b in pairs(v) do
 132                                         result[a] = b;
 133                                 end
 134                         end
 135                 end
 136         end
 137         return commit(haveany and result or nil);
 138 end
 139 local function keyval_store_set(data)
 140         local affected, err = setsql("DELETE FROM `Prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 141
 142         if data and next(data) ~= nil then
 143                 local extradata = {};
 144                 for key, value in pairs(data) do
 145                         if type(key) == "string" and key ~= "" then
 146                                 local t, value = serialize(value);
 147                                 if not t then return rollback(t, value); end
 148                                 local ok, err = setsql("INSERT INTO `Prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 149                                 if not ok then return rollback(ok, err); end
 150                         else
 151                                 extradata[key] = value;
 152                         end
 153                 end
 154                 if next(extradata) ~= nil then
 155                         local t, extradata = serialize(extradata);
 156                         if not t then return rollback(t, extradata); end
 157                         local ok, err = setsql("INSERT INTO `Prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", "", t, extradata);
 158                         if not ok then return rollback(ok, err); end
 159                 end
 160         end
 161         return commit(true);
 162 end
 163
 164 local keyval_store = {};
 165 keyval_store.__index = keyval_store;
 166 function keyval_store:get(username)
 167         user,store = username,self.store;
 168         local success, ret, err = xpcall(keyval_store_get, debug.traceback);
 169         if success then return ret, err; else return rollback(nil, ret); end
 170 end
 171 function keyval_store:set(username, data)
 172         user,store = username,self.store;
 173         local success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
 174         if success then return ret, err; else return rollback(nil, ret); end
 175 end
 176
 177 local function map_store_get(key)
 178         local stmt, err = getsql("SELECT * FROM `Prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 179         if not stmt then return nil, err; end
 180
 181         local haveany;
 182         local result = {};
 183         for row in stmt:rows(true) do
 184                 haveany = true;
 185                 local k = row.key;
 186                 local v = deserialize(row.type, row.value);
 187                 if k and v then
 188                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 189                                 for a,b in pairs(v) do
 190                                         result[a] = b;
 191                                 end
 192                         end
 193                 end
 194         end
 195         return commit(haveany and result[key] or nil);
 196 end
 197 local function map_store_set(key, data)
 198         local affected, err = setsql("DELETE FROM `Prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 199
 200         if data and next(data) ~= nil then
 201                 if type(key) == "string" and key ~= "" then
 202                         local t, value = serialize(data);
 203                         if not t then return rollback(t, value); end
 204                         local ok, err = setsql("INSERT INTO `Prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 205                         if not ok then return rollback(ok, err); end
 206                 else
 207                         -- TODO non-string keys
 208                 end
 209         end
 210         return commit(true);
 211 end
 212
 213 local map_store = {};
 214 map_store.__index = map_store;
 215 function map_store:get(username, key)
 216         user,store = username,self.store;
 217         local success, ret, err = xpcall(function() return map_store_get(key); end, debug.traceback);
 218         if success then return ret, err; else return rollback(nil, ret); end
 219 end
 220 function map_store:set(username, key, data)
 221         user,store = username,self.store;
 222         local success, ret, err = xpcall(function() return map_store_set(key, data); end, debug.traceback);
 223         if success then return ret, err; else return rollback(nil, ret); end
 224 end
 225
 226 local list_store = {};
 227 list_store.__index = list_store;
 228 function list_store:scan(username, from, to, jid, typ)
 229         user,store = username,self.store;
 230
 231         local cols = {"from", "to", "jid", "typ"};
 232         local vals = { from ,  to ,  jid ,  typ };
 233         local stmt, err;
 234         local query = "SELECT * FROM `ProsodyArchive` WHERE `host`=? AND `user`=? AND `store`=?";
 235
 236         query = query.." ORDER BY time";
 237         --local stmt, err = getsql("SELECT * FROM `Prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 238
 239         return nil, "not-implemented"
 240 end
 241
 242 local driver = { name = "sql" };
 243
 244 function driver:open(store, typ)
 245         if not typ then -- default key-value store
 246                 return setmetatable({ store = store }, keyval_store);
 247         end
 248         return nil, "unsupported-store";
 249 end
 250
 251 module:add_item("data-driver", driver);