Difference between revisions of "Module:Protection banner"

From Timelines
Jump to: navigation, search
(now reason)
m (1 revision imported: image crop)
 
(97 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 newFileLink = require('Module:File link').new
 
 
local effectiveProtectionLevel = require('Module:Effective protection level')._main
 
local effectiveProtectionLevel = require('Module:Effective protection level')._main
 +
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
 
local yesno = require('Module:Yesno')
 
local yesno = require('Module:Yesno')
  
 
-- Lazily initialise modules and objects we don't always need.
 
-- Lazily initialise modules and objects we don't always need.
−
local mArguments, mMessageBox, lang, config
+
local getArgs, makeMessageBox, lang
 +
 
 +
-- Set constants.
 +
local CONFIG_MODULE = 'Module:Protection banner/config'
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Protection class
+
-- Helper functions
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Protection = class('Protection')
+
local function makeCategoryLink(cat, sort)
 +
if cat then
 +
return string.format(
 +
'[[%s:%s|%s]]',
 +
mw.site.namespaces[14].name,
 +
cat,
 +
sort
 +
)
 +
end
 +
end
  
−
function Protection:initialize(args, configObj, 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
  
−
-- Set level
+
local function makeFullUrl(page, query, display)
−
do
+
return string.format(
−
local level = effectiveProtectionLevel(self.action, titleObj)
+
'[%s %s]',
−
if level == 'accountcreator' then
+
tostring(mw.uri.fullUrl(page, query)),
−
-- Lump titleblacklisted pages in with template-protected pages,
+
display
−
-- since templateeditors can do both.
+
)
−
level = 'templateeditor'
+
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
 
end
−
if self.action == 'move' and level == 'autoconfirmed' then
+
toWalk[k] = nil
−
-- Users need to be autoconfirmed to move pages anyway, so treat
+
retval[k] = true
−
-- semi-move-protected pages as unprotected.
+
for _,v in ipairs(graph[k]) do
−
level = '*'
+
if not retval[v] then
 +
toWalk[v] = true
 +
end
 
end
 
end
−
self.level = level or '*'
+
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
 
end
  
−
-- Validation function for the expiry and the protection date
+
-- Set level
−
local function validateDate(date, dateType)
+
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
−
lang = lang or mw.language.getContentLanguage()
+
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
−
local success, expiry = pcall(lang.formatDate, lang, 'U', args.expiry)
+
-- Users need to be autoconfirmed to move pages anyway, so treat
−
expiry = tonumber(expiry)
+
-- semi-move-protected pages as unprotected.
−
if success and expiry then
+
obj.level = '*'
−
return expiry
 
−
else
 
−
return string.format(
 
−
'<strong class="error">Error: invalid %s ("%s")</strong>',
 
−
dateType,
 
−
tostring(args.expiry)
 
−
)
 
−
end
 
 
end
 
end
  
 
-- Set expiry
 
-- Set expiry
−
if args.expiry then
+
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
−
local indefStrings = configObj.cfg.indefStrings
+
if effectiveExpiry == 'infinity' then
−
if indefStrings[args.expiry] then
+
obj.expiry = 'indef'
−
self._expiry = 'indef'
+
elseif effectiveExpiry ~= 'unknown' then
−
elseif type(args.expiry) == 'number' then
+
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
−
self._expiry = args.expiry
 
−
else
 
−
self._expiry = validateDate(args.expiry, 'expiry date')
 
−
end
 
 
end
 
end
  
 
-- Set reason
 
-- Set reason
−
do
+
if args[1] then
−
local reason = args.reason or args[1]
+
obj.reason = mw.ustring.lower(args[1])
−
if reason then
+
if obj.reason:find('|') then
−
self.reason = reason:lower()
+
error('reasons cannot contain the pipe character ("|")', 3)
 
end
 
end
 
end
 
end
  
 
-- Set protection date
 
-- Set protection date
−
self._protectionDate = validateDate(args.date, 'protection date')
+
if args.date then
 +
obj.protectionDate = validateDate(args.date, 'protection date')
 +
end
 
 
 
-- Set banner config
 
-- Set banner config
 
do
 
do
−
self.bannerConfig = {}
+
obj.bannerConfig = {}
−
local cfg = configObj.cfg
 
−
local fields = {
 
−
'text',
 
−
'explanation',
 
−
'tooltip',
 
−
'alt',
 
−
'link',
 
−
'image'
 
−
}
 
 
local configTables = {}
 
local configTables = {}
−
if cfg.banners[self.action] then
+
if cfg.banners[obj.action] then
−
configTables[#configTables + 1] = cfg.banners[self.action][self.reason]
+
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
 
end
 
end
−
if cfg.defaultBanners[self.action] then
+
if cfg.defaultBanners[obj.action] then
−
configTables[#configTables + 1] = cfg.defaultBanners[self.action][self.level]
+
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
−
configTables[#configTables + 1] = cfg.defaultBanners[self.action].default
+
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
 
end
 
end
 
configTables[#configTables + 1] = cfg.masterBanner
 
configTables[#configTables + 1] = cfg.masterBanner
−
for i, field in ipairs(fields) do
+
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
−
self.bannerConfig[field] = t[field]
+
obj.bannerConfig[field] = t[field]
 
break
 
break
 
end
 
end
Line 119: Line 168:
 
end
 
end
 
end
 
end
 +
return setmetatable(obj, Protection)
 
end
 
end
  
 
function Protection:isProtected()
 
function Protection:isProtected()
 
return self.level ~= '*'
 
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
 
end
  
Line 129: Line 344:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Blurb = class('Blurb')
+
local Blurb = {}
 +
Blurb.__index = Blurb
  
−
function Blurb:initialize(configObj, protectionObj, titleObj)
+
Blurb.bannerTextFields = {
−
self._configObj = configObj
+
text = true,
−
self._protectionObj = protectionObj
+
explanation = true,
−
self._bannerConfig = protectionObj.bannerConfig
+
tooltip = true,
−
self._titleObj = titleObj
+
alt = true,
 +
link = true
 +
}
 +
 
 +
function Blurb.new(protectionObj, args, cfg)
 +
return setmetatable({
 +
_cfg = cfg,
 +
_protectionObj = protectionObj,
 +
_args = args
 +
}, Blurb)
 
end
 
end
  
−
-- Static methods --
+
-- Private methods --
−
 
 
−
function Blurb.makeFullUrl(page, query, display)
 
−
local url = mw.uri.fullUrl(page, query)
 
−
url = tostring(url)
 
−
return string.format('[%s %s]', url, display)
 
−
end
 
  
−
function Blurb.formatDate(num)
+
function Blurb:_formatDate(num)
 
-- Formats a Unix timestamp into dd Month, YYYY format.
 
-- Formats a Unix timestamp into dd Month, YYYY format.
 
lang = lang or mw.language.getContentLanguage()
 
lang = lang or mw.language.getContentLanguage()
Line 152: Line 371:
 
lang.formatDate,
 
lang.formatDate,
 
lang,
 
lang,
−
'j F Y',
+
self._cfg.msg['expiry-date-format'] or 'j F Y',
 
'@' .. tostring(num)
 
'@' .. tostring(num)
 
)
 
)
Line 160: Line 379:
 
end
 
end
  
−
-- Private methods --
+
function Blurb:_getExpandedMessage(msgKey)
−
 
+
return self:_substituteParameters(self._cfg.msg[msgKey])
−
function Blurb:_getExpandedMessage(msg)
 
−
local msg = self._configObj.msg[msg]
 
−
return self:_substituteParameters(msg)
 
 
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, {
 
−
__index = function (t, k)
 
−
local param
 
−
if parameterFuncs[k] then
 
−
param = parameterFuncs[k](self)
 
−
end
 
−
param = param or ''
 
−
params[k] = param
 
−
return param
 
−
end
 
−
})
 
  
 
parameterFuncs.CURRENTVERSION    = self._makeCurrentVersionParameter
 
parameterFuncs.CURRENTVERSION    = self._makeCurrentVersionParameter
−
parameterFuncs.DELETIONDISCUSSION = self._makeDeletionDiscussionParameter
 
−
parameterFuncs.DISPUTEBLURB      = self._makeDisputeBlurbParameter
 
−
parameterFuncs.DISPUTESECTION    = self._makeDisputeSectionParameter
 
 
parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
 
parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
 
parameterFuncs.EXPIRY            = self._makeExpiryParameter
 
parameterFuncs.EXPIRY            = self._makeExpiryParameter
Line 191: Line 393:
 
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
 
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
 
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
 
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
−
parameterFuncs.OFFICEBLURB        = self._makeOfficeBlurbParameter
+
parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
 
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
 
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
 
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
 
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
Line 197: Line 399:
 
parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
 
parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
 
parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
 
parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
−
parameterFuncs.RESETBLURB        = self._makeResetBlurbParameter
 
 
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
 
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
 
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
 
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
 +
parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
 
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
 
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
 
 
−
self._params = params
+
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
 
end
 
 
Line 212: Line 424:
 
-- A link to the page history or the move log, depending on the kind of
 
-- A link to the page history or the move log, depending on the kind of
 
-- protection.
 
-- protection.
−
local action = self._protectionObj.action
+
local pagename = self._protectionObj.title.prefixedText
−
local pagename = self._titleObj.prefixedText
+
if self._protectionObj.action == 'move' then
−
if action == 'move' then
 
 
-- We need the move log link.
 
-- We need the move log link.
−
return self.makeFullUrl(
+
return makeFullUrl(
 
'Special:Log',
 
'Special:Log',
 
{type = 'move', page = pagename},
 
{type = 'move', page = pagename},
Line 223: Line 434:
 
else
 
else
 
-- We need the history link.
 
-- We need the history link.
−
return self.makeFullUrl(
+
return makeFullUrl(
 
pagename,
 
pagename,
 
{action = 'history'},
 
{action = 'history'},
 
self:_getExpandedMessage('current-version-edit-display')
 
self:_getExpandedMessage('current-version-edit-display')
 
)
 
)
−
end
 
−
end
 
−
 
−
function Blurb:_makeDeletionDiscussionLinkParameter()
 
−
local deletionDiscussionPage = self._deletionDiscussionPage
 
−
if deletionDiscussionPage then
 
−
local display = self:_getExpandedMessage('deletion-discussion-link-display')
 
−
return string.format('[[%s|%s]]', deletionDiscussionPage, display)
 
−
end
 
−
end
 
−
 
−
function Blurb:_makeDisputeBlurbParameter()
 
−
local expiry = self._protectionObj:getExpiry()
 
−
if type(expiry) == 'number' then
 
−
return self:_getExpandedMessage('dispute-blurb-expiry')
 
−
else
 
−
return self:_getExpandedMessage('dispute-blurb-noexpiry')
 
−
end
 
−
end
 
−
 
−
function Blurb:_makeDisputeSectionParameter()
 
−
-- "disputes", with or without a section link
 
−
local section = self._section
 
−
local disputes = self:_getExpandedMessage('dispute-section-link-display')
 
−
if section then
 
−
return string.format(
 
−
'[[%s:%s#%s|%s]]',
 
−
mw.site.namespaces[self._titleObj.namespace].talk.name,
 
−
self._titleObj.text,
 
−
section,
 
−
disputes
 
−
)
 
−
else
 
−
return disputes
 
 
end
 
end
 
end
 
end
Line 269: Line 446:
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
−
 
−
-- Get the display message key.
 
−
local key
 
−
if action == 'edit' and level == 'autoconfirmed' then
 
−
key = 'edit-request-semi-display'
 
−
else
 
−
key = 'edit-request-full-display'
 
−
end
 
−
local display = self:_getExpandedMessage(key)
 
 
 
 
-- Get the edit request type.
 
-- Get the edit request type.
Line 284: Line 452:
 
if level == 'autoconfirmed' then
 
if level == 'autoconfirmed' then
 
requestType = 'semi'
 
requestType = 'semi'
 +
elseif level == 'extendedconfirmed' then
 +
requestType = 'extended'
 
elseif level == 'templateeditor' then
 
elseif level == 'templateeditor' then
 
requestType = 'template'
 
requestType = 'template'
Line 290: Line 460:
 
requestType = requestType or 'full'
 
requestType = requestType or 'full'
 
 
−
return mEditRequest.exportLinkToLua{type = requestType, display = display}
+
-- Get the display value.
 +
local display = self:_getExpandedMessage('edit-request-display')
 +
 
 +
return mEditRequest._link{type = requestType, display = display}
 
end
 
end
  
 
function Blurb:_makeExpiryParameter()
 
function Blurb:_makeExpiryParameter()
−
local expiry = self._protectionObj:getExpiry()
+
local expiry = self._protectionObj.expiry
−
if expiry == 'indef' then
+
if type(expiry) == 'number' then
−
return nil
+
return self:_formatDate(expiry)
−
elseif type(expiry) == 'number' then
+
else
−
return Blurb.formatDate(expiry)
 
−
elseif expiry then
 
−
-- Expiry is an error string.
 
 
return expiry
 
return expiry
 
end
 
end
Line 306: Line 476:
  
 
function Blurb:_makeExplanationBlurbParameter()
 
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 action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
−
local namespace = self._titleObj.namespace
+
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
−
local isTalk = self._titleObj.isTalkPage
 
  
−
-- @TODO: add semi-protection and pending changes blurbs
+
-- Find the message in the explanation blurb table and substitute any
−
local key
+
-- parameters.
−
if namespace == 8 then
+
local explanations = self._cfg.explanationBlurbs
−
-- MediaWiki namespace
+
local msg
−
key = 'explanation-blurb-full-nounprotect'
+
if explanations[action][level] and explanations[action][level][talkKey] then
−
elseif action == 'edit' and level == 'sysop' and not isTalk then
+
msg = explanations[action][level][talkKey]
−
key = 'explanation-blurb-full-subject'
+
elseif explanations[action][level] and explanations[action][level].default then
−
elseif action == 'move' then
+
msg = explanations[action][level].default
−
if isTalk then
+
elseif explanations[action].default and explanations[action].default[talkKey] then
−
key = 'explanation-blurb-move-talk'
+
msg = explanations[action].default[talkKey]
−
else
+
elseif explanations[action].default and explanations[action].default.default then
−
key = 'explanation-blurb-move-subject'
+
msg = explanations[action].default.default
−
end
 
−
elseif action == 'create' then
 
−
local xfd = self._deletionDiscussion
 
−
if xfd then
 
−
key = 'explanation-blurb-create-xfd'
 
−
else
 
−
key = 'explanation-blurb-create-noxfd'
 
−
end
 
 
else
 
else
−
key = 'explanation-blurb-default'
+
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:_getExpandedMessage(key)
+
return self:_substituteParameters(msg)
 
end
 
end
  
 
function Blurb:_makeImageLinkParameter()
 
function Blurb:_makeImageLinkParameter()
−
local imageLinks = self._configObj.cfg.imageLinks
+
local imageLinks = self._cfg.imageLinks
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 353: Line 526:
  
 
function Blurb:_makeIntroBlurbParameter()
 
function Blurb:_makeIntroBlurbParameter()
−
local expiry = self._protectionObj:getExpiry()
+
if self._protectionObj:isTemporary() then
−
if type(expiry) == 'number' then
 
 
return self:_getExpandedMessage('intro-blurb-expiry')
 
return self:_getExpandedMessage('intro-blurb-expiry')
 
else
 
else
Line 361: Line 533:
 
end
 
end
  
−
function Blurb:_makeOfficeBlurbParameter()
+
function Blurb:_makeIntroFragmentParameter()
−
local protectionDate = self._protectionObj:getProtectionDate()
+
if self._protectionObj:isTemporary() then
−
if protectionDate then
+
return self:_getExpandedMessage('intro-fragment-expiry')
−
return self:_getExpandedMessage('office-blurb-protectiondate')
 
 
else
 
else
−
return self:_getExpandedMessage('office-blurb-noprotectiondate')
+
return self:_getExpandedMessage('intro-fragment-noexpiry')
 
end
 
end
 
end
 
end
  
 
function Blurb:_makePagetypeParameter()
 
function Blurb:_makePagetypeParameter()
−
local pagetypes = self._configObj.cfg.pagetypes
+
local pagetypes = self._cfg.pagetypes
−
local namespace = self._titleObj.namespace
+
return pagetypes[self._protectionObj.title.namespace]
−
return pagetypes[namespace] or pagetypes.default or error('no default pagetype defined')
+
or pagetypes.default
 +
or error('no default pagetype defined', 8)
 
end
 
end
  
 
function Blurb:_makeProtectionBlurbParameter()
 
function Blurb:_makeProtectionBlurbParameter()
−
local protectionBlurbs = self._configObj.cfg.protectionBlurbs
+
local protectionBlurbs = self._cfg.protectionBlurbs
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 388: Line 560:
 
msg = protectionBlurbs.edit.default
 
msg = protectionBlurbs.edit.default
 
else
 
else
−
error('no protection blurb defined for cfg.protectionBlurbs.edit.default')
+
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 394: Line 566:
  
 
function Blurb:_makeProtectionDateParameter()
 
function Blurb:_makeProtectionDateParameter()
−
local protectionDate = self._protectionObj:getProtectionDate()
+
local protectionDate = self._protectionObj.protectionDate
 
if type(protectionDate) == 'number' then
 
if type(protectionDate) == 'number' then
−
return Blurb.formatDate(protectionDate)
+
return self:_formatDate(protectionDate)
 
else
 
else
 
return protectionDate
 
return protectionDate
Line 403: Line 575:
  
 
function Blurb:_makeProtectionLevelParameter()
 
function Blurb:_makeProtectionLevelParameter()
−
local protectionLevels = self._configObj.cfg.protectionLevels
+
local protectionLevels = self._cfg.protectionLevels
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 414: Line 586:
 
msg = protectionLevels.edit.default
 
msg = protectionLevels.edit.default
 
else
 
else
−
error('no protection level defined for cfg.protectionLevels.edit.default')
+
error('no protection level defined for protectionLevels.edit.default', 8)
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 420: Line 592:
  
 
function Blurb:_makeProtectionLogParameter()
 
function Blurb:_makeProtectionLogParameter()
−
local action = self._protectionObj.action
+
local pagename = self._protectionObj.title.prefixedText
−
local pagename = self._titleObj.prefixedText
+
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},
Line 431: Line 602:
 
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:_getExpandedMessage('protection-log-display')
 
self:_getExpandedMessage('protection-log-display')
 
)
 
)
−
end
 
−
end
 
−
 
−
function Blurb:_makeResetBlurbParameter()
 
−
local protectionDate = self._protectionObj:getProtectionDate()
 
−
if protectionDate then
 
−
return self:_getExpandedMessage('reset-blurb-protectiondate')
 
−
else
 
−
return self:_getExpandedMessage('reset-blurb-noprotectiondate')
 
 
end
 
end
 
end
 
end
  
 
function Blurb:_makeTalkPageParameter()
 
function Blurb:_makeTalkPageParameter()
−
local section = self._section
 
−
local display = self:_getExpandedMessage('talk-page-link-display')
 
 
return string.format(
 
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:_makeTooltipBlurbParameter()
 
function Blurb:_makeTooltipBlurbParameter()
−
local expiry = self._protectionObj:getExpiry()
+
if self._protectionObj:isTemporary() then
−
if type(expiry) == 'number' then
 
 
return self:_getExpandedMessage('tooltip-blurb-expiry')
 
return self:_getExpandedMessage('tooltip-blurb-expiry')
 
else
 
else
 
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
 
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
 
end
 
end
  
 
function Blurb:_makeVandalTemplateParameter()
 
function Blurb:_makeVandalTemplateParameter()
−
local mVandalM = require('Module:Vandal-m')
+
return require('Module:Vandal-m')._main{
−
local username = self._username
+
self._args.user or self._protectionObj.title.baseText
−
username = username or self._titleObj.baseText
+
}
−
return mVandalM._main{username}
 
 
end
 
end
  
 
-- Public methods --
 
-- Public methods --
  
−
function Blurb:setDeletionDiscussionPage(page)
+
function Blurb:makeBannerText(key)
−
self._deletionDiscussionPage = page
+
-- Validate input.
−
end
+
if not key or not Blurb.bannerTextFields[key] then
 +
error(string.format(
 +
'"%s" is not a valid banner config field',
 +
tostring(key)
 +
), 2)
 +
end
  
−
function Blurb:setUsername(username)
+
-- Generate the text.
−
self._username = username
+
local msg = self._protectionObj.bannerConfig[key]
−
end
+
if type(msg) == 'string' then
−
 
+
return self:_substituteParameters(msg)
−
function Blurb:setSection(section)
+
elseif type(msg) == 'function' then
−
self._section = section
+
msg = msg(self._protectionObj, self._args)
−
end
+
if type(msg) ~= 'string' then
−
 
+
error(string.format(
−
function Blurb:makeReasonText()
+
'bad output from banner config function with key "%s"'
−
local msg = self._bannerConfig.text
+
.. ' (expected string, got %s)',
−
if msg then
+
tostring(key),
 +
type(msg)
 +
), 4)
 +
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
 
end
 
end
−
end
 
−
 
−
function Blurb:makeExplanationText()
 
−
local msg = self._bannerConfig.explanation
 
−
return self:_substituteParameters(msg)
 
−
end
 
−
 
−
function Blurb:makeTooltipText()
 
−
local msg = self._bannerConfig.tooltip
 
−
return self:_substituteParameters(msg)
 
−
end
 
−
 
−
function Blurb:makeAltText()
 
−
local msg = self._bannerConfig.alt
 
−
return self:_substituteParameters(msg)
 
−
end
 
−
 
−
function Blurb:makeLinkText()
 
−
local msg = self._bannerConfig.link
 
−
return self:_substituteParameters(msg)
 
 
end
 
end
  
Line 521: 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, protectionObj, titleObj)
+
-- 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,
−
local action = protectionObj.action
+
-- generate it from the protection status and the namespace.
−
local level = protectionObj.level
+
local action = protectionObj.action
−
local expiry = protectionObj:getExpiry()
+
local level = protectionObj.level
−
local namespace = titleObj.namespace
+
local namespace = protectionObj.title.namespace
−
+
local reason = protectionObj.reason
−
-- Deal with special cases first.
+
−
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check?
+
-- Deal with special cases first.
−
and action == 'edit'
+
if (
−
and level == 'sysop'
+
namespace == 10
−
and not expiry
+
or namespace == 828
−
then
+
or reason and obj._cfg.indefImageReasons[reason]
−
-- Fully protected modules and templates get the special red "indef"
+
)
−
-- padlock.
+
and action == 'edit'
−
self._imageFilename = self._configObj.msg['image-filename-indef']
+
and level == 'sysop'
−
return nil
+
and not protectionObj:isTemporary()
−
end
+
then
−
 
+
-- Fully protected modules and templates get the special red "indef"
−
-- Deal with regular protection types.
+
-- padlock.
−
local images = self._configObj.cfg.images
+
obj._imageFilename = obj._cfg.msg['image-filename-indef']
−
if images[action] then
+
else
−
if images[action][level] then
+
-- Deal with regular protection types.
−
self._imageFilename = images[action][level]
+
local images = obj._cfg.images
−
return nil
+
if images[action] then
−
elseif images[action].default then
+
if images[action][level] then
−
self._imageFilename = images[action].default
+
obj._imageFilename = images[action][level]
−
return nil
+
elseif images[action].default then
 +
obj._imageFilename = images[action].default
 +
end
 +
end
 
end
 
end
 
end
 
end
−
 
+
return setmetatable(obj, BannerTemplate)
−
return nil
 
−
end
 
−
 
 
−
function BannerTemplate:setImageWidth(width)
 
−
self._imageWidth = width
 
−
end
 
−
 
 
−
function BannerTemplate:setImageTooltip(tooltip)
 
−
self._imageCaption = tooltip
 
 
end
 
end
  
 
function BannerTemplate:renderImage()
 
function BannerTemplate:renderImage()
 
local filename = self._imageFilename
 
local filename = self._imageFilename
−
or self._configObj.msg['image-filename-default']
+
or self._cfg.msg['image-filename-default']
 
or 'Transparent.gif'
 
or 'Transparent.gif'
−
return newFileLink(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 594: Line 739:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Banner = BannerTemplate:subclass('Banner')
+
local Banner = setmetatable({}, BannerTemplate)
 +
Banner.__index = Banner
  
−
function Banner:initialize(configObj)
+
function Banner.new(protectionObj, blurbObj, cfg)
−
BannerTemplate.initialize(self, configObj)
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
−
self:setImageWidth(40)
+
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:setReasonText(s)
+
function Banner:__tostring()
−
self._reasonText = s
 
−
end
 
−
 
 
−
function Banner:setExplanationText(s)
 
−
self._explanationText = s
 
−
end
 
−
 
 
−
function Banner:render(page)
 
 
-- Renders the banner.
 
-- Renders the banner.
−
-- The page parameter specifies the page to generate the banner for, for
+
makeMessageBox = makeMessageBox or require('Module:Message box').main
−
-- testing purposes.
+
local reasonText = self._reasonText or error('no reason text set', 2)
−
mMessageBox = mMessageBox or require('Module:Message box')
 
−
local reasonText = self._reasonText or error('no reason text set')
 
 
local explanationText = self._explanationText
 
local explanationText = self._explanationText
 
local mbargs = {
 
local mbargs = {
−
page = page,
+
page = self._page,
 
type = 'protection',
 
type = 'protection',
 
image = self:renderImage(),
 
image = self:renderImage(),
Line 626: Line 767:
 
)
 
)
 
}
 
}
−
return mMessageBox.main('mbox', mbargs)
+
return makeMessageBox('mbox', mbargs)
 
end
 
end
  
Line 633: Line 774:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Padlock = BannerTemplate:subclass('Padlock')
+
local Padlock = setmetatable({}, BannerTemplate)
 +
Padlock.__index = Padlock
  
−
function Padlock:initialize(configObj)
+
function Padlock.new(protectionObj, blurbObj, cfg)
−
BannerTemplate.initialize(self, configObj)
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
−
self:setImageWidth(20)
+
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 Padlock:setImageAlt(alt)
+
function Padlock:__tostring()
−
self._imageAlt = alt
+
local frame = mw.getCurrentFrame()
−
end
+
-- The nowiki tag helps prevent whitespace at the top of articles.
−
 
+
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
−
function Padlock:setImageLink(link)
+
name = 'indicator',
−
self._imageLink = link
+
args = {name = self._indicatorName},
−
end
+
content = self:renderImage()
−
 
+
}
−
function Padlock:setRight(px)
 
−
self._right = px
 
−
end
 
−
 
 
−
function Padlock:render()
 
−
local root = mw.html.create('div')
 
−
root
 
−
:addClass('metadata topicon nopopups')
 
−
:attr('id', 'protected-icon')
 
−
:css{display = 'none', right = self._right or '55px'}
 
−
:wikitext(self:renderImage())
 
−
return tostring(root)
 
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Category class
+
-- Exports
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Category = class('Category')
+
local p = {}
  
−
function Category:initialize(configObj, protectionObj)
+
function p._exportClasses()
−
self._configObj = configObj
+
-- This is used for testing purposes.
−
self._protectionObj = protectionObj
+
return {
−
end
+
Protection = Protection,
−
 
+
Blurb = Blurb,
−
function Category:setName(name)
+
BannerTemplate = BannerTemplate,
−
self._name = name
+
Banner = Banner,
 +
Padlock = Padlock,
 +
}
 
end
 
end
  
−
function Category:render()
+
function p._main(args, cfg, title)
−
if self._name then
+
args = args or {}
−
return string.format(
+
cfg = cfg or require(CONFIG_MODULE)
−
'[[%s:%s]]',
 
−
mw.site.namespaces[14].name,
 
−
self._name
 
−
)
 
−
end
 
−
end
 
  
−
--------------------------------------------------------------------------------
+
local protectionObj = Protection.new(args, cfg, title)
−
-- ProtectionCategory class
 
−
--------------------------------------------------------------------------------
 
  
−
local ProtectionCategory = Category:subclass('ProtectionCategory')
+
local ret = {}
  
−
function ProtectionCategory:initialize(configObj, protectionObj, titleObj)
+
-- If a page's edit protection is equally or more restrictive than its
−
Category.initialize(self, configObj, protectionObj)
+
-- protection from some other action, then don't bother displaying anything
−
self._titleObj = titleObj
+
-- for the other action (except categories).
−
end
+
if protectionObj.action == 'edit' or
−
 
+
args.demolevel or
−
function ProtectionCategory:render()
+
not getReachableNodes(
−
local configObj = self._configObj
+
cfg.hierarchy,
−
local protectionObj = self._protectionObj
+
protectionObj.level
−
local titleObj = self._titleObj
+
)[effectiveProtectionLevel('edit', protectionObj.title)]
 +
then
 +
-- Initialise the blurb object
 +
local blurbObj = Blurb.new(protectionObj, args, cfg)
 
 
−
-- Get the level and exit if the page is not protected.
+
-- Render the banner
−
if not protectionObj:isProtected() then
+
if protectionObj:isProtected() then
−
return ''
+
ret[#ret + 1] = tostring(
−
end
+
(yesno(args.small) and Padlock or Banner)
−
+
.new(protectionObj, blurbObj, cfg)
−
-- Get the expiry.
+
)
−
local expiry = protectionObj:getExpiry()
 
−
if type(expiry) == 'number' then
 
−
expiry = 'temp'
 
−
elseif expiry ~= 'indef' then
 
−
expiry = nil
 
−
end
 
−
 
 
−
-- Get the namespace category key.
 
−
local nskey
 
−
do
 
−
local namespace = titleObj.namespace
 
−
local categoryNamespaces = configObj.cfg.categoryNamespaceKeys
 
−
nskey = categoryNamespaces[namespace]
 
−
if not nskey and namespace % 2 == 1 then
 
−
nskey = 'talk'
 
 
end
 
end
 
end
 
end
  
−
-- Get the other inputs.
+
-- Render the categories
−
local reason = protectionObj.reason
+
if yesno(args.category) ~= false then
−
local action = protectionObj.action
+
ret[#ret + 1] = protectionObj:makeCategoryLinks()
−
local level = protectionObj.level
 
−
 
−
--[[
 
−
-- 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, val = expiry},
 
−
namespace = {order = 2, val = nskey},
 
−
reason    = {order = 3, val = reason},
 
−
level    = {order = 4, val = level},
 
−
action    = {order = 5, val = action}
 
−
}
 
−
 
−
--[[
 
−
-- 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 reasonsWithNamespacePriority = configObj.cfg.reasonsWithNamespacePriority
 
−
local namespaceFirst = reason and reasonsWithNamespacePriority[reason] or false
 
−
for propertiesKey, t in pairs(properties) do
 
−
configOrder[t.order] = t
 
−
end
 
−
if namespaceFirst then
 
−
-- Swap namespace and reason around.
 
−
local namespaceTable = table.remove(configOrder, 2)
 
−
table.insert(configOrder, 3, namespaceTable)
 
−
end
 
−
end
 
−
 
−
--[[
 
−
-- Define the attempt order. 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
 
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.cfg.protectionCategories
 
−
local cat
 
−
for i = 1, 2^noActive do
 
−
local key = {}
 
−
for j, t in ipairs(attemptOrder) do
 
−
if j > noActive then
 
−
key[t.order] = 'all'
 
−
else
 
−
local quotient = i / 2 ^ (j - 1)
 
−
quotient = math.ceil(quotient)
 
−
if quotient % 2 == 1 then
 
−
key[t.order] = t.val
 
−
else
 
−
key[t.order] = 'all'
 
−
end
 
−
end
 
−
end
 
−
key = table.concat(key, '-')
 
−
local attempt = cats[key]
 
−
if attempt then
 
−
cat = attempt
 
−
break
 
−
end
 
−
end
 
−
if cat then
 
−
self:setName(cat)
 
−
end
 
−
return Category.render(self)
 
−
end
 
−
 
−
--------------------------------------------------------------------------------
 
−
-- ExpiryCategory class
 
−
--------------------------------------------------------------------------------
 
−
 
−
local ExpiryCategory = Category:subclass('ExpiryCategory')
 
−
 
−
function ExpiryCategory:render()
 
−
local configObj = self._configObj
 
−
local protectionObj = self._protectionObj
 
 
 
−
local reasonsWithoutExpiryCheck = configObj.cfg.reasonsWithoutExpiryCheck
+
return table.concat(ret)
−
local expiryCheckActions = configObj.cfg.expiryCheckActions
 
−
local expiry = protectionObj:getExpiry()
 
−
local action = protectionObj.action
 
−
local reason = protectionObj.reason
 
−
 
−
if not expiry
 
−
and expiryCheckActions[action]
 
−
and reason -- the old {{pp-protected}} didn't check for expiry
 
−
and not reasonsWithoutExpiryCheck[reason]
 
−
then
 
−
self:setName(configObj.msg['tracking-category-expiry'])
 
−
end
 
−
return Category.render(self)
 
 
end
 
end
  
−
--------------------------------------------------------------------------------
+
function p.main(frame, cfg)
−
-- ErrorCategory class
+
cfg = cfg or require(CONFIG_MODULE)
−
--------------------------------------------------------------------------------
 
  
−
local ErrorCategory = Category:subclass('ErrorCategory')
+
-- Find default args, if any.
 +
local parent = frame.getParent and frame:getParent()
 +
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
  
−
function ErrorCategory:render()
+
-- Find user args, and use the parent frame if we are being called from a
−
local configObj = self._configObj
+
-- wrapper template.
−
local protectionObj = self._protectionObj
+
getArgs = getArgs or require('Module:Arguments').getArgs
−
+
local userArgs = getArgs(frame, {
−
local expiry = protectionObj:getExpiry()
+
parentOnly = defaultArgs,
−
local action = protectionObj.action
+
frameOnly = not defaultArgs
−
local level = protectionObj.level
+
})
  
−
if not protectionObj:isProtected()
+
-- Build the args table. User-specified args overwrite default args.
−
or type(expiry) == 'number' and expiry < os.time()
+
local args = {}
−
then
+
for k, v in pairs(defaultArgs or {}) do
−
self:setName(configObj.msg['tracking-category-incorrect'])
+
args[k] = v
 
end
 
end
−
return Category.render(self)
+
for k, v in pairs(userArgs) do
−
end
+
args[k] = v
−
 
 
−
--------------------------------------------------------------------------------
 
−
-- TemplateCategory class
 
−
--------------------------------------------------------------------------------
 
−
 
 
−
local TemplateCategory = Category:subclass('TemplateCategory')
 
−
 
 
−
function TemplateCategory:initialize(configObj, protectionObj, titleObj)
 
−
Category.initialize(self, configObj, protectionObj)
 
−
self._titleObj = titleObj
 
−
end
 
−
 
 
−
function TemplateCategory:render()
 
−
local configObj = self._configObj
 
−
local protectionObj = self._protectionObj
 
−
local titleObj = self._titleObj
 
−
 
−
local action = protectionObj.action
 
−
local level = protectionObj.level
 
−
local namespace = titleObj.namespace
 
−
 
−
if level == 'templateeditor'
 
−
and (
 
−
(action ~= 'edit' and action ~= 'move')
 
−
or (namespace ~= 10 and namespace ~= 828)
 
−
)
 
−
then
 
−
self:setName(configObj.msg['tracking-category-template'])
 
−
end
 
−
return Category.render(self)
 
−
end
 
−
 
 
−
--------------------------------------------------------------------------------
 
−
-- ProtectionBanner class
 
−
--------------------------------------------------------------------------------
 
−
 
 
−
local ProtectionBanner = {}
 
−
 
 
−
function ProtectionBanner.exportToWiki(frame, titleObj)
 
−
mArguments = mArguments or require('Module:Arguments')
 
−
local args = mArguments.getArgs(frame)
 
−
return ProtectionBanner.exportToLua(args, titleObj)
 
−
end
 
−
 
 
−
function ProtectionBanner.exportToLua(args, titleObj)
 
−
titleObj = titleObj or mw.title.getCurrentTitle()
 
−
 
 
−
-- Get data objects
 
−
if not config then
 
−
config = mw.loadData('Module:Protection banner/config')
 
 
end
 
end
−
local configObj = config
+
return p._main(args, cfg)
−
local protectionObj = Protection:new(args, configObj, titleObj)
 
−
 
 
−
-- Initialise the blurb object
 
−
local blurbObj = Blurb:new(configObj, protectionObj, titleObj)
 
−
blurbObj:setDeletionDiscussionPage(args.xfd)
 
−
blurbObj:setUsername(args.user)
 
−
blurbObj:setSection(args.section)
 
−
 
 
−
local ret = {}
 
−
 
 
−
-- Render the banner
 
−
if protectionObj:isProtected() then
 
−
-- Get the banner object
 
−
local isPadlock = yesno(args.small)
 
−
local bannerObj
 
−
if isPadlock then
 
−
bannerObj = Padlock:new(configObj)
 
−
else
 
−
bannerObj = Banner:new(configObj)
 
−
end
 
−
 
 
−
-- Set the image fields
 
−
local bannerConfig = protectionObj.bannerConfig
 
−
bannerObj:setImageFilename(bannerConfig.image, protectionObj, titleObj)
 
−
if isPadlock then
 
−
bannerObj:setImageTooltip(blurbObj:makeTooltipText())
 
−
bannerObj:setImageAlt(blurbObj:makeAltText())
 
−
bannerObj:setImageLink(blurbObj:makeLinkText())
 
−
else
 
−
-- Large banners use the alt text for the tooltip.
 
−
bannerObj:setImageTooltip(blurbObj:makeAltText())
 
−
end
 
−
 
 
−
-- Set the text fields
 
−
if not isPadlock then
 
−
bannerObj:setReasonText(blurbObj:makeReasonText())
 
−
bannerObj:setExplanationText(blurbObj:makeExplanationText())
 
−
end
 
−
 
 
−
ret[#ret + 1] = bannerObj:render()
 
−
end
 
−
 
−
-- Render the categories
 
−
if yesno(args.category) ~= false then
 
−
local objects = {
 
−
ProtectionCategory:new(configObj, protectionObj, titleObj),
 
−
ExpiryCategory:new(configObj, protectionObj),
 
−
ErrorCategory:new(configObj, protectionObj),
 
−
TemplateCategory:new(configObj, protectionObj, titleObj)
 
−
}
 
−
for _, obj in ipairs(objects) do
 
−
ret[#ret + 1] = obj:render()
 
−
end
 
−
end
 
−
 
−
return table.concat(ret)
 
−
end
 
−
 
 
−
function ProtectionBanner._exportClasses()
 
−
-- This is used to export the classes for testing purposes.
 
−
return {
 
−
Protection = Protection,
 
−
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 10:39, 12 September 2020

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 "http://timelines.issarice.com/index.php?title=Module:Protection_banner&oldid=44568"