TEPwiki

Module:Protection banner: Difference between revisions

Module Discussion

Module:Protection banner (view source)

Revision as of 03:09, 16 November 2022

18 bytes added ,  1 year ago
m
1 revision imported from wikipedia:Module:Protection_banner
(condense _main and switch Blurb arg order)
m (1 revision imported from wikipedia:Module:Protection_banner)
 
(95 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 newFileLink = require('Module:File link').new
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')
 
-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang
 
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'
 
--------------------------------------------------------------------------------
Line 16 ⟶ 19:
--------------------------------------------------------------------------------
 
local function makeCategoryLink(cat, sort)
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat,
sort
)
else
return ''
end
end
Line 30 ⟶ 32:
-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
if not lang then
lang = lang or mw.language.getContentLanguage()
lang = mw.language.getContentLanguage()
end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
Line 39 ⟶ 43:
end
error(string.format(
'invalid %s: ("%s")',
dateType,
tostring(dateString)
), 4)
end
 
local function makeFullUrl(page, query, display)
return string.format(
'[%s %s]',
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
 
Line 49 ⟶ 82:
--------------------------------------------------------------------------------
 
local Protection = class('Protection'){}
Protection.__index = Protection
 
Protection.supportedActions = {
create = true,
edit = true,
move = true,
autoreview = true,
upload = true
}
 
Line 67 ⟶ 101:
}
 
function Protection:initialize.new(args, cfg, title)
self._cfglocal obj = cfg{}
obj._cfg = cfg
if args.title then
self obj.title = title or mw.title.newgetCurrentTitle(args.title)
if not self.title then
error('Invalid title "' .. args.title .. '"', 2)
end
else
self.title = mw.title.getCurrentTitle()
end
 
-- Set action
if not args.action then
do
if not argsobj.action then= 'edit'
elseif Protection.supportedActions[args.action] then
self.action = 'edit'
elseif selfobj.supportedActions[action = args.action] then
else
self.action = args.action
error(string.format(
else
error('Unsupportedinvalid action: %s' .. args.action, 2)
tostring(args.action)
end
), 3)
end
 
-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
do
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
self.level = effectiveProtectionLevel(self.action, self.title)
-- Users need to be autoconfirmed to move pages anyway, so treat
if self.level == 'accountcreator' then
-- semi-move-protected pages as unprotected.
-- Lump titleblacklisted pages in with template-protected pages,
obj.level = '*'
-- 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
-- semi-move-protected pages as unprotected.
self.level = '*'
end
end
 
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if args.expiry then
if cfg.indefStrings[args.expiry]effectiveExpiry == 'infinity' then
selfobj.expiry = 'indef'
elseif type(args.expiry)effectiveExpiry =~= 'numberunknown' then
selfobj.expiry = args.validateDate(effectiveExpiry, 'expiry date')
else
self.expiry = validateDate(args.expiry, 'expiry date')
end
end
 
-- Set reason
if args[1] then
do
local obj.reason = argsmw.reason or ustring.lower(args[1])
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
self.reason = reason:lower()
end
end
 
-- Set protection date
if args.date then
self.protectionDate = validateDate(args.date, 'protection date')
obj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
selfobj.bannerConfig = {}
local configTables = {}
if cfg.banners[selfobj.action] then
configTables[#configTables + 1] = cfg.banners[selfobj.action][selfobj.reason]
end
if cfg.defaultBanners[selfobj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action][selfobj.level]
configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(selfProtection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
selfobj.bannerConfig[field] = t[field]
break
end
Line 146 ⟶ 168:
end
end
return setmetatable(obj, Protection)
end
 
function Protection:isUserScript()
-- Whether the page is a user JavaScript or CSS page.
local title = self.title
return title.namespace == 2 and (
title.contentModel == 'javascript' or title.contentModel == 'css'
)
end
 
function Protection:isProtected()
return self.level ~= '*'
end
 
function Protection:shouldShowLock()
-- Whether we should output a banner/padlock
return self:isProtected() and not self:isUserScript()
end
 
-- Whether this page needs a protection category.
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock
 
function Protection:isTemporary()
return type(self.expiry) == 'number'
end
 
function Protection:makeProtectionCategory()
if not self:shouldHaveProtectionCategory() then
return ''
end
 
local cfg = self._cfg
local title = self.title
-- Exit ifGet the page isexpiry notkey protectedfragment.
local expiryFragment
if not self:isProtected() then
if self.expiry == 'indef' then
return ''
expiryFragment = self.expiry
end
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
-- Get the expiry.
local expiry = self.expiry
if type(expiry) == 'number' then
expiry = 'temp'
elseif expiry ~= 'indef' then
expiry = nil
end
 
-- Get the namespace category key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
local nskey
if not namespaceFragment and title.namespace % 2 == 1 then
do
namespaceFragment = 'talk'
local namespace = title.namespace
local categoryNamespaces = cfg.categoryNamespaceKeys
nskey = categoryNamespaces[namespace]
if not nskey and namespace % 2 == 1 then
nskey = 'talk'
end
end
 
-- Define the order that key fragments are tested in. This is done with an
-- Get the other inputs.
-- array of tables containing the value to be tested, along with its
local reason = self.reason
-- position in the cfg.protectionCategories table.
local action = self.action
local levelorder = self.level{
{val = expiryFragment, keypos = 1},
{val = namespaceFragment, keypos = 2},
--[[
{val = self.reason, keypos = 3},
-- Define the properties table. Each property is a table containing the
{val = self.level, keypos = 4},
-- canonical order that the property is tested in, the position the
{val = self.action, keypos = 5}
-- property has in the category key strings, and the property value itself.
--]]
local properties = {
expiry = {order = 1, val = expiry},
namespace = {order = 2, val = nskey},
reason = {order = 3, val = reason},
level = {order = 4, val = level},
action = {order = 5, val = action}
}
 
--[[
-- 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 reasonsWithNamespacePriority = cfg.reasonsWithNamespacePriority
local namespaceFirst = reason and reasonsWithNamespacePriority[reason] or false
for propertiesKey, t in pairs(properties) do
configOrder[t.order] = t
end
if namespaceFirst then
-- Swap namespace and reason around.
local namespaceTable = table.remove(configOrder, 2)
table.insert(configOrder, 3, namespaceTable)
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 246 ⟶ 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 270 ⟶ 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 = cfg.protectionCategories
Line 282 ⟶ 302:
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.orderkeypos] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.orderkeypos] = t.val
else
key[t.orderkeypos] = '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 Protection:makeExpiryCategoryisIncorrect()
local cfg = self._cfg
if 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]
then
return makeCategoryLink(self._cfg.msg['tracking-category-expiry'])
end
end
 
function Protection:makeErrorCategory()
local expiry = self.expiry
ifreturn not self:isProtectedshouldHaveProtectionCategory()
or type(expiry) == 'number' and expiry < os.time()
then
return makeCategoryLink(self._cfg.msg['tracking-category-incorrect'])
end
end
 
function Protection:makeTemplateCategoryisTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
ifreturn self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end
then
 
return makeCategoryLink(self._cfg.msg['tracking-category-template'])
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
 
Line 337 ⟶ 359:
--------------------------------------------------------------------------------
 
local Blurb = class('Blurb'){}
Blurb.__index = Blurb
 
Blurb.bannerTextFields = {
function Blurb:initialize(protectionObj, cfg)
self._cfgtext = cfgtrue,
explanation = true,
self._protectionObj = protectionObj
tooltip = true,
self._bannerConfig = protectionObj.bannerConfig
alt = true,
self._title = protectionObj.title
link = true
}
 
function Blurb.new(protectionObj, args, cfg)
return setmetatable({
_cfg = cfg,
_protectionObj = protectionObj,
_args = args
}, Blurb)
end
 
-- StaticPrivate methods --
 
function Blurb.makeFullUrl(page, query, display)
return string.format(
'[%s %s]',
tostring(mw.uri.fullUrl(page, query)),
display
)
end
 
function Blurb.formatDate:_formatDate(num)
-- Formats a Unix timestamp into dd Month, YYYY format.
lang = lang or mw.language.getContentLanguage()
Line 362 ⟶ 386:
lang.formatDate,
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
Line 369 ⟶ 393:
end
end
 
-- Private methods --
 
function Blurb:_getExpandedMessage(msgKey)
Line 378 ⟶ 400:
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.DISPUTEBLURB = self._makeDisputeBlurbParameter
parameterFuncs.DISPUTESECTION = self._makeDisputeSectionParameter
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter
parameterFuncs.EXPIRY = self._makeExpiryParameter
Line 400 ⟶ 408:
parameterFuncs.IMAGELINK = self._makeImageLinkParameter
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter
parameterFuncs.OFFICEBLURB INTROFRAGMENT = self._makeOfficeBlurbParameter_makeIntroFragmentParameter
parameterFuncs.PAGETYPE = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter
Line 406 ⟶ 414:
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter
parameterFuncs.RESETBLURB = self._makeResetBlurbParameter
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 421 ⟶ 439:
-- A link to the page history or the move log, depending on the kind of
-- protection.
local actionpagename = self._protectionObj.actiontitle.prefixedText
if self._protectionObj.action == 'move' then
local pagename = self._title.prefixedText
if action == 'move' then
-- We need the move log link.
return self.makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
Line 432 ⟶ 449:
else
-- We need the history link.
return self.makeFullUrl(
pagename,
{action = 'history'},
self:_getExpandedMessage('current-version-edit-display')
)
end
end
 
function Blurb:_makeDeletionDiscussionLinkParameter()
local deletionDiscussionPage = self._deletionDiscussionPage
if deletionDiscussionPage then
local display = self:_getExpandedMessage('deletion-discussion-link-display')
return string.format('[[%s|%s]]', deletionDiscussionPage, display)
end
end
 
function Blurb:_makeDisputeBlurbParameter()
local expiry = self._protectionObj.expiry
if type(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 section = self._section
local disputes = self:_getExpandedMessage('dispute-section-link-display')
if section then
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._title.namespace].talk.name,
self._title.text,
section,
disputes
)
else
return disputes
end
end
Line 478 ⟶ 461:
local action = self._protectionObj.action
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.
Line 493 ⟶ 467:
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
Line 499 ⟶ 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._protectionObj.expiry
if type(expiry) == 'indefnumber' then
return nilself:_formatDate(expiry)
else
elseif type(expiry) == 'number' then
return Blurb.formatDate(expiry)
elseif expiry then
-- Expiry is an error string.
return expiry
end
Line 515 ⟶ 491:
 
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 namespacetalkKey = self._title_protectionObj.namespacetitle.isTalkPage and 'talk' or 'subject'
local isTalk = self._title.isTalkPage
 
-- Find the message in the explanation blurb table and substitute any
-- @TODO: add semi-protection and pending changes blurbs
-- parameters.
local key
local explanations = self._cfg.explanationBlurbs
if namespace == 8 then
local msg
-- MediaWiki namespace
if explanations[action][level] and explanations[action][level][talkKey] then
key = 'explanation-blurb-full-nounprotect'
msg = explanations[action][level][talkKey]
elseif action == 'edit' and level == 'sysop' and not isTalk then
elseif explanations[action][level] and explanations[action][level].default then
key = 'explanation-blurb-full-subject'
msg = explanations[action][level].default
elseif action == 'move' then
elseif explanations[action].default and explanations[action].default[talkKey] then
if isTalk then
msg = explanations[action].default[talkKey]
key = 'explanation-blurb-move-talk'
elseif explanations[action].default and explanations[action].default.default then
else
msg = explanations[action].default.default
key = 'explanation-blurb-move-subject'
end
elseif action == 'create' then
local xfd = self._deletionDiscussion
if xfd then
key = 'explanation-blurb-create-xfd'
else
key = 'explanation-blurb-create-noxfd'
end
else
error(string.format(
key = 'explanation-blurb-default'
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
return self:_getExpandedMessage_substituteParameters(keymsg)
end
 
Line 562 ⟶ 541:
 
function Blurb:_makeIntroBlurbParameter()
local expiry =if self._protectionObj.expiry:isTemporary() then
if type(expiry) == 'number' then
return self:_getExpandedMessage('intro-blurb-expiry')
else
Line 570 ⟶ 548:
end
 
function Blurb:_makeOfficeBlurbParameter_makeIntroFragmentParameter()
local protectionDate =if self._protectionObj.protectionDate:isTemporary() then
return self:_getExpandedMessage('intro-fragment-expiry')
if protectionDate then
return self:_getExpandedMessage('office-blurb-protectiondate')
else
return self:_getExpandedMessage('officeintro-blurbfragment-noprotectiondatenoexpiry')
end
end
Line 581 ⟶ 558:
function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
local namespace =return pagetypes[self._title_protectionObj.title.namespace]
return pagetypes[namespace] or pagetypes.default or error('no default pagetype defined')
or error('no default pagetype defined', 8)
end
 
Line 597 ⟶ 575:
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
Line 605 ⟶ 583:
local protectionDate = self._protectionObj.protectionDate
if type(protectionDate) == 'number' then
return Blurb.formatDateself:_formatDate(protectionDate)
else
return protectionDate
Line 623 ⟶ 601:
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
Line 629 ⟶ 607:
 
function Blurb:_makeProtectionLogParameter()
local actionpagename = self._protectionObj.actiontitle.prefixedText
if self._protectionObj.action == 'autoreview' then
local pagename = self._title.prefixedText
if action == 'autoreview' then
-- We need the pending changes log.
return self.makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
Line 640 ⟶ 617:
else
-- We need the protection log.
return self.makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self:_getExpandedMessage('protection-log-display')
)
end
end
 
function Blurb:_makeResetBlurbParameter()
local protectionDate = self._protectionObj.protectionDate
if protectionDate then
return self:_getExpandedMessage('reset-blurb-protectiondate')
else
return self:_getExpandedMessage('reset-blurb-noprotectiondate')
end
end
 
function Blurb:_makeTalkPageParameter()
local section = self._section
local display = self:_getExpandedMessage('talk-page-link-display')
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._title_protectionObj.title.namespace].talk.name,
self._title_protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
display
)
end
 
function Blurb:_makeTooltipBlurbParameter()
local expiry =if self._protectionObj.expiry:isTemporary() then
if type(expiry) == 'number' 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{
local mVandalM = require('Module:Vandal-m')
title="vandal-m",
local username = self._username
username args= username{self._args.user or self._title_protectionObj.title.baseText}
}
return mVandalM._main{username}
end
 
-- Public methods --
 
function Blurb:setDeletionDiscussionPagemakeBannerText(pagekey)
-- Validate input.
self._deletionDiscussionPage = page
if not key or not Blurb.bannerTextFields[key] then
end
error(string.format(
 
'"%s" is not a valid banner config field',
function Blurb:setUsername(username)
tostring(key)
self._username = username
), 2)
end
end
 
function Blurb:setSection(section)
self._section = section
end
 
-- Generate the text.
function Blurb:makeReasonText()
local msg = self._bannerConfig_protectionObj.textbannerConfig[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
 
function Blurb:makeExplanationText()
local msg = self._bannerConfig.explanation
return self:_substituteParameters(msg)
end
 
function Blurb:makeTooltipText()
local msg = self._bannerConfig.tooltip
return self:_substituteParameters(msg)
end
 
function Blurb:makeAltText()
local msg = self._bannerConfig.alt
return self:_substituteParameters(msg)
end
 
function Blurb:makeLinkText()
local msg = self._bannerConfig.link
return self:_substituteParameters(msg)
end
 
Line 730 ⟶ 691:
--------------------------------------------------------------------------------
 
local BannerTemplate = class('BannerTemplate'){}
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate:initialize.new(protectionObj, cfg)
self._cfglocal obj = cfg{}
obj._cfg = cfg
end
 
-- Set the image filename.
function BannerTemplate:setImageFilename(filename, protectionObj)
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.
local action = protectionObj.action
local levelaction = protectionObj.levelaction
local expirylevel = protectionObj.expirylevel
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason
-- Deal with special cases first.
-- Deal with special cases first.
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check?
if (
and action == 'edit'
and level namespace == 'sysop'10
or namespace == 828
and not expiry
or reason and obj._cfg.indefImageReasons[reason]
then
)
-- Fully protected modules and templates get the special red "indef"
and action == 'edit'
-- padlock.
and level == 'sysop'
self._imageFilename = self._cfg.msg['image-filename-indef']
and not protectionObj:isTemporary()
return nil
then
end
-- Fully protected modules and templates get the special red "indef"
 
-- padlock.
-- Deal with regular protection types.
obj._imageFilename = obj._cfg.msg['image-filename-indef']
local images = self._cfg.images
else
if images[action] then
-- Deal with regular protection types.
if images[action][level] then
self._imageFilenamelocal images = obj._cfg.images[action][level]
if images[action] then
return nil
elseif if images[action].default[level] then
self obj._imageFilename = images[action].default[level]
elseif images[action].default then
return nil
obj._imageFilename = images[action].default
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
 
Line 786 ⟶ 742:
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return newFileLink(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
 
Line 798 ⟶ 755:
--------------------------------------------------------------------------------
 
local Banner = BannerTemplate:subclasssetmetatable('Banner'{}, BannerTemplate)
Banner.__index = Banner
 
function Banner:initialize.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.initializenew(selfprotectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 40
self:setImageWidth(40)
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
end
obj._reasonText = blurbObj:makeBannerText('text')
 
obj._explanationText = blurbObj:makeBannerText('explanation')
function Banner:setReasonText(s)
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
self._reasonText = s
return setmetatable(obj, Banner)
end
 
function Banner:setExplanationText(s)
self._explanationText = s
end
 
function Banner:setPage(s)
-- This specifies the page to generate the banner for. This only affects
-- Module:Message box if the page specified is not the current page.
self._page = s
end
 
Line 822 ⟶ 771:
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local mbargs = {
Line 841 ⟶ 790:
--------------------------------------------------------------------------------
 
local Padlock = BannerTemplate:subclasssetmetatable('Padlock'{}, BannerTemplate)
Padlock.__index = Padlock
 
function Padlock:initialize.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.initializenew(selfprotectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
self:setImageWidth(20)
obj.imageCaption = blurbObj:makeBannerText('tooltip')
end
obj._imageAlt = blurbObj:makeBannerText('alt')
 
obj._imageLink = blurbObj:makeBannerText('link')
function Padlock:setImageAlt(alt)
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
self._imageAlt = alt
or cfg.padlockIndicatorNames.default
end
or 'pp-default'
 
return setmetatable(obj, Padlock)
function Padlock:setImageLink(link)
self._imageLink = link
end
 
function Padlock:setRight(px)
self._right = px
end
 
function Padlock:__tostring()
local rootframe = mw.html.creategetCurrentFrame('div')
-- The nowiki tag helps prevent whitespace at the top of articles.
root
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
:addClass('metadata topicon nopopups')
name = 'indicator',
:attr('id', 'protected-icon')
:css{displayargs = 'none', right{name = self._right or '55px'_indicatorName},
:wikitext(content = self:renderImage())
}
return tostring(root)
end
 
Line 887 ⟶ 832:
end
 
function p._main(args, cfg, title)
args = args or {}
if not cfg then
cfg = cfg or require(CONFIG_MODULE)
cfg = mw.loadData('Module:Protection banner/config')
end
 
local protectionObj = Protection.new(args, cfg, title)
-- Initialise protection and blurb objects
local protectionObj = Protection:new(args, cfg)
local blurbObj = Blurb:new(protectionObj, cfg)
blurbObj:setDeletionDiscussionPage(args.xfd)
blurbObj:setUsername(args.user)
blurbObj:setSection(args.section)
 
local ret = {}
 
-- If a page's edit protection is equally or more restrictive than its
-- Render the banner
-- protection from some other action, then don't bother displaying anything
if protectionObj:isProtected() then
-- for the other action (except categories).
-- Get the banner object
if not yesno(args.catonly) and (protectionObj.action == 'edit' or
local bannerObj
if yesno(args.small)demolevel thenor
not getReachableNodes(
bannerObj = Padlock:new(cfg)
cfg.hierarchy,
bannerObj:setImageTooltip(blurbObj:makeTooltipText())
protectionObj.level
bannerObj:setImageAlt(blurbObj:makeAltText())
)[effectiveProtectionLevel('edit', protectionObj.title)])
bannerObj:setImageLink(blurbObj:makeLinkText())
then
else
-- Initialise the blurb object
bannerObj = Banner:new(cfg)
local blurbObj = Blurb.new(protectionObj, args, cfg)
-- Large banners use the alt text for the tooltip.
bannerObj:setImageTooltip(blurbObj:makeAltText())
-- SetRender the text fields and the page name.banner
if protectionObj:shouldShowLock() then
bannerObj:setReasonText(blurbObj:makeReasonText())
ret[#ret + 1] = tostring(
bannerObj:setExplanationText(blurbObj:makeExplanationText())
(yesno(args.small) and Padlock or Banner)
bannerObj:setPage(protectionObj.title.prefixedText)
.new(protectionObj, blurbObj, cfg)
)
end
-- Set the image fields
local bannerConfig = protectionObj.bannerConfig
bannerObj:setImageFilename(bannerConfig.image, protectionObj)
 
ret[#ret + 1] = tostring(bannerObj)
end
 
-- Render the categories
if yesno(args.category) ~= false then
ret[#ret + 1] = protectionObj:makeProtectionCategorymakeCategoryLinks()
ret[#ret + 1] = protectionObj:makeExpiryCategory()
ret[#ret + 1] = protectionObj:makeErrorCategory()
ret[#ret + 1] = protectionObj:makeTemplateCategory()
end
Line 937 ⟶ 870:
end
 
function p.main(frame, cfg)
cfg = cfg or require(CONFIG_MODULE)
if not getArgs then
 
getArgs = require('Module:Arguments').getArgs
-- 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(getArgs(frame)args, cfg)
end
 
TheInferiorDyl
verified
2,508

edits

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