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 mArguments, mMessageBox, lang
−
 
 
−
-- Set constants.
 
−
local CONFIG_MODULE = 'Module:Protection banner/config'
 
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Helper functions
+
-- Config class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local function makeCategoryLink(cat, sort)
+
local Config = class('Config')
−
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,
+
function Config:initialize(data)
−
-- get a table of all nodes reachable from a given node (though always
+
data = data or mw.loadData('Module:Protection banner/config')
−
-- including the given node).
+
self._cfg = data.cfg
−
local function getReachableNodes(graph, start)
+
self._msg = data.msg
−
local toWalk, retval = {[start] = true}, {}
+
self._bannerConfigTables = {}
−
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
  
−
--------------------------------------------------------------------------------
+
function Config:getBannerConfig(protectionObj)
−
-- Protection class
+
if self._bannerConfigTables[protectionObj] then
−
--------------------------------------------------------------------------------
+
return self._bannerConfigTables[protectionObj]
−
 
 
−
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
 
else
−
error(string.format(
+
local ret = {}
−
'invalid action: %s',
+
local cfg = self._cfg
−
tostring(args.action)
+
local action = protectionObj.action
−
), 3)
+
local level = protectionObj.level
−
end
+
local reason = protectionObj.reason
−
 
+
local fields = {
−
-- Set level
+
'text',
−
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
+
'explanation',
−
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
+
'tooltip',
−
-- Users need to be autoconfirmed to move pages anyway, so treat
+
'alt',
−
-- semi-move-protected pages as unprotected.
+
'link',
−
obj.level = '*'
+
'image'
−
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 = {}
 
local configTables = {}
−
if cfg.banners[obj.action] then
+
if cfg.banners[action] then
−
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
+
configTables[#configTables + 1] = cfg.banners[action][reason]
 
end
 
end
−
if cfg.defaultBanners[obj.action] then
+
if cfg.defaultBanners[action] then
−
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
+
configTables[#configTables + 1] = cfg.defaultBanners[action][level]
−
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
+
configTables[#configTables + 1] = cfg.defaultBanners[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(fields) 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]
+
ret[field] = t[field]
 
break
 
break
 
end
 
end
 
end
 
end
 
end
 
end
 +
self._bannerConfigTables[protectionObj] = ret
 +
return ret
 
end
 
end
−
return setmetatable(obj, Protection)
 
 
end
 
end
  
−
function Protection:isProtected()
+
function Config:getConfigTable(key)
−
return self.level ~= '*'
+
local blacklist = {
 +
banners = true,
 +
defaultBanners = true,
 +
masterBanner = true
 +
}
 +
if not blacklist[key] then
 +
return self._cfg[key]
 +
else
 +
return nil
 +
end
 
end
 
end
  
−
function Protection:isTemporary()
+
function Config:getMessage(key)
−
return type(self.expiry) == 'number'
+
return self._msg[key]
 
end
 
end
  
−
function Protection:makeProtectionCategory()
+
--------------------------------------------------------------------------------
−
local cfg = self._cfg
+
-- Protection class
−
local title = self.title
+
--------------------------------------------------------------------------------
−
+
 
−
-- Exit if the page is not protected.
+
local Protection = class('Protection')
−
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.
+
function Protection:initialize(args, configObj, titleObj)
−
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
+
-- Set action
−
if not namespaceFragment and title.namespace % 2 == 1 then
+
do
−
namespaceFragment = 'talk'
+
local actions = {
 +
create = true,
 +
edit = true,
 +
move = true,
 +
autoreview = true
 +
}
 +
if args.action and actions[args.action] then
 +
self.action = args.action
 +
else
 +
self.action = 'edit'
 +
end
 
end
 
end
−
 
−
-- 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}
 
−
}
 
  
−
--[[
+
-- Set level
−
-- 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
 
do
−
local active, inactive = {}, {}
+
local level = effectiveProtectionLevel(self.action, titleObj)
−
for i, t in ipairs(order) do
+
if level == 'accountcreator' then
−
if t.val then
+
-- Lump titleblacklisted pages in with template-protected pages,
−
active[#active + 1] = t
+
-- since templateeditors can do both.
−
else
+
level = 'templateeditor'
−
inactive[#inactive + 1] = t
 
−
end
 
 
end
 
end
−
noActive = #active
+
if self.action == 'move' and level == 'autoconfirmed' then
−
attemptOrder = active
+
-- Users need to be autoconfirmed to move pages anyway, so treat
−
for i, t in ipairs(inactive) do
+
-- semi-move-protected pages as unprotected.
−
attemptOrder[#attemptOrder + 1] = t
+
level = '*'
 
end
 
end
 +
self.level = level or '*'
 
end
 
end
−
+
 
−
--[[
+
-- Validation function for the expiry and the protection date
−
-- Check increasingly generic key combinations until we find a match. If a
+
local function validateDate(date, dateType)
−
-- specific category exists for the combination of key fragments we are
+
lang = lang or mw.language.getContentLanguage()
−
-- given, that match will be found first. If not, we keep trying different
+
local success, expiry = pcall(lang.formatDate, lang, 'U', args.expiry)
−
-- key fragment combinations until we match using the key
+
expiry = tonumber(expiry)
−
-- "all-all-all-all-all".
+
if success and expiry then
−
--
+
return expiry
−
-- To generate the keys, we index the key subtables using a binary matrix
+
else
−
-- with indexes i and j. j is only calculated up to the number of active
+
return string.format(
−
-- subtables. For example, if there were three active subtables, the matrix
+
'<strong class="error">Error: invalid %s ("%s")</strong>',
−
-- would look like this, with 0 corresponding to the key fragment "all", and
+
dateType,
−
-- 1 corresponding to other key fragments.
+
tostring(args.expiry)
−
--
+
)
−
--  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
 
end
−
key = table.concat(key, '|')
+
end
−
local attempt = cats[key]
+
 
−
if attempt then
+
-- Set expiry
−
return makeCategoryLink(attempt, title.text)
+
if args.expiry then
 +
local indefStrings = configObj:getConfigTable('indefStrings')
 +
if indefStrings[args.expiry] then
 +
self.expiry = 'indef'
 +
elseif type(args.expiry) == 'number' then
 +
self.expiry = args.expiry
 +
else
 +
self.expiry = validateDate(args.expiry, 'expiry date')
 
end
 
end
 
end
 
end
−
return ''
 
−
end
 
  
−
function Protection:isIncorrect()
+
-- Set reason
−
local expiry = self.expiry
+
do
−
return not self:isProtected()
+
local reason = args.reason or args[1]
−
or type(expiry) == 'number' and expiry < os.time()
+
if reason then
−
end
+
self.reason = reason:lower()
 +
end
 +
end
  
−
function Protection:isTemplateProtectedNonTemplate()
+
-- Set protection date
−
local action, namespace = self.action, self.title.namespace
+
self.protectionDate = validateDate(args.date, 'protection date')
−
return self.level == 'templateeditor'
 
−
and (
 
−
(action ~= 'edit' and action ~= 'move')
 
−
or (namespace ~= 10 and namespace ~= 828)
 
−
)
 
 
end
 
end
  
−
function Protection:makeCategoryLinks()
+
function Protection:isProtected()
−
local msg = self._cfg.msg
+
return self._level ~= '*'
−
local ret = { self:makeProtectionCategory() }
 
−
if self:isIncorrect() then
 
−
ret[#ret + 1] = makeCategoryLink(
 
−
msg['tracking-category-incorrect'],
 
−
self.title.text
 
−
)
 
−
end
 
−
if self:isTemplateProtectedNonTemplate() then
 
−
ret[#ret + 1] = makeCategoryLink(
 
−
msg['tracking-category-template'],
 
−
self.title.text
 
−
)
 
−
end
 
−
return table.concat(ret)
 
 
end
 
end
  
Line 344: Line 167:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Blurb = {}
+
local Blurb = class('Blurb')
−
Blurb.__index = Blurb
+
 
 +
function Blurb:initialize(configObj, protectionObj, titleObj)
 +
self._configObj = configObj
 +
self._protectionObj = protectionObj
 +
self._bannerConfig = configObj:getBannerConfig(protectionObj)
 +
self._titleObj = titleObj
 +
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({
+
local url = mw.uri.fullUrl(page, query)
−
_cfg = cfg,
+
url = tostring(url)
−
_protectionObj = protectionObj,
+
return string.format('[%s %s]', url, display)
−
_args = args
 
−
}, 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 190:
 
lang.formatDate,
 
lang.formatDate,
 
lang,
 
lang,
−
self._cfg.msg['expiry-date-format'] or 'j F Y',
+
'j F Y',
 
'@' .. tostring(num)
 
'@' .. tostring(num)
 
)
 
)
Line 379: Line 198:
 
end
 
end
  
−
function Blurb:_getExpandedMessage(msgKey)
+
-- Private methods --
−
return self:_substituteParameters(self._cfg.msg[msgKey])
+
 
 +
function Blurb:_getExpandedMessage(msg)
 +
local msg = self._configObj:getMessage(msg)
 +
return self:_substituteParameters(msg)
 
end
 
end
  
 
function Blurb:_substituteParameters(msg)
 
function Blurb:_substituteParameters(msg)
 
if not self._params then
 
if not self._params then
−
local 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 229:
 
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 235:
 
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 250:
 
-- 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._titleObj.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 261:
 
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._titleObj.namespace].talk.name,
 +
self._titleObj.text,
 +
section,
 +
disputes
 +
)
 +
else
 +
return disputes
 
end
 
end
 
end
 
end
Line 446: Line 307:
 
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 322:
 
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 328:
 
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 344:
  
 
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._titleObj.namespace
 +
local isTalk = self._titleObj.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
  
 
function Blurb:_makeImageLinkParameter()
 
function Blurb:_makeImageLinkParameter()
−
local imageLinks = self._cfg.imageLinks
+
local imageLinks = self._configObj:getConfigTable('imageLinks')
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 526: Line 391:
  
 
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 399:
 
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
  
 
function Blurb:_makePagetypeParameter()
 
function Blurb:_makePagetypeParameter()
−
local pagetypes = self._cfg.pagetypes
+
local pagetypes = self._configObj:getConfigTable('pagetypes')
−
return pagetypes[self._protectionObj.title.namespace]
+
local namespace = self._titleObj.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
  
 
function Blurb:_makeProtectionBlurbParameter()
 
function Blurb:_makeProtectionBlurbParameter()
−
local protectionBlurbs = self._cfg.protectionBlurbs
+
local protectionBlurbs = self._configObj:getConfigTable('protectionBlurbs')
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 560: Line 426:
 
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 cfg.protectionBlurbs.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 568: Line 434:
 
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 575: Line 441:
  
 
function Blurb:_makeProtectionLevelParameter()
 
function Blurb:_makeProtectionLevelParameter()
−
local protectionLevels = self._cfg.protectionLevels
+
local protectionLevels = self._configObj:getConfigTable('protectionLevels')
 
local action = self._protectionObj.action
 
local action = self._protectionObj.action
 
local level = self._protectionObj.level
 
local level = self._protectionObj.level
Line 586: Line 452:
 
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 cfg.protectionLevels.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 592: Line 458:
  
 
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._titleObj.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 469:
 
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._titleObj.namespace].talk.name,
−
self._protectionObj.title.text,
+
self._titleObj.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 507:
 
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._titleObj.baseText
−
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
+
return mVandalM._main{username}
−
end
 
 
end
 
end
  
−
function Blurb:_makeVandalTemplateParameter()
+
-- Public methods --
−
return require('Module:Vandal-m')._main{
+
 
−
self._args.user or self._protectionObj.title.baseText
+
function Blurb:setDeletionDiscussionPage(page)
−
}
+
self._deletionDiscussionPage = page
 
end
 
end
  
−
-- Public methods --
+
function Blurb:setUsername(username)
 +
self._username = username
 +
end
  
−
function Blurb:makeBannerText(key)
+
function Blurb:setSection(section)
−
-- Validate input.
+
self._section = section
−
if not key or not Blurb.bannerTextFields[key] then
+
end
−
error(string.format(
 
−
'"%s" is not a valid banner config field',
 
−
tostring(key)
 
−
), 2)
 
−
end
 
  
−
-- Generate the text.
+
function Blurb:makeReasonText()
−
local msg = self._protectionObj.bannerConfig[key]
+
local msg = self._bannerConfig.text
−
if type(msg) == 'string' then
+
if msg 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)
 
return self:_substituteParameters(msg)
 
end
 
end
 +
end
 +
 +
function Blurb:makeExplanationText()
 +
local msg = self._bannerConfig.explanation
 +
return self:_substituteParameters(msg)
 +
end
 +
 +
function Blurb:makeTooltipText()
 +
local msg = self._bannerConfig.tooltip
 +
return self:_substituteParameters(msg)
 +
end
 +
 +
function Blurb:makeAltText()
 +
local msg = self._bannerConfig.alt
 +
return self:_substituteParameters(msg)
 +
end
 +
 +
function Blurb:makeLinkText()
 +
local msg = self._bannerConfig.link
 +
return self:_substituteParameters(msg)
 
end
 
end
  
Line 675: Line 559:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local BannerTemplate = {}
+
local BannerTemplate = class('BannerTemplate')
−
BannerTemplate.__index = BannerTemplate
+
 
 +
function BannerTemplate:initialize(configObj)
 +
self._configObj = configObj
 +
end
 +
 
 +
function BannerTemplate:setImageFilename(filename, protectionObj, titleObj)
 +
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 = titleObj.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._configObj:getMessage('image-filename-indef')
 +
return nil
 +
end
  
−
-- Set the image filename.
+
-- Deal with regular protection types.
−
local imageFilename = protectionObj.bannerConfig.image
+
local images = self._configObj:getConfigTable('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
  
 
function BannerTemplate:renderImage()
 
function BannerTemplate:renderImage()
 
local filename = self._imageFilename
 
local filename = self._imageFilename
−
or self._cfg.msg['image-filename-default']
+
or self._configObj:getMessage('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
 +
 
 +
function BannerTemplate:render()
 +
-- Dummy method, to be implemented by the subclasses.
 +
return ''
 
end
 
end
  
Line 739: Line 632:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Banner = setmetatable({}, BannerTemplate)
+
local Banner = BannerTemplate:subclass('Banner')
−
Banner.__index = Banner
+
 
 +
function Banner:initialize(configObj)
 +
BannerTemplate.initialize(self, configObj)
 +
self:setImageWidth(40)
 +
end
  
−
function Banner.new(protectionObj, blurbObj, cfg)
+
function Banner:setReasonText(s)
−
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
+
self._reasonText = s
−
obj.imageWidth = 40
 
−
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
 
−
obj._reasonText = blurbObj:makeBannerText('text')
 
−
obj._explanationText = blurbObj:makeBannerText('explanation')
 
−
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
 
−
return setmetatable(obj, Banner)
 
 
end
 
end
  
−
function Banner:__tostring()
+
function Banner:setExplanationText(s)
 +
self._explanationText = s
 +
end
 +
 
 +
function Banner:render(page)
 
-- Renders the banner.
 
-- Renders the banner.
−
makeMessageBox = makeMessageBox or require('Module:Message box').main
+
-- The page parameter specifies the page to generate the banner for, for
−
local reasonText = self._reasonText or error('no reason text set', 2)
+
-- testing purposes.
 +
mMessageBox = mMessageBox or require('Module:Message box')
 +
local reasonText = self._reasonText or error('no reason text set')
 
local explanationText = self._explanationText
 
local explanationText = self._explanationText
 
local mbargs = {
 
local mbargs = {
−
page = self._page,
+
page = page,
 
type = 'protection',
 
type = 'protection',
 
image = self:renderImage(),
 
image = self:renderImage(),
Line 767: Line 664:
 
)
 
)
 
}
 
}
−
return makeMessageBox('mbox', mbargs)
+
return mMessageBox.main('mbox', mbargs)
 
end
 
end
  
Line 774: Line 671:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local Padlock = setmetatable({}, BannerTemplate)
+
local Padlock = BannerTemplate:subclass('Padlock')
−
Padlock.__index = Padlock
 
  
−
function Padlock.new(protectionObj, blurbObj, cfg)
+
function Padlock:initialize(configObj)
−
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
+
BannerTemplate.initialize(self, configObj)
−
obj.imageWidth = 20
+
self:setImageWidth(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:setImageAlt(alt)
−
local frame = mw.getCurrentFrame()
+
self._imageAlt = alt
−
-- The nowiki tag helps prevent whitespace at the top of articles.
+
end
−
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
+
 
−
name = 'indicator',
+
function Padlock:setImageLink(link)
−
args = {name = self._indicatorName},
+
self._imageLink = link
−
content = self:renderImage()
+
end
−
}
+
 
 +
function Padlock:setRight(px)
 +
self._right = px
 +
end
 +
 
 +
function Padlock:render()
 +
local root = mw.html.create('div')
 +
root
 +
:addClass('metadata topicon nopopups')
 +
:attr('id', 'protected-icon')
 +
:css{display = 'none', right = self._right or '55px'}
 +
:wikitext(self:renderImage())
 +
return tostring(root)
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Exports
+
-- Category class
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local p = {}
+
local Category = class('Category')
  
−
function p._exportClasses()
+
function Category:initialize(configObj, protectionObj)
−
-- This is used for testing purposes.
+
self._configObj = configObj
−
return {
+
self._protectionObj = protectionObj
−
Protection = Protection,
+
end
−
Blurb = Blurb,
+
 
−
BannerTemplate = BannerTemplate,
+
function Category:setName(name)
−
Banner = Banner,
+
self._name = name
−
Padlock = Padlock,
 
−
}
 
 
end
 
end
  
−
function p._main(args, cfg, title)
+
function Category:render()
−
args = args or {}
+
if self._name then
−
cfg = cfg or require(CONFIG_MODULE)
+
return string.format(
 +
'[[%s:%s]]',
 +
mw.site.namespaces[14].name,
 +
self._name
 +
)
 +
end
 +
end
  
−
local protectionObj = Protection.new(args, cfg, title)
+
--------------------------------------------------------------------------------
 +
-- ProtectionCategory class
 +
--------------------------------------------------------------------------------
 +
 
 +
local ProtectionCategory = Category:subclass('ProtectionCategory')
  
−
local ret = {}
+
function ProtectionCategory:initialize(configObj, protectionObj, titleObj)
 +
Category.initialize(self, configObj, protectionObj)
 +
self._titleObj = titleObj
 +
end
  
−
-- If a page's edit protection is equally or more restrictive than its
+
function ProtectionCategory:render()
−
-- protection from some other action, then don't bother displaying anything
+
local configObj = self._configObj
−
-- for the other action (except categories).
+
local protectionObj = self._protectionObj
−
if protectionObj.action == 'edit' or
+
local titleObj = self._titleObj
−
args.demolevel or
+
−
not getReachableNodes(
+
-- Get the level and exit if the page is not protected.
−
cfg.hierarchy,
+
if not protectionObj:isProtected() then
−
protectionObj.level
+
return ''
−
)[effectiveProtectionLevel('edit', protectionObj.title)]
+
end
−
then
 
−
-- Initialise the blurb object
 
−
local blurbObj = Blurb.new(protectionObj, args, cfg)
 
 
 
−
-- Render the banner
+
-- Get the expiry.
−
if protectionObj:isProtected() then
+
local expiry = protectionObj.expiry
−
ret[#ret + 1] = tostring(
+
if type(expiry) == 'number' then
−
(yesno(args.small) and Padlock or Banner)
+
expiry = 'temp'
−
.new(protectionObj, blurbObj, cfg)
+
elseif expiry ~= 'indef' then
−
)
+
expiry = nil
 +
end
 +
 
 +
-- Get the namespace category key.
 +
local nskey
 +
do
 +
local namespace = titleObj.namespace
 +
local categoryNamespaces = configObj:getConfigTable('categoryNamespaceKeys')
 +
nskey = categoryNamespaces[namespace]
 +
if not nskey and namespace % 2 == 1 then
 +
nskey = 'talk'
 +
end
 +
end
 +
 
 +
-- Get the other inputs.
 +
local reason = protectionObj.reason
 +
local action = protectionObj.action
 +
local level = protectionObj.level
 +
 +
--[[
 +
-- Define the properties table. Each property is a table containing the
 +
-- canonical order that the property is tested in, the position the
 +
-- property has in the category key strings, and the property value itself.
 +
--]]
 +
local properties = {
 +
expiry    = {order = 1, val = expiry},
 +
namespace = {order = 2, val = nskey},
 +
reason    = {order = 3, val = reason},
 +
level    = {order = 4, val = level},
 +
action    = {order = 5, val = action}
 +
}
 +
 +
--[[
 +
-- Apply the category order configuration, if any. The configuration value
 +
-- will be a property string, e.g. 'reason', 'namespace', etc. The property
 +
-- corresponding to that string is tested last (i.e. it is the most
 +
-- important, because it keeps its specified value the longest) and the
 +
-- other properties are tested in the canonical order. If no configuration
 +
-- value is specified then the canonical order is used.
 +
--]]
 +
local configOrder = {}
 +
do
 +
local reasonsWithNamespacePriority = configObj:getConfigTable('reasonsWithNamespacePriority')
 +
local namespaceFirst = reason and reasonsWithNamespacePriority[reason] or false
 +
for propertiesKey, t in pairs(properties) do
 +
configOrder[t.order] = t
 +
end
 +
if namespaceFirst then
 +
-- Swap namespace and reason around.
 +
local namespaceTable = table.remove(configOrder, 2)
 +
table.insert(configOrder, 3, namespaceTable)
 +
end
 +
end
 +
 +
--[[
 +
-- Define the attempt order. Properties with no value defined are moved
 +
-- to the end, where they will later be given the value "all". This is
 +
-- to cut down on the number of table lookups in the cats table, which
 +
-- grows exponentially with the number of properties with valid values.
 +
-- We keep track of the number of active properties with the noActive
 +
-- parameter.
 +
--]]
 +
local noActive, attemptOrder
 +
do
 +
local active, inactive = {}, {}
 +
for i, t in ipairs(configOrder) do
 +
if t.val then
 +
active[#active + 1] = t
 +
else
 +
inactive[#inactive + 1] = t
 +
end
 +
end
 +
noActive = #active
 +
attemptOrder = active
 +
for i, t in ipairs(inactive) do
 +
attemptOrder[#attemptOrder + 1] = t
 +
end
 +
end
 +
 +
--[[
 +
-- 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('protectionCategories')
 +
local cat
 +
for i = 1, 2^noActive do
 +
local key = {}
 +
for j, t in ipairs(attemptOrder) do
 +
if j > noActive then
 +
key[t.order] = 'all'
 +
else
 +
local quotient = i / 2 ^ (j - 1)
 +
quotient = math.ceil(quotient)
 +
if quotient % 2 == 1 then
 +
key[t.order] = t.val
 +
else
 +
key[t.order] = 'all'
 +
end
 +
end
 +
end
 +
key = table.concat(key, '-')
 +
local attempt = cats[key]
 +
if attempt then
 +
cat = attempt
 +
break
 
end
 
end
 
end
 
end
 +
if cat then
 +
self:setName(cat)
 +
end
 +
return Category.render(self)
 +
end
  
−
-- Render the categories
+
--------------------------------------------------------------------------------
−
if yesno(args.category) ~= false then
+
-- ExpiryCategory class
−
ret[#ret + 1] = protectionObj:makeCategoryLinks()
+
--------------------------------------------------------------------------------
 +
 
 +
local ExpiryCategory = Category:subclass('ExpiryCategory')
 +
 
 +
function ExpiryCategory:render()
 +
local reasonsWithoutExpiryCheck = self._configObj:getConfigTable('reasonsWithoutExpiryCheck')
 +
local expiryCheckActions = self._configObj:getConfigTable('expiryCheckActions')
 +
local expiry = self._protectionObj.expiry
 +
local action = self._protectionObj.action
 +
local reason = self._protectionObj.reason
 +
 +
if not expiry
 +
and expiryCheckActions[action]
 +
and reason -- the old {{pp-protected}} didn't check for expiry
 +
and not reasonsWithoutExpiryCheck[reason]
 +
then
 +
self:setName(configObj:getMessage('tracking-category-expiry'))
 +
end
 +
return Category.render(self)
 +
end
 +
 
 +
--------------------------------------------------------------------------------
 +
-- ErrorCategory class
 +
--------------------------------------------------------------------------------
 +
 
 +
local ErrorCategory = Category:subclass('ErrorCategory')
 +
 
 +
function ErrorCategory:render()
 +
local configObj = self._configObj
 +
local protectionObj = self._protectionObj
 +
local expiry = protectionObj.expiry
 +
local action = protectionObj.action
 +
local level = protectionObj.level
 +
 
 +
if not protectionObj:isProtected()
 +
or type(expiry) == 'number' and expiry < os.time()
 +
then
 +
self:setName(configObj:getMessage('tracking-category-incorrect'))
 
end
 
end
 +
return Category.render(self)
 +
end
 +
 +
--------------------------------------------------------------------------------
 +
-- TemplateCategory class
 +
--------------------------------------------------------------------------------
 +
 +
local TemplateCategory = Category:subclass('TemplateCategory')
 +
 +
function TemplateCategory:initialize(configObj, protectionObj, titleObj)
 +
Category.initialize(self, configObj, protectionObj)
 +
self._titleObj = titleObj
 +
end
 +
 +
function TemplateCategory:render()
 +
local configObj = self._configObj
 +
local action = self._protectionObj.action
 +
local level = self._protectionObj.level
 +
local namespace = self._titleObj.namespace
 
 
−
return table.concat(ret)
+
if level == 'templateeditor'
 +
and (
 +
(action ~= 'edit' and action ~= 'move')
 +
or (namespace ~= 10 and namespace ~= 828)
 +
)
 +
then
 +
self:setName(configObj:getMessage('tracking-category-template'))
 +
end
 +
return Category.render(self)
 +
end
 +
 
 +
--------------------------------------------------------------------------------
 +
-- ProtectionBanner class
 +
--------------------------------------------------------------------------------
 +
 
 +
local ProtectionBanner = {}
 +
 
 +
function ProtectionBanner.exportToWiki(frame, titleObj)
 +
mArguments = mArguments or require('Module:Arguments')
 +
local args = mArguments.getArgs(frame)
 +
return ProtectionBanner.exportToLua(args, titleObj)
 
end
 
end
  
−
function p.main(frame, cfg)
+
function ProtectionBanner.exportToLua(args, titleObj)
−
cfg = cfg or require(CONFIG_MODULE)
+
titleObj = titleObj or mw.title.getCurrentTitle()
 +
 
 +
-- Get data objects
 +
local configObj = Config:new()
 +
local protectionObj = Protection:new(args, configObj, titleObj)
 +
 
 +
-- Initialise the blurb object
 +
local blurbObj = Blurb:new(configObj, protectionObj, titleObj)
 +
blurbObj:setDeletionDiscussionPage(args.xfd)
 +
blurbObj:setUsername(args.user)
 +
blurbObj:setSection(args.section)
 +
 
 +
local ret = {}
 +
 
 +
-- Render the banner
 +
if protectionObj:isProtected() then
 +
-- Get the banner object
 +
local isPadlock = yesno(args.small)
 +
local bannerObj
 +
if isPadlock then
 +
bannerObj = Padlock:new(configObj)
 +
else
 +
bannerObj = Banner:new(configObj)
 +
end
  
−
-- Find default args, if any.
+
-- Set the image fields
−
local parent = frame.getParent and frame:getParent()
+
local bannerConfig = configObj:getBannerConfig(protectionObj)
−
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
+
bannerObj:setImageFilename(bannerConfig.image, protectionObj, titleObj)
 +
if isPadlock then
 +
bannerObj:setImageTooltip(blurbObj:makeTooltipText())
 +
bannerObj:setImageAlt(blurbObj:makeAltText())
 +
bannerObj:setImageLink(blurbObj:makeLinkText())
 +
else
 +
-- Large banners use the alt text for the tooltip.
 +
bannerObj:setImageTooltip(blurbObj:makeAltText())
 +
end
  
−
-- Find user args, and use the parent frame if we are being called from a
+
-- Set the text fields
−
-- wrapper template.
+
if not isPadlock then
−
getArgs = getArgs or require('Module:Arguments').getArgs
+
bannerObj:setReasonText(blurbObj:makeReasonText())
−
local userArgs = getArgs(frame, {
+
bannerObj:setExplanationText(blurbObj:makeExplanationText())
−
parentOnly = defaultArgs,
+
end
−
frameOnly = not defaultArgs
 
−
})
 
  
−
-- Build the args table. User-specified args overwrite default args.
+
ret[#ret + 1] = bannerObj:render()
−
local args = {}
 
−
for k, v in pairs(defaultArgs or {}) do
 
−
args[k] = v
 
 
end
 
end
−
for k, v in pairs(userArgs) do
+
−
args[k] = v
+
-- Render the categories
 +
if yesno(args.category) ~= false then
 +
local objects = {
 +
ProtectionCategory:new(configObj, protectionObj, titleObj),
 +
ExpiryCategory:new(configObj, protectionObj),
 +
ErrorCategory:new(configObj, protectionObj),
 +
TemplateCategory:new(configObj, protectionObj, titleObj)
 +
}
 +
for _, obj in ipairs(objects) do
 +
ret[#ret + 1] = obj:render()
 +
end
 
end
 
end
−
return p._main(args, cfg)
+
 +
return table.concat(ret)
 +
end
 +
 
 +
function ProtectionBanner._exportClasses()
 +
-- This is used to export the classes for testing purposes.
 +
return {
 +
Protection = Protection,
 +
Config = Config,
 +
Blurb = Blurb,
 +
BannerTemplate = BannerTemplate,
 +
Banner = Banner,
 +
Padlock = Padlock,
 +
Category = Category,
 +
ProtectionCategory = ProtectionCategory,
 +
ErrorCategory = ErrorCategory,
 +
ExpiryCategory = ExpiryCategory,
 +
}
 
end
 
end
  
−
return p
+
return ProtectionBanner

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)
Retrieved from "https://wiki.minr.org/Module:Protection_banner"