Module:Archive: Difference between revisions

Content deleted Content added
m Protected Module:AutomaticArchiveNavigator: High-risk Lua module: 15,000 transclusions ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))
Line 2:
-- This module implements {{Automatic archive navigator}}
--
local p = {}
local args
local frame
local thisPage
 
local yesno = require('Module:Yesno')
-- Get a formatted link to the subpage a certain distance away, or nil
-- if that subpage does not exist. e.g. If the current subpage is
-- /Archive 27, then getSubpageLink(3) returns a link to Archive 30.
local function getSubpageLink(offset)
local subpageName
local startIdx, endIdx, archiveNum = mw.ustring.find(thisPage.subpageText, '^Archive ([0-9]+)')
if archiveNum then
subpageName = 'Archive ' .. (archiveNum + offset)
elseif tonumber(thisPage.subpageText) then
subpageName = thisPage.subpageText + offset
else
return nil -- Couldn't parse out a subpage number
end
 
-------------------------------------------------------------------------------
local page = mw.title.new(thisPage.baseText .. '/' .. subpageName, thisPage.namespace)
-- Helper functions
if page.exists then
-------------------------------------------------------------------------------
return '[[../' .. subpageName .. '|' .. subpageName .. ']]'
 
else
local function makeWikilink(page, display)
return nil
if display then
end
return string.format('[[%s|%s]]', page, display)
else
return string.format('[[%s]]', page)
end
end
 
local function getLinksTextescapePattern(s)
-- Escape punctuation in a string so it can be used in a Lua pattern.
local arrowSpacer = '  '
s = s:gsub('%p', '%%%0')
local linkSpacer = '    '
return s
if mw.ustring.len(thisPage.subpageText) <= 4 then
end
-- If page names are short, we want more space. But why the mix of regular, non-breaking, and em spaces?
local emSpace = frame:expandTemplate({title = 'Unicode', args = {mw.ustring.char(8195)}})
arrowSpacer = '&nbsp; ' .. emSpace .. ' &nbsp;&nbsp;'
linkSpacer = '&nbsp; ' .. emSpace .. ' &nbsp; ' .. emSpace .. '&nbsp;'
end
local s = ''
for offset = -5, -3 do
local link = getSubpageLink(offset)
if link then
if offset == -3 then
s = s .. link .. linkSpacer
else
s = s .. link .. ' ←' .. arrowSpacer
end
break
end
end
for offset = -2, -1 do
local link = getSubpageLink(offset)
if link then
s = s .. link .. linkSpacer
end
end
 
-------------------------------------------------------------------------------
s = s .. '<span style="font-size:115%;">[[' .. thisPage.fullText .. '|' .. thisPage.subpageText .. ']]</span>'
-- Navigator class
-------------------------------------------------------------------------------
for offset = 1, 2 do
local link = getSubpageLink(offset)
if link then
s = s .. linkSpacer .. link
end
end
for offset = 5, 3, -1 do
local link = getSubpageLink(offset)
if link then
if offset == 3 then
s = s .. linkSpacer .. link
else
s = s .. arrowSpacer .. '→ ' .. link
end
break
end
end
 
local Navigator = {}
return s
Navigator.__index = Navigator
 
function Navigator.new(args, cfg, currentTitle)
local obj = setmetatable({}, Navigator)
-- Set inputs
obj.args = args
obj.cfg = cfg
obj.currentTitle = currentTitle
 
-- Archive prefix
-- Decode HTML entities so users can enter things like "Archive&#32;" from
-- wikitext.
obj.archivePrefix = obj.args.prefix or obj:message('archive-prefix')
obj.archivePrefix = mw.text.decode(obj.archivePrefix)
 
-- Current archive number
do
local pattern = string.format(
'^%s([1-9][0-9]*)$',
escapePattern(obj.archivePrefix)
)
obj.currentArchiveNum = obj.currentTitle.subpageText:match(pattern)
obj.currentArchiveNum = tonumber(obj.currentArchiveNum)
end
-- Highest archive number
obj.highestArchiveNum = require('Module:Highest archive number')._main(
obj.currentTitle.nsText ..
':' ..
obj.currentTitle.baseText ..
'/' ..
obj.archivePrefix
)
 
return obj
end
 
local function getMessageNavigator:message(key, ...)
local msg = self.cfg[key]
if args[1] == '1' then
if select('#', ...) > 0 then
return ''
return mw.message.newRawMessage(msg, ...):plain()
else
else
local msg = '----\n'
return msg
if args.text then
end
msg = msg .. args.text
else
msg = msg .. "This is an '''[[Help:Archiving a talk page|archive]]''' of past discussions"
if args.period then
msg = msg .. "&#32;for the period '''" .. args.period .. "'''"
end
msg = msg .. ". '''Do not edit the contents of this page.''' If you wish to start a new discussion or revive an old one, please do so on the "
msg = msg .. "[[" .. thisPage.rootPageTitle.fullText .. "|current talk page]]."
end
return msg
end
end
 
local function _aanNavigator:makeBlurb()
local args = self.args
frame = mw.getCurrentFrame()
if args[1] == '1' then
-- The old template used "|1" to suppress the blurb.
-- For testing purposes, allow passing in the page name as a param.
return ''
if args.title then
else
thisPage = mw.title.new(args.title)
local ret
else
if args.text then
thisPage = mw.title.getCurrentTitle()
ret = args.text
end
else
local talkPage = self.currentTitle.nsText ..
local image = args.image
':' ..
if not image then
self.currentTitle.baseText
image = '[[File:' .. (args.icon or 'Replacement filing cabinet.svg') .. '|40x40px|alt=|link=]]'
if args.period then
end
ret = self:message('blurb-period', talkPage, args.period)
else
local mbox = frame:expandTemplate({title = 'tmbox', args = {
ret = self:message('blurb-noperiod', talkPage)
image = image,
end
imageright = args.imageright,
end
style = args.style or 'width:80%;margin-left:auto;margin-right:auto;',
return ret
textstyle = args.textstyle or 'text-align:center;',
end
text = getLinksText() .. '\n' .. getMessage()
}})
return mbox .. '__NONEWSECTIONLINK__ __NOEDITSECTION__'
end
 
function p.aanNavigator:makeMessageBox(frame)
local args = self.args
local origArgs
-- If called via #invoke, use the args passed into the invoking template.
local image
-- Otherwise, for testing purposes, assume args are being passed directly in.
if frame == mwargs.getCurrentFrame()image then
image = args.image
origArgs = frame:getParent().args
else
local icon = args.icon or self:message('default-icon')
origArgs = frame
image = string.format(
end
'[[File:%s|%s|alt=|link=]]',
icon,
-- ParserFunctions considers the empty string to be false, so to preserve the previous
self:message('image-size')
-- template behavior, change any empty arguments to nil, so Lua will consider
)
-- them false too.
end
args = {}
 
for k, v in pairs(origArgs) do
local mbox = require('Module:Message box').main('tmbox', {
if v ~= '' then
image = image,
args[k] = v
imageright = args.imageright,
end
style = args.style or 'width:80%;margin-left:auto;margin-right:auto',
end
textstyle = args.textstyle or 'text-align:center',
text = self:makeBlurb()
return _aan()
})
 
return mbox
end
 
function Navigator:getArchiveNums()
-- Returns an array of the archive numbers to format.
local noLinks = tonumber(self.args.links) or self:message('default-link-count')
noLinks = math.floor(noLinks)
local allowRedLinks = not yesno(self.args.noredlinks)
local current = self.currentArchiveNum
local highest = self.highestArchiveNum
 
if not current or not highest or noLinks < 1 then
return {}
elseif noLinks == 1 then
return {current}
end
 
local function getNum(i, current)
-- Gets an archive number given i, the position in the array away from
-- the current archive, and the current archive number. The first two
-- offsets are consecutive; the third offset is rounded up to the
-- nearest 5; and the fourth and subsequent offsets are rounded up to
-- the nearest 10. The offsets are calculated in such a way that archive
-- numbers will not be duplicated.
if -2 <= i and i <= 2 then
return current + i
elseif -3 <= i and i <= 3 then
return current + 2 - (current + 2) % 5 + (i / 3) * 5
elseif 4 <= i then
return current + 7 - (current + 7) % 10 + (i - 3) * 10
else
return current + 2 - (current + 2) % 10 + (i + 3) * 10
end
end
 
local nums = {}
 
-- Archive nums lower than the current page.
for i = -1, -math.floor((noLinks - 1) / 2), -1 do
local num = getNum(i, current)
if num <= 1 then
table.insert(nums, 1, 1)
break
else
table.insert(nums, 1, num)
end
end
 
-- Current page.
table.insert(nums, current)
 
-- Higher archive nums.
for i = 1, math.ceil((noLinks - 1) / 2) do
local num = getNum(i, current)
if num <= highest then
table.insert(nums, num)
elseif allowRedLinks and (i <= 2 or i <= 3 and num == nums[#nums] + 1) then
-- Only insert one red link, and only if it is consecutive.
table.insert(nums, highest + 1)
break
elseif nums[#nums] < highest then
-- Insert the highest archive number if it isn't already there.
table.insert(nums, highest)
break
else
break
end
end
 
return nums
end
 
function Navigator:makeArchiveLinksWikitable()
local lang = mw.language.getContentLanguage()
local nums = self:getArchiveNums()
local noLinks = #nums
if noLinks < 1 then
return ''
end
 
-- Make the table of links.
local links = {}
local isCompact = noLinks > 7
local currentIndex
for i, num in ipairs(nums) do
local subpage = self.archivePrefix .. tostring(num)
local display
if isCompact then
display = tostring(num)
else
display = self:message('archive-link-display', num)
end
local link = makeWikilink('../' .. subpage, display)
if num == self.currentArchiveNum then
link = string.format('<span style="font-size:115%%;">%s</span>', link)
currentIndex = i
end
table.insert(links, link)
end
 
-- Add the arrows.
-- We must do the forwards arrow first as we are adding elements to the
-- links table. If we did the backwards arrow first the index for the
-- current archive would be wrong.
currentIndex = currentIndex or math.ceil(#links / 2)
for i = currentIndex + 1, #links do
if nums[i] - nums[i - 1] > 1 then
table.insert(links, i, lang:getArrow('forwards'))
break
end
end
for i = currentIndex - 1, 1, -1 do
if nums[i + 1] - nums[i] > 1 then
table.insert(links, i + 1, lang:getArrow('backwards'))
break
end
end
 
-- Output the wikitable.
local ret = {}
local width
if noLinks <= 3 then
width = string.format('%dem', noLinks * 10)
elseif noLinks <= 7 then
width = string.format('%dem', (noLinks + 3) * 5)
else
width = '50em'
end
ret[#ret + 1] = string.format(
'{| style="width:%s;background:transparent;' ..
'margin:0 auto 0.5em;text-align:center"',
width
)
for i, s in ipairs(links) do
if i % 20 == 1 then
ret[#ret + 1] = '\n|-'
end
ret[#ret + 1] = '\n| '
ret[#ret + 1] = s
end
ret[#ret + 1] = '\n|}'
return table.concat(ret)
end
 
function Navigator:__tostring()
return self:makeMessageBox() ..
'\n' ..
self:makeArchiveLinksWikitable() ..
' __NONEWSECTIONLINK__ __NOEDITSECTION__'
end
 
-------------------------------------------------------------------------------
-- Exports
-------------------------------------------------------------------------------
 
local p = {}
 
function p._aan(args, cfg, currentTitle)
cfg = cfg or mw.loadData('Module:AutomaticArchiveNavigator/config')
currentTitle = currentTitle or mw.title.getCurrentTitle()
local aan = Navigator.new(args, cfg, currentTitle)
return tostring(aan)
end
 
function p._tan(args)
args.links = args.links or 3
return p._aan(args)
end
 
function p._exportClasses()
return {
Navigator = Navigator
}
end
 
setmetatable(p, {__index = function(t, k)
return function(frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = {
'Template:Automatic archive navigator',
'Template:Talk archive navigation'
}
})
return p['_' .. k](args)
end
end})
 
return p