Module:Age: Difference between revisions
m (Protected "Module:Age": High-risk Lua module; 1,000+ transclusions ([Edit=Require autoconfirmed or confirmed access] (indefinite))) |
(update from sandbox: sortable=table; ranges of more time units; no default sort key in Template:Age in years and days; implement Template:Birth date and age; experimental range=no) |
||
Line 1: | Line 1: | ||
-- Implement various "age of" and other date-related templates. | -- Implement various "age of" and other date-related templates. | ||
local _Date, | local _Date, _currentDate | ||
local function | local function getExports(frame) | ||
-- Return objects exported from the date module or its sandbox. | -- Return objects exported from the date module or its sandbox. | ||
if not _Date then | if not _Date then | ||
Line 8: | Line 8: | ||
local datemod = require('Module:Date' .. sandbox) | local datemod = require('Module:Date' .. sandbox) | ||
_Date = datemod._Date | _Date = datemod._Date | ||
_currentDate = datemod._current | |||
end | end | ||
return _Date, | return _Date, _currentDate | ||
end | end | ||
local | local Collection -- a table to hold items | ||
Collection = { | |||
add = function (self, item) | |||
if item ~= nil then | |||
self.n = self.n + 1 | self.n = self.n + 1 | ||
self[self.n] = item | self[self.n] = item | ||
end, | end | ||
end, | |||
join = function (self, sep) | |||
end, | return table.concat(self, sep) | ||
} | end, | ||
end | remove = function (self, pos) | ||
if self.n > 0 and (pos == nil or (0 < pos and pos <= self.n)) then | |||
self.n = self.n - 1 | |||
return table.remove(self, pos) | |||
end | |||
end, | |||
sort = function (self, comp) | |||
table.sort(self, comp) | |||
end, | |||
new = function () | |||
return setmetatable({n = 0}, Collection) | |||
end | |||
} | |||
Collection.__index = Collection | |||
local function | local function stripToNil(text) | ||
-- If text is a string, return its trimmed content, or nil if empty. | -- If text is a string, return its trimmed content, or nil if empty. | ||
-- Otherwise return text (which may, for example, be nil). | -- Otherwise return text (which may, for example, be nil). | ||
Line 43: | Line 55: | ||
end | end | ||
local function message(msg, | local function message(msg, id) | ||
-- Return formatted message text for an error. | -- Return formatted message text for an error or warning. | ||
local categories = { | |||
error = '[[Category:Age error]]', | |||
local category | warning = '[[Category:Age error]]', -- same as error until determine whether 'Age warning' would be worthwhile | ||
if | } | ||
local a, b, category | |||
if id == 'warning' then | |||
a = '<sup>[<i>' | |||
b = '</i>]</sup>' | |||
else | else | ||
category = '' | a = '<strong class="error">Error: ' | ||
b = '</strong>' | |||
end | |||
if mw.title.getCurrentTitle():inNamespaces(0) then | |||
-- Category only in namespaces: 0=article. | |||
category = categories[id or 'error'] | |||
end | end | ||
return | return | ||
a .. | |||
mw.text.nowiki(msg) .. | mw.text.nowiki(msg) .. | ||
b .. | |||
category | (category or '') | ||
end | end | ||
local function | local function formatNumber(number) | ||
-- Return the given number formatted with commas as group separators, | -- Return the given number formatted with commas as group separators, | ||
-- given that the number is an integer. | -- given that the number is an integer. | ||
local numstr = tostring(number) | local numstr = tostring(number) | ||
local length = #numstr | local length = #numstr | ||
local places = | local places = Collection.new() | ||
local pos = 0 | local pos = 0 | ||
repeat | repeat | ||
Line 73: | Line 92: | ||
until pos >= length | until pos >= length | ||
places:add(length) | places:add(length) | ||
local groups = | local groups = Collection.new() | ||
for i = places.n, 2, -1 do | for i = places.n, 2, -1 do | ||
local p1 = length - places[i] + 1 | local p1 = length - places[i] + 1 | ||
Line 82: | Line 101: | ||
end | end | ||
local function | local function makeSort(value, sortable) | ||
-- Return a sort key | -- Return a sort key if requested. | ||
-- Assume value is a valid number which has not overflowed. | -- Assume value is a valid number which has not overflowed. | ||
if sortable == 'sortable_on' or sortable == 'sortable_debug' then | if sortable == 'sortable_table' or sortable == 'sortable_on' or sortable == 'sortable_debug' then | ||
local sortkey | local sortkey | ||
if value == 0 then | if value == 0 then | ||
Line 100: | Line 119: | ||
sortkey = string.format('%d', prefix) .. string.format('%015.0f', math.floor(value * 10^(14-mag))) | sortkey = string.format('%d', prefix) .. string.format('%015.0f', math.floor(value * 10^(14-mag))) | ||
end | end | ||
local lhs = sortable == 'sortable_debug' and | local lhs, rhs | ||
if sortable == 'sortable_table' then | |||
lhs = 'data-sort-value="' | |||
return lhs .. sortkey .. | rhs = '"|' | ||
else | |||
lhs = sortable == 'sortable_debug' and | |||
'<span style="border:1px solid;display:inline;" class="sortkey">' or | |||
'<span style="display:none" class="sortkey">' | |||
rhs = '♠</span>' | |||
end | |||
return lhs .. sortkey .. rhs | |||
end | end | ||
end | end | ||
local | local translateParameters = { | ||
abbr = { | abbr = { | ||
off = 'abbr_off', | off = 'abbr_off', | ||
Line 141: | Line 167: | ||
ymw = { 'y', 'm', 'w', id = 'ymw' }, | ymw = { 'y', 'm', 'w', id = 'ymw' }, | ||
ymwd = { 'y', 'm', 'w', 'd', id = 'ymwd' }, | ymwd = { 'y', 'm', 'w', 'd', id = 'ymwd' }, | ||
yd = { 'y', 'd', id = 'yd', | yd = { 'y', 'd', id = 'yd', keepZero = true }, | ||
m = { 'm', id = 'm' }, | m = { 'm', id = 'm' }, | ||
md = { 'm', 'd', id = 'md' }, | md = { 'm', 'd', id = 'md' }, | ||
Line 161: | Line 187: | ||
off = false, | off = false, | ||
on = 'sortable_on', | on = 'sortable_on', | ||
table = 'sortable_table', | |||
debug = 'sortable_debug', | debug = 'sortable_debug', | ||
}, | }, | ||
} | } | ||
local function | local function dateExtract(frame) | ||
-- Return part of a date after performing an optional operation. | -- Return part of a date after performing an optional operation. | ||
local Date = | local Date = getExports(frame) | ||
local args = frame:getParent().args | local args = frame:getParent().args | ||
local parms = {} | local parms = {} | ||
Line 183: | Line 210: | ||
return message('Need valid date') | return message('Need valid date') | ||
end | end | ||
local add = | local add = stripToNil(args.add) | ||
if add then | if add then | ||
for item in add:gmatch('%S+') do | for item in add:gmatch('%S+') do | ||
Line 193: | Line 220: | ||
end | end | ||
local prefix, result | local prefix, result | ||
local sortable = | local sortable = translateParameters.sortable[args.sortable] | ||
if sortable then | if sortable then | ||
local value = (date.partial and date.partial.first or date).jdz | local value = (date.partial and date.partial.first or date).jdz | ||
prefix = | prefix = makeSort(value, sortable) | ||
end | end | ||
local show = | local show = stripToNil(args.show) or 'dmy' | ||
if show ~= 'hide' then | if show ~= 'hide' then | ||
result = date[show] | result = date[show] | ||
Line 212: | Line 239: | ||
end | end | ||
local function | local function makeText(values, components, names, options) | ||
-- Return wikitext representing an age or duration. | -- Return wikitext representing an age or duration. | ||
local text = | local text = Collection.new() | ||
local count = #values | local count = #values | ||
local sep = names.sep or '' | local sep = names.sep or '' | ||
Line 220: | Line 247: | ||
-- v is a number (say 4 for 4 years), or a table ({4,5} for 4 or 5 years). | -- v is a number (say 4 for 4 years), or a table ({4,5} for 4 or 5 years). | ||
local islist = type(v) == 'table' | local islist = type(v) == 'table' | ||
if (islist or v > 0) or (text.n == 0 and i == count) or (text.n > 0 and components. | if (islist or v > 0) or (text.n == 0 and i == count) or (text.n > 0 and components.keepZero) then | ||
local fmt, vstr | local fmt, vstr | ||
if i == 1 and options.format == 'format_commas' then | if i == 1 and options.format == 'format_commas' then | ||
-- Numbers after the first should be small and not need formatting. | -- Numbers after the first should be small and not need formatting. | ||
fmt = | fmt = formatNumber | ||
else | else | ||
fmt = tostring | fmt = tostring | ||
Line 283: | Line 310: | ||
end | end | ||
local function | local function dateDifference(parms) | ||
-- Return a formatted date difference using the given parameters | -- Return a formatted date difference using the given parameters | ||
-- which have been validated. | -- which have been validated. | ||
Line 323: | Line 350: | ||
local show = parms.show -- may be nil; default is set below | local show = parms.show -- may be nil; default is set below | ||
local abbr = parms.abbr or 'abbr_off' | local abbr = parms.abbr or 'abbr_off' | ||
local | local defaultJoin | ||
if abbr ~= 'abbr_off' then | if abbr ~= 'abbr_off' then | ||
defaultJoin = 'sep_space' | |||
end | end | ||
if not show then | if not show then | ||
Line 331: | Line 358: | ||
if parms.disp == 'disp_age' then | if parms.disp == 'disp_age' then | ||
if diff.years < 3 then | if diff.years < 3 then | ||
defaultJoin = 'sep_space' | |||
if diff.years >= 1 then | if diff.years >= 1 then | ||
show = 'ym' | show = 'ym' | ||
Line 343: | Line 370: | ||
end | end | ||
if type(show) ~= 'table' then | if type(show) ~= 'table' then | ||
show = | show = translateParameters.show[show] | ||
end | end | ||
if parms.disp == 'disp_raw' then | if parms.disp == 'disp_raw' then | ||
defaultJoin = 'sep_space' | |||
abbr = 'abbr_raw' | abbr = 'abbr_raw' | ||
elseif parms. | elseif parms.wantSc then | ||
defaultJoin = 'sep_serialcomma' | |||
end | end | ||
local | local diffOptions = { | ||
round = parms.round, | round = parms.round, | ||
duration = parms. | duration = parms.wantDuration, | ||
range = parms.range and true or nil, | range = parms.range and true or nil, | ||
} | } | ||
local prefix | local prefix | ||
if parms.sortable then | if parms.sortable then | ||
local value = diff.age_days + (parms. | local value = diff.age_days + (parms.wantDuration and 1 or 0) -- days and fraction of a day | ||
if diff.isnegative then | if diff.isnegative then | ||
value = -value | value = -value | ||
end | end | ||
prefix = | prefix = makeSort(value, parms.sortable) | ||
end | end | ||
local | local textOptions = { | ||
prefix = prefix, | prefix = prefix, | ||
suffix = parms.suffix, -- not currently used | suffix = parms.suffix, -- not currently used | ||
format = parms.format, | format = parms.format, | ||
join = parms.sep or | join = parms.sep or defaultJoin, | ||
isnegative = diff.isnegative, | isnegative = diff.isnegative, | ||
range = parms.range, | range = parms.range, | ||
Line 375: | Line 402: | ||
return prefix or '' | return prefix or '' | ||
end | end | ||
local values = { diff:age(show.id, | local values = { diff:age(show.id, diffOptions) } | ||
if values[1] then | if values[1] then | ||
return | return makeText(values, show, names[abbr], textOptions) | ||
end | |||
if diff.partial then | |||
-- Handle a more complex range such as | |||
-- {{age_yd|20 Dec 2001|2003|range=yes}} → 1 year, 12 days or 2 years, 11 days | |||
local opt = { | |||
format = textOptions.format, | |||
join = textOptions.join, | |||
isnegative = textOptions.isnegative, | |||
} | |||
return | |||
(textOptions.prefix or '') .. | |||
makeText({ diff.partial.mindiff:age(show.id, diffOptions) }, show, names[abbr], opt) .. | |||
(textOptions.range == 'dash' and '–' or ' or ') .. | |||
makeText({ diff.partial.maxdiff:age(show.id, diffOptions) }, show, names[abbr], opt) .. | |||
(textOptions.suffix or '') | |||
end | end | ||
return message('Parameter show=' .. show.id .. ' is not supported here') | return message('Parameter show=' .. show.id .. ' is not supported here') | ||
end | end | ||
local function | local function getDates(frame, getopt) | ||
-- Parse template parameters and return one of: | -- Parse template parameters and return one of: | ||
-- * date (a date table, if single) | -- * date (a date table, if single) | ||
Line 388: | Line 430: | ||
-- * text (a string error message) | -- * text (a string error message) | ||
-- A missing date is replaced with the current date. | -- A missing date is replaced with the current date. | ||
-- If | -- If wantMixture is true, a missing date component is replaced | ||
-- from the current date, so can get a bizarre mixture of | -- from the current date, so can get a bizarre mixture of | ||
-- specified/current y/m/d as has been done by some "age" templates. | -- specified/current y/m/d as has been done by some "age" templates. | ||
-- Some results may be placed in table getopt. | -- Some results may be placed in table getopt. | ||
local Date, | local Date, currentDate = getExports(frame) | ||
getopt = getopt or {} | getopt = getopt or {} | ||
local fix = getopt.fix and 'fix' or '' | local fix = getopt.fix and 'fix' or '' | ||
local partial = getopt. | local partial = getopt.partial and 'partial' or '' | ||
local args = frame:getParent().args | local args = frame:getParent().args | ||
local fields = {} | local fields = {} | ||
local | local isNamed = args.year or args.year1 or args.year2 or | ||
args.month or args.month1 or args.month2 or | args.month or args.month1 or args.month2 or | ||
args.day or args.day1 or args.day2 | args.day or args.day1 or args.day2 | ||
if | if isNamed then | ||
fields[1] = args.year1 or args.year | fields[1] = args.year1 or args.year | ||
fields[2] = args.month1 or args.month | fields[2] = args.month1 or args.month | ||
Line 415: | Line 457: | ||
local imax = 0 | local imax = 0 | ||
for i = 1, 6 do | for i = 1, 6 do | ||
fields[i] = | fields[i] = stripToNil(fields[i]) | ||
if fields[i] then | if fields[i] then | ||
imax = i | imax = i | ||
end | end | ||
end | end | ||
local | local noDefault = imax == 0 and getopt.noMissing | ||
local dates = {} | local dates = {} | ||
if | if isNamed or imax >= 3 then | ||
local | local nrDates = getopt.single and 1 or 2 | ||
if getopt. | if getopt.wantMixture then | ||
-- Cannot be partial since empty fields are set from current. | -- Cannot be partial since empty fields are set from current. | ||
local components = { 'year', 'month', 'day' } | local components = { 'year', 'month', 'day' } | ||
for i = 1, | for i = 1, nrDates * 3 do | ||
fields[i] = fields[i] or | fields[i] = fields[i] or currentDate[components[i > 3 and i - 3 or i]] | ||
end | end | ||
for i = 1, | for i = 1, nrDates do | ||
local index = i == 1 and 1 or 4 | local index = i == 1 and 1 or 4 | ||
dates[i] = Date(fields[index], fields[index+1], fields[index+2]) | dates[i] = Date(fields[index], fields[index+1], fields[index+2]) | ||
end | end | ||
else | else | ||
for i = 1, | for i = 1, nrDates do | ||
local index = i == 1 and 1 or 4 | local index = i == 1 and 1 or 4 | ||
local y, m, d = fields[index], fields[index+1], fields[index+2] | local y, m, d = fields[index], fields[index+1], fields[index+2] | ||
if (partial and y) or (y and m and d) then | if (partial and y) or (y and m and d) then | ||
dates[i] = Date(fix, partial, y, m, d) | dates[i] = Date(fix, partial, y, m, d) | ||
elseif not | elseif not y and not m and not d and not noDefault then | ||
dates[i] = Date('currentdate') | dates[i] = Date('currentdate') | ||
end | end | ||
end | end | ||
end | end | ||
elseif not noDefault then | |||
getopt.textdates = true | getopt.textdates = true -- have parsed each date from a single text field | ||
dates[1] = Date(fix, partial, fields[1] or 'currentdate') | dates[1] = Date(fix, partial, fields[1] or 'currentdate') | ||
if not single then | if not getopt.single then | ||
dates[2] = Date(fix, partial, fields[2] or 'currentdate') | dates[2] = Date(fix, partial, fields[2] or 'currentdate') | ||
end | end | ||
Line 455: | Line 497: | ||
return message('Need valid year, month, day') | return message('Need valid year, month, day') | ||
end | end | ||
if single then | if getopt.single then | ||
return dates[1] | return dates[1] | ||
end | end | ||
Line 464: | Line 506: | ||
end | end | ||
local function | local function ageGeneric(frame) | ||
-- Return the result required by the specified template. | -- Return the result required by the specified template. | ||
-- Can use sortable=x where x = on/off/debug in any supported template. | -- Can use sortable=x where x = on/table/off/debug in any supported template. | ||
-- Some templates default to sortable=on but can be overridden | -- Some templates default to sortable=on but can be overridden. | ||
local name = frame.args.template | local name = frame.args.template | ||
if not name then | if not name then | ||
Line 542: | Line 584: | ||
format = 'format_commas', | format = 'format_commas', | ||
sep = args.sep ~= 'and' and 'sep_comma' or nil, | sep = args.sep ~= 'and' and 'sep_comma' or nil, | ||
}, | }, | ||
age_yd_nts = { -- {{age in years and days nts}} | age_yd_nts = { -- {{age in years and days nts}} | ||
Line 560: | Line 601: | ||
age_ymwd = { -- {{age in years, months, weeks and days}} | age_ymwd = { -- {{age in years, months, weeks and days}} | ||
show = 'ymwd', | show = 'ymwd', | ||
wantMixture = true, | |||
}, | }, | ||
} | } | ||
Line 568: | Line 609: | ||
end | end | ||
if name == 'age_days' then | if name == 'age_days' then | ||
local su = | local su = stripToNil(args['show unit']) | ||
if su then | if su then | ||
if su == 'abbr' or su == 'full' then | if su == 'abbr' or su == 'full' then | ||
Line 576: | Line 617: | ||
end | end | ||
end | end | ||
local range = spec.range or yes( | local partial | ||
local range = stripToNil(args.range) or spec.range | |||
if range then | |||
-- Suppose partial dates are used and age could be 11 or 12 years. | |||
-- "|range=" (empty value) has no effect (spec is used). | |||
-- "|range=yes" or spec.range == true sets range = true (gives "11 or 12") | |||
-- "|range=dash" sets range = 'dash' (gives "11–12"). | |||
-- "|range=no" sets range = nil (gives "12"). | |||
-- Above gives a good result with age in years, but is probably unhelpful for other cases. | |||
-- {{age in years|year1=1900|year2=1910|range=no}} → 10 | |||
-- {{age in days|year1=1900|year2=1910|range=no}} → 4016 (from 1900-01-01 to 1910-12-31) | |||
-- "|range=OTHER" sets range = nil and rejects partial dates. | |||
range = ({ dash = 'dash', no = 'no', [true] = true })[range] or yes(range) | |||
if range then | |||
partial = true -- accept partial dates with a possible age range for the result | |||
if range == 'no' then | |||
range = nil | |||
end | |||
end | |||
end | |||
local getopt = { | local getopt = { | ||
fix = yes(args.fix), | fix = yes(args.fix), | ||
partial = partial, | |||
wantMixture = spec.wantMixture, | |||
} | } | ||
local date1, date2 = | local date1, date2 = getDates(frame, getopt) | ||
if type(date1) == 'string' then | if type(date1) == 'string' then | ||
return date1 | return date1 | ||
end | end | ||
local format = | local format = stripToNil(args.format) | ||
if format then | if format then | ||
format = 'format_' .. format | format = 'format_' .. format | ||
Line 594: | Line 654: | ||
local parms = { | local parms = { | ||
diff = date2 - date1, | diff = date2 - date1, | ||
wantDuration = spec.duration or yes(args.duration), | |||
range = range, | range = range, | ||
wantSc = yes(args.sc), | |||
show = args.show == 'hide' and 'hide' or spec.show, | show = args.show == 'hide' and 'hide' or spec.show, | ||
abbr = spec.abbr, | abbr = spec.abbr, | ||
Line 603: | Line 663: | ||
round = yes(args.round), | round = yes(args.round), | ||
sep = spec.sep, | sep = spec.sep, | ||
sortable = | sortable = translateParameters.sortable[args.sortable or spec.sortable], | ||
} | } | ||
if (spec.negative or frame.args.negative) == 'error' and parms.diff.isnegative then | if (spec.negative or frame.args.negative) == 'error' and parms.diff.isnegative then | ||
return message('The second date should not be before the first date') | return message('The second date should not be before the first date') | ||
end | end | ||
return | return dateDifference(parms) | ||
end | |||
local function bda(frame) | |||
-- Implement [[Template:Birth date and age]]. | |||
local args = frame:getParent().args | |||
local options = { noMissing=true, single=true } | |||
local date = getDates(frame, options) | |||
if type(date) == 'string' then | |||
return date -- error text | |||
end | |||
local Date = getExports(frame) | |||
local diff = Date('currentdate') - date | |||
if diff.isnegative or diff.years > 150 then | |||
return message('Invalid birth date for calculating age') | |||
end | |||
local disp, show = 'disp_raw', 'y' | |||
if diff.years < 2 then | |||
disp = 'disp_age' | |||
if diff.years == 0 and diff.months == 0 then | |||
show = 'd' | |||
else | |||
show = 'm' | |||
end | |||
end | |||
local df = stripToNil(args.df) -- day first (dmy); default is month first (mdy) | |||
local result = df and | |||
'%-d %B %-Y' or | |||
'%B %-d, %-Y' | |||
result = '(<span class="bday">%-Y-%m-%d</span>) </span>' .. result | |||
result = '<span style="display:none"> ' .. | |||
date:text(result) .. | |||
'<span class="noprint ForceAgeToShow"> ' .. | |||
'(age ' .. | |||
dateDifference({ | |||
diff = diff, | |||
show = show, | |||
abbr = 'abbr_off', | |||
disp = disp, | |||
sep = 'sep_space', | |||
}) .. | |||
')</span>' | |||
local warnings = tonumber(frame.args.warnings) | |||
if warnings and warnings > 0 then | |||
local good = { | |||
df = true, | |||
mf = true, | |||
template = true, | |||
day = true, | |||
day1 = true, | |||
month = true, | |||
month1 = true, | |||
year = true, | |||
year1 = true, | |||
} | |||
local invalid | |||
local imax = options.textdates and 1 or 3 | |||
for k, _ in pairs(args) do | |||
if type(k) == 'number' then | |||
if k > imax then | |||
invalid = tostring(k) | |||
break | |||
end | |||
else | |||
if not good[k] then | |||
invalid = k | |||
break | |||
end | |||
end | |||
end | |||
if invalid then | |||
result = result .. message('invalid parameter ' .. invalid, 'warning') | |||
end | |||
end | |||
return result | |||
end | end | ||
local function | local function dateToGsd(frame) | ||
-- | -- Implement [[Template:Gregorian serial date]]. | ||
-- Return Gregorian serial date of the given date, or the current date. | -- Return Gregorian serial date of the given date, or the current date. | ||
-- The returned value is negative for dates before 1 January 1 AD | -- The returned value is negative for dates before 1 January 1 AD | ||
-- despite the fact that GSD is not defined for such dates. | -- despite the fact that GSD is not defined for such dates. | ||
local date = | local date = getDates(frame, { wantMixture=true, single=true }) | ||
if type(date) == 'string' then | if type(date) == 'string' then | ||
return date | return date | ||
Line 623: | Line 757: | ||
end | end | ||
local function | local function jdToDate(frame) | ||
-- Return formatted date from a Julian date. | -- Return formatted date from a Julian date. | ||
-- The result includes a time if the input includes a fraction. | -- The result includes a time if the input includes a fraction. | ||
-- The word 'Julian' is accepted for the Julian calendar. | -- The word 'Julian' is accepted for the Julian calendar. | ||
local Date = | local Date = getExports(frame) | ||
local args = frame:getParent().args | local args = frame:getParent().args | ||
local date = Date('juliandate', args[1], args[2]) | local date = Date('juliandate', args[1], args[2]) | ||
Line 636: | Line 770: | ||
end | end | ||
local function | local function dateToJd(frame) | ||
-- Return Julian date (a number) from a date which may include a time, | -- Return Julian date (a number) from a date which may include a time, | ||
-- or the current date ('currentdate') or current date and time ('currentdatetime'). | -- or the current date ('currentdate') or current date and time ('currentdatetime'). | ||
-- The word 'Julian' is accepted for the Julian calendar. | -- The word 'Julian' is accepted for the Julian calendar. | ||
local Date = | local Date = getExports(frame) | ||
local args = frame:getParent().args | local args = frame:getParent().args | ||
local date = Date(args[1], args[2], args[3], args[4], args[5], args[6], args[7]) | local date = Date(args[1], args[2], args[3], args[4], args[5], args[6], args[7]) | ||
Line 649: | Line 783: | ||
end | end | ||
local function | local function timeInterval(frame) | ||
-- | -- Implement [[Template:Time interval]]. | ||
-- There are two positional arguments: date1, date2. | -- There are two positional arguments: date1, date2. | ||
-- The default for each is the current date and time. | -- The default for each is the current date and time. | ||
-- Result is date2 - date1 formatted. | -- Result is date2 - date1 formatted. | ||
local Date = | local Date = getExports(frame) | ||
local args = frame:getParent().args | local args = frame:getParent().args | ||
local parms = { | local parms = { | ||
wantDuration = yes(args.duration), | |||
range = yes(args.range) or (args.range == 'dash' and 'dash' or nil), | range = yes(args.range) or (args.range == 'dash' and 'dash' or nil), | ||
wantSc = yes(args.sc), | |||
} | } | ||
local fix = yes(args.fix) and 'fix' or '' | local fix = yes(args.fix) and 'fix' or '' | ||
local date1 = Date(fix, 'partial', | local date1 = Date(fix, 'partial', stripToNil(args[1]) or 'currentdatetime') | ||
if not date1 then | if not date1 then | ||
return message('Invalid start date in first parameter') | return message('Invalid start date in first parameter') | ||
end | end | ||
local date2 = Date(fix, 'partial', | local date2 = Date(fix, 'partial', stripToNil(args[2]) or 'currentdatetime') | ||
if not date2 then | if not date2 then | ||
return message('Invalid end date in second parameter') | return message('Invalid end date in second parameter') | ||
end | end | ||
parms.diff = date2 - date1 | parms.diff = date2 - date1 | ||
for argname, translate in pairs( | for argname, translate in pairs(translateParameters) do | ||
local parm = | local parm = stripToNil(args[argname]) | ||
if parm then | if parm then | ||
parm = translate[parm] | parm = translate[parm] | ||
Line 690: | Line 824: | ||
end | end | ||
else | else | ||
parms.show = | parms.show = translateParameters.show[round] | ||
end | end | ||
end | end | ||
parms.round = true | parms.round = true | ||
end | end | ||
return | return dateDifference(parms) | ||
end | end | ||
return { | return { | ||
age_generic = | age_generic = ageGeneric, -- can emulate several age templates | ||
gsd = | birth_date_and_age = bda, -- Template:Birth_date_and_age | ||
extract = | gsd = dateToGsd, -- Template:Gregorian_serial_date | ||
jd_to_date = | extract = dateExtract, -- Template:Extract | ||
JULIANDAY = | jd_to_date = jdToDate, -- Template:? | ||
time_interval = | JULIANDAY = dateToJd, -- Template:JULIANDAY | ||
time_interval = timeInterval, -- Template:Time_interval | |||
} | } |
Revision as of 04:45, 28 February 2018
Documentation for this module may be created at Module:Age/doc
-- Implement various "age of" and other date-related templates. local _Date, _currentDate local function getExports(frame) -- Return objects exported from the date module or its sandbox. if not _Date then local sandbox = frame:getTitle():find('sandbox', 1, true) and '/sandbox' or '' local datemod = require('Module:Date' .. sandbox) _Date = datemod._Date _currentDate = datemod._current end return _Date, _currentDate end local Collection -- a table to hold items Collection = { add = function (self, item) if item ~= nil then self.n = self.n + 1 self[self.n] = item end end, join = function (self, sep) return table.concat(self, sep) end, remove = function (self, pos) if self.n > 0 and (pos == nil or (0 < pos and pos <= self.n)) then self.n = self.n - 1 return table.remove(self, pos) end end, sort = function (self, comp) table.sort(self, comp) end, new = function () return setmetatable({n = 0}, Collection) end } Collection.__index = Collection local function stripToNil(text) -- If text is a string, return its trimmed content, or nil if empty. -- Otherwise return text (which may, for example, be nil). if type(text) == 'string' then text = text:match('(%S.-)%s*$') end return text end local function yes(parameter) -- Return true if parameter should be interpreted as "yes". -- Do not want to accept mixed upper/lowercase unless done by current templates. -- Need to accept "on" because "round=on" is wanted. return ({ y = true, yes = true, on = true })[parameter] end local function message(msg, id) -- Return formatted message text for an error or warning. local categories = { error = '[[Category:Age error]]', warning = '[[Category:Age error]]', -- same as error until determine whether 'Age warning' would be worthwhile } local a, b, category if id == 'warning' then a = '<sup>[<i>' b = '</i>]</sup>' else a = '<strong class="error">Error: ' b = '</strong>' end if mw.title.getCurrentTitle():inNamespaces(0) then -- Category only in namespaces: 0=article. category = categories[id or 'error'] end return a .. mw.text.nowiki(msg) .. b .. (category or '') end local function formatNumber(number) -- Return the given number formatted with commas as group separators, -- given that the number is an integer. local numstr = tostring(number) local length = #numstr local places = Collection.new() local pos = 0 repeat places:add(pos) pos = pos + 3 until pos >= length places:add(length) local groups = Collection.new() for i = places.n, 2, -1 do local p1 = length - places[i] + 1 local p2 = length - places[i - 1] groups:add(numstr:sub(p1, p2)) end return groups:join(',') end local function makeSort(value, sortable) -- Return a sort key if requested. -- Assume value is a valid number which has not overflowed. if sortable == 'sortable_table' or sortable == 'sortable_on' or sortable == 'sortable_debug' then local sortkey if value == 0 then sortkey = '5000000000000000000' else local mag = math.floor(math.log10(math.abs(value)) + 1e-14) local prefix if value > 0 then prefix = 7000 + mag else prefix = 2999 - mag value = value + 10^(mag+1) end sortkey = string.format('%d', prefix) .. string.format('%015.0f', math.floor(value * 10^(14-mag))) end local lhs, rhs if sortable == 'sortable_table' then lhs = 'data-sort-value="' rhs = '"|' else lhs = sortable == 'sortable_debug' and '<span style="border:1px solid;display:inline;" class="sortkey">' or '<span style="display:none" class="sortkey">' rhs = '♠</span>' end return lhs .. sortkey .. rhs end end local translateParameters = { abbr = { off = 'abbr_off', on = 'abbr_on', }, disp = { age = 'disp_age', raw = 'disp_raw', }, format = { raw = 'format_raw', commas = 'format_commas', }, round = { on = 'on', yes = 'on', months = 'ym', weeks = 'ymw', days = 'ymd', hours = 'ymdh', }, sep = { comma = 'sep_comma', [','] = 'sep_comma', serialcomma = 'sep_serialcomma', space = 'sep_space', }, show = { hide = { id = 'hide' }, y = { 'y', id = 'y' }, ym = { 'y', 'm', id = 'ym' }, ymd = { 'y', 'm', 'd', id = 'ymd' }, ymw = { 'y', 'm', 'w', id = 'ymw' }, ymwd = { 'y', 'm', 'w', 'd', id = 'ymwd' }, yd = { 'y', 'd', id = 'yd', keepZero = true }, m = { 'm', id = 'm' }, md = { 'm', 'd', id = 'md' }, w = { 'w', id = 'w' }, wd = { 'w', 'd', id = 'wd' }, h = { 'H', id = 'h' }, hm = { 'H', 'M', id = 'hm' }, hms = { 'H', 'M', 'S', id = 'hms' }, d = { 'd', id = 'd' }, dh = { 'd', 'H', id = 'dh' }, dhm = { 'd', 'H', 'M', id = 'dhm' }, dhms = { 'd', 'H', 'M', 'S', id = 'dhms' }, ymdh = { 'y', 'm', 'd', 'H', id = 'ymdh' }, ymdhm = { 'y', 'm', 'd', 'H', 'M', id = 'ymdhm' }, ymwdh = { 'y', 'm', 'w', 'd', 'H', id = 'ymwdh' }, ymwdhm = { 'y', 'm', 'w', 'd', 'H', 'M', id = 'ymwdhm' }, }, sortable = { off = false, on = 'sortable_on', table = 'sortable_table', debug = 'sortable_debug', }, } local function dateExtract(frame) -- Return part of a date after performing an optional operation. local Date = getExports(frame) local args = frame:getParent().args local parms = {} for i, v in ipairs(args) do parms[i] = v end if yes(args.fix) then table.insert(parms, 'fix') end if yes(args.partial) then table.insert(parms, 'partial') end local date = Date(unpack(parms)) if not date then return message('Need valid date') end local add = stripToNil(args.add) if add then for item in add:gmatch('%S+') do date = date + item if not date then return message('Cannot add "' .. item .. '"') end end end local prefix, result local sortable = translateParameters.sortable[args.sortable] if sortable then local value = (date.partial and date.partial.first or date).jdz prefix = makeSort(value, sortable) end local show = stripToNil(args.show) or 'dmy' if show ~= 'hide' then result = date[show] if result == nil then result = date:text(show) elseif type(result) == 'boolean' then result = result and '1' or '0' else result = tostring(result) end end return (prefix or '') .. (result or '') end local function makeText(values, components, names, options) -- Return wikitext representing an age or duration. local text = Collection.new() local count = #values local sep = names.sep or '' for i, v in ipairs(values) do -- v is a number (say 4 for 4 years), or a table ({4,5} for 4 or 5 years). local islist = type(v) == 'table' if (islist or v > 0) or (text.n == 0 and i == count) or (text.n > 0 and components.keepZero) then local fmt, vstr if i == 1 and options.format == 'format_commas' then -- Numbers after the first should be small and not need formatting. fmt = formatNumber else fmt = tostring end if islist then local join = options.range == 'dash' and '–' or ' or ' vstr = fmt(v[1]) .. join .. fmt(v[2]) else vstr = fmt(v) end local name = names[components[i]] if name then local plural = names.plural if not plural or (islist and v[2] or v) == 1 then plural = '' end text:add(vstr .. sep .. name .. plural) else text:add(vstr) end end end local first, last if options.join == 'sep_space' then first = ' ' last = ' ' elseif options.join == 'sep_comma' then first = ', ' last = ', ' elseif options.join == 'sep_serialcomma' and text.n > 2 then first = ', ' last = ', and ' else first = ', ' last = ' and ' end for i, v in ipairs(text) do if i < text.n then text[i] = v .. (i + 1 < text.n and first or last) end end local sign = '' if options.isnegative then -- Do not display negative zero. if text.n > 1 or (text.n == 1 and text[1]:sub(1, 1) ~= '0' ) then if options.format == 'format_raw' then sign = '-' -- plain hyphen so result can be used in a calculation else sign = '−' -- Unicode U+2212 MINUS SIGN end end end return (options.prefix or '') .. sign .. text:join() .. (options.suffix or '') end local function dateDifference(parms) -- Return a formatted date difference using the given parameters -- which have been validated. local names = { abbr_off = { plural = 's', sep = ' ', y = 'year', m = 'month', w = 'week', d = 'day', H = 'hour', M = 'minute', S = 'second', }, abbr_on = { y = 'y', m = 'm', w = 'w', d = 'd', H = 'h', M = 'm', S = 's', }, abbr_infant = { -- for {{age for infant}} plural = 's', sep = ' ', y = 'yr', m = 'mo', w = 'wk', d = 'day', H = 'hr', M = 'min', S = 'sec', }, abbr_raw = {}, } local diff = parms.diff -- must be a valid date difference local show = parms.show -- may be nil; default is set below local abbr = parms.abbr or 'abbr_off' local defaultJoin if abbr ~= 'abbr_off' then defaultJoin = 'sep_space' end if not show then show = 'ymd' if parms.disp == 'disp_age' then if diff.years < 3 then defaultJoin = 'sep_space' if diff.years >= 1 then show = 'ym' else show = 'md' end else show = 'y' end end end if type(show) ~= 'table' then show = translateParameters.show[show] end if parms.disp == 'disp_raw' then defaultJoin = 'sep_space' abbr = 'abbr_raw' elseif parms.wantSc then defaultJoin = 'sep_serialcomma' end local diffOptions = { round = parms.round, duration = parms.wantDuration, range = parms.range and true or nil, } local prefix if parms.sortable then local value = diff.age_days + (parms.wantDuration and 1 or 0) -- days and fraction of a day if diff.isnegative then value = -value end prefix = makeSort(value, parms.sortable) end local textOptions = { prefix = prefix, suffix = parms.suffix, -- not currently used format = parms.format, join = parms.sep or defaultJoin, isnegative = diff.isnegative, range = parms.range, } if show.id == 'hide' then return prefix or '' end local values = { diff:age(show.id, diffOptions) } if values[1] then return makeText(values, show, names[abbr], textOptions) end if diff.partial then -- Handle a more complex range such as -- {{age_yd|20 Dec 2001|2003|range=yes}} → 1 year, 12 days or 2 years, 11 days local opt = { format = textOptions.format, join = textOptions.join, isnegative = textOptions.isnegative, } return (textOptions.prefix or '') .. makeText({ diff.partial.mindiff:age(show.id, diffOptions) }, show, names[abbr], opt) .. (textOptions.range == 'dash' and '–' or ' or ') .. makeText({ diff.partial.maxdiff:age(show.id, diffOptions) }, show, names[abbr], opt) .. (textOptions.suffix or '') end return message('Parameter show=' .. show.id .. ' is not supported here') end local function getDates(frame, getopt) -- Parse template parameters and return one of: -- * date (a date table, if single) -- * date1, date2 (two date tables, if not single) -- * text (a string error message) -- A missing date is replaced with the current date. -- If wantMixture is true, a missing date component is replaced -- from the current date, so can get a bizarre mixture of -- specified/current y/m/d as has been done by some "age" templates. -- Some results may be placed in table getopt. local Date, currentDate = getExports(frame) getopt = getopt or {} local fix = getopt.fix and 'fix' or '' local partial = getopt.partial and 'partial' or '' local args = frame:getParent().args local fields = {} local isNamed = args.year or args.year1 or args.year2 or args.month or args.month1 or args.month2 or args.day or args.day1 or args.day2 if isNamed then fields[1] = args.year1 or args.year fields[2] = args.month1 or args.month fields[3] = args.day1 or args.day fields[4] = args.year2 fields[5] = args.month2 fields[6] = args.day2 else for i = 1, 6 do fields[i] = args[i] end end local imax = 0 for i = 1, 6 do fields[i] = stripToNil(fields[i]) if fields[i] then imax = i end end local noDefault = imax == 0 and getopt.noMissing local dates = {} if isNamed or imax >= 3 then local nrDates = getopt.single and 1 or 2 if getopt.wantMixture then -- Cannot be partial since empty fields are set from current. local components = { 'year', 'month', 'day' } for i = 1, nrDates * 3 do fields[i] = fields[i] or currentDate[components[i > 3 and i - 3 or i]] end for i = 1, nrDates do local index = i == 1 and 1 or 4 dates[i] = Date(fields[index], fields[index+1], fields[index+2]) end else for i = 1, nrDates do local index = i == 1 and 1 or 4 local y, m, d = fields[index], fields[index+1], fields[index+2] if (partial and y) or (y and m and d) then dates[i] = Date(fix, partial, y, m, d) elseif not y and not m and not d and not noDefault then dates[i] = Date('currentdate') end end end elseif not noDefault then getopt.textdates = true -- have parsed each date from a single text field dates[1] = Date(fix, partial, fields[1] or 'currentdate') if not getopt.single then dates[2] = Date(fix, partial, fields[2] or 'currentdate') end end if not dates[1] then return message('Need valid year, month, day') end if getopt.single then return dates[1] end if not dates[2] then return message('Second date should be year, month, day') end return dates[1], dates[2] end local function ageGeneric(frame) -- Return the result required by the specified template. -- Can use sortable=x where x = on/table/off/debug in any supported template. -- Some templates default to sortable=on but can be overridden. local name = frame.args.template if not name then return message('The template invoking this must have "|template=x" where x is the wanted operation') end local args = frame:getParent().args local specs = { age_days = { -- {{age in days}} show = 'd', disp = 'disp_raw', }, age_days_nts = { -- {{age in days nts}} show = 'd', disp = 'disp_raw', format = 'format_commas', sortable = 'on', }, duration_days = { -- {{duration in days}} show = 'd', disp = 'disp_raw', duration = true, }, duration_days_nts = { -- {{duration in days nts}} show = 'd', disp = 'disp_raw', format = 'format_commas', sortable = 'on', duration = true, }, age_full_years = { -- {{age}} show = 'y', abbr = 'abbr_raw', }, age_full_years_nts = { -- {{age nts}} show = 'y', abbr = 'abbr_raw', format = 'format_commas', sortable = 'on', }, age_in_years = { -- {{age in years}} show = 'y', abbr = 'abbr_raw', negative = 'error', range = 'dash', }, age_in_years_nts = { -- {{age in years nts}} show = 'y', abbr = 'abbr_raw', negative = 'error', range = 'dash', format = 'format_commas', sortable = 'on', }, age_infant = { -- {{age for infant}} -- Do not set show because special processing is done later. abbr = yes(args.abbr) and 'abbr_infant' or 'abbr_off', disp = 'disp_age', sep = 'sep_space', sortable = 'on', }, age_m = { -- {{age in months}} show = 'm', disp = 'disp_raw', }, age_w = { -- {{age in weeks}} show = 'w', disp = 'disp_raw', }, age_wd = { -- {{age in weeks and days}} show = 'wd', }, age_yd = { -- {{age in years and days}} show = 'yd', format = 'format_commas', sep = args.sep ~= 'and' and 'sep_comma' or nil, }, age_yd_nts = { -- {{age in years and days nts}} show = 'yd', format = 'format_commas', sep = args.sep ~= 'and' and 'sep_comma' or nil, sortable = 'on', }, age_ym = { -- {{age in years and months}} show = 'ym', sep = 'sep_comma', }, age_ymd = { -- {{age in years, months and days}} show = 'ymd', range = true, }, age_ymwd = { -- {{age in years, months, weeks and days}} show = 'ymwd', wantMixture = true, }, } local spec = specs[name] if not spec then return message('The specified template name is not valid') end if name == 'age_days' then local su = stripToNil(args['show unit']) if su then if su == 'abbr' or su == 'full' then spec.disp = nil spec.abbr = su == 'abbr' and 'abbr_on' or nil end end end local partial local range = stripToNil(args.range) or spec.range if range then -- Suppose partial dates are used and age could be 11 or 12 years. -- "|range=" (empty value) has no effect (spec is used). -- "|range=yes" or spec.range == true sets range = true (gives "11 or 12") -- "|range=dash" sets range = 'dash' (gives "11–12"). -- "|range=no" sets range = nil (gives "12"). -- Above gives a good result with age in years, but is probably unhelpful for other cases. -- {{age in years|year1=1900|year2=1910|range=no}} → 10 -- {{age in days|year1=1900|year2=1910|range=no}} → 4016 (from 1900-01-01 to 1910-12-31) -- "|range=OTHER" sets range = nil and rejects partial dates. range = ({ dash = 'dash', no = 'no', [true] = true })[range] or yes(range) if range then partial = true -- accept partial dates with a possible age range for the result if range == 'no' then range = nil end end end local getopt = { fix = yes(args.fix), partial = partial, wantMixture = spec.wantMixture, } local date1, date2 = getDates(frame, getopt) if type(date1) == 'string' then return date1 end local format = stripToNil(args.format) if format then format = 'format_' .. format elseif name == 'age_days' and getopt.textdates then format = 'format_commas' end local parms = { diff = date2 - date1, wantDuration = spec.duration or yes(args.duration), range = range, wantSc = yes(args.sc), show = args.show == 'hide' and 'hide' or spec.show, abbr = spec.abbr, disp = spec.disp, format = format or spec.format, round = yes(args.round), sep = spec.sep, sortable = translateParameters.sortable[args.sortable or spec.sortable], } if (spec.negative or frame.args.negative) == 'error' and parms.diff.isnegative then return message('The second date should not be before the first date') end return dateDifference(parms) end local function bda(frame) -- Implement [[Template:Birth date and age]]. local args = frame:getParent().args local options = { noMissing=true, single=true } local date = getDates(frame, options) if type(date) == 'string' then return date -- error text end local Date = getExports(frame) local diff = Date('currentdate') - date if diff.isnegative or diff.years > 150 then return message('Invalid birth date for calculating age') end local disp, show = 'disp_raw', 'y' if diff.years < 2 then disp = 'disp_age' if diff.years == 0 and diff.months == 0 then show = 'd' else show = 'm' end end local df = stripToNil(args.df) -- day first (dmy); default is month first (mdy) local result = df and '%-d %B %-Y' or '%B %-d, %-Y' result = '(<span class="bday">%-Y-%m-%d</span>) </span>' .. result result = '<span style="display:none"> ' .. date:text(result) .. '<span class="noprint ForceAgeToShow"> ' .. '(age ' .. dateDifference({ diff = diff, show = show, abbr = 'abbr_off', disp = disp, sep = 'sep_space', }) .. ')</span>' local warnings = tonumber(frame.args.warnings) if warnings and warnings > 0 then local good = { df = true, mf = true, template = true, day = true, day1 = true, month = true, month1 = true, year = true, year1 = true, } local invalid local imax = options.textdates and 1 or 3 for k, _ in pairs(args) do if type(k) == 'number' then if k > imax then invalid = tostring(k) break end else if not good[k] then invalid = k break end end end if invalid then result = result .. message('invalid parameter ' .. invalid, 'warning') end end return result end local function dateToGsd(frame) -- Implement [[Template:Gregorian serial date]]. -- Return Gregorian serial date of the given date, or the current date. -- The returned value is negative for dates before 1 January 1 AD -- despite the fact that GSD is not defined for such dates. local date = getDates(frame, { wantMixture=true, single=true }) if type(date) == 'string' then return date end return tostring(date.gsd) end local function jdToDate(frame) -- Return formatted date from a Julian date. -- The result includes a time if the input includes a fraction. -- The word 'Julian' is accepted for the Julian calendar. local Date = getExports(frame) local args = frame:getParent().args local date = Date('juliandate', args[1], args[2]) if date then return date:text() end return message('Need valid Julian date number') end local function dateToJd(frame) -- Return Julian date (a number) from a date which may include a time, -- or the current date ('currentdate') or current date and time ('currentdatetime'). -- The word 'Julian' is accepted for the Julian calendar. local Date = getExports(frame) local args = frame:getParent().args local date = Date(args[1], args[2], args[3], args[4], args[5], args[6], args[7]) if date then return tostring(date.jd) end return message('Need valid year/month/day or "currentdate"') end local function timeInterval(frame) -- Implement [[Template:Time interval]]. -- There are two positional arguments: date1, date2. -- The default for each is the current date and time. -- Result is date2 - date1 formatted. local Date = getExports(frame) local args = frame:getParent().args local parms = { wantDuration = yes(args.duration), range = yes(args.range) or (args.range == 'dash' and 'dash' or nil), wantSc = yes(args.sc), } local fix = yes(args.fix) and 'fix' or '' local date1 = Date(fix, 'partial', stripToNil(args[1]) or 'currentdatetime') if not date1 then return message('Invalid start date in first parameter') end local date2 = Date(fix, 'partial', stripToNil(args[2]) or 'currentdatetime') if not date2 then return message('Invalid end date in second parameter') end parms.diff = date2 - date1 for argname, translate in pairs(translateParameters) do local parm = stripToNil(args[argname]) if parm then parm = translate[parm] if parm == nil then -- test for nil because false is a valid setting return message('Parameter ' .. argname .. '=' .. args[argname] .. ' is invalid') end parms[argname] = parm end end if parms.round then local round = parms.round local show = parms.show if round ~= 'on' then if show then if show.id ~= round then return message('Parameter show=' .. args.show .. ' conflicts with round=' .. args.round) end else parms.show = translateParameters.show[round] end end parms.round = true end return dateDifference(parms) end return { age_generic = ageGeneric, -- can emulate several age templates birth_date_and_age = bda, -- Template:Birth_date_and_age gsd = dateToGsd, -- Template:Gregorian_serial_date extract = dateExtract, -- Template:Extract jd_to_date = jdToDate, -- Template:? JULIANDAY = dateToJd, -- Template:JULIANDAY time_interval = timeInterval, -- Template:Time_interval }