plugins/mod_storage_sql1.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 local build_url = require"socket.url".build;
  31
  32 local DBI;
  33 local connection;
  34 local host,user,store = module.host;
  35 local params = module:get_option("sql");
  36
  37 local dburi;
  38 local connections = module:shared "/*/sql/connection-cache";
  39
  40 local function db2uri(params)
  41         return build_url{
  42                 scheme = params.driver,
  43                 user = params.username,
  44                 password = params.password,
  45                 host = params.host,
  46                 port = params.port,
  47                 path = params.database,
  48         };
  49 end
  50
  51
  52 local resolve_relative_path = require "util.paths".resolve_relative_path;
  53
  54 local function test_connection()
  55         if not connection then return nil; end
  56         if connection:ping() then
  57                 return true;
  58         else
  59                 module:log("debug", "Database connection closed");
  60                 connection = nil;
  61                 connections[dburi] = nil;
  62         end
  63 end
  64 local function connect()
  65         if not test_connection() then
  66                 prosody.unlock_globals();
  67                 local dbh, err = DBI.Connect(
  68                         params.driver, params.database,
  69                         params.username, params.password,
  70                         params.host, params.port
  71                 );
  72                 prosody.lock_globals();
  73                 if not dbh then
  74                         module:log("debug", "Database connection failed: %s", tostring(err));
  75                         return nil, err;
  76                 end
  77                 module:log("debug", "Successfully connected to database");
  78                 dbh:autocommit(false); -- don't commit automatically
  79                 connection = dbh;
  80
  81                 connections[dburi] = dbh;
  82         end
  83         return connection;
  84 end
  85
  86 local function create_table()
  87         if not module:get_option("sql_manage_tables", true) then
  88                 return;
  89         end
  90         local create_sql = "CREATE TABLE `prosody` (`host` TEXT, `user` TEXT, `store` TEXT, `key` TEXT, `type` TEXT, `value` TEXT);";
  91         if params.driver == "PostgreSQL" then
  92                 create_sql = create_sql:gsub("`", "\"");
  93         elseif params.driver == "MySQL" then
  94                 create_sql = create_sql:gsub("`value` TEXT", "`value` MEDIUMTEXT");
  95         end
  96
  97         local stmt, err = connection:prepare(create_sql);
  98         if stmt then
  99                 local ok = stmt:execute();
 100                 local commit_ok = connection:commit();
 101                 if ok and commit_ok then
 102                         module:log("info", "Initialized new %s database with prosody table", params.driver);
 103                         local index_sql = "CREATE INDEX `prosody_index` ON `prosody` (`host`, `user`, `store`, `key`)";
 104                         if params.driver == "PostgreSQL" then
 105                                 index_sql = index_sql:gsub("`", "\"");
 106                         elseif params.driver == "MySQL" then
 107                                 index_sql = index_sql:gsub("`([,)])", "`(20)%1");
 108                         end
 109                         local stmt, err = connection:prepare(index_sql);
 110                         local ok, commit_ok, commit_err;
 111                         if stmt then
 112                                 ok, err = stmt:execute();
 113                                 commit_ok, commit_err = connection:commit();
 114                         end
 115                         if not(ok and commit_ok) then
 116                                 module:log("warn", "Failed to create index (%s), lookups may not be optimised", err or commit_err);
 117                         end
 118                 elseif params.driver == "MySQL" then  -- COMPAT: Upgrade tables from 0.8.0
 119                         -- Failed to create, but check existing MySQL table here
 120                         local stmt = connection:prepare("SHOW COLUMNS FROM prosody WHERE Field='value' and Type='text'");
 121                         local ok = stmt:execute();
 122                         local commit_ok = connection:commit();
 123                         if ok and commit_ok then
 124                                 if stmt:rowcount() > 0 then
 125                                         module:log("info", "Upgrading database schema...");
 126                                         local stmt = connection:prepare("ALTER TABLE prosody MODIFY COLUMN `value` MEDIUMTEXT");
 127                                         local ok, err = stmt:execute();
 128                                         local commit_ok = connection:commit();
 129                                         if ok and commit_ok then
 130                                                 module:log("info", "Database table automatically upgraded");
 131                                         else
 132                                                 module:log("error", "Failed to upgrade database schema (%s), please see "
 133                                                         .."https://prosody.im/doc/mysql for help",
 134                                                         err or "unknown error");
 135                                         end
 136                                 end
 137                                 repeat until not stmt:fetch();
 138                         end
 139                 end
 140         elseif params.driver ~= "SQLite3" then -- SQLite normally fails to prepare for existing table
 141                 module:log("warn", "Prosody was not able to automatically check/create the database table (%s), "
 142                         .."see https://prosody.im/doc/modules/mod_storage_sql#table_management for help.",
 143                         err or "unknown error");
 144         end
 145 end
 146
 147 do -- process options to get a db connection
 148         local ok;
 149         prosody.unlock_globals();
 150         ok, DBI = pcall(require, "DBI");
 151         if not ok then
 152                 package.loaded["DBI"] = {};
 153                 module:log("error", "Failed to load the LuaDBI library for accessing SQL databases: %s", DBI);
 154                 module:log("error", "More information on installing LuaDBI can be found at https://prosody.im/doc/depends#luadbi");
 155         end
 156         prosody.lock_globals();
 157         if not ok or not DBI.Connect then
 158                 return; -- Halt loading of this module
 159         end
 160
 161         params = params or { driver = "SQLite3" };
 162
 163         if params.driver == "SQLite3" then
 164                 params.database = resolve_relative_path(prosody.paths.data or ".", params.database or "prosody.sqlite");
 165         end
 166
 167         assert(params.driver and params.database, "Both the SQL driver and the database need to be specified");
 168
 169         dburi = db2uri(params);
 170         connection = connections[dburi];
 171
 172         assert(connect());
 173
 174         -- Automatically create table, ignore failure (table probably already exists)
 175         create_table();
 176 end
 177
 178 local function serialize(value)
 179         local t = type(value);
 180         if t == "string" or t == "boolean" or t == "number" then
 181                 return t, tostring(value);
 182         elseif t == "table" then
 183                 local value,err = json.encode(value);
 184                 if value then return "json", value; end
 185                 return nil, err;
 186         end
 187         return nil, "Unhandled value type: "..t;
 188 end
 189 local function deserialize(t, value)
 190         if t == "string" then return value;
 191         elseif t == "boolean" then
 192                 if value == "true" then return true;
 193                 elseif value == "false" then return false; end
 194         elseif t == "number" then return tonumber(value);
 195         elseif t == "json" then
 196                 return json.decode(value);
 197         end
 198 end
 199
 200 local function dosql(sql, ...)
 201         if params.driver == "PostgreSQL" then
 202                 sql = sql:gsub("`", "\"");
 203         end
 204         -- do prepared statement stuff
 205         local stmt, err = connection:prepare(sql);
 206         if not stmt and not test_connection() then error("connection failed"); end
 207         if not stmt then module:log("error", "QUERY FAILED: %s %s", err, debug.traceback()); return nil, err; end
 208         -- run query
 209         local ok, err = stmt:execute(...);
 210         if not ok and not test_connection() then error("connection failed"); end
 211         if not ok then return nil, err; end
 212
 213         return stmt;
 214 end
 215 local function getsql(sql, ...)
 216         return dosql(sql, host or "", user or "", store or "", ...);
 217 end
 218 local function setsql(sql, ...)
 219         local stmt, err = getsql(sql, ...);
 220         if not stmt then return stmt, err; end
 221         return stmt:affected();
 222 end
 223 local function transact(...)
 224         -- ...
 225 end
 226 local function rollback(...)
 227         if connection then connection:rollback(); end -- FIXME check for rollback error?
 228         return ...;
 229 end
 230 local function commit(...)
 231         local success,err = connection:commit();
 232         if not success then return nil, "SQL commit failed: "..tostring(err); end
 233         return ...;
 234 end
 235
 236 local function keyval_store_get()
 237         local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 238         if not stmt then return rollback(nil, err); end
 239
 240         local haveany;
 241         local result = {};
 242         for row in stmt:rows(true) do
 243                 haveany = true;
 244                 local k = row.key;
 245                 local v = deserialize(row.type, row.value);
 246                 if k and v then
 247                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 248                                 for a,b in pairs(v) do
 249                                         result[a] = b;
 250                                 end
 251                         end
 252                 end
 253         end
 254         return commit(haveany and result or nil);
 255 end
 256 local function keyval_store_set(data)
 257         local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
 258         if not affected then return rollback(affected, err); end
 259
 260         if data and next(data) ~= nil then
 261                 local extradata = {};
 262                 for key, value in pairs(data) do
 263                         if type(key) == "string" and key ~= "" then
 264                                 local t, value = serialize(value);
 265                                 if not t then return rollback(t, value); end
 266                                 local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 267                                 if not ok then return rollback(ok, err); end
 268                         else
 269                                 extradata[key] = value;
 270                         end
 271                 end
 272                 if next(extradata) ~= nil then
 273                         local t, extradata = serialize(extradata);
 274                         if not t then return rollback(t, extradata); end
 275                         local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", "", t, extradata);
 276                         if not ok then return rollback(ok, err); end
 277                 end
 278         end
 279         return commit(true);
 280 end
 281
 282 local keyval_store = {};
 283 keyval_store.__index = keyval_store;
 284 function keyval_store:get(username)
 285         user,store = username,self.store;
 286         if not connection and not connect() then return nil, "Unable to connect to database"; end
 287         local success, ret, err = xpcall(keyval_store_get, debug.traceback);
 288         if not connection and connect() then
 289                 success, ret, err = xpcall(keyval_store_get, debug.traceback);
 290         end
 291         if success then return ret, err; else return rollback(nil, ret); end
 292 end
 293 function keyval_store:set(username, data)
 294         user,store = username,self.store;
 295         if not connection and not connect() then return nil, "Unable to connect to database"; end
 296         local success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
 297         if not connection and connect() then
 298                 success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
 299         end
 300         if success then return ret, err; else return rollback(nil, ret); end
 301 end
 302 function keyval_store:users()
 303         local stmt, err = dosql("SELECT DISTINCT `user` FROM `prosody` WHERE `host`=? AND `store`=?", host, self.store);
 304         if not stmt then
 305                 return rollback(nil, err);
 306         end
 307         local next = stmt:rows();
 308         return commit(function()
 309                 local row = next();
 310                 return row and row[1];
 311         end);
 312 end
 313
 314 local function map_store_get(key)
 315         local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 316         if not stmt then return rollback(nil, err); end
 317
 318         local haveany;
 319         local result = {};
 320         for row in stmt:rows(true) do
 321                 haveany = true;
 322                 local k = row.key;
 323                 local v = deserialize(row.type, row.value);
 324                 if k and v then
 325                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 326                                 for a,b in pairs(v) do
 327                                         result[a] = b;
 328                                 end
 329                         end
 330                 end
 331         end
 332         return commit(haveany and result[key] or nil);
 333 end
 334 local function map_store_set(key, data)
 335         local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 336         if not affected then return rollback(affected, err); end
 337
 338         if data and next(data) ~= nil then
 339                 if type(key) == "string" and key ~= "" then
 340                         local t, value = serialize(data);
 341                         if not t then return rollback(t, value); end
 342                         local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
 343                         if not ok then return rollback(ok, err); end
 344                 else
 345                         -- TODO non-string keys
 346                 end
 347         end
 348         return commit(true);
 349 end
 350
 351 local map_store = {};
 352 map_store.__index = map_store;
 353 function map_store:get(username, key)
 354         user,store = username,self.store;
 355         local success, ret, err = xpcall(function() return map_store_get(key); end, debug.traceback);
 356         if success then return ret, err; else return rollback(nil, ret); end
 357 end
 358 function map_store:set(username, key, data)
 359         user,store = username,self.store;
 360         local success, ret, err = xpcall(function() return map_store_set(key, data); end, debug.traceback);
 361         if success then return ret, err; else return rollback(nil, ret); end
 362 end
 363
 364 local list_store = {};
 365 list_store.__index = list_store;
 366 function list_store:scan(username, from, to, jid, typ)
 367         user,store = username,self.store;
 368
 369         local cols = {"from", "to", "jid", "typ"};
 370         local vals = { from ,  to ,  jid ,  typ };
 371         local stmt, err;
 372         local query = "SELECT * FROM `prosodyarchive` WHERE `host`=? AND `user`=? AND `store`=?";
 373
 374         query = query.." ORDER BY time";
 375         --local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
 376
 377         return nil, "not-implemented"
 378 end
 379
 380 local driver = {};
 381
 382 function driver:open(store, typ)
 383         if typ and typ ~= "keyval" then
 384                 return nil, "unsupported-store";
 385         end
 386         return setmetatable({ store = store }, keyval_store);
 387 end
 388
 389 function driver:stores(username)
 390         local sql = "SELECT DISTINCT `store` FROM `prosody` WHERE `host`=? AND `user`" ..
 391                 (username == true and "!=?" or "=?");
 392         if username == true or not username then
 393                 username = "";
 394         end
 395         local stmt, err = dosql(sql, host, username);
 396         if not stmt then
 397                 return rollback(nil, err);
 398         end
 399         local next = stmt:rows();
 400         return commit(function()
 401                 local row = next();
 402                 return row and row[1];
 403         end);
 404 end
 405
 406 function driver:purge(username)
 407         local stmt, err = dosql("DELETE FROM `prosody` WHERE `host`=? AND `user`=?", host, username);
 408         if not stmt then return rollback(stmt, err); end
 409         local changed, err = stmt:affected();
 410         if not changed then return rollback(changed, err); end
 411         return commit(true, changed);
 412 end
 413
 414 module:provides("storage", driver);