TestWiki

Module:Protection banner: Difference between revisions

Module Discussion

Module:Protection banner (view source)

Revision as of 15:41, 29 November 2023

9,140 bytes added ,  6 months ago
m
1 revision imported
Enwikipedia>Mr. Stradivarius
(move the parameter functions to the top level of the blurb class and add a new one)
m (1 revision imported)
Tags: Mobile edit Mobile web edit Advanced mobile edit
 
(173 intermediate revisions by 32 users not shown)
Line 3:
 
-- Initialise necessary modules.
require('Module:No globalsstrict')
local classmakeFileLink = require('Module:MiddleclassFile link').class_main
local mArgumentseffectiveProtectionLevel = require('Module:ArgumentsEffective protection level')._main
local mFileLinkeffectiveProtectionExpiry = require('Module:FileEffective linkprotection expiry')._main
local mProtectionLevel = require('Module:Effective protection level')
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'
 
--------------------------------------------------------------------------------
-- Helper functions
-- ProtectionStatus class
--------------------------------------------------------------------------------
 
local function makeCategoryLink(cat, sort)
local ProtectionStatus = class('ProtectionStatus')
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat,
sort
)
end
end
 
-- Validation function for the expiry and the protection date
function ProtectionStatus:initialize(args, titleObj)
local function validateDate(dateString, dateType)
-- Set action
if not lang then
do
lang = mw.language.getContentLanguage()
local actions = {
create = true,
edit = true,
move = true,
autoreview = true
}
if args.action and actions[args.action] then
self._action = args.action
else
self._action = 'edit'
end
end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
 
if success then
-- Set level
result = tonumber(result)
do
if result then
local level = mProtectionLevel._main(self._action, titleObj)
return result
if level == 'accountcreator' then
-- Lump titleblacklisted pages in with template-protected pages,
-- since templateeditors can do both.
level = 'templateeditor'
end
self._level = level or '*'
end
error(string.format(
 
'invalid %s: %s',
-- Set other params
dateType,
self._reason = args.reason
tostring(dateString)
self._expiry = args.expiry or 'indef'
), 4)
self._section = args.section
end
 
local function makeFullUrl(page, query, display)
function ProtectionStatus:getAction()
return selfstring._actionformat(
'[%s %s]',
tostring(mw.uri.fullUrl(page, query)),
display
)
end
 
-- Given a directed graph formatted as node -> table of direct successors,
function ProtectionStatus:getLevel()
-- get a table of all nodes reachable from a given node (though always
return self._level
-- including the given node).
end
local function getReachableNodes(graph, start)
 
local toWalk, retval = {[start] = true}, {}
function ProtectionStatus:getReason()
while true do
return self._reason
-- Can't use pairs() since we're adding and removing things as we're iterating
end
local k = next(toWalk) -- This always gets the "first" key
 
if k == nil then
function ProtectionStatus:getExpiry()
return self._expiryretval
end
toWalk[k] = nil
 
retval[k] = true
function ProtectionStatus:getSection()
for _,v in ipairs(graph[k]) do
return self._section
if not retval[v] then
end
toWalk[v] = true
 
end
--------------------------------------------------------------------------------
end
-- Config class
--------------------------------------------------------------------------------
 
local Config = class('Config')
 
function Config:initialize()
self._cfg = mw.loadData('Module:Protection banner/config')
end
 
function Config:getBannerConfig(protectionStatusObj)
local cfg = self._cfg
local action = protectionStatusObj:getAction()
local reason = protectionStatusObj:getReason()
if cfg.banners[action][reason] then
return cfg.banners[action][reason]
else
return cfg.defaultBanners[action]
end
end
 
function Config:getConfigTable(key)
local blacklist = {
banners = true,
defaultBanners = true
}
if not blacklist[key] then
return self._cfg[key]
else
return nil
end
end
 
function Config:getMessage(key)
return self._cfg.msg[key]
end
 
--------------------------------------------------------------------------------
-- BlurbProtection class
--------------------------------------------------------------------------------
 
local BlurbProtection = class('Blurb'){}
Protection.__index = Protection
 
Protection.supportedActions = {
function Blurb:initialize(configObj, protectionStatusObj, titleObj)
edit = true,
self._configObj = configObj
move = true,
self._protectionStatusObj = protectionStatusObj
autoreview = true,
self._bannerConfig = configObj:getBannerConfig(protectionStatusObj)
upload = true
self._titleObj = titleObj
}
end
 
Protection.bannerConfigFields = {
function Blurb:_substituteParameters(msg)
'text',
if not self._params then
'explanation',
local params, parameterFuncs = {}, {}
'tooltip',
setmetatable(params, {
'alt',
__index = function (t, k)
'link',
local param
'image'
if parameterFuncs[k] then
}
param = parameterFuncs[k]()
end
param = param or ''
params[k] = param
return param
end
})
parameterFuncs[1] = function ()
return self:_makeIntroParameter()
end
parameterFuncs[2] = function ()
return self:_makeUntilParameter()
end
parameterFuncs[3] = function ()
return self:_makeDisputesParameter()
end
parameterFuncs[4] = function ()
return self:_makePagetypeParameter()
end
parameterFuncs[5] = function ()
return self:_makeProtectionDateParameter()
end
 
function Protection.new(args, cfg, title)
parameterFuncs[6] = function ()
local obj = {}
return self:_makeVandalTemplateParameter()
obj._cfg = cfg
end
obj.title = title or mw.title.getCurrentTitle()
 
-- Set action
parameterFuncs[7] = function ()
if not args.action then
return self:_makeProtectionLevelParameter()
obj.action = 'edit'
end
elseif Protection.supportedActions[args.action] then
 
obj.action = args.action
parameterFuncs[8] = function ()
return self:_makeExpiryParameter()
end
 
parameterFuncs[9] = function ()
return self:_makeDisputeLinkParameter() -- A link to the page history or the move log
end
 
parameterFuncs[10] = function ()
return self:_makeProtectionLogParameter()
end
 
parameterFuncs[11] = function ()
return self:_makeTalkLinkParameter()
end
 
parameterFuncs[12] = function ()
return self:_makeEditRequestParameter()
end
 
parameterFuncs[13] = function ()
return self:_makeRequestUnprotectionParameter()
end
 
parameterFuncs[14] = function ()
return self:_makeSubjectPageLinksParameter() -- Adds links to edit requests and the talk page if we are on a subject page
end
 
parameterFuncs[15] = function ()
return self:_makeDeletionDiscussionParameter()
end
 
parameterFuncs[16] = function ()
return self:_makeDeletionLogParameter()
end
self._params = params
end
return mw.message.newRawMessage(msg):params(self._params):plain()
end
 
function Blurb:_makeIntroParameter()
-- parameter $1
local key
local action = self._protectionStatusObj:getAction()
local level = self._protectionStatusObj:getLevel()
if action == 'edit' and level == 'autoconfirmed' then
key = 'reason-text-semi'
elseif action == 'move' then
key = 'reason-text-move'
elseif action == 'create' then
key = 'reason-text-create'
else
error(string.format(
key = 'reason-text-default'
'invalid action: %s',
tostring(args.action)
), 3)
end
local msg = self._configObj:getMessage(key)
return self:_substituteParameters(msg)
end
 
-- Set level
function Blurb:_makeUntilParameter()
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
-- parameter $2
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- "until" or "or until" depending on the expiry
-- Users need to be autoconfirmed to move pages anyway, so treat
local expiry = self._protectionStatusObj:getExpiry()
-- semi-move-protected pages as unprotected.
if expiry then
returnobj.level 'or= until'*'
else
return 'until'
end
end
 
-- Set expiry
function Blurb:_makeDisputesParameter()
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
-- parameter $3
if effectiveExpiry == 'infinity' then
-- "disputes", with or without a section link
obj.expiry = 'indef'
local section = self._protectionStatusObj:getSection()
elseif effectiveExpiry ~= 'unknown' then
local disputes = self.configObj:getMessage('dispute-section-link-display')
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
if section then
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._titleObj.namespace].talk.name,
self._titleObj.text,
section,
disputes
)
else
return disputes
end
end
 
-- Set reason
function Blurb:_makePagetypeParameter()
if args[1] then
-- parameter $4
obj.reason = mw.ustring.lower(args[1])
local pagetypes = self._configObj:getConfigTable('pagetypeNamespaces')
if obj.reason:find('|') then
local namespace = self._titleObj:getNamespace()
error('reasons cannot contain the pipe character ("|")', 3)
return pagetypes[namespace] or pagetypes.default or 'page'
end
 
function Blurb:_makeProtectionDateParameter()
-- parameter $5
if self._protectionDate then
local lang = mw.language.getContentLanguage()
local success, date = pcall(
lang.formatDate,
lang,
'j F Y',
self._protectionDate
)
if success and date then
return date
end
end
end
 
-- Set protection date
--------------------------------------------------------------------------------
if args.date then
-- Image class
obj.protectionDate = validateDate(args.date, 'protection date')
--------------------------------------------------------------------------------
end
 
local Image = class('Image')
-- Set banner config
 
do
function Image:initialize(configObj, protectionStatusObj, titleObj)
obj.bannerConfig = {}
self._configObj = configObj
local configTables = {}
self._protectionStatusObj = protectionStatusObj
if cfg.banners[obj.action] then
self._titleObj = titleObj
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
end
 
function Image:setFilename(filename)
if filename then
self._filename = filename
else
local images, action, level, reason, namespace
do
local configObj = self._configObj
local protectionStatusObj = self._protectionStatusObj
local titleObj = self._titleObj
images = configObj:getConfigTable('images')
action = protectionStatusObj:getAction()
level = protectionStatusObj:getLevel()
reason = protectionStatusObj:getReason()
namespace = titleObj:getNamespace()
end
if cfg.defaultBanners[obj.action] then
 
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
local image
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
if reason == 'office' or reason == 'reset' then
end
image = images.office
configTables[#configTables + 1] = cfg.masterBanner
elseif namespace == 10 or namespace == 828 then
for i, field in ipairs(Protection.bannerConfigFields) do
-- We are in the template or module namespaces.
for j, t in ipairs(configTables) do
if level == 'templateeditor' then
if t[field] then
image = images.template
obj.bannerConfig[field] = t[field]
elseif level == 'sysop' then
break
image = images.indef
end
elseif action == 'create' then
image = images.create
elseif action == 'move'
and (
level == 'templateeditor'
or level == 'sysop'
)
then
image = images.move
elseif action == 'edit' then
if level == 'sysop' then
image = images.full
elseif level == 'autoconfirmed' then
image = images.semi
end
elseif action == 'autoreview' then
if level == 'autoconfirmed' then
image = images.pc1
elseif level == 'reviewer' then
image = images.pc2
end
end
self._filename = image
end
return setmetatable(obj, Protection)
end
 
function ImageProtection:setWidthisUserScript(width)
-- Whether the page is a user JavaScript or CSS page.
self._width = width
local title = self.title
return title.namespace == 2 and (
title.contentModel == 'javascript' or title.contentModel == 'css'
)
end
 
function ImageProtection:setAltisProtected(alt)
return self._altlevel ~= alt'*'
end
 
function ImageProtection:setLinkshouldShowLock(link)
-- Whether we should output a banner/padlock
self._link = link
return self:isProtected() and not self:isUserScript()
end
 
-- Whether this page needs a protection category.
function Image:setCaption(caption)
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock
self._caption = caption
end
 
function ImageProtection:exportisTemporary()
return mFileLink.newtype(self._filenameexpiry) or== 'Transparent.gifnumber')
:width(self._width or 20)
:alt(self._alt)
:link(self._link)
:caption(self._caption)
:render()
end
 
function Protection:makeProtectionCategory()
--------------------------------------------------------------------------------
if not self:shouldHaveProtectionCategory() then
-- BannerTemplate class
--------------------------------------------------------------------------------
 
local BannerTemplate = class('BannerTemplate')
 
function BannerTemplate:initialize()
end
 
function BannerTemplate:render()
end
 
--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------
 
local Banner = BannerTemplate:subclass('Banner')
 
--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------
 
local Padlock = BannerTemplate:subclass('Padlock')
 
--------------------------------------------------------------------------------
-- Category class
--------------------------------------------------------------------------------
 
local Category = class('Category')
 
function Category:initialize()
end
 
function Category:setName(name)
self._name = name
end
 
function Category:export()
if self._categoryName then
return string.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
self._categoryName
)
else
return ''
end
end
 
local cfg = self._cfg
--------------------------------------------------------------------------------
local title = self.title
-- ProtectionCategory class
--------------------------------------------------------------------------------
 
local ProtectionCategory = Category:subclass('ProtectionCategory')
 
function ProtectionCategory:setName(
name,
configObj,
protectionStatusObj,
namespace
)
--[[
-- Sets the protection category. If a category name is not provided, this
-- method gets a category name from the module config, given a combination
-- of the protection type, the protection level, the namespace number, the
-- reason for protection, and the expiry date.
--]]
-- IfGet athe nameexpiry waskey provided, use thatfragment.
local expiryFragment
if name then
if self.expiry == 'indef' then
Category.setName(self, name)
expiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
end
 
-- Get the namespace category key from the namespace numberfragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
local nskey
if not namespaceFragment and title.namespace % 2 == 1 then
do
namespaceFragment = 'talk'
local categoryNamespaces = configObj:getConfigTable('categoryNamespaces')
if not namespace or type(namespace) ~= 'number' then
nskey = nil
else
nskey = categoryNamespaces[ns]
if not nskey and ns % 2 == 1 then
nskey = 'talk'
end
end
end
 
-- 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
-- Define the properties table. Each property is a table containing the
-- position in the cfg.protectionCategories table.
-- canonical order that the property is tested in, the position the
local order = {
-- property has in the category key strings, and the property value itself.
{val = expiryFragment, keypos = 1},
--]]
{val = namespaceFragment, keypos = 2},
local properties = {
{val = self.reason, keypos = 3},
expiry = {order = 1, keypos = 5, val = protectionStatusObj:getExpiry()},
namespace = {orderval = 2self.level, keypos = 3, val keypos = nskey4},
{val = self.action, keypos = 5}
reason = {order = 3, keypos = 4, val = protectionStatusObj:getReason()},
level = {order = 4, keypos = 2, val = protectionStatusObj:getLevel()},
action = {order = 5, keypos = 1, val = protectionStatusObj:getAction()}
}
 
--[[
-- The old protection templates used an ad-hoc protection category system,
-- Apply the category order configuration, if any. The configuration value
-- with some templates prioritising namespaces in their categories, and
-- will be a property string, e.g. 'reason', 'namespace', etc. The property
-- others prioritising the protection reason. To emulate this in this module
-- corresponding to that string is tested last (i.e. it is the most
-- we use the config table cfg.reasonsWithNamespacePriority to set the
-- important, because it keeps its specified value the longest) and the
-- reasons for which namespaces have priority over protection reason.
-- other properties are tested in the canonical order. If no configuration
-- If we are dealing with one of those reasons, move the namespace table to
-- value is specified then the canonical order is used.
-- the end of the order table, i.e. give it highest priority. If not, the
-- reason should have highest priority, so move that to the end of the table
-- instead.
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
local configOrder = {}
do
local bannerConfig = configObj:getBannerConfig(protectionStatusObj)
local categoryOrder = bannerConfig.categoryOrder
for propertiesKey, t in pairs(properties) do
configOrder[t.order] = t
end
if categoryOrder then
local property = properties[categoryOrder]
if not property then
local msg = '"'
.. categoryOrder
.. '" is not a valid value of cfg.reasons.'
.. reason
.. '.categoryOrder'
error(msg)
end
table.insert(configOrder, table.remove(configOrder, property.order))
end
end
--[[
-- Define the attempt order. PropertiesInactive subtables (subtables with nonil "value defined are moved"
-- fields) are moved to the end, where they will later be given the value "all". This iskey
-- "all". This is to cut down on the number of table lookups in the cats table, which
-- cfg.protectionCategories, which grows exponentially with the number of properties with valid values.
-- non-nil keys. We keep track of the number of active propertiessubtables with the noActive
-- noActive parameter.
--]]
local noActive, attemptOrder
do
local active, inactive = {}, {}
for i, t in ipairs(configOrderorder) do
if t.val then
active[#active + 1] = t
Line 517 ⟶ 267:
--[[
-- Check increasingly generic key combinations until we find a match. If a
-- If a specific category exists for the combination of propertieskey fragments we are
-- we are given, that match will be found first. If not, we keep trying different
-- tryingkey different keyfragment combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the propertykey subtables using a binary matrix
-- binary matrix with indexes i and j. j is only calculated up to the number of active
-- the number of active propertiessubtables. For example, if there were three active subtables, the matrix
-- active properties, the matrix would look like this, with 0 corresponding to the key fragment "all", and
-- 1 corresponding to theother string "all", and 1 corresponding tokey thefragments.
-- val field in the property table:
--
-- j 1 2 3
Line 541 ⟶ 290:
-- 8 0 0 0
--
-- Values of j higher than the number of active propertiessubtables are set
-- to the string "all".
--
-- A key for the category tablecfg.protectionCategories is constructed for each value of i.
-- The correct position of the value in the key is determined by the keypos field in
-- each subtable.
-- pos field in the property table.
--]]
local cats = configObj:getConfigTable('categories')cfg.protectionCategories
local cat
for i = 1, 2^noActive do
local key = {}
Line 565 ⟶ 313:
end
end
key = table.concat(key, '-|')
local attempt = cats[key]
if attempt then
cat =return makeCategoryLink(attempt, title.text)
break
end
end
return ''
if cat then
end
Category.setName(self, cat)
 
else
function Protection:isIncorrect()
error(
local expiry = self.expiry
'No category match found;'
return not self:shouldHaveProtectionCategory()
.. ' please define the category for key "all-all-all-all-all"'
or type(expiry) == 'number' and expiry < os.time()
end
 
function Protection:isTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
return self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end
 
function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local ret = {self:makeProtectionCategory()}
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)
end
 
--------------------------------------------------------------------------------
-- ExpiryCategoryBlurb class
--------------------------------------------------------------------------------
 
local Blurb = {}
local ExpiryCategory = Category:subclass('ExpiryCategory')
Blurb.__index = Blurb
 
Blurb.bannerTextFields = {
text = true,
explanation = true,
tooltip = true,
alt = true,
link = true
}
 
function Blurb.new(protectionObj, args, cfg)
return setmetatable({
_cfg = cfg,
_protectionObj = protectionObj,
_args = args
}, Blurb)
end
 
-- Private methods --
 
function Blurb:_formatDate(num)
-- Formats a Unix timestamp into dd Month, YYYY format.
lang = lang or mw.language.getContentLanguage()
local success, date = pcall(
lang.formatDate,
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
if success then
return date
end
end
 
function Blurb:_getExpandedMessage(msgKey)
return self:_substituteParameters(self._cfg.msg[msgKey])
end
 
function Blurb:_substituteParameters(msg)
if not self._params then
local parameterFuncs = {}
 
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter
parameterFuncs.EXPIRY = self._makeExpiryParameter
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter
parameterFuncs.IMAGELINK = self._makeImageLinkParameter
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter
parameterFuncs.PAGETYPE = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter
parameterFuncs.TALKPAGE = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL = self._makeVandalTemplateParameter
self._params = setmetatable({}, {
__index = function (t, k)
local param
if parameterFuncs[k] then
param = parameterFuncs[k](self)
end
param = param or ''
t[k] = param
return param
end
})
end
msg = msg:gsub('${(%u+)}', self._params)
return msg
end
 
function Blurb:_makeCurrentVersionParameter()
-- A link to the page history or the move log, depending on the kind of
-- protection.
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
-- We need the move log link.
return makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
self:_getExpandedMessage('current-version-move-display')
)
else
-- We need the history link.
return makeFullUrl(
pagename,
{action = 'history'},
self:_getExpandedMessage('current-version-edit-display')
)
end
end
 
function Blurb:_makeEditRequestParameter()
local mEditRequest = require('Module:Submit an edit request')
local action = self._protectionObj.action
local level = self._protectionObj.level
-- Get the edit request type.
local requestType
if action == 'edit' then
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
end
end
requestType = requestType or 'full'
-- Get the display value.
local display = self:_getExpandedMessage('edit-request-display')
 
return mEditRequest._link{type = requestType, display = display}
end
 
function Blurb:_makeExpiryParameter()
local expiry = self._protectionObj.expiry
if type(expiry) == 'number' then
return self:_formatDate(expiry)
else
return expiry
end
end
 
function Blurb:_makeExplanationBlurbParameter()
-- Cover special cases first.
if self._protectionObj.title.namespace == 8 then
-- MediaWiki namespace
return self:_getExpandedMessage('explanation-blurb-nounprotect')
end
 
-- Get explanation blurb table keys
local action = self._protectionObj.action
local level = self._protectionObj.level
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
 
-- Find the message in the explanation blurb table and substitute any
-- parameters.
local explanations = self._cfg.explanationBlurbs
local msg
if explanations[action][level] and explanations[action][level][talkKey] then
msg = explanations[action][level][talkKey]
elseif explanations[action][level] and explanations[action][level].default then
msg = explanations[action][level].default
elseif explanations[action].default and explanations[action].default[talkKey] then
msg = explanations[action].default[talkKey]
elseif explanations[action].default and explanations[action].default.default then
msg = explanations[action].default.default
else
error(string.format(
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeImageLinkParameter()
local imageLinks = self._cfg.imageLinks
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if imageLinks[action][level] then
msg = imageLinks[action][level]
elseif imageLinks[action].default then
msg = imageLinks[action].default
else
msg = imageLinks.edit.default
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-blurb-expiry')
else
return self:_getExpandedMessage('intro-blurb-noexpiry')
end
end
 
function Blurb:_makeIntroFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-fragment-expiry')
else
return self:_getExpandedMessage('intro-fragment-noexpiry')
end
end
 
function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end
 
function Blurb:_makeProtectionBlurbParameter()
local protectionBlurbs = self._cfg.protectionBlurbs
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionBlurbs[action][level] then
msg = protectionBlurbs[action][level]
elseif protectionBlurbs[action].default then
msg = protectionBlurbs[action].default
elseif protectionBlurbs.edit.default then
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeProtectionDateParameter()
local protectionDate = self._protectionObj.protectionDate
if type(protectionDate) == 'number' then
return self:_formatDate(protectionDate)
else
return protectionDate
end
end
 
function Blurb:_makeProtectionLevelParameter()
local protectionLevels = self._cfg.protectionLevels
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionLevels[action][level] then
msg = protectionLevels[action][level]
elseif protectionLevels[action].default then
msg = protectionLevels[action].default
elseif protectionLevels.edit.default then
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeProtectionLogParameter()
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'autoreview' then
-- We need the pending changes log.
return makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
self:_getExpandedMessage('pc-log-display')
)
else
-- We need the protection log.
return makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self:_getExpandedMessage('protection-log-display')
)
end
end
 
function Blurb:_makeTalkPageParameter()
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
self._protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
)
end
 
function Blurb:_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-blurb-expiry')
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
 
function Blurb:_makeVandalTemplateParameter()
return mw.getCurrentFrame():expandTemplate{
title="vandal-m",
args={self._args.user or self._protectionObj.title.baseText}
}
end
 
-- Public methods --
 
function Blurb:makeBannerText(key)
-- Validate input.
if not key or not Blurb.bannerTextFields[key] then
error(string.format(
'"%s" is not a valid banner config field',
tostring(key)
), 2)
end
 
-- Generate the text.
local msg = self._protectionObj.bannerConfig[key]
if type(msg) == 'string' then
return self:_substituteParameters(msg)
elseif type(msg) == 'function' then
msg = msg(self._protectionObj, self._args)
if type(msg) ~= 'string' then
error(string.format(
'bad output from banner config function with key "%s"'
.. ' (expected string, got %s)',
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
end
end
 
--------------------------------------------------------------------------------
-- ErrorCategoryBannerTemplate class
--------------------------------------------------------------------------------
 
local BannerTemplate = {}
local ErrorCategory = Category:subclass('ErrorCategory')
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate.new(protectionObj, cfg)
local obj = {}
obj._cfg = cfg
 
-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
obj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
-- generate it from the protection status and the namespace.
local action = protectionObj.action
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'
and not protectionObj:isTemporary()
then
-- Fully protected modules and templates get the special red "indef"
-- padlock.
obj._imageFilename = obj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = obj._cfg.images
if images[action] then
if images[action][level] then
obj._imageFilename = images[action][level]
elseif images[action].default then
obj._imageFilename = images[action].default
end
end
end
end
return setmetatable(obj, BannerTemplate)
end
 
function BannerTemplate:renderImage()
local filename = self._imageFilename
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return makeFileLink{
file = filename,
size = (self.imageWidth or 20) .. 'px',
alt = self._imageAlt,
link = self._imageLink,
caption = self.imageCaption
}
end
 
--------------------------------------------------------------------------------
-- ProtectionBannerBanner class
--------------------------------------------------------------------------------
 
local Banner = setmetatable({}, BannerTemplate)
local ProtectionBanner = {}
Banner.__index = Banner
 
function ProtectionBannerBanner.exportToWikinew(frameprotectionObj, titleblurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
local args = mArguments.getArgs(frame)
obj.imageWidth = 40
return ProtectionBanner.exportToLua(args, title)
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
obj._reasonText = blurbObj:makeBannerText('text')
obj._explanationText = blurbObj:makeBannerText('explanation')
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
return setmetatable(obj, Banner)
end
 
function ProtectionBanner.exportToLuaBanner:__tostring(args, title)
-- Renders the banner.
title = title or mw.title.getCurrentTitle()
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 = {
page = self._page,
type = 'protection',
image = self:renderImage(),
text = string.format(
"'''%s'''%s",
reasonText,
explanationText and '<br />' .. explanationText or ''
)
}
return makeMessageBox('mbox', mbargs)
end
 
--------------------------------------------------------------------------------
-- Get data objects
-- Padlock class
local theProtectionStatus = ProtectionStatus:new(args, title)
--------------------------------------------------------------------------------
local theConfig = Config:new()
 
local retPadlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock
 
function Padlock.new(protectionObj, blurbObj, cfg)
-- Render the banner
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
-- Render the categories
obj.imageCaption = blurbObj:makeBannerText('tooltip')
obj._imageAlt = blurbObj:makeBannerText('alt')
obj._imageLink = blurbObj:makeBannerText('link')
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
or cfg.padlockIndicatorNames.default
or 'pp-default'
return setmetatable(obj, Padlock)
end
 
function Padlock:__tostring()
return table.concat(ret)
local frame = mw.getCurrentFrame()
-- The nowiki tag helps prevent whitespace at the top of articles.
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
name = 'indicator',
args = {name = self._indicatorName},
content = self:renderImage()
}
end
 
--------------------------------------------------------------------------------
function ProtectionBanner._exportClasses()
-- Exports
-- This is used to export the classes for testing purposes.
--------------------------------------------------------------------------------
 
local p = {}
 
function p._exportClasses()
-- This is used for testing purposes.
return {
Protection = Protection,
ProtectionStatus = ProtectionStatus,
Config = Config,
Image = Image,
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
Category = Category,
ProtectionCategory = ProtectionCategory,
ErrorCategory = ErrorCategory,
ExpiryCategory = ExpiryCategory,
}
end
 
function p._main(args, cfg, title)
return ProtectionBanner
args = args or {}
cfg = cfg or require(CONFIG_MODULE)
 
local protectionObj = Protection.new(args, cfg, title)
 
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 not yesno(args.catonly) and (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:shouldShowLock() 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
ret[#ret + 1] = protectionObj:makeCategoryLinks()
end
return table.concat(ret)
end
 
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
local userArgs = getArgs(frame, {
parentOnly = defaultArgs,
frameOnly = not defaultArgs
})
 
-- 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
end
return p._main(args, cfg)
end
 
return p
Retrieved from "https://publictestwiki.com/wiki/Special:MobileDiff/12494...54139"