5 Prosody - key-value, map
6 | host | user | store | key | type | value |
8 | host | user | store | key | time | stanzatype | jsonvalue |
12 | host | user | "roster" | "contactjid" | type | value |
13 | host | user | "roster" | NULL | "json" | roster[false] data |
15 | host | user | "accounts" | "username" | type | value |
17 Offline - ProsodyArchive
18 | host | user | "offline" | "contactjid" | time | "message" | json|XML |
23 local tostring = tostring;
24 local tonumber = tonumber;
27 local setmetatable = setmetatable;
28 local xpcall = xpcall;
29 local json = require "util.json";
33 local host,user,store = module.host;
34 local params = module:get_option("sql");
36 local resolve_relative_path = require "core.configmanager".resolve_relative_path;
38 local function test_connection()
39 if not connection then return nil; end
40 if connection:ping() then
43 module:log("debug", "Database connection closed");
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
55 prosody.lock_globals();
57 module:log("debug", "Database connection failed: %s", tostring(err));
60 module:log("debug", "Successfully connected to database");
61 dbh:autocommit(false); -- don't commit automatically
67 do -- process options to get a db connection
70 params = params or { driver = "SQLite3" };
72 if params.driver == "SQLite3" then
73 params.database = resolve_relative_path(prosody.paths.data or ".", params.database or "prosody.sqlite");
76 assert(params.driver and params.database, "Both the SQL driver and the database need to be specified");
80 -- Automatically create table, ignore failure (table probably already exists)
81 local create_sql = "CREATE TABLE `prosody` (`host` TEXT, `user` TEXT, `store` TEXT, `key` TEXT, `type` TEXT, `value` TEXT);";
82 if params.driver == "PostgreSQL" then
83 create_sql = create_sql:gsub("`", "\"");
86 local stmt = connection:prepare(create_sql);
88 local ok = stmt:execute();
89 local commit_ok = connection:commit();
90 if ok and commit_ok then
91 module:log("info", "Initialized new %s database with prosody table", params.driver);
96 local function serialize(value)
97 local t = type(value);
98 if t == "string" or t == "boolean" or t == "number" then
99 return t, tostring(value);
100 elseif t == "table" then
101 local value,err = json.encode(value);
102 if value then return "json", value; end
105 return nil, "Unhandled value type: "..t;
107 local function deserialize(t, value)
108 if t == "string" then return value;
109 elseif t == "boolean" then
110 if value == "true" then return true;
111 elseif value == "false" then return false; end
112 elseif t == "number" then return tonumber(value);
113 elseif t == "json" then
114 return json.decode(value);
118 local function getsql(sql, ...)
119 if params.driver == "PostgreSQL" then
120 sql = sql:gsub("`", "\"");
122 -- do prepared statement stuff
123 local stmt, err = connection:prepare(sql);
124 if not stmt and not test_connection() then error("connection failed"); end
125 if not stmt then module:log("error", "QUERY FAILED: %s %s", err, debug.traceback()); return nil, err; end
127 local ok, err = stmt:execute(host or "", user or "", store or "", ...);
128 if not ok and not test_connection() then error("connection failed"); end
129 if not ok then return nil, err; end
133 local function setsql(sql, ...)
134 local stmt, err = getsql(sql, ...);
135 if not stmt then return stmt, err; end
136 return stmt:affected();
138 local function transact(...)
141 local function rollback(...)
142 if connection then connection:rollback(); end -- FIXME check for rollback error?
145 local function commit(...)
146 if not connection:commit() then return nil, "SQL commit failed"; end
150 local function keyval_store_get()
151 local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
152 if not stmt then return rollback(nil, err); end
156 for row in stmt:rows(true) do
159 local v = deserialize(row.type, row.value);
161 if k ~= "" then result[k] = v; elseif type(v) == "table" then
162 for a,b in pairs(v) do
168 return commit(haveany and result or nil);
170 local function keyval_store_set(data)
171 local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=?");
172 if not affected then return rollback(affected, err); end
174 if data and next(data) ~= nil then
175 local extradata = {};
176 for key, value in pairs(data) do
177 if type(key) == "string" and key ~= "" then
178 local t, value = serialize(value);
179 if not t then return rollback(t, value); end
180 local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
181 if not ok then return rollback(ok, err); end
183 extradata[key] = value;
186 if next(extradata) ~= nil then
187 local t, extradata = serialize(extradata);
188 if not t then return rollback(t, extradata); end
189 local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", "", t, extradata);
190 if not ok then return rollback(ok, err); end
196 local keyval_store = {};
197 keyval_store.__index = keyval_store;
198 function keyval_store:get(username)
199 user,store = username,self.store;
200 if not connection and not connect() then return nil, "Unable to connect to database"; end
201 local success, ret, err = xpcall(keyval_store_get, debug.traceback);
202 if not connection and connect() then
203 success, ret, err = xpcall(keyval_store_get, debug.traceback);
205 if success then return ret, err; else return rollback(nil, ret); end
207 function keyval_store:set(username, data)
208 user,store = username,self.store;
209 if not connection and not connect() then return nil, "Unable to connect to database"; end
210 local success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
211 if not connection and connect() then
212 success, ret, err = xpcall(function() return keyval_store_set(data); end, debug.traceback);
214 if success then return ret, err; else return rollback(nil, ret); end
217 local function map_store_get(key)
218 local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
219 if not stmt then return rollback(nil, err); end
223 for row in stmt:rows(true) do
226 local v = deserialize(row.type, row.value);
228 if k ~= "" then result[k] = v; elseif type(v) == "table" then
229 for a,b in pairs(v) do
235 return commit(haveany and result[key] or nil);
237 local function map_store_set(key, data)
238 local affected, err = setsql("DELETE FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
239 if not affected then return rollback(affected, err); end
241 if data and next(data) ~= nil then
242 if type(key) == "string" and key ~= "" then
243 local t, value = serialize(data);
244 if not t then return rollback(t, value); end
245 local ok, err = setsql("INSERT INTO `prosody` (`host`,`user`,`store`,`key`,`type`,`value`) VALUES (?,?,?,?,?,?)", key, t, value);
246 if not ok then return rollback(ok, err); end
248 -- TODO non-string keys
254 local map_store = {};
255 map_store.__index = map_store;
256 function map_store:get(username, key)
257 user,store = username,self.store;
258 local success, ret, err = xpcall(function() return map_store_get(key); end, debug.traceback);
259 if success then return ret, err; else return rollback(nil, ret); end
261 function map_store:set(username, key, data)
262 user,store = username,self.store;
263 local success, ret, err = xpcall(function() return map_store_set(key, data); end, debug.traceback);
264 if success then return ret, err; else return rollback(nil, ret); end
267 local list_store = {};
268 list_store.__index = list_store;
269 function list_store:scan(username, from, to, jid, typ)
270 user,store = username,self.store;
272 local cols = {"from", "to", "jid", "typ"};
273 local vals = { from , to , jid , typ };
275 local query = "SELECT * FROM `prosodyarchive` WHERE `host`=? AND `user`=? AND `store`=?";
277 query = query.." ORDER BY time";
278 --local stmt, err = getsql("SELECT * FROM `prosody` WHERE `host`=? AND `user`=? AND `store`=? AND `key`=?", key or "");
280 return nil, "not-implemented"
283 local driver = { name = "sql" };
285 function driver:open(store, typ)
286 if not typ then -- default key-value store
287 return setmetatable({ store = store }, keyval_store);
289 return nil, "unsupported-store";
292 module:add_item("data-driver", driver);