plugins/mod_storage_internal.lua
author Kim Alvefur <zash@zash.se>
Sun, 24 Mar 2024 20:39:42 +0100
changeset 13466 720aed1f5cf2
parent 13422 2374c7665d0b
permissions -rw-r--r--
util.startup: Check root after detecting platform and reading config (thanks SigmaTel71) Ensures that startup.detect_platform() runs so know whether to use the POSIX method of checking the current user or something else. Also after reading the config so we know whether the root override setting is set.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12981
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     1
local cache = require "prosody.util.cache";
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     2
local datamanager = require "prosody.core.storagemanager".olddm;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     3
local array = require "prosody.util.array";
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     4
local datetime = require "prosody.util.datetime";
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     5
local st = require "prosody.util.stanza";
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     6
local now = require "prosody.util.time".now;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     7
local id = require "prosody.util.id".medium;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     8
local jid_join = require "prosody.util.jid".join;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 11769
diff changeset
     9
local set = require "prosody.util.set";
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
    10
local it = require "prosody.util.iterators";
4085
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    11
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    12
local host = module.host;
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    13
13217
50324f66ca2a plugins: Use integer config API with interval specification where sensible
Kim Alvefur <zash@zash.se>
parents: 13191
diff changeset
    14
local archive_item_limit = module:get_option_integer("storage_archive_item_limit", 10000, 0);
13232
616c578c644f mod_storage_internal: Use integer option method for cache size
Kim Alvefur <zash@zash.se>
parents: 13217
diff changeset
    15
local archive_item_count_cache = cache.new(module:get_option_integer("storage_archive_item_limit_cache_size", 1000, 1));
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    16
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
    17
local use_shift = module:get_option_boolean("storage_archive_experimental_fast_delete", false);
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
    18
5122
b41c33dc7c36 mod_storage_*: Don't explicitly set driver name, to ease copying/renaming modules.
Waqas Hussain <waqas20@gmail.com>
parents: 5121
diff changeset
    19
local driver = {};
4085
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    20
5153
688aeac0012a mod_storage_internal, datamanager: Add support for iterating over users with data in a store
Kim Alvefur <zash@zash.se>
parents: 5133
diff changeset
    21
function driver:open(store, typ)
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    22
	local mt = self[typ or "keyval"]
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    23
	if not mt then
6283
7cf6d3a2c855 mod_storage_{none,internal,sql}: Return error for unsupported (everything but keyval) store types
Kim Alvefur <zash@zash.se>
parents: 5153
diff changeset
    24
		return nil, "unsupported-store";
7cf6d3a2c855 mod_storage_{none,internal,sql}: Return error for unsupported (everything but keyval) store types
Kim Alvefur <zash@zash.se>
parents: 5153
diff changeset
    25
	end
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    26
	return setmetatable({ store = store, type = typ }, mt);
4085
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    27
end
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    28
8023
342ce07836de mod_storage_internal: Ignore unused 'self' argument [luacheck]
Kim Alvefur <zash@zash.se>
parents: 8022
diff changeset
    29
function driver:stores(username) -- luacheck: ignore 212/self
8022
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    30
	return datamanager.stores(username, host);
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    31
end
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    32
8023
342ce07836de mod_storage_internal: Ignore unused 'self' argument [luacheck]
Kim Alvefur <zash@zash.se>
parents: 8022
diff changeset
    33
function driver:purge(user) -- luacheck: ignore 212/self
8022
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    34
	return datamanager.purge(user, host);
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    35
end
925098aad268 mod_storage_internal: Reorder methods
Kim Alvefur <zash@zash.se>
parents: 8021
diff changeset
    36
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    37
local keyval = { };
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    38
driver.keyval = { __index = keyval };
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    39
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    40
function keyval:get(user)
4085
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    41
	return datamanager.load(user, host, self.store);
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    42
end
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    43
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    44
function keyval:set(user, data)
4085
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    45
	return datamanager.store(user, host, self.store, data);
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    46
end
7699cef04740 storagemanager, mod_storage_internal: Split out default driver to mod_storage_internal, and greatly simplify storagemanager's error handling and fallback code
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    47
8021
9545d0a9401f mod_storage_internal: Separate driver from keyval implementation
Kim Alvefur <zash@zash.se>
parents: 6283
diff changeset
    48
function keyval:users()
5153
688aeac0012a mod_storage_internal, datamanager: Add support for iterating over users with data in a store
Kim Alvefur <zash@zash.se>
parents: 5133
diff changeset
    49
	return datamanager.users(host, self.store, self.type);
688aeac0012a mod_storage_internal, datamanager: Add support for iterating over users with data in a store
Kim Alvefur <zash@zash.se>
parents: 5133
diff changeset
    50
end
688aeac0012a mod_storage_internal, datamanager: Add support for iterating over users with data in a store
Kim Alvefur <zash@zash.se>
parents: 5133
diff changeset
    51
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    52
local archive = {};
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    53
driver.archive = { __index = archive };
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    54
9888
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    55
archive.caps = {
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    56
	total = true;
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    57
	quota = archive_item_limit;
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    58
	truncate = true;
11279
b8fada57faf0 mod_storage_internal: Add support for full ID range query
Kim Alvefur <zash@zash.se>
parents: 10930
diff changeset
    59
	full_id_range = true;
11282
c3907f05bed4 mod_storage_internal: Support query for set of IDs
Kim Alvefur <zash@zash.se>
parents: 11279
diff changeset
    60
	ids = true;
9888
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    61
};
9751c17f5281 mod_storage_internal,_sql: Expose archive capabilities feature set
Kim Alvefur <zash@zash.se>
parents: 9887
diff changeset
    62
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    63
function archive:append(username, key, value, when, with)
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    64
	when = when or now();
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    65
	if not st.is_stanza(value) then
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    66
		return nil, "unsupported-datatype";
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    67
	end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    68
	value = st.preserialize(st.clone(value));
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    69
	value.when = when;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    70
	value.with = with;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
    71
	value.attr.stamp = datetime.datetime(when);
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    72
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
    73
	local cache_key = jid_join(username, host, self.store);
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
    74
	local item_count = archive_item_count_cache:get(cache_key);
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    75
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    76
	if key then
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    77
		local items, err = datamanager.list_load(username, host, self.store);
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    78
		if not items and err then return items, err; end
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    79
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    80
		-- Check the quota
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    81
		item_count = items and #items or 0;
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
    82
		archive_item_count_cache:set(cache_key, item_count);
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    83
		if item_count >= archive_item_limit then
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    84
			module:log("debug", "%s reached or over quota, not adding to store", username);
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    85
			return nil, "quota-limit";
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    86
		end
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    87
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    88
		if items then
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    89
			-- Filter out any item with the same key as the one being added
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    90
			items = array(items);
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    91
			items:filter(function (item)
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    92
				return item.key ~= key;
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    93
			end);
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
    94
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    95
			value.key = key;
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    96
			items:push(value);
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    97
			local ok, err = datamanager.list_store(username, host, self.store, items);
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
    98
			if not ok then return ok, err; end
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
    99
			archive_item_count_cache:set(cache_key, #items);
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   100
			return key;
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   101
		end
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   102
	else
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   103
		if not item_count then -- Item count not cached?
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   104
			-- We need to load the list to get the number of items currently stored
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   105
			local items, err = datamanager.list_load(username, host, self.store);
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   106
			if not items and err then return items, err; end
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   107
			item_count = items and #items or 0;
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
   108
			archive_item_count_cache:set(cache_key, item_count);
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   109
		end
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   110
		if item_count >= archive_item_limit then
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   111
			module:log("debug", "%s reached or over quota, not adding to store", username);
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   112
			return nil, "quota-limit";
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   113
		end
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   114
		key = id();
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   115
	end
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   116
9899
6bd65bff03b5 mod_storage_internal: Include store name when reporting quota status
Kim Alvefur <zash@zash.se>
parents: 9892
diff changeset
   117
	module:log("debug", "%s has %d items out of %d limit in store %s", username, item_count, archive_item_limit, self.store);
9887
f76bd399267c mod_storage_internal,_sql: Add limit to number of items in an archive store (fixes #733)
Matthew Wild <mwild1@gmail.com>
parents: 9108
diff changeset
   118
8312
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   119
	value.key = key;
5281c479955a mod_storage_internal: Add support for archive key deduplication (like mod_storage_sql)
Kim Alvefur <zash@zash.se>
parents: 8176
diff changeset
   120
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   121
	local ok, err = datamanager.list_append(username, host, self.store, value);
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   122
	if not ok then return ok, err; end
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
   123
	archive_item_count_cache:set(cache_key, item_count+1);
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   124
	return key;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   125
end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   126
13140
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   127
local function binary_search(haystack, test, min, max)
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   128
	if min == nil then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   129
		min = 1;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   130
	end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   131
	if max == nil then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   132
		max = #haystack;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   133
	end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   134
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   135
	local floor = math.floor;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   136
	while min < max do
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   137
		local mid = floor((max + min) / 2);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   138
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   139
		local result = test(haystack[mid]);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   140
		if result < 0 then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   141
			max = mid;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   142
		elseif result > 0 then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   143
			min = mid + 1;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   144
		else
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   145
			return mid, haystack[mid];
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   146
		end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   147
	end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   148
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   149
	return min, nil;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   150
end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   151
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   152
function archive:find(username, query)
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   153
	local list, err = datamanager.list_open(username, host, self.store);
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   154
	if not list then
8176
3ff99d49082f mod_storage_internal: Return a noop iterator if archive is empty (fixes #920)
Kim Alvefur <zash@zash.se>
parents: 8146
diff changeset
   155
		if err then
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   156
			return list, err;
10001
7c4631d7b6fb mod_storage_internal,memory: Only return total count if requested
Kim Alvefur <zash@zash.se>
parents: 9907
diff changeset
   157
		elseif query then
10028
4a0d990253a0 mod_storage_internal: Return appropriate error even with empty archive
Kim Alvefur <zash@zash.se>
parents: 10022
diff changeset
   158
			if query.before or query.after then
4a0d990253a0 mod_storage_internal: Return appropriate error even with empty archive
Kim Alvefur <zash@zash.se>
parents: 10022
diff changeset
   159
				return nil, "item-not-found";
4a0d990253a0 mod_storage_internal: Return appropriate error even with empty archive
Kim Alvefur <zash@zash.se>
parents: 10022
diff changeset
   160
			end
10001
7c4631d7b6fb mod_storage_internal,memory: Only return total count if requested
Kim Alvefur <zash@zash.se>
parents: 9907
diff changeset
   161
			if query.total then
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   162
				return function()
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   163
				end, 0;
10001
7c4631d7b6fb mod_storage_internal,memory: Only return total count if requested
Kim Alvefur <zash@zash.se>
parents: 9907
diff changeset
   164
			end
8176
3ff99d49082f mod_storage_internal: Return a noop iterator if archive is empty (fixes #920)
Kim Alvefur <zash@zash.se>
parents: 8146
diff changeset
   165
		end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   166
		return function()
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   167
		end;
8176
3ff99d49082f mod_storage_internal: Return a noop iterator if archive is empty (fixes #920)
Kim Alvefur <zash@zash.se>
parents: 8146
diff changeset
   168
	end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   169
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   170
	local i = 0;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   171
	local iter = function()
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   172
		i = i + 1;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   173
		return list[i]
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   174
	end
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   175
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   176
	if query then
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   177
		if query.reverse then
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   178
			i = #list + 1
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   179
			iter = function()
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   180
				i = i - 1
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   181
				return list[i]
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   182
			end
13406
6877786d73d7 mod_storage_internal, tests: Fix before/after combined with the 'reverse' flag
Matthew Wild <mwild1@gmail.com>
parents: 13350
diff changeset
   183
			query.before, query.after = query.after, query.before;
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   184
		end
8092
4ba8cb75d925 mod_storage_internal: Support the 'key' archive query field
Kim Alvefur <zash@zash.se>
parents: 8026
diff changeset
   185
		if query.key then
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   186
			iter = it.filter(function(item)
8092
4ba8cb75d925 mod_storage_internal: Support the 'key' archive query field
Kim Alvefur <zash@zash.se>
parents: 8026
diff changeset
   187
				return item.key == query.key;
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   188
			end, iter);
8092
4ba8cb75d925 mod_storage_internal: Support the 'key' archive query field
Kim Alvefur <zash@zash.se>
parents: 8026
diff changeset
   189
		end
11282
c3907f05bed4 mod_storage_internal: Support query for set of IDs
Kim Alvefur <zash@zash.se>
parents: 11279
diff changeset
   190
		if query.ids then
c3907f05bed4 mod_storage_internal: Support query for set of IDs
Kim Alvefur <zash@zash.se>
parents: 11279
diff changeset
   191
			local ids = set.new(query.ids);
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   192
			iter = it.filter(function(item)
11282
c3907f05bed4 mod_storage_internal: Support query for set of IDs
Kim Alvefur <zash@zash.se>
parents: 11279
diff changeset
   193
				return ids:contains(item.key);
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   194
			end, iter);
11282
c3907f05bed4 mod_storage_internal: Support query for set of IDs
Kim Alvefur <zash@zash.se>
parents: 11279
diff changeset
   195
		end
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   196
		if query.with then
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   197
			iter = it.filter(function(item)
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   198
				return item.with == query.with;
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   199
			end, iter);
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   200
		end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   201
		if query.start then
13140
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   202
			if not query.reverse then
13422
2374c7665d0b mod_storage_internal: Fix off-by-one when searching archive for
Kim Alvefur <zash@zash.se>
parents: 13406
diff changeset
   203
				local wi = binary_search(list, function(item)
13140
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   204
					local when = item.when or datetime.parse(item.attr.stamp);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   205
					return query.start - when;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   206
				end);
13422
2374c7665d0b mod_storage_internal: Fix off-by-one when searching archive for
Kim Alvefur <zash@zash.se>
parents: 13406
diff changeset
   207
				i = wi - 1;
13140
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   208
			else
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   209
				iter = it.filter(function(item)
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   210
					local when = item.when or datetime.parse(item.attr.stamp);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   211
					return when >= query.start;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   212
				end, iter);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   213
			end
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   214
		end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   215
		if query["end"] then
13140
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   216
			if query.reverse then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   217
				local wi = binary_search(list, function(item)
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   218
					local when = item.when or datetime.parse(item.attr.stamp);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   219
					return query["end"] - when;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   220
				end);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   221
				if wi then
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   222
					i = wi + 1;
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   223
				end
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   224
			else
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   225
				iter = it.filter(function(item)
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   226
					local when = item.when or datetime.parse(item.attr.stamp);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   227
					return when <= query["end"];
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   228
				end, iter);
396db0e7084f mod_storage_internal: Use a binary search for time based ranges
Kim Alvefur <zash@zash.se>
parents: 13139
diff changeset
   229
			end
10001
7c4631d7b6fb mod_storage_internal,memory: Only return total count if requested
Kim Alvefur <zash@zash.se>
parents: 9907
diff changeset
   230
		end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   231
		if query.after then
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   232
			local found = false;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   233
			iter = it.filter(function(item)
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   234
				local found_after = found;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   235
				if item.key == query.after then
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   236
					found = true
10022
7408b9473729 mod_storage_internal: Return error if 'before' or 'after' are not found (partial fix for #1325)
Kim Alvefur <zash@zash.se>
parents: 10005
diff changeset
   237
				end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   238
				return found_after;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   239
			end, iter);
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   240
		end
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   241
		if query.before then
10022
7408b9473729 mod_storage_internal: Return error if 'before' or 'after' are not found (partial fix for #1325)
Kim Alvefur <zash@zash.se>
parents: 10005
diff changeset
   242
			local found = false;
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   243
			iter = it.filter(function(item)
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   244
				if item.key == query.before then
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   245
					found = true
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   246
				end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   247
				return not found;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   248
			end, iter);
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   249
		end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   250
		if query.limit then
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   251
			iter = it.head(query.limit, iter);
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   252
		end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   253
	end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   254
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   255
	return function()
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   256
		local item = iter();
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   257
		if item == nil then
13347
9a9455de295d mod_storage_internal: Only close lazy-loading list store abstractions
Kim Alvefur <zash@zash.se>
parents: 13344
diff changeset
   258
			if list.close then
9a9455de295d mod_storage_internal: Only close lazy-loading list store abstractions
Kim Alvefur <zash@zash.se>
parents: 13344
diff changeset
   259
				list:close();
9a9455de295d mod_storage_internal: Only close lazy-loading list store abstractions
Kim Alvefur <zash@zash.se>
parents: 13344
diff changeset
   260
			end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   261
			return
10930
c55bd98a54f8 mod_storage_internal, mod_storage_memory: Add support for query.before
Matthew Wild <mwild1@gmail.com>
parents: 10848
diff changeset
   262
		end
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   263
		local key = item.key;
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   264
		local when = item.when or item.attr and datetime.parse(item.attr.stamp);
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   265
		local with = item.with;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   266
		item.key, item.when, item.with = nil, nil, nil;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   267
		item.attr.stamp = nil;
11769
1cac469b18d0 mod_storage_internal: Stop storing XEP-0091 timestamp
Kim Alvefur <zash@zash.se>
parents: 11282
diff changeset
   268
		-- COMPAT Stored data may still contain legacy XEP-0091 timestamp
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   269
		item.attr.stamp_legacy = nil;
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   270
		item = st.deserialize(item);
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   271
		return key, item, when, with;
13139
3fd24e1945b0 mod_storage_internal: Lazy-load archive items while iterating
Kim Alvefur <zash@zash.se>
parents: 12981
diff changeset
   272
	end
8024
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   273
end
83f18982bcfd mod_storage_internal: Add basic archive store implementation
Kim Alvefur <zash@zash.se>
parents: 8023
diff changeset
   274
10841
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   275
function archive:get(username, wanted_key)
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   276
	local iter, err = self:find(username, { key = wanted_key })
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   277
	if not iter then return iter, err; end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   278
	for key, stanza, when, with in iter do
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   279
		if key == wanted_key then
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   280
			return stanza, when, with;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   281
		end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   282
	end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   283
	return nil, "item-not-found";
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   284
end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   285
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   286
function archive:set(username, key, new_value, new_when, new_with)
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   287
	local items, err = datamanager.list_load(username, host, self.store);
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   288
	if not items then
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   289
		if err then
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   290
			return items, err;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   291
		else
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   292
			return nil, "item-not-found";
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   293
		end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   294
	end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   295
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   296
	for i = 1, #items do
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   297
		local old_item = items[i];
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   298
		if old_item.key == key then
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   299
			local item = st.preserialize(st.clone(new_value));
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   300
10846
5a6ba2f38e2b mod_storage_internal: Fix keeping old timestamp in archive map API
Kim Alvefur <zash@zash.se>
parents: 10841
diff changeset
   301
			local when = new_when or old_item.when or datetime.parse(old_item.attr.stamp);
10841
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   302
			item.key = key;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   303
			item.when = when;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   304
			item.with = new_with or old_item.with;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   305
			item.attr.stamp = datetime.datetime(when);
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   306
			items[i] = item;
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   307
			return datamanager.list_store(username, host, self.store, items);
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   308
		end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   309
	end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   310
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   311
	return nil, "item-not-found";
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   312
end
f23363380599 mod_storage_internal: Implement key-value API
Kim Alvefur <zash@zash.se>
parents: 10227
diff changeset
   313
8026
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   314
function archive:dates(username)
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   315
	local items, err = datamanager.list_load(username, host, self.store);
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   316
	if not items then return items, err; end
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   317
	return array(items):pluck("when"):map(datetime.date):unique();
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   318
end
5a9d491cc714 mod_storage_internal: Add the dates method
Kim Alvefur <zash@zash.se>
parents: 8025
diff changeset
   319
9907
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   320
function archive:summary(username, query)
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   321
	local iter, err = self:find(username, query)
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   322
	if not iter then return iter, err; end
10224
1e2b444acb72 mod_storage_*: Tweak :summary API to allow future expansion with more fields
Kim Alvefur <zash@zash.se>
parents: 10028
diff changeset
   323
	local counts = {};
10226
51f145094648 mod_storage_*: Also include timestmap of first message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10225
diff changeset
   324
	local earliest = {};
10225
068692cb9e78 mod_storage_*: Include timestamp of latest message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10224
diff changeset
   325
	local latest = {};
10227
d185c4961ee0 mod_storage_internal: Include last text message
Kim Alvefur <zash@zash.se>
parents: 10226
diff changeset
   326
	local body = {};
d185c4961ee0 mod_storage_internal: Include last text message
Kim Alvefur <zash@zash.se>
parents: 10226
diff changeset
   327
	for _, stanza, when, with in iter do
10224
1e2b444acb72 mod_storage_*: Tweak :summary API to allow future expansion with more fields
Kim Alvefur <zash@zash.se>
parents: 10028
diff changeset
   328
		counts[with] = (counts[with] or 0) + 1;
10226
51f145094648 mod_storage_*: Also include timestmap of first message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10225
diff changeset
   329
		if earliest[with] == nil then
51f145094648 mod_storage_*: Also include timestmap of first message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10225
diff changeset
   330
			earliest[with] = when;
51f145094648 mod_storage_*: Also include timestmap of first message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10225
diff changeset
   331
		end
10225
068692cb9e78 mod_storage_*: Include timestamp of latest message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10224
diff changeset
   332
		latest[with] = when;
10227
d185c4961ee0 mod_storage_internal: Include last text message
Kim Alvefur <zash@zash.se>
parents: 10226
diff changeset
   333
		body[with] = stanza:get_child_text("body") or body[with];
9907
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   334
	end
10224
1e2b444acb72 mod_storage_*: Tweak :summary API to allow future expansion with more fields
Kim Alvefur <zash@zash.se>
parents: 10028
diff changeset
   335
	return {
1e2b444acb72 mod_storage_*: Tweak :summary API to allow future expansion with more fields
Kim Alvefur <zash@zash.se>
parents: 10028
diff changeset
   336
		counts = counts;
10226
51f145094648 mod_storage_*: Also include timestmap of first message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10225
diff changeset
   337
		earliest = earliest;
10225
068692cb9e78 mod_storage_*: Include timestamp of latest message in :summary API
Kim Alvefur <zash@zash.se>
parents: 10224
diff changeset
   338
		latest = latest;
10227
d185c4961ee0 mod_storage_internal: Include last text message
Kim Alvefur <zash@zash.se>
parents: 10226
diff changeset
   339
		body = body;
10224
1e2b444acb72 mod_storage_*: Tweak :summary API to allow future expansion with more fields
Kim Alvefur <zash@zash.se>
parents: 10028
diff changeset
   340
	};
9907
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   341
end
2c5546cc5c70 mod_storage_internal: Implement a summary API returning message counts per contact
Kim Alvefur <zash@zash.se>
parents: 9899
diff changeset
   342
10005
55f5588d71c6 mod_storage_internal: Add support for iterating over users in archive stores
Kim Alvefur <zash@zash.se>
parents: 10001
diff changeset
   343
function archive:users()
55f5588d71c6 mod_storage_internal: Add support for iterating over users in archive stores
Kim Alvefur <zash@zash.se>
parents: 10001
diff changeset
   344
	return datamanager.users(host, self.store, "list");
55f5588d71c6 mod_storage_internal: Add support for iterating over users in archive stores
Kim Alvefur <zash@zash.se>
parents: 10001
diff changeset
   345
end
55f5588d71c6 mod_storage_internal: Add support for iterating over users in archive stores
Kim Alvefur <zash@zash.se>
parents: 10001
diff changeset
   346
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   347
function archive:trim(username, to_when)
13350
53c347043cb5 mod_storage_internal: Clear archive item count cache after experimental trim
Kim Alvefur <zash@zash.se>
parents: 13348
diff changeset
   348
	local cache_key = jid_join(username, host, self.store);
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   349
	local list, err = datamanager.list_open(username, host, self.store);
13267
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   350
	if not list then
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   351
		if err == nil then
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   352
			module:log("debug", "store already empty, can't trim");
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   353
			return 0;
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   354
		end
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   355
		return list, err;
e77994e88940 mod_storage_internal: Don't report error when attempting to trim empty archive
Kim Alvefur <zash@zash.se>
parents: 13266
diff changeset
   356
	end
13266
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   357
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   358
	-- shortcut: check if the last item should be trimmed, if so, drop the whole archive
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   359
	local last = list[#list].when or datetime.parse(list[#list].attr.stamp);
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   360
	if last <= to_when then
13348
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   361
		if list.close then
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   362
			list:close()
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   363
		end
13266
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   364
		return datamanager.list_store(username, host, self.store, nil);
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   365
	end
9a86e7cbdd79 mod_storage_internal: Fix fast trimming of archive with exactly one item
Kim Alvefur <zash@zash.se>
parents: 13232
diff changeset
   366
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   367
	-- luacheck: ignore 211/exact
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   368
	local i, exact = binary_search(list, function(item)
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   369
		local when = item.when or datetime.parse(item.attr.stamp);
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   370
		return to_when - when;
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   371
	end);
13348
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   372
	if list.close then
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   373
		list:close()
958c759d3897 mod_storage_internal: Close lazy-loading list abstraction after trim
Kim Alvefur <zash@zash.se>
parents: 13347
diff changeset
   374
	end
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   375
	-- TODO if exact then ... off by one?
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   376
	if i == 1 then return 0; end
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   377
	local ok, err = datamanager.list_shift(username, host, self.store, i);
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   378
	if not ok then return ok, err; end
13350
53c347043cb5 mod_storage_internal: Clear archive item count cache after experimental trim
Kim Alvefur <zash@zash.se>
parents: 13348
diff changeset
   379
	archive_item_count_cache:set(cache_key, nil); -- TODO calculate how many items are left
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   380
	return i-1;
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   381
end
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   382
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   383
function archive:delete(username, query)
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
   384
	local cache_key = jid_join(username, host, self.store);
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   385
	if not query or next(query) == nil then
13350
53c347043cb5 mod_storage_internal: Clear archive item count cache after experimental trim
Kim Alvefur <zash@zash.se>
parents: 13348
diff changeset
   386
		archive_item_count_cache:set(cache_key, nil); -- nil because we don't check if the following succeeds
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   387
		return datamanager.list_store(username, host, self.store, nil);
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   388
	end
13191
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   389
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   390
	if use_shift and next(query) == "end" and next(query, "end") == nil then
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   391
		return self:trim(username, query["end"]);
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   392
	end
fe1229919070 mod_storage_internal: Implement efficient deletion of oldest archive items
Kim Alvefur <zash@zash.se>
parents: 13140
diff changeset
   393
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   394
	local items, err = datamanager.list_load(username, host, self.store);
8146
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   395
	if not items then
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   396
		if err then
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   397
			return items, err;
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   398
		end
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
   399
		archive_item_count_cache:set(cache_key, 0);
8146
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   400
		-- Store is empty
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   401
		return 0;
c4c159953c72 mod_storage_internal: Handle case of empty item store when deleting (fixes #910)
Kim Alvefur <zash@zash.se>
parents: 8145
diff changeset
   402
	end
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   403
	items = array(items);
8145
13e075549cb3 mod_storage_internal: Correctly calculate number of deleted items (fixes #912)
Kim Alvefur <zash@zash.se>
parents: 8092
diff changeset
   404
	local count_before = #items;
8313
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   405
	if query then
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   406
		if query.key then
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   407
			items:filter(function (item)
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   408
				return item.key ~= query.key;
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   409
			end);
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   410
		end
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   411
		if query.with then
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   412
			items:filter(function (item)
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   413
				return item.with ~= query.with;
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   414
			end);
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   415
		end
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   416
		if query.start then
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   417
			items:filter(function (item)
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   418
				return item.when < query.start;
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   419
			end);
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   420
		end
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   421
		if query["end"] then
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   422
			items:filter(function (item)
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   423
				return item.when > query["end"];
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   424
			end);
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   425
		end
9108
e735c9865f42 mod_storage_internal: Only apply truncate if there are more items than requested
Kim Alvefur <zash@zash.se>
parents: 8405
diff changeset
   426
		if query.truncate and #items > query.truncate then
8396
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   427
			if query.reverse then
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   428
				-- Before: { 1, 2, 3, 4, 5, }
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   429
				-- After: { 1, 2, 3 }
8397
4892c22403d5 mod_storage_internal: Optimize truncation
Kim Alvefur <zash@zash.se>
parents: 8396
diff changeset
   430
				for i = #items, query.truncate + 1, -1 do
4892c22403d5 mod_storage_internal: Optimize truncation
Kim Alvefur <zash@zash.se>
parents: 8396
diff changeset
   431
					items[i] = nil;
8396
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   432
				end
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   433
			else
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   434
				-- Before: { 1, 2, 3, 4, 5, }
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   435
				-- After: { 3, 4, 5 }
8397
4892c22403d5 mod_storage_internal: Optimize truncation
Kim Alvefur <zash@zash.se>
parents: 8396
diff changeset
   436
				local offset = #items - query.truncate;
4892c22403d5 mod_storage_internal: Optimize truncation
Kim Alvefur <zash@zash.se>
parents: 8396
diff changeset
   437
				for i = 1, #items do
4892c22403d5 mod_storage_internal: Optimize truncation
Kim Alvefur <zash@zash.se>
parents: 8396
diff changeset
   438
					items[i] = items[i+offset];
8396
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   439
				end
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   440
			end
b6a7b83f8d87 mod_storage_internal: Allow truncating deletion at the beginning or end of an archive store
Kim Alvefur <zash@zash.se>
parents: 8313
diff changeset
   441
		end
8313
1759491b53db mod_storage_internal: Add more extensive query support to archive:delete method
Kim Alvefur <zash@zash.se>
parents: 8312
diff changeset
   442
	end
8145
13e075549cb3 mod_storage_internal: Correctly calculate number of deleted items (fixes #912)
Kim Alvefur <zash@zash.se>
parents: 8092
diff changeset
   443
	local count = count_before - #items;
8405
469afa02947b mod_storage_internal: Skip write if no items matched a deletion query
Kim Alvefur <zash@zash.se>
parents: 8397
diff changeset
   444
	if count == 0 then
469afa02947b mod_storage_internal: Skip write if no items matched a deletion query
Kim Alvefur <zash@zash.se>
parents: 8397
diff changeset
   445
		return 0; -- No changes, skip write
469afa02947b mod_storage_internal: Skip write if no items matched a deletion query
Kim Alvefur <zash@zash.se>
parents: 8397
diff changeset
   446
	end
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   447
	local ok, err = datamanager.list_store(username, host, self.store, items);
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   448
	if not ok then return ok, err; end
9889
64e16d1e91f6 mod_storage_internal,_sql: Key item count cache on both username and store
Kim Alvefur <zash@zash.se>
parents: 9888
diff changeset
   449
	archive_item_count_cache:set(cache_key, #items);
8025
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   450
	return count;
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   451
end
05e201468f27 mod_storage_internal: Add support for removing archived items
Kim Alvefur <zash@zash.se>
parents: 8024
diff changeset
   452
5121
b5a5643f8572 core.storagemanager, mod_storage_*: "data-driver" -> "storage-provider", to allow using module:provides().
Waqas Hussain <waqas20@gmail.com>
parents: 5039
diff changeset
   453
module:provides("storage", driver);