Difference between revisions of "Module:Protection banner"

From MINR.ORG WIKI
(use factory classes to get the banner and category classes, and add a PageData class so we don't expose all of mw.title to every class)
m (231 revisions imported: Imported Category TOC from wikipedia)
 
(142 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'
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- PageData class
+
-- Helper functions
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
--[[
+
local function makeCategoryLink(cat, sort)
−
-- This class represents a MediaWiki page, just as the mw.title object does.
+
if cat then
−
-- The difference is that this class is much simpler, using only the fields
+
return string.format(
−
-- necessary for this module. This is to keep the module extensible while
+
'[[%s:%s|%s]]',
−
-- keeping the code as simple as possible, e.g. this way we do not expose
+
mw.site.namespaces[14].name,
−
-- mw.title's protectionLevels property to classes that only need to know a
+
cat,
−
-- page's namespace. The "data" in PageData is so that this class can be more
+
sort
−
-- easily differentiated with mw.title.
+
)
−
--]]
+
end
 +
end
  
−
local PageData = class('PageData')
+
-- 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
  
−
function PageData:initialize(titleObj)
+
local function makeFullUrl(page, query, display)
−
self._namespace = titleObj.namespace
+
return string.format(
 +
'[%s %s]',
 +
tostring(mw.uri.fullUrl(page, query)),
 +
display
 +
)
 
end
 
end
  
−
function PageData:getNamespace()
+
-- Given a directed graph formatted as node -> table of direct successors,
−
return self._namespace
+
-- 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
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ProtectionStatus class
+
-- Protection class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ProtectionStatus = class('ProtectionStatus')
+
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()
  
−
function ProtectionStatus:initialize(args, titleObj)
 
 
-- Set action
 
-- Set action
−
do
+
if not args.action then
−
local actions = {
+
obj.action = 'edit'
−
create = true,
+
elseif Protection.supportedActions[args.action] then
−
edit = true,
+
obj.action = args.action
−
move = true,
+
else
−
autoreview = true
+
error(string.format(
−
}
+
'invalid action: %s',
−
if args.action and actions[args.action] then
+
tostring(args.action)
−
self._action = args.action
+
), 3)
−
else
 
−
self._action = 'edit'
 
−
end
 
 
end
 
end
  
 
-- Set level
 
-- Set level
−
do
+
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
−
local level = mProtectionLevel._main(self._action, titleObj)
+
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
−
if level == 'accountcreator' then
+
-- Users need to be autoconfirmed to move pages anyway, so treat
−
-- Lump titleblacklisted pages in with template-protected pages,
+
-- semi-move-protected pages as unprotected.
−
-- since templateeditors can do both.
+
obj.level = '*'
−
level = 'templateeditor'
 
−
end
 
−
self._level = level or '*'
 
 
end
 
end
−
 
−
-- Set reason
 
−
self._reason = args.reason
 
  
 
-- Set expiry
 
-- Set expiry
−
self._expiry = args.expiry or 'indef'
+
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
−
end
+
if effectiveExpiry == 'infinity' then
 +
obj.expiry = 'indef'
 +
elseif effectiveExpiry ~= 'unknown' then
 +
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
 +
end
  
−
function ProtectionStatus:getAction()
+
-- Set reason
−
return self._action
+
if args[1] then
−
end
+
obj.reason = mw.ustring.lower(args[1])
 +
if obj.reason:find('|') then
 +
error('reasons cannot contain the pipe character ("|")', 3)
 +
end
 +
end
  
−
function ProtectionStatus:getLevel()
+
-- Set protection date
−
return self._level
+
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
 
end
  
−
function ProtectionStatus:getReason()
+
function Protection:isProtected()
−
return self._reason
+
return self.level ~= '*'
 
end
 
end
  
−
function ProtectionStatus:getExpiry()
+
function Protection:isTemporary()
−
return self._expiry
+
return type(self.expiry) == 'number'
 
end
 
end
  
−
--------------------------------------------------------------------------------
+
function Protection:makeProtectionCategory()
−
-- Config class
 
−
--------------------------------------------------------------------------------
 
−
 
 
−
local Config = class('Config')
 
−
 
 
−
function Config:initialize()
 
−
self._cfg = mw.loadData('Module:Protection banner/config')
 
−
end
 
−
 
 
−
function Config:getBannerConfig(protectionStatusObj)
 
 
local cfg = self._cfg
 
local cfg = self._cfg
−
local action = protectionStatusObj:getAction()
+
local title = self.title
−
local reason = protectionStatusObj:getReason()
+
−
if cfg.banners[action][reason] then
+
-- Exit if the page is not protected.
−
return cfg.banners[action][reason]
+
if not self:isProtected() then
−
else
+
return ''
−
return cfg.defaultBanners[action]
+
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
 
end
−
end
 
  
−
function Config:getConfigTable(key)
+
-- Get the namespace key fragment.
−
local blacklist = {
+
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
−
banners = true,
+
if not namespaceFragment and title.namespace % 2 == 1 then
−
defaultBanners = true
+
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
 
−
return nil
 
−
end
 
−
end
 
  
−
--------------------------------------------------------------------------------
+
--[[
−
-- Image class
+
-- 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
−
local Image = class('Image')
+
-- we use the config table cfg.reasonsWithNamespacePriority to set the
−
 
+
-- reasons for which namespaces have priority over protection reason.
−
function Image:initialize(configObj, protectionStatusObj, pageDataObj)
+
-- If we are dealing with one of those reasons, move the namespace table to
−
self._configObj = configObj
+
-- the end of the order table, i.e. give it highest priority. If not, the
−
self._protectionStatusObj = protectionStatusObj
+
-- reason should have highest priority, so move that to the end of the table
−
self._pageDataObj = pageDataObj
+
-- instead.
−
end
+
--]]
−
 
+
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
−
function Image:setFilename(filename)
+
−
if filename then
+
--[[
−
self._filename = filename
+
-- Define the attempt order. Inactive subtables (subtables with nil "value"
−
else
+
-- fields) are moved to the end, where they will later be given the key
−
local images, action, level, reason, namespace
+
-- "all". This is to cut down on the number of table lookups in
−
do
+
-- cfg.protectionCategories, which grows exponentially with the number of
−
local configObj = self._configObj
+
-- non-nil keys. We keep track of the number of active subtables with the
−
local protectionStatusObj = self._protectionStatusObj
+
-- noActive parameter.
−
local pageDataObj = self._pageDataObj
+
--]]
−
images = configObj:getConfigTable('images')
+
local noActive, attemptOrder
−
action = protectionStatusObj:getAction()
+
do
−
level = protectionStatusObj:getLevel()
+
local active, inactive = {}, {}
−
reason = protectionStatusObj:getReason()
+
for i, t in ipairs(order) do
−
namespace = pageDataObj:getNamespace()
+
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
−
local image
+
−
if reason == 'office' or reason == 'reset' then
+
--[[
−
image = images.office
+
-- Check increasingly generic key combinations until we find a match. If a
−
elseif namespace == 10 or namespace == 828 then
+
-- specific category exists for the combination of key fragments we are
−
-- We are in the template or module namespaces.
+
-- given, that match will be found first. If not, we keep trying different
−
if level == 'templateeditor' then
+
-- key fragment combinations until we match using the key
−
image = images.template
+
-- "all-all-all-all-all".
−
elseif level == 'sysop' then
+
--
−
image = images.indef
+
-- To generate the keys, we index the key subtables using a binary matrix
−
end
+
-- with indexes i and j. j is only calculated up to the number of active
−
elseif action == 'create' then
+
-- subtables. For example, if there were three active subtables, the matrix
−
image = images.create
+
-- would look like this, with 0 corresponding to the key fragment "all", and
−
elseif action == 'move'
+
-- 1 corresponding to other key fragments.
−
and (
+
--
−
level == 'templateeditor'
+
--  j 1  2  3
−
or level == 'sysop'
+
-- i 
−
)
+
-- 1  1  1  1
−
then
+
-- 2  0  1  1
−
image = images.move
+
-- 3  1  0  1
−
elseif action == 'edit' then
+
-- 4  0  0  1
−
if level == 'sysop' then
+
-- 5  1  1  0
−
image = images.full
+
-- 6  0  1  0
−
elseif level == 'autoconfirmed' then
+
-- 7  1  0  0
−
image = images.semi
+
-- 8  0  0  0
−
end
+
--
−
elseif action == 'autoreview' then
+
-- Values of j higher than the number of active subtables are set
−
if level == 'autoconfirmed' then
+
-- to the string "all".
−
image = images.pc1
+
--
−
elseif level == 'reviewer' then
+
-- A key for cfg.protectionCategories is constructed for each value of i.
−
image = images.pc2
+
-- 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
 
end
 
end
−
self._filename = image
+
key = table.concat(key, '|')
 +
local attempt = cats[key]
 +
if attempt then
 +
return makeCategoryLink(attempt, title.text)
 +
end
 
end
 
end
 +
return ''
 
end
 
end
  
−
function Image:setWidth(width)
+
function Protection:isIncorrect()
−
self._width = width
+
local expiry = self.expiry
 +
return not self:isProtected()
 +
or type(expiry) == 'number' and expiry < os.time()
 
end
 
end
  
−
function Image:setAlt(alt)
+
function Protection:isTemplateProtectedNonTemplate()
−
self._alt = alt
+
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
 
end
  
−
function Image:setLink(link)
+
function Protection:makeCategoryLinks()
−
self._link = link
+
local msg = self._cfg.msg
−
end
+
local ret = { self:makeProtectionCategory() }
−
 
+
if self:isIncorrect() then
−
function Image:setCaption(caption)
+
ret[#ret + 1] = makeCategoryLink(
−
self._caption = caption
+
msg['tracking-category-incorrect'],
−
end
+
self.title.text
−
 
+
)
−
function Image:export()
+
end
−
return mFileLink.new(self._filename or 'Transparent.gif')
+
if self:isTemplateProtectedNonTemplate() then
−
:width(self._width or 20)
+
ret[#ret + 1] = makeCategoryLink(
−
:alt(self._alt)
+
msg['tracking-category-template'],
−
:link(self._link)
+
self.title.text
−
:caption(self._caption)
+
)
−
:render()
+
end
 +
return table.concat(ret)
 
end
 
end
  
Line 216: Line 344:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Blurb = class('Blurb')
+
local Blurb = {}
 +
Blurb.__index = Blurb
  
−
function Blurb:initialize(configObj, protectionStatusObj, pageDataObj)
+
Blurb.bannerTextFields = {
−
self._configObj = configObj
+
text = true,
−
self._protectionStatusObj = protectionStatusObj
+
explanation = true,
−
self._bannerConfig = configObj:getBannerConfig(protectionStatusObj)
+
tooltip = true,
−
self._pageDataObj = pageDataObj
+
alt = true,
 +
link = true
 +
}
 +
 
 +
function Blurb.new(protectionObj, args, cfg)
 +
return setmetatable({
 +
_cfg = cfg,
 +
_protectionObj = protectionObj,
 +
_args = args
 +
}, Blurb)
 
end
 
end
  
−
function Blurb:_makeIntroParameter()
+
-- 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
 
end
  
−
function Blurb:_makePagetypeParameter()
+
function Blurb:_getExpandedMessage(msgKey)
−
local pagetypes = self._configObj:getConfigTable('pagetypeNamespaces')
+
return self:_substituteParameters(self._cfg.msg[msgKey])
−
local namespace = self._pageDataObj:getNamespace()
 
−
return pagetypes[namespace] or pagetypes.default or 'page'
 
 
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
 
if parameterFuncs[k] then
 
if parameterFuncs[k] then
−
param = parameterFuncs[k]()
+
param = parameterFuncs[k](self)
 
end
 
end
−
params[k] = param
+
param = param or ''
 +
t[k] = param
 
return param
 
return param
 
end
 
end
 
})
 
})
−
+
end
−
parameterFuncs[1] = function ()
+
−
return self:_makeIntroParameter()
+
msg = msg:gsub('${(%u+)}', self._params)
−
end
+
return msg
 +
end
  
−
-- TODO: Write parameter functions
+
function Blurb:_makeCurrentVersionParameter()
−
self._params = params
+
-- 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
−
return mw.message.newRawMessage(msg):params(self._params):plain()
 
 
end
 
end
  
−
--------------------------------------------------------------------------------
+
function Blurb:_makeEditRequestParameter()
−
-- BannerTemplate class
+
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')
  
−
local BannerTemplate = class('BannerTemplate')
+
return mEditRequest._link{type = requestType, display = display}
−
 
 
−
function BannerTemplate:initialize()
 
 
end
 
end
  
−
function BannerTemplate:render()
+
function Blurb:_makeExpiryParameter()
 +
local expiry = self._protectionObj.expiry
 +
if type(expiry) == 'number' then
 +
return self:_formatDate(expiry)
 +
else
 +
return expiry
 +
end
 
end
 
end
  
−
--------------------------------------------------------------------------------
+
function Blurb:_makeExplanationBlurbParameter()
−
-- Banner class
+
-- Cover special cases first.
−
--------------------------------------------------------------------------------
+
if self._protectionObj.title.namespace == 8 then
 +
-- MediaWiki namespace
 +
return self:_getExpandedMessage('explanation-blurb-nounprotect')
 +
end
  
−
local Banner = BannerTemplate:subclass('Banner')
+
-- 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
−
-- Padlock class
+
-- 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
  
−
local Padlock = BannerTemplate:subclass('Padlock')
+
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()
−
-- BannerFactory class
+
if self._protectionObj:isTemporary() then
−
--------------------------------------------------------------------------------
+
return self:_getExpandedMessage('intro-blurb-expiry')
 +
else
 +
return self:_getExpandedMessage('intro-blurb-noexpiry')
 +
end
 +
end
  
−
local BannerFactory = class('BannerFactory')
+
function Blurb:_makeIntroFragmentParameter()
 +
if self._protectionObj:isTemporary() then
 +
return self:_getExpandedMessage('intro-fragment-expiry')
 +
else
 +
return self:_getExpandedMessage('intro-fragment-noexpiry')
 +
end
 +
end
  
−
function BannerFactory:initialize(
+
function Blurb:_makePagetypeParameter()
−
args,
+
local pagetypes = self._cfg.pagetypes
−
configObj,
+
return pagetypes[self._protectionObj.title.namespace]
−
protectionStatusObj,
+
or pagetypes.default
−
pageDataObj
+
or error('no default pagetype defined', 8)
−
)
+
end
−
 
 
−
-- Set dependent objects
 
−
self._configObj = configObj
 
−
self._protectionStatusObj = protectionStatusObj
 
−
self._pageDataObj = pageDataObj
 
  
−
-- Set object paradigm to use
+
function Blurb:_makeProtectionBlurbParameter()
−
if yesno(args.small) then
+
local protectionBlurbs = self._cfg.protectionBlurbs
−
self._paradigm = 'padlock'
+
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
 
else
−
self._paradigm = 'banner'
+
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
 
end
 
end
 +
return self:_substituteParameters(msg)
 
end
 
end
  
−
function BannerFactory:newBannerTemplate()
+
function Blurb:_makeProtectionDateParameter()
 +
local protectionDate = self._protectionObj.protectionDate
 +
if type(protectionDate) == 'number' then
 +
return self:_formatDate(protectionDate)
 +
else
 +
return protectionDate
 +
end
 
end
 
end
  
−
function BannerFactory:newBlurb()
+
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
 
end
  
−
function BannerFactory:newImage()
+
function Blurb:_makeProtectionLogParameter()
−
local image = Image:new()
+
local pagename = self._protectionObj.title.prefixedText
−
if self._paradigm == 'padlock' then
+
if self._protectionObj.action == 'autoreview' then
−
image:setWidth(20)
+
-- We need the pending changes log.
 +
return makeFullUrl(
 +
'Special:Log',
 +
{type = 'stable', page = pagename},
 +
self:_getExpandedMessage('pc-log-display')
 +
)
 
else
 
else
−
image:setWidth(40)
+
-- We need the protection log.
 +
return makeFullUrl(
 +
'Special:Log',
 +
{type = 'protect', page = pagename},
 +
self:_getExpandedMessage('protection-log-display')
 +
)
 
end
 
end
−
return image
 
 
end
 
end
  
−
--------------------------------------------------------------------------------
+
function Blurb:_makeTalkPageParameter()
−
-- Category class
+
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
  
−
local Category = class('Category')
+
function Blurb:_makeTooltipBlurbParameter()
 +
if self._protectionObj:isTemporary() then
 +
return self:_getExpandedMessage('tooltip-blurb-expiry')
 +
else
 +
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
 +
end
 +
end
  
−
function Category:initialize()
+
function Blurb:_makeTooltipFragmentParameter()
 +
if self._protectionObj:isTemporary() then
 +
return self:_getExpandedMessage('tooltip-fragment-expiry')
 +
else
 +
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
 +
end
 
end
 
end
  
−
function Category:setName(name)
+
function Blurb:_makeVandalTemplateParameter()
−
self._name = name
+
return require('Module:Vandal-m')._main{
 +
self._args.user or self._protectionObj.title.baseText
 +
}
 
end
 
end
  
−
function Category:export()
+
-- Public methods --
−
if self._categoryName then
+
 
−
return string.format(
+
function Blurb:makeBannerText(key)
−
'[[%s:%s]]',
+
-- Validate input.
−
mw.site.namespaces[14].name,
+
if not key or not Blurb.bannerTextFields[key] then
−
self._categoryName
+
error(string.format(
−
)
+
'"%s" is not a valid banner config field',
−
else
+
tostring(key)
−
return ''
+
), 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
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ProtectionCategory class
+
-- BannerTemplate class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ProtectionCategory = Category:subclass('ProtectionCategory')
+
local BannerTemplate = {}
 +
BannerTemplate.__index = BannerTemplate
 +
 
 +
function BannerTemplate.new(protectionObj, cfg)
 +
local obj = {}
 +
obj._cfg = cfg
  
−
function ProtectionCategory:setName(
+
-- Set the image filename.
−
name,
+
local imageFilename = protectionObj.bannerConfig.image
−
configObj,
+
if imageFilename then
−
protectionStatusObj,
+
obj._imageFilename = imageFilename
−
namespace
+
else
−
)
+
-- If an image filename isn't specified explicitly in the banner config,
−
--[[
+
-- generate it from the protection status and the namespace.
−
-- Sets the protection category. If a category name is not provided, this
+
local action = protectionObj.action
−
-- method gets a category name from the module config, given a combination
+
local level = protectionObj.level
−
-- of the protection type, the protection level, the namespace number, the
+
local namespace = protectionObj.title.namespace
−
-- reason for protection, and the expiry date.
+
local reason = protectionObj.reason
−
--]]
+
−
+
-- Deal with special cases first.
−
-- If a name was provided, use that.
+
if (
−
if name then
+
namespace == 10
−
Category.setName(self, name)
+
or namespace == 828
−
end
+
or reason and obj._cfg.indefImageReasons[reason]
−
+
)
−
-- Get the namespace category key from the namespace number.
+
and action == 'edit'
−
local nskey
+
and level == 'sysop'
−
do
+
and not protectionObj:isTemporary()
−
local categoryNamespaces = configObj:getConfigTable('categoryNamespaces')
+
then
−
if not namespace or type(namespace) ~= 'number' then
+
-- Fully protected modules and templates get the special red "indef"
−
nskey = nil
+
-- padlock.
 +
obj._imageFilename = obj._cfg.msg['image-filename-indef']
 
else
 
else
−
nskey = categoryNamespaces[ns]
+
-- Deal with regular protection types.
−
if not nskey and ns % 2 == 1 then
+
local images = obj._cfg.images
−
nskey = 'talk'
+
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
 
end
 
end
 
end
−
+
return setmetatable(obj, BannerTemplate)
−
--[[
+
end
−
-- Define the properties table. Each property is a table containing the
+
 
−
-- canonical order that the property is tested in, the position the
+
function BannerTemplate:renderImage()
−
-- property has in the category key strings, and the property value itself.
+
local filename = self._imageFilename
−
--]]
+
or self._cfg.msg['image-filename-default']
−
local properties = {
+
or 'Transparent.gif'
−
expiry = {order = 1, keypos = 5, val = protectionStatusObj:getExpiry()},
+
return makeFileLink{
−
namespace = {order = 2, keypos = 3, val = nskey},
+
file = filename,
−
reason = {order = 3, keypos = 4, val = protectionStatusObj:getReason()},
+
size = (self.imageWidth or 20) .. 'px',
−
level = {order = 4, keypos = 2, val = protectionStatusObj:getLevel()},
+
alt = self._imageAlt,
−
action = {order = 5, keypos = 1, val = protectionStatusObj:getAction()}
+
link = self._imageLink,
 +
caption = self.imageCaption
 
}
 
}
−
 
−
--[[
 
−
-- 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
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ExpiryCategory class
+
-- Banner class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ExpiryCategory = Category:subclass('ExpiryCategory')
+
local Banner = setmetatable({}, BannerTemplate)
 +
Banner.__index = Banner
  
−
--------------------------------------------------------------------------------
+
function Banner.new(protectionObj, blurbObj, cfg)
−
-- ErrorCategory class
+
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
  
−
local ErrorCategory = Category:subclass('ErrorCategory')
+
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
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- CategoryFactory class
+
-- Padlock class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local CategoryFactory = class('CategoryFactory')
+
local Padlock = setmetatable({}, BannerTemplate)
 +
Padlock.__index = Padlock
  
−
function CategoryFactory:initialize(
+
function Padlock.new(protectionObj, blurbObj, cfg)
−
configObj,
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
−
protectionStatusObj,
+
obj.imageWidth = 20
−
pageDataObj
+
obj.imageCaption = blurbObj:makeBannerText('tooltip')
−
)
+
obj._imageAlt = blurbObj:makeBannerText('alt')
−
 
+
obj._imageLink = blurbObj:makeBannerText('link')
−
-- Set dependent objects
+
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
−
self._configObj = configObj
+
or cfg.padlockIndicatorNames.default
−
self._protectionStatusObj = protectionStatusObj
+
or 'pp-default'
−
self._pageDataObj = pageDataObj
+
return setmetatable(obj, Padlock)
 
end
 
end
  
−
function CategoryFactory:getCategoryObjects()
+
function Padlock:__tostring()
−
local ret = {}
+
local frame = mw.getCurrentFrame()
−
local classes = {ProtectionCategory, ExpiryCategory, ErrorCategory}
+
-- The nowiki tag helps prevent whitespace at the top of articles.
−
for i, aClass in ipairs(classes) do
+
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
−
ret[#ret + 1] = aClass:new()
+
name = 'indicator',
−
end
+
args = {name = self._indicatorName},
−
return ret
+
content = self:renderImage()
 +
}
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- ProtectionBanner class
+
-- Exports
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local ProtectionBanner = {}
+
local p = {}
  
−
function ProtectionBanner.exportToWiki(frame, title)
+
function p._exportClasses()
−
local args = mArguments.getArgs(frame)
+
-- This is used for testing purposes.
−
return ProtectionBanner.exportToLua(args, title)
+
return {
 +
Protection = Protection,
 +
Blurb = Blurb,
 +
BannerTemplate = BannerTemplate,
 +
Banner = Banner,
 +
Padlock = Padlock,
 +
}
 
end
 
end
  
−
function ProtectionBanner.exportToLua(args, title)
+
function p._main(args, cfg, title)
−
title = title or mw.title.getCurrentTitle()
+
args = args or {}
 +
cfg = cfg or require(CONFIG_MODULE)
  
−
-- Get data objects
+
local protectionObj = Protection.new(args, cfg, title)
−
local thePageData = PageData:new(title)
 
−
local theProtectionStatus = ProtectionStatus.new(args, title)
 
−
local theConfig = Config:new()
 
  
 
local ret = {}
 
local ret = {}
  
−
-- Render the banner
+
-- If a page's edit protection is equally or more restrictive than its
−
do
+
-- protection from some other action, then don't bother displaying anything
−
local theBannerFactory = BannerFactory:new(
+
-- for the other action (except categories).
−
args,
+
if protectionObj.action == 'edit' or
−
theConfig,
+
args.demolevel or
−
theProtectionStatus,
+
not getReachableNodes(
−
thePageData
+
cfg.hierarchy,
−
)
+
protectionObj.level
−
local banner = theBannerFactory:newBannerTemplate()
+
)[effectiveProtectionLevel('edit', protectionObj.title)]
−
local image = theBannerFactory:newImage()
+
then
−
local blurb = theBannerFactory:newBlurb()
+
-- Initialise the blurb object
−
--TODO: actual rendering
+
local blurbObj = Blurb.new(protectionObj, args, cfg)
−
ret[#ret + 1] = banner:export()
+
 +
-- Render the banner
 +
if protectionObj:isProtected() then
 +
ret[#ret + 1] = tostring(
 +
(yesno(args.small) and Padlock or Banner)
 +
.new(protectionObj, blurbObj, cfg)
 +
)
 +
end
 
end
 
end
  
 
-- Render the categories
 
-- Render the categories
−
do
+
if yesno(args.category) ~= false then
−
local theCategoryFactory = CategoryFactory:new(
+
ret[#ret + 1] = protectionObj:makeCategoryLinks()
−
theConfig,
 
−
theProtectionStatus,
 
−
thePageData
 
−
)
 
−
local categoryObjects = theCategoryFactory:getCategoryObjects()
 
−
for i, obj in ipairs(categoryObjects) do
 
−
ret[#ret + 1] = obj:export()
 
−
end
 
 
end
 
end
−
 
+
 
return table.concat(ret)
 
return table.concat(ret)
 
end
 
end
  
−
function ProtectionBanner._exportClasses()
+
function p.main(frame, cfg)
−
-- This is used to export the classes for testing purposes.
+
cfg = cfg or require(CONFIG_MODULE)
−
return {
+
 
−
PageData = PageData,
+
-- Find default args, if any.
−
ProtectionStatus = ProtectionStatus,
+
local parent = frame.getParent and frame:getParent()
−
Config = Config,
+
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
−
Image = Image,
+
 
−
Blurb = Blurb,
+
-- Find user args, and use the parent frame if we are being called from a
−
BannerTemplate = BannerTemplate,
+
-- wrapper template.
−
Banner = Banner,
+
getArgs = getArgs or require('Module:Arguments').getArgs
−
Padlock = Padlock,
+
local userArgs = getArgs(frame, {
−
BannerFactory = BannerFactory,
+
parentOnly = defaultArgs,
−
Category = Category,
+
frameOnly = not defaultArgs
−
ProtectionCategory = ProtectionCategory,
+
})
−
ErrorCategory = ErrorCategory,
+
 
−
ExpiryCategory = ExpiryCategory,
+
-- Build the args table. User-specified args overwrite default args.
−
CategoryFactory = CategoryFactory
+
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
 
end
  
−
return ProtectionBanner
+
return p

Latest revision as of 18:56, 11 August 2017

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://wiki.minr.org/index.php?title=Module:Protection_banner&oldid=2238"