Difference between revisions of "Module:Protection banner"

From Amanita Research
Jump to navigation Jump to search
(allow individual banner config items to fall back to the same value in the defaults table, and add functions for making the blurb values)
m (231 revisions imported: citations)
 
(130 intermediate revisions by 6 users not shown)
Line 4: Line 4:
 
-- Initialise necessary modules.
 
-- Initialise necessary modules.
 
require('Module:No globals')
 
require('Module:No globals')
−
local class = require('Module:Middleclass').class
+
local makeFileLink = require('Module:File link')._main
−
local mArguments = require('Module:Arguments')
+
local effectiveProtectionLevel = require('Module:Effective protection level')._main
−
local mFileLink = require('Module:File link')
+
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
−
local mProtectionLevel = require('Module:Effective protection level')
 
 
local yesno = require('Module:Yesno')
 
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'
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ProtectionStatus class
+
-- Helper functions
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ProtectionStatus = class('ProtectionStatus')
+
local function makeCategoryLink(cat, sort)
 +
if cat then
 +
return string.format(
 +
'[[%s:%s|%s]]',
 +
mw.site.namespaces[14].name,
 +
cat,
 +
sort
 +
)
 +
end
 +
end
  
−
function ProtectionStatus:initialize(args, titleObj)
+
-- Validation function for the expiry and the protection date
−
-- Set action
+
local function validateDate(dateString, dateType)
−
do
+
if not lang then
−
local actions = {
+
lang = mw.language.getContentLanguage()
−
create = true,
+
end
−
edit = true,
+
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
−
move = true,
+
if success then
−
autoreview = true
+
result = tonumber(result)
−
}
+
if result then
−
if args.action and actions[args.action] then
+
return result
−
self._action = args.action
 
−
else
 
−
self._action = 'edit'
 
 
end
 
end
 
end
 
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
  
−
-- Set level
+
-- Given a directed graph formatted as node -> table of direct successors,
−
do
+
-- get a table of all nodes reachable from a given node (though always
−
local level = mProtectionLevel._main(self._action, titleObj)
+
-- including the given node).
−
if level == 'accountcreator' then
+
local function getReachableNodes(graph, start)
−
-- Lump titleblacklisted pages in with template-protected pages,
+
local toWalk, retval = {[start] = true}, {}
−
-- since templateeditors can do both.
+
while true do
−
level = 'templateeditor'
+
-- 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
−
self._level = level or '*'
 
 
end
 
end
−
 
−
-- Set other params
 
−
self._reason = args.reason
 
−
self._expiry = args.expiry or 'indef'
 
−
self._protectionDate = args.date
 
 
end
 
end
  
−
function ProtectionStatus:getAction()
+
--------------------------------------------------------------------------------
−
return self._action
+
-- Protection class
−
end
+
--------------------------------------------------------------------------------
  
−
function ProtectionStatus:getLevel()
+
local Protection = {}
−
return self._level
+
Protection.__index = Protection
−
end
 
  
−
function ProtectionStatus:getReason()
+
Protection.supportedActions = {
−
return self._reason
+
edit = true,
−
end
+
move = true,
 +
autoreview = true,
 +
upload = true
 +
}
  
−
function ProtectionStatus:getExpiry()
+
Protection.bannerConfigFields = {
−
return self._expiry
+
'text',
−
end
+
'explanation',
 +
'tooltip',
 +
'alt',
 +
'link',
 +
'image'
 +
}
  
−
function ProtectionStatus:getProtectionDate()
+
function Protection.new(args, cfg, title)
−
return self._protectionDate
+
local obj = {}
−
end
+
obj._cfg = cfg
 +
obj.title = title or mw.title.getCurrentTitle()
  
−
--------------------------------------------------------------------------------
+
-- Set action
−
-- Config class
+
if not args.action then
−
--------------------------------------------------------------------------------
+
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
  
−
local Config = class('Config')
+
-- Set level
 +
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
  
−
function Config:initialize()
+
-- Set expiry
−
local data = mw.loadData('Module:Protection banner/config')
+
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
−
self._cfg = data.cfg
+
if effectiveExpiry == 'infinity' then
−
self._msg = data.msg
+
obj.expiry = 'indef'
−
self._bannerConfigTables = {}
+
elseif effectiveExpiry ~= 'unknown' then
−
end
+
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
 +
end
  
−
function Config:getBannerConfig(protectionStatusObj)
+
-- Set reason
−
local cfg = self._cfg
+
if args[1] then
−
local action = protectionStatusObj:getAction()
+
obj.reason = mw.ustring.lower(args[1])
−
local reason = protectionStatusObj:getReason()
+
if obj.reason:find('|') then
 +
error('reasons cannot contain the pipe character ("|")', 3)
 +
end
 +
end
  
−
if self._bannerConfigTables[protectionStatusObj] then
+
-- Set protection date
−
return self._bannerConfigTables[protectionStatusObj]
+
if args.date then
−
else
+
obj.protectionDate = validateDate(args.date, 'protection date')
−
local ret = {}
+
end
−
local fields = {
+
−
'text',
+
-- Set banner config
−
'explanation',
+
do
−
'tooltip',
+
obj.bannerConfig = {}
−
'alt',
 
−
'image',
 
−
'categoryOrder',
 
−
'categoryReason'
 
−
}
 
 
local configTables = {}
 
local configTables = {}
−
configTables[#configTables + 1] = cfg.banners[action][reason]
+
if cfg.banners[obj.action] then
−
configTables[#configTables + 1] = cfg.defaultBanners[action]
+
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
−
for i, field in ipairs(fields) do
+
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
 
for j, t in ipairs(configTables) do
 
if t[field] then
 
if t[field] then
−
ret[field] = t[field]
+
obj.bannerConfig[field] = t[field]
 
break
 
break
 
end
 
end
 
end
 
end
 
end
 
end
−
self._bannerConfigTables[protectionStatusObj] = ret
 
−
return ret
 
 
end
 
end
 +
return setmetatable(obj, Protection)
 +
end
 +
 +
function Protection:isProtected()
 +
return self.level ~= '*'
 +
end
 +
 +
function Protection:isTemporary()
 +
return type(self.expiry) == 'number'
 
end
 
end
  
−
function Config:getConfigTable(key)
+
function Protection:makeProtectionCategory()
−
local blacklist = {
+
local cfg = self._cfg
−
banners = true,
+
local title = self.title
−
defaultBanners = true
+
 +
-- Exit if the page is not protected.
 +
if not self:isProtected() then
 +
return ''
 +
end
 +
 +
-- Get the expiry key fragment.
 +
local expiryFragment
 +
if self.expiry == 'indef' then
 +
expiryFragment = self.expiry
 +
elseif type(self.expiry) == 'number' then
 +
expiryFragment = 'temp'
 +
end
 +
 
 +
-- Get the namespace key fragment.
 +
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
 +
if not namespaceFragment and title.namespace % 2 == 1 then
 +
namespaceFragment = 'talk'
 +
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]
+
--[[
−
else
+
-- The old protection templates used an ad-hoc protection category system,
−
return nil
+
-- 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 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
 
end
 +
return ''
 
end
 
end
  
−
function Config:getMessage(key)
+
function Protection:isIncorrect()
−
return self._msg[key]
+
local expiry = self.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
 
end
  
Line 136: Line 344:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Blurb = class('Blurb')
+
local Blurb = {}
 +
Blurb.__index = Blurb
  
−
function Blurb:initialize(configObj, protectionStatusObj, titleObj)
+
Blurb.bannerTextFields = {
−
self._configObj = configObj
+
text = true,
−
self._protectionStatusObj = protectionStatusObj
+
explanation = true,
−
self._bannerConfig = configObj:getBannerConfig(protectionStatusObj)
+
tooltip = true,
−
self._titleObj = titleObj
+
alt = true,
−
end
+
link = true
 +
}
  
−
function Blurb.makeFullUrl(page, query, display)
+
function Blurb.new(protectionObj, args, cfg)
−
local url = mw.uri.fullUrl(page, query)
+
return setmetatable({
−
url = tostring(url)
+
_cfg = cfg,
−
return string.format('[%s %s]', url, display)
+
_protectionObj = protectionObj,
 +
_args = args
 +
}, Blurb)
 
end
 
end
  
−
function Blurb:setDeletionDiscussionPage(page)
+
-- Private methods --
−
self._deletionDiscussionPage = page
 
−
end
 
  
−
function Blurb:setUsername(username)
+
function Blurb:_formatDate(num)
−
self._username = username
+
-- 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
 
end
  
−
function Blurb:setSection(section)
+
function Blurb:_getExpandedMessage(msgKey)
−
self._section = section
+
return self:_substituteParameters(self._cfg.msg[msgKey])
 
end
 
end
  
 
function Blurb:_substituteParameters(msg)
 
function Blurb:_substituteParameters(msg)
 
if not self._params then
 
if not self._params then
−
local params, parameterFuncs = {}, {}
+
local 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)
 
__index = function (t, k)
 
local param
 
local param
Line 173: Line 411:
 
end
 
end
 
param = param or ''
 
param = param or ''
−
params[k] = param
+
t[k] = param
 
return param
 
return param
 
end
 
end
 
})
 
})
 +
end
 
 
−
parameterFuncs[1] = self._makeIntroParameter
+
msg = msg:gsub('${(%u+)}', self._params)
−
parameterFuncs[2] = self._makeUntilParameter
+
return msg
−
parameterFuncs[3] = self._makeDisputesParameter
+
end
−
parameterFuncs[4] = self._makePagetypeParameter
+
 
−
parameterFuncs[5] = self._makeProtectionDateParameter
+
function Blurb:_makeCurrentVersionParameter()
−
parameterFuncs[6] = self._makeVandalTemplateParameter
+
-- A link to the page history or the move log, depending on the kind of
−
parameterFuncs[7] = self._makeProtectionLevelParameter
+
-- protection.
−
parameterFuncs[8] = self._makeExpiryParameter
+
local pagename = self._protectionObj.title.prefixedText
−
parameterFuncs[9] = self._makeDisputeLinkParameter -- A link to the page history or the move log
+
if self._protectionObj.action == 'move' then
−
parameterFuncs[10] = self._makeProtectionLogParameter
+
-- We need the move log link.
−
parameterFuncs[11] = self._makeTalkLinkParameter
+
return makeFullUrl(
−
parameterFuncs[12] = self._makeEditRequestParameter
+
'Special:Log',
−
parameterFuncs[13] = self._makeRequestUnprotectionParameter
+
{type = 'move', page = pagename},
−
parameterFuncs[14] = self._makeSubjectPageLinksParameter -- Adds links to edit requests and the talk page if we are on a subject page
+
self:_getExpandedMessage('current-version-move-display')
−
parameterFuncs[15] = self._makeDeletionBlurbParameter
+
)
−
parameterFuncs[16] = self._makeDeletionDiscussionLinkParameter
+
else
−
parameterFuncs[17] = self._makeDeletionLogParameter
+
-- We need the history link.
−
+
return makeFullUrl(
−
self._params = params
+
pagename,
 +
{action = 'history'},
 +
self:_getExpandedMessage('current-version-edit-display')
 +
)
 
end
 
end
 +
end
  
−
local function getParameter(match)
+
function Blurb:_makeEditRequestParameter()
−
match = tonumber(match)
+
local mEditRequest = require('Module:Submit an edit request')
−
return self._params[match]
+
local action = self._protectionObj.action
 +
local level = self._protectionObj.level
 +
 +
-- Get the edit request type.
 +
local requestType
 +
if action == 'edit' then
 +
if level == 'autoconfirmed' then
 +
requestType = 'semi'
 +
elseif level == 'extendedconfirmed' then
 +
requestType = 'extended'
 +
elseif level == 'templateeditor' then
 +
requestType = 'template'
 +
end
 
end
 
end
 +
requestType = requestType or 'full'
 +
 +
-- Get the display value.
 +
local display = self:_getExpandedMessage('edit-request-display')
  
−
msg = msg:gsub('$([1-9][0-9]*)', getParameter)
+
return mEditRequest._link{type = requestType, display = display}
−
return msg
 
 
end
 
end
  
−
function Blurb:_makeIntroParameter()
+
function Blurb:_makeExpiryParameter()
−
-- parameter $1
+
local expiry = self._protectionObj.expiry
−
local key
+
if type(expiry) == 'number' then
−
local action = self._protectionStatusObj:getAction()
+
return self:_formatDate(expiry)
−
local level = self._protectionStatusObj:getLevel()
 
−
if action == 'edit' and level == 'autoconfirmed' then
 
−
key = 'reason-text-semi'
 
−
elseif action == 'move' then
 
−
key = 'reason-text-move'
 
−
elseif action == 'create' then
 
−
key = 'reason-text-create'
 
 
else
 
else
−
key = 'reason-text-default'
+
return expiry
 
end
 
end
−
local msg = self._configObj:getMessage(key)
 
−
return self:_substituteParameters(msg)
 
 
end
 
end
  
−
function Blurb:_makeUntilParameter()
+
function Blurb:_makeExplanationBlurbParameter()
−
-- parameter $2
+
-- Cover special cases first.
−
-- "until" or "or until" depending on the expiry
+
if self._protectionObj.title.namespace == 8 then
−
local expiry = self._protectionStatusObj:getExpiry()
+
-- MediaWiki namespace
−
if expiry then
+
return self:_getExpandedMessage('explanation-blurb-nounprotect')
−
return 'or until'
+
end
 +
 
 +
-- Get explanation blurb table keys
 +
local action = self._protectionObj.action
 +
local level = self._protectionObj.level
 +
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
 +
 
 +
-- Find the message in the explanation blurb table and substitute any
 +
-- parameters.
 +
local explanations = self._cfg.explanationBlurbs
 +
local msg
 +
if explanations[action][level] and explanations[action][level][talkKey] then
 +
msg = explanations[action][level][talkKey]
 +
elseif explanations[action][level] and explanations[action][level].default then
 +
msg = explanations[action][level].default
 +
elseif explanations[action].default and explanations[action].default[talkKey] then
 +
msg = explanations[action].default[talkKey]
 +
elseif explanations[action].default and explanations[action].default.default then
 +
msg = explanations[action].default.default
 
else
 
else
−
return 'until'
+
error(string.format(
 +
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
 +
action,
 +
level,
 +
talkKey
 +
), 8)
 
end
 
end
 +
return self:_substituteParameters(msg)
 
end
 
end
  
−
function Blurb:_makeDisputesParameter()
+
function Blurb:_makeImageLinkParameter()
−
-- parameter $3
+
local imageLinks = self._cfg.imageLinks
−
-- "disputes", with or without a section link
+
local action = self._protectionObj.action
−
local section = self._section
+
local level = self._protectionObj.level
−
local disputes = self.configObj:getMessage('dispute-section-link-display')
+
local msg
−
if section then
+
if imageLinks[action][level] then
−
return string.format(
+
msg = imageLinks[action][level]
−
'[[%s:%s#%s|%s]]',
+
elseif imageLinks[action].default then
−
mw.site.namespaces[self._titleObj.namespace].talk.name,
+
msg = imageLinks[action].default
−
self._titleObj.text,
 
−
section,
 
−
disputes
 
−
)
 
 
else
 
else
−
return disputes
+
msg = imageLinks.edit.default
 
end
 
end
 +
return self:_substituteParameters(msg)
 
end
 
end
  
−
function Blurb:_makePagetypeParameter()
+
function Blurb:_makeIntroBlurbParameter()
−
-- parameter $4
+
if self._protectionObj:isTemporary() then
−
local pagetypes = self._configObj:getConfigTable('bannerPagetypes')
+
return self:_getExpandedMessage('intro-blurb-expiry')
−
local namespace = self._titleObj.namespace
+
else
−
return pagetypes[namespace] or pagetypes.default or 'page'
+
return self:_getExpandedMessage('intro-blurb-noexpiry')
 +
end
 
end
 
end
  
−
function Blurb:_makeProtectionDateParameter()
+
function Blurb:_makeIntroFragmentParameter()
−
-- parameter $5
+
if self._protectionObj:isTemporary() then
−
local protectionDate = self._protectionStatusObj:getProtectionDate()
+
return self:_getExpandedMessage('intro-fragment-expiry')
−
if protectionDate then
+
else
−
local lang = mw.language.getContentLanguage()
+
return self:_getExpandedMessage('intro-fragment-noexpiry')
−
local success, date = pcall(
 
−
lang.formatDate,
 
−
lang,
 
−
'j F Y',
 
−
protectionDate
 
−
)
 
−
if success and date then
 
−
return date
 
−
end
 
 
end
 
end
 
end
 
end
  
−
function Blurb:_makeVandalTemplateParameter()
+
function Blurb:_makePagetypeParameter()
−
-- parameter $6
+
local pagetypes = self._cfg.pagetypes
−
local mVandalM = require('Module:Vandal-m')
+
return pagetypes[self._protectionObj.title.namespace]
−
local username = self._username
+
or pagetypes.default
−
username = username or self._titleObj.baseText
+
or error('no default pagetype defined', 8)
−
return mVandalM.luaMain{username}
 
 
end
 
end
  
−
function Blurb:_makeProtectionLevelParameter()
+
function Blurb:_makeProtectionBlurbParameter()
−
-- parameter $7
+
local protectionBlurbs = self._cfg.protectionBlurbs
−
local action = self._protectionStatusObj:getAction()
+
local action = self._protectionObj.action
−
local level = self._protectionStatusObj:getLevel()
+
local level = self._protectionObj.level
−
local key
+
local msg
−
if action == 'edit' then
+
if protectionBlurbs[action][level] then
−
if level == 'sysop' then
+
msg = protectionBlurbs[action][level]
−
key = 'protection-level-full'
+
elseif protectionBlurbs[action].default then
−
elseif level == 'templateeditor' then
+
msg = protectionBlurbs[action].default
−
key = 'protection-level-template'
+
elseif protectionBlurbs.edit.default then
−
elseif level == 'autoconfirmed' then
+
msg = protectionBlurbs.edit.default
−
key = 'protection-level-semi'
 
−
end
 
−
elseif action == 'move' then
 
−
key = 'protection-level-move'
 
−
elseif action == 'create' then
 
−
key = 'protection-level-create'
 
 
else
 
else
−
key = 'protection-level-default'
+
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
 
end
 
end
−
return self._configObj:getMessage(key)
+
return self:_substituteParameters(msg)
 
end
 
end
  
−
function Blurb:_makeExpiryParameter()
+
function Blurb:_makeProtectionDateParameter()
−
-- parameter $8
+
local protectionDate = self._protectionObj.protectionDate
−
-- @TODO: Check to see if the expiry is valid.
+
if type(protectionDate) == 'number' then
−
local expiry = self._protectionStatusObj:getExpiry()
+
return self:_formatDate(protectionDate)
−
if expiry then
 
−
return ' until ' .. expiry
 
 
else
 
else
−
return ''
+
return protectionDate
 
end
 
end
 
end
 
end
  
−
function Blurb:_makeDisputeLinkParameter()
+
function Blurb:_makeProtectionLevelParameter()
−
-- parameter $9
+
local protectionLevels = self._cfg.protectionLevels
−
-- A link to the page history or the move log, depending on the kind of
+
local action = self._protectionObj.action
−
-- protection.
+
local level = self._protectionObj.level
−
local action = self._protectionStatusObj:getAction()
+
local msg
−
local pagename = self._titleObj.prefixedText
+
if protectionLevels[action][level] then
−
if action == 'move' then
+
msg = protectionLevels[action][level]
−
-- We need the move log link.
+
elseif protectionLevels[action].default then
−
return self.makeFullUrl(
+
msg = protectionLevels[action].default
−
'Special:Log',
+
elseif protectionLevels.edit.default then
−
{type = 'move', page = pagename},
+
msg = protectionLevels.edit.default
−
self._configObj:getMessage('dispute-move-link-display')
 
−
)
 
 
else
 
else
−
-- We need the history link.
+
error('no protection level defined for protectionLevels.edit.default', 8)
−
return self.makeFullUrl(
 
−
pagename,
 
−
{action = 'history'},
 
−
self._configObj:getMessage('dispute-edit-link-display')
 
−
)
 
 
end
 
end
 +
return self:_substituteParameters(msg)
 
end
 
end
  
 
function Blurb:_makeProtectionLogParameter()
 
function Blurb:_makeProtectionLogParameter()
−
-- parameter $10
+
local pagename = self._protectionObj.title.prefixedText
−
local action = self._protectionStatusObj:getAction()
+
if self._protectionObj.action == 'autoreview' then
−
if action == 'autoreview' then
 
 
-- We need the pending changes log.
 
-- We need the pending changes log.
−
return self.makeFullUrl(
+
return makeFullUrl(
 
'Special:Log',
 
'Special:Log',
 
{type = 'stable', page = pagename},
 
{type = 'stable', page = pagename},
−
self._configObj:getMessage('more-details-pc-log-display')
+
self:_getExpandedMessage('pc-log-display')
 
)
 
)
 
else
 
else
 
-- We need the protection log.
 
-- We need the protection log.
−
return self.makeFullUrl(
+
return makeFullUrl(
 
'Special:Log',
 
'Special:Log',
 
{type = 'protect', page = pagename},
 
{type = 'protect', page = pagename},
−
self._configObj:getMessage('more-details-protection-log-display')
+
self:_getExpandedMessage('protection-log-display')
 
)
 
)
 
end
 
end
 
end
 
end
  
−
function Blurb:_makeTalkLinkParameter()
+
function Blurb:_makeTalkPageParameter()
−
-- parameter $11
+
return string.format(
−
local section = self._section
 
−
local display = self._configObj:getMessage('talk-page-link-display')
 
−
return string.format(
 
 
'[[%s:%s#%s|%s]]',
 
'[[%s:%s#%s|%s]]',
−
mw.site.namespaces[self._titleObj.namespace].talk.name,
+
mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
−
self._titleObj.text,
+
self._protectionObj.title.text,
−
section or 'top',
+
self._args.section or 'top',
−
display
+
self:_getExpandedMessage('talk-page-link-display')
 
)
 
)
 
end
 
end
  
−
function Blurb:_makeEditRequestParameter()
+
function Blurb:_makeTooltipBlurbParameter()
−
-- parameter $12
+
if self._protectionObj:isTemporary() then
−
local mEditRequest = require('Module:Submit an edit request')
+
return self:_getExpandedMessage('tooltip-blurb-expiry')
−
local action = self._protectionStatusObj:getAction()
 
−
local level = self._protectionStatusObj:getLevel()
 
−
 
−
-- Get the display message key.
 
−
local key
 
−
if action == 'edit' and level == 'autoconfirmed' then
 
−
key = 'edit-request-semi-display'
 
 
else
 
else
−
key = 'edit-request-full-display'
+
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
−
end
 
−
local display = self._configObj:getMessage(key)
 
−
 
−
-- Get the edit request type.
 
−
local requestType
 
−
if action == 'edit' then
 
−
if level == 'autoconfirmed' then
 
−
requestType = 'semi'
 
−
elseif level == 'templateeditor' then
 
−
requestType = 'template'
 
−
end
 
 
end
 
end
−
requestType = requestType or 'full'
 
−
 
−
return mEditRequest.exportLinkToLua{type = requestType, display = display}
 
 
end
 
end
  
−
function Blurb:_makeRequestUnprotectionParameter()
+
function Blurb:_makeTooltipFragmentParameter()
−
-- parameter $13
+
if self._protectionObj:isTemporary() then
−
if self._titleObj.namespace ~= 8 then
+
return self:_getExpandedMessage('tooltip-fragment-expiry')
−
-- MediaWiki pages can't be unprotected.
+
else
−
return self._configObj:getMessage('request-unprotection-blurb')
+
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
 
end
 
end
 
end
 
end
  
−
function Blurb:_makeSubjectPageLinksParameter()
+
function Blurb:_makeVandalTemplateParameter()
−
-- parameter $14
+
return require('Module:Vandal-m')._main{
−
-- Don't display these links if we are on a talk page.
+
self._args.user or self._protectionObj.title.baseText
−
if not self._titleObj.isTalkPage then
+
}
−
local msg = self._config:getMessage('semi-subject-page-links')
 
−
return self._substituteParameters(msg)
 
−
end
 
 
end
 
end
  
−
function Blurb:_makeDeletionBlurbParameter()
+
-- Public methods --
−
-- parameter $15
+
 
−
local deletionDiscussionPage = self._deletionDiscussionPage
+
function Blurb:makeBannerText(key)
−
local key
+
-- Validate input.
−
if deletionDiscussionPage then
+
if not key or not Blurb.bannerTextFields[key] then
−
key = 'deletion-discussion-blurb-xfd'
+
error(string.format(
−
else
+
'"%s" is not a valid banner config field',
−
key = 'deletion-discussion-blurb-noxfd'
+
tostring(key)
 +
), 2)
 
end
 
end
−
local msg = self._configObj:getMessage(msg)
 
−
return self._substituteParameters(msg)
 
−
end
 
  
−
function Blurb:_makeDeletionDiscussionLinkParameter()
+
-- Generate the text.
−
-- parameter $16
+
local msg = self._protectionObj.bannerConfig[key]
−
local deletionDiscussionPage = self._deletionDiscussionPage
+
if type(msg) == 'string' then
−
if deletionDiscussionPage then
+
return self:_substituteParameters(msg)
−
local display = self._configObj:getMessage('deletion-discussion-link-display')
+
elseif type(msg) == 'function' then
−
return string.format('[[%s|%s]]', deletionDiscussionPage, display)
+
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
−
end
 
−
 
−
function Blurb:_makeDeletionLogParameter()
 
−
-- parameter $17
 
−
return Blurb.makeFullUrl(
 
−
'Special:Log',
 
−
{type = 'delete', page = self._titleObj.prefixedText},
 
−
self._configObj:getMessage('deletion-log-link-display')
 
−
)
 
−
end
 
−
 
−
function Blurb:makeReasonText()
 
−
local msg = self._bannerConfig.text
 
−
return self:_substituteParameters(msg)
 
−
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
 
end
  
Line 478: Line 675:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local BannerTemplate = class('BannerTemplate')
+
local BannerTemplate = {}
 +
BannerTemplate.__index = BannerTemplate
  
−
function BannerTemplate:initialize(configObj)
+
function BannerTemplate.new(protectionObj, cfg)
−
self._configObj = configObj
+
local obj = {}
−
end
+
obj._cfg = cfg
  
−
function BannerTemplate:setImageFilename(filename, action, level, namespace, expiry)
+
-- Set the image filename.
−
if filename then
+
local imageFilename = protectionObj.bannerConfig.image
−
self._imageFilename = filename
+
if imageFilename then
−
return nil
+
obj._imageFilename = imageFilename
−
end
+
else
−
+
-- If an image filename isn't specified explicitly in the banner config,
−
if not action or not level then
+
-- generate it from the protection status and the namespace.
−
-- If the filename is not specified, we need the action and the level
+
local action = protectionObj.action
−
-- to find the image name. The namespace and the expiry are optional,
+
local level = protectionObj.level
−
-- however.
+
local namespace = protectionObj.title.namespace
−
return nil
+
local reason = protectionObj.reason
−
end
+
−
+
-- Deal with special cases first.
−
-- Deal with special cases first.
+
if (
−
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check?
+
namespace == 10
−
and action == 'edit'
+
or namespace == 828
−
and level == 'sysop'
+
or reason and obj._cfg.indefImageReasons[reason]
−
and not expiry
+
)
−
then
+
and action == 'edit'
−
-- Fully protected modules and templates get the special red "indef"
+
and level == 'sysop'
−
-- padlock.
+
and not protectionObj:isTemporary()
−
self._imageFilename = self._configObj:getMessage('image-filename-indef')
+
then
−
return nil
+
-- Fully protected modules and templates get the special red "indef"
−
end
+
-- padlock.
−
+
obj._imageFilename = obj._cfg.msg['image-filename-indef']
−
-- Deal with regular protection types.
+
else
−
local images = self._configObj:getConfigTable('images')
+
-- Deal with regular protection types.
−
if images[action] then
+
local images = obj._cfg.images
−
if images[action][level] then
+
if images[action] then
−
self._imageFilename = images[action][level]
+
if images[action][level] then
−
return nil
+
obj._imageFilename = images[action][level]
−
elseif images[action].default then
+
elseif images[action].default then
−
self._imageFilename = images[action].default
+
obj._imageFilename = images[action].default
−
return nil
+
end
 +
end
 
end
 
end
 
end
 
end
−
 
+
return setmetatable(obj, BannerTemplate)
−
return nil
 
−
end
 
−
 
 
−
function BannerTemplate:setImageWidth(width)
 
−
self._imageWidth = width
 
−
end
 
−
 
 
−
function BannerTemplate:setImageAlt(alt)
 
−
self._imageAlt = alt
 
−
end
 
−
 
 
−
function BannerTemplate:setImageLink(link)
 
−
self._imageLink = link
 
−
end
 
−
 
 
−
function BannerTemplate:setImageCaption(caption)
 
−
self._imageCaption = caption
 
 
end
 
end
  
 
function BannerTemplate:renderImage()
 
function BannerTemplate:renderImage()
−
local filename = self._filename
+
local filename = self._imageFilename
−
or self._configObj:getMessage('image-filename-default')
+
or self._cfg.msg['image-filename-default']
 
or 'Transparent.gif'
 
or 'Transparent.gif'
−
return mFileLink.new(filename)
+
return makeFileLink{
−
:width(self._imageWidth or 20)
+
file = filename,
−
:alt(self._imageAlt)
+
size = (self.imageWidth or 20) .. 'px',
−
:link(self._imageLink)
+
alt = self._imageAlt,
−
:caption(self._imageCaption)
+
link = self._imageLink,
−
:render()
+
caption = self.imageCaption
−
end
+
}
−
 
 
−
function BannerTemplate:render()
 
−
-- Dummy method, to be implemented by the subclasses.
 
−
return ''
 
 
end
 
end
  
Line 561: Line 739:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Banner = BannerTemplate:subclass('Banner')
+
local Banner = setmetatable({}, BannerTemplate)
 +
Banner.__index = Banner
  
−
function Banner:initialize()
+
function Banner.new(protectionObj, blurbObj, cfg)
−
self:setImageWidth(40)
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
 +
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
 
end
  
−
--------------------------------------------------------------------------------
+
function Banner:__tostring()
−
-- Padlock class
+
-- Renders the banner.
−
--------------------------------------------------------------------------------
+
makeMessageBox = makeMessageBox or require('Module:Message box').main
−
 
+
local reasonText = self._reasonText or error('no reason text set', 2)
−
local Padlock = BannerTemplate:subclass('Padlock')
+
local explanationText = self._explanationText
−
 
+
local mbargs = {
−
function Padlock:initialize()
+
page = self._page,
−
self:setImageWidth(20)
+
type = 'protection',
 +
image = self:renderImage(),
 +
text = string.format(
 +
"'''%s'''%s",
 +
reasonText,
 +
explanationText and '<br />' .. explanationText or ''
 +
)
 +
}
 +
return makeMessageBox('mbox', mbargs)
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Category class
+
-- Padlock class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Category = class('Category')
+
local Padlock = setmetatable({}, BannerTemplate)
 +
Padlock.__index = Padlock
  
−
function Category:initialize()
+
function Padlock.new(protectionObj, blurbObj, cfg)
 +
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
 +
obj.imageWidth = 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
 
end
  
−
function Category:setName(name)
+
function Padlock:__tostring()
−
self._name = name
+
local frame = mw.getCurrentFrame()
−
end
+
-- The nowiki tag helps prevent whitespace at the top of articles.
−
 
+
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
−
function Category:export()
+
name = 'indicator',
−
if self._categoryName then
+
args = {name = self._indicatorName},
−
return string.format(
+
content = self:renderImage()
−
'[[%s:%s]]',
+
}
−
mw.site.namespaces[14].name,
 
−
self._categoryName
 
−
)
 
−
else
 
−
return ''
 
−
end
 
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ProtectionCategory class
+
-- Exports
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ProtectionCategory = Category:subclass('ProtectionCategory')
+
local p = {}
  
−
function ProtectionCategory:setName(
+
function p._exportClasses()
−
name,
+
-- This is used for testing purposes.
−
configObj,
+
return {
−
protectionStatusObj,
+
Protection = Protection,
−
namespace
+
Blurb = Blurb,
−
)
+
BannerTemplate = BannerTemplate,
−
--[[
+
Banner = Banner,
−
-- Sets the protection category. If a category name is not provided, this
+
Padlock = Padlock,
−
-- method gets a category name from the module config, given a combination
 
−
-- of the protection type, the protection level, the namespace number, the
 
−
-- reason for protection, and the expiry date.
 
−
--]]
 
−
 
−
-- If a name was provided, use that.
 
−
if name then
 
−
Category.setName(self, name)
 
−
end
 
−
 
−
-- 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
 
end
  
−
--------------------------------------------------------------------------------
+
function p._main(args, cfg, title)
−
-- ExpiryCategory class
+
args = args or {}
−
--------------------------------------------------------------------------------
+
cfg = cfg or require(CONFIG_MODULE)
  
−
local ExpiryCategory = Category:subclass('ExpiryCategory')
+
local protectionObj = Protection.new(args, cfg, title)
  
−
--------------------------------------------------------------------------------
+
local ret = {}
−
-- ErrorCategory class
 
−
--------------------------------------------------------------------------------
 
  
−
local ErrorCategory = Category:subclass('ErrorCategory')
+
-- If a page's edit protection is equally or more restrictive than its
 +
-- protection from some other action, then don't bother displaying anything
 +
-- for the other action (except categories).
 +
if 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
−
-- ProtectionBanner class
+
if yesno(args.category) ~= false then
−
--------------------------------------------------------------------------------
+
ret[#ret + 1] = protectionObj:makeCategoryLinks()
−
 
+
end
−
local ProtectionBanner = {}
+
−
 
+
return table.concat(ret)
−
function ProtectionBanner.exportToWiki(frame, title)
 
−
local args = mArguments.getArgs(frame)
 
−
return ProtectionBanner.exportToLua(args, title)
 
 
end
 
end
  
−
function ProtectionBanner.exportToLua(args, title)
+
function p.main(frame, cfg)
−
title = title or mw.title.getCurrentTitle()
+
cfg = cfg or require(CONFIG_MODULE)
  
−
-- Get data objects
+
-- Find default args, if any.
−
local theProtectionStatus = ProtectionStatus:new(args, title)
+
local parent = frame.getParent and frame:getParent()
−
local theConfig = Config:new()
+
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
  
−
local ret = {}
+
-- 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
 +
})
  
−
-- Render the banner
+
-- Build the args table. User-specified args overwrite default args.
−
local theBanner
+
local args = {}
−
if yesno(args.small) then
+
for k, v in pairs(defaultArgs or {}) do
−
theBanner = Padlock.new(theConfig, theProtectionStatus, title)
+
args[k] = v
−
else
+
end
−
theBanner = Banner.new(theConfig, theProtectionStatus, title)
+
for k, v in pairs(userArgs) do
 +
args[k] = v
 
end
 
end
−
theBanner = Padlock.new(theConfig, theProtectionStatus, title)
+
return p._main(args, cfg)
−
theBanner:setDeletionDiscussionPage(args.xfd)
 
−
theBanner:setUsername(args.user)
 
−
theBanner:setSection(args.section)
 
−
ret[#ret + 1] = theBanner:render()
 
−
 
−
-- Render the categories
 
−
 
 
−
return table.concat(ret)
 
−
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
 
end
  
−
return ProtectionBanner
+
return p

Latest revision as of 18:47, 2 November 2019

Documentation for this module may be created at Module:Protection banner/doc 

-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.

-- Initialise necessary modules.
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
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'

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function makeCategoryLink(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
local function validateDate(dateString, dateType)
	if not lang then
		lang = mw.language.getContentLanguage()
	end
	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)
	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

--------------------------------------------------------------------------------
-- 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(
			'invalid action: %s',
			tostring(args.action)
		), 3)
	end

	-- Set level
	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
	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(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 Protection:isProtected()
	return self.level ~= '*'
end

function Protection:isTemporary()
	return type(self.expiry) == 'number'
end

function Protection:makeProtectionCategory()
	local cfg = self._cfg
	local title = self.title
	
	-- Exit if the page is not protected.
	if not self:isProtected() then
		return ''
	end
	
	-- Get the expiry key fragment.
	local expiryFragment
	if self.expiry == 'indef' then
		expiryFragment = self.expiry
	elseif type(self.expiry) == 'number' then
		expiryFragment = 'temp'
	end

	-- Get the namespace key fragment.
	local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
	if not namespaceFragment and title.namespace % 2 == 1 then
			namespaceFragment = 'talk'
	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}
	}

	--[[
	-- 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 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 Protection:isIncorrect()
	local expiry = self.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

--------------------------------------------------------------------------------
-- Blurb class
--------------------------------------------------------------------------------

local Blurb = {}
Blurb.__index = Blurb

Blurb.bannerTextFields = {
	text = true,
	explanation = true,
	tooltip = true,
	alt = true,
	link = true
}

function Blurb.new(protectionObj, args, cfg)
	return setmetatable({
		_cfg = cfg,
		_protectionObj = protectionObj,
		_args = args
	}, Blurb)
end

-- Private methods --

function Blurb:_formatDate(num)
	-- Formats a Unix timestamp into dd Month, YYYY format.
	lang = lang or mw.language.getContentLanguage()
	local success, date = pcall(
		lang.formatDate,
		lang,
		self._cfg.msg['expiry-date-format'] or 'j F Y',
		'@' .. tostring(num)
	)
	if success then
		return date
	end
end

function Blurb:_getExpandedMessage(msgKey)
	return self:_substituteParameters(self._cfg.msg[msgKey])
end

function Blurb:_substituteParameters(msg)
	if not self._params then
		local parameterFuncs = {}

		parameterFuncs.CURRENTVERSION     = self._makeCurrentVersionParameter
		parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
		parameterFuncs.EXPIRY             = self._makeExpiryParameter
		parameterFuncs.EXPLANATIONBLURB   = self._makeExplanationBlurbParameter
		parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
		parameterFuncs.INTROBLURB         = self._makeIntroBlurbParameter
		parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
		parameterFuncs.PAGETYPE           = self._makePagetypeParameter
		parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
		parameterFuncs.PROTECTIONDATE     = self._makeProtectionDateParameter
		parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
		parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
		parameterFuncs.TALKPAGE           = self._makeTalkPageParameter
		parameterFuncs.TOOLTIPBLURB       = self._makeTooltipBlurbParameter
		parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
		parameterFuncs.VANDAL             = self._makeVandalTemplateParameter
		
		self._params = setmetatable({}, {
			__index = function (t, k)
				local param
				if parameterFuncs[k] then
					param = parameterFuncs[k](self)
				end
				param = param or ''
				t[k] = param
				return param
			end
		})
	end
	
	msg = msg:gsub('${(%u+)}', self._params)
	return msg
end

function Blurb:_makeCurrentVersionParameter()
	-- A link to the page history or the move log, depending on the kind of
	-- protection.
	local pagename = self._protectionObj.title.prefixedText
	if self._protectionObj.action == 'move' then
		-- We need the move log link.
		return makeFullUrl(
			'Special:Log',
			{type = 'move', page = pagename},
			self:_getExpandedMessage('current-version-move-display')
		)
	else
		-- We need the history link.
		return makeFullUrl(
			pagename,
			{action = 'history'},
			self:_getExpandedMessage('current-version-edit-display')
		)
	end
end

function Blurb:_makeEditRequestParameter()
	local mEditRequest = require('Module:Submit an edit request')
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	
	-- Get the edit request type.
	local requestType
	if action == 'edit' then
		if level == 'autoconfirmed' then
			requestType = 'semi'
		elseif level == 'extendedconfirmed' then
			requestType = 'extended'
		elseif level == 'templateeditor' then
			requestType = 'template'
		end
	end
	requestType = requestType or 'full'
	
	-- Get the display value.
	local display = self:_getExpandedMessage('edit-request-display')

	return mEditRequest._link{type = requestType, display = display}
end

function Blurb:_makeExpiryParameter()
	local expiry = self._protectionObj.expiry
	if type(expiry) == 'number' then
		return self:_formatDate(expiry)
	else
		return expiry
	end
end

function Blurb:_makeExplanationBlurbParameter()
	-- Cover special cases first.
	if self._protectionObj.title.namespace == 8 then
		-- MediaWiki namespace
		return self:_getExpandedMessage('explanation-blurb-nounprotect')
	end

	-- Get explanation blurb table keys
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'

	-- Find the message in the explanation blurb table and substitute any
	-- parameters.
	local explanations = self._cfg.explanationBlurbs
	local msg
	if explanations[action][level] and explanations[action][level][talkKey] then
		msg = explanations[action][level][talkKey]
	elseif explanations[action][level] and explanations[action][level].default then
		msg = explanations[action][level].default
	elseif explanations[action].default and explanations[action].default[talkKey] then
		msg = explanations[action].default[talkKey]
	elseif explanations[action].default and explanations[action].default.default then
		msg = explanations[action].default.default
	else
		error(string.format(
			'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
			action,
			level,
			talkKey
		), 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeImageLinkParameter()
	local imageLinks = self._cfg.imageLinks
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if imageLinks[action][level] then
		msg = imageLinks[action][level]
	elseif imageLinks[action].default then
		msg = imageLinks[action].default
	else
		msg = imageLinks.edit.default
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeIntroBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-blurb-expiry')
	else
		return self:_getExpandedMessage('intro-blurb-noexpiry')
	end
end

function Blurb:_makeIntroFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-fragment-expiry')
	else
		return self:_getExpandedMessage('intro-fragment-noexpiry')
	end
end

function Blurb:_makePagetypeParameter()
	local pagetypes = self._cfg.pagetypes
	return pagetypes[self._protectionObj.title.namespace]
		or pagetypes.default
		or error('no default pagetype defined', 8)
end

function Blurb:_makeProtectionBlurbParameter()
	local protectionBlurbs = self._cfg.protectionBlurbs
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if protectionBlurbs[action][level] then
		msg = protectionBlurbs[action][level]
	elseif protectionBlurbs[action].default then
		msg = protectionBlurbs[action].default
	elseif protectionBlurbs.edit.default then
		msg = protectionBlurbs.edit.default
	else
		error('no protection blurb defined for protectionBlurbs.edit.default', 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionDateParameter()
	local protectionDate = self._protectionObj.protectionDate
	if type(protectionDate) == 'number' then
		return self:_formatDate(protectionDate)
	else
		return protectionDate
	end
end

function Blurb:_makeProtectionLevelParameter()
	local protectionLevels = self._cfg.protectionLevels
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if protectionLevels[action][level] then
		msg = protectionLevels[action][level]
	elseif protectionLevels[action].default then
		msg = protectionLevels[action].default
	elseif protectionLevels.edit.default then
		msg = protectionLevels.edit.default
	else
		error('no protection level defined for protectionLevels.edit.default', 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionLogParameter()
	local pagename = self._protectionObj.title.prefixedText
	if self._protectionObj.action == 'autoreview' then
		-- We need the pending changes log.
		return makeFullUrl(
			'Special:Log',
			{type = 'stable', page = pagename},
			self:_getExpandedMessage('pc-log-display')
		)
	else
		-- We need the protection log.
		return makeFullUrl(
			'Special:Log',
			{type = 'protect', page = pagename},
			self:_getExpandedMessage('protection-log-display')
		)
	end
end

function Blurb:_makeTalkPageParameter()
	return string.format(
		'[[%s:%s#%s|%s]]',
		mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
		self._protectionObj.title.text,
		self._args.section or 'top',
		self:_getExpandedMessage('talk-page-link-display')
	)
end

function Blurb:_makeTooltipBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-blurb-expiry')
	else
		return self:_getExpandedMessage('tooltip-blurb-noexpiry')
	end
end

function Blurb:_makeTooltipFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-fragment-expiry')
	else
		return self:_getExpandedMessage('tooltip-fragment-noexpiry')
	end
end

function Blurb:_makeVandalTemplateParameter()
	return require('Module:Vandal-m')._main{
		self._args.user or self._protectionObj.title.baseText
	}
end

-- Public methods --

function Blurb:makeBannerText(key)
	-- Validate input.
	if not key or not Blurb.bannerTextFields[key] then
		error(string.format(
			'"%s" is not a valid banner config field',
			tostring(key)
		), 2)
	end

	-- Generate the text.
	local msg = self._protectionObj.bannerConfig[key]
	if type(msg) == 'string' then
		return self:_substituteParameters(msg)
	elseif type(msg) == 'function' then
		msg = msg(self._protectionObj, self._args)
		if type(msg) ~= 'string' then
			error(string.format(
				'bad output from banner config function with key "%s"'
					.. ' (expected string, got %s)',
				tostring(key),
				type(msg)
			), 4)
		end
		return self:_substituteParameters(msg)
	end
end

--------------------------------------------------------------------------------
-- BannerTemplate class
--------------------------------------------------------------------------------

local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate

function BannerTemplate.new(protectionObj, cfg)
	local obj = {}
	obj._cfg = cfg

	-- Set the image filename.
	local imageFilename = protectionObj.bannerConfig.image
	if imageFilename then
		obj._imageFilename = imageFilename
	else
		-- If an image filename isn't specified explicitly in the banner config,
		-- generate it from the protection status and the namespace.
		local action = protectionObj.action
		local level = protectionObj.level
		local namespace = protectionObj.title.namespace
		local reason = protectionObj.reason
		
		-- Deal with special cases first.
		if (
			namespace == 10
			or namespace == 828
			or reason and obj._cfg.indefImageReasons[reason]
			)
			and action == 'edit'
			and level == 'sysop'
			and not protectionObj:isTemporary()
		then
			-- Fully protected modules and templates get the special red "indef"
			-- padlock.
			obj._imageFilename = obj._cfg.msg['image-filename-indef']
		else
			-- Deal with regular protection types.
			local images = obj._cfg.images
			if images[action] then
				if images[action][level] then
					obj._imageFilename = images[action][level]
				elseif images[action].default then
					obj._imageFilename = images[action].default
				end
			end
		end
	end
	return setmetatable(obj, BannerTemplate)
end

function BannerTemplate:renderImage()
	local filename = self._imageFilename
		or self._cfg.msg['image-filename-default']
		or 'Transparent.gif'
	return makeFileLink{
		file = filename,
		size = (self.imageWidth or 20) .. 'px',
		alt = self._imageAlt,
		link = self._imageLink,
		caption = self.imageCaption
	}
end

--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------

local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner

function Banner.new(protectionObj, blurbObj, cfg)
	local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
	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:__tostring()
	-- 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 = {
		page = self._page,
		type = 'protection',
		image = self:renderImage(),
		text = string.format(
			"'''%s'''%s",
			reasonText,
			explanationText and '<br />' .. explanationText or ''
		)
	}
	return makeMessageBox('mbox', mbargs)
end

--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------

local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock

function Padlock.new(protectionObj, blurbObj, cfg)
	local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
	obj.imageWidth = 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:__tostring()
	local frame = mw.getCurrentFrame()
	-- The nowiki tag helps prevent whitespace at the top of articles.
	return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
		name = 'indicator',
		args = {name = self._indicatorName},
		content = self:renderImage()
	}
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p = {}

function p._exportClasses()
	-- This is used for testing purposes.
	return {
		Protection = Protection,
		Blurb = Blurb,
		BannerTemplate = BannerTemplate,
		Banner = Banner,
		Padlock = Padlock,
	}
end

function p._main(args, cfg, title)
	args = args or {}
	cfg = cfg or require(CONFIG_MODULE)

	local protectionObj = Protection.new(args, cfg, title)

	local ret = {}

	-- If a page's edit protection is equally or more restrictive than its
	-- protection from some other action, then don't bother displaying anything
	-- for the other action (except categories).
	if 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 p.main(frame, cfg)
	cfg = cfg or require(CONFIG_MODULE)

	-- Find default args, if any.
	local parent = frame.getParent and frame:getParent()
	local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]

	-- Find user args, and use the parent frame if we are being called from a
	-- wrapper template.
	getArgs = getArgs or require('Module:Arguments').getArgs
	local userArgs = getArgs(frame, {
		parentOnly = defaultArgs,
		frameOnly = not defaultArgs
	})

	-- Build the args table. User-specified args overwrite default args.
	local args = {}
	for k, v in pairs(defaultArgs or {}) do
		args[k] = v
	end
	for k, v in pairs(userArgs) do
		args[k] = v
	end
	return p._main(args, cfg)
end

return p
Retrieved from "https://amanitaresearch.com/index.php?title=Module:Protection_banner&oldid=3926"