Editing Module:Protection banner

From MINR.ORG WIKI

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 4: Line 4:
 
-- Initialise necessary modules.
 
-- Initialise necessary modules.
 
require('Module:No globals')
 
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
+
local class = require('Module:Middleclass').class
 +
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 getArgs, makeMessageBox, lang
 
local getArgs, makeMessageBox, lang
 
-- Set constants.
 
local CONFIG_MODULE = 'Module:Protection banner/config'
 
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
Line 19: Line 16:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local function makeCategoryLink(cat, sort)
+
local function makeCategoryLink(cat)
 
if cat then
 
if cat then
 
return string.format(
 
return string.format(
'[[%s:%s|%s]]',
+
'[[%s:%s]]',
 
mw.site.namespaces[14].name,
 
mw.site.namespaces[14].name,
cat,
+
cat
sort
 
 
)
 
)
 +
else
 +
return ''
 
end
 
end
 
end
 
end
Line 32: Line 30:
 
-- Validation function for the expiry and the protection date
 
-- Validation function for the expiry and the protection date
 
local function validateDate(dateString, dateType)
 
local function validateDate(dateString, dateType)
if not lang then
+
lang = lang or mw.language.getContentLanguage()
lang = mw.language.getContentLanguage()
 
end
 
 
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
 
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
 
if success then
 
if success then
Line 43: Line 39:
 
end
 
end
 
error(string.format(
 
error(string.format(
'invalid %s: %s',
+
'invalid %s ("%s")',
 
dateType,
 
dateType,
 
tostring(dateString)
 
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
 
end
  
Line 82: Line 49:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local Protection = {}
+
local Protection = class('Protection')
Protection.__index = Protection
 
  
 
Protection.supportedActions = {
 
Protection.supportedActions = {
 +
create = true,
 
edit = true,
 
edit = true,
 
move = true,
 
move = true,
autoreview = true,
+
autoreview = true
upload = true
 
 
}
 
}
  
Line 101: Line 67:
 
}
 
}
  
function Protection.new(args, cfg, title)
+
function Protection:initialize(args, cfg, title)
local obj = {}
+
self._cfg = cfg
obj._cfg = cfg
+
self.title = title or mw.title.getCurrentTitle()
obj.title = title or mw.title.getCurrentTitle()
 
  
 
-- Set action
 
-- Set action
if not args.action then
+
do
obj.action = 'edit'
+
if not args.action then
elseif Protection.supportedActions[args.action] then
+
self.action = 'edit'
obj.action = args.action
+
elseif self.supportedActions[args.action] then
else
+
self.action = args.action
error(string.format(
+
else
'invalid action: %s',
+
error('Unsupported action ' .. args.action, 2)
tostring(args.action)
+
end
), 3)
 
 
end
 
end
  
 
-- Set level
 
-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
+
do
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
+
self.level = effectiveProtectionLevel(self.action, self.title)
-- Users need to be autoconfirmed to move pages anyway, so treat
+
if self.level == 'accountcreator' then
-- semi-move-protected pages as unprotected.
+
-- Lump titleblacklisted pages in with template-protected pages,
obj.level = '*'
+
-- since templateeditors can do both.
 +
self.level = 'templateeditor'
 +
elseif not self.level or (self.action == 'move' and self.level == 'autoconfirmed') then
 +
-- Users need to be autoconfirmed to move pages anyway, so treat
 +
-- semi-move-protected pages as unprotected.
 +
self.level = '*'
 +
end
 
end
 
end
  
 
-- Set expiry
 
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
+
if args.expiry then
if effectiveExpiry == 'infinity' then
+
if cfg.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
if args[1] then
+
do
obj.reason = mw.ustring.lower(args[1])
+
local reason = args.reason or args[1]
if obj.reason:find('|') then
+
if reason then
error('reasons cannot contain the pipe character ("|")', 3)
+
self.reason = reason:lower()
 
end
 
end
 
end
 
end
  
 
-- Set protection date
 
-- Set protection date
if args.date then
+
self.protectionDate = validateDate(args.date, 'protection date')
obj.protectionDate = validateDate(args.date, 'protection date')
 
end
 
 
 
 
-- Set banner config
 
-- Set banner config
 
do
 
do
obj.bannerConfig = {}
+
self.bannerConfig = {}
 
local configTables = {}
 
local configTables = {}
if cfg.banners[obj.action] then
+
if cfg.banners[self.action] then
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
+
configTables[#configTables + 1] = cfg.banners[self.action][self.reason]
 
end
 
end
if cfg.defaultBanners[obj.action] then
+
if cfg.defaultBanners[self.action] then
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
+
configTables[#configTables + 1] = cfg.defaultBanners[self.action][self.level]
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
+
configTables[#configTables + 1] = cfg.defaultBanners[self.action].default
 
end
 
end
 
configTables[#configTables + 1] = cfg.masterBanner
 
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(Protection.bannerConfigFields) do
+
for i, field in ipairs(self.bannerConfigFields) do
 
for j, t in ipairs(configTables) do
 
for j, t in ipairs(configTables) do
 
if t[field] then
 
if t[field] then
obj.bannerConfig[field] = t[field]
+
self.bannerConfig[field] = t[field]
 
break
 
break
 
end
 
end
Line 168: Line 139:
 
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
 
end
  
Line 188: Line 154:
 
end
 
end
 
 
-- Get the expiry key fragment.
+
-- Get the expiry.
local expiryFragment
+
local expiry = self.expiry
if self.expiry == 'indef' then
+
if type(expiry) == 'number' then
expiryFragment = self.expiry
+
expiry = 'temp'
elseif type(self.expiry) == 'number' then
+
elseif expiry ~= 'indef' then
expiryFragment = 'temp'
+
expiry = nil
 
end
 
end
  
-- Get the namespace key fragment.
+
-- Get the namespace category key.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
+
local nskey
if not namespaceFragment and title.namespace % 2 == 1 then
+
do
namespaceFragment = 'talk'
+
local namespace = title.namespace
 +
local categoryNamespaces = cfg.categoryNamespaceKeys
 +
nskey = categoryNamespaces[namespace]
 +
if not nskey and namespace % 2 == 1 then
 +
nskey = 'talk'
 +
end
 
end
 
end
 +
 +
-- Get the other inputs.
 +
local reason = self.reason
 +
local action = self.action
 +
local level = self.level
 
   
 
   
-- 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
+
-- Define the properties table. Each property is a table containing the
-- position in the cfg.protectionCategories table.
+
-- canonical order that the property is tested in, the position the
local order = {
+
-- property has in the category key strings, and the property value itself.
{val = expiryFragment,   keypos = 1},
+
--]]
{val = namespaceFragment, keypos = 2},
+
local properties = {
{val = self.reason,      keypos = 3},
+
expiry    = {order = 1, val = expiry},
{val = self.level,        keypos = 4},
+
namespace = {order = 2, val = nskey},
{val = self.action,      keypos = 5}
+
reason    = {order = 3, val = reason},
 +
level    = {order = 4, val = level},
 +
action    = {order = 5, val = action}
 
}
 
}
 
+
 
--[[
 
--[[
-- The old protection templates used an ad-hoc protection category system,
+
-- Apply the category order configuration, if any. The configuration value
-- with some templates prioritising namespaces in their categories, and
+
-- will be a property string, e.g. 'reason', 'namespace', etc. The property
-- others prioritising the protection reason. To emulate this in this module
+
-- corresponding to that string is tested last (i.e. it is the most
-- we use the config table cfg.reasonsWithNamespacePriority to set the
+
-- important, because it keeps its specified value the longest) and the
-- reasons for which namespaces have priority over protection reason.
+
-- other properties are tested in the canonical order. If no configuration
-- If we are dealing with one of those reasons, move the namespace table to
+
-- value is specified then the canonical order is used.
-- the end of the order table, i.e. give it highest priority. If not, the
 
-- reason should have highest priority, so move that to the end of the table
 
-- instead.
 
 
--]]
 
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
+
local configOrder = {}
 +
do
 +
local reasonsWithNamespacePriority = cfg.reasonsWithNamespacePriority
 +
local namespaceFirst = reason and reasonsWithNamespacePriority[reason] or false
 +
for propertiesKey, t in pairs(properties) do
 +
configOrder[t.order] = t
 +
end
 +
if namespaceFirst then
 +
-- Swap namespace and reason around.
 +
local namespaceTable = table.remove(configOrder, 2)
 +
table.insert(configOrder, 3, namespaceTable)
 +
end
 +
end
 
   
 
   
 
--[[
 
--[[
-- Define the attempt order. Inactive subtables (subtables with nil "value"
+
-- Define the attempt order. Properties with no value defined are moved
-- fields) are moved to the end, where they will later be given the key
+
-- to the end, where they will later be given the value "all". This is
-- "all". This is to cut down on the number of table lookups in
+
-- to cut down on the number of table lookups in the cats table, which
-- cfg.protectionCategories, which grows exponentially with the number of
+
-- grows exponentially with the number of properties with valid values.
-- non-nil keys. We keep track of the number of active subtables with the
+
-- We keep track of the number of active properties with the noActive
-- noActive parameter.
+
-- parameter.
 
--]]
 
--]]
 
local noActive, attemptOrder
 
local noActive, attemptOrder
 
do
 
do
 
local active, inactive = {}, {}
 
local active, inactive = {}, {}
for i, t in ipairs(order) do
+
for i, t in ipairs(configOrder) do
 
if t.val then
 
if t.val then
 
active[#active + 1] = t
 
active[#active + 1] = t
Line 252: Line 239:
 
   
 
   
 
--[[
 
--[[
-- Check increasingly generic key combinations until we find a match. If a
+
-- Check increasingly generic key combinations until we find a match.
-- specific category exists for the combination of key fragments we are
+
-- If a specific category exists for the combination of properties
-- given, that match will be found first. If not, we keep trying different
+
-- we are given, that match will be found first. If not, we keep
-- key fragment combinations until we match using the key
+
-- trying different key combinations until we match using the key
 
-- "all-all-all-all-all".
 
-- "all-all-all-all-all".
 
--
 
--
-- To generate the keys, we index the key subtables using a binary matrix
+
-- To generate the keys, we index the property subtables using a
-- with indexes i and j. j is only calculated up to the number of active
+
-- binary matrix with indexes i and j. j is only calculated up to
-- subtables. For example, if there were three active subtables, the matrix
+
-- the number of active properties. For example, if there were three
-- would look like this, with 0 corresponding to the key fragment "all", and
+
-- active properties, the matrix would look like this, with 0
-- 1 corresponding to other key fragments.
+
-- corresponding to the string "all", and 1 corresponding to the
 +
-- val field in the property table:
 
--  
 
--  
 
--  j 1  2  3
 
--  j 1  2  3
Line 275: Line 263:
 
-- 8  0  0  0
 
-- 8  0  0  0
 
--  
 
--  
-- Values of j higher than the number of active subtables are set
+
-- Values of j higher than the number of active properties are set
 
-- to the string "all".
 
-- to the string "all".
 
--
 
--
-- A key for cfg.protectionCategories is constructed for each value of i.
+
-- A key for the category table is constructed for each value of i.
-- The position of the value in the key is determined by the keypos field in
+
-- The correct position of the value in the key is determined by the
-- each subtable.
+
-- pos field in the property table.
 
--]]
 
--]]
 
local cats = cfg.protectionCategories
 
local cats = cfg.protectionCategories
Line 287: Line 275:
 
for j, t in ipairs(attemptOrder) do
 
for j, t in ipairs(attemptOrder) do
 
if j > noActive then
 
if j > noActive then
key[t.keypos] = 'all'
+
key[t.order] = 'all'
 
else
 
else
 
local quotient = i / 2 ^ (j - 1)
 
local quotient = i / 2 ^ (j - 1)
 
quotient = math.ceil(quotient)
 
quotient = math.ceil(quotient)
 
if quotient % 2 == 1 then
 
if quotient % 2 == 1 then
key[t.keypos] = t.val
+
key[t.order] = t.val
 
else
 
else
key[t.keypos] = 'all'
+
key[t.order] = 'all'
 
end
 
end
 
end
 
end
 
end
 
end
key = table.concat(key, '|')
+
key = table.concat(key, '-')
 
local attempt = cats[key]
 
local attempt = cats[key]
 
if attempt then
 
if attempt then
return makeCategoryLink(attempt, title.text)
+
return makeCategoryLink(attempt)
 
end
 
end
 
end
 
end
return ''
+
end
 +
 
 +
function Protection:needsExpiry()
 +
local cfg = self._cfg
 +
return not self.expiry
 +
and cfg.expiryCheckActions[self.action]
 +
and self.reason -- the old {{pp-protected}} didn't check for expiry
 +
and not cfg.reasonsWithoutExpiryCheck[self.reason]
 
end
 
end
  
Line 325: Line 320:
 
local msg = self._cfg.msg
 
local msg = self._cfg.msg
 
local ret = { self:makeProtectionCategory() }
 
local ret = { self:makeProtectionCategory() }
 +
if self:needsExpiry() then
 +
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-expiry'])
 +
end
 
if self:isIncorrect() then
 
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(
+
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-incorrect'])
msg['tracking-category-incorrect'],
 
self.title.text
 
)
 
 
end
 
end
 
if self:isTemplateProtectedNonTemplate() then
 
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink(
+
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-template'])
msg['tracking-category-template'],
 
self.title.text
 
)
 
 
end
 
end
 
return table.concat(ret)
 
return table.concat(ret)
Line 344: Line 336:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local Blurb = {}
+
local Blurb = class('Blurb')
Blurb.__index = Blurb
+
 
 +
function Blurb:initialize(protectionObj, args, cfg)
 +
self._cfg = cfg
 +
self._protectionObj = protectionObj
 +
self._bannerConfig = protectionObj.bannerConfig
 +
self._title = protectionObj.title
 +
self._deletionDiscussionPage = args.xfd
 +
self._username = args.user
 +
self._section = args.section
 +
end
  
Blurb.bannerTextFields = {
+
-- Static methods --
text = true,
 
explanation = true,
 
tooltip = true,
 
alt = true,
 
link = true
 
}
 
  
function Blurb.new(protectionObj, args, cfg)
+
function Blurb.makeFullUrl(page, query, display)
return setmetatable({
+
return string.format(
_cfg = cfg,
+
'[%s %s]',
_protectionObj = protectionObj,
+
tostring(mw.uri.fullUrl(page, query)),
_args = args
+
display
}, Blurb)
+
)
 
end
 
end
  
-- Private methods --
+
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 371: Line 364:
 
lang.formatDate,
 
lang.formatDate,
 
lang,
 
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
+
'j F Y',
 
'@' .. tostring(num)
 
'@' .. tostring(num)
 
)
 
)
Line 378: Line 371:
 
end
 
end
 
end
 
end
 +
 +
-- Private methods --
  
 
function Blurb:_getExpandedMessage(msgKey)
 
function Blurb:_getExpandedMessage(msgKey)
Line 385: Line 380:
 
function Blurb:_substituteParameters(msg)
 
function Blurb:_substituteParameters(msg)
 
if not self._params then
 
if not self._params then
local parameterFuncs = {}
+
local params, parameterFuncs = {}, {}
 +
setmetatable(params, {
 +
__index = function (t, k)
 +
local param
 +
if parameterFuncs[k] then
 +
param = parameterFuncs[k](self)
 +
end
 +
param = param or ''
 +
params[k] = param
 +
return param
 +
end
 +
})
  
 
parameterFuncs.CURRENTVERSION    = self._makeCurrentVersionParameter
 
parameterFuncs.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 393: Line 402:
 
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
 
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
 
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
 
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
+
parameterFuncs.OFFICEBLURB        = self._makeOfficeBlurbParameter
 
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
 
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
 
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
 
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
Line 399: Line 408:
 
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 = setmetatable({}, {
+
self._params = params
__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 424: Line 423:
 
-- 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 pagename = self._protectionObj.title.prefixedText
+
local action = self._protectionObj.action
if self._protectionObj.action == 'move' then
+
local pagename = self._title.prefixedText
 +
if action == 'move' then
 
-- We need the move log link.
 
-- We need the move log link.
return makeFullUrl(
+
return self.makeFullUrl(
 
'Special:Log',
 
'Special:Log',
 
{type = 'move', page = pagename},
 
{type = 'move', page = pagename},
Line 434: Line 434:
 
else
 
else
 
-- We need the history link.
 
-- We need the history link.
return makeFullUrl(
+
return self.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.expiry
 +
if type(expiry) == 'number' then
 +
return self:_getExpandedMessage('dispute-blurb-expiry')
 +
else
 +
return self:_getExpandedMessage('dispute-blurb-noexpiry')
 +
end
 +
end
 +
 +
function Blurb:_makeDisputeSectionParameter()
 +
-- "disputes", with or without a section link
 +
local section = self._section
 +
local disputes = self:_getExpandedMessage('dispute-section-link-display')
 +
if section then
 +
return string.format(
 +
'[[%s:%s#%s|%s]]',
 +
mw.site.namespaces[self._title.namespace].talk.name,
 +
self._title.text,
 +
section,
 +
disputes
 +
)
 +
else
 +
return disputes
 
end
 
end
 
end
 
end
Line 446: Line 480:
 
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 452: Line 495:
 
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 460: Line 501:
 
requestType = requestType or 'full'
 
requestType = requestType or 'full'
 
 
-- Get the display value.
+
return mEditRequest.exportLinkToLua{type = requestType, display = display}
local display = self:_getExpandedMessage('edit-request-display')
 
 
 
return mEditRequest._link{type = requestType, display = display}
 
 
end
 
end
  
 
function Blurb:_makeExpiryParameter()
 
function Blurb:_makeExpiryParameter()
 
local expiry = self._protectionObj.expiry
 
local expiry = self._protectionObj.expiry
if type(expiry) == 'number' then
+
if expiry == 'indef' then
return self:_formatDate(expiry)
+
return nil
else
+
elseif type(expiry) == 'number' then
 +
return Blurb.formatDate(expiry)
 +
elseif expiry then
 +
-- Expiry is an error string.
 
return expiry
 
return expiry
 
end
 
end
Line 476: Line 517:
  
 
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 talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
+
local namespace = self._title.namespace
 +
local isTalk = self._title.isTalkPage
  
-- Find the message in the explanation blurb table and substitute any
+
-- @TODO: add semi-protection and pending changes blurbs
-- parameters.
+
local key
local explanations = self._cfg.explanationBlurbs
+
if namespace == 8 then
local msg
+
-- MediaWiki namespace
if explanations[action][level] and explanations[action][level][talkKey] then
+
key = 'explanation-blurb-full-nounprotect'
msg = explanations[action][level][talkKey]
+
elseif action == 'edit' and level == 'sysop' and not isTalk then
elseif explanations[action][level] and explanations[action][level].default then
+
key = 'explanation-blurb-full-subject'
msg = explanations[action][level].default
+
elseif action == 'move' then
elseif explanations[action].default and explanations[action].default[talkKey] then
+
if isTalk then
msg = explanations[action].default[talkKey]
+
key = 'explanation-blurb-move-talk'
elseif explanations[action].default and explanations[action].default.default then
+
else
msg = explanations[action].default.default
+
key = 'explanation-blurb-move-subject'
 +
end
 +
elseif action == 'create' then
 +
local xfd = self._deletionDiscussion
 +
if xfd then
 +
key = 'explanation-blurb-create-xfd'
 +
else
 +
key = 'explanation-blurb-create-noxfd'
 +
end
 
else
 
else
error(string.format(
+
key = 'explanation-blurb-default'
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
 
action,
 
level,
 
talkKey
 
), 8)
 
 
end
 
end
return self:_substituteParameters(msg)
+
return self:_getExpandedMessage(key)
 
end
 
end
  
Line 526: Line 564:
  
 
function Blurb:_makeIntroBlurbParameter()
 
function Blurb:_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() then
+
local expiry = self._protectionObj.expiry
 +
if type(expiry) == 'number' then
 
return self:_getExpandedMessage('intro-blurb-expiry')
 
return self:_getExpandedMessage('intro-blurb-expiry')
 
else
 
else
Line 533: Line 572:
 
end
 
end
  
function Blurb:_makeIntroFragmentParameter()
+
function Blurb:_makeOfficeBlurbParameter()
if self._protectionObj:isTemporary() then
+
local protectionDate = self._protectionObj.protectionDate
return self:_getExpandedMessage('intro-fragment-expiry')
+
if protectionDate then
 +
return self:_getExpandedMessage('office-blurb-protectiondate')
 
else
 
else
return self:_getExpandedMessage('intro-fragment-noexpiry')
+
return self:_getExpandedMessage('office-blurb-noprotectiondate')
 
end
 
end
 
end
 
end
Line 543: Line 583:
 
function Blurb:_makePagetypeParameter()
 
function Blurb:_makePagetypeParameter()
 
local pagetypes = self._cfg.pagetypes
 
local pagetypes = self._cfg.pagetypes
return pagetypes[self._protectionObj.title.namespace]
+
local namespace = self._title.namespace
or pagetypes.default
+
return pagetypes[namespace] or pagetypes.default or error('no default pagetype defined')
or error('no default pagetype defined', 8)
 
 
end
 
end
  
Line 560: Line 599:
 
msg = protectionBlurbs.edit.default
 
msg = protectionBlurbs.edit.default
 
else
 
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
+
error('no protection blurb defined for protectionBlurbs.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 568: Line 607:
 
local protectionDate = self._protectionObj.protectionDate
 
local protectionDate = self._protectionObj.protectionDate
 
if type(protectionDate) == 'number' then
 
if type(protectionDate) == 'number' then
return self:_formatDate(protectionDate)
+
return Blurb.formatDate(protectionDate)
 
else
 
else
 
return protectionDate
 
return protectionDate
Line 586: Line 625:
 
msg = protectionLevels.edit.default
 
msg = protectionLevels.edit.default
 
else
 
else
error('no protection level defined for protectionLevels.edit.default', 8)
+
error('no protection level defined for protectionLevels.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 592: Line 631:
  
 
function Blurb:_makeProtectionLogParameter()
 
function Blurb:_makeProtectionLogParameter()
local pagename = self._protectionObj.title.prefixedText
+
local action = self._protectionObj.action
if self._protectionObj.action == 'autoreview' then
+
local pagename = self._title.prefixedText
 +
if action == 'autoreview' then
 
-- We need the pending changes log.
 
-- We need the pending changes log.
return makeFullUrl(
+
return self.makeFullUrl(
 
'Special:Log',
 
'Special:Log',
 
{type = 'stable', page = pagename},
 
{type = 'stable', page = pagename},
Line 602: Line 642:
 
else
 
else
 
-- We need the protection log.
 
-- We need the protection log.
return makeFullUrl(
+
return self.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.protectionDate
 +
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._protectionObj.title.namespace].talk.name,
+
mw.site.namespaces[self._title.namespace].talk.name,
self._protectionObj.title.text,
+
self._title.text,
self._args.section or 'top',
+
section or 'top',
self:_getExpandedMessage('talk-page-link-display')
+
display
 
)
 
)
 
end
 
end
  
 
function Blurb:_makeTooltipBlurbParameter()
 
function Blurb:_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() then
+
local expiry = self._protectionObj.expiry
 +
if type(expiry) == 'number' then
 
return self:_getExpandedMessage('tooltip-blurb-expiry')
 
return self:_getExpandedMessage('tooltip-blurb-expiry')
 
else
 
else
Line 628: Line 680:
 
end
 
end
  
function Blurb:_makeTooltipFragmentParameter()
+
function Blurb:_makeVandalTemplateParameter()
if self._protectionObj:isTemporary() then
+
local mVandalM = require('Module:Vandal-m')
return self:_getExpandedMessage('tooltip-fragment-expiry')
+
local username = self._username
else
+
username = username or self._title.baseText
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
+
return mVandalM._main{username}
 +
end
 +
 
 +
-- Public methods --
 +
 
 +
function Blurb:makeReasonText()
 +
local msg = self._bannerConfig.text
 +
if msg then
 +
return self:_substituteParameters(msg)
 
end
 
end
 
end
 
end
  
function Blurb:_makeVandalTemplateParameter()
+
function Blurb:makeExplanationText()
return require('Module:Vandal-m')._main{
+
local msg = self._bannerConfig.explanation
self._args.user or self._protectionObj.title.baseText
+
return self:_substituteParameters(msg)
}
 
 
end
 
end
  
-- Public methods --
+
function Blurb:makeTooltipText()
 +
local msg = self._bannerConfig.tooltip
 +
return self:_substituteParameters(msg)
 +
end
  
function Blurb:makeBannerText(key)
+
function Blurb:makeAltText()
-- Validate input.
+
local msg = self._bannerConfig.alt
if not key or not Blurb.bannerTextFields[key] then
+
return self:_substituteParameters(msg)
error(string.format(
+
end
'"%s" is not a valid banner config field',
 
tostring(key)
 
), 2)
 
end
 
  
-- Generate the text.
+
function Blurb:makeLinkText()
local msg = self._protectionObj.bannerConfig[key]
+
local msg = self._bannerConfig.link
if type(msg) == 'string' then
+
return self:_substituteParameters(msg)
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
  
Line 675: Line 720:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local BannerTemplate = {}
+
local BannerTemplate = class('BannerTemplate')
BannerTemplate.__index = BannerTemplate
+
 
 +
function BannerTemplate:initialize(cfg)
 +
self._cfg = cfg
 +
end
 +
 
 +
function BannerTemplate:setImageFilename(filename, protectionObj)
 +
if filename then
 +
self._imageFilename = filename
 +
return nil
 +
end
  
function BannerTemplate.new(protectionObj, cfg)
+
local action = protectionObj.action
local obj = {}
+
local level = protectionObj.level
obj._cfg = cfg
+
local expiry = protectionObj.expiry
 +
local namespace = protectionObj.title.namespace
 +
 +
-- Deal with special cases first.
 +
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check?
 +
and action == 'edit'
 +
and level == 'sysop'
 +
and not expiry
 +
then
 +
-- Fully protected modules and templates get the special red "indef"
 +
-- padlock.
 +
self._imageFilename = self._cfg.msg['image-filename-indef']
 +
return nil
 +
end
  
-- Set the image filename.
+
-- Deal with regular protection types.
local imageFilename = protectionObj.bannerConfig.image
+
local images = self._cfg.images
if imageFilename then
+
if images[action] then
obj._imageFilename = imageFilename
+
if images[action][level] then
else
+
self._imageFilename = images[action][level]
-- If an image filename isn't specified explicitly in the banner config,
+
return nil
-- generate it from the protection status and the namespace.
+
elseif images[action].default then
local action = protectionObj.action
+
self._imageFilename = images[action].default
local level = protectionObj.level
+
return nil
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
 
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
  
Line 726: Line 776:
 
or self._cfg.msg['image-filename-default']
 
or self._cfg.msg['image-filename-default']
 
or 'Transparent.gif'
 
or 'Transparent.gif'
return makeFileLink{
+
return newFileLink(filename)
file = filename,
+
:width(self._imageWidth or 20)
size = (self.imageWidth or 20) .. 'px',
+
:alt(self._imageAlt)
alt = self._imageAlt,
+
:link(self._imageLink)
link = self._imageLink,
+
:caption(self._imageCaption)
caption = self.imageCaption
+
:render()
}
 
 
end
 
end
  
Line 739: Line 788:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local Banner = setmetatable({}, BannerTemplate)
+
local Banner = BannerTemplate:subclass('Banner')
Banner.__index = Banner
+
 
 +
function Banner:initialize(cfg)
 +
BannerTemplate.initialize(self, cfg)
 +
self:setImageWidth(40)
 +
end
 +
 
 +
function Banner:setReasonText(s)
 +
self._reasonText = s
 +
end
 +
 
 +
function Banner:setExplanationText(s)
 +
self._explanationText = s
 +
end
  
function Banner.new(protectionObj, blurbObj, cfg)
+
function Banner:setPage(s)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
+
-- This specifies the page to generate the banner for. This only affects
obj.imageWidth = 40
+
-- Module:Message box if the page specified is not the current page.
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
+
self._page = s
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
  
Line 755: Line 812:
 
-- Renders the banner.
 
-- Renders the banner.
 
makeMessageBox = makeMessageBox or require('Module:Message box').main
 
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
+
local reasonText = self._reasonText or error('no reason text set')
 
local explanationText = self._explanationText
 
local explanationText = self._explanationText
 
local mbargs = {
 
local mbargs = {
Line 774: Line 831:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
local Padlock = setmetatable({}, BannerTemplate)
+
local Padlock = BannerTemplate:subclass('Padlock')
Padlock.__index = Padlock
+
 
 +
function Padlock:initialize(cfg)
 +
BannerTemplate.initialize(self, cfg)
 +
self:setImageWidth(20)
 +
end
 +
 
 +
function Padlock:setImageAlt(alt)
 +
self._imageAlt = alt
 +
end
 +
 
 +
function Padlock:setImageLink(link)
 +
self._imageLink = link
 +
end
  
function Padlock.new(protectionObj, blurbObj, cfg)
+
function Padlock:setRight(px)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
+
self._right = px
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:__tostring()
 
function Padlock:__tostring()
local frame = mw.getCurrentFrame()
+
local root = mw.html.create('div')
-- The nowiki tag helps prevent whitespace at the top of articles.
+
root
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
+
:addClass('metadata topicon nopopups')
name = 'indicator',
+
:attr('id', 'protected-icon')
args = {name = self._indicatorName},
+
:css{display = 'none', right = self._right or '55px'}
content = self:renderImage()
+
:wikitext(self:renderImage())
}
+
return tostring(root)
 
end
 
end
  
Line 817: Line 878:
  
 
function p._main(args, cfg, title)
 
function p._main(args, cfg, title)
args = args or {}
+
if not cfg then
cfg = cfg or require(CONFIG_MODULE)
+
cfg = mw.loadData('Module:Protection banner/config')
 +
end
  
local protectionObj = Protection.new(args, cfg, title)
+
-- Initialise protection and blurb objects
 +
local protectionObj = Protection:new(args, cfg, title)
 +
local blurbObj = Blurb:new(protectionObj, args, cfg)
  
 
local ret = {}
 
local ret = {}
  
-- If a page's edit protection is equally or more restrictive than its
+
-- Render the banner
-- protection from some other action, then don't bother displaying anything
+
if protectionObj:isProtected() then
-- for the other action (except categories).
+
-- Get the banner object
if protectionObj.action == 'edit' or
+
local bannerObj
args.demolevel or
+
if yesno(args.small) then
not getReachableNodes(
+
bannerObj = Padlock:new(cfg)
cfg.hierarchy,
+
bannerObj:setImageTooltip(blurbObj:makeTooltipText())
protectionObj.level
+
bannerObj:setImageAlt(blurbObj:makeAltText())
)[effectiveProtectionLevel('edit', protectionObj.title)]
+
bannerObj:setImageLink(blurbObj:makeLinkText())
then
+
else
-- Initialise the blurb object
+
bannerObj = Banner:new(cfg)
local blurbObj = Blurb.new(protectionObj, args, cfg)
+
-- Large banners use the alt text for the tooltip.
+
bannerObj:setImageTooltip(blurbObj:makeAltText())
-- Render the banner
+
-- Set the text fields and the page name.
if protectionObj:isProtected() then
+
bannerObj:setReasonText(blurbObj:makeReasonText())
ret[#ret + 1] = tostring(
+
bannerObj:setExplanationText(blurbObj:makeExplanationText())
(yesno(args.small) and Padlock or Banner)
+
bannerObj:setPage(protectionObj.title.prefixedText)
.new(protectionObj, blurbObj, cfg)
 
)
 
 
end
 
end
 +
-- Set the image fields
 +
local bannerConfig = protectionObj.bannerConfig
 +
bannerObj:setImageFilename(bannerConfig.image, protectionObj)
 +
 +
ret[#ret + 1] = tostring(bannerObj)
 
end
 
end
 
+
 
-- Render the categories
 
-- Render the categories
 
if yesno(args.category) ~= false then
 
if yesno(args.category) ~= false then
Line 854: Line 921:
 
end
 
end
  
function p.main(frame, cfg)
+
function p.main(frame)
cfg = cfg or require(CONFIG_MODULE)
+
if not getArgs then
 
+
getArgs = require('Module:Arguments').getArgs
-- Find default args, if any.
 
local parent = frame.getParent and frame:getParent()
 
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
 
 
 
-- Find user args, and use the parent frame if we are being called from a
 
-- wrapper template.
 
getArgs = getArgs or require('Module:Arguments').getArgs
 
local userArgs = getArgs(frame, {
 
parentOnly = defaultArgs,
 
frameOnly = not defaultArgs
 
})
 
 
 
-- Build the args table. User-specified args overwrite default args.
 
local args = {}
 
for k, v in pairs(defaultArgs or {}) do
 
args[k] = v
 
end
 
for k, v in pairs(userArgs) do
 
args[k] = v
 
 
end
 
end
return p._main(args, cfg)
+
return p._main(getArgs(frame))
 
end
 
end
  
 
return p
 
return p

Please note that all contributions to MINR.ORG WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)