Nonbinary Wiki

Module:Protection banner: Difference between revisions

Module Discussion

Module:Protection banner (edit)

Revision as of 11:43, 21 May 2021

683 bytes added ,  2 years ago
m
236 revisions imported from wikipedia:Module:Protection_banner: see Topic:Vtixlm0q28eo6jtf
m (fix cfg table name)
m (236 revisions imported from wikipedia:Module:Protection_banner: see Topic:Vtixlm0q28eo6jtf)
 
(26 intermediate revisions by 8 users not shown)
Line 4: Line 4:
-- Initialise necessary modules.
-- Initialise necessary modules.
require('Module:No globals')
require('Module:No globals')
local newFileLink = require('Module:File link').new
local makeFileLink = require('Module:File link')._main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')


-- Lazily initialise modules and objects we don't always need.
-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang
local getArgs, makeMessageBox, lang
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Line 16: Line 20:


local function makeCategoryLink(cat, sort)
local function makeCategoryLink(cat, sort)
local nsText = mw.site.namespaces[14].name
if cat then
if cat and sort then
return string.format(
return string.format(
'[[%s:%s|%s]]',
'[[%s:%s|%s]]',
nsText,
mw.site.namespaces[14].name,
cat,
cat,
sort
sort
)
)
elseif cat then
return string.format(
'[[%s:%s]]',
nsText,
cat
)
else
return ''
end
end
end
end
Line 37: Line 32:
-- Validation function for the expiry and the protection date
-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
local function validateDate(dateString, dateType)
lang = lang or mw.language.getContentLanguage()
if not lang then
lang = mw.language.getContentLanguage()
end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
if success then
Line 46: Line 43:
end
end
error(string.format(
error(string.format(
'invalid %s ("%s")',
'invalid %s: %s',
dateType,
dateType,
tostring(dateString)
tostring(dateString)
), 0)
), 4)
end
end


Line 60: Line 57:
end
end


local function toTableEnd(t, pos)
-- Given a directed graph formatted as node -> table of direct successors,
-- Sends the value at position pos to the end of array t, and shifts the
-- get a table of all nodes reachable from a given node (though always
-- other items down accordingly.
-- including the given node).
return table.insert(t, table.remove(t, pos))
local function getReachableNodes(graph, start)
local toWalk, retval = {[start] = true}, {}
while true do
-- Can't use pairs() since we're adding and removing things as we're iterating
local k = next(toWalk) -- This always gets the "first" key
if k == nil then
return retval
end
toWalk[k] = nil
retval[k] = true
for _,v in ipairs(graph[k]) do
if not retval[v] then
toWalk[v] = true
end
end
end
end
end


Line 76: Line 88:
edit = true,
edit = true,
move = true,
move = true,
autoreview = true
autoreview = true,
upload = true
}
}


Line 100: Line 113:
else
else
error(string.format(
error(string.format(
'invalid action ("%s")',
'invalid action: %s',
tostring(args.action)
tostring(args.action)
), 0)
), 3)
end
end


-- Set level
-- Set level
obj.level = effectiveProtectionLevel(obj.action, obj.title)
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
if obj.level == 'accountcreator' then
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Lump titleblacklisted pages in with template-protected pages,
-- since templateeditors can do both.
obj.level = 'templateeditor'
elseif not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
-- semi-move-protected pages as unprotected.
Line 118: Line 127:


-- Set expiry
-- Set expiry
if args.expiry then
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if cfg.indefStrings[args.expiry] then
if effectiveExpiry == 'infinity' then
obj.expiry = 'indef'
obj.expiry = 'indef'
elseif type(args.expiry) == 'number' then
elseif effectiveExpiry ~= 'unknown' then
obj.expiry = args.expiry
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
else
obj.expiry = validateDate(args.expiry, 'expiry date')
end
end
end


Line 132: Line 138:
obj.reason = mw.ustring.lower(args[1])
obj.reason = mw.ustring.lower(args[1])
if obj.reason:find('|') then
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 0)
error('reasons cannot contain the pipe character ("|")', 3)
end
end
end
end
Line 163: Line 169:
end
end
return setmetatable(obj, Protection)
return setmetatable(obj, Protection)
end
function Protection:isUserScript()
-- Whether the page is a user JavaScript or CSS page.
local title = self.title
return title.namespace == 2 and (
title.contentModel == 'javascript' or title.contentModel == 'css'
)
end
end


Line 168: Line 182:
return self.level ~= '*'
return self.level ~= '*'
end
end
function Protection:shouldShowLock()
-- Whether we should output a banner/padlock
return self:isProtected() and not self:isUserScript()
end
-- Whether this page needs a protection category.
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock


function Protection:isTemporary()
function Protection:isTemporary()
Line 174: Line 196:


function Protection:makeProtectionCategory()
function Protection:makeProtectionCategory()
if not self:shouldHaveProtectionCategory() then
return ''
end
local cfg = self._cfg
local cfg = self._cfg
local title = self.title
local title = self.title
-- Exit if the page is not protected.
if not self:isProtected() then
return ''
end
-- Get the expiry key fragment.
-- Get the expiry key fragment.
Line 191: Line 212:


-- Get the namespace key fragment.
-- Get the namespace key fragment.
local namespaceFragment
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
do
if not namespaceFragment and title.namespace % 2 == 1 then
namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
namespaceFragment = 'talk'
if not namespaceFragment and title.namespace % 2 == 1 then
namespaceFragment = 'talk'
end
end
end
 
-- Define the order that key fragments are tested in. This is done with an
-- Define the order that key fragments are tested in. This is done with an
-- array of tables containing the value to be tested, along with its
-- array of tables containing the value to be tested, along with its
Line 221: Line 239:
-- instead.
-- instead.
--]]
--]]
if self.reason and cfg.reasonsWithNamespacePriority[self.reason] then
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
-- table.insert(order, 3, table.remove(order, 2))
toTableEnd(order, 2)
else
toTableEnd(order, 3)
end
   
   
--[[
--[[
Line 307: Line 320:
end
end
return ''
return ''
end
function Protection:needsExpiry()
local cfg = self._cfg
local actionNeedsCheck = cfg.expiryCheckActions[self.action]
return not self.expiry and (
actionNeedsCheck or (
actionNeedsCheck == nil
and self.reason -- the old {{pp-protected}} didn't check for expiry
and not cfg.reasonsWithoutExpiryCheck[self.reason]
)
)
end
end


function Protection:isIncorrect()
function Protection:isIncorrect()
local expiry = self.expiry
local expiry = self.expiry
return not self:isProtected()
return not self:shouldHaveProtectionCategory()
or type(expiry) == 'number' and expiry < os.time()
or type(expiry) == 'number' and expiry < os.time()
end
end
Line 338: Line 339:
function Protection:makeCategoryLinks()
function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local msg = self._cfg.msg
local ret = { self:makeProtectionCategory() }
local ret = {self:makeProtectionCategory()}
if self:needsExpiry() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-expiry'],
self.title.text
)
end
if self:isIncorrect() then
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(
ret[#ret + 1] = makeCategoryLink(
Line 421: Line 416:
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
Line 471: Line 467:
if level == 'autoconfirmed' then
if level == 'autoconfirmed' then
requestType = 'semi'
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
elseif level == 'templateeditor' then
requestType = 'template'
requestType = 'template'
Line 522: Line 520:
level,
level,
talkKey
talkKey
))
), 8)
end
end
return self:_substituteParameters(msg)
return self:_substituteParameters(msg)
Line 562: Line 560:
return pagetypes[self._protectionObj.title.namespace]
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or pagetypes.default
or error('no default pagetype defined')
or error('no default pagetype defined', 8)
end
end


Line 577: Line 575:
msg = protectionBlurbs.edit.default
msg = protectionBlurbs.edit.default
else
else
error('no protection blurb defined for protectionBlurbs.edit.default')
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
end
return self:_substituteParameters(msg)
return self:_substituteParameters(msg)
Line 603: Line 601:
msg = protectionLevels.edit.default
msg = protectionLevels.edit.default
else
else
error('no protection level defined for protectionLevels.edit.default')
error('no protection level defined for protectionLevels.edit.default', 8)
end
end
return self:_substituteParameters(msg)
return self:_substituteParameters(msg)
Line 642: Line 640:
else
else
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
end
end
function Blurb:_makeTooltipFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-fragment-expiry')
else
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
end
end
end
end


function Blurb:_makeVandalTemplateParameter()
function Blurb:_makeVandalTemplateParameter()
return require('Module:Vandal-m')._main{
return mw.getCurrentFrame():expandTemplate{
self._args.user or self._protectionObj.title.baseText
title="vandal-m",
args={self._args.user or self._protectionObj.title.baseText}
}
}
end
end
Line 674: Line 681:
tostring(key),
tostring(key),
type(msg)
type(msg)
))
), 4)
end
end
return self:_substituteParameters(msg)
return self:_substituteParameters(msg)
Line 729: Line 736:
end
end
return setmetatable(obj, BannerTemplate)
return setmetatable(obj, BannerTemplate)
end
function BannerTemplate:setImageWidth(width)
self._imageWidth = width
end
function BannerTemplate:setImageTooltip(tooltip)
self._imageCaption = tooltip
end
end


Line 743: Line 742:
or self._cfg.msg['image-filename-default']
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
or 'Transparent.gif'
return newFileLink(filename)
return makeFileLink{
:width(self._imageWidth or 20)
file = filename,
:alt(self._imageAlt)
size = (self.imageWidth or 20) .. 'px',
:link(self._imageLink)
alt = self._imageAlt,
:caption(self._imageCaption)
link = self._imageLink,
:render()
caption = self.imageCaption
}
end
end


Line 760: Line 760:
function Banner.new(protectionObj, blurbObj, cfg)
function Banner.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj:setImageWidth(40)
obj.imageWidth = 40
obj:setImageTooltip(blurbObj:makeBannerText('alt')) -- Large banners use the alt text for the tooltip.
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
obj._reasonText = blurbObj:makeBannerText('text')
obj._reasonText = blurbObj:makeBannerText('text')
obj._explanationText = blurbObj:makeBannerText('explanation')
obj._explanationText = blurbObj:makeBannerText('explanation')
Line 771: Line 771:
-- Renders the banner.
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set')
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local explanationText = self._explanationText
local mbargs = {
local mbargs = {
Line 795: Line 795:
function Padlock.new(protectionObj, blurbObj, cfg)
function Padlock.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj:setImageWidth(20)
obj.imageWidth = 20
obj:setImageTooltip(blurbObj:makeBannerText('tooltip'))
obj.imageCaption = blurbObj:makeBannerText('tooltip')
obj._imageAlt = blurbObj:makeBannerText('alt')
obj._imageAlt = blurbObj:makeBannerText('alt')
obj._imageLink = blurbObj:makeBannerText('link')
obj._imageLink = blurbObj:makeBannerText('link')
obj._right = cfg.padlockPositions[protectionObj.action]
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
or cfg.padlockPositions.default
or cfg.padlockIndicatorNames.default
or '55px'
or 'pp-default'
return setmetatable(obj, Padlock)
return setmetatable(obj, Padlock)
end
end


function Padlock:__tostring()
function Padlock:__tostring()
local root = mw.html.create('div')
local frame = mw.getCurrentFrame()
root
-- The nowiki tag helps prevent whitespace at the top of articles.
:addClass('metadata topicon nopopups')
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
:attr('id', 'protected-icon')
name = 'indicator',
:css{display = 'none', right = self._right}
args = {name = self._indicatorName},
:wikitext(self:renderImage())
content = self:renderImage()
return tostring(root)
}
end
end


Line 834: Line 834:
function p._main(args, cfg, title)
function p._main(args, cfg, title)
args = args or {}
args = args or {}
cfg = cfg or require('Module:Protection banner/config')
cfg = cfg or require(CONFIG_MODULE)


-- Initialise the protection object and check for errors
local protectionObj = Protection.new(args, cfg, title)
local protectionObjCreated, protectionObj = pcall(
Protection.new,
args,
cfg,
title
)
if not protectionObjCreated then
local errorBlurb = cfg.msg['error-message-blurb'] or 'Error: $1.'
local errorText = mw.message.newRawMessage(errorBlurb)
:params(protectionObj) -- protectionObj is the error message
:plain()
return string.format(
'<strong class="error">%s</strong>%s',
errorText,
makeCategoryLink(
cfg.msg['tracking-category-incorrect'],
title and title.text or mw.title.getCurrentTitle().text
)
)
end
-- Initialise the blurb object
local blurbObj = Blurb.new(protectionObj, args, cfg)


local ret = {}
local ret = {}


-- Render the banner
-- If a page's edit protection is equally or more restrictive than its
if protectionObj:isProtected() then
-- protection from some other action, then don't bother displaying anything
ret[#ret + 1] = tostring(
-- for the other action (except categories).
(yesno(args.small) and Padlock or Banner)
if protectionObj.action == 'edit' or
.new(protectionObj, blurbObj, cfg)
args.demolevel or
)
not getReachableNodes(
cfg.hierarchy,
protectionObj.level
)[effectiveProtectionLevel('edit', protectionObj.title)]
then
-- Initialise the blurb object
local blurbObj = Blurb.new(protectionObj, args, cfg)
-- Render the banner
if protectionObj:shouldShowLock() then
ret[#ret + 1] = tostring(
(yesno(args.small) and Padlock or Banner)
.new(protectionObj, blurbObj, cfg)
)
end
end
end
 
-- Render the categories
-- Render the categories
if yesno(args.category) ~= false then
if yesno(args.category) ~= false then
Line 880: Line 871:


function p.main(frame, cfg)
function p.main(frame, cfg)
cfg = cfg or require(CONFIG_MODULE)
-- Find default args, if any.
local parent = frame.getParent and frame:getParent()
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
-- Find user args, and use the parent frame if we are being called from a
-- wrapper template.
getArgs = getArgs or require('Module:Arguments').getArgs
getArgs = getArgs or require('Module:Arguments').getArgs
cfg = cfg or require('Module:Protection banner/config')
local userArgs = getArgs(frame, {
local parentTitle = frame:getParent():getTitle()
parentOnly = defaultArgs,
parentTitle = parentTitle:gsub('/sandbox$', '')
frameOnly = not defaultArgs
local defaultArgs = cfg.wrappers[parentTitle] or {}
})
local args = getArgs(frame, {parentOnly = defaultArgs and true})
 
for k, v in pairs(defaultArgs) do
-- Build the args table. User-specified args overwrite default args.
local args = {}
for k, v in pairs(defaultArgs or {}) do
args[k] = v
end
for k, v in pairs(userArgs) do
args[k] = v
args[k] = v
end
end
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/30669...30696"