More actions
Content deleted Content added
now level |
m 11 revisions imported: import clickable buttons 2 |
||
(108 intermediate revisions by 12 users not shown) | |||
Line 4: | Line 4: | ||
-- Initialise necessary modules. |
-- Initialise necessary modules. |
||
require('Module:No globals') |
require('Module:No globals') |
||
local |
local makeFileLink = require('Module:File link')._main |
||
local newFileLink = require('Module:File link').new |
|||
local effectiveProtectionLevel = require('Module:Effective protection level')._main |
local effectiveProtectionLevel = require('Module:Effective protection level')._main |
||
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main |
|||
local yesno = require('Module:Yesno') |
local yesno = require('Module:Yesno') |
||
-- Lazily initialise modules and objects we don't always need. |
-- Lazily initialise modules and objects we don't always need. |
||
local |
local getArgs, makeMessageBox, lang |
||
-- Set constants. |
|||
local CONFIG_MODULE = 'Module:Protection banner/config' |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Helper functions |
|||
-- Protection class |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local function makeCategoryLink(cat, sort) |
|||
local Protection = class('Protection') |
|||
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 |
|||
function Protection:initialize(args, configObj, titleObj) |
|||
local function validateDate(dateString, dateType) |
|||
-- Set action |
|||
if not lang then |
|||
do |
|||
lang = mw.language.getContentLanguage() |
|||
local actions = { |
|||
end |
|||
create = true, |
|||
local success, result = pcall(lang.formatDate, lang, 'U', dateString) |
|||
edit = true, |
|||
if success then |
|||
move = true, |
|||
result = tonumber(result) |
|||
autoreview = true |
|||
if result then |
|||
} |
|||
return result |
|||
if args.action and actions[args.action] then |
|||
self.action = args.action |
|||
else |
|||
self.action = 'edit' |
|||
end |
end |
||
end |
end |
||
error(string.format( |
|||
'invalid %s: %s', |
|||
dateType, |
|||
tostring(dateString) |
|||
), 4) |
|||
end |
|||
local function makeFullUrl(page, query, display) |
|||
-- Set level |
|||
return string.format( |
|||
do |
|||
'[%s %s]', |
|||
local level = effectiveProtectionLevel(self.action, titleObj) |
|||
tostring(mw.uri.fullUrl(page, query)), |
|||
if level == 'accountcreator' then |
|||
display |
|||
-- Lump titleblacklisted pages in with template-protected pages, |
|||
) |
|||
-- since templateeditors can do both. |
|||
end |
|||
level = 'templateeditor' |
|||
-- Given a directed graph formatted as node -> table of direct successors, |
|||
-- get a table of all nodes reachable from a given node (though always |
|||
-- including the given node). |
|||
local function getReachableNodes(graph, start) |
|||
local toWalk, retval = {[start] = true}, {} |
|||
while true do |
|||
-- Can't use pairs() since we're adding and removing things as we're iterating |
|||
local k = next(toWalk) -- This always gets the "first" key |
|||
if k == nil then |
|||
return retval |
|||
end |
end |
||
toWalk[k] = nil |
|||
if self.action == 'move' and level == 'autoconfirmed' then |
|||
retval[k] = true |
|||
-- Users need to be autoconfirmed to move pages anyway, so treat |
|||
for _,v in ipairs(graph[k]) do |
|||
-- semi-move-protected pages as unprotected. |
|||
if not retval[v] then |
|||
level = '*' |
|||
toWalk[v] = true |
|||
end |
|||
end |
end |
||
self.level = level or '*' |
|||
end |
end |
||
end |
|||
-------------------------------------------------------------------------------- |
|||
-- Validation function for the expiry and the protection date |
|||
-- Protection class |
|||
local function validateDate(date, dateType) |
|||
-------------------------------------------------------------------------------- |
|||
lang = lang or mw.language.getContentLanguage() |
|||
local success, expiry = pcall(lang.formatDate, lang, 'U', args.expiry) |
|||
local Protection = {} |
|||
expiry = tonumber(expiry) |
|||
Protection.__index = Protection |
|||
if success and expiry then |
|||
return expiry |
|||
Protection.supportedActions = { |
|||
else |
|||
edit = true, |
|||
return string.format( |
|||
move = true, |
|||
'<strong class="error">Error: invalid %s ("%s")</strong>', |
|||
autoreview = true, |
|||
dateType, |
|||
upload = true |
|||
tostring(args.expiry) |
|||
} |
|||
) |
|||
end |
|||
Protection.bannerConfigFields = { |
|||
'text', |
|||
'explanation', |
|||
'tooltip', |
|||
'alt', |
|||
'link', |
|||
'image' |
|||
} |
|||
function Protection.new(args, cfg, title) |
|||
local obj = {} |
|||
obj._cfg = cfg |
|||
obj.title = title or mw.title.getCurrentTitle() |
|||
-- Set action |
|||
if not args.action then |
|||
obj.action = 'edit' |
|||
elseif Protection.supportedActions[args.action] then |
|||
obj.action = args.action |
|||
else |
|||
error(string.format( |
|||
'invalid action: %s', |
|||
tostring(args.action) |
|||
), 3) |
|||
end |
|||
-- Set level |
|||
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title) |
|||
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then |
|||
-- Users need to be autoconfirmed to move pages anyway, so treat |
|||
-- semi-move-protected pages as unprotected. |
|||
obj.level = '*' |
|||
end |
end |
||
-- Set expiry |
-- Set expiry |
||
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title) |
|||
if args.expiry then |
|||
if effectiveExpiry == 'infinity' then |
|||
local indefStrings = configObj.cfg.indefStrings |
|||
obj.expiry = 'indef' |
|||
elseif effectiveExpiry ~= 'unknown' then |
|||
self._expiry = 'indef' |
|||
obj.expiry = validateDate(effectiveExpiry, 'expiry date') |
|||
elseif type(args.expiry) == 'number' then |
|||
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]) |
|||
if reason then |
if obj.reason:find('|') 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 = {} |
|||
local cfg = configObj.cfg |
|||
local fields = { |
|||
'text', |
|||
'explanation', |
|||
'tooltip', |
|||
'alt', |
|||
'link', |
|||
'image' |
|||
} |
|||
local configTables = {} |
local configTables = {} |
||
if cfg.banners[ |
if cfg.banners[obj.action] then |
||
configTables[#configTables + 1] = cfg.banners[ |
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] |
||
end |
end |
||
if cfg.defaultBanners[ |
if cfg.defaultBanners[obj.action] then |
||
configTables[#configTables + 1] = cfg.defaultBanners[ |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] |
||
configTables[#configTables + 1] = cfg.defaultBanners[ |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default |
||
end |
end |
||
configTables[#configTables + 1] = cfg.masterBanner |
configTables[#configTables + 1] = cfg.masterBanner |
||
for i, field in ipairs( |
for i, field in ipairs(Protection.bannerConfigFields) do |
||
for j, t in ipairs(configTables) do |
for j, t in ipairs(configTables) do |
||
if t[field] then |
if t[field] then |
||
obj.bannerConfig[field] = t[field] |
|||
break |
break |
||
end |
end |
||
Line 119: | Line 168: | ||
end |
end |
||
end |
end |
||
return setmetatable(obj, Protection) |
|||
end |
end |
||
function Protection:isProtected() |
function Protection:isProtected() |
||
return self.level ~= '*' |
return self.level ~= '*' |
||
end |
|||
function Protection:isTemporary() |
|||
return type(self.expiry) == 'number' |
|||
end |
|||
function Protection:makeProtectionCategory() |
|||
local cfg = self._cfg |
|||
local title = self.title |
|||
-- Exit if the page is not protected. |
|||
if not self:isProtected() then |
|||
return '' |
|||
end |
|||
-- Get the expiry key fragment. |
|||
local expiryFragment |
|||
if self.expiry == 'indef' then |
|||
expiryFragment = self.expiry |
|||
elseif type(self.expiry) == 'number' then |
|||
expiryFragment = 'temp' |
|||
end |
|||
-- Get the namespace key fragment. |
|||
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] |
|||
if not namespaceFragment and title.namespace % 2 == 1 then |
|||
namespaceFragment = 'talk' |
|||
end |
|||
-- Define the order that key fragments are tested in. This is done with an |
|||
-- array of tables containing the value to be tested, along with its |
|||
-- position in the cfg.protectionCategories table. |
|||
local order = { |
|||
{val = expiryFragment, keypos = 1}, |
|||
{val = namespaceFragment, keypos = 2}, |
|||
{val = self.reason, keypos = 3}, |
|||
{val = self.level, keypos = 4}, |
|||
{val = self.action, keypos = 5} |
|||
} |
|||
--[[ |
|||
-- The old protection templates used an ad-hoc protection category system, |
|||
-- with some templates prioritising namespaces in their categories, and |
|||
-- others prioritising the protection reason. To emulate this in this module |
|||
-- we use the config table cfg.reasonsWithNamespacePriority to set the |
|||
-- reasons for which namespaces have priority over protection reason. |
|||
-- If we are dealing with one of those reasons, move the namespace table to |
|||
-- the end of the order table, i.e. give it highest priority. If not, the |
|||
-- reason should have highest priority, so move that to the end of the table |
|||
-- instead. |
|||
--]] |
|||
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3)) |
|||
--[[ |
|||
-- Define the attempt order. Inactive subtables (subtables with nil "value" |
|||
-- fields) are moved to the end, where they will later be given the key |
|||
-- "all". This is to cut down on the number of table lookups in |
|||
-- cfg.protectionCategories, which grows exponentially with the number of |
|||
-- non-nil keys. We keep track of the number of active subtables with the |
|||
-- noActive parameter. |
|||
--]] |
|||
local noActive, attemptOrder |
|||
do |
|||
local active, inactive = {}, {} |
|||
for i, t in ipairs(order) do |
|||
if t.val then |
|||
active[#active + 1] = t |
|||
else |
|||
inactive[#inactive + 1] = t |
|||
end |
|||
end |
|||
noActive = #active |
|||
attemptOrder = active |
|||
for i, t in ipairs(inactive) do |
|||
attemptOrder[#attemptOrder + 1] = t |
|||
end |
|||
end |
|||
--[[ |
|||
-- Check increasingly generic key combinations until we find a match. If a |
|||
-- specific category exists for the combination of key fragments we are |
|||
-- given, that match will be found first. If not, we keep trying different |
|||
-- key fragment combinations until we match using the key |
|||
-- "all-all-all-all-all". |
|||
-- |
|||
-- To generate the keys, we index the key subtables using a binary matrix |
|||
-- with indexes i and j. j is only calculated up to the number of active |
|||
-- subtables. For example, if there were three active subtables, the matrix |
|||
-- would look like this, with 0 corresponding to the key fragment "all", and |
|||
-- 1 corresponding to other key fragments. |
|||
-- |
|||
-- j 1 2 3 |
|||
-- i |
|||
-- 1 1 1 1 |
|||
-- 2 0 1 1 |
|||
-- 3 1 0 1 |
|||
-- 4 0 0 1 |
|||
-- 5 1 1 0 |
|||
-- 6 0 1 0 |
|||
-- 7 1 0 0 |
|||
-- 8 0 0 0 |
|||
-- |
|||
-- Values of j higher than the number of active subtables are set |
|||
-- to the string "all". |
|||
-- |
|||
-- A key for cfg.protectionCategories is constructed for each value of i. |
|||
-- The position of the value in the key is determined by the keypos field in |
|||
-- each subtable. |
|||
--]] |
|||
local cats = cfg.protectionCategories |
|||
for i = 1, 2^noActive do |
|||
local key = {} |
|||
for j, t in ipairs(attemptOrder) do |
|||
if j > noActive then |
|||
key[t.keypos] = 'all' |
|||
else |
|||
local quotient = i / 2 ^ (j - 1) |
|||
quotient = math.ceil(quotient) |
|||
if quotient % 2 == 1 then |
|||
key[t.keypos] = t.val |
|||
else |
|||
key[t.keypos] = 'all' |
|||
end |
|||
end |
|||
end |
|||
key = table.concat(key, '|') |
|||
local attempt = cats[key] |
|||
if attempt then |
|||
return makeCategoryLink(attempt, title.text) |
|||
end |
|||
end |
|||
return '' |
|||
end |
|||
function Protection:isIncorrect() |
|||
local expiry = self.expiry |
|||
return not self:isProtected() |
|||
or type(expiry) == 'number' and expiry < os.time() |
|||
end |
|||
function Protection:isTemplateProtectedNonTemplate() |
|||
local action, namespace = self.action, self.title.namespace |
|||
return self.level == 'templateeditor' |
|||
and ( |
|||
(action ~= 'edit' and action ~= 'move') |
|||
or (namespace ~= 10 and namespace ~= 828) |
|||
) |
|||
end |
|||
function Protection:makeCategoryLinks() |
|||
local msg = self._cfg.msg |
|||
local ret = { self:makeProtectionCategory() } |
|||
if self:isIncorrect() then |
|||
ret[#ret + 1] = makeCategoryLink( |
|||
msg['tracking-category-incorrect'], |
|||
self.title.text |
|||
) |
|||
end |
|||
if self:isTemplateProtectedNonTemplate() then |
|||
ret[#ret + 1] = makeCategoryLink( |
|||
msg['tracking-category-template'], |
|||
self.title.text |
|||
) |
|||
end |
|||
return table.concat(ret) |
|||
end |
end |
||
Line 129: | Line 344: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local Blurb = |
local Blurb = {} |
||
Blurb.__index = Blurb |
|||
Blurb.bannerTextFields = { |
|||
function Blurb:initialize(configObj, protectionObj, titleObj) |
|||
text = true, |
|||
self._configObj = configObj |
|||
explanation = true, |
|||
self._protectionObj = protectionObj |
|||
tooltip = true, |
|||
self._bannerConfig = protectionObj.bannerConfig |
|||
alt = true, |
|||
self._titleObj = titleObj |
|||
link = true |
|||
end |
|||
} |
|||
function Blurb.new(protectionObj, args, cfg) |
|||
-- Static methods -- |
|||
return setmetatable({ |
|||
_cfg = cfg, |
|||
function Blurb.makeFullUrl(page, query, display) |
|||
_protectionObj = protectionObj, |
|||
local url = mw.uri.fullUrl(page, query) |
|||
_args = args |
|||
url = tostring(url) |
|||
}, Blurb) |
|||
return string.format('[%s %s]', url, display) |
|||
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 152: | Line 371: | ||
lang.formatDate, |
lang.formatDate, |
||
lang, |
lang, |
||
'j F Y', |
self._cfg.msg['expiry-date-format'] or 'j F Y', |
||
'@' .. tostring(num) |
'@' .. tostring(num) |
||
) |
) |
||
Line 160: | Line 379: | ||
end |
end |
||
function Blurb:_getExpandedMessage(msgKey) |
|||
-- Private methods -- |
|||
return self:_substituteParameters(self._cfg.msg[msgKey]) |
|||
function Blurb:_getExpandedMessage(msg) |
|||
local msg = self._configObj.msg[msg] |
|||
return self:_substituteParameters(msg) |
|||
end |
end |
||
function Blurb:_substituteParameters(msg) |
function Blurb:_substituteParameters(msg) |
||
if not self._params then |
if not self._params then |
||
local |
local parameterFuncs = {} |
||
setmetatable(params, { |
|||
__index = function (t, k) |
|||
local param |
|||
if parameterFuncs[k] then |
|||
param = parameterFuncs[k](self) |
|||
end |
|||
param = param or '' |
|||
params[k] = param |
|||
return param |
|||
end |
|||
}) |
|||
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
||
parameterFuncs.DELETIONDISCUSSION = self._makeDeletionDiscussionParameter |
|||
parameterFuncs.DISPUTEBLURB = self._makeDisputeBlurbParameter |
|||
parameterFuncs.DISPUTESECTION = self._makeDisputeSectionParameter |
|||
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
||
parameterFuncs.EXPIRY = self._makeExpiryParameter |
parameterFuncs.EXPIRY = self._makeExpiryParameter |
||
Line 191: | Line 393: | ||
parameterFuncs.IMAGELINK = self._makeImageLinkParameter |
parameterFuncs.IMAGELINK = self._makeImageLinkParameter |
||
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter |
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter |
||
parameterFuncs. |
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter |
||
parameterFuncs.PAGETYPE = self._makePagetypeParameter |
parameterFuncs.PAGETYPE = self._makePagetypeParameter |
||
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter |
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter |
||
Line 197: | Line 399: | ||
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter |
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter |
||
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter |
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter |
||
parameterFuncs.RESETBLURB = self._makeResetBlurbParameter |
|||
parameterFuncs.TALKPAGE = self._makeTalkPageParameter |
parameterFuncs.TALKPAGE = self._makeTalkPageParameter |
||
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter |
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter |
||
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter |
|||
parameterFuncs.VANDAL = self._makeVandalTemplateParameter |
parameterFuncs.VANDAL = self._makeVandalTemplateParameter |
||
self._params = |
self._params = setmetatable({}, { |
||
__index = function (t, k) |
|||
local param |
|||
if parameterFuncs[k] then |
|||
param = parameterFuncs[k](self) |
|||
end |
|||
param = param or '' |
|||
t[k] = param |
|||
return param |
|||
end |
|||
}) |
|||
end |
end |
||
Line 212: | Line 424: | ||
-- A link to the page history or the move log, depending on the kind of |
-- A link to the page history or the move log, depending on the kind of |
||
-- protection. |
-- protection. |
||
local |
local pagename = self._protectionObj.title.prefixedText |
||
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 |
return makeFullUrl( |
||
'Special:Log', |
'Special:Log', |
||
{type = 'move', page = pagename}, |
{type = 'move', page = pagename}, |
||
Line 223: | Line 434: | ||
else |
else |
||
-- We need the history link. |
-- We need the history link. |
||
return |
return makeFullUrl( |
||
pagename, |
pagename, |
||
{action = 'history'}, |
{action = 'history'}, |
||
self:_getExpandedMessage('current-version-edit-display') |
self:_getExpandedMessage('current-version-edit-display') |
||
) |
) |
||
end |
|||
end |
|||
function Blurb:_makeDeletionDiscussionLinkParameter() |
|||
local deletionDiscussionPage = self._deletionDiscussionPage |
|||
if deletionDiscussionPage then |
|||
local display = self:_getExpandedMessage('deletion-discussion-link-display') |
|||
return string.format('[[%s|%s]]', deletionDiscussionPage, display) |
|||
end |
|||
end |
|||
function Blurb:_makeDisputeBlurbParameter() |
|||
local expiry = self._protectionObj:getExpiry() |
|||
if type(expiry) == 'number' then |
|||
return self:_getExpandedMessage('dispute-blurb-expiry') |
|||
else |
|||
return self:_getExpandedMessage('dispute-blurb-noexpiry') |
|||
end |
|||
end |
|||
function Blurb:_makeDisputeSectionParameter() |
|||
-- "disputes", with or without a section link |
|||
local section = self._section |
|||
local disputes = self:_getExpandedMessage('dispute-section-link-display') |
|||
if section then |
|||
return string.format( |
|||
'[[%s:%s#%s|%s]]', |
|||
mw.site.namespaces[self._titleObj.namespace].talk.name, |
|||
self._titleObj.text, |
|||
section, |
|||
disputes |
|||
) |
|||
else |
|||
return disputes |
|||
end |
end |
||
end |
end |
||
Line 269: | Line 446: | ||
local action = self._protectionObj.action |
local action = self._protectionObj.action |
||
local level = self._protectionObj.level |
local level = self._protectionObj.level |
||
-- Get the display message key. |
|||
local key |
|||
if action == 'edit' and level == 'autoconfirmed' then |
|||
key = 'edit-request-semi-display' |
|||
else |
|||
key = 'edit-request-full-display' |
|||
end |
|||
local display = self:_getExpandedMessage(key) |
|||
-- Get the edit request type. |
-- Get the edit request type. |
||
Line 284: | Line 452: | ||
if level == 'autoconfirmed' then |
if level == 'autoconfirmed' then |
||
requestType = 'semi' |
requestType = 'semi' |
||
elseif level == 'extendedconfirmed' then |
|||
requestType = 'extended' |
|||
elseif level == 'templateeditor' then |
elseif level == 'templateeditor' then |
||
requestType = 'template' |
requestType = 'template' |
||
Line 290: | Line 460: | ||
requestType = requestType or 'full' |
requestType = requestType or 'full' |
||
-- 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 |
local expiry = self._protectionObj.expiry |
||
if expiry == ' |
if type(expiry) == 'number' then |
||
return |
return self:_formatDate(expiry) |
||
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 306: | Line 476: | ||
function Blurb:_makeExplanationBlurbParameter() |
function Blurb:_makeExplanationBlurbParameter() |
||
-- Cover special cases first. |
|||
if self._protectionObj.title.namespace == 8 then |
|||
-- MediaWiki namespace |
|||
return self:_getExpandedMessage('explanation-blurb-nounprotect') |
|||
end |
|||
-- Get explanation blurb table keys |
|||
local action = self._protectionObj.action |
local action = self._protectionObj.action |
||
local level = self._protectionObj.level |
local level = self._protectionObj.level |
||
local |
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject' |
||
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: |
return self:_substituteParameters(msg) |
||
end |
end |
||
function Blurb:_makeImageLinkParameter() |
function Blurb:_makeImageLinkParameter() |
||
local imageLinks = self. |
local imageLinks = self._cfg.imageLinks |
||
local action = self._protectionObj.action |
local action = self._protectionObj.action |
||
local level = self._protectionObj.level |
local level = self._protectionObj.level |
||
Line 353: | Line 526: | ||
function Blurb:_makeIntroBlurbParameter() |
function Blurb:_makeIntroBlurbParameter() |
||
if self._protectionObj:isTemporary() then |
|||
if type(expiry) == 'number' then |
|||
return self:_getExpandedMessage('intro-blurb-expiry') |
return self:_getExpandedMessage('intro-blurb-expiry') |
||
else |
else |
||
Line 361: | Line 533: | ||
end |
end |
||
function Blurb: |
function Blurb:_makeIntroFragmentParameter() |
||
if self._protectionObj:isTemporary() then |
|||
return self:_getExpandedMessage('intro-fragment-expiry') |
|||
if protectionDate then |
|||
return self:_getExpandedMessage('office-blurb-protectiondate') |
|||
else |
else |
||
return self:_getExpandedMessage(' |
return self:_getExpandedMessage('intro-fragment-noexpiry') |
||
end |
end |
||
end |
end |
||
function Blurb:_makePagetypeParameter() |
function Blurb:_makePagetypeParameter() |
||
local pagetypes = self. |
local pagetypes = self._cfg.pagetypes |
||
return pagetypes[self._protectionObj.title.namespace] |
|||
or pagetypes.default |
|||
or error('no default pagetype defined', 8) |
|||
end |
end |
||
function Blurb:_makeProtectionBlurbParameter() |
function Blurb:_makeProtectionBlurbParameter() |
||
local protectionBlurbs = self. |
local protectionBlurbs = self._cfg.protectionBlurbs |
||
local action = self._protectionObj.action |
local action = self._protectionObj.action |
||
local level = self._protectionObj.level |
local level = self._protectionObj.level |
||
Line 388: | Line 560: | ||
msg = protectionBlurbs.edit.default |
msg = protectionBlurbs.edit.default |
||
else |
else |
||
error('no protection blurb defined for |
error('no protection blurb defined for protectionBlurbs.edit.default', 8) |
||
end |
end |
||
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
||
Line 394: | Line 566: | ||
function Blurb:_makeProtectionDateParameter() |
function Blurb:_makeProtectionDateParameter() |
||
local protectionDate = self._protectionObj |
local protectionDate = self._protectionObj.protectionDate |
||
if type(protectionDate) == 'number' then |
if type(protectionDate) == 'number' then |
||
return |
return self:_formatDate(protectionDate) |
||
else |
else |
||
return protectionDate |
return protectionDate |
||
Line 403: | Line 575: | ||
function Blurb:_makeProtectionLevelParameter() |
function Blurb:_makeProtectionLevelParameter() |
||
local protectionLevels = self. |
local protectionLevels = self._cfg.protectionLevels |
||
local action = self._protectionObj.action |
local action = self._protectionObj.action |
||
local level = self._protectionObj.level |
local level = self._protectionObj.level |
||
Line 414: | Line 586: | ||
msg = protectionLevels.edit.default |
msg = protectionLevels.edit.default |
||
else |
else |
||
error('no protection level defined for |
error('no protection level defined for protectionLevels.edit.default', 8) |
||
end |
end |
||
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
||
Line 420: | Line 592: | ||
function Blurb:_makeProtectionLogParameter() |
function Blurb:_makeProtectionLogParameter() |
||
local |
local pagename = self._protectionObj.title.prefixedText |
||
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 |
return makeFullUrl( |
||
'Special:Log', |
'Special:Log', |
||
{type = 'stable', page = pagename}, |
{type = 'stable', page = pagename}, |
||
Line 431: | Line 602: | ||
else |
else |
||
-- We need the protection log. |
-- We need the protection log. |
||
return |
return makeFullUrl( |
||
'Special:Log', |
'Special:Log', |
||
{type = 'protect', page = pagename}, |
{type = 'protect', page = pagename}, |
||
self:_getExpandedMessage('protection-log-display') |
self:_getExpandedMessage('protection-log-display') |
||
) |
) |
||
end |
|||
end |
|||
function Blurb:_makeResetBlurbParameter() |
|||
local protectionDate = self._protectionObj:getProtectionDate() |
|||
if protectionDate then |
|||
return self:_getExpandedMessage('reset-blurb-protectiondate') |
|||
else |
|||
return self:_getExpandedMessage('reset-blurb-noprotectiondate') |
|||
end |
end |
||
end |
end |
||
function Blurb:_makeTalkPageParameter() |
function Blurb:_makeTalkPageParameter() |
||
local section = self._section |
|||
local display = self:_getExpandedMessage('talk-page-link-display') |
|||
return string.format( |
return string.format( |
||
'[[%s:%s#%s|%s]]', |
'[[%s:%s#%s|%s]]', |
||
mw.site.namespaces[self. |
mw.site.namespaces[self._protectionObj.title.namespace].talk.name, |
||
self. |
self._protectionObj.title.text, |
||
section or 'top', |
self._args.section or 'top', |
||
self:_getExpandedMessage('talk-page-link-display') |
|||
display |
|||
) |
) |
||
end |
end |
||
function Blurb:_makeTooltipBlurbParameter() |
function Blurb:_makeTooltipBlurbParameter() |
||
if self._protectionObj:isTemporary() then |
|||
if type(expiry) == 'number' then |
|||
return self:_getExpandedMessage('tooltip-blurb-expiry') |
return self:_getExpandedMessage('tooltip-blurb-expiry') |
||
else |
else |
||
return self:_getExpandedMessage('tooltip-blurb-noexpiry') |
return self:_getExpandedMessage('tooltip-blurb-noexpiry') |
||
end |
|||
end |
|||
function Blurb:_makeTooltipFragmentParameter() |
|||
if self._protectionObj:isTemporary() then |
|||
return self:_getExpandedMessage('tooltip-fragment-expiry') |
|||
else |
|||
return self:_getExpandedMessage('tooltip-fragment-noexpiry') |
|||
end |
end |
||
end |
end |
||
function Blurb:_makeVandalTemplateParameter() |
function Blurb:_makeVandalTemplateParameter() |
||
return require('Module:Vandal-m')._main{ |
|||
self._args.user or self._protectionObj.title.baseText |
|||
local username = self._username |
|||
} |
|||
username = username or self._titleObj.baseText |
|||
return mVandalM._main{username} |
|||
end |
end |
||
-- Public methods -- |
-- Public methods -- |
||
function Blurb: |
function Blurb:makeBannerText(key) |
||
-- Validate input. |
|||
self._deletionDiscussionPage = page |
|||
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:setUsername(username) |
|||
local msg = self._protectionObj.bannerConfig[key] |
|||
self._username = username |
|||
if type(msg) == 'string' then |
|||
end |
|||
return self:_substituteParameters(msg) |
|||
elseif type(msg) == 'function' then |
|||
function Blurb:setSection(section) |
|||
msg = msg(self._protectionObj, self._args) |
|||
self._section = section |
|||
if type(msg) ~= 'string' then |
|||
end |
|||
error(string.format( |
|||
'bad output from banner config function with key "%s"' |
|||
function Blurb:makeReasonText() |
|||
.. ' (expected string, got %s)', |
|||
local msg = self._bannerConfig.text |
|||
tostring(key), |
|||
if msg then |
|||
type(msg) |
|||
), 4) |
|||
end |
|||
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
||
end |
end |
||
end |
|||
function Blurb:makeExplanationText() |
|||
local msg = self._bannerConfig.explanation |
|||
return self:_substituteParameters(msg) |
|||
end |
|||
function Blurb:makeTooltipText() |
|||
local msg = self._bannerConfig.tooltip |
|||
return self:_substituteParameters(msg) |
|||
end |
|||
function Blurb:makeAltText() |
|||
local msg = self._bannerConfig.alt |
|||
return self:_substituteParameters(msg) |
|||
end |
|||
function Blurb:makeLinkText() |
|||
local msg = self._bannerConfig.link |
|||
return self:_substituteParameters(msg) |
|||
end |
end |
||
Line 521: | Line 675: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local BannerTemplate = |
local BannerTemplate = {} |
||
BannerTemplate.__index = BannerTemplate |
|||
function BannerTemplate |
function BannerTemplate.new(protectionObj, cfg) |
||
local obj = {} |
|||
self._configObj = configObj |
|||
obj._cfg = cfg |
|||
end |
|||
-- Set the image filename. |
|||
function BannerTemplate:setImageFilename(filename, protectionObj, titleObj) |
|||
local imageFilename = protectionObj.bannerConfig.image |
|||
if filename then |
|||
if imageFilename then |
|||
self._imageFilename = filename |
|||
obj._imageFilename = imageFilename |
|||
return nil |
|||
else |
|||
end |
|||
-- If an image filename isn't specified explicitly in the banner config, |
|||
-- generate it from the protection status and the namespace. |
|||
local action = protectionObj.action |
|||
local action = protectionObj.action |
|||
local level = protectionObj.level |
|||
local namespace = protectionObj.title.namespace |
|||
local reason = protectionObj.reason |
|||
-- Deal with special cases first. |
|||
-- Deal with special cases first. |
|||
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check? |
|||
if ( |
|||
and action == 'edit' |
|||
namespace == 10 |
|||
or namespace == 828 |
|||
and not expiry |
|||
or reason and obj._cfg.indefImageReasons[reason] |
|||
then |
|||
) |
|||
-- Fully protected modules and templates get the special red "indef" |
|||
and action == 'edit' |
|||
-- padlock. |
|||
and level == 'sysop' |
|||
self._imageFilename = self._configObj.msg['image-filename-indef'] |
|||
and not protectionObj:isTemporary() |
|||
return nil |
|||
then |
|||
end |
|||
-- Fully protected modules and templates get the special red "indef" |
|||
-- padlock. |
|||
-- Deal with regular protection types. |
|||
obj._imageFilename = obj._cfg.msg['image-filename-indef'] |
|||
local images = self._configObj.cfg.images |
|||
else |
|||
if images[action] then |
|||
-- Deal with regular protection types. |
|||
if images[action][level] then |
|||
local images = obj._cfg.images |
|||
if images[action] then |
|||
return nil |
|||
if images[action][level] then |
|||
obj._imageFilename = images[action][level] |
|||
elseif images[action].default then |
|||
return nil |
|||
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. |
or self._cfg.msg['image-filename-default'] |
||
or 'Transparent.gif' |
or 'Transparent.gif' |
||
return |
return makeFileLink{ |
||
file = filename, |
|||
:width(self._imageWidth or 20) |
|||
size = (self.imageWidth or 20) .. 'px', |
|||
alt = self._imageAlt, |
|||
link = self._imageLink, |
|||
caption = self.imageCaption |
|||
:render() |
|||
} |
|||
end |
|||
function BannerTemplate:render() |
|||
-- Dummy method, to be implemented by the subclasses. |
|||
return '' |
|||
end |
end |
||
Line 594: | Line 739: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local Banner = |
local Banner = setmetatable({}, BannerTemplate) |
||
Banner.__index = Banner |
|||
function Banner |
function Banner.new(protectionObj, blurbObj, cfg) |
||
BannerTemplate. |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
||
obj.imageWidth = 40 |
|||
self:setImageWidth(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: |
function Banner:__tostring() |
||
self._reasonText = s |
|||
end |
|||
function Banner:setExplanationText(s) |
|||
self._explanationText = s |
|||
end |
|||
function Banner:render(page) |
|||
-- Renders the banner. |
-- Renders the banner. |
||
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 = |
page = self._page, |
||
type = 'protection', |
type = 'protection', |
||
image = self:renderImage(), |
image = self:renderImage(), |
||
Line 626: | Line 767: | ||
) |
) |
||
} |
} |
||
return |
return makeMessageBox('mbox', mbargs) |
||
end |
end |
||
Line 633: | Line 774: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local Padlock = |
local Padlock = setmetatable({}, BannerTemplate) |
||
Padlock.__index = Padlock |
|||
function Padlock |
function Padlock.new(protectionObj, blurbObj, cfg) |
||
BannerTemplate. |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
||
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: |
function Padlock:__tostring() |
||
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 |
local p = {} |
||
function |
function p._exportClasses() |
||
-- This is used for testing purposes. |
|||
self._configObj = configObj |
|||
return { |
|||
self._protectionObj = protectionObj |
|||
Protection = Protection, |
|||
Blurb = Blurb, |
|||
BannerTemplate = BannerTemplate, |
|||
Banner = Banner, |
|||
Padlock = Padlock, |
|||
} |
|||
end |
end |
||
function |
function p._main(args, cfg, title) |
||
args = args or {} |
|||
self._name = name |
|||
cfg = cfg or require(CONFIG_MODULE) |
|||
end |
|||
local protectionObj = Protection.new(args, cfg, title) |
|||
function Category:render() |
|||
if self._name then |
|||
return string.format( |
|||
'[[%s:%s]]', |
|||
mw.site.namespaces[14].name, |
|||
self._name |
|||
) |
|||
end |
|||
end |
|||
local ret = {} |
|||
-------------------------------------------------------------------------------- |
|||
-- ProtectionCategory class |
|||
-------------------------------------------------------------------------------- |
|||
-- If a page's edit protection is equally or more restrictive than its |
|||
local ProtectionCategory = Category:subclass('ProtectionCategory') |
|||
-- protection from some other action, then don't bother displaying anything |
|||
-- for the other action (except categories). |
|||
function ProtectionCategory:initialize(configObj, protectionObj, titleObj) |
|||
if protectionObj.action == 'edit' or |
|||
Category.initialize(self, configObj, protectionObj) |
|||
args.demolevel or |
|||
self._titleObj = titleObj |
|||
not getReachableNodes( |
|||
end |
|||
cfg.hierarchy, |
|||
protectionObj.level |
|||
function ProtectionCategory:render() |
|||
)[effectiveProtectionLevel('edit', protectionObj.title)] |
|||
local configObj = self._configObj |
|||
then |
|||
local protectionObj = self._protectionObj |
|||
-- Initialise the blurb object |
|||
local titleObj = self._titleObj |
|||
local blurbObj = Blurb.new(protectionObj, args, cfg) |
|||
-- Render the banner |
|||
-- Get the level and exit if the page is not protected. |
|||
if protectionObj:isProtected() then |
|||
ret[#ret + 1] = tostring( |
|||
return '' |
|||
(yesno(args.small) and Padlock or Banner) |
|||
end |
|||
.new(protectionObj, blurbObj, cfg) |
|||
) |
|||
-- Get the expiry. |
|||
local expiry = protectionObj:getExpiry() |
|||
if type(expiry) == 'number' then |
|||
expiry = 'temp' |
|||
elseif expiry ~= 'indef' then |
|||
expiry = nil |
|||
end |
|||
-- Get the namespace category key. |
|||
local nskey |
|||
do |
|||
local namespace = titleObj.namespace |
|||
local categoryNamespaces = configObj.cfg.categoryNamespaceKeys |
|||
nskey = categoryNamespaces[namespace] |
|||
if not nskey and namespace % 2 == 1 then |
|||
nskey = 'talk' |
|||
end |
end |
||
end |
end |
||
-- |
-- Render the categories |
||
if yesno(args.category) ~= false then |
|||
local reason = protectionObj:getReason() |
|||
ret[#ret + 1] = protectionObj:makeCategoryLinks() |
|||
local level = protectionObj.level |
|||
--[[ |
|||
-- Define the properties table. Each property is a table containing the |
|||
-- canonical order that the property is tested in, the position the |
|||
-- property has in the category key strings, and the property value itself. |
|||
--]] |
|||
local properties = { |
|||
expiry = {order = 1, val = expiry}, |
|||
namespace = {order = 2, val = nskey}, |
|||
reason = {order = 3, val = reason}, |
|||
level = {order = 4, val = level}, |
|||
action = {order = 5, val = action} |
|||
} |
|||
--[[ |
|||
-- Apply the category order configuration, if any. The configuration value |
|||
-- will be a property string, e.g. 'reason', 'namespace', etc. The property |
|||
-- corresponding to that string is tested last (i.e. it is the most |
|||
-- important, because it keeps its specified value the longest) and the |
|||
-- other properties are tested in the canonical order. If no configuration |
|||
-- value is specified then the canonical order is used. |
|||
--]] |
|||
local configOrder = {} |
|||
do |
|||
local reasonsWithNamespacePriority = configObj.cfg.reasonsWithNamespacePriority |
|||
local namespaceFirst = reason and reasonsWithNamespacePriority[reason] or false |
|||
for propertiesKey, t in pairs(properties) do |
|||
configOrder[t.order] = t |
|||
end |
|||
if namespaceFirst then |
|||
-- Swap namespace and reason around. |
|||
local namespaceTable = table.remove(configOrder, 2) |
|||
table.insert(configOrder, 3, namespaceTable) |
|||
end |
|||
end |
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.cfg.protectionCategories |
|||
local cat |
|||
for i = 1, 2^noActive do |
|||
local key = {} |
|||
for j, t in ipairs(attemptOrder) do |
|||
if j > noActive then |
|||
key[t.order] = 'all' |
|||
else |
|||
local quotient = i / 2 ^ (j - 1) |
|||
quotient = math.ceil(quotient) |
|||
if quotient % 2 == 1 then |
|||
key[t.order] = t.val |
|||
else |
|||
key[t.order] = 'all' |
|||
end |
|||
end |
|||
end |
|||
key = table.concat(key, '-') |
|||
local attempt = cats[key] |
|||
if attempt then |
|||
cat = attempt |
|||
break |
|||
end |
|||
end |
|||
if cat then |
|||
self:setName(cat) |
|||
end |
|||
return Category.render(self) |
|||
end |
|||
-------------------------------------------------------------------------------- |
|||
-- ExpiryCategory class |
|||
-------------------------------------------------------------------------------- |
|||
local ExpiryCategory = Category:subclass('ExpiryCategory') |
|||
function ExpiryCategory:render() |
|||
local configObj = self._configObj |
|||
local protectionObj = self._protectionObj |
|||
return table.concat(ret) |
|||
local reasonsWithoutExpiryCheck = configObj.cfg.reasonsWithoutExpiryCheck |
|||
local expiryCheckActions = configObj.cfg.expiryCheckActions |
|||
local expiry = protectionObj:getExpiry() |
|||
local action = protectionObj.action |
|||
local reason = protectionObj:getReason() |
|||
if not expiry |
|||
and expiryCheckActions[action] |
|||
and reason -- the old {{pp-protected}} didn't check for expiry |
|||
and not reasonsWithoutExpiryCheck[reason] |
|||
then |
|||
self:setName(configObj.msg['tracking-category-expiry']) |
|||
end |
|||
return Category.render(self) |
|||
end |
end |
||
function p.main(frame, cfg) |
|||
-------------------------------------------------------------------------------- |
|||
cfg = cfg or require(CONFIG_MODULE) |
|||
-- ErrorCategory class |
|||
-------------------------------------------------------------------------------- |
|||
-- Find default args, if any. |
|||
local ErrorCategory = Category:subclass('ErrorCategory') |
|||
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 |
|||
function ErrorCategory:render() |
|||
-- wrapper template. |
|||
local configObj = self._configObj |
|||
getArgs = getArgs or require('Module:Arguments').getArgs |
|||
local protectionObj = self._protectionObj |
|||
local userArgs = getArgs(frame, { |
|||
parentOnly = defaultArgs, |
|||
local expiry = protectionObj:getExpiry() |
|||
frameOnly = not defaultArgs |
|||
local action = protectionObj.action |
|||
}) |
|||
local level = protectionObj.level |
|||
-- Build the args table. User-specified args overwrite default args. |
|||
if not protectionObj:isProtected() |
|||
local args = {} |
|||
or type(expiry) == 'number' and expiry < os.time() |
|||
for k, v in pairs(defaultArgs or {}) do |
|||
then |
|||
args[k] = v |
|||
self:setName(configObj.msg['tracking-category-incorrect']) |
|||
end |
end |
||
for k, v in pairs(userArgs) do |
|||
return Category.render(self) |
|||
args[k] = v |
|||
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 protectionObj = self._protectionObj |
|||
local titleObj = self._titleObj |
|||
local action = protectionObj.action |
|||
local level = protectionObj.level |
|||
local namespace = titleObj.namespace |
|||
if level == 'templateeditor' |
|||
and ( |
|||
(action ~= 'edit' and action ~= 'move') |
|||
or (namespace ~= 10 and namespace ~= 828) |
|||
) |
|||
then |
|||
self:setName(configObj.msg['tracking-category-template']) |
|||
end |
end |
||
return |
return p._main(args, cfg) |
||
end |
|||
-------------------------------------------------------------------------------- |
|||
-- ProtectionBanner class |
|||
-------------------------------------------------------------------------------- |
|||
local ProtectionBanner = {} |
|||
function ProtectionBanner.exportToWiki(frame, titleObj) |
|||
mArguments = mArguments or require('Module:Arguments') |
|||
local args = mArguments.getArgs(frame) |
|||
return ProtectionBanner.exportToLua(args, titleObj) |
|||
end |
|||
function ProtectionBanner.exportToLua(args, titleObj) |
|||
titleObj = titleObj or mw.title.getCurrentTitle() |
|||
-- Get data objects |
|||
if not config then |
|||
config = mw.loadData('Module:Protection banner/config') |
|||
end |
|||
local configObj = config |
|||
local protectionObj = Protection:new(args, configObj, titleObj) |
|||
-- Initialise the blurb object |
|||
local blurbObj = Blurb:new(configObj, protectionObj, titleObj) |
|||
blurbObj:setDeletionDiscussionPage(args.xfd) |
|||
blurbObj:setUsername(args.user) |
|||
blurbObj:setSection(args.section) |
|||
local ret = {} |
|||
-- Render the banner |
|||
if protectionObj:isProtected() then |
|||
-- Get the banner object |
|||
local isPadlock = yesno(args.small) |
|||
local bannerObj |
|||
if isPadlock then |
|||
bannerObj = Padlock:new(configObj) |
|||
else |
|||
bannerObj = Banner:new(configObj) |
|||
end |
|||
-- Set the image fields |
|||
local bannerConfig = protectionObj.bannerConfig |
|||
bannerObj:setImageFilename(bannerConfig.image, protectionObj, titleObj) |
|||
if isPadlock then |
|||
bannerObj:setImageTooltip(blurbObj:makeTooltipText()) |
|||
bannerObj:setImageAlt(blurbObj:makeAltText()) |
|||
bannerObj:setImageLink(blurbObj:makeLinkText()) |
|||
else |
|||
-- Large banners use the alt text for the tooltip. |
|||
bannerObj:setImageTooltip(blurbObj:makeAltText()) |
|||
end |
|||
-- Set the text fields |
|||
if not isPadlock then |
|||
bannerObj:setReasonText(blurbObj:makeReasonText()) |
|||
bannerObj:setExplanationText(blurbObj:makeExplanationText()) |
|||
end |
|||
ret[#ret + 1] = bannerObj:render() |
|||
end |
|||
-- Render the categories |
|||
if yesno(args.category) ~= false then |
|||
local objects = { |
|||
ProtectionCategory:new(configObj, protectionObj, titleObj), |
|||
ExpiryCategory:new(configObj, protectionObj), |
|||
ErrorCategory:new(configObj, protectionObj), |
|||
TemplateCategory:new(configObj, protectionObj, titleObj) |
|||
} |
|||
for _, obj in ipairs(objects) do |
|||
ret[#ret + 1] = obj:render() |
|||
end |
|||
end |
|||
return table.concat(ret) |
|||
end |
|||
function ProtectionBanner._exportClasses() |
|||
-- This is used to export the classes for testing purposes. |
|||
return { |
|||
Protection = Protection, |
|||
Blurb = Blurb, |
|||
BannerTemplate = BannerTemplate, |
|||
Banner = Banner, |
|||
Padlock = Padlock, |
|||
Category = Category, |
|||
ProtectionCategory = ProtectionCategory, |
|||
ErrorCategory = ErrorCategory, |
|||
ExpiryCategory = ExpiryCategory, |
|||
} |
|||
end |
end |
||
return |
return p |
Latest revision as of 00:30, 28 March 2020
Documentation for this module may be created at Module:Protection banner/doc
-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.
-- Initialise necessary modules.
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')
-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
local function makeCategoryLink(cat, sort)
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat,
sort
)
end
end
-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
if not lang then
lang = mw.language.getContentLanguage()
end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
result = tonumber(result)
if result then
return result
end
end
error(string.format(
'invalid %s: %s',
dateType,
tostring(dateString)
), 4)
end
local function makeFullUrl(page, query, display)
return string.format(
'[%s %s]',
tostring(mw.uri.fullUrl(page, query)),
display
)
end
-- Given a directed graph formatted as node -> table of direct successors,
-- get a table of all nodes reachable from a given node (though always
-- including the given node).
local function getReachableNodes(graph, start)
local toWalk, retval = {[start] = true}, {}
while true do
-- Can't use pairs() since we're adding and removing things as we're iterating
local k = next(toWalk) -- This always gets the "first" key
if k == nil then
return retval
end
toWalk[k] = nil
retval[k] = true
for _,v in ipairs(graph[k]) do
if not retval[v] then
toWalk[v] = true
end
end
end
end
--------------------------------------------------------------------------------
-- Protection class
--------------------------------------------------------------------------------
local Protection = {}
Protection.__index = Protection
Protection.supportedActions = {
edit = true,
move = true,
autoreview = true,
upload = true
}
Protection.bannerConfigFields = {
'text',
'explanation',
'tooltip',
'alt',
'link',
'image'
}
function Protection.new(args, cfg, title)
local obj = {}
obj._cfg = cfg
obj.title = title or mw.title.getCurrentTitle()
-- Set action
if not args.action then
obj.action = 'edit'
elseif Protection.supportedActions[args.action] then
obj.action = args.action
else
error(string.format(
'invalid action: %s',
tostring(args.action)
), 3)
end
-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
obj.level = '*'
end
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if effectiveExpiry == 'infinity' then
obj.expiry = 'indef'
elseif effectiveExpiry ~= 'unknown' then
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
end
-- Set reason
if args[1] then
obj.reason = mw.ustring.lower(args[1])
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
end
end
-- Set protection date
if args.date then
obj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
obj.bannerConfig = {}
local configTables = {}
if cfg.banners[obj.action] then
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
end
if cfg.defaultBanners[obj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(Protection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
obj.bannerConfig[field] = t[field]
break
end
end
end
end
return setmetatable(obj, Protection)
end
function Protection:isProtected()
return self.level ~= '*'
end
function Protection:isTemporary()
return type(self.expiry) == 'number'
end
function Protection:makeProtectionCategory()
local cfg = self._cfg
local title = self.title
-- Exit if the page is not protected.
if not self:isProtected() then
return ''
end
-- Get the expiry key fragment.
local expiryFragment
if self.expiry == 'indef' then
expiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
end
-- Get the namespace key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
if not namespaceFragment and title.namespace % 2 == 1 then
namespaceFragment = 'talk'
end
-- Define the order that key fragments are tested in. This is done with an
-- array of tables containing the value to be tested, along with its
-- position in the cfg.protectionCategories table.
local order = {
{val = expiryFragment, keypos = 1},
{val = namespaceFragment, keypos = 2},
{val = self.reason, keypos = 3},
{val = self.level, keypos = 4},
{val = self.action, keypos = 5}
}
--[[
-- The old protection templates used an ad-hoc protection category system,
-- with some templates prioritising namespaces in their categories, and
-- others prioritising the protection reason. To emulate this in this module
-- we use the config table cfg.reasonsWithNamespacePriority to set the
-- reasons for which namespaces have priority over protection reason.
-- If we are dealing with one of those reasons, move the namespace table to
-- the end of the order table, i.e. give it highest priority. If not, the
-- reason should have highest priority, so move that to the end of the table
-- instead.
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
--[[
-- Define the attempt order. Inactive subtables (subtables with nil "value"
-- fields) are moved to the end, where they will later be given the key
-- "all". This is to cut down on the number of table lookups in
-- cfg.protectionCategories, which grows exponentially with the number of
-- non-nil keys. We keep track of the number of active subtables with the
-- noActive parameter.
--]]
local noActive, attemptOrder
do
local active, inactive = {}, {}
for i, t in ipairs(order) do
if t.val then
active[#active + 1] = t
else
inactive[#inactive + 1] = t
end
end
noActive = #active
attemptOrder = active
for i, t in ipairs(inactive) do
attemptOrder[#attemptOrder + 1] = t
end
end
--[[
-- Check increasingly generic key combinations until we find a match. If a
-- specific category exists for the combination of key fragments we are
-- given, that match will be found first. If not, we keep trying different
-- key fragment combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the key subtables using a binary matrix
-- with indexes i and j. j is only calculated up to the number of active
-- subtables. For example, if there were three active subtables, the matrix
-- would look like this, with 0 corresponding to the key fragment "all", and
-- 1 corresponding to other key fragments.
--
-- j 1 2 3
-- i
-- 1 1 1 1
-- 2 0 1 1
-- 3 1 0 1
-- 4 0 0 1
-- 5 1 1 0
-- 6 0 1 0
-- 7 1 0 0
-- 8 0 0 0
--
-- Values of j higher than the number of active subtables are set
-- to the string "all".
--
-- A key for cfg.protectionCategories is constructed for each value of i.
-- The position of the value in the key is determined by the keypos field in
-- each subtable.
--]]
local cats = cfg.protectionCategories
for i = 1, 2^noActive do
local key = {}
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.keypos] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.keypos] = t.val
else
key[t.keypos] = 'all'
end
end
end
key = table.concat(key, '|')
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
return ''
end
function Protection:isIncorrect()
local expiry = self.expiry
return not self:isProtected()
or type(expiry) == 'number' and expiry < os.time()
end
function Protection:isTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
return self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end
function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local ret = { self:makeProtectionCategory() }
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-incorrect'],
self.title.text
)
end
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-template'],
self.title.text
)
end
return table.concat(ret)
end
--------------------------------------------------------------------------------
-- Blurb class
--------------------------------------------------------------------------------
local Blurb = {}
Blurb.__index = Blurb
Blurb.bannerTextFields = {
text = true,
explanation = true,
tooltip = true,
alt = true,
link = true
}
function Blurb.new(protectionObj, args, cfg)
return setmetatable({
_cfg = cfg,
_protectionObj = protectionObj,
_args = args
}, Blurb)
end
-- Private methods --
function Blurb:_formatDate(num)
-- Formats a Unix timestamp into dd Month, YYYY format.
lang = lang or mw.language.getContentLanguage()
local success, date = pcall(
lang.formatDate,
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
if success then
return date
end
end
function Blurb:_getExpandedMessage(msgKey)
return self:_substituteParameters(self._cfg.msg[msgKey])
end
function Blurb:_substituteParameters(msg)
if not self._params then
local parameterFuncs = {}
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter
parameterFuncs.EXPIRY = self._makeExpiryParameter
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter
parameterFuncs.IMAGELINK = self._makeImageLinkParameter
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter
parameterFuncs.PAGETYPE = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter
parameterFuncs.TALKPAGE = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL = self._makeVandalTemplateParameter
self._params = setmetatable({}, {
__index = function (t, k)
local param
if parameterFuncs[k] then
param = parameterFuncs[k](self)
end
param = param or ''
t[k] = param
return param
end
})
end
msg = msg:gsub('${(%u+)}', self._params)
return msg
end
function Blurb:_makeCurrentVersionParameter()
-- A link to the page history or the move log, depending on the kind of
-- protection.
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
-- We need the move log link.
return makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
self:_getExpandedMessage('current-version-move-display')
)
else
-- We need the history link.
return makeFullUrl(
pagename,
{action = 'history'},
self:_getExpandedMessage('current-version-edit-display')
)
end
end
function Blurb:_makeEditRequestParameter()
local mEditRequest = require('Module:Submit an edit request')
local action = self._protectionObj.action
local level = self._protectionObj.level
-- Get the edit request type.
local requestType
if action == 'edit' then
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
end
end
requestType = requestType or 'full'
-- Get the display value.
local display = self:_getExpandedMessage('edit-request-display')
return mEditRequest._link{type = requestType, display = display}
end
function Blurb:_makeExpiryParameter()
local expiry = self._protectionObj.expiry
if type(expiry) == 'number' then
return self:_formatDate(expiry)
else
return expiry
end
end
function Blurb:_makeExplanationBlurbParameter()
-- Cover special cases first.
if self._protectionObj.title.namespace == 8 then
-- MediaWiki namespace
return self:_getExpandedMessage('explanation-blurb-nounprotect')
end
-- Get explanation blurb table keys
local action = self._protectionObj.action
local level = self._protectionObj.level
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
-- Find the message in the explanation blurb table and substitute any
-- parameters.
local explanations = self._cfg.explanationBlurbs
local msg
if explanations[action][level] and explanations[action][level][talkKey] then
msg = explanations[action][level][talkKey]
elseif explanations[action][level] and explanations[action][level].default then
msg = explanations[action][level].default
elseif explanations[action].default and explanations[action].default[talkKey] then
msg = explanations[action].default[talkKey]
elseif explanations[action].default and explanations[action].default.default then
msg = explanations[action].default.default
else
error(string.format(
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
return self:_substituteParameters(msg)
end
function Blurb:_makeImageLinkParameter()
local imageLinks = self._cfg.imageLinks
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if imageLinks[action][level] then
msg = imageLinks[action][level]
elseif imageLinks[action].default then
msg = imageLinks[action].default
else
msg = imageLinks.edit.default
end
return self:_substituteParameters(msg)
end
function Blurb:_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-blurb-expiry')
else
return self:_getExpandedMessage('intro-blurb-noexpiry')
end
end
function Blurb:_makeIntroFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-fragment-expiry')
else
return self:_getExpandedMessage('intro-fragment-noexpiry')
end
end
function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end
function Blurb:_makeProtectionBlurbParameter()
local protectionBlurbs = self._cfg.protectionBlurbs
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionBlurbs[action][level] then
msg = protectionBlurbs[action][level]
elseif protectionBlurbs[action].default then
msg = protectionBlurbs[action].default
elseif protectionBlurbs.edit.default then
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
end
function Blurb:_makeProtectionDateParameter()
local protectionDate = self._protectionObj.protectionDate
if type(protectionDate) == 'number' then
return self:_formatDate(protectionDate)
else
return protectionDate
end
end
function Blurb:_makeProtectionLevelParameter()
local protectionLevels = self._cfg.protectionLevels
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionLevels[action][level] then
msg = protectionLevels[action][level]
elseif protectionLevels[action].default then
msg = protectionLevels[action].default
elseif protectionLevels.edit.default then
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
end
function Blurb:_makeProtectionLogParameter()
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'autoreview' then
-- We need the pending changes log.
return makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
self:_getExpandedMessage('pc-log-display')
)
else
-- We need the protection log.
return makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self:_getExpandedMessage('protection-log-display')
)
end
end
function Blurb:_makeTalkPageParameter()
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
self._protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
)
end
function Blurb:_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-blurb-expiry')
else
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
end
end
function Blurb:_makeTooltipFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-fragment-expiry')
else
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
end
end
function Blurb:_makeVandalTemplateParameter()
return require('Module:Vandal-m')._main{
self._args.user or self._protectionObj.title.baseText
}
end
-- Public methods --
function Blurb:makeBannerText(key)
-- Validate input.
if not key or not Blurb.bannerTextFields[key] then
error(string.format(
'"%s" is not a valid banner config field',
tostring(key)
), 2)
end
-- Generate the text.
local msg = self._protectionObj.bannerConfig[key]
if type(msg) == 'string' then
return self:_substituteParameters(msg)
elseif type(msg) == 'function' then
msg = msg(self._protectionObj, self._args)
if type(msg) ~= 'string' then
error(string.format(
'bad output from banner config function with key "%s"'
.. ' (expected string, got %s)',
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
end
end
--------------------------------------------------------------------------------
-- BannerTemplate class
--------------------------------------------------------------------------------
local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate
function BannerTemplate.new(protectionObj, cfg)
local obj = {}
obj._cfg = cfg
-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
obj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
-- generate it from the protection status and the namespace.
local action = protectionObj.action
local level = protectionObj.level
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason
-- Deal with special cases first.
if (
namespace == 10
or namespace == 828
or reason and obj._cfg.indefImageReasons[reason]
)
and action == 'edit'
and level == 'sysop'
and not protectionObj:isTemporary()
then
-- Fully protected modules and templates get the special red "indef"
-- padlock.
obj._imageFilename = obj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = obj._cfg.images
if images[action] then
if images[action][level] then
obj._imageFilename = images[action][level]
elseif images[action].default then
obj._imageFilename = images[action].default
end
end
end
end
return setmetatable(obj, BannerTemplate)
end
function BannerTemplate:renderImage()
local filename = self._imageFilename
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return makeFileLink{
file = filename,
size = (self.imageWidth or 20) .. 'px',
alt = self._imageAlt,
link = self._imageLink,
caption = self.imageCaption
}
end
--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------
local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner
function Banner.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 40
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
obj._reasonText = blurbObj:makeBannerText('text')
obj._explanationText = blurbObj:makeBannerText('explanation')
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
return setmetatable(obj, Banner)
end
function Banner:__tostring()
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local mbargs = {
page = self._page,
type = 'protection',
image = self:renderImage(),
text = string.format(
"'''%s'''%s",
reasonText,
explanationText and '<br />' .. explanationText or ''
)
}
return makeMessageBox('mbox', mbargs)
end
--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------
local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock
function Padlock.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
obj.imageCaption = blurbObj:makeBannerText('tooltip')
obj._imageAlt = blurbObj:makeBannerText('alt')
obj._imageLink = blurbObj:makeBannerText('link')
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
or cfg.padlockIndicatorNames.default
or 'pp-default'
return setmetatable(obj, Padlock)
end
function Padlock:__tostring()
local frame = mw.getCurrentFrame()
-- The nowiki tag helps prevent whitespace at the top of articles.
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
name = 'indicator',
args = {name = self._indicatorName},
content = self:renderImage()
}
end
--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------
local p = {}
function p._exportClasses()
-- This is used for testing purposes.
return {
Protection = Protection,
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
}
end
function p._main(args, cfg, title)
args = args or {}
cfg = cfg or require(CONFIG_MODULE)
local protectionObj = Protection.new(args, cfg, title)
local ret = {}
-- If a page's edit protection is equally or more restrictive than its
-- protection from some other action, then don't bother displaying anything
-- for the other action (except categories).
if protectionObj.action == 'edit' or
args.demolevel or
not getReachableNodes(
cfg.hierarchy,
protectionObj.level
)[effectiveProtectionLevel('edit', protectionObj.title)]
then
-- Initialise the blurb object
local blurbObj = Blurb.new(protectionObj, args, cfg)
-- Render the banner
if protectionObj:isProtected() then
ret[#ret + 1] = tostring(
(yesno(args.small) and Padlock or Banner)
.new(protectionObj, blurbObj, cfg)
)
end
end
-- Render the categories
if yesno(args.category) ~= false then
ret[#ret + 1] = protectionObj:makeCategoryLinks()
end
return table.concat(ret)
end
function p.main(frame, cfg)
cfg = cfg or require(CONFIG_MODULE)
-- Find default args, if any.
local parent = frame.getParent and frame:getParent()
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
-- Find user args, and use the parent frame if we are being called from a
-- wrapper template.
getArgs = getArgs or require('Module:Arguments').getArgs
local userArgs = getArgs(frame, {
parentOnly = defaultArgs,
frameOnly = not defaultArgs
})
-- Build the args table. User-specified args overwrite default args.
local args = {}
for k, v in pairs(defaultArgs or {}) do
args[k] = v
end
for k, v in pairs(userArgs) do
args[k] = v
end
return p._main(args, cfg)
end
return p