TEPwiki

Module:Protection banner: Difference between revisions

Module Discussion

Module:Protection banner (view source)

Revision as of 03:09, 16 November 2022

176 bytes removed ,  1 year ago
m
1 revision imported from wikipedia:Module:Protection_banner
(sort parameter methods into alphabetical order, and remove the ones that are no longer needed)
m (1 revision imported from wikipedia:Module:Protection_banner)
 
(126 intermediate revisions by 15 users not shown)
Line 3:
 
-- Initialise necessary modules.
require('Module:No globalsstrict')
local classmakeFileLink = require('Module:MiddleclassFile link').class_main
local mFileLinkeffectiveProtectionLevel = require('Module:FileEffective linkprotection level')._main
local mProtectionLeveleffectiveProtectionExpiry = require('Module:Effective protection levelexpiry')._main
local yesno = require('Module:Yesno')
 
-- Lazily initialise modules and objects we don't always need.
local mArgumentsgetArgs, mMessageBoxmakeMessageBox, lang
 
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'
 
--------------------------------------------------------------------------------
-- ConfigHelper classfunctions
--------------------------------------------------------------------------------
 
local Configfunction = classmakeCategoryLink('Config'cat, sort)
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 Config:initialize(data)
local function validateDate(dateString, dateType)
data = data or mw.loadData('Module:Protection banner/config')
if not lang then
self._cfg = data.cfg
lang = mw.language.getContentLanguage()
self._msg = data.msg
end
self._bannerConfigTables = {}
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
result = tonumber(result)
if result then
return result
end
end
error(string.format(
'invalid %s: %s',
dateType,
tostring(dateString)
), 4)
end
 
local function makeFullUrl(page, query, display)
function Config:getBannerConfig(protectionStatusObj)
return string.format(
if self._bannerConfigTables[protectionStatusObj] then
'[%s %s]',
return self._bannerConfigTables[protectionStatusObj]
tostring(mw.uri.fullUrl(page, query)),
display
)
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 getReachableNodes(graph, start)
local toWalk, retval = {[start] = true}, {}
while true do
-- Can't use pairs() since we're adding and removing things as we're iterating
local k = next(toWalk) -- This always gets the "first" key
if k == nil then
return retval
end
toWalk[k] = nil
retval[k] = true
for _,v in ipairs(graph[k]) do
if not retval[v] then
toWalk[v] = true
end
end
end
end
 
--------------------------------------------------------------------------------
-- Protection class
--------------------------------------------------------------------------------
 
local Protection = {}
Protection.__index = Protection
 
Protection.supportedActions = {
edit = true,
move = true,
autoreview = true,
upload = true
}
 
Protection.bannerConfigFields = {
'text',
'explanation',
'tooltip',
'alt',
'link',
'image'
}
 
function Protection.new(args, cfg, title)
local obj = {}
obj._cfg = cfg
obj.title = title or mw.title.getCurrentTitle()
 
-- Set action
if not args.action then
obj.action = 'edit'
elseif Protection.supportedActions[args.action] then
obj.action = args.action
else
error(string.format(
local ret = {}
'invalid action: %s',
local cfg = self._cfg
tostring(args.action)
local action = protectionStatusObj:getAction()
), 3)
local level = protectionStatusObj:getLevel()
end
local reason = protectionStatusObj:getReason()
 
local fields = {
-- Set level
'text',
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
'explanation',
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
'tooltip',
-- Users need to be autoconfirmed to move pages anyway, so treat
'alt',
-- semi-move-protected pages as unprotected.
'image'
obj.level = '*'
}
end
 
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if effectiveExpiry == 'infinity' then
obj.expiry = 'indef'
elseif effectiveExpiry ~= 'unknown' then
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
end
 
-- Set reason
if args[1] then
obj.reason = mw.ustring.lower(args[1])
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
end
end
 
-- Set protection date
if args.date then
obj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
obj.bannerConfig = {}
local configTables = {}
if cfg.banners[obj.action] then
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
end
if cfg.defaultBanners[obj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(fieldsProtection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
retobj.bannerConfig[field] = t[field]
break
end
end
end
self._bannerConfigTables[protectionStatusObj] = ret
return ret
end
return setmetatable(obj, Protection)
end
 
function ConfigProtection:getConfigTableisUserScript(key)
-- Whether the page is a user JavaScript or CSS page.
local blacklist = {
local title = self.title
banners = true,
return title.namespace == 2 and (
defaultBanners = true,
title.contentModel == 'javascript' or title.contentModel == 'css'
masterBanner = true
})
if not blacklist[key] then
return self._cfg[key]
else
return nil
end
end
 
function ConfigProtection:getMessageisProtected(key)
return self._msg[key]level ~= '*'
end
 
function Protection:shouldShowLock()
--------------------------------------------------------------------------------
-- Whether we should output a banner/padlock
-- ProtectionStatus class
return self:isProtected() and not self:isUserScript()
--------------------------------------------------------------------------------
end
 
-- Whether this page needs a protection category.
local ProtectionStatus = class('ProtectionStatus')
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock
 
function Protection:isTemporary()
function ProtectionStatus:initialize(args, configObj, titleObj)
return type(self.expiry) == 'number'
-- Set action
end
do
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
 
function Protection:makeProtectionCategory()
-- Set level
if not self:shouldHaveProtectionCategory() then
do
return ''
local level = mProtectionLevel._main(self._action, titleObj)
if level == 'accountcreator' then
-- Lump titleblacklisted pages in with template-protected pages,
-- since templateeditors can do both.
level = 'templateeditor'
end
if self._action == 'move' and level == 'autoconfirmed' then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
level = '*'
end
self._level = level or '*'
end
 
local cfg = self._cfg
-- Validation function for the expiry and the protection date
local title = self.title
local function validateDate(date, dateType)
lang = lang or mw.language.getContentLanguage()
-- Get the expiry key fragment.
local success, expiry = pcall(lang.formatDate, lang, 'U', args.expiry)
local expiryFragment
expiry = tonumber(expiry)
if successself.expiry and== expiry'indef' then
returnexpiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
else
expiryFragment = 'temp'
return string.format(
'<strong class="error">Error: invalid %s ("%s")</strong>',
dateType,
tostring(args.expiry)
)
end
end
 
-- Get the namespace key fragment.
-- Set expiry
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
if args.expiry then
if not namespaceFragment and title.namespace % 2 == 1 then
local indefStrings = configObj:getConfigTable('indefStrings')
namespaceFragment = 'talk'
if 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
 
-- Define the order that key fragments are tested in. This is done with an
-- Set reason
-- array of tables containing the value to be tested, along with its
-- position in the cfg.protectionCategories table.
local order = {
{val = expiryFragment, keypos = 1},
{val = namespaceFragment, keypos = 2},
{val = self.reason, keypos = 3},
{val = self.level, keypos = 4},
{val = self.action, keypos = 5}
}
 
--[[
-- The old protection templates used an ad-hoc protection category system,
-- with some templates prioritising namespaces in their categories, and
-- others prioritising the protection reason. To emulate this in this module
-- we use the config table cfg.reasonsWithNamespacePriority to set the
-- reasons for which namespaces have priority over protection reason.
-- If we are dealing with one of those reasons, move the namespace table to
-- 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))
--[[
-- Define the attempt order. Inactive subtables (subtables with nil "value"
-- fields) are moved to the end, where they will later be given the key
-- "all". This is to cut down on the number of table lookups in
-- cfg.protectionCategories, which grows exponentially with the number of
-- non-nil keys. We keep track of the number of active subtables with the
-- noActive parameter.
--]]
local noActive, attemptOrder
do
local reasonactive, =inactive args.reason= or{}, args[1]{}
for i, t in ipairs(order) do
if reason then
if t.val then
self._reason = reason:lower()
active[#active + 1] = t
else
inactive[#inactive + 1] = t
end
end
noActive = #active
attemptOrder = active
for i, t in ipairs(inactive) do
attemptOrder[#attemptOrder + 1] = t
end
end
 
--[[
-- Set protection date
-- Check increasingly generic key combinations until we find a match. If a
self._protectionDate = validateDate(args.date, 'protection date')
-- specific category exists for the combination of key fragments we are
-- given, that match will be found first. If not, we keep trying different
-- key fragment combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the key subtables using a binary matrix
-- with indexes i and j. j is only calculated up to the number of active
-- subtables. For example, if there were three active subtables, the matrix
-- would look like this, with 0 corresponding to the key fragment "all", and
-- 1 corresponding to other key fragments.
--
-- j 1 2 3
-- i
-- 1 1 1 1
-- 2 0 1 1
-- 3 1 0 1
-- 4 0 0 1
-- 5 1 1 0
-- 6 0 1 0
-- 7 1 0 0
-- 8 0 0 0
--
-- Values of j higher than the number of active subtables are set
-- to the string "all".
--
-- A key for cfg.protectionCategories is constructed for each value of i.
-- The position of the value in the key is determined by the keypos field in
-- each subtable.
--]]
local cats = cfg.protectionCategories
for i = 1, 2^noActive do
local key = {}
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.keypos] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.keypos] = t.val
else
key[t.keypos] = 'all'
end
end
end
key = table.concat(key, '|')
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
return ''
end
 
function ProtectionStatusProtection:getActionisIncorrect()
returnlocal expiry = self._actionexpiry
return not self:shouldHaveProtectionCategory()
or type(expiry) == 'number' and expiry < os.time()
end
 
function ProtectionStatusProtection:getLevelisTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
return self._level
return self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end
 
function ProtectionStatusProtection:getReasonmakeCategoryLinks()
returnlocal msg = self._reason_cfg.msg
local ret = {self:makeProtectionCategory()}
end
if self:isIncorrect() then
 
ret[#ret + 1] = makeCategoryLink(
function ProtectionStatus:getExpiry()
msg['tracking-category-incorrect'],
return self._expiry
self.title.text
end
)
 
end
function ProtectionStatus:getProtectionDate()
if self:isTemplateProtectedNonTemplate() then
return self._protectionDate
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-template'],
self.title.text
)
end
return table.concat(ret)
end
 
Line 182 ⟶ 359:
--------------------------------------------------------------------------------
 
local Blurb = class('Blurb'){}
Blurb.__index = Blurb
 
Blurb.bannerTextFields = {
function Blurb:initialize(configObj, protectionStatusObj, titleObj)
text = true,
self._configObj = configObj
explanation = true,
self._protectionStatusObj = protectionStatusObj
tooltip = true,
self._bannerConfig = configObj:getBannerConfig(protectionStatusObj)
alt = true,
self._titleObj = titleObj
link = true
end
}
 
function Blurb.new(protectionObj, args, cfg)
-- Static methods --
return setmetatable({
 
_cfg = cfg,
function Blurb.makeFullUrl(page, query, display)
_protectionObj = protectionObj,
local url = mw.uri.fullUrl(page, query)
_args = args
url = tostring(url)
}, Blurb)
return string.format('[%s %s]', url, display)
end
 
-- Private methods --
function Blurb.formatDate(num)
 
function Blurb:_formatDate(num)
-- Formats a Unix timestamp into dd Month, YYYY format.
lang = lang or mw.language.getContentLanguage()
Line 205 ⟶ 386:
lang.formatDate,
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
Line 213 ⟶ 394:
end
 
function Blurb:_getExpandedMessage(msgKey)
-- Private methods --
return self:_substituteParameters(self._cfg.msg[msgKey])
end
 
function Blurb:_substituteParameters(msg)
if not self._params then
local params, parameterFuncs = {}, {}
setmetatable(params, {
__index = function (t, k)
local param
if parameterFuncs[k] then
param = parameterFuncs[k](self)
end
param = param or ''
params[k] = param
return param
end
})
 
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter
parameterFuncs.DELETIONDISCUSSION = self._makeDeletionDiscussionParameter
parameterFuncs.DISPUTESECTION = self._makeDisputeSectionParameter
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 = paramssetmetatable({}, {
__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
Line 254 ⟶ 439:
-- A link to the page history or the move log, depending on the kind of
-- protection.
local actionpagename = self._protectionStatusObj:getAction()_protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
local pagename = self._titleObj.prefixedText
if action == 'move' then
-- We need the move log link.
return self.makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
self._configObj:getMessage_getExpandedMessage('disputecurrent-moveversion-linkmove-display')
)
else
-- We need the history link.
return self.makeFullUrl(
pagename,
{action = 'history'},
self._configObj:getMessage_getExpandedMessage('disputecurrent-editversion-linkedit-display')
)
end
end
 
function Blurb:_makeDeletionDiscussionLinkParameter()
local deletionDiscussionPage = self._deletionDiscussionPage
if deletionDiscussionPage then
local display = self._configObj:getMessage('deletion-discussion-link-display')
return string.format('[[%s|%s]]', deletionDiscussionPage, display)
end
end
 
function Blurb:_makeDisputeSectionParameter()
-- "disputes", with or without a section link
local section = self._section
local disputes = self.configObj:getMessage('dispute-section-link-display')
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
Line 300 ⟶ 459:
function Blurb:_makeEditRequestParameter()
local mEditRequest = require('Module:Submit an edit request')
local action = self._protectionStatusObj:getAction()_protectionObj.action
local level = self._protectionStatusObj:getLevel()_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._configObj:getMessage(key)
-- Get the edit request type.
Line 317 ⟶ 467:
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
Line 323 ⟶ 475:
requestType = requestType or 'full'
-- Get the display value.
return mEditRequest.exportLinkToLua{type = requestType, display = display}
local display = self:_getExpandedMessage('edit-request-display')
 
return mEditRequest._link{type = requestType, display = display}
end
 
function Blurb:_makeExpiryParameter()
local expiry = self._protectionStatusObj:getExpiry()_protectionObj.expiry
if type(expiry) == 'indefnumber' then
return nilself:_formatDate(expiry)
else
elseif type(expiry) == 'number' then
local formatted = Blurb.formatDate(expiry)
return ' until ' .. formatted
elseif expiry then
-- Expiry is an error string.
return expiry
end
Line 340 ⟶ 491:
 
function Blurb:_makeExplanationBlurbParameter()
-- Cover special cases first.
local action = self._protectionStatusObj:getAction()
if self._protectionObj.title.namespace == 8 then
local level = self._protectionStatusObj:getLevel()
-- MediaWiki namespace
local key
return self:_getExpandedMessage('explanation-blurb-nounprotect')
if action == 'edit' and level == 'autoconfirmed' then
end
key = 'explanation-text-semi'
 
elseif action == 'move' then
key -- =Get 'explanation-text-move' blurb table keys
elseiflocal action == 'create' thenself._protectionObj.action
local level = self._protectionObj.level
key = 'explanation-text-create'
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(
key = 'explanation-text-default'
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
local msg = self._configObj:getMessage(key)
return self:_substituteParameters(msg)
end
 
function Blurb:_makeIntroBlurbParameter_makeImageLinkParameter()
local imageLinks = self._cfg.imageLinks
local key
local action = self._protectionStatusObj:getAction()_protectionObj.action
local level = self._protectionStatusObj:getLevel()_protectionObj.level
local msg
if action == 'edit' and level == 'autoconfirmed' then
if imageLinks[action][level] then
key = 'reason-text-semi'
msg = imageLinks[action][level]
elseif action == 'move' then
elseif imageLinks[action].default then
key = 'reason-text-move'
msg = imageLinks[action].default
elseif action == 'create' then
key = 'reason-text-create'
else
keymsg = 'reason-text-imageLinks.edit.default'
end
local msg = self._configObj:getMessage(key)
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._configObj:getConfigTable('bannerPagetypes')_cfg.pagetypes
local namespace =return pagetypes[self._titleObj_protectionObj.title.namespace]
return pagetypes[namespace] or pagetypes.default or 'page'
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._protectionStatusObj:getProtectionDate()_protectionObj.protectionDate
if type(protectionDate) == 'number' then
return Blurb.formatDateself:_formatDate(protectionDate)
else
return protectionDate
Line 389 ⟶ 590:
 
function Blurb:_makeProtectionLevelParameter()
local actionprotectionLevels = self._protectionStatusObj:getAction()_cfg.protectionLevels
local levelaction = self._protectionStatusObj:getLevel()_protectionObj.action
local level = self._protectionObj.level
local key
local msg
if action == 'edit' then
if protectionLevels[action][level == 'sysop'] then
keymsg = 'protection-protectionLevels[action][level-full']
elseif level == 'templateeditor'protectionLevels[action].default then
msg = protectionLevels[action].default
key = 'protection-level-template'
elseif level == 'autoconfirmed'protectionLevels.edit.default then
msg = protectionLevels.edit.default
key = 'protection-level-semi'
end
elseif action == 'move' then
key = 'protection-level-move'
elseif action == 'create' then
key = 'protection-level-create'
else
key = error('no protection- level- defined for protectionLevels.edit.default', 8)
end
return self._configObj:getMessage_substituteParameters(keymsg)
end
 
function Blurb:_makeProtectionLogParameter()
local actionpagename = self._protectionStatusObj:getAction()_protectionObj.title.prefixedText
if self._protectionObj.action == 'autoreview' then
local pagename = self._titleObj.prefixedText
if action == 'autoreview' then
-- We need the pending changes log.
return self.makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
self._configObj:getMessage_getExpandedMessage('more-details-pc-log-display')
)
else
-- We need the protection log.
return self.makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self._configObj:getMessage_getExpandedMessage('more-details-protection-log-display')
)
end
Line 431 ⟶ 626:
 
function Blurb:_makeTalkPageParameter()
return string.format(
local section = self._section
local display = self._configObj:getMessage('talk-page-link-display')
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._titleObj_protectionObj.title.namespace].talk.name,
self._titleObj_protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
display
)
end
 
function Blurb:_makeVandalTemplateParameter_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() then
local mVandalM = require('Module:Vandal-m')
return self:_getExpandedMessage('tooltip-blurb-expiry')
local username = self._username
else
username = username or self._titleObj.baseText
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
return mVandalM.luaMain{username}
end
end
 
function Blurb:_makeTooltipFragmentParameter()
-- Public methods --
if self._protectionObj:isTemporary() then
 
return self:_getExpandedMessage('tooltip-fragment-expiry')
function Blurb:setDeletionDiscussionPage(page)
else
self._deletionDiscussionPage = page
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
end
end
 
function Blurb:setUsername_makeVandalTemplateParameter(username)
return mw.getCurrentFrame():expandTemplate{
self._username = username
title="vandal-m",
args={self._args.user or self._protectionObj.title.baseText}
}
end
 
-- Public methods --
function Blurb:setSection(section)
self._section = section
end
 
function Blurb:makeReasonTextmakeBannerText(key)
-- Validate input.
local msg = self._bannerConfig.text
if not key or not Blurb.bannerTextFields[key] then
return self:_substituteParameters(msg)
error(string.format(
end
'"%s" is not a valid banner config field',
tostring(key)
), 2)
end
 
-- Generate the text.
function Blurb:makeExplanationText()
local msg = self._bannerConfig_protectionObj.explanationbannerConfig[key]
if type(msg) == 'string' then
return self:_substituteParameters(msg)
return self:_substituteParameters(msg)
end
elseif type(msg) == 'function' then
 
msg = msg(self._protectionObj, self._args)
function Blurb:makeTooltipText()
if type(msg) ~= 'string' then
local msg = self._bannerConfig.tooltip
error(string.format(
return self:_substituteParameters(msg)
'bad output from banner config function with key "%s"'
end
.. ' (expected string, got %s)',
 
tostring(key),
function Blurb:makeAltText()
type(msg)
local msg = self._bannerConfig.alt
), 4)
return self:_substituteParameters(msg)
end
return self:_substituteParameters(msg)
 
end
function Blurb:makeLinkText()
local msg = self._bannerConfig.link
return self:_substituteParameters(msg)
end
 
Line 492 ⟶ 691:
--------------------------------------------------------------------------------
 
local BannerTemplate = class('BannerTemplate'){}
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate:initialize.new(configObjprotectionObj, cfg)
local obj = {}
self._configObj = configObj
obj._cfg = cfg
end
 
-- Set the image filename.
function BannerTemplate:setImageFilename(filename, action, level, namespace, expiry)
local imageFilename = protectionObj.bannerConfig.image
if filename then
if imageFilename then
self._imageFilename = filename
obj._imageFilename = imageFilename
return nil
else
end
-- If an image filename isn't specified explicitly in the banner config,
-- generate it from the protection status and the namespace.
if not action or not level then
local action = protectionObj.action
-- If the filename is not specified, we need the action and the level
local level = protectionObj.level
-- to find the image name. The namespace and the expiry are optional,
local namespace = protectionObj.title.namespace
-- however.
local reason = protectionObj.reason
return nil
end
-- Deal with special cases first.
 
if (
-- Deal with special cases first.
namespace == 10
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check?
and or actionnamespace == 'edit'828
or reason and obj._cfg.indefImageReasons[reason]
and level == 'sysop'
)
and not expiry
and action == 'edit'
then
and level == 'sysop'
-- Fully protected modules and templates get the special red "indef"
and not protectionObj:isTemporary()
-- padlock.
then
self._imageFilename = self._configObj:getMessage('image-filename-indef')
-- Fully protected modules and templates get the special red "indef"
return nil
-- padlock.
end
obj._imageFilename = obj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
-- Deal with regular protection types.
local images = self._configObj:getConfigTable('images')
local images = obj._cfg.images
if images[action] then
if images[action][level] then
self._imageFilename = if images[action][level] then
obj._imageFilename = images[action][level]
return nil
elseif images[action].default then
self obj._imageFilename = images[action].default
return nil end
end
end
end
return setmetatable(obj, BannerTemplate)
 
return nil
end
 
function BannerTemplate:setImageWidth(width)
self._imageWidth = width
end
 
function BannerTemplate:setImageTooltip(tooltip)
self._imageCaption = tooltip
end
 
function BannerTemplate:renderImage()
local filename = self._imageFilename
or self._configObj:getMessage(_cfg.msg['image-filename-default')]
or 'Transparent.gif'
return mFileLink.new(filename)makeFileLink{
file = filename,
:width(self._imageWidth or 20)
:altsize = (self._imageAltimageWidth or 20) .. 'px',
:link(alt = self._imageLink)_imageAlt,
:caption(link = self._imageCaption)_imageLink,
caption = self.imageCaption
:render()
}
end
 
function BannerTemplate:render()
-- Dummy method, to be implemented by the subclasses.
return ''
end
 
Line 567 ⟶ 755:
--------------------------------------------------------------------------------
 
local Banner = BannerTemplate:subclasssetmetatable('Banner'{}, BannerTemplate)
Banner.__index = Banner
 
function Banner:initialize(configObj)
BannerTemplate.initialize(self, configObj)
self:setImageWidth(40)
end
 
function Banner:setReasonText(s)
self._reasonText = s
end
 
function Banner:setExplanationText.new(sprotectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
self._explanationText = s
obj.imageWidth = 40
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 Banner:render__tostring(page)
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
-- The page parameter specifies the page to generate the banner for, for
local reasonText = self._reasonText or error('no reason text set', 2)
-- testing purposes.
mMessageBox = mMessageBox or require('Module:Message box')
local reasonText = self._reasonText or error('no reason text set')
local explanationText = self._explanationText
local mbargs = {
page = pageself._page,
type = 'protection',
image = self:renderImage(),
Line 599 ⟶ 783:
)
}
return mMessageBox.mainmakeMessageBox('mbox', mbargs)
end
 
Line 606 ⟶ 790:
--------------------------------------------------------------------------------
 
local Padlock = BannerTemplate:subclasssetmetatable('Padlock'{}, BannerTemplate)
Padlock.__index = Padlock
 
function Padlock:initialize.new(configObjprotectionObj, blurbObj, cfg)
local obj = BannerTemplate.initializenew(selfprotectionObj, configObjcfg) -- This doesn't need the blurb.
obj.imageWidth = 20
self:setImageWidth(20)
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:setImageAlt__tostring(alt)
local frame = mw.getCurrentFrame()
self._imageAlt = alt
-- The nowiki tag helps prevent whitespace at the top of articles.
end
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
 
name = 'indicator',
function Padlock:setImageLink(link)
args = {name = self._indicatorName},
self._imageLink = link
content = self:renderImage()
end
}
 
function Padlock:setRight(px)
self._right = px
end
 
function Padlock:render()
local root = mw.html.create('div')
root
:addClass('metadata topicon nopopups')
:attr('id', 'protected-icon')
:css{display = 'none', right = self._right or '55px'}
:wikitext(self:renderImage())
return tostring(root)
end
 
--------------------------------------------------------------------------------
-- Exports
-- Category class
--------------------------------------------------------------------------------
 
local Categoryp = class('Category'){}
 
function p._exportClasses()
function Category:initialize(configObj, protectionStatusObj, titleObj)
-- This is used for testing purposes.
self._configObj = configObj
return {
self._protectionStatusObj = protectionStatusObj
Protection = Protection,
self._titleObj = titleObj
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
}
end
 
function Category:setNamep._main(nameargs, cfg, title)
args = args or {}
self._name = name
cfg = cfg or require(CONFIG_MODULE)
end
 
local protectionObj = Protection.new(args, cfg, title)
function Category:render()
if self._name then
return string.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
self._name
)
end
end
 
local ret = {}
--------------------------------------------------------------------------------
-- ProtectionCategory class
--------------------------------------------------------------------------------
 
-- If a page's edit protection is equally or more restrictive than its
local ProtectionCategory = Category:subclass('ProtectionCategory')
-- protection from some other action, then don't bother displaying anything
 
-- for the other action (except categories).
function ProtectionCategory:initialize(configObj, protectionStatusObj, titleObj)
if not yesno(args.catonly) and (protectionObj.action == 'edit' or
Category.initialize(self, configObj, protectionStatusObj)
args.demolevel or
self._titleObj = titleObj
not getReachableNodes(
end
cfg.hierarchy,
 
protectionObj.level
function ProtectionCategory:render()
)[effectiveProtectionLevel('edit', protectionObj.title)])
local configObj = self._configObj
then
local protectionStatusObj = self._protectionStatusObj
-- Initialise the blurb object
local titleObj = self._titleObj
local blurbObj = Blurb.new(protectionObj, args, cfg)
-- Render the banner
-- Get the namespace category key from the namespace number.
if protectionObj:shouldShowLock() then
local nskey
ret[#ret + 1] = tostring(
do
(yesno(args.small) and Padlock or Banner)
local namespace = titleObj.namespace
.new(protectionObj, blurbObj, cfg)
local categoryNamespaces = configObj:getConfigTable('categoryNamespaces')
)
nskey = categoryNamespaces[namespace]
if not nskey and namespace % 2 == 1 then
nskey = 'talk'
end
end
 
-- Render the categories
--[[
if yesno(args.category) ~= false then
-- Define the properties table. Each property is a table containing the
ret[#ret + 1] = protectionObj:makeCategoryLinks()
-- canonical order that the property is tested in, the position the
-- property has in the category key strings, and the property value itself.
--]]
local properties = {
expiry = {order = 1, val = protectionStatusObj:getExpiry()},
namespace = {order = 2, val = nskey},
reason = {order = 3, val = protectionStatusObj:getReason()},
level = {order = 4, val = protectionStatusObj:getLevel()},
action = {order = 5, val = protectionStatusObj:getAction()}
}
--[[
-- Apply the category order configuration, if any. The configuration value
-- will be a property string, e.g. 'reason', 'namespace', etc. The property
-- corresponding to that string is tested last (i.e. it is the most
-- important, because it keeps its specified value the longest) and the
-- other properties are tested in the canonical order. If no configuration
-- value is specified then the canonical order is used.
--]]
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. Properties with no value defined are moved
-- to the end, where they will later be given the value "all". This is
-- to cut down on the number of table lookups in the cats table, which
-- grows exponentially with the number of properties with valid values.
-- We keep track of the number of active properties with the noActive
-- parameter.
--]]
local noActive, attemptOrder
do
local active, inactive = {}, {}
for i, t in ipairs(configOrder) do
if t.val then
active[#active + 1] = t
else
inactive[#inactive + 1] = t
end
end
noActive = #active
attemptOrder = active
for i, t in ipairs(inactive) do
attemptOrder[#attemptOrder + 1] = t
end
end
--[[
-- Check increasingly generic key combinations until we find a match.
-- If a specific category exists for the combination of properties
-- we are given, that match will be found first. If not, we keep
-- trying different key combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the property subtables using a
-- binary matrix with indexes i and j. j is only calculated up to
-- the number of active properties. For example, if there were three
-- active properties, the matrix would look like this, with 0
-- corresponding to the string "all", and 1 corresponding to the
-- val field in the property table:
--
-- j 1 2 3
-- i
-- 1 1 1 1
-- 2 0 1 1
-- 3 1 0 1
-- 4 0 0 1
-- 5 1 1 0
-- 6 0 1 0
-- 7 1 0 0
-- 8 0 0 0
--
-- Values of j higher than the number of active properties are set
-- to the string "all".
--
-- A key for the category table is constructed for each value of i.
-- The correct position of the value in the key is determined by the
-- pos field in the property table.
--]]
local cats = configObj:getConfigTable('categories')
local cat
for i = 1, 2^noActive do
local key = {}
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.order] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.order] = t.val
else
key[t.order] = 'all'
end
end
end
key = table.concat(key, '-')
local attempt = cats[key]
if attempt then
cat = attempt
break
end
end
if cat then
Category.setName(self, cat)
return Category.export(self)
else
error(
'No category match found;'
.. ' please define the category for key "all-all-all-all-all"'
)
end
end
 
--------------------------------------------------------------------------------
-- ExpiryCategory class
--------------------------------------------------------------------------------
 
local ExpiryCategory = Category:subclass('ExpiryCategory')
 
function ExpiryCategory:render()
local configObj = self._configObj
local protectionStatusObj = self._protectionStatusObj
end
 
--------------------------------------------------------------------------------
-- ErrorCategory class
--------------------------------------------------------------------------------
 
local ErrorCategory = Category:subclass('ErrorCategory')
 
function ErrorCategory:render()
local configObj = self._configObj
local protectionStatusObj = self._protectionStatusObj
return table.concat(ret)
local expiry = protectionStatusObj:getExpiry()
local action = protectionStatusObj:getAction()
local level = protectionStatusObj:getLevel()
 
if level == '*'
or action == 'move' and level == 'autoconfirmed'
or type(expiry) == 'number' and expiry < os.time()
then
Category.setName(self, configObj:getMessage('tracking-category-incorrect'))
return Category.export(self)
end
end
 
function p.main(frame, cfg)
--------------------------------------------------------------------------------
cfg = cfg or require(CONFIG_MODULE)
-- ProtectionBanner class
--------------------------------------------------------------------------------
 
-- Find default args, if any.
local ProtectionBanner = {}
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
function ProtectionBanner.exportToWiki(frame, titleObj)
-- wrapper template.
mArguments = mArguments or require('Module:Arguments')
getArgs = getArgs or require('Module:Arguments').getArgs
local args = mArguments.getArgs(frame)
local userArgs = getArgs(frame, {
return ProtectionBanner.exportToLua(args, titleObj)
parentOnly = defaultArgs,
end
frameOnly = not defaultArgs
})
 
-- Build the args table. User-specified args overwrite default args.
function ProtectionBanner.exportToLua(args, titleObj)
local args = {}
titleObj = titleObj or mw.title.getCurrentTitle()
for k, v in pairs(defaultArgs or {}) do
 
args[k] = v
-- Get data objects
local configObj = Config:new()
local protectionObj = ProtectionStatus:new(args, configObj, titleObj)
 
-- Initialise the blurb object
local blurbObj = Blurb:new(configObj, protectionObj, titleObj)
blurbObj:setDeletionDiscussionPage(args.xfd)
blurbObj:setUsername(args.user)
blurbObj:setSection(args.section)
 
local ret = {}
 
-- Render the banner
do
-- Get the banner object
local isPadlock = yesno(args.small)
local bannerObj
if isPadlock then
bannerObj = Padlock:new(configObj)
else
bannerObj = Banner:new(configObj)
end
 
-- Set the image fields
local bannerConfig = configObj:getBannerConfig(protectionObj)
local imageFilename = bannerConfig.image
bannerObj:setImageFilename(
imageFilename,
protectionObj:getAction(),
protectionObj:getLevel(),
titleObj.namespace,
protectionObj:getExpiry()
)
if isPadlock then
bannerObj:setImageTooltip(blurbObj:makeTooltipText())
bannerObj:setImageAlt(blurbObj:makeAltText())
bannerObj:setImageLink(blurbObj:makeLinkText())
else
-- Large banners use the alt text for the tooltip.
bannerObj:setImageTooltip(blurbObj:makeAltText())
end
 
-- Set the text fields
if not isPadlock then
bannerObj:setReasonText(blurbObj:makeReasonText())
bannerObj:setExplanationText(blurbObj:makeExplanationText())
end
 
ret[#ret + 1] = bannerObj:render()
end
for k, v in pairs(userArgs) do
args[k] = v
-- Render the categories
end
return tablep.concat_main(retargs, cfg)
end
 
function ProtectionBanner._exportClasses()
-- This is used to export the classes for testing purposes.
return {
ProtectionStatus = ProtectionStatus,
Config = Config,
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
Category = Category,
ProtectionCategory = ProtectionCategory,
ErrorCategory = ErrorCategory,
ExpiryCategory = ExpiryCategory,
}
end
 
return ProtectionBannerp
TheInferiorDyl
verified
2,508

edits

Retrieved from "https://tep.wiki/wiki/Special:MobileDiff/46945...61976"