annotate mod_storage_gdbm/mod_storage_gdbm.lua @ 1603:1fbec16996f5

mod_storage_gdbm: Add support for 'limit' query parameter
author Kim Alvefur <zash@zash.se>
date Sat, 07 Feb 2015 22:22:46 +0100
parents 3912a53fd4db
children 53052a610c67
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 -- mod_storage_gdbm
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 -- Copyright (C) 2014 Kim Alvefur
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 --
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 -- This file is MIT/X11 licensed.
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 --
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 -- Depends on lgdbm:
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 -- http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lgdbm
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local gdbm = require"gdbm";
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 local path = require"util.paths";
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 local lfs = require"lfs";
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
12 local uuid = require"util.uuid".generate;
1593
d9f3c66ea938 mod_storage_gdbm: Use require directly instead of util.import (which is not available in prosodyctl, breaks adduser etc)
Kim Alvefur <zash@zash.se>
parents: 1570
diff changeset
13 local serialization = require"util.serialization";
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
14 local st = require"util.stanza";
1593
d9f3c66ea938 mod_storage_gdbm: Use require directly instead of util.import (which is not available in prosodyctl, breaks adduser etc)
Kim Alvefur <zash@zash.se>
parents: 1570
diff changeset
15 local serialize = serialization.serialize;
d9f3c66ea938 mod_storage_gdbm: Use require directly instead of util.import (which is not available in prosodyctl, breaks adduser etc)
Kim Alvefur <zash@zash.se>
parents: 1570
diff changeset
16 local deserialize = serialization.deserialize;
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
18 local function id(v) return v; end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
19
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
20 local function is_stanza(s)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
21 return getmetatable(s) == st.stanza_mt;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
22 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
23
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
24 local function ifelse(cond, iftrue, iffalse)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
25 if cond then return iftrue; end return iffalse;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
26 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
27
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 local base_path = path.resolve_relative_path(prosody.paths.data, module.host);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 lfs.mkdir(base_path);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 local cache = {};
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
33 local keyval = {};
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
34 local keyval_mt = { __index = keyval, suffix = ".db" };
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
36 function keyval:set(user, value)
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 local ok, err = gdbm.replace(self._db, user or "@", serialize(value));
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 if not ok then return nil, err; end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 return true;
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
42 function keyval:get(user)
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 local data, err = gdbm.fetch(self._db, user or "@");
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 if not data then return nil, err; end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 return deserialize(data);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
48 local archive = {};
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
49 local archive_mt = { __index = archive, suffix = ".adb" };
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
50
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
51 archive.get = keyval.get;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
52 archive.set = keyval.set;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
53
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
54 function archive:append(username, key, when, with, value)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
55 key = key or uuid();
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
56 local meta = self:get(username);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
57 if not meta then
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
58 meta = {};
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
59 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
60 local i = meta[key] or #meta+1;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
61 local type;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
62 if is_stanza(value) then
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
63 type, value = "stanza", st.preserialize(value);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
64 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
65 meta[i] = { key = key, when = when, with = with, type = type };
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
66 meta[key] = i;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
67 local ok, err = self:set(username, meta);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
68 if not ok then return nil, err; end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
69 ok, err = self:set(key, value);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
70 if not ok then return nil, err; end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
71 return key;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
72 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
73
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
74 local deserialize = {
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
75 stanza = st.deserialize;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
76 };
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
77
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
78 function archive:find(username, query)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
79 local meta = self:get(username);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
80 local r = query.reverse;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
81 local d = r and -1 or 1;
1602
3912a53fd4db mod_storage_gdbm: Get 'after' parameter from correct table
Kim Alvefur <zash@zash.se>
parents: 1596
diff changeset
82 local s = meta[ifelse(r, query.before, query.after)];
1603
1fbec16996f5 mod_storage_gdbm: Add support for 'limit' query parameter
Kim Alvefur <zash@zash.se>
parents: 1602
diff changeset
83 local limit = query.limit;
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
84 if s then
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
85 s = s + d;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
86 else
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
87 s = ifelse(r, #meta, 1)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
88 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
89 local e = ifelse(r, 1, #meta);
1603
1fbec16996f5 mod_storage_gdbm: Add support for 'limit' query parameter
Kim Alvefur <zash@zash.se>
parents: 1602
diff changeset
90 local c = 0;
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
91 return function ()
1603
1fbec16996f5 mod_storage_gdbm: Add support for 'limit' query parameter
Kim Alvefur <zash@zash.se>
parents: 1602
diff changeset
92 if limit and c >= limit then return end
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
93 local item, value;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
94 for i = s, e, d do
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
95 item = meta[i];
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
96 if (not query.with or item.with == query.with)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
97 and (not query.start or item.when >= query.start)
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
98 and (not query["end"] or item.when >= query["end"]) then
1603
1fbec16996f5 mod_storage_gdbm: Add support for 'limit' query parameter
Kim Alvefur <zash@zash.se>
parents: 1602
diff changeset
99 s = i + d; c = c + 1;
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
100 value = self:get(item.key);
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
101 return item.key, (deserialize[item.type] or id)(value), item.when, item.with;
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
102 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
103 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
104 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
105 end
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
106
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
107 local drivers = {
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
108 keyval = keyval_mt;
1596
b362e6c00fd1 mod_storage_gdbm: Add archive support
Kim Alvefur <zash@zash.se>
parents: 1595
diff changeset
109 archive = archive_mt;
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
110 }
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
111
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
112 function open(_, store, typ)
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
113 typ = typ or "keyval";
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
114 local driver_mt = drivers[typ];
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
115 if not driver_mt then
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
116 return nil, "unsupported-store";
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
117 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
118
1595
6288591d5edf mod_storage_gdbm: Prepare for supporting multiple store types
Kim Alvefur <zash@zash.se>
parents: 1593
diff changeset
119 local db_path = path.join(base_path, store) .. driver_mt.suffix;
1570
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
120
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
121 local db = cache[db_path];
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
122 if not db then
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
123 db = assert(gdbm.open(db_path, "c"));
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
124 cache[db_path] = db;
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
125 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
126 return setmetatable({ _db = db; _path = db_path; store = store, typ = type }, driver_mt);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
127 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
128
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
129 function module.unload()
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
130 for path, db in pairs(cache) do
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
131 gdbm.sync(db);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
132 gdbm.close(db);
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
133 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
134 end
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
135
67fafebdceb7 mod_storage_gdbm: Storage backend based on lgdbm
Kim Alvefur <zash@zash.se>
parents:
diff changeset
136 module:provides"storage";