plugins/mod_storage_sql2.lua

   1
   2 local json = require "util.json";
   3 local xml_parse = require "util.xml".parse;
   4 local uuid = require "util.uuid";
   5 local resolve_relative_path = require "util.paths".resolve_relative_path;
   6
   7 local stanza_mt = require"util.stanza".stanza_mt;
   8 local getmetatable = getmetatable;
   9 local t_concat = table.concat;
  10 local function is_stanza(x) return getmetatable(x) == stanza_mt; end
  11
  12 local noop = function() end
  13 local unpack = unpack
  14 local function iterator(result)
  15         return function(result)
  16                 local row = result();
  17                 if row ~= nil then
  18                         return unpack(row);
  19                 end
  20         end, result, nil;
  21 end
  22
  23 local mod_sql = module:require("sql");
  24 local params = module:get_option("sql");
  25
  26 local engine; -- TODO create engine
  27
  28 local function create_table()
  29         local Table,Column,Index = mod_sql.Table,mod_sql.Column,mod_sql.Index;
  30
  31         local ProsodyTable = Table {
  32                 name="prosody";
  33                 Column { name="host", type="TEXT", nullable=false };
  34                 Column { name="user", type="TEXT", nullable=false };
  35                 Column { name="store", type="TEXT", nullable=false };
  36                 Column { name="key", type="TEXT", nullable=false };
  37                 Column { name="type", type="TEXT", nullable=false };
  38                 Column { name="value", type="MEDIUMTEXT", nullable=false };
  39                 Index { name="prosody_index", "host", "user", "store", "key" };
  40         };
  41         engine:transaction(function()
  42                 ProsodyTable:create(engine);
  43         end);
  44
  45         local ProsodyArchiveTable = Table {
  46                 name="prosodyarchive";
  47                 Column { name="sort_id", type="INTEGER", primary_key=true, auto_increment=true };
  48                 Column { name="host", type="TEXT", nullable=false };
  49                 Column { name="user", type="TEXT", nullable=false };
  50                 Column { name="store", type="TEXT", nullable=false };
  51                 Column { name="key", type="TEXT", nullable=false }; -- item id
  52                 Column { name="when", type="INTEGER", nullable=false }; -- timestamp
  53                 Column { name="with", type="TEXT", nullable=false }; -- related id
  54                 Column { name="type", type="TEXT", nullable=false };
  55                 Column { name="value", type="MEDIUMTEXT", nullable=false };
  56                 Index { name="prosodyarchive_index", unique = true, "host", "user", "store", "key" };
  57         };
  58         engine:transaction(function()
  59                 ProsodyArchiveTable:create(engine);
  60         end);
  61 end
  62
  63 local function upgrade_table()
  64         if params.driver == "MySQL" then
  65                 local success,err = engine:transaction(function()
  66                         local result = engine:execute("SHOW COLUMNS FROM prosody WHERE Field='value' and Type='text'");
  67                         if result:rowcount() > 0 then
  68                                 module:log("info", "Upgrading database schema...");
  69                                 engine:execute("ALTER TABLE prosody MODIFY COLUMN `value` MEDIUMTEXT");
  70                                 module:log("info", "Database table automatically upgraded");
  71                         end
  72                         return true;
  73                 end);
  74                 if not success then
  75                         module:log("error", "Failed to check/upgrade database schema (%s), please see "
  76                                 .."http://prosody.im/doc/mysql for help",
  77                                 err or "unknown error");
  78                         return false;
  79                 end
  80                 -- COMPAT w/pre-0.9: Upgrade tables to UTF-8 if not already
  81                 local check_encoding_query = "SELECT `COLUMN_NAME`,`COLUMN_TYPE` FROM `information_schema`.`columns` WHERE `TABLE_NAME`='prosody' AND ( `CHARACTER_SET_NAME`!='utf8' OR `COLLATION_NAME`!='utf8_bin' );";
  82                 success,err = engine:transaction(function()
  83                         local result = engine:execute(check_encoding_query);
  84                         local n_bad_columns = result:rowcount();
  85                         if n_bad_columns > 0 then
  86                                 module:log("warn", "Found %d columns in prosody table requiring encoding change, updating now...", n_bad_columns);
  87                                 local fix_column_query1 = "ALTER TABLE `prosody` CHANGE `%s` `%s` BLOB;";
  88                                 local fix_column_query2 = "ALTER TABLE `prosody` CHANGE `%s` `%s` %s CHARACTER SET 'utf8' COLLATE 'utf8_bin';";
  89                                 for row in result:rows() do
  90                                         local column_name, column_type = unpack(row);
  91                                         engine:execute(fix_column_query1:format(column_name, column_name));
  92                                         engine:execute(fix_column_query2:format(column_name, column_name, column_type));
  93                                 end
  94                                 module:log("info", "Database encoding upgrade complete!");
  95                         end
  96                 end);
  97                 success,err = engine:transaction(function() return engine:execute(check_encoding_query); end);
  98                 if not success then
  99                         module:log("error", "Failed to check/upgrade database encoding: %s", err or "unknown error");
 100                 end
 101         end
 102 end
 103
 104 do -- process options to get a db connection
 105         params = params or { driver = "SQLite3" };
 106
 107         if params.driver == "SQLite3" then
 108                 params.database = resolve_relative_path(prosody.paths.data or ".", params.database or "prosody.sqlite");
 109         end
 110
 111         assert(params.driver and params.database, "Both the SQL driver and the database need to be specified");
 112
 113         --local dburi = db2uri(params);
 114         engine = mod_sql:create_engine(params);
 115
 116         if module:get_option("sql_manage_tables", true) then
 117                 -- Automatically create table, ignore failure (table probably already exists)
 118                 create_table();
 119                 -- Encoding mess
 120                 upgrade_table();
 121         end
 122 end
 123
 124 local function serialize(value)
 125         local t = type(value);
 126         if t == "string" or t == "boolean" or t == "number" then
 127                 return t, tostring(value);
 128         elseif is_stanza(value) then
 129                 return "xml", 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         elseif t == "xml" then
 146                 return xml_parse(value);
 147         end
 148 end
 149
 150 local host = module.host;
 151 local user, store;
 152
 153 local function keyval_store_get()
 154         local haveany;
 155         local result = {};
 156         for row in engine:select("SELECT `key`,`type`,`value` FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?", host, user or "", store) do
 157                 haveany = true;
 158                 local k = row[1];
 159                 local v = deserialize(row[2], row[3]);
 160                 if k and v then
 161                         if k ~= "" then result[k] = v; elseif type(v) == "table" then
 162                                 for a,b in pairs(v) do
 163                                         result[a] = b;
 164                                 end
 165                         end
 166                 end
 167         end
 168         if haveany then
 169                 return result;
 170         end
 171 end
 172 local function keyval_store_set(data)
 173         engine:delete("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?", host, user or "", store);
 174
 175         if data and next(data) ~= nil then
 176                 local extradata = {};
 177                 for key, value in pairs(data) do
 178                         if type(key) == "string" and key ~= "" then
 179                                 local t, value = serialize(value);
 180                                 assert(t, value);
 181                                 engine:insert("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", host, user or "", store, key, t, value);
 182                         else
 183                                 extradata[key] = value;
 184                         end
 185                 end
 186                 if next(extradata) ~= nil then
 187                         local t, extradata = serialize(extradata);
 188                         assert(t, extradata);
 189                         engine:insert("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", host, user or "", store, "", t, extradata);
 190                 end
 191         end
 192         return true;
 193 end
 194
 195 --- Key/value store API (default store type)
 196
 197 local keyval_store = {};
 198 keyval_store.__index = keyval_store;
 199 function keyval_store:get(username)
 200         user, store = username, self.store;
 201         local ok, result = engine:transaction(keyval_store_get);
 202         if not ok then
 203                 module:log("error", "Unable to read from database %s store for %s: %s", store, username or "<host>", result);
 204                 return nil, result;
 205         end
 206         return result;
 207 end
 208 function keyval_store:set(username, data)
 209         user,store = username,self.store;
 210         return engine:transaction(function()
 211                 return keyval_store_set(data);
 212         end);
 213 end
 214 function keyval_store:users()
 215         local ok, result = engine:transaction(function()
 216                 return engine:select("SELECT DISTINCT `user` FROM `prosody` WHERE `host`=? AND `store`=?", host, self.store);
 217         end);
 218         if not ok then return ok, result end
 219         return iterator(result);
 220 end
 221
 222 --- Archive store API
 223
 224 local archive_store = {}
 225 archive_store.__index = archive_store
 226 function archive_store:append(username, key, when, with, value)
 227         if value == nil then -- COMPAT early versions
 228                 when, with, value, key = key, when, with, value
 229         end
 230         local user,store = username,self.store;
 231         return engine:transaction(function()
 232                 if key then
 233                         engine:delete("DELETE FROM `prosodyarchive` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", host, user or "", store, key);
 234                 else
 235                         key = uuid.generate();
 236                 end
 237                 local t, value = serialize(value);
 238                 engine:insert("INSERT INTO `prosodyarchive` (`host`, `user`, `store`, `when`, `with`, `key`, `type`, `value`) VALUES (?,?,?,?,?,?,?,?)", host, user or "", store, when, with, key, t, value);
 239                 return key;
 240         end);
 241 end
 242
 243 -- Helpers for building the WHERE clause
 244 local function archive_where(query, args, where)
 245         -- Time range, inclusive
 246         if query.start then
 247                 args[#args+1] = query.start
 248                 where[#where+1] = "`when` >= ?"
 249         end
 250
 251         if query["end"] then
 252                 args[#args+1] = query["end"];
 253                 if query.start then
 254                         where[#where] = "`when` BETWEEN ? AND ?" -- is this inclusive?
 255                 else
 256                         where[#where+1] = "`when` <= ?"
 257                 end
 258         end
 259
 260         -- Related name
 261         if query.with then
 262                 where[#where+1] = "`with` = ?";
 263                 args[#args+1] = query.with
 264         end
 265
 266         -- Unique id
 267         if query.key then
 268                 where[#where+1] = "`key` = ?";
 269                 args[#args+1] = query.key
 270         end
 271 end
 272 local function archive_where_id_range(query, args, where)
 273         local args_len = #args
 274         -- Before or after specific item, exclusive
 275         if query.after then  -- keys better be unique!
 276                 where[#where+1] = "`sort_id` > (SELECT `sort_id` FROM `prosodyarchive` WHERE `key` = ? AND `host` = ? AND `user` = ? AND `store` = ? LIMIT 1)"
 277                 args[args_len+1], args[args_len+2], args[args_len+3], args[args_len+4] = query.after, args[1], args[2], args[3];
 278                 args_len = args_len + 4
 279         end
 280         if query.before then
 281                 where[#where+1] = "`sort_id` < (SELECT `sort_id` FROM `prosodyarchive` WHERE `key` = ? AND `host` = ? AND `user` = ? AND `store` = ? LIMIT 1)"
 282                 args[args_len+1], args[args_len+2], args[args_len+3], args[args_len+4] = query.before, args[1], args[2], args[3];
 283         end
 284 end
 285
 286 function archive_store:find(username, query)
 287         query = query or {};
 288         local user,store = username,self.store;
 289         local total;
 290         local ok, result = engine:transaction(function()
 291                 local sql_query = "SELECT `key`, `type`, `value`, `when` FROM `prosodyarchive` WHERE %s ORDER BY `sort_id` %s%s;";
 292                 local args = { host, user or "", store, };
 293                 local where = { "`host` = ?", "`user` = ?", "`store` = ?", };
 294
 295                 archive_where(query, args, where);
 296
 297                 -- Total matching
 298                 if query.total then
 299                         local stats = engine:select("SELECT COUNT(*) FROM `prosodyarchive` WHERE " .. t_concat(where, " AND "), unpack(args));
 300                         if stats then
 301                                 local _total = stats()
 302                                 total = _total and _total[1];
 303                         end
 304                         if query.limit == 0 then -- Skip the real query
 305                                 return noop, total;
 306                         end
 307                 end
 308
 309                 archive_where_id_range(query, args, where);
 310
 311                 if query.limit then
 312                         args[#args+1] = query.limit;
 313                 end
 314
 315                 sql_query = sql_query:format(t_concat(where, " AND "), query.reverse and "DESC" or "ASC", query.limit and " LIMIT ?" or "");
 316                 module:log("debug", sql_query);
 317                 return engine:select(sql_query, unpack(args));
 318         end);
 319         if not ok then return ok, result end
 320         return function()
 321                 local row = result();
 322                 if row ~= nil then
 323                         return row[1], deserialize(row[2], row[3]), row[4];
 324                 end
 325         end, total;
 326 end
 327
 328 function archive_store:delete(username, query)
 329         query = query or {};
 330         local user,store = username,self.store;
 331         return engine:transaction(function()
 332                 local sql_query = "DELETE FROM `prosodyarchive` WHERE %s;";
 333                 local args = { host, user or "", store, };
 334                 local where = { "`host` = ?", "`user` = ?", "`store` = ?", };
 335                 if user == true then
 336                         table.remove(args, 2);
 337                         table.remove(where, 2);
 338                 end
 339                 archive_where(query, args, where);
 340                 archive_where_id_range(query, args, where);
 341                 sql_query = sql_query:format(t_concat(where, " AND "));
 342                 module:log("debug", sql_query);
 343                 return engine:delete(sql_query, unpack(args));
 344         end);
 345 end
 346
 347 local stores = {
 348         keyval = keyval_store;
 349         archive = archive_store;
 350 };
 351
 352 --- Implement storage driver API
 353
 354 -- FIXME: Some of these operations need to operate on the archive store(s) too
 355
 356 local driver = {};
 357
 358 function driver:open(store, typ)
 359         local store_mt = stores[typ or "keyval"];
 360         if store_mt then
 361                 return setmetatable({ store = store }, store_mt);
 362         end
 363         return nil, "unsupported-store";
 364 end
 365
 366 function driver:stores(username)
 367         local query = "SELECT DISTINCT `store` FROM `prosody` WHERE `host`=? AND `user`" ..
 368                 (username == true and "!=?" or "=?");
 369         if username == true or not username then
 370                 username = "";
 371         end
 372         local ok, result = engine:transaction(function()
 373                 return engine:select(query, host, username);
 374         end);
 375         if not ok then return ok, result end
 376         return iterator(result);
 377 end
 378
 379 function driver:purge(username)
 380         return engine:transaction(function()
 381                 local stmt,err = engine:delete("DELETE FROM `prosody` WHERE `host`=? AND `user`=?", host, username);
 382                 return true, err;
 383         end);
 384 end
 385
 386 module:provides("storage", driver);
 387
 388