Open main menu

Changes

Module:Protection banner

693 bytes added, 01:26, 10 September 2019
m
232 revisions imported
-- Initialise necessary modules.
require('Module:No globals')
local class = require('Module:Middleclass').classlocal newFileLink makeFileLink = require('Module:File link').new_main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')
-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang
 
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local function makeCategoryLink(cat, sort)
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat, sort
)
else
return ''
end
end
-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
if not lang then lang = lang or mw.language.getContentLanguage() end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
end
error(string.format(
'invalid %s (": %s")',
dateType,
tostring(dateString)
), 04)
end
end
-- Given a directed graph formatted as node -> table of direct successors,-- get a table of all nodes reachable from a given node (though always-- including the given node).local function toTableEndgetReachableNodes(tgraph, posstart) local toWalk, retval = {[start] = true}, {} while true do -- Sends the value at position pos to the end of array Can't, use pairs() since we're adding and shifts theremoving things as we're iterating local k = next(toWalk) -- other items down accordingly.This always gets the "first" key if k == nil then return table.insert(tretval end toWalk[k] = nil retval[k] = true for _, table.removev in ipairs(t, pos)graph[k])do if not retval[v] then toWalk[v] = true end end end
end
--------------------------------------------------------------------------------
local Protection = class('{}Protection.__index = Protection')
Protection.supportedActions = {
edit = true,
move = true,
autoreview = true, upload = true
}
}
function Protection:initialize.new(args, cfg, title) selflocal obj = {} obj._cfg = cfg selfobj.title = title or mw.title.getCurrentTitle()
-- Set action
if not args.action then
selfobj.action = 'edit' elseif selfProtection.supportedActions[args.action] then selfobj.action = args.action
else
error(string.format(
'invalid action (": %s")',
tostring(args.action)
), 03)
end
-- Set level
selfobj.level = args.demolevel or effectiveProtectionLevel(selfobj.action, selfobj.title) if self.level == 'accountcreator' then -- Lump titleblacklisted pages in with template-protected pages, -- since templateeditors can do both. self.level = 'templateeditor' elseif not selfobj.level or (selfobj.action == 'move' and selfobj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
selfobj.level = '*'
end
-- Set expiry
if argslocal effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.expiry thentitle) if cfg.indefStrings[args.expiry] effectiveExpiry == 'infinity' then self obj.expiry = 'indef' elseif type(args.expiry) =effectiveExpiry ~= 'numberunknown' then self.expiry = args.expiry else selfobj.expiry = validateDate(args.expiryeffectiveExpiry, 'expiry date') end
end
-- Set reason
if args[1] then
selfobj.reason = mw.ustring.lower(args[1]) if selfobj.reason:find('|') then error('reasons cannot contain the pipe character ("|")', 03)
end
end
-- Set protection date
if args.date then
selfobj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
selfobj.bannerConfig = {}
local configTables = {}
if cfg.banners[selfobj.action] then configTables[#configTables + 1] = cfg.banners[selfobj.action][selfobj.reason]
end
if cfg.defaultBanners[selfobj.action] then configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action][selfobj.level] configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(selfProtection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
selfobj.bannerConfig[field] = t[field]
break
end
end
end
return setmetatable(obj, Protection)
end
-- Get the namespace key fragment.
local namespaceFragment do namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] if not namespaceFragment and title.namespace % 2 == 1 then namespaceFragment = 'talk' end
end
-- instead.
--]]
if table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] then -- table.insert(order, and 2 or 3, table.remove(order, 2)) toTableEnd(order, 2) else toTableEnd(order, 3) end
--[[
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
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
local msg = self._cfg.msg
local ret = { self:makeProtectionCategory() }
if self:needsExpiry() then
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-expiry'])
end
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink( msg['tracking-category-incorrect'], self.title.text )
end
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink( msg['tracking-category-template'], self.title.text )
end
return table.concat(ret)
--------------------------------------------------------------------------------
local Blurb = class('{}Blurb.__index = Blurb')
Blurb.bannerTextFields = {
}
function Blurb:initialize.new(protectionObj, args, cfg) self.return setmetatable({ _cfg = cfg, self. _protectionObj = protectionObj, self. _args = args }, Blurb)
end
parameterFuncs.TALKPAGE = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL = self._makeVandalTemplateParameter
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
level,
talkKey
), 8)
end
return self:_substituteParameters(msg)
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
else
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
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
--------------------------------------------------------------------------------
local BannerTemplate = class('{}BannerTemplate.__index = BannerTemplate')
function BannerTemplate:initialize.new(protectionObj, cfg) selflocal obj = {} obj._cfg = cfg
-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
selfobj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
local level = protectionObj.level
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason
-- Deal with special cases first.
if ( namespace == 10 or namespace == 828 or reason and obj._cfg.indefImageReasons[reason] )
and action == 'edit'
and level == 'sysop'
-- Fully protected modules and templates get the special red "indef"
-- padlock.
selfobj._imageFilename = selfobj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = selfobj._cfg.images
if images[action] then
if images[action][level] then
selfobj._imageFilename = images[action][level]
elseif images[action].default then
selfobj._imageFilename = images[action].default
end
end
end
end
end function BannerTemplate:setImageWidth return setmetatable(width) self._imageWidth = widthend function obj, BannerTemplate:setImageTooltip(tooltip) self._imageCaption = tooltip
end
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return newFileLink(makeFileLink{ file = filename), :widthsize = (self._imageWidth imageWidth or 20).. 'px', :alt(= self._imageAlt), :link(= self._imageLink), :caption(= self._imageCaption)imageCaption :render() }
end
--------------------------------------------------------------------------------
local Banner = setmetatable({}, BannerTemplate:subclass(')Banner.__index = Banner')
function Banner:initialize.new(protectionObj, blurbObj, cfg) local obj = BannerTemplate.initializenew(self, protectionObj, cfg) -- This doesn't need the blurb. self:setImageWidth(obj.imageWidth = 40) self:setImageTooltip(obj.imageCaption = blurbObj:makeBannerText('alt')) -- Large banners use the alt text for the tooltip. selfobj._reasonText = blurbObj:makeBannerText('text') selfobj._explanationText = blurbObj:makeBannerText('explanation') selfobj._page = protectionObj.title.prefixedText -- Only makes a difference in testing. return setmetatable(obj, Banner)
end
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local mbargs = {
--------------------------------------------------------------------------------
local Padlock = setmetatable({}, BannerTemplate:subclass(')Padlock.__index = Padlock')
function Padlock:initialize.new(protectionObj, blurbObj, cfg) local obj = BannerTemplate.initializenew(self, protectionObj, cfg) -- This doesn't need the blurb. self:setImageWidth(obj.imageWidth = 20) self:setImageTooltip(obj.imageCaption = blurbObj:makeBannerText('tooltip')) selfobj._imageAlt = blurbObj:makeBannerText('alt') selfobj._imageLink = blurbObj:makeBannerText('link') selfobj._right _indicatorName = cfg.padlockPositionspadlockIndicatorNames[protectionObj.action] or cfg.padlockPositionspadlockIndicatorNames.default or '55pxpp-default' return setmetatable(obj, Padlock)
end
function Padlock:__tostring()
local root frame = mw.html.creategetCurrentFrame('div') root-- The nowiki tag helps prevent whitespace at the top of articles. return frame:addClass(extensionTag{name = 'metadata topicon nopopupsnowiki')} .. frame:extensionTag{ :attr(name = 'idindicator', 'protected-icon') :cssargs = {display = 'none', right name = self._right_indicatorName}, :wikitext(content = self:renderImage()) return tostring(root)}
end
function p._main(args, cfg, title)
args = args or {}
cfg = cfg or require('Module:Protection banner/config'CONFIG_MODULE)
-- Initialise the protection object and check for errors local protectionObjCreated, protectionObj = pcall( Protection.new, Protection, -- equivalent to 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']) ) end -- Initialise the blurb object local blurbObj = Blurb:new(protectionObj, args, cfg)
local ret = {}
-- If a page's edit protection is equally or more restrictive than its -- protection from some other action, then don't bother displaying anything -- for the other action (except categories). if protectionObj.action == 'edit' or 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:isProtected() then ret[#ret + 1] = tostring( (yesno(args.small) and Padlock or Banner) : .new(protectionObj, blurbObj, cfg) ) )end
end
-- Render the categories
if yesno(args.category) ~= false then
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
cfg local userArgs = cfg or requiregetArgs('Module:Protection banner/config')frame, { parentOnly = defaultArgs, frameOnly = not defaultArgs local parentTitle = frame:getParent():getTitle(}parentTitle = parentTitle:gsub('/sandbox$', '')-- Build the args table. User-specified args overwrite default args. local defaultArgs args = cfg.wrappers[parentTitle] or {} local args = getArgsfor k, v in pairs(frame, defaultArgs or {parentOnly = defaultArgs and true})do args[k] = v end for k, v in pairs(defaultArgsuserArgs) do
args[k] = v
end