The Lonsdale Battalion

Module:Protection banner: Difference between revisions

← Older edit
Content deleted Content added
add some more blurb parameter functions
m 11 revisions imported: import clickable buttons 2
 
(149 intermediate revisions by 12 users not shown)
Line 4:
-- Initialise necessary modules.
require('Module:No globals')
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(
function ProtectionStatus:initialize(args, titleObj)
'[[%s:%s|%s]]',
-- Set action
mw.site.namespaces[14].name,
do
cat,
local actions = {
sort
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
end
 
-- Validation function for the expiry and the protection date
-- Set level
local function validateDate(dateString, dateType)
do
if not lang then
local level = mProtectionLevel._main(self._action, titleObj)
lang = mw.language.getContentLanguage()
if level == 'accountcreator' then
end
-- Lump titleblacklisted pages in with template-protected pages,
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
-- since templateeditors can do both.
if success then
level = 'templateeditor'
result = tonumber(result)
if result then
return result
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
self._protectionDate = args.date
self._username = args.user
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).
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
 
--------------------------------------------------------------------------------
function ProtectionStatus:getReason()
-- Protection class
return self._reason
--------------------------------------------------------------------------------
end
 
local Protection = {}
function ProtectionStatus:getExpiry()
Protection.__index = Protection
return self._expiry
end
 
Protection.supportedActions = {
function ProtectionStatus:getSection()
edit = true,
return self._section
move = true,
end
autoreview = true,
upload = true
}
 
Protection.bannerConfigFields = {
function ProtectionStatus:getProtectionDate()
'text',
return self._protectionDate
'explanation',
end
'tooltip',
'alt',
'link',
'image'
}
 
function Protection.new(args, cfg, title)
function ProtectionStatus:getUsername()
local obj = {}
return self._username
obj._cfg = cfg
end
obj.title = title or mw.title.getCurrentTitle()
 
-- Set action
--------------------------------------------------------------------------------
if not args.action then
-- Config class
obj.action = 'edit'
--------------------------------------------------------------------------------
elseif Protection.supportedActions[args.action] then
obj.action = args.action
else
error(string.format(
'invalid action: %s',
tostring(args.action)
), 3)
end
 
-- Set level
local Config = class('Config')
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
obj.level = '*'
end
 
-- Set expiry
function Config:initialize()
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
self._cfg = mw.loadData('Module:Protection banner/config')
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(Protection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
obj.bannerConfig[field] = t[field]
break
end
end
end
end
return setmetatable(obj, Protection)
end
 
function ConfigProtection:getBannerConfigisProtected(protectionStatusObj)
return self.level ~= '*'
end
 
function Protection:isTemporary()
return type(self.expiry) == 'number'
end
 
function Protection:makeProtectionCategory()
local cfg = self._cfg
local actiontitle = protectionStatusObj:getAction()self.title
local reason = protectionStatusObj:getReason()
-- Exit if the page is not protected.
if cfg.banners[action][reason] then
if not self:isProtected() then
return cfg.banners[action][reason]
return ''
else
end
return cfg.defaultBanners[action]
-- Get the expiry key fragment.
local expiryFragment
if self.expiry == 'indef' then
expiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
end
end
 
-- Get the namespace key fragment.
function Config:getConfigTable(key)
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
local blacklist = {
if not namespaceFragment and title.namespace % 2 == 1 then
banners = true,
namespaceFragment = 'talk'
defaultBanners = true
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
-- 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}
}
 
if not blacklist[key] then
--[[
return self._cfg[key]
-- The old protection templates used an ad-hoc protection category system,
else
-- with some templates prioritising namespaces in their categories, and
return nil
-- 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 active, inactive = {}, {}
for i, t in ipairs(order) 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 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 ConfigProtection:getMessageisIncorrect(key)
returnlocal expiry = self._cfg.msg[key]expiry
return not self:isProtected()
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
 
Line 120 ⟶ 344:
--------------------------------------------------------------------------------
 
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
}
 
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 params, parameterFuncs = {}, {}
 
setmetatable(params, {
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 ''
paramst[k] = param
return param
end
})
end
msg = msg:gsub('${(%u+)}', self._params)
parameterFuncs[1] = function ()
return msg
return self:_makeIntroParameter()
end
 
function Blurb:_makeCurrentVersionParameter()
parameterFuncs[2] = function ()
-- A link to the page history or the move log, depending on the kind of
return self:_makeUntilParameter()
-- protection.
end
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
parameterFuncs[3] = function ()
-- We need the move log link.
return self:_makeDisputesParameter()
return makeFullUrl(
end
'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.
parameterFuncs[4] = function ()
local requestType
return self:_makePagetypeParameter()
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.
parameterFuncs[5] = function ()
local display = self:_getExpandedMessage('edit-request-display')
return self:_makeProtectionDateParameter()
end
 
return mEditRequest._link{type = requestType, display = display}
parameterFuncs[6] = function ()
end
return self:_makeVandalTemplateParameter()
end
 
function Blurb:_makeExpiryParameter()
parameterFuncs[7] = function ()
local expiry = self._protectionObj.expiry
return self:_makeProtectionLevelParameter()
if type(expiry) == 'number' then
end
return self:_formatDate(expiry)
else
return expiry
end
end
 
function Blurb:_makeExplanationBlurbParameter()
parameterFuncs[8] = function ()
-- Cover special cases first.
return self:_makeExpiryParameter()
if self._protectionObj.title.namespace == 8 then
end
-- MediaWiki namespace
return self:_getExpandedMessage('explanation-blurb-nounprotect')
end
 
-- Get explanation blurb table keys
parameterFuncs[9] = function ()
local action = self._protectionObj.action
-- A link to the page history or the move log
local level = self._protectionObj.level
return self:_makeDisputeLinkParameter()
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
end
 
-- Find the message in the explanation blurb table and substitute any
parameterFuncs[10] = function ()
-- parameters.
return self:_makeProtectionLogParameter()
local explanations = self._cfg.explanationBlurbs
end
local msg
 
if explanations[action][level] and explanations[action][level][talkKey] then
parameterFuncs[11] = function ()
msg = explanations[action][level][talkKey]
return self:_makeTalkLinkParameter()
elseif explanations[action][level] and explanations[action][level].default then
end
msg = explanations[action][level].default
 
elseif explanations[action].default and explanations[action].default[talkKey] then
parameterFuncs[12] = function ()
msg = explanations[action].default[talkKey]
return self:_makeEditRequestParameter()
elseif explanations[action].default and explanations[action].default.default then
end
msg = explanations[action].default.default
 
else
parameterFuncs[13] = function ()
error(string.format(
return self:_makeRequestUnprotectionParameter()
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
end
action,
 
level,
parameterFuncs[14] = function ()
talkKey
-- Adds links to edit requests and the talk page if we are on a
), 8)
-- subject page
return self:_makeSubjectPageLinksParameter()
end
 
parameterFuncs[15] = function ()
return self:_makeDeletionDiscussionParameter()
end
 
parameterFuncs[16] = function ()
return self:_makeDeletionLogParameter()
end
self._params = params
end
return self:_substituteParameters(msg)
return mw.message.newRawMessage(msg):params(self._params):plain()
end
 
function Blurb:_makeIntroParameter_makeImageLinkParameter()
local imageLinks = self._cfg.imageLinks
-- parameter $1
local action = self._protectionObj.action
local key
local actionlevel = self._protectionStatusObj:getAction()_protectionObj.level
local msg
local level = self._protectionStatusObj:getLevel()
if imageLinks[action == 'edit' and ][level == 'autoconfirmed'] then
msg = imageLinks[action][level]
key = 'reason-text-semi'
elseif imageLinks[action == 'move'].default then
msg = imageLinks[action].default
key = 'reason-text-move'
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:_makeUntilParameter_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() then
-- parameter $2
return self:_getExpandedMessage('intro-blurb-expiry')
-- "until" or "or until" depending on the expiry
local expiry = self._protectionStatusObj:getExpiry()
if expiry then
return 'or until'
else
return self:_getExpandedMessage('intro-blurb-noexpiry')
return 'until'
end
end
 
function Blurb:_makeDisputesParameter_makeIntroFragmentParameter()
if self._protectionObj:isTemporary() then
-- parameter $3
return self:_getExpandedMessage('intro-fragment-expiry')
-- "disputes", with or without a section link
local section = self._protectionStatusObj:getSection()
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 self:_getExpandedMessage('intro-fragment-noexpiry')
return disputes
end
end
 
function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
-- parameter $4
localreturn pagetypes = [self._configObj:getConfigTable('pagetypeNamespaces')_protectionObj.title.namespace]
or pagetypes.default
local namespace = self._titleObj:getNamespace()
or error('no default pagetype defined', 8)
return pagetypes[namespace] or pagetypes.default or 'page'
end
 
function Blurb:_makeProtectionDateParameter_makeProtectionBlurbParameter()
local protectionBlurbs = self._cfg.protectionBlurbs
-- parameter $5
local protectionDateaction = self._protectionStatusObj:getProtectionDate()_protectionObj.action
local level = self._protectionObj.level
if protectionDate then
local msg
local lang = mw.language.getContentLanguage()
if protectionBlurbs[action][level] then
local success, date = pcall(
msg = protectionBlurbs[action][level]
lang.formatDate,
elseif protectionBlurbs[action].default then
lang,
msg = protectionBlurbs[action].default
'j F Y',
elseif protectionBlurbs.edit.default then
protectionDate
msg = protectionBlurbs.edit.default
)
else
if success and date then
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
return date
end
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeVandalTemplateParameter_makeProtectionDateParameter()
local protectionDate = self._protectionObj.protectionDate
local mVandalM = require('Module:Vandal-m')
if type(protectionDate) == 'number' then
local username = self._protectionStatusObj:getUsername()
return self:_formatDate(protectionDate)
username = username or self._titleObj.baseText
else
return mVandalM.luaMain{username}
return protectionDate
end
end
 
function Blurb:_makeProtectionLevelParameter()
--------------------------------------------------------------------------------
local protectionLevels = self._cfg.protectionLevels
-- Image class
local action = self._protectionObj.action
--------------------------------------------------------------------------------
local level = self._protectionObj.level
 
local Image = class('Image')msg
if protectionLevels[action][level] then
 
msg = protectionLevels[action][level]
function Image:initialize(configObj, protectionStatusObj, titleObj)
elseif protectionLevels[action].default then
self._configObj = configObj
msg = protectionLevels[action].default
self._protectionStatusObj = protectionStatusObj
elseif protectionLevels.edit.default then
self._titleObj = titleObj
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
end
 
function ImageBlurb:setFilename_makeProtectionLogParameter(filename)
local pagename = self._protectionObj.title.prefixedText
if filename then
if self._protectionObj.action == 'autoreview' then
self._filename = filename
-- 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.
local images, action, level, reason, namespace
return makeFullUrl(
do
'Special:Log',
local configObj = self._configObj
{type = 'protect', page = pagename},
local protectionStatusObj = self._protectionStatusObj
self:_getExpandedMessage('protection-log-display')
local titleObj = self._titleObj
)
images = configObj:getConfigTable('images')
action = protectionStatusObj:getAction()
level = protectionStatusObj:getLevel()
reason = protectionStatusObj:getReason()
namespace = titleObj:getNamespace()
end
 
local image
if reason == 'office' or reason == 'reset' then
image = images.office
elseif namespace == 10 or namespace == 828 then
-- We are in the template or module namespaces.
if level == 'templateeditor' then
image = images.template
elseif level == 'sysop' then
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
end
 
function ImageBlurb:setWidth_makeTalkPageParameter(width)
return string.format(
self._width = width
'[[%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 ImageBlurb:setAlt_makeTooltipBlurbParameter(alt)
if self._protectionObj:isTemporary() then
self._alt = alt
return self:_getExpandedMessage('tooltip-blurb-expiry')
else
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
end
end
 
function ImageBlurb:setLink_makeTooltipFragmentParameter(link)
if self._protectionObj:isTemporary() then
self._link = link
return self:_getExpandedMessage('tooltip-fragment-expiry')
else
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
end
end
 
function ImageBlurb:setCaption_makeVandalTemplateParameter(caption)
return require('Module:Vandal-m')._main{
self._caption = caption
self._args.user or self._protectionObj.title.baseText
}
end
 
-- Public methods --
function Image:export()
 
return mFileLink.new(self._filename or 'Transparent.gif')
function Blurb:makeBannerText(key)
:width(self._width or 20)
-- Validate input.
:alt(self._alt)
if not key or not Blurb.bannerTextFields[key] then
:link(self._link)
error(string.format(
:caption(self._caption)
'"%s" is not a valid banner config field',
:render()
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
 
Line 387 ⟶ 675:
--------------------------------------------------------------------------------
 
local BannerTemplate = class('BannerTemplate'){}
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate:initialize.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:renderrenderImage()
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
 
Line 399 ⟶ 739:
--------------------------------------------------------------------------------
 
local Banner = BannerTemplate:subclasssetmetatable('Banner'{}, BannerTemplate)
Banner.__index = Banner
 
function Banner.new(protectionObj, blurbObj, cfg)
--------------------------------------------------------------------------------
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
-- Padlock class
obj.imageWidth = 40
--------------------------------------------------------------------------------
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
 
obj._reasonText = blurbObj:makeBannerText('text')
local Padlock = BannerTemplate:subclass('Padlock')
obj._explanationText = blurbObj:makeBannerText('explanation')
 
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
--------------------------------------------------------------------------------
return setmetatable(obj, Banner)
-- Category class
--------------------------------------------------------------------------------
 
local Category = class('Category')
 
function Category:initialize()
end
 
function CategoryBanner:setName__tostring(name)
-- Renders the banner.
self._name = name
makeMessageBox = makeMessageBox or require('Module:Message box').main
end
local reasonText = self._reasonText or error('no reason text set', 2)
 
local explanationText = self._explanationText
function Category:export()
local mbargs = {
if self._categoryName then
page = self._page,
return string.format(
type = '[[%s:%s]]protection',
image = self:renderImage(),
mw.site.namespaces[14].name,
text = string.format(
self._categoryName
"'''%s'''%s",
reasonText,
explanationText and '<br />' .. explanationText or ''
)
}
else
return makeMessageBox('mbox', mbargs)
end
end
 
--------------------------------------------------------------------------------
-- ProtectionCategoryPadlock class
--------------------------------------------------------------------------------
 
local Padlock = setmetatable({}, BannerTemplate)
local ProtectionCategory = Category:subclass('ProtectionCategory')
Padlock.__index = Padlock
 
function Padlock.new(protectionObj, blurbObj, cfg)
function ProtectionCategory:setName(
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
name,
obj.imageWidth = 20
configObj,
obj.imageCaption = blurbObj:makeBannerText('tooltip')
protectionStatusObj,
obj._imageAlt = blurbObj:makeBannerText('alt')
namespace
obj._imageLink = blurbObj:makeBannerText('link')
)
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
--[[
or cfg.padlockIndicatorNames.default
-- Sets the protection category. If a category name is not provided, this
or 'pp-default'
-- method gets a category name from the module config, given a combination
return setmetatable(obj, Padlock)
-- of the protection type, the protection level, the namespace number, the
end
-- reason for protection, and the expiry date.
 
--]]
function Padlock:__tostring()
local frame = mw.getCurrentFrame()
-- If a name was provided, use that.
-- The nowiki tag helps prevent whitespace at the top of articles.
if name then
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
Category.setName(self, name)
name = 'indicator',
end
args = {name = self._indicatorName},
content = self:renderImage()
-- Get the namespace category key from the namespace number.
local nskey
do
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 properties table. Each property is a table containing the
-- 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, keypos = 5, val = protectionStatusObj:getExpiry()},
namespace = {order = 2, keypos = 3, val = nskey},
reason = {order = 3, keypos = 4, val = protectionStatusObj:getReason()},
level = {order = 4, keypos = 2, val = protectionStatusObj:getLevel()},
action = {order = 5, keypos = 1, 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.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
cat = attempt
break
end
end
if cat then
Category.setName(self, cat)
else
error(
'No category match found;'
.. ' please define the category for key "all-all-all-all-all"'
)
end
end
 
--------------------------------------------------------------------------------
-- Exports
-- ExpiryCategory class
--------------------------------------------------------------------------------
 
local p = {}
local ExpiryCategory = Category:subclass('ExpiryCategory')
 
function p._exportClasses()
--------------------------------------------------------------------------------
-- This is used for testing purposes.
-- ErrorCategory class
return {
--------------------------------------------------------------------------------
Protection = Protection,
 
Blurb = Blurb,
local ErrorCategory = Category:subclass('ErrorCategory')
BannerTemplate = BannerTemplate,
 
Banner = Banner,
--------------------------------------------------------------------------------
Padlock = Padlock,
-- ProtectionBanner class
}
--------------------------------------------------------------------------------
 
local ProtectionBanner = {}
 
function ProtectionBanner.exportToWiki(frame, title)
local args = mArguments.getArgs(frame)
return ProtectionBanner.exportToLua(args, title)
end
 
function ProtectionBannerp.exportToLua_main(args, cfg, title)
args = args or {}
title = title or mw.title.getCurrentTitle()
cfg = cfg or require(CONFIG_MODULE)
 
local protectionObj = Protection.new(args, cfg, title)
-- Get data objects
local theProtectionStatus = ProtectionStatus:new(args, title)
local theConfig = Config:new()
 
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
-- for the other action (except categories).
if 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:isProtected() 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 ProtectionBannerp._exportClassesmain(frame, cfg)
cfg = cfg or require(CONFIG_MODULE)
-- This is used to export the classes for testing purposes.
 
return {
-- Find default args, if any.
ProtectionStatus = ProtectionStatus,
local parent = frame.getParent and frame:getParent()
Config = Config,
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
Image = Image,
 
Blurb = Blurb,
-- Find user args, and use the parent frame if we are being called from a
BannerTemplate = BannerTemplate,
-- wrapper template.
Banner = Banner,
getArgs = getArgs or require('Module:Arguments').getArgs
Padlock = Padlock,
local userArgs = getArgs(frame, {
Category = Category,
parentOnly = defaultArgs,
ProtectionCategory = ProtectionCategory,
frameOnly = not defaultArgs
ErrorCategory = ErrorCategory,
})
ExpiryCategory = ExpiryCategory,
 
}
-- 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 ProtectionBannerp
Retrieved from "https://thelonsdalebattalion.co.uk/wiki/Module:Protection_banner"