5 Prosody - key-value, map
6 | host | user | store | key | subkey | type | value |
8 | host | user | store | key | time | stanzatype | jsonvalue |
12 | host | user | "roster" | "contactjid" | item-subkey | type | value |
13 | host | user | "roster" | NULL | NULL | "json" | roster[false] data |
15 | host | user | "accounts" | "username" | NULL | 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 json = { stringify = function(s) return require"util.serialization".serialize(s) end, parse = require"util.serialization".deserialize };
30 local connection = ...;
31 local host,user,store = module.host;
33 do -- process options to get a db connection
34 local DBI = require "DBI";
36 local params = module:get_option("sql") or { driver = "SQLite3", database = "prosody.sqlite" };
37 assert(params and params.driver and params.database, "invalid params");
39 prosody.unlock_globals();
40 local dbh, err = DBI.Connect(
41 params.driver, params.database,
42 params.username, params.password,
43 params.host, params.port
45 prosody.lock_globals();
48 dbh:autocommit(false); -- don't commit automatically
51 if params.driver == "SQLite3" then -- auto initialize
52 local stmt = assert(connection:prepare("SELECT COUNT(*) FROM sqlite_master WHERE type='table' AND name='Prosody';"));
53 local ok = assert(stmt:execute());
54 local count = stmt:fetch()[1];
56 local stmt = assert(connection:prepare("CREATE TABLE Prosody (host TEXT, user TEXT, store TEXT, key TEXT, subkey TEXT, type TEXT, value TEXT);"));
57 assert(stmt:execute());
58 assert(connection:commit());
59 module:log("debug", "Initialized new SQLite3 database");
61 --print("===", json.stringify())
65 local function serialize(value)
66 local t = type(value);
67 if t == "string" or t == "boolean" or t == "number" then
68 return t, tostring(value);
69 elseif t == "table" then
70 local value,err = json.stringify(value);
71 if value then return "json", value; end
74 return nil, "Unhandled value type: "..t;
76 local function deserialize(t, value)
77 if t == "string" then return value;
78 elseif t == "boolean" then
79 if value == "true" then return true;
80 elseif value == "false" then return false; end
81 elseif t == "number" then return tonumber(value);
82 elseif t == "json" then
83 return json.parse(value);
87 local function getsql(sql, ...)
88 -- do prepared statement stuff
89 local stmt, err = connection:prepare(sql);
90 if not stmt then return nil, err; end
92 local ok, err = stmt:execute(host, user, store, ...);
93 if not ok then return nil, err; end
97 local function setsql(sql, ...)
98 local stmt, err = getsql(sql, ...);
99 if not stmt then return stmt, err; end
100 return stmt:affected();
102 local function transact(...)
105 local function rollback(...)
106 connection:rollback(); -- FIXME check for rollback error?
109 local function commit(...)
110 if not connection:commit() then return nil, "SQL commit failed"; end
114 local keyval_store = {};
115 keyval_store.__index = keyval_store;
116 function keyval_store:get(username)
117 user,store = username,self.store;
118 local stmt, err = getsql("SELECT * FROM Prosody WHERE host IS ? AND user IS ? AND store IS ? AND subkey IS NULL");
119 if not stmt then return nil, err; end
123 for row in stmt:rows(true) do
126 local v = deserialize(row.type, row.value);
128 if k then result[k] = v; elseif type(v) == "table" then
129 for a,b in pairs(v) do
135 return haveany and result or nil;
137 function keyval_store:set(username, data)
138 user,store = username,self.store;
140 local affected, err = setsql("DELETE FROM Prosody WHERE host IS ? AND user IS ? AND store IS ? AND subkey IS NULL");
142 if data and next(data) ~= nil then
143 local extradata = {};
144 for key, value in pairs(data) do
145 if type(key) == "string" 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
151 extradata[key] = value;
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 (?,?,?,?,?,?)", nil, t, extradata);
158 if not ok then return rollback(ok, err); end
164 local map_store = {};
165 map_store.__index = map_store;
166 function map_store:get(username, key)
167 user,store = username,self.store;
168 local stmt, err = getsql("SELECT * FROM Prosody WHERE host IS ? AND user IS ? AND store IS ? AND key IS ?", key);
169 if not stmt then return nil, err; end
173 for row in stmt:rows(true) do
175 local k = row.subkey;
176 local v = deserialize(row.type, row.value);
178 if k then result[k] = v; elseif type(v) == "table" then
179 for a,b in pairs(v) do
185 return haveany and result or nil;
187 function map_store:set(username, key, data)
188 user,store = username,self.store;
190 local affected, err = setsql("DELETE FROM Prosody WHERE host IS ? AND user IS ? AND store IS ? AND key IS ?", key);
192 if data and next(data) ~= nil then
193 local extradata = {};
194 for subkey, value in pairs(data) do
195 if type(subkey) == "string" then
196 local t, value = serialize(value);
197 if not t then return rollback(t, value); end
198 local ok, err = setsql("INSERT INTO Prosody (host,user,store,key,subkey,type,value) VALUES (?,?,?,?,?,?)", key, subkey, t, value);
199 if not ok then return rollback(ok, err); end
201 extradata[subkey] = value;
204 if next(extradata) ~= nil then
205 local t, extradata = serialize(extradata);
206 if not t then return rollback(t, extradata); end
207 local ok, err = setsql("INSERT INTO Prosody (host,user,store,key,subkey,type,value) VALUES (?,?,?,?,?,?)", key, nil, t, extradata);
208 if not ok then return rollback(ok, err); end
214 local list_store = {};
215 list_store.__index = list_store;
216 function list_store:scan(username, from, to, jid, typ)
217 user,store = username,self.store;
219 local cols = {"from", "to", "jid", "typ"};
220 local vals = { from , to , jid , typ };
222 local query = "SELECT * FROM ProsodyArchive WHERE host IS ? AND user IS ? AND store IS ?";
224 query = query.." ORDER BY time";
225 --local stmt, err = getsql("SELECT * FROM Prosody WHERE host IS ? AND user IS ? AND store IS ? AND key IS ?", key);
227 return nil, "not-implemented"
230 local driver = { name = "sql" };
232 function driver:open(store, typ)
233 if not typ then -- default key-value store
234 return setmetatable({ store = store }, keyval_store);
236 return nil, "unsupported-store";
239 module:add_item("data-driver", driver);