Module:Protection banner: Difference between revisions
(allow specifying a data table to config objects for testing purposes) |
Squareblob (talk | contribs) m (1 revision imported from wikipedia:Module:Protection_banner) |
||
(129 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 |
local effectiveProtectionLevel = require('Module:Effective protection level')._main |
||
local |
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 |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local |
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 |
|||
function Config:initialize(data) |
|||
local function validateDate(dateString, dateType) |
|||
data = data or mw.loadData('Module:Protection banner/config') |
|||
if not lang then |
|||
self._cfg = data.cfg |
|||
lang = mw.language.getContentLanguage() |
|||
self._msg = data.msg |
|||
end |
|||
self._bannerConfigTables = {} |
|||
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 |
end |
||
local function makeFullUrl(page, query, display) |
|||
function Config:getBannerConfig(protectionStatusObj) |
|||
return string.format( |
|||
if self._bannerConfigTables[protectionStatusObj] then |
|||
'[%s %s]', |
|||
return self._bannerConfigTables[protectionStatusObj] |
|||
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 |
else |
||
error(string.format( |
|||
local ret = {} |
|||
'invalid action: %s', |
|||
local cfg = self._cfg |
|||
tostring(args.action) |
|||
local action = protectionStatusObj:getAction() |
|||
), 3) |
|||
local level = protectionStatusObj:getLevel() |
|||
end |
|||
local reason = protectionStatusObj:getReason() |
|||
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. |
|||
'image', |
|||
obj.level = '*' |
|||
'categoryOrder', |
|||
end |
|||
'categoryReason' |
|||
} |
|||
-- 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[action] then |
if cfg.banners[obj.action] then |
||
configTables[#configTables + 1] = cfg.banners[action][reason] |
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] |
||
end |
end |
||
if cfg.defaultBanners[action] then |
if cfg.defaultBanners[obj.action] then |
||
configTables[#configTables + 1] = cfg.defaultBanners[action][level] |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] |
||
configTables[#configTables + 1] = cfg.defaultBanners[action].default |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default |
||
end |
end |
||
configTables[#configTables + 1] = cfg.masterBanner |
|||
for i, field in ipairs(fields) do |
|||
for i, field in ipairs(Protection.bannerConfigFields) do |
|||
for j, t in ipairs(configTables) do |
for j, t in ipairs(configTables) do |
||
if t[field] then |
if t[field] then |
||
obj.bannerConfig[field] = t[field] |
|||
break |
break |
||
end |
end |
||
end |
end |
||
end |
end |
||
self._bannerConfigTables[protectionStatusObj] = ret |
|||
return ret |
|||
end |
end |
||
return setmetatable(obj, Protection) |
|||
end |
end |
||
function |
function Protection:isUserScript() |
||
-- Whether the page is a user JavaScript or CSS page. |
|||
local blacklist = { |
|||
local title = self.title |
|||
banners = true, |
|||
return title.namespace == 2 and ( |
|||
defaultBanners = true |
|||
title.contentModel == 'javascript' or title.contentModel == 'css' |
|||
} |
|||
) |
|||
if not blacklist[key] then |
|||
return self._cfg[key] |
|||
else |
|||
return nil |
|||
end |
|||
end |
end |
||
function |
function Protection:isProtected() |
||
return self. |
return self.level ~= '*' |
||
end |
end |
||
function Protection:shouldShowLock() |
|||
-------------------------------------------------------------------------------- |
|||
-- Whether we should output a banner/padlock |
|||
-- ProtectionStatus class |
|||
return self:isProtected() and not self:isUserScript() |
|||
-------------------------------------------------------------------------------- |
|||
end |
|||
-- Whether this page needs a protection category. |
|||
local ProtectionStatus = class('ProtectionStatus') |
|||
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock |
|||
function Protection:isTemporary() |
|||
function ProtectionStatus:initialize(args, configObj, titleObj) |
|||
return type(self.expiry) == 'number' |
|||
-- Set action |
|||
end |
|||
do |
|||
local actions = { |
|||
function Protection:makeProtectionCategory() |
|||
create = true, |
|||
if not self:shouldHaveProtectionCategory() then |
|||
edit = true, |
|||
return '' |
|||
move = true, |
|||
autoreview = true |
|||
} |
|||
if args.action and actions[args.action] then |
|||
self._action = args.action |
|||
else |
|||
self._action = 'edit' |
|||
end |
|||
end |
end |
||
local cfg = self._cfg |
|||
-- Set level |
|||
local title = self.title |
|||
do |
|||
local level = mProtectionLevel._main(self._action, titleObj) |
|||
-- Get the expiry key fragment. |
|||
if level == 'accountcreator' then |
|||
local expiryFragment |
|||
-- Lump titleblacklisted pages in with template-protected pages, |
|||
if self.expiry == 'indef' then |
|||
-- since templateeditors can do both. |
|||
expiryFragment = self.expiry |
|||
level = 'templateeditor' |
|||
elseif type(self.expiry) == 'number' then |
|||
end |
|||
expiryFragment = 'temp' |
|||
end |
end |
||
-- Get the namespace key fragment. |
|||
-- Validation function for the expiry and the protection date |
|||
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] |
|||
local function validateDate(date, dateType) |
|||
if not namespaceFragment and title.namespace % 2 == 1 then |
|||
lang = lang or mw.language.getContentLanguage() |
|||
namespaceFragment = 'talk' |
|||
local success, expiry = pcall(lang.formatDate, lang, 'U', args.expiry) |
|||
expiry = tonumber(expiry) |
|||
if success and expiry then |
|||
return expiry |
|||
else |
|||
return string.format( |
|||
'<strong class="error">Error: invalid %s ("%s")</strong>', |
|||
dateType, |
|||
tostring(args.expiry) |
|||
) |
|||
end |
|||
end |
end |
||
-- Define the order that key fragments are tested in. This is done with an |
|||
-- Set expiry |
|||
-- array of tables containing the value to be tested, along with its |
|||
if args.expiry then |
|||
-- position in the cfg.protectionCategories table. |
|||
local indefStrings = configObj:getConfigTable('indefStrings') |
|||
local order = { |
|||
if indefStrings[args.expiry] then |
|||
{val = expiryFragment, keypos = 1}, |
|||
self._expiry = 'indef' |
|||
{val = namespaceFragment, keypos = 2}, |
|||
elseif type(args.expiry) == 'number' then |
|||
{val = self.reason, keypos = 3}, |
|||
{val = self.level, keypos = 4}, |
|||
else |
|||
{val = self.action, keypos = 5} |
|||
self._expiry = validateDate(args.expiry, 'expiry date') |
|||
} |
|||
--[[ |
|||
-- 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 |
||
end |
end |
||
--[[ |
|||
-- Set other params |
|||
-- Check increasingly generic key combinations until we find a match. If a |
|||
self._reason = args.reason |
|||
-- specific category exists for the combination of key fragments we are |
|||
self._protectionDate = validateDate(args.date, 'protection date') |
|||
-- 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 |
end |
||
function |
function Protection:isIncorrect() |
||
local expiry = self.expiry |
|||
return not self:shouldHaveProtectionCategory() |
|||
or type(expiry) == 'number' and expiry < os.time() |
|||
end |
end |
||
function |
function Protection:isTemplateProtectedNonTemplate() |
||
local action, namespace = self.action, self.title.namespace |
|||
return self._level |
|||
return self.level == 'templateeditor' |
|||
and ( |
|||
(action ~= 'edit' and action ~= 'move') |
|||
or (namespace ~= 10 and namespace ~= 828) |
|||
) |
|||
end |
end |
||
function |
function Protection:makeCategoryLinks() |
||
local msg = self._cfg.msg |
|||
local ret = {self:makeProtectionCategory()} |
|||
end |
|||
if self:isIncorrect() then |
|||
ret[#ret + 1] = makeCategoryLink( |
|||
function ProtectionStatus:getExpiry() |
|||
msg['tracking-category-incorrect'], |
|||
return self._expiry |
|||
self.title.text |
|||
end |
|||
) |
|||
end |
|||
function ProtectionStatus:getProtectionDate() |
|||
if self:isTemplateProtectedNonTemplate() then |
|||
return self._protectionDate |
|||
ret[#ret + 1] = makeCategoryLink( |
|||
msg['tracking-category-template'], |
|||
self.title.text |
|||
) |
|||
end |
|||
return table.concat(ret) |
|||
end |
end |
||
Line 170: | Line 359: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local Blurb = |
local Blurb = {} |
||
Blurb.__index = Blurb |
|||
Blurb.bannerTextFields = { |
|||
function Blurb:initialize(configObj, protectionStatusObj, titleObj) |
|||
text = true, |
|||
self._configObj = configObj |
|||
explanation = true, |
|||
self._protectionStatusObj = protectionStatusObj |
|||
tooltip = true, |
|||
self._bannerConfig = configObj:getBannerConfig(protectionStatusObj) |
|||
alt = true, |
|||
self._titleObj = titleObj |
|||
link = true |
|||
end |
|||
} |
|||
function Blurb. |
function Blurb.new(protectionObj, args, cfg) |
||
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) |
|||
-- Formats a Unix timestamp into dd M, YYYY format. |
|||
function Blurb:_formatDate(num) |
|||
-- Formats a Unix timestamp into dd Month, YYYY format. |
|||
lang = lang or mw.language.getContentLanguage() |
lang = lang or mw.language.getContentLanguage() |
||
local success, date = pcall( |
local success, date = pcall( |
||
lang.formatDate, |
lang.formatDate, |
||
lang, |
lang, |
||
'j F Y', |
self._cfg.msg['expiry-date-format'] or 'j F Y', |
||
'@' .. tostring(num) |
'@' .. tostring(num) |
||
) |
) |
||
Line 199: | Line 394: | ||
end |
end |
||
function Blurb: |
function Blurb:_getExpandedMessage(msgKey) |
||
return self:_substituteParameters(self._cfg.msg[msgKey]) |
|||
self._deletionDiscussionPage = page |
|||
end |
|||
function Blurb:setUsername(username) |
|||
self._username = username |
|||
end |
|||
function Blurb:setSection(section) |
|||
self._section = section |
|||
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, { |
|||
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
|||
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
|||
parameterFuncs.EXPIRY = self._makeExpiryParameter |
|||
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter |
|||
parameterFuncs.IMAGELINK = self._makeImageLinkParameter |
|||
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter |
|||
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter |
|||
parameterFuncs.PAGETYPE = self._makePagetypeParameter |
|||
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter |
|||
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter |
|||
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter |
|||
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter |
|||
parameterFuncs.TALKPAGE = self._makeTalkPageParameter |
|||
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter |
|||
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter |
|||
parameterFuncs.VANDAL = self._makeVandalTemplateParameter |
|||
self._params = setmetatable({}, { |
|||
__index = function (t, k) |
__index = function (t, k) |
||
local param |
local param |
||
Line 221: | Line 426: | ||
end |
end |
||
param = param or '' |
param = param or '' |
||
t[k] = param |
|||
return param |
return param |
||
end |
end |
||
}) |
}) |
||
end |
|||
msg = msg:gsub('${(%u+)}', self._params) |
|||
parameterFuncs[1] = self._makeIntroParameter |
|||
return msg |
|||
parameterFuncs[2] = self._makeUntilParameter |
|||
end |
|||
parameterFuncs[3] = self._makeDisputesParameter |
|||
parameterFuncs[4] = self._makePagetypeParameter |
|||
function Blurb:_makeCurrentVersionParameter() |
|||
parameterFuncs[5] = self._makeProtectionDateParameter |
|||
-- A link to the page history or the move log, depending on the kind of |
|||
parameterFuncs[6] = self._makeVandalTemplateParameter |
|||
-- protection. |
|||
parameterFuncs[7] = self._makeProtectionLevelParameter |
|||
local pagename = self._protectionObj.title.prefixedText |
|||
parameterFuncs[8] = self._makeExpiryParameter |
|||
if self._protectionObj.action == 'move' then |
|||
parameterFuncs[9] = self._makeDisputeLinkParameter -- A link to the page history or the move log |
|||
-- We need the move log link. |
|||
parameterFuncs[10] = self._makeProtectionLogParameter |
|||
return makeFullUrl( |
|||
parameterFuncs[11] = self._makeTalkLinkParameter |
|||
'Special:Log', |
|||
parameterFuncs[12] = self._makeEditRequestParameter |
|||
{type = 'move', page = pagename}, |
|||
parameterFuncs[13] = self._makeRequestUnprotectionParameter |
|||
self:_getExpandedMessage('current-version-move-display') |
|||
parameterFuncs[14] = self._makeSubjectPageLinksParameter -- Adds links to edit requests and the talk page if we are on a subject page |
|||
) |
|||
parameterFuncs[15] = self._makeDeletionBlurbParameter |
|||
else |
|||
parameterFuncs[16] = self._makeDeletionDiscussionLinkParameter |
|||
-- We need the history link. |
|||
parameterFuncs[17] = self._makeDeletionLogParameter |
|||
return makeFullUrl( |
|||
parameterFuncs[18] = self._makeExplanationTextParameter |
|||
pagename, |
|||
{action = 'history'}, |
|||
self._params = params |
|||
self:_getExpandedMessage('current-version-edit-display') |
|||
) |
|||
end |
end |
||
end |
|||
function Blurb:_makeEditRequestParameter() |
|||
local mEditRequest = require('Module:Submit an edit request') |
|||
match = tonumber(match) |
|||
local action = self._protectionObj.action |
|||
return self._params[match] |
|||
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 |
end |
||
requestType = requestType or 'full' |
|||
-- Get the display value. |
|||
local display = self:_getExpandedMessage('edit-request-display') |
|||
return mEditRequest._link{type = requestType, display = display} |
|||
msg = msg:gsub('$([1-9][0-9]*)', getParameter) |
|||
return msg |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeExpiryParameter() |
||
local expiry = self._protectionObj.expiry |
|||
-- parameter $1 |
|||
if type(expiry) == 'number' then |
|||
local key |
|||
return self:_formatDate(expiry) |
|||
local action = self._protectionStatusObj:getAction() |
|||
local level = self._protectionStatusObj:getLevel() |
|||
if action == 'edit' and level == 'autoconfirmed' then |
|||
key = 'reason-text-semi' |
|||
elseif action == 'move' then |
|||
key = 'reason-text-move' |
|||
elseif action == 'create' then |
|||
key = 'reason-text-create' |
|||
else |
else |
||
return expiry |
|||
key = 'reason-text-default' |
|||
end |
end |
||
local msg = self._configObj:getMessage(key) |
|||
return self:_substituteParameters(msg) |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeExplanationBlurbParameter() |
||
-- Cover special cases first. |
|||
-- parameter $2 |
|||
if self._protectionObj.title.namespace == 8 then |
|||
-- "until" or "or until" depending on the expiry |
|||
-- MediaWiki namespace |
|||
local expiry = self._protectionStatusObj:getExpiry() |
|||
return self:_getExpandedMessage('explanation-blurb-nounprotect') |
|||
if expiry then |
|||
end |
|||
return 'or until' |
|||
-- 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 |
else |
||
error(string.format( |
|||
return 'until' |
|||
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"', |
|||
action, |
|||
level, |
|||
talkKey |
|||
), 8) |
|||
end |
end |
||
return self:_substituteParameters(msg) |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeImageLinkParameter() |
||
local imageLinks = self._cfg.imageLinks |
|||
-- parameter $3 |
|||
local action = self._protectionObj.action |
|||
-- "disputes", with or without a section link |
|||
local |
local level = self._protectionObj.level |
||
local msg |
|||
local disputes = self.configObj:getMessage('dispute-section-link-display') |
|||
if |
if imageLinks[action][level] then |
||
msg = imageLinks[action][level] |
|||
return string.format( |
|||
elseif imageLinks[action].default then |
|||
'[[%s:%s#%s|%s]]', |
|||
msg = imageLinks[action].default |
|||
mw.site.namespaces[self._titleObj.namespace].talk.name, |
|||
self._titleObj.text, |
|||
section, |
|||
disputes |
|||
) |
|||
else |
else |
||
msg = imageLinks.edit.default |
|||
return disputes |
|||
end |
end |
||
return self:_substituteParameters(msg) |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeIntroBlurbParameter() |
||
if self._protectionObj:isTemporary() then |
|||
-- parameter $4 |
|||
return self:_getExpandedMessage('intro-blurb-expiry') |
|||
local pagetypes = self._configObj:getConfigTable('bannerPagetypes') |
|||
else |
|||
local namespace = self._titleObj.namespace |
|||
return self:_getExpandedMessage('intro-blurb-noexpiry') |
|||
return pagetypes[namespace] or pagetypes.default or 'page' |
|||
end |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeIntroFragmentParameter() |
||
if self._protectionObj:isTemporary() then |
|||
-- parameter $5 |
|||
return self:_getExpandedMessage('intro-fragment-expiry') |
|||
local protectionDate = self._protectionStatusObj:getProtectionDate() |
|||
if type(protectionDate) == 'number' then |
|||
return Blurb.formatDate(protectionDate) |
|||
else |
else |
||
return self:_getExpandedMessage('intro-fragment-noexpiry') |
|||
return protectionDate |
|||
end |
end |
||
end |
end |
||
function Blurb: |
function Blurb:_makePagetypeParameter() |
||
local pagetypes = self._cfg.pagetypes |
|||
-- parameter $6 |
|||
return pagetypes[self._protectionObj.title.namespace] |
|||
local mVandalM = require('Module:Vandal-m') |
|||
or pagetypes.default |
|||
local username = self._username |
|||
or error('no default pagetype defined', 8) |
|||
username = username or self._titleObj.baseText |
|||
return mVandalM.luaMain{username} |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeProtectionBlurbParameter() |
||
local protectionBlurbs = self._cfg.protectionBlurbs |
|||
-- parameter $7 |
|||
local action = self. |
local action = self._protectionObj.action |
||
local level = self. |
local level = self._protectionObj.level |
||
local |
local msg |
||
if action |
if protectionBlurbs[action][level] then |
||
msg = protectionBlurbs[action][level] |
|||
if level == 'sysop' then |
|||
elseif protectionBlurbs[action].default then |
|||
key = 'protection-level-full' |
|||
msg = protectionBlurbs[action].default |
|||
elseif level == 'templateeditor' then |
|||
elseif protectionBlurbs.edit.default then |
|||
key = 'protection-level-template' |
|||
msg = protectionBlurbs.edit.default |
|||
elseif level == 'autoconfirmed' then |
|||
key = 'protection-level-semi' |
|||
end |
|||
elseif action == 'move' then |
|||
key = 'protection-level-move' |
|||
elseif action == 'create' then |
|||
key = 'protection-level-create' |
|||
else |
else |
||
error('no protection blurb defined for protectionBlurbs.edit.default', 8) |
|||
end |
end |
||
return self |
return self:_substituteParameters(msg) |
||
end |
end |
||
function Blurb: |
function Blurb:_makeProtectionDateParameter() |
||
local protectionDate = self._protectionObj.protectionDate |
|||
-- parameter $8 |
|||
if type(protectionDate) == 'number' then |
|||
-- @TODO: Check to see if the expiry is valid. |
|||
return self:_formatDate(protectionDate) |
|||
local expiry = self._protectionStatusObj:getExpiry() |
|||
else |
|||
if expiry == 'indef' then |
|||
return |
return protectionDate |
||
elseif type(expiry) == 'number' then |
|||
local formatted = Blurb.formatDate(expiry) |
|||
return ' until ' .. formatted |
|||
elseif expiry then |
|||
-- Expiry is an error string. |
|||
return expiry |
|||
end |
end |
||
end |
end |
||
function Blurb: |
function Blurb:_makeProtectionLevelParameter() |
||
local protectionLevels = self._cfg.protectionLevels |
|||
-- parameter $9 |
|||
local action = self._protectionObj.action |
|||
-- A link to the page history or the move log, depending on the kind of |
|||
local level = self._protectionObj.level |
|||
-- protection. |
|||
local msg |
|||
local action = self._protectionStatusObj:getAction() |
|||
if protectionLevels[action][level] then |
|||
local pagename = self._titleObj.prefixedText |
|||
msg = protectionLevels[action][level] |
|||
if action == 'move' then |
|||
elseif protectionLevels[action].default then |
|||
-- We need the move log link. |
|||
msg = protectionLevels[action].default |
|||
return self.makeFullUrl( |
|||
elseif protectionLevels.edit.default then |
|||
'Special:Log', |
|||
msg = protectionLevels.edit.default |
|||
{type = 'move', page = pagename}, |
|||
self._configObj:getMessage('dispute-move-link-display') |
|||
) |
|||
else |
else |
||
error('no protection level defined for protectionLevels.edit.default', 8) |
|||
-- We need the history link. |
|||
return self.makeFullUrl( |
|||
pagename, |
|||
{action = 'history'}, |
|||
self._configObj:getMessage('dispute-edit-link-display') |
|||
) |
|||
end |
end |
||
return self:_substituteParameters(msg) |
|||
end |
end |
||
function Blurb:_makeProtectionLogParameter() |
function Blurb:_makeProtectionLogParameter() |
||
local pagename = self._protectionObj.title.prefixedText |
|||
-- parameter $10 |
|||
if self._protectionObj.action == 'autoreview' then |
|||
local action = self._protectionStatusObj:getAction() |
|||
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}, |
||
self |
self:_getExpandedMessage('pc-log-display') |
||
) |
) |
||
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 |
self:_getExpandedMessage('protection-log-display') |
||
) |
) |
||
end |
end |
||
end |
end |
||
function Blurb: |
function Blurb:_makeTalkPageParameter() |
||
return string.format( |
|||
-- parameter $11 |
|||
local section = self._section |
|||
local display = self._configObj:getMessage('talk-page-link-display') |
|||
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: |
function Blurb:_makeTooltipBlurbParameter() |
||
if self._protectionObj:isTemporary() then |
|||
-- parameter $12 |
|||
return self:_getExpandedMessage('tooltip-blurb-expiry') |
|||
local mEditRequest = require('Module:Submit an edit request') |
|||
local action = self._protectionStatusObj:getAction() |
|||
local level = self._protectionStatusObj:getLevel() |
|||
-- Get the display message key. |
|||
local key |
|||
if action == 'edit' and level == 'autoconfirmed' then |
|||
key = 'edit-request-semi-display' |
|||
else |
else |
||
return self:_getExpandedMessage('tooltip-blurb-noexpiry') |
|||
key = 'edit-request-full-display' |
|||
end |
end |
||
local display = self._configObj:getMessage(key) |
|||
-- Get the edit request type. |
|||
local requestType |
|||
if action == 'edit' then |
|||
if level == 'autoconfirmed' then |
|||
requestType = 'semi' |
|||
elseif level == 'templateeditor' then |
|||
requestType = 'template' |
|||
end |
|||
end |
|||
requestType = requestType or 'full' |
|||
return mEditRequest.exportLinkToLua{type = requestType, display = display} |
|||
end |
end |
||
function Blurb: |
function Blurb:_makeTooltipFragmentParameter() |
||
if self._protectionObj:isTemporary() then |
|||
-- parameter $13 |
|||
return self:_getExpandedMessage('tooltip-fragment-expiry') |
|||
if self._titleObj.namespace ~= 8 then |
|||
else |
|||
-- MediaWiki pages can't be unprotected. |
|||
return self |
return self:_getExpandedMessage('tooltip-fragment-noexpiry') |
||
end |
end |
||
end |
end |
||
function Blurb: |
function Blurb:_makeVandalTemplateParameter() |
||
return mw.getCurrentFrame():expandTemplate{ |
|||
-- parameter $14 |
|||
title="vandal-m", |
|||
-- Don't display these links if we are on a talk page. |
|||
args={self._args.user or self._protectionObj.title.baseText} |
|||
if not self._titleObj.isTalkPage then |
|||
} |
|||
local msg = self._config:getMessage('semi-subject-page-links') |
|||
return self._substituteParameters(msg) |
|||
end |
|||
end |
end |
||
-- Public methods -- |
|||
function Blurb:_makeDeletionBlurbParameter() |
|||
-- parameter $15 |
|||
local deletionDiscussionPage = self._deletionDiscussionPage |
|||
local key |
|||
if deletionDiscussionPage then |
|||
key = 'deletion-discussion-blurb-xfd' |
|||
else |
|||
key = 'deletion-discussion-blurb-noxfd' |
|||
end |
|||
local msg = self._configObj:getMessage(msg) |
|||
return self._substituteParameters(msg) |
|||
end |
|||
function Blurb: |
function Blurb:makeBannerText(key) |
||
-- |
-- Validate input. |
||
if not key or not Blurb.bannerTextFields[key] then |
|||
local deletionDiscussionPage = self._deletionDiscussionPage |
|||
error(string.format( |
|||
if deletionDiscussionPage then |
|||
'"%s" is not a valid banner config field', |
|||
local display = self._configObj:getMessage('deletion-discussion-link-display') |
|||
tostring(key) |
|||
return string.format('[[%s|%s]]', deletionDiscussionPage, display) |
|||
), 2) |
|||
end |
end |
||
end |
|||
-- Generate the text. |
|||
function Blurb:_makeDeletionLogParameter() |
|||
local msg = self._protectionObj.bannerConfig[key] |
|||
-- parameter $17 |
|||
if type(msg) == 'string' then |
|||
return Blurb.makeFullUrl( |
|||
return self:_substituteParameters(msg) |
|||
'Special:Log', |
|||
elseif type(msg) == 'function' then |
|||
{type = 'delete', page = self._titleObj.prefixedText}, |
|||
msg = msg(self._protectionObj, self._args) |
|||
self._configObj:getMessage('deletion-log-link-display') |
|||
if type(msg) ~= 'string' then |
|||
) |
|||
error(string.format( |
|||
end |
|||
'bad output from banner config function with key "%s"' |
|||
.. ' (expected string, got %s)', |
|||
function Blurb:_makeExplanationTextParameter() |
|||
tostring(key), |
|||
-- parameter $18 |
|||
type(msg) |
|||
local action = self._protectionStatusObj:getAction() |
|||
), 4) |
|||
local level = self._protectionStatusObj:getLevel() |
|||
end |
|||
local key |
|||
return self:_substituteParameters(msg) |
|||
if action == 'edit' and level == 'autoconfirmed' then |
|||
key = 'explanation-text-semi' |
|||
elseif action == 'move' then |
|||
key = 'explanation-text-move' |
|||
elseif action == 'create' then |
|||
key = 'explanation-text-create' |
|||
else |
|||
key = 'explanation-text-default' |
|||
end |
end |
||
local msg = self._configObj:getMessage(key) |
|||
return self:_substituteParameters(msg) |
|||
end |
|||
function Blurb:makeReasonText() |
|||
local msg = self._bannerConfig.text |
|||
return self:_substituteParameters(msg) |
|||
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 |
end |
||
Line 542: | Line 691: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
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, action, level, namespace, expiry) |
|||
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. |
|||
if not action or not level then |
|||
local action = protectionObj.action |
|||
-- If the filename is not specified, we need the action and the level |
|||
local level = protectionObj.level |
|||
-- to find the image name. The namespace and the expiry are optional, |
|||
local namespace = protectionObj.title.namespace |
|||
-- however. |
|||
local reason = protectionObj.reason |
|||
return nil |
|||
end |
|||
-- Deal with special cases first. |
|||
if ( |
|||
-- Deal with special cases first. |
|||
namespace == 10 |
|||
if (namespace == 10 or namespace == 828) -- Maybe we don't need the namespace check? |
|||
or namespace == 828 |
|||
or reason and obj._cfg.indefImageReasons[reason] |
|||
and level == 'sysop' |
|||
) |
|||
and not expiry |
|||
and action == 'edit' |
|||
then |
|||
and level == 'sysop' |
|||
-- Fully protected modules and templates get the special red "indef" |
|||
and not protectionObj:isTemporary() |
|||
-- padlock. |
|||
then |
|||
self._imageFilename = self._configObj:getMessage('image-filename-indef') |
|||
-- Fully protected modules and templates get the special red "indef" |
|||
return nil |
|||
-- padlock. |
|||
end |
|||
obj._imageFilename = obj._cfg.msg['image-filename-indef'] |
|||
else |
|||
-- Deal with regular protection types. |
|||
-- Deal with regular protection types. |
|||
local images = self._configObj:getConfigTable('images') |
|||
local images = obj._cfg.images |
|||
if images[action] then |
|||
if images[action |
if images[action] then |
||
if images[action][level] then |
|||
obj._imageFilename = images[action][level] |
|||
return nil |
|||
elseif images[action].default then |
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:setImageAlt(alt) |
|||
self._imageAlt = alt |
|||
end |
|||
function BannerTemplate:setImageLink(link) |
|||
self._imageLink = link |
|||
end |
|||
function BannerTemplate:setImageCaption(caption) |
|||
self._imageCaption = caption |
|||
end |
end |
||
function BannerTemplate:renderImage() |
function BannerTemplate:renderImage() |
||
local filename = self. |
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 625: | Line 755: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local Banner = |
local Banner = setmetatable({}, BannerTemplate) |
||
Banner.__index = Banner |
|||
function Banner |
function Banner.new(protectionObj, blurbObj, cfg) |
||
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
|||
self:setImageWidth(40) |
|||
obj.imageWidth = 40 |
|||
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip. |
|||
obj._reasonText = blurbObj:makeBannerText('text') |
|||
obj._explanationText = blurbObj:makeBannerText('explanation') |
|||
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing. |
|||
return setmetatable(obj, Banner) |
|||
end |
end |
||
function Banner:__tostring() |
|||
-------------------------------------------------------------------------------- |
|||
-- Renders the banner. |
|||
-- Padlock class |
|||
makeMessageBox = makeMessageBox or require('Module:Message box').main |
|||
-------------------------------------------------------------------------------- |
|||
local reasonText = self._reasonText or error('no reason text set', 2) |
|||
local explanationText = self._explanationText |
|||
local Padlock = BannerTemplate:subclass('Padlock') |
|||
local mbargs = { |
|||
page = self._page, |
|||
function Padlock:initialize() |
|||
type = 'protection', |
|||
self:setImageWidth(20) |
|||
image = self:renderImage(), |
|||
text = string.format( |
|||
"'''%s'''%s", |
|||
reasonText, |
|||
explanationText and '<br />' .. explanationText or '' |
|||
) |
|||
} |
|||
return makeMessageBox('mbox', mbargs) |
|||
end |
end |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- |
-- Padlock class |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local |
local Padlock = setmetatable({}, BannerTemplate) |
||
Padlock.__index = Padlock |
|||
function Padlock.new(protectionObj, blurbObj, cfg) |
|||
function Category:initialize() |
|||
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 |
end |
||
function |
function Padlock:__tostring() |
||
local frame = mw.getCurrentFrame() |
|||
self._name = name |
|||
-- The nowiki tag helps prevent whitespace at the top of articles. |
|||
end |
|||
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{ |
|||
name = 'indicator', |
|||
function Category:export() |
|||
args = {name = self._indicatorName}, |
|||
if self._categoryName then |
|||
content = self:renderImage() |
|||
return string.format( |
|||
} |
|||
'[[%s:%s]]', |
|||
mw.site.namespaces[14].name, |
|||
self._categoryName |
|||
) |
|||
else |
|||
return '' |
|||
end |
|||
end |
end |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Exports |
|||
-- ProtectionCategory class |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local p = {} |
|||
local ProtectionCategory = Category:subclass('ProtectionCategory') |
|||
function |
function p._exportClasses() |
||
-- This is used for testing purposes. |
|||
name, |
|||
return { |
|||
configObj, |
|||
Protection = Protection, |
|||
protectionStatusObj, |
|||
Blurb = Blurb, |
|||
namespace |
|||
BannerTemplate = BannerTemplate, |
|||
) |
|||
Banner = Banner, |
|||
--[[ |
|||
Padlock = Padlock, |
|||
-- Sets the protection category. If a category name is not provided, this |
|||
-- method gets a category name from the module config, given a combination |
|||
-- of the protection type, the protection level, the namespace number, the |
|||
-- reason for protection, and the expiry date. |
|||
--]] |
|||
-- If a name was provided, use that. |
|||
if name then |
|||
Category.setName(self, name) |
|||
end |
|||
-- Get the namespace category key from the namespace number. |
|||
local nskey |
|||
do |
|||
local categoryNamespaces = configObj:getConfigTable('categoryNamespaces') |
|||
if not namespace or type(namespace) ~= 'number' then |
|||
nskey = nil |
|||
else |
|||
nskey = categoryNamespaces[ns] |
|||
if not nskey and ns % 2 == 1 then |
|||
nskey = 'talk' |
|||
end |
|||
end |
|||
end |
|||
--[[ |
|||
-- 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, keypos = 5, val = protectionStatusObj:getExpiry()}, |
|||
namespace = {order = 2, keypos = 3, val = nskey}, |
|||
reason = {order = 3, keypos = 4, val = protectionStatusObj:getReason()}, |
|||
level = {order = 4, keypos = 2, val = protectionStatusObj:getLevel()}, |
|||
action = {order = 5, keypos = 1, val = protectionStatusObj:getAction()} |
|||
} |
} |
||
--[[ |
|||
-- Apply the category order configuration, if any. The configuration value |
|||
-- will be a property string, e.g. 'reason', 'namespace', etc. The property |
|||
-- corresponding to that string is tested last (i.e. it is the most |
|||
-- important, because it keeps its specified value the longest) and the |
|||
-- other properties are tested in the canonical order. If no configuration |
|||
-- value is specified then the canonical order is used. |
|||
--]] |
|||
local configOrder = {} |
|||
do |
|||
local bannerConfig = configObj:getBannerConfig(protectionStatusObj) |
|||
local categoryOrder = bannerConfig.categoryOrder |
|||
for propertiesKey, t in pairs(properties) do |
|||
configOrder[t.order] = t |
|||
end |
|||
if categoryOrder then |
|||
local property = properties[categoryOrder] |
|||
if not property then |
|||
local msg = '"' |
|||
.. categoryOrder |
|||
.. '" is not a valid value of cfg.reasons.' |
|||
.. reason |
|||
.. '.categoryOrder' |
|||
error(msg) |
|||
end |
|||
table.insert(configOrder, table.remove(configOrder, property.order)) |
|||
end |
|||
end |
|||
--[[ |
|||
-- Define the attempt order. Properties with no value defined are moved |
|||
-- to the end, where they will later be given the value "all". This is |
|||
-- to cut down on the number of table lookups in the cats table, which |
|||
-- grows exponentially with the number of properties with valid values. |
|||
-- We keep track of the number of active properties with the noActive |
|||
-- parameter. |
|||
--]] |
|||
local noActive, attemptOrder |
|||
do |
|||
local active, inactive = {}, {} |
|||
for i, t in ipairs(configOrder) do |
|||
if t.val then |
|||
active[#active + 1] = t |
|||
else |
|||
inactive[#inactive + 1] = t |
|||
end |
|||
end |
|||
noActive = #active |
|||
attemptOrder = active |
|||
for i, t in ipairs(inactive) do |
|||
attemptOrder[#attemptOrder + 1] = t |
|||
end |
|||
end |
|||
--[[ |
|||
-- Check increasingly generic key combinations until we find a match. |
|||
-- If a specific category exists for the combination of properties |
|||
-- we are given, that match will be found first. If not, we keep |
|||
-- trying different key combinations until we match using the key |
|||
-- "all-all-all-all-all". |
|||
-- |
|||
-- To generate the keys, we index the property subtables using a |
|||
-- binary matrix with indexes i and j. j is only calculated up to |
|||
-- the number of active properties. For example, if there were three |
|||
-- active properties, the matrix would look like this, with 0 |
|||
-- corresponding to the string "all", and 1 corresponding to the |
|||
-- val field in the property table: |
|||
-- |
|||
-- j 1 2 3 |
|||
-- i |
|||
-- 1 1 1 1 |
|||
-- 2 0 1 1 |
|||
-- 3 1 0 1 |
|||
-- 4 0 0 1 |
|||
-- 5 1 1 0 |
|||
-- 6 0 1 0 |
|||
-- 7 1 0 0 |
|||
-- 8 0 0 0 |
|||
-- |
|||
-- Values of j higher than the number of active properties are set |
|||
-- to the string "all". |
|||
-- |
|||
-- A key for the category table is constructed for each value of i. |
|||
-- The correct position of the value in the key is determined by the |
|||
-- pos field in the property table. |
|||
--]] |
|||
local cats = configObj:getConfigTable('categories') |
|||
local cat |
|||
for i = 1, 2^noActive do |
|||
local key = {} |
|||
for j, t in ipairs(attemptOrder) do |
|||
if j > noActive then |
|||
key[t.keypos] = 'all' |
|||
else |
|||
local quotient = i / 2 ^ (j - 1) |
|||
quotient = math.ceil(quotient) |
|||
if quotient % 2 == 1 then |
|||
key[t.keypos] = t.val |
|||
else |
|||
key[t.keypos] = 'all' |
|||
end |
|||
end |
|||
end |
|||
key = table.concat(key, '-') |
|||
local attempt = cats[key] |
|||
if attempt then |
|||
cat = attempt |
|||
break |
|||
end |
|||
end |
|||
if cat then |
|||
Category.setName(self, cat) |
|||
else |
|||
error( |
|||
'No category match found;' |
|||
.. ' please define the category for key "all-all-all-all-all"' |
|||
) |
|||
end |
|||
end |
end |
||
function p._main(args, cfg, title) |
|||
-------------------------------------------------------------------------------- |
|||
args = args or {} |
|||
-- ExpiryCategory class |
|||
cfg = cfg or require(CONFIG_MODULE) |
|||
-------------------------------------------------------------------------------- |
|||
local protectionObj = Protection.new(args, cfg, title) |
|||
local ExpiryCategory = Category:subclass('ExpiryCategory') |
|||
local ret = {} |
|||
-------------------------------------------------------------------------------- |
|||
-- ErrorCategory class |
|||
-------------------------------------------------------------------------------- |
|||
-- If a page's edit protection is equally or more restrictive than its |
|||
local ErrorCategory = Category:subclass('ErrorCategory') |
|||
-- 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:shouldShowLock() 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 |
|||
-- ProtectionBanner class |
|||
ret[#ret + 1] = protectionObj:makeCategoryLinks() |
|||
-------------------------------------------------------------------------------- |
|||
end |
|||
local ProtectionBanner = {} |
|||
return table.concat(ret) |
|||
function ProtectionBanner.exportToWiki(frame, title) |
|||
mArguments = mArguments or require('Module:Arguments') |
|||
local args = mArguments.getArgs(frame) |
|||
return ProtectionBanner.exportToLua(args, title) |
|||
end |
end |
||
function |
function p.main(frame, cfg) |
||
cfg = cfg or require(CONFIG_MODULE) |
|||
title = title or mw.title.getCurrentTitle() |
|||
-- Find default args, if any. |
|||
-- Get data objects |
|||
local |
local parent = frame.getParent and frame:getParent() |
||
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')] |
|||
local theProtectionStatus = ProtectionStatus:new(args, theConfig, title) |
|||
-- Find user args, and use the parent frame if we are being called from a |
|||
local ret = {} |
|||
-- 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. |
|||
-- Render the banner |
|||
local |
local args = {} |
||
for k, v in pairs(defaultArgs or {}) do |
|||
if yesno(args.small) then |
|||
args[k] = v |
|||
theBanner = Padlock.new(theConfig, theProtectionStatus, title) |
|||
else |
|||
theBanner = Banner.new(theConfig, theProtectionStatus, title) |
|||
end |
end |
||
for k, v in pairs(userArgs) do |
|||
theBanner = Padlock.new(theConfig, theProtectionStatus, title) |
|||
args[k] = v |
|||
theBanner:setDeletionDiscussionPage(args.xfd) |
|||
end |
|||
theBanner:setUsername(args.user) |
|||
return p._main(args, cfg) |
|||
theBanner:setSection(args.section) |
|||
ret[#ret + 1] = theBanner:render() |
|||
-- Render the categories |
|||
return table.concat(ret) |
|||
end |
|||
function ProtectionBanner._exportClasses() |
|||
-- This is used to export the classes for testing purposes. |
|||
return { |
|||
ProtectionStatus = ProtectionStatus, |
|||
Config = Config, |
|||
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 18:14, 5 May 2021
This Lua module is used on approximately 38,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module creates protection banners and padlock icons that are placed at the top of protected pages.
Usage
Most users will not need to use this module directly. For adding protection templates to pages you can use the {{pp}} template, or you may find it more convenient to use one of the more specific protection templates in the table below.
From wikitext
{{#invoke:Protection banner|main | 1 = reason | small = yes/no | action = action | date = protection date | user = username | section = talk page section name | category = no }}
The #invoke syntax can be used for creating protection templates more specific than {{pp}}. For example, it is possible to create a protection template which always shows a padlock icon by using the code {{#invoke:Protection banner|main|small=yes}}
. Pages which call this template will still be able to use other arguments, like action. However, this only works one level deep; a page calling a template which calls another template containing the above code will not automatically be able to use parameters like action.
Note: You should no longer specify the expiry, as it is automatically retrieved in all cases.
From Lua
First, load the module.
local mProtectionBanner = require('Module:Protection banner')
Then you can make protection banners by using the _main function.
mProtectionBanner._main(args, cfg, titleObj)
args is a table of arguments to pass to the module. For possible keys and values for this table, see the parameters section. The cfg and titleObj variables are intended only for testing; cfg specifies a customised config table to use instead of Module:Protection banner/config, and titleObj specifies a mw.title object to use instead of the current title. args, cfg and titleObj are all optional.
Parameters
All parameters are optional.
- 1 - the reason that the page was protected. If set, this must be one of the values listed in the reasons table.
- small - if set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.
- action - the protection action. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). The default value is "edit".
- date - the protection date. This must be valid input to the second parameter of the #time parser function. This argument has an effect for reasons that use the PROTECTIONDATE parameter in their configuration. As of July 2014, those were the "office" and "reset" reasons.
- user - the username of the user to generate links for. As of July 2014, this only has an effect when the "usertalk" reason is specified.
- section - the section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.
- category - categories are suppressed if this is set to "no", "n", "0", or "false".
Reasons
The following table contains the available reasons, plus the actions for which they are available.
Reason | Action | Description |
---|---|---|
blp | edit | For pages protected to promote compliance with the biographies of living persons policy |
dispute | edit | For pages protected due to editing disputes |
dmca | edit | For pages protected by the Wikimedia Foundation due to Digital Millennium Copyright Act takedown requests |
ecp | edit | For articles in topic areas authorized by ArbCom or meets the criteria for community use |
mainpage | edit | For pages protected for being displayed on the Main Page |
office | edit | For pages protected by the Wikimedia Foundation |
reset | edit | For pages protected by the Wikimedia Foundation and "reset" to a bare-bones version |
sock | edit | For pages protected due to sock puppetry |
template | edit | For high-risk templates and Lua modules |
usertalk | edit | For pages protected against disruptive edits by a particular user |
vandalism | edit | For pages protected against vandalism |
dispute | move | For pages protected against page moves due to disputes over the page title |
vandalism | move | For pages protected against page-move vandalism |
Errors
Below is a list of some of the common errors that this module can produce, and how to fix them.
Invalid protection date
Error: invalid protection date ("abc")
This error is produced if you supply an |date=
parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "9 June 2024". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).
Invalid action
Error: invalid action ("abc")
This error is produced if you specify an invalid protection action. There are only three valid actions: edit
(the default, for normal protection), move
(for move-protection), and autoreview
(for pending changes). This should only be possible if you are using a template that supports manually specifying the protection action, such as {{pp}}, or if you are using #invoke directly. If this is not the case, please leave a message on Module talk:Protection banner.
Reasons cannot contain the pipe character
Error: reasons cannot contain the pipe character ("|")
This error is produced if you specify a reason using the |1=
parameter that includes a pipe character ("|"). Please check that you are not entering the {{!}} template into this parameter by mistake. The pipe character is disallowed as the module uses it internally. A list of valid reasons can be seen in the reasons section.
Other errors
If you see an error other than the ones above, it is likely to either be a bug in the module or mistake in the configuration. Please post a message about it at Module talk:Protection banner.
Technical details
This module uses configuration data from Module:Protection banner/config. Most of the module's behaviour can be configured there, making it easily portable across different wikis and different languages.
General test cases for the module can be found at Module:Protection banner/testcases, and test cases specific to enwiki's config can be found at Module:Protection banner/config/testcases.
Bug reports and feature requests should be made on the module's talk page.
-- 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:isUserScript()
-- Whether the page is a user JavaScript or CSS page.
local title = self.title
return title.namespace == 2 and (
title.contentModel == 'javascript' or title.contentModel == 'css'
)
end
function Protection:isProtected()
return self.level ~= '*'
end
function Protection:shouldShowLock()
-- Whether we should output a banner/padlock
return self:isProtected() and not self:isUserScript()
end
-- Whether this page needs a protection category.
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock
function Protection:isTemporary()
return type(self.expiry) == 'number'
end
function Protection:makeProtectionCategory()
if not self:shouldHaveProtectionCategory() then
return ''
end
local cfg = self._cfg
local title = self.title
-- 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:shouldHaveProtectionCategory()
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 mw.getCurrentFrame():expandTemplate{
title="vandal-m",
args={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:shouldShowLock() 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