Editing Module:Protection banner
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 4: | Line 4: | ||
-- Initialise necessary modules. | -- Initialise necessary modules. | ||
require('Module:No globals') | require('Module:No globals') | ||
local | local newFileLink = require('Module:File link').new | ||
local effectiveProtectionLevel = require('Module:Effective protection level')._main | local effectiveProtectionLevel = require('Module:Effective protection level')._main | ||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
Line 20: | Line 19: | ||
local function makeCategoryLink(cat, sort) | local function makeCategoryLink(cat, sort) | ||
if cat then | local nsText = mw.site.namespaces[14].name | ||
if cat and sort then | |||
return string.format( | return string.format( | ||
'[[%s:%s|%s]]', | '[[%s:%s|%s]]', | ||
nsText, | |||
cat, | cat, | ||
sort | sort | ||
) | ) | ||
elseif cat then | |||
return string.format( | |||
'[[%s:%s]]', | |||
nsText, | |||
cat | |||
) | |||
else | |||
return '' | |||
end | end | ||
end | end | ||
Line 32: | Line 40: | ||
-- 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() | |||
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 43: | Line 49: | ||
end | end | ||
error(string.format( | error(string.format( | ||
'invalid %s | 'invalid %s ("%s")', | ||
dateType, | dateType, | ||
tostring(dateString) | tostring(dateString) | ||
), | ), 0) | ||
end | end | ||
Line 57: | Line 63: | ||
end | end | ||
local function toTableEnd(t, pos) | |||
-- Sends the value at position pos to the end of array t, and shifts the | |||
-- other items down accordingly. | |||
local function | return table.insert(t, table.remove(t, pos)) | ||
end | end | ||
Line 88: | Line 79: | ||
edit = true, | edit = true, | ||
move = true, | move = true, | ||
autoreview | autoreview = true | ||
} | } | ||
Line 113: | Line 103: | ||
else | else | ||
error(string.format( | error(string.format( | ||
'invalid action | 'invalid action ("%s")', | ||
tostring(args.action) | tostring(args.action) | ||
), | ), 0) | ||
end | end | ||
-- Set level | -- Set level | ||
obj.level = | obj.level = effectiveProtectionLevel(obj.action, obj.title) | ||
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then | if obj.level == 'accountcreator' 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 127: | Line 121: | ||
-- Set expiry | -- Set expiry | ||
if args.expiry then | |||
if cfg.indefStrings[args.expiry] then | |||
obj.expiry = 'indef' | |||
elseif type(args.expiry) == 'number' then | |||
obj.expiry = validateDate( | obj.expiry = args.expiry | ||
else | |||
obj.expiry = validateDate(args.expiry, 'expiry date') | |||
end | |||
end | end | ||
Line 138: | Line 135: | ||
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 ("|")', | error('reasons cannot contain the pipe character ("|")', 0) | ||
end | end | ||
end | end | ||
Line 169: | Line 166: | ||
end | end | ||
return setmetatable(obj, Protection) | return setmetatable(obj, Protection) | ||
end | end | ||
Line 182: | Line 171: | ||
return self.level ~= '*' | return self.level ~= '*' | ||
end | end | ||
function Protection:isTemporary() | function Protection:isTemporary() | ||
Line 196: | Line 177: | ||
function Protection:makeProtectionCategory() | function Protection:makeProtectionCategory() | ||
if not self: | local cfg = self._cfg | ||
local title = self.title | |||
-- Exit if the page is not protected. | |||
if not self:isProtected() then | |||
return '' | return '' | ||
end | end | ||
-- Get the expiry key fragment. | -- Get the expiry key fragment. | ||
Line 212: | Line 194: | ||
-- Get the namespace key fragment. | -- Get the namespace key fragment. | ||
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] | local namespaceFragment | ||
do | |||
namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] | |||
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 239: | Line 224: | ||
-- instead. | -- instead. | ||
--]] | --]] | ||
table.insert(order, table.remove(order, | if self.reason and cfg.reasonsWithNamespacePriority[self.reason] then | ||
-- table.insert(order, 3, table.remove(order, 2)) | |||
toTableEnd(order, 2) | |||
else | |||
toTableEnd(order, 3) | |||
end | |||
--[[ | --[[ | ||
Line 320: | Line 310: | ||
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: | return not self:isProtected() | ||
or type(expiry) == 'number' and expiry < os.time() | or type(expiry) == 'number' and expiry < os.time() | ||
end | end | ||
Line 339: | Line 341: | ||
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 467: | Line 475: | ||
if level == 'autoconfirmed' then | if level == 'autoconfirmed' then | ||
requestType = 'semi' | requestType = 'semi' | ||
elseif level == 'templateeditor' then | elseif level == 'templateeditor' then | ||
requestType = 'template' | requestType = 'template' | ||
Line 520: | Line 526: | ||
level, | level, | ||
talkKey | talkKey | ||
) | )) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 560: | Line 566: | ||
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') | ||
end | end | ||
Line 575: | Line 581: | ||
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') | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 601: | Line 607: | ||
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') | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 652: | Line 658: | ||
function Blurb:_makeVandalTemplateParameter() | function Blurb:_makeVandalTemplateParameter() | ||
return | return require('Module:Vandal-m')._main{ | ||
self._args.user or self._protectionObj.title.baseText | |||
} | } | ||
end | end | ||
Line 681: | Line 686: | ||
tostring(key), | tostring(key), | ||
type(msg) | type(msg) | ||
) | )) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 736: | Line 741: | ||
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 742: | Line 755: | ||
or self._cfg.msg['image-filename-default'] | or self._cfg.msg['image-filename-default'] | ||
or 'Transparent.gif' | or 'Transparent.gif' | ||
return | return newFileLink(filename) | ||
:width(self._imageWidth or 20) | |||
:alt(self._imageAlt) | |||
alt | :link(self._imageLink) | ||
link | :caption(self._imageCaption) | ||
caption | :render() | ||
end | end | ||
Line 760: | Line 772: | ||
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 | obj:setImageWidth(40) | ||
obj | obj:setImageTooltip(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 783: | ||
-- 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') | ||
local explanationText = self._explanationText | local explanationText = self._explanationText | ||
local mbargs = { | local mbargs = { | ||
Line 795: | Line 807: | ||
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 | obj:setImageWidth(20) | ||
obj | obj:setImageTooltip(blurbObj:makeBannerText('tooltip')) | ||
obj._imageAlt = blurbObj:makeBannerText('alt') | obj._imageAlt = blurbObj:makeBannerText('alt') | ||
obj._imageLink = blurbObj:makeBannerText('link') | obj._imageLink = blurbObj:makeBannerText('link') | ||
obj. | obj._right = cfg.padlockPositions[protectionObj.action] | ||
or cfg. | or cfg.padlockPositions.default | ||
or ' | or '55px' | ||
return setmetatable(obj, Padlock) | return setmetatable(obj, Padlock) | ||
end | end | ||
function Padlock:__tostring() | function Padlock:__tostring() | ||
local | local root = mw.html.create('div') | ||
root | |||
:addClass('metadata topicon nopopups') | |||
:attr('id', 'protected-icon') | |||
:css{display = 'none', right = self._right} | |||
:wikitext(self:renderImage()) | |||
return tostring(root) | |||
end | end | ||
Line 834: | Line 846: | ||
function p._main(args, cfg, title) | function p._main(args, cfg, title) | ||
args = args or {} | args = args or {} | ||
cfg = cfg or require( | cfg = cfg or require('Module:Protection banner/config') | ||
local protectionObj = Protection.new( | -- Initialise the protection object and check for errors | ||
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 protectionObj:isProtected() then | |||
ret[#ret + 1] = tostring( | |||
if protectionObj | (yesno(args.small) and Padlock or Banner) | ||
.new(protectionObj, blurbObj, cfg) | |||
) | |||
end | |||
-- Render the categories | -- Render the categories | ||
if yesno(args.category) ~= false then | if yesno(args.category) ~= false then | ||
Line 874: | Line 895: | ||
-- Find default args, if any. | -- Find default args, if any. | ||
local | local parentTitle = frame:getParent():getTitle() | ||
parentTitle = parentTitle:gsub('/sandbox$', '') | |||
local defaultArgs = cfg.wrappers[parentTitle] or {} | |||
-- Find user args, and use the parent frame if we are being called from a | -- Find user args, and use the parent frame if we are being called from a | ||
Line 887: | Line 909: | ||
-- Build the args table. User-specified args overwrite default args. | -- Build the args table. User-specified args overwrite default args. | ||
local args = {} | local args = {} | ||
for k, v in pairs(defaultArgs | for k, v in pairs(defaultArgs) do | ||
args[k] = v | args[k] = v | ||
end | end |