Editing Module:Protection banner
From MINR.ORG WIKI
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save 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 class = require('Module:Middleclass').class |
+ | 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') | ||
-- 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 | ||
− | |||
− | |||
− | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
Line 19: | Line 16: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local function makeCategoryLink(cat | + | local function makeWikitextError(msg) |
+ | -- @TODO: localise this. | ||
+ | local boilerplate = 'Error: $1 ([[Module:Protection banner#Errors|help]])' | ||
+ | local errorText = mw.message.newRawMessage(boilerplate):params(msg):plain() | ||
+ | return string.format( | ||
+ | '<strong class="error">%s</strong>', | ||
+ | errorText | ||
+ | ) | ||
+ | end | ||
+ | |||
+ | local function makeCategoryLink(cat) | ||
if cat then | if cat then | ||
return string.format( | return string.format( | ||
− | '[[%s: | + | '[[%s:%s]]', |
mw.site.namespaces[14].name, | mw.site.namespaces[14].name, | ||
− | cat | + | 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 55: | Line 61: | ||
display | display | ||
) | ) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
Line 82: | Line 67: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local Protection = | + | local Protection = class('Protection') |
− | |||
Protection.supportedActions = { | Protection.supportedActions = { | ||
edit = true, | edit = true, | ||
move = true, | move = true, | ||
− | autoreview | + | autoreview = true |
− | |||
} | } | ||
Line 101: | Line 84: | ||
} | } | ||
− | function Protection | + | function Protection:initialize(args, cfg, title) |
− | + | self._cfg = cfg | |
− | + | self.title = title or mw.title.getCurrentTitle() | |
− | |||
-- Set action | -- Set action | ||
if not args.action then | if not args.action then | ||
− | + | self.action = 'edit' | |
− | elseif | + | elseif self.supportedActions[args.action] then |
− | + | self.action = args.action | |
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 | ||
− | + | self.level = effectiveProtectionLevel(self.action, self.title) | |
− | if not | + | if self.level == 'accountcreator' then |
+ | -- Lump titleblacklisted pages in with template-protected pages, | ||
+ | -- since templateeditors can do both. | ||
+ | self.level = 'templateeditor' | ||
+ | elseif not self.level or (self.action == 'move' and self.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. | ||
− | + | self.level = '*' | |
end | end | ||
-- Set expiry | -- Set expiry | ||
− | + | if args.expiry then | |
− | + | if cfg.indefStrings[args.expiry] then | |
− | + | self.expiry = 'indef' | |
− | + | elseif type(args.expiry) == 'number' then | |
− | + | self.expiry = args.expiry | |
+ | else | ||
+ | self.expiry = validateDate(args.expiry, 'expiry date') | ||
+ | end | ||
end | end | ||
-- Set reason | -- Set reason | ||
− | + | do | |
− | + | local reason = args.reason or args[1] | |
− | if | + | if reason then |
− | + | self.reason = mw.ustring.lower(reason) | |
end | end | ||
end | end | ||
-- Set protection date | -- Set protection date | ||
− | + | self.protectionDate = validateDate(args.date, 'protection date') | |
− | |||
− | |||
-- Set banner config | -- Set banner config | ||
do | do | ||
− | + | self.bannerConfig = {} | |
local configTables = {} | local configTables = {} | ||
− | if cfg.banners[ | + | if cfg.banners[self.action] then |
− | configTables[#configTables + 1] = cfg.banners[ | + | configTables[#configTables + 1] = cfg.banners[self.action][self.reason] |
end | end | ||
− | if cfg.defaultBanners[ | + | if cfg.defaultBanners[self.action] then |
− | configTables[#configTables + 1] = cfg.defaultBanners[ | + | configTables[#configTables + 1] = cfg.defaultBanners[self.action][self.level] |
− | configTables[#configTables + 1] = cfg.defaultBanners[ | + | configTables[#configTables + 1] = cfg.defaultBanners[self.action].default |
end | end | ||
configTables[#configTables + 1] = cfg.masterBanner | configTables[#configTables + 1] = cfg.masterBanner | ||
− | for i, field in ipairs( | + | for i, field in ipairs(self.bannerConfigFields) do |
for j, t in ipairs(configTables) do | for j, t in ipairs(configTables) do | ||
if t[field] then | if t[field] then | ||
− | + | self.bannerConfig[field] = t[field] | |
break | break | ||
end | end | ||
Line 168: | Line 155: | ||
end | end | ||
end | end | ||
− | |||
end | end | ||
function Protection:isProtected() | function Protection:isProtected() | ||
return self.level ~= '*' | return self.level ~= '*' | ||
− | |||
− | |||
− | |||
− | |||
end | end | ||
Line 197: | Line 179: | ||
-- 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 | ||
Line 213: | Line 198: | ||
} | } | ||
− | -- | + | -- To generate the correct category for some reason values, we need to |
− | + | -- prioritise the position of the namespace key fragment over that of the | |
− | + | -- reason key fragment. For these reasn values, swap the namespace subtable | |
− | -- | + | -- and the reason subtable around. |
− | + | if self.reason and cfg.reasonsWithNamespacePriority[self.reason] then | |
− | -- | + | table.insert(order, 3, table.remove(order, 2)) |
− | + | end | |
− | -- the | ||
− | |||
− | |||
− | |||
− | |||
--[[ | --[[ | ||
Line 298: | Line 278: | ||
end | end | ||
end | end | ||
− | key = table.concat(key, ' | + | key = table.concat(key, '-') |
local attempt = cats[key] | local attempt = cats[key] | ||
if attempt then | if attempt then | ||
− | return makeCategoryLink(attempt | + | return makeCategoryLink(attempt) |
end | end | ||
end | end | ||
− | return ' | + | end |
+ | |||
+ | function Protection:needsExpiry() | ||
+ | local cfg = self._cfg | ||
+ | return not self.expiry | ||
+ | and cfg.expiryCheckActions[self.action] | ||
+ | and self.reason -- the old {{pp-protected}} didn't check for expiry | ||
+ | and not cfg.reasonsWithoutExpiryCheck[self.reason] | ||
end | end | ||
Line 325: | Line 312: | ||
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']) | ||
+ | end | ||
if self:isIncorrect() then | if self:isIncorrect() then | ||
− | ret[#ret + 1] = makeCategoryLink( | + | ret[#ret + 1] = makeCategoryLink(msg['tracking-category-incorrect']) |
− | |||
− | |||
− | |||
end | end | ||
if self:isTemplateProtectedNonTemplate() then | if self:isTemplateProtectedNonTemplate() then | ||
− | ret[#ret + 1] = makeCategoryLink( | + | ret[#ret + 1] = makeCategoryLink(msg['tracking-category-template']) |
− | |||
− | |||
− | |||
end | end | ||
return table.concat(ret) | return table.concat(ret) | ||
Line 344: | Line 328: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local Blurb = | + | local Blurb = class('Blurb') |
− | Blurb | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | function Blurb | + | function Blurb:initialize(protectionObj, args, cfg) |
− | + | self._cfg = cfg | |
− | + | self._protectionObj = protectionObj | |
− | + | self._username = args.user | |
− | + | self._section = args.section | |
− | |||
end | end | ||
− | -- | + | -- Static methods -- |
− | function Blurb | + | function Blurb.formatDate(num) |
-- Formats a Unix timestamp into dd Month, YYYY format. | -- Formats a Unix timestamp into dd Month, YYYY format. | ||
lang = lang or mw.language.getContentLanguage() | lang = lang or mw.language.getContentLanguage() | ||
Line 371: | Line 345: | ||
lang.formatDate, | lang.formatDate, | ||
lang, | lang, | ||
− | + | 'j F Y', | |
'@' .. tostring(num) | '@' .. tostring(num) | ||
) | ) | ||
Line 378: | Line 352: | ||
end | end | ||
end | end | ||
+ | |||
+ | -- Private methods -- | ||
function Blurb:_getExpandedMessage(msgKey) | function Blurb:_getExpandedMessage(msgKey) | ||
Line 388: | Line 364: | ||
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter | parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter | ||
+ | parameterFuncs.DISPUTEBLURB = self._makeDisputeBlurbParameter | ||
+ | parameterFuncs.DISPUTESECTION = self._makeDisputeSectionParameter | ||
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter | parameterFuncs.EDITREQUEST = self._makeEditRequestParameter | ||
parameterFuncs.EXPIRY = self._makeExpiryParameter | parameterFuncs.EXPIRY = self._makeExpiryParameter | ||
Line 393: | Line 371: | ||
parameterFuncs.IMAGELINK = self._makeImageLinkParameter | parameterFuncs.IMAGELINK = self._makeImageLinkParameter | ||
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter | parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter | ||
− | parameterFuncs. | + | parameterFuncs.OFFICEBLURB = self._makeOfficeBlurbParameter |
parameterFuncs.PAGETYPE = self._makePagetypeParameter | parameterFuncs.PAGETYPE = self._makePagetypeParameter | ||
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter | parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter | ||
Line 399: | Line 377: | ||
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter | parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter | ||
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter | parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter | ||
+ | parameterFuncs.RESETBLURB = self._makeResetBlurbParameter | ||
parameterFuncs.TALKPAGE = self._makeTalkPageParameter | parameterFuncs.TALKPAGE = self._makeTalkPageParameter | ||
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter | parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter | ||
− | |||
parameterFuncs.VANDAL = self._makeVandalTemplateParameter | parameterFuncs.VANDAL = self._makeVandalTemplateParameter | ||
Line 439: | Line 417: | ||
self:_getExpandedMessage('current-version-edit-display') | self:_getExpandedMessage('current-version-edit-display') | ||
) | ) | ||
+ | end | ||
+ | end | ||
+ | |||
+ | function Blurb:_makeDisputeBlurbParameter() | ||
+ | if type(self._protectionObj.expiry) == 'number' then | ||
+ | return self:_getExpandedMessage('dispute-blurb-expiry') | ||
+ | else | ||
+ | return self:_getExpandedMessage('dispute-blurb-noexpiry') | ||
+ | end | ||
+ | end | ||
+ | |||
+ | function Blurb:_makeDisputeSectionParameter() | ||
+ | -- "disputes", with or without a section link | ||
+ | local disputes = self:_getExpandedMessage('dispute-section-link-display') | ||
+ | if self._section then | ||
+ | return string.format( | ||
+ | '[[%s:%s#%s|%s]]', | ||
+ | mw.site.namespaces[self._protectionObj.title.namespace].talk.name, | ||
+ | self._protectionObj.title.text, | ||
+ | self._section, | ||
+ | disputes | ||
+ | ) | ||
+ | else | ||
+ | return disputes | ||
end | end | ||
end | end | ||
Line 446: | Line 448: | ||
local action = self._protectionObj.action | local action = self._protectionObj.action | ||
local level = self._protectionObj.level | local level = self._protectionObj.level | ||
+ | |||
+ | -- Get the display message key. | ||
+ | local key | ||
+ | if action == 'edit' and level == 'autoconfirmed' then | ||
+ | key = 'edit-request-semi-display' | ||
+ | else | ||
+ | key = 'edit-request-full-display' | ||
+ | end | ||
+ | local display = self:_getExpandedMessage(key) | ||
-- Get the edit request type. | -- Get the edit request type. | ||
Line 452: | Line 463: | ||
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 460: | Line 469: | ||
requestType = requestType or 'full' | requestType = requestType or 'full' | ||
− | + | return mEditRequest.exportLinkToLua{type = requestType, display = display} | |
− | |||
− | |||
− | return mEditRequest. | ||
end | end | ||
Line 469: | Line 475: | ||
local expiry = self._protectionObj.expiry | local expiry = self._protectionObj.expiry | ||
if type(expiry) == 'number' then | if type(expiry) == 'number' then | ||
− | return | + | return Blurb.formatDate(expiry) |
else | else | ||
return expiry | return expiry | ||
Line 476: | Line 482: | ||
function Blurb:_makeExplanationBlurbParameter() | function Blurb:_makeExplanationBlurbParameter() | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
local action = self._protectionObj.action | local action = self._protectionObj.action | ||
local level = self._protectionObj.level | local level = self._protectionObj.level | ||
− | local | + | local namespace = self._protectionObj.title.namespace |
+ | local isTalk = self._protectionObj.title.isTalkPage | ||
− | -- | + | -- @TODO: add semi-protection and pending changes blurbs |
− | + | local key | |
− | + | if namespace == 8 then | |
− | local | + | -- MediaWiki namespace |
− | if | + | key = 'explanation-blurb-full-nounprotect' |
− | + | elseif action == 'edit' and level == 'sysop' and not isTalk then | |
− | elseif | + | key = 'explanation-blurb-full-subject' |
− | + | elseif action == 'move' then | |
− | elseif | + | if isTalk then |
− | + | key = 'explanation-blurb-move-talk' | |
− | + | else | |
− | + | key = 'explanation-blurb-move-subject' | |
+ | end | ||
else | else | ||
− | + | key = 'explanation-blurb-default' | |
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
− | return self: | + | return self:_getExpandedMessage(key) |
end | end | ||
Line 526: | Line 522: | ||
function Blurb:_makeIntroBlurbParameter() | function Blurb:_makeIntroBlurbParameter() | ||
− | if self._protectionObj | + | if type(self._protectionObj.expiry) == 'number' then |
return self:_getExpandedMessage('intro-blurb-expiry') | return self:_getExpandedMessage('intro-blurb-expiry') | ||
else | else | ||
Line 533: | Line 529: | ||
end | end | ||
− | function Blurb: | + | function Blurb:_makeOfficeBlurbParameter() |
− | if self._protectionObj | + | if self._protectionObj.protectionDate then |
− | return self:_getExpandedMessage(' | + | return self:_getExpandedMessage('office-blurb-protectiondate') |
else | else | ||
− | return self:_getExpandedMessage(' | + | return self:_getExpandedMessage('office-blurb-noprotectiondate') |
end | end | ||
end | end | ||
Line 545: | Line 541: | ||
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 560: | Line 556: | ||
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 568: | Line 564: | ||
local protectionDate = self._protectionObj.protectionDate | local protectionDate = self._protectionObj.protectionDate | ||
if type(protectionDate) == 'number' then | if type(protectionDate) == 'number' then | ||
− | return | + | return Blurb.formatDate(protectionDate) |
else | else | ||
return protectionDate | return protectionDate | ||
Line 586: | Line 582: | ||
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 607: | Line 603: | ||
self:_getExpandedMessage('protection-log-display') | self:_getExpandedMessage('protection-log-display') | ||
) | ) | ||
+ | end | ||
+ | end | ||
+ | |||
+ | function Blurb:_makeResetBlurbParameter() | ||
+ | if self._protectionObj.protectionDate then | ||
+ | return self:_getExpandedMessage('reset-blurb-protectiondate') | ||
+ | else | ||
+ | return self:_getExpandedMessage('reset-blurb-noprotectiondate') | ||
end | end | ||
end | end | ||
Line 615: | Line 619: | ||
mw.site.namespaces[self._protectionObj.title.namespace].talk.name, | mw.site.namespaces[self._protectionObj.title.namespace].talk.name, | ||
self._protectionObj.title.text, | self._protectionObj.title.text, | ||
− | self. | + | self._section or 'top', |
self:_getExpandedMessage('talk-page-link-display') | self:_getExpandedMessage('talk-page-link-display') | ||
) | ) | ||
Line 621: | Line 625: | ||
function Blurb:_makeTooltipBlurbParameter() | function Blurb:_makeTooltipBlurbParameter() | ||
− | if self._protectionObj | + | if type(self._protectionObj.expiry) == 'number' then |
return self:_getExpandedMessage('tooltip-blurb-expiry') | return self:_getExpandedMessage('tooltip-blurb-expiry') | ||
else | else | ||
return self:_getExpandedMessage('tooltip-blurb-noexpiry') | return self:_getExpandedMessage('tooltip-blurb-noexpiry') | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
end | end | ||
Line 638: | Line 634: | ||
function Blurb:_makeVandalTemplateParameter() | function Blurb:_makeVandalTemplateParameter() | ||
return require('Module:Vandal-m')._main{ | return require('Module:Vandal-m')._main{ | ||
− | self. | + | self._username or self._protectionObj.title.baseText |
} | } | ||
end | end | ||
Line 644: | Line 640: | ||
-- Public methods -- | -- Public methods -- | ||
− | function Blurb: | + | function Blurb:makeReasonText() |
− | + | local msg = self._protectionObj.bannerConfig.text | |
− | if | + | if msg then |
− | + | return self:_substituteParameters(msg) | |
− | |||
− | |||
− | |||
end | end | ||
+ | end | ||
− | + | function Blurb:makeExplanationText() | |
− | local msg = self._protectionObj.bannerConfig | + | local msg = self._protectionObj.bannerConfig.explanation |
− | + | return self:_substituteParameters(msg) | |
− | + | end | |
− | + | ||
− | + | function Blurb:makeTooltipText() | |
− | + | local msg = self._protectionObj.bannerConfig.tooltip | |
− | + | return self:_substituteParameters(msg) | |
− | + | end | |
− | + | ||
− | + | function Blurb:makeAltText() | |
− | + | local msg = self._protectionObj.bannerConfig.alt | |
− | + | return self:_substituteParameters(msg) | |
− | + | end | |
− | + | ||
− | + | function Blurb:makeLinkText() | |
+ | local msg = self._protectionObj.bannerConfig.link | ||
+ | return self:_substituteParameters(msg) | ||
end | end | ||
Line 675: | Line 671: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local BannerTemplate = | + | local BannerTemplate = class('BannerTemplate') |
− | |||
− | function BannerTemplate | + | function BannerTemplate:initialize(protectionObj, cfg) |
− | + | self._cfg = cfg | |
− | |||
-- Set the image filename. | -- Set the image filename. | ||
local imageFilename = protectionObj.bannerConfig.image | local imageFilename = protectionObj.bannerConfig.image | ||
if imageFilename then | if imageFilename then | ||
− | + | self._imageFilename = imageFilename | |
else | else | ||
-- If an image filename isn't specified explicitly in the banner config, | -- If an image filename isn't specified explicitly in the banner config, | ||
Line 691: | Line 685: | ||
local action = protectionObj.action | local action = protectionObj.action | ||
local level = protectionObj.level | local level = protectionObj.level | ||
+ | local expiry = protectionObj.expiry | ||
local namespace = protectionObj.title.namespace | local namespace = protectionObj.title.namespace | ||
− | |||
-- Deal with special cases first. | -- Deal with special cases first. | ||
− | if ( | + | if (namespace == 10 or namespace == 828) |
− | |||
− | |||
− | |||
− | |||
and action == 'edit' | and action == 'edit' | ||
and level == 'sysop' | and level == 'sysop' | ||
− | and not | + | and not expiry |
then | then | ||
-- Fully protected modules and templates get the special red "indef" | -- Fully protected modules and templates get the special red "indef" | ||
-- padlock. | -- padlock. | ||
− | + | self._imageFilename = self._cfg.msg['image-filename-indef'] | |
else | else | ||
-- Deal with regular protection types. | -- Deal with regular protection types. | ||
− | local images = | + | local images = self._cfg.images |
if images[action] then | if images[action] then | ||
if images[action][level] then | if images[action][level] then | ||
− | + | self._imageFilename = images[action][level] | |
elseif images[action].default then | elseif images[action].default then | ||
− | + | self._imageFilename = images[action].default | |
end | end | ||
end | end | ||
end | end | ||
end | end | ||
− | + | end | |
+ | |||
+ | function BannerTemplate:setImageWidth(width) | ||
+ | self._imageWidth = width | ||
+ | end | ||
+ | |||
+ | function BannerTemplate:setImageTooltip(tooltip) | ||
+ | self._imageCaption = tooltip | ||
end | end | ||
Line 726: | Line 723: | ||
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 739: | Line 735: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local Banner = | + | local Banner = BannerTemplate:subclass('Banner') |
− | |||
− | function Banner | + | function Banner:initialize(protectionObj, blurbObj, cfg) |
− | + | BannerTemplate.initialize(self, protectionObj, cfg) -- This doesn't need the blurb. | |
− | + | self:setImageWidth(40) | |
− | + | self:setImageTooltip(blurbObj:makeAltText()) -- Large banners use the alt text for the tooltip. | |
− | + | self._reasonText = blurbObj:makeReasonText() | |
− | + | self._explanationText = blurbObj:makeExplanationText() | |
− | + | self._page = protectionObj.title.prefixedText -- Only makes a difference in testing. | |
− | |||
end | end | ||
Line 755: | Line 749: | ||
-- 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 774: | Line 768: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
− | local Padlock = | + | local Padlock = BannerTemplate:subclass('Padlock') |
− | |||
− | function Padlock | + | function Padlock:initialize(protectionObj, blurbObj, cfg) |
− | + | BannerTemplate.initialize(self, protectionObj, cfg) -- This doesn't need the blurb. | |
− | + | self:setImageWidth(20) | |
− | + | self:setImageTooltip(blurbObj:makeTooltipText()) | |
− | + | self._imageAlt = blurbObj:makeAltText() | |
− | + | self._imageLink = blurbObj:makeLinkText() | |
− | + | self._right = cfg.padlockPositions[protectionObj.action] | |
− | or cfg. | + | or cfg.padlockPositions.default |
− | or ' | + | or '55px' |
− | |||
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 | ||
+ | |||
+ | -------------------------------------------------------------------------------- | ||
+ | -- Documentation class | ||
+ | -------------------------------------------------------------------------------- | ||
+ | |||
+ | local Documentation = class('Documentation') | ||
+ | |||
+ | function Documentation:initialize(cfg) | ||
+ | self._cfg = cfg | ||
+ | end | ||
+ | |||
+ | function Documentation:makeReasonTable() | ||
+ | -- Get the data from the cfg.banners table. | ||
+ | local rowData = {} | ||
+ | for action, reasonTables in pairs(self._cfg.banners) do | ||
+ | for reason, t in pairs(reasonTables) do | ||
+ | rowData[#rowData + 1] = { | ||
+ | reason = reason, | ||
+ | action = action, | ||
+ | description = t.description | ||
+ | } | ||
+ | end | ||
+ | end | ||
+ | |||
+ | -- Sort the table into alphabetical order, first by action and then by | ||
+ | -- reason. | ||
+ | table.sort(rowData, function (t1, t2) | ||
+ | if t1.action == t2.action then | ||
+ | return t1.reason < t2.reason | ||
+ | else | ||
+ | return t1.action < t2.action | ||
+ | end | ||
+ | end) | ||
+ | |||
+ | -- Assemble a wikitable of the data. | ||
+ | local msg = self._cfg.msg | ||
+ | local ret = {} | ||
+ | ret[#ret + 1] = '{| class="wikitable"' | ||
+ | if #rowData < 1 then | ||
+ | ret[#ret + 1] = '|-' | ||
+ | ret[#ret + 1] = string.format( | ||
+ | '| colspan="3" | %s', | ||
+ | msg['documentation-blurb-noreasons'] | ||
+ | ) | ||
+ | else | ||
+ | -- Header | ||
+ | ret[#ret + 1] = '|-' | ||
+ | ret[#ret + 1] = string.format( | ||
+ | '! %s\n! %s\n! %s', | ||
+ | msg['documentation-heading-reason'], | ||
+ | msg['documentation-heading-action'], | ||
+ | msg['documentation-heading-description'] | ||
+ | ) | ||
+ | -- Rows | ||
+ | for _, t in ipairs(rowData) do | ||
+ | ret[#ret + 1] = '|-' | ||
+ | ret[#ret + 1] = string.format( | ||
+ | '| %s\n| %s\n| %s', | ||
+ | t.reason, | ||
+ | t.action, | ||
+ | t.description | ||
+ | ) | ||
+ | end | ||
+ | end | ||
+ | ret[#ret + 1] = '|}' | ||
+ | |||
+ | return table.concat(ret, '\n') | ||
end | end | ||
Line 814: | Line 874: | ||
Padlock = Padlock, | Padlock = Padlock, | ||
} | } | ||
+ | end | ||
+ | |||
+ | function p.reasonTable() | ||
+ | local cfg = mw.loadData('Module:Protection banner/config') | ||
+ | local documentationObj = Documentation:new(cfg) | ||
+ | return documentationObj:makeReasonTable() | ||
end | end | ||
function p._main(args, cfg, title) | function p._main(args, cfg, title) | ||
− | + | if not cfg then | |
− | + | cfg = mw.loadData('Module:Protection banner/config') | |
+ | end | ||
− | local protectionObj = Protection.new(args, cfg, title) | + | -- 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 | ||
+ | -- protectionObj is the error message. | ||
+ | return makeWikitextError(protectionObj) | ||
+ | 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 854: | Line 920: | ||
end | end | ||
− | function p.main(frame | + | function p.main(frame) |
− | + | if not getArgs then | |
− | + | getArgs = require('Module:Arguments').getArgs | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
− | return p._main(args | + | local args = getArgs(frame, {wrappers = 'Template:Pp'}) |
+ | return p._main(args) | ||
end | end | ||
return p | return p |