core.moduleapi: Add :get_option_period for parsing time intervals E.g. for use in mod_mam and others that take an amount of time before some (usually cleanup) action is taken.

author: Kim Alvefur <zash@zash.se>
date: Sun, 16 Jul 2023 19:49:12 +0200
parent: 13203:aa6c2692a4be
child: 13205:0ccd82b965d5
--- a/core/moduleapi.lua	Tue Oct 05 15:36:38 2021 +0200
+++ b/core/moduleapi.lua	Sun Jul 16 19:49:12 2023 +0200
@@ -21,6 +21,7 @@
 local jid_node = require "prosody.util.jid".node;
 local jid_split = require "prosody.util.jid".split;
 local jid_resource = require "prosody.util.jid".resource;
+local human_io = require "prosody.util.human.io";
 
 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
 local error, setmetatable, type = error, setmetatable, type;
@@ -253,6 +254,20 @@
 	return ret;
 end
 
+function api:get_option_period(name, default_value)
+	local value = self:get_option_scalar(name, default_value);
+	local num = tonumber(value);
+	if num then
+		-- assume seconds
+		return num;
+	end
+	local ret = human_io.parse_duration(value);
+	if value ~= nil and ret == nil then
+		self:log("error", "Config option '%s' not understood, expecting a period", name);
+	end
+	return ret;
+end
+
 function api:get_option_boolean(name, ...)
 	local value = self:get_option_scalar(name, ...);
 	if value == nil then