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 DBI;
  32 local connection;
  33 local host,user,store = module.host;
  34 local params = module:get_option("sql");
  35
  36 local resolve_relative_path = require "core.configmanager".resolve_relative_path;
  37
  38 local function test_connection()
  39         if not connection then return nil; end
  40         if connection:ping() then
  41                 return true;
  42         else
  43                 module:log("debug", "Database connection closed");
  44                 connection = nil;
  45         end
  46 end
  47 local function connect()
  48         if not test_connection() then
  49                 prosody.unlock_globals();
  50                 local dbh, err = DBI.Connect(
  51                         params.driver, params.database,
  52                         params.username, params.password,
  53                         params.host, params.port
  54                 );
  55                 prosody.lock_globals();
  56                 if not dbh then
  57                         module:log("debug", "Database connection failed: %s", tostring(err));
  58                         return nil, err;
  59                 end
  60                 module:log("debug", "Successfully connected to database");
  61                 dbh:autocommit(false); -- don't commit automatically
  62                 connection = dbh;
  63                 return connection;
  64         end
  65 end
  66
  67 local function create_table()
  68         local create_sql = "CREATE TABLE `prosody` (`host` TEXT, `user` TEXT, `store` TEXT, `key` TEXT, `type` TEXT, `value` TEXT);";
  69         if params.driver == "PostgreSQL" then
  70                 create_sql = create_sql:gsub("`", "\"");
  71         end
  72
  73         local stmt = connection:prepare(create_sql);
  74         if stmt then
  75                 local ok = stmt:execute();
  76                 local commit_ok = connection:commit();
  77                 if ok and commit_ok then
  78                         module:log("info", "Initialized new %s database with prosody table", params.driver);
  79                         local index_sql = "CREATE INDEX `prosody_index` ON `prosody` (`host`, `user`, `store`, `key`)";
  80                         if params.driver == "PostgreSQL" then
  81                                 index_sql = index_sql:gsub("`", "\"");
  82                         elseif params.driver == "MySQL" then
  83                                 index_sql = index_sql:gsub("`([,)])", "`(20)%1");
  84                         end
  85                         local stmt, err = connection:prepare(index_sql);
  86                         local ok, commit_ok, commit_err;
  87                         if stmt then
  88                                 ok, err = stmt:execute();
  89                                 commit_ok, commit_err = connection:commit();
  90                         end
  91                         if not(ok and commit_ok) then
  92                                 module:log("warn", "Failed to create index (%s), lookups may not be optimised", err or commit_err);
  93                         end
  94                 end
  95         end
  96 end
  97
  98 do -- process options to get a db connection
  99         local ok;
 100         prosody.unlock_globals();
 101         ok, DBI = pcall(require, "DBI");
 102         if not ok then
 103                 package.loaded["DBI"] = {};
 104                 module:log("error", "Failed to load the LuaDBI library for accessing SQL databases: %s", DBI);
 105                 module:log("error", "More information on installing LuaDBI can be found at http://prosody.im/doc/depends#luadbi");
 106         end
 107         prosody.lock_globals();
 108         if not ok or not DBI.Connect then
 109                 return; -- Halt loading of this module
 110         end
 111
 112         params = params or { driver = "SQLite3" };
 113
 114         if params.driver == "SQLite3" then
 115                 params.database = resolve_relative_path(prosody.paths.data or ".", params.database or "prosody.sqlite");
 116         end
 117
 118         assert(params.driver and params.database, "Both the SQL driver and the database need to be specified");
 119
 120         assert(connect());
 121
 122         -- Automatically create table, ignore failure (table probably already exists)
 123         create_table();
 124 end
 125
 126 local function serialize(value)
 127         local t = type(value);
 128         if t == "string" or t == "boolean" or t == "number" then
 129                 return t, tostring(value);
 130         elseif t == "table" then
 131                 local value,err = json.encode(value);
 132                 if value then return "json", value; end
 133                 return nil, err;
 134         end
 135         return nil, "Unhandled value type: "..t;
 136 end
 137 local function deserialize(t, value)
 138         if t == "string" then return value;
 139         elseif t == "boolean" then
 140                 if value == "true" then return true;
 141                 elseif value == "false" then return false; end
 142         elseif t == "number" then return tonumber(value);
 143         elseif t == "json" then
 144                 return json.decode(value);
 145         end
 146 end
 147
 148 local function getsql(sql, ...)
 149         if params.driver == "PostgreSQL" then
 150                 sql = sql:gsub("`", "\"");
 151         end
 152         -- do prepared statement stuff
 153         local stmt, err = connection:prepare(sql);
 154         if not stmt and not test_connection() then error("connection failed"); end
 155         if not stmt then module:log("error", "QUERY FAILED: %s %s", err, debug.traceback()); return nil, err; end
 156         -- run query
 157         local ok, err = stmt:execute(host or "", user or "", store or "", ...);
 158         if not ok and not test_connection() then error("connection failed"); end
 159         if not ok then return nil, err; end
 160
 161         return stmt;
 162 end
 163 local function setsql(sql, ...)
 164         local stmt, err = getsql(sql, ...);
 165         if not stmt then return stmt, err; end
 166         return stmt:affected();
 167 end
 168 local function transact(...)
 169         -- ...
 170 end
 171 local function rollback(...)
 172         if connection then connection:rollback(); end -- FIXME check for rollback error?
 173         return ...;
 174 end
 175 local function commit(...)
 176         if not connection:commit() then return nil, "SQL commit failed"; end
 177         return ...;
 178 end
 179
 180 local function keyval_store_get()
 181         local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 182         if not stmt then return rollback(nil, err); end
 183
 184         local haveany;
 185         local result = {};
 186         for row in stmt:rows(true) do
 187                 haveany = true;
 188                 local k = row.key;
 189                 local v = deserialize(row.type, row.value);
 190                 if k and v then
 191                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 192                                 for a,b in pairs(v) do
 193                                         result[a] = b;
 194                                 end
 195                         end
 196                 end
 197         end
 198         return commit(haveany and result or nil);
 199 end
 200 local function keyval_store_set(data)
 201         local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 202         if not affected then return rollback(affected, err); end
 203
 204         if data and next(data) ~= nil then
 205                 local extradata = {};
 206                 for key, value in pairs(data) do
 207                         if type(key) == "string" and key ~= "" then
 208                                 local t, value = serialize(value);
 209                                 if not t then return rollback(t, value); end
 210                                 local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 211                                 if not ok then return rollback(ok, err); end
 212                         else
 213                                 extradata[key] = value;
 214                         end
 215                 end
 216                 if next(extradata) ~= nil then
 217                         local t, extradata = serialize(extradata);
 218                         if not t then return rollback(t, extradata); end
 219                         local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", "", t, extradata);
 220                         if not ok then return rollback(ok, err); end
 221                 end
 222         end
 223         return commit(true);
 224 end
 225
 226 local keyval_store = {};
 227 keyval_store.__index = keyval_store;
 228 function keyval_store:get(username)
 229         user,store = username,self.store;
 230         if not connection and not connect() then return nil, "Unable to connect to database"; end
 231         local success, ret, err = xpcall(keyval_store_get, debug.traceback);
 232         if not connection and connect() then
 233                 success, ret, err = xpcall(keyval_store_get, debug.traceback);
 234         end
 235         if success then return ret, err; else return rollback(nil, ret); end
 236 end
 237 function keyval_store:set(username, data)
 238         user,store = username,self.store;
 239         if not connection and not connect() then return nil, "Unable to connect to database"; end
 240         local success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
 241         if not connection and connect() then
 242                 success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
 243         end
 244         if success then return ret, err; else return rollback(nil, ret); end
 245 end
 246
 247 local function map_store_get(key)
 248         local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 249         if not stmt then return rollback(nil, err); end
 250
 251         local haveany;
 252         local result = {};
 253         for row in stmt:rows(true) do
 254                 haveany = true;
 255                 local k = row.key;
 256                 local v = deserialize(row.type, row.value);
 257                 if k and v then
 258                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 259                                 for a,b in pairs(v) do
 260                                         result[a] = b;
 261                                 end
 262                         end
 263                 end
 264         end
 265         return commit(haveany and result[key] or nil);
 266 end
 267 local function map_store_set(key, data)
 268         local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 269         if not affected then return rollback(affected, err); end
 270
 271         if data and next(data) ~= nil then
 272                 if type(key) == "string" and key ~= "" then
 273                         local t, value = serialize(data);
 274                         if not t then return rollback(t, value); end
 275                         local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 276                         if not ok then return rollback(ok, err); end
 277                 else
 278                         -- TODO non-string keys
 279                 end
 280         end
 281         return commit(true);
 282 end
 283
 284 local map_store = {};
 285 map_store.__index = map_store;
 286 function map_store:get(username, key)
 287         user,store = username,self.store;
 288         local success, ret, err = xpcall(function() return map_store_get(key); end, debug.traceback);
 289         if success then return ret, err; else return rollback(nil, ret); end
 290 end
 291 function map_store:set(username, key, data)
 292         user,store = username,self.store;
 293         local success, ret, err = xpcall(function() return map_store_set(key, data); end, debug.traceback);
 294         if success then return ret, err; else return rollback(nil, ret); end
 295 end
 296
 297 local list_store = {};
 298 list_store.__index = list_store;
 299 function list_store:scan(username, from, to, jid, typ)
 300         user,store = username,self.store;
 301
 302         local cols = {"from", "to", "jid", "typ"};
 303         local vals = { from ,  to ,  jid ,  typ };
 304         local stmt, err;
 305         local query = "SELECT * FROM `prosodyarchive` WHERE `host`=? AND `user`=? AND `store`=?";
 306
 307         query = query.." ORDER BY time";
 308         --local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 309
 310         return nil, "not-implemented"
 311 end
 312
 313 local driver = { name = "sql" };
 314
 315 function driver:open(store, typ)
 316         if not typ then -- default key-value store
 317                 return setmetatable({ store = store }, keyval_store);
 318         end
 319         return nil, "unsupported-store";
 320 end
 321
 322 module:add_item("data-driver", driver);