Please log in first.
Diff: Module:Protection banner
Comparing revision #1 (2022-10-21 08:07:11) with revision #2 (2023-02-02 05:25:40).
| Old | New |
|---|---|
-- This module implements {{pp-meta}} and its daughter templates such as |
-- This module implements {{pp-meta}} and its daughter templates such as |
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}. |
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}. |
-- Initialise necessary modules. |
-- Initialise necessary modules. |
require('strict') |
require('strict') |
local makeFileLink = require('Module:File link')._main |
local makeFileLink = require('Module:File link')._main |
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 effectiveProtectionExpiry = require('Module:Effective protection expiry')._main |
local yesno = require('Module:Yesno') |
local yesno = require('Module:Yesno') |
-- Lazily initialise modules and objects we don't always need. |
-- Lazily initialise modules and objects we don't always need. |
local getArgs, makeMessageBox, lang |
local getArgs, makeMessageBox, lang |
-- Set constants. |
-- Set constants. |
local CONFIG_MODULE = 'Module:Protection banner/config' |
local CONFIG_MODULE = 'Module:Protection banner/config' |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Helper functions |
-- Helper functions |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local function makeCategoryLink(cat, sort) |
local function makeCategoryLink(cat, sort) |
if cat then |
if cat then |
return string.format( |
return string.format( |
'[[%s:%s|%s]]', |
'[[%s:%s|%s]]', |
mw.site.namespaces[14].name, |
mw.site.namespaces[14].name, |
cat, |
cat, |
sort |
sort |
) |
) |
end |
end |
end |
end |
-- Validation function for the expiry and the protection date |
-- Validation function for the expiry and the protection date |
local function validateDate(dateString, dateType) |
local function validateDate(dateString, dateType) |
if not lang then |
if not lang then |
lang = mw.language.getContentLanguage() |
lang = mw.language.getContentLanguage() |
end |
end |
local success, result = pcall(lang.formatDate, lang, 'U', dateString) |
local success, result = pcall(lang.formatDate, lang, 'U', dateString) |
if success then |
if success then |
result = tonumber(result) |
result = tonumber(result) |
if result then |
if result then |
return result |
return result |
end |
end |
end |
end |
error(string.format( |
error(string.format( |
'invalid %s: %s', |
'invalid %s: %s', |
dateType, |
dateType, |
tostring(dateString) |
tostring(dateString) |
), 4) |
), 4) |
end |
end |
local function makeFullUrl(page, query, display) |
local function makeFullUrl(page, query, display) |
return string.format( |
return string.format( |
'[%s %s]', |
'[%s %s]', |
tostring(mw.uri.fullUrl(page, query)), |
tostring(mw.uri.fullUrl(page, query)), |
display |
display |
) |
) |
end |
end |
-- Given a directed graph formatted as node -> table of direct successors, |
-- Given a directed graph formatted as node -> table of direct successors, |
-- get a table of all nodes reachable from a given node (though always |
-- get a table of all nodes reachable from a given node (though always |
-- including the given node). |
-- including the given node). |
local function getReachableNodes(graph, start) |
local function getReachableNodes(graph, start) |
local toWalk, retval = {[start] = true}, {} |
local toWalk, retval = {[start] = true}, {} |
while true do |
while true do |
-- Can't use pairs() since we're adding and removing things as we're iterating |
-- 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 |
local k = next(toWalk) -- This always gets the "first" key |
if k == nil then |
if k == nil then |
return retval |
return retval |
end |
end |
toWalk[k] = nil |
toWalk[k] = nil |
retval[k] = true |
retval[k] = true |
for _,v in ipairs(graph[k]) do |
for _,v in ipairs(graph[k]) do |
if not retval[v] then |
if not retval[v] then |
toWalk[v] = true |
toWalk[v] = true |
end |
end |
end |
end |
end |
end |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Protection class |
-- Protection class |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local Protection = {} |
local Protection = {} |
Protection.__index = Protection |
Protection.__index = Protection |
Protection.supportedActions = { |
Protection.supportedActions = { |
edit = true, |
edit = true, |
move = true, |
move = true, |
autoreview = true, |
autoreview = true, |
upload = true |
upload = true |
} |
} |
Protection.bannerConfigFields = { |
Protection.bannerConfigFields = { |
'text', |
'text', |
'explanation', |
'explanation', |
'tooltip', |
'tooltip', |
'alt', |
'alt', |
'link', |
'link', |
'image' |
'image' |
} |
} |
function Protection.new(args, cfg, title) |
function Protection.new(args, cfg, title) |
local obj = {} |
local obj = {} |
obj._cfg = cfg |
obj._cfg = cfg |
obj.title = title or mw.title.getCurrentTitle() |
obj.title = title or mw.title.getCurrentTitle() |
-- Set action |
-- Set action |
if not args.action then |
if not args.action then |
obj.action = 'edit' |
obj.action = 'edit' |
elseif Protection.supportedActions[args.action] then |
elseif Protection.supportedActions[args.action] then |
obj.action = args.action |
obj.action = args.action |
else |
else |
error(string.format( |
error(string.format( |
'invalid action: %s', |
'invalid action: %s', |
tostring(args.action) |
tostring(args.action) |
), 3) |
), 3) |
end |
end |
-- Set level |
-- Set level |
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title) |
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title) |
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then |
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then |
-- Users need to be autoconfirmed to move pages anyway, so treat |
-- Users need to be autoconfirmed to move pages anyway, so treat |
-- semi-move-protected pages as unprotected. |
-- semi-move-protected pages as unprotected. |
obj.level = '*' |
obj.level = '*' |
end |
end |
-- Set expiry |
-- Set expiry |
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title) |
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title) |
if effectiveExpiry == 'infinity' then |
if effectiveExpiry == 'infinity' then |
obj.expiry = 'indef' |
obj.expiry = 'indef' |
elseif effectiveExpiry ~= 'unknown' then |
elseif effectiveExpiry ~= 'unknown' then |
obj.expiry = validateDate(effectiveExpiry, 'expiry date') |
obj.expiry = validateDate(effectiveExpiry, 'expiry date') |
end |
end |
-- Set reason |
-- Set reason |
if args[1] then |
if args[1] then |
obj.reason = mw.ustring.lower(args[1]) |
obj.reason = mw.ustring.lower(args[1]) |
if obj.reason:find('|') then |
if obj.reason:find('|') then |
error('reasons cannot contain the pipe character ("|")', 3) |
error('reasons cannot contain the pipe character ("|")', 3) |
end |
end |
end |
end |
-- Set protection date |
-- Set protection date |
if args.date then |
if args.date then |
obj.protectionDate = validateDate(args.date, 'protection date') |
obj.protectionDate = validateDate(args.date, 'protection date') |
end |
end |
-- Set banner config |
-- Set banner config |
do |
do |
obj.bannerConfig = {} |
obj.bannerConfig = {} |
local configTables = {} |
local configTables = {} |
if cfg.banners[obj.action] then |
if cfg.banners[obj.action] then |
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] |
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] |
end |
end |
if cfg.defaultBanners[obj.action] then |
if cfg.defaultBanners[obj.action] then |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] |
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default |
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(Protection.bannerConfigFields) 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] |
obj.bannerConfig[field] = t[field] |
break |
break |
end |
end |
end |
end |
end |
end |
end |
end |
return setmetatable(obj, Protection) |
return setmetatable(obj, Protection) |
end |
end |
function Protection:isUserScript() |
function Protection:isUserScript() |
-- Whether the page is a user JavaScript or CSS page. |
-- Whether the page is a user JavaScript or CSS page. |
local title = self.title |
local title = self.title |
return title.namespace == 2 and ( |
return title.namespace == 2 and ( |
title.contentModel == 'javascript' or title.contentModel == 'css' |
title.contentModel == 'javascript' or title.contentModel == 'css' |
) |
) |
end |
end |
function Protection:isProtected() |
function Protection:isProtected() |
return self.level ~= '*' |
return self.level ~= '*' |
end |
end |
function Protection:shouldShowLock() |
function Protection:shouldShowLock() |
-- Whether we should output a banner/padlock |
-- Whether we should output a banner/padlock |
return self:isProtected() and not self:isUserScript() |
return self:isProtected() and not self:isUserScript() |
end |
end |
-- Whether this page needs a protection category. |
-- Whether this page needs a protection category. |
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock |
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock |
function Protection:isTemporary() |
function Protection:isTemporary() |
return type(self.expiry) == 'number' |
return type(self.expiry) == 'number' |
end |
end |
function Protection:makeProtectionCategory() |
function Protection:makeProtectionCategory() |
if not self:shouldHaveProtectionCategory() then |
if not self:shouldHaveProtectionCategory() then |
return '' |
return '' |
end |
end |
local cfg = self._cfg |
local cfg = self._cfg |
local title = self.title |
local title = self.title |
-- Get the expiry key fragment. |
-- Get the expiry key fragment. |
local expiryFragment |
local expiryFragment |
if self.expiry == 'indef' then |
if self.expiry == 'indef' then |
expiryFragment = self.expiry |
expiryFragment = self.expiry |
elseif type(self.expiry) == 'number' then |
elseif type(self.expiry) == 'number' then |
expiryFragment = 'temp' |
expiryFragment = 'temp' |
end |
end |
-- Get the namespace key fragment. |
-- Get the namespace key fragment. |
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] |
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] |
if not namespaceFragment and title.namespace % 2 == 1 then |
if not namespaceFragment and title.namespace % 2 == 1 then |
namespaceFragment = 'talk' |
namespaceFragment = 'talk' |
end |
end |
-- Define the order that key fragments are tested in. This is done with an |
-- 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 |
-- array of tables containing the value to be tested, along with its |
-- position in the cfg.protectionCategories table. |
-- position in the cfg.protectionCategories table. |
local order = { |
local order = { |
{val = expiryFragment, keypos = 1}, |
{val = expiryFragment, keypos = 1}, |
{val = namespaceFragment, keypos = 2}, |
{val = namespaceFragment, keypos = 2}, |
{val = self.reason, keypos = 3}, |
{val = self.reason, keypos = 3}, |
{val = self.level, keypos = 4}, |
{val = self.level, keypos = 4}, |
{val = self.action, keypos = 5} |
{val = self.action, keypos = 5} |
} |
} |
--[[ |
--[[ |
-- The old protection templates used an ad-hoc protection category system, |
-- The old protection templates used an ad-hoc protection category system, |
-- with some templates prioritising namespaces in their categories, and |
-- with some templates prioritising namespaces in their categories, and |
-- others prioritising the protection reason. To emulate this in this module |
-- others prioritising the protection reason. To emulate this in this module |
-- we use the config table cfg.reasonsWithNamespacePriority to set the |
-- we use the config table cfg.reasonsWithNamespacePriority to set the |
-- reasons for which namespaces have priority over protection reason. |
-- reasons for which namespaces have priority over protection reason. |
-- If we are dealing with one of those reasons, move the namespace table to |
-- 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 |
-- 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 |
-- reason should have highest priority, so move that to the end of the table |
-- instead. |
-- instead. |
--]] |
--]] |
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3)) |
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" |
-- Define the attempt order. Inactive subtables (subtables with nil "value" |
-- fields) are moved to the end, where they will later be given the key |
-- 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 |
-- "all". This is to cut down on the number of table lookups in |
-- cfg.protectionCategories, which grows exponentially with the number of |
-- cfg.protectionCategories, which grows exponentially with the number of |
-- non-nil keys. We keep track of the number of active subtables with the |
-- non-nil keys. We keep track of the number of active subtables with the |
-- noActive parameter. |
-- noActive parameter. |
--]] |
--]] |
local noActive, attemptOrder |
local noActive, attemptOrder |
do |
do |
local active, inactive = {}, {} |
local active, inactive = {}, {} |
for i, t in ipairs(order) do |
for i, t in ipairs(order) do |
if t.val then |
if t.val then |
active[#active + 1] = t |
active[#active + 1] = t |
else |
else |
inactive[#inactive + 1] = t |
inactive[#inactive + 1] = t |
end |
end |
end |
end |
noActive = #active |
noActive = #active |
attemptOrder = active |
attemptOrder = active |
for i, t in ipairs(inactive) do |
for i, t in ipairs(inactive) do |
attemptOrder[#attemptOrder + 1] = t |
attemptOrder[#attemptOrder + 1] = t |
end |
end |
end |
end |
--[[ |
--[[ |
-- Check increasingly generic key combinations until we find a match. If a |
-- Check increasingly generic key combinations until we find a match. If a |
-- specific category exists for the combination of key fragments we are |
-- specific category exists for the combination of key fragments we are |
-- given, that match will be found first. If not, we keep trying different |
-- given, that match will be found first. If not, we keep trying different |
-- key fragment combinations until we match using the key |
-- key fragment combinations until we match using the key |
-- "all-all-all-all-all". |
-- "all-all-all-all-all". |
-- |
-- |
-- To generate the keys, we index the key subtables using a binary matrix |
-- To generate the keys, we index the key subtables using a binary matrix |
-- with indexes i and j. j is only calculated up to the number of active |
-- 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 |
-- subtables. For example, if there were three active subtables, the matrix |
-- would look like this, with 0 corresponding to the key fragment "all", and |
-- would look like this, with 0 corresponding to the key fragment "all", and |
-- 1 corresponding to other key fragments. |
-- 1 corresponding to other key fragments. |
-- |
-- |
-- j 1 2 3 |
-- j 1 2 3 |
-- i |
-- i |
-- 1 1 1 1 |
-- 1 1 1 1 |
-- 2 0 1 1 |
-- 2 0 1 1 |
-- 3 1 0 1 |
-- 3 1 0 1 |
-- 4 0 0 1 |
-- 4 0 0 1 |
-- 5 1 1 0 |
-- 5 1 1 0 |
-- 6 0 1 0 |
-- 6 0 1 0 |
-- 7 1 0 0 |
-- 7 1 0 0 |
-- 8 0 0 0 |
-- 8 0 0 0 |
-- |
-- |
-- Values of j higher than the number of active subtables are set |
-- Values of j higher than the number of active subtables are set |
-- to the string "all". |
-- to the string "all". |
-- |
-- |
-- A key for cfg.protectionCategories is constructed for each value of i. |
-- A key for cfg.protectionCategories is constructed for each value of i. |
-- The position of the value in the key is determined by the keypos field in |
-- The position of the value in the key is determined by the keypos field in |
-- each subtable. |
-- each subtable. |
--]] |
--]] |
local cats = cfg.protectionCategories |
local cats = cfg.protectionCategories |
for i = 1, 2^noActive do |
for i = 1, 2^noActive do |
local key = {} |
local key = {} |
for j, t in ipairs(attemptOrder) do |
for j, t in ipairs(attemptOrder) do |
if j > noActive then |
if j > noActive then |
key[t.keypos] = 'all' |
key[t.keypos] = 'all' |
else |
else |
local quotient = i / 2 ^ (j - 1) |
local quotient = i / 2 ^ (j - 1) |
quotient = math.ceil(quotient) |
quotient = math.ceil(quotient) |
if quotient % 2 == 1 then |
if quotient % 2 == 1 then |
key[t.keypos] = t.val |
key[t.keypos] = t.val |
else |
else |
key[t.keypos] = 'all' |
key[t.keypos] = 'all' |
end |
end |
end |
end |
end |
end |
key = table.concat(key, '|') |
key = table.concat(key, '|') |
local attempt = cats[key] |
local attempt = cats[key] |
if attempt then |
if attempt then |
return makeCategoryLink(attempt, title.text) |
return makeCategoryLink(attempt, title.text) |
end |
end |
end |
end |
return '' |
return '' |
end |
end |
function Protection:isIncorrect() |
function Protection:isIncorrect() |
local expiry = self.expiry |
local expiry = self.expiry |
return not self:shouldHaveProtectionCategory() |
return not self:shouldHaveProtectionCategory() |
or type(expiry) == 'number' and expiry < os.time() |
or type(expiry) == 'number' and expiry < os.time() |
end |
end |
function Protection:isTemplateProtectedNonTemplate() |
function Protection:isTemplateProtectedNonTemplate() |
local action, namespace = self.action, self.title.namespace |
local action, namespace = self.action, self.title.namespace |
return self.level == 'templateeditor' |
return self.level == 'templateeditor' |
and ( |
and ( |
(action ~= 'edit' and action ~= 'move') |
(action ~= 'edit' and action ~= 'move') |
or (namespace ~= 10 and namespace ~= 828) |
or (namespace ~= 10 and namespace ~= 828) |
) |
) |
end |
end |
function Protection:makeCategoryLinks() |
function Protection:makeCategoryLinks() |
local msg = self._cfg.msg |
local msg = self._cfg.msg |
local ret = {self:makeProtectionCategory()} |
local ret = {self:makeProtectionCategory()} |
if self:isIncorrect() then |
if self:isIncorrect() then |
ret[#ret + 1] = makeCategoryLink( |
ret[#ret + 1] = makeCategoryLink( |
msg['tracking-category-incorrect'], |
msg['tracking-category-incorrect'], |
self.title.text |
self.title.text |
) |
) |
end |
end |
if self:isTemplateProtectedNonTemplate() then |
if self:isTemplateProtectedNonTemplate() then |
ret[#ret + 1] = makeCategoryLink( |
ret[#ret + 1] = makeCategoryLink( |
msg['tracking-category-template'], |
msg['tracking-category-template'], |
self.title.text |
self.title.text |
) |
) |
end |
end |
return table.concat(ret) |
return table.concat(ret) |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Blurb class |
-- Blurb class |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local Blurb = {} |
local Blurb = {} |
Blurb.__index = Blurb |
Blurb.__index = Blurb |
Blurb.bannerTextFields = { |
Blurb.bannerTextFields = { |
text = true, |
text = true, |
explanation = true, |
explanation = true, |
tooltip = true, |
tooltip = true, |
alt = true, |
alt = true, |
link = true |
link = true |
} |
} |
function Blurb.new(protectionObj, args, cfg) |
function Blurb.new(protectionObj, args, cfg) |
return setmetatable({ |
return setmetatable({ |
_cfg = cfg, |
_cfg = cfg, |
_protectionObj = protectionObj, |
_protectionObj = protectionObj, |
_args = args |
_args = args |
}, Blurb) |
}, Blurb) |
end |
end |
-- Private methods -- |
-- 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() |
local success, date = pcall( |
local success, date = pcall( |
lang.formatDate, |
lang.formatDate, |
lang, |
lang, |
self._cfg.msg['expiry-date-format'] or 'j F Y', |
self._cfg.msg['expiry-date-format'] or 'j F Y', |
'@' .. tostring(num) |
'@' .. tostring(num) |
) |
) |
if success then |
if success then |
return date |
return date |
end |
end |
end |
end |
function Blurb:_getExpandedMessage(msgKey) |
function Blurb:_getExpandedMessage(msgKey) |
return self:_substituteParameters(self._cfg.msg[msgKey]) |
return self:_substituteParameters(self._cfg.msg[msgKey]) |
end |
end |
function Blurb:_substituteParameters(msg) |
function Blurb:_substituteParameters(msg) |
if not self._params then |
if not self._params then |
local parameterFuncs = {} |
local parameterFuncs = {} |
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
parameterFuncs.EXPIRY = self._makeExpiryParameter |
parameterFuncs.EXPIRY = self._makeExpiryParameter |
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter |
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter |
parameterFuncs.IMAGELINK = self._makeImageLinkParameter |
parameterFuncs.IMAGELINK = self._makeImageLinkParameter |
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter |
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter |
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter |
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter |
parameterFuncs.PAGETYPE = self._makePagetypeParameter |
parameterFuncs.PAGETYPE = self._makePagetypeParameter |
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter |
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter |
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter |
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter |
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter |
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter |
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter |
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter |
parameterFuncs.TALKPAGE = self._makeTalkPageParameter |
parameterFuncs.TALKPAGE = self._makeTalkPageParameter |
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter |
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter |
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter |
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter |
parameterFuncs.VANDAL = self._makeVandalTemplateParameter |
parameterFuncs.VANDAL = self._makeVandalTemplateParameter |
self._params = setmetatable({}, { |
self._params = setmetatable({}, { |
__index = function (t, k) |
__index = function (t, k) |
local param |
local param |
if parameterFuncs[k] then |
if parameterFuncs[k] then |
param = parameterFuncs[k](self) |
param = parameterFuncs[k](self) |
end |
end |
param = param or '' |
param = param or '' |
t[k] = param |
t[k] = param |
return param |
return param |
end |
end |
}) |
}) |
end |
end |
msg = msg:gsub('${(%u+)}', self._params) |
msg = msg:gsub('${(%u+)}', self._params) |
return msg |
return msg |
end |
end |
function Blurb:_makeCurrentVersionParameter() |
function Blurb:_makeCurrentVersionParameter() |
-- A link to the page history or the move log, depending on the kind of |
-- A link to the page history or the move log, depending on the kind of |
-- protection. |
-- protection. |
local pagename = self._protectionObj.title.prefixedText |
local pagename = self._protectionObj.title.prefixedText |
if self._protectionObj.action == 'move' then |
if self._protectionObj.action == 'move' then |
-- We need the move log link. |
-- We need the move log link. |
return makeFullUrl( |
return makeFullUrl( |
'Special:Log', |
'Special:Log', |
{type = 'move', page = pagename}, |
{type = 'move', page = pagename}, |
self:_getExpandedMessage('current-version-move-display') |
self:_getExpandedMessage('current-version-move-display') |
) |
) |
else |
else |
-- We need the history link. |
-- We need the history link. |
return makeFullUrl( |
return makeFullUrl( |
pagename, |
pagename, |
{action = 'history'}, |
{action = 'history'}, |
self:_getExpandedMessage('current-version-edit-display') |
self:_getExpandedMessage('current-version-edit-display') |
) |
) |
end |
end |
end |
end |
function Blurb:_makeEditRequestParameter() |
function Blurb:_makeEditRequestParameter() |
local mEditRequest = require('Module:Submit an edit request') |
local mEditRequest = require('Module:Submit an edit request') |
local action = self._protectionObj.action |
local action = self._protectionObj.action |
local level = self._protectionObj.level |
local level = self._protectionObj.level |
-- Get the edit request type. |
-- Get the edit request type. |
local requestType |
local requestType |
if action == 'edit' then |
if action == 'edit' then |
if level == 'autoconfirmed' then |
if level == 'autoconfirmed' then |
requestType = 'semi' |
requestType = 'semi' |
elseif level == 'extendedconfirmed' then |
elseif level == 'extendedconfirmed' then |
requestType = 'extended' |
requestType = 'extended' |
elseif level == 'templateeditor' then |
elseif level == 'templateeditor' then |
requestType = 'template' |
requestType = 'template' |
end |
end |
end |
end |
requestType = requestType or 'full' |
requestType = requestType or 'full' |
-- Get the display value. |
-- Get the display value. |
local display = self:_getExpandedMessage('edit-request-display') |
local display = self:_getExpandedMessage('edit-request-display') |
return mEditRequest._link{type = requestType, display = display} |
return mEditRequest._link{type = requestType, display = display} |
end |
end |
function Blurb:_makeExpiryParameter() |
function Blurb:_makeExpiryParameter() |
local expiry = self._protectionObj.expiry |
local expiry = self._protectionObj.expiry |
if type(expiry) == 'number' then |
if type(expiry) == 'number' then |
return self:_formatDate(expiry) |
return self:_formatDate(expiry) |
else |
else |
return expiry |
return expiry |
end |
end |
end |
end |
function Blurb:_makeExplanationBlurbParameter() |
function Blurb:_makeExplanationBlurbParameter() |
-- Cover special cases first. |
-- Cover special cases first. |
if self._protectionObj.title.namespace == 8 then |
if self._protectionObj.title.namespace == 8 then |
-- MediaWiki namespace |
-- MediaWiki namespace |
return self:_getExpandedMessage('explanation-blurb-nounprotect') |
return self:_getExpandedMessage('explanation-blurb-nounprotect') |
end |
end |
-- Get explanation blurb table keys |
-- Get explanation blurb table keys |
local action = self._protectionObj.action |
local action = self._protectionObj.action |
local level = self._protectionObj.level |
local level = self._protectionObj.level |
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject' |
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject' |
-- Find the message in the explanation blurb table and substitute any |
-- Find the message in the explanation blurb table and substitute any |
-- parameters. |
-- parameters. |
local explanations = self._cfg.explanationBlurbs |
local explanations = self._cfg.explanationBlurbs |
local msg |
local msg |
if explanations[action][level] and explanations[action][level][talkKey] then |
if explanations[action][level] and explanations[action][level][talkKey] then |
msg = explanations[action][level][talkKey] |
msg = explanations[action][level][talkKey] |
elseif explanations[action][level] and explanations[action][level].default then |
elseif explanations[action][level] and explanations[action][level].default then |
msg = explanations[action][level].default |
msg = explanations[action][level].default |
elseif explanations[action].default and explanations[action].default[talkKey] then |
elseif explanations[action].default and explanations[action].default[talkKey] then |
msg = explanations[action].default[talkKey] |
msg = explanations[action].default[talkKey] |
elseif explanations[action].default and explanations[action].default.default then |
elseif explanations[action].default and explanations[action].default.default then |
msg = explanations[action].default.default |
msg = explanations[action].default.default |
else |
else |
error(string.format( |
error(string.format( |
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"', |
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"', |
action, |
action, |
level, |
level, |
talkKey |
talkKey |
), 8) |
), 8) |
end |
end |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
end |
end |
function Blurb:_makeImageLinkParameter() |
function Blurb:_makeImageLinkParameter() |
local imageLinks = self._cfg.imageLinks |
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 |
local msg |
local msg |
if imageLinks[action][level] then |
if imageLinks[action][level] then |
msg = imageLinks[action][level] |
msg = imageLinks[action][level] |
elseif imageLinks[action].default then |
elseif imageLinks[action].default then |
msg = imageLinks[action].default |
msg = imageLinks[action].default |
else |
else |
msg = imageLinks.edit.default |
msg = imageLinks.edit.default |
end |
end |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
end |
end |
function Blurb:_makeIntroBlurbParameter() |
function Blurb:_makeIntroBlurbParameter() |
if self._protectionObj:isTemporary() then |
if self._protectionObj:isTemporary() then |
return self:_getExpandedMessage('intro-blurb-expiry') |
return self:_getExpandedMessage('intro-blurb-expiry') |
else |
else |
return self:_getExpandedMessage('intro-blurb-noexpiry') |
return self:_getExpandedMessage('intro-blurb-noexpiry') |
end |
end |
end |
end |
function Blurb:_makeIntroFragmentParameter() |
function Blurb:_makeIntroFragmentParameter() |
if self._protectionObj:isTemporary() then |
if self._protectionObj:isTemporary() then |
return self:_getExpandedMessage('intro-fragment-expiry') |
return self:_getExpandedMessage('intro-fragment-expiry') |
else |
else |
return self:_getExpandedMessage('intro-fragment-noexpiry') |
return self:_getExpandedMessage('intro-fragment-noexpiry') |
end |
end |
end |
end |
function Blurb:_makePagetypeParameter() |
function Blurb:_makePagetypeParameter() |
local pagetypes = self._cfg.pagetypes |
local pagetypes = self._cfg.pagetypes |
return pagetypes[self._protectionObj.title.namespace] |
return pagetypes[self._protectionObj.title.namespace] |
or pagetypes.default |
or pagetypes.default |
or error('no default pagetype defined', 8) |
or error('no default pagetype defined', 8) |
end |
end |
function Blurb:_makeProtectionBlurbParameter() |
function Blurb:_makeProtectionBlurbParameter() |
local protectionBlurbs = self._cfg.protectionBlurbs |
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 |
local msg |
local msg |
if protectionBlurbs[action][level] then |
if protectionBlurbs[action][level] then |
msg = protectionBlurbs[action][level] |
msg = protectionBlurbs[action][level] |
elseif protectionBlurbs[action].default then |
elseif protectionBlurbs[action].default then |
msg = protectionBlurbs[action].default |
msg = protectionBlurbs[action].default |
elseif protectionBlurbs.edit.default then |
elseif protectionBlurbs.edit.default then |
msg = protectionBlurbs.edit.default |
msg = protectionBlurbs.edit.default |
else |
else |
error('no protection blurb defined for protectionBlurbs.edit.default', 8) |
error('no protection blurb defined for protectionBlurbs.edit.default', 8) |
end |
end |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
end |
end |
function Blurb:_makeProtectionDateParameter() |
function Blurb:_makeProtectionDateParameter() |
local protectionDate = self._protectionObj.protectionDate |
local protectionDate = self._protectionObj.protectionDate |
if type(protectionDate) == 'number' then |
if type(protectionDate) == 'number' then |
return self:_formatDate(protectionDate) |
return self:_formatDate(protectionDate) |
else |
else |
return protectionDate |
return protectionDate |
end |
end |
end |
end |
function Blurb:_makeProtectionLevelParameter() |
function Blurb:_makeProtectionLevelParameter() |
local protectionLevels = self._cfg.protectionLevels |
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 |
local msg |
local msg |
if protectionLevels[action][level] then |
if protectionLevels[action][level] then |
msg = protectionLevels[action][level] |
msg = protectionLevels[action][level] |
elseif protectionLevels[action].default then |
elseif protectionLevels[action].default then |
msg = protectionLevels[action].default |
msg = protectionLevels[action].default |
elseif protectionLevels.edit.default then |
elseif protectionLevels.edit.default then |
msg = protectionLevels.edit.default |
msg = protectionLevels.edit.default |
else |
else |
error('no protection level defined for protectionLevels.edit.default', 8) |
error('no protection level defined for protectionLevels.edit.default', 8) |
end |
end |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
end |
end |
function Blurb:_makeProtectionLogParameter() |
function Blurb:_makeProtectionLogParameter() |
local pagename = self._protectionObj.title.prefixedText |
local pagename = self._protectionObj.title.prefixedText |
if self._protectionObj.action == 'autoreview' then |
if self._protectionObj.action == 'autoreview' then |
-- We need the pending changes log. |
-- We need the pending changes log. |
return makeFullUrl( |
return makeFullUrl( |
'Special:Log', |
'Special:Log', |
{type = 'stable', page = pagename}, |
{type = 'stable', page = pagename}, |
self:_getExpandedMessage('pc-log-display') |
self:_getExpandedMessage('pc-log-display') |
) |
) |
else |
else |
-- We need the protection log. |
-- We need the protection log. |
return makeFullUrl( |
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 |
end |
end |
function Blurb:_makeTalkPageParameter() |
function Blurb:_makeTalkPageParameter() |
return string.format( |
return string.format( |
'[[%s:%s#%s|%s]]', |
'[[%s:%s#%s|%s]]', |
mw.site.namespaces[self._protectionObj.title.namespace].talk.name, |
mw.site.namespaces[self._protectionObj.title.namespace].talk.name, |
self._protectionObj.title.text, |
self._protectionObj.title.text, |
self._args.section or 'top', |
self._args.section or 'top', |
self:_getExpandedMessage('talk-page-link-display') |
self:_getExpandedMessage('talk-page-link-display') |
) |
) |
end |
end |
function Blurb:_makeTooltipBlurbParameter() |
function Blurb:_makeTooltipBlurbParameter() |
if self._protectionObj:isTemporary() then |
if self._protectionObj:isTemporary() 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 |
end |
end |
function Blurb:_makeTooltipFragmentParameter() |
function Blurb:_makeTooltipFragmentParameter() |
if self._protectionObj:isTemporary() then |
if self._protectionObj:isTemporary() then |
return self:_getExpandedMessage('tooltip-fragment-expiry') |
return self:_getExpandedMessage('tooltip-fragment-expiry') |
else |
else |
return self:_getExpandedMessage('tooltip-fragment-noexpiry') |
return self:_getExpandedMessage('tooltip-fragment-noexpiry') |
end |
end |
end |
end |
function Blurb:_makeVandalTemplateParameter() |
function Blurb:_makeVandalTemplateParameter() |
return mw.getCurrentFrame():expandTemplate{ |
return mw.getCurrentFrame():expandTemplate{ |
title="vandal-m", |
title="vandal-m", |
args={self._args.user or self._protectionObj.title.baseText} |
args={self._args.user or self._protectionObj.title.baseText} |
} |
} |
end |
end |
-- Public methods -- |
-- Public methods -- |
function Blurb:makeBannerText(key) |
function Blurb:makeBannerText(key) |
-- Validate input. |
-- Validate input. |
if not key or not Blurb.bannerTextFields[key] then |
if not key or not Blurb.bannerTextFields[key] then |
error(string.format( |
error(string.format( |
'"%s" is not a valid banner config field', |
'"%s" is not a valid banner config field', |
tostring(key) |
tostring(key) |
), 2) |
), 2) |
end |
end |
-- Generate the text. |
-- Generate the text. |
local msg = self._protectionObj.bannerConfig[key] |
local msg = self._protectionObj.bannerConfig[key] |
if type(msg) == 'string' then |
if type(msg) == 'string' then |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
elseif type(msg) == 'function' then |
elseif type(msg) == 'function' then |
msg = msg(self._protectionObj, self._args) |
msg = msg(self._protectionObj, self._args) |
if type(msg) ~= 'string' then |
if type(msg) ~= 'string' then |
error(string.format( |
error(string.format( |
'bad output from banner config function with key "%s"' |
'bad output from banner config function with key "%s"' |
.. ' (expected string, got %s)', |
.. ' (expected string, got %s)', |
tostring(key), |
tostring(key), |
type(msg) |
type(msg) |
), 4) |
), 4) |
end |
end |
return self:_substituteParameters(msg) |
return self:_substituteParameters(msg) |
end |
end |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- BannerTemplate class |
-- BannerTemplate class |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local BannerTemplate = {} |
local BannerTemplate = {} |
BannerTemplate.__index = BannerTemplate |
BannerTemplate.__index = BannerTemplate |
function BannerTemplate.new(protectionObj, cfg) |
function BannerTemplate.new(protectionObj, cfg) |
local obj = {} |
local obj = {} |
obj._cfg = cfg |
obj._cfg = cfg |
-- Set the image filename. |
-- Set the image filename. |
local imageFilename = protectionObj.bannerConfig.image |
local imageFilename = protectionObj.bannerConfig.image |
if imageFilename then |
if imageFilename then |
obj._imageFilename = imageFilename |
obj._imageFilename = imageFilename |
else |
else |
-- If an image filename isn't specified explicitly in the banner config, |
-- If an image filename isn't specified explicitly in the banner config, |
-- generate it from the protection status and the namespace. |
-- generate it from the protection status and the namespace. |
local action = protectionObj.action |
local action = protectionObj.action |
local level = protectionObj.level |
local level = protectionObj.level |
local namespace = protectionObj.title.namespace |
local namespace = protectionObj.title.namespace |
local reason = protectionObj.reason |
local reason = protectionObj.reason |
-- Deal with special cases first. |
-- Deal with special cases first. |
if ( |
if ( |
namespace == 10 |
namespace == 10 |
or namespace == 828 |
or namespace == 828 |
or reason and obj._cfg.indefImageReasons[reason] |
or reason and obj._cfg.indefImageReasons[reason] |
) |
) |
and action == 'edit' |
and action == 'edit' |
and level == 'sysop' |
and level == 'sysop' |
and not protectionObj:isTemporary() |
and not protectionObj:isTemporary() |
then |
then |
-- Fully protected modules and templates get the special red "indef" |
-- Fully protected modules and templates get the special red "indef" |
-- padlock. |
-- padlock. |
obj._imageFilename = obj._cfg.msg['image-filename-indef'] |
obj._imageFilename = obj._cfg.msg['image-filename-indef'] |
else |
else |
-- Deal with regular protection types. |
-- Deal with regular protection types. |
local images = obj._cfg.images |
local images = obj._cfg.images |
if images[action] then |
if images[action] then |
if images[action][level] then |
if images[action][level] then |
obj._imageFilename = images[action][level] |
obj._imageFilename = images[action][level] |
elseif images[action].default then |
elseif images[action].default then |
obj._imageFilename = images[action].default |
obj._imageFilename = images[action].default |
end |
end |
end |
end |
end |
end |
end |
end |
return setmetatable(obj, BannerTemplate) |
return setmetatable(obj, BannerTemplate) |
end |
end |
function BannerTemplate:renderImage() |
function BannerTemplate:renderImage() |
local filename = self._imageFilename |
local filename = self._imageFilename |
or self._cfg.msg['image-filename-default'] |
or self._cfg.msg['image-filename-default'] |
or 'Transparent.gif' |
or 'Transparent.gif' |
return makeFileLink{ |
return makeFileLink{ |
file = filename, |
file = filename, |
size = (self.imageWidth or 20) .. 'px', |
size = (self.imageWidth or 20) .. 'px', |
alt = self._imageAlt, |
alt = self._imageAlt, |
link = self._imageLink, |
link = self._imageLink, |
caption = self.imageCaption |
caption = self.imageCaption |
} |
} |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Banner class |
-- Banner class |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local Banner = setmetatable({}, BannerTemplate) |
local Banner = setmetatable({}, BannerTemplate) |
Banner.__index = Banner |
Banner.__index = Banner |
function Banner.new(protectionObj, blurbObj, cfg) |
function Banner.new(protectionObj, blurbObj, cfg) |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
obj.imageWidth = 40 |
obj.imageWidth = 40 |
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip. |
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip. |
obj._reasonText = blurbObj:makeBannerText('text') |
obj._reasonText = blurbObj:makeBannerText('text') |
obj._explanationText = blurbObj:makeBannerText('explanation') |
obj._explanationText = blurbObj:makeBannerText('explanation') |
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing. |
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing. |
return setmetatable(obj, Banner) |
return setmetatable(obj, Banner) |
end |
end |
function Banner:__tostring() |
function Banner:__tostring() |
-- Renders the banner. |
-- Renders the banner. |
makeMessageBox = makeMessageBox or require('Module:Message box').main |
makeMessageBox = makeMessageBox or require('Module:Message box').main |
local reasonText = self._reasonText or error('no reason text set', 2) |
local reasonText = self._reasonText or error('no reason text set', 2) |
local explanationText = self._explanationText |
local explanationText = self._explanationText |
local mbargs = { |
local mbargs = { |
page = self._page, |
page = self._page, |
type = 'protection', |
type = 'protection', |
image = self:renderImage(), |
image = self:renderImage(), |
text = string.format( |
text = string.format( |
"'''%s'''%s", |
"'''%s'''%s", |
reasonText, |
reasonText, |
explanationText and '<br />' .. explanationText or '' |
explanationText and '<br />' .. explanationText or '' |
) |
) |
} |
} |
return makeMessageBox('mbox', mbargs) |
return makeMessageBox('mbox', mbargs) |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Padlock class |
-- Padlock class |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local Padlock = setmetatable({}, BannerTemplate) |
local Padlock = setmetatable({}, BannerTemplate) |
Padlock.__index = Padlock |
Padlock.__index = Padlock |
function Padlock.new(protectionObj, blurbObj, cfg) |
function Padlock.new(protectionObj, blurbObj, cfg) |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. |
obj.imageWidth = 20 |
obj.imageWidth = 20 |
obj.imageCaption = blurbObj:makeBannerText('tooltip') |
obj.imageCaption = blurbObj:makeBannerText('tooltip') |
obj._imageAlt = blurbObj:makeBannerText('alt') |
obj._imageAlt = blurbObj:makeBannerText('alt') |
obj._imageLink = blurbObj:makeBannerText('link') |
obj._imageLink = blurbObj:makeBannerText('link') |
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action] |
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action] |
or cfg.padlockIndicatorNames.default |
or cfg.padlockIndicatorNames.default |
or 'pp-default' |
or 'pp-default' |
return setmetatable(obj, Padlock) |
return setmetatable(obj, Padlock) |
end |
end |
function Padlock:__tostring() |
function Padlock:__tostring() |
local frame = mw.getCurrentFrame() |
local frame = mw.getCurrentFrame() |
-- The nowiki tag helps prevent whitespace at the top of articles. |
-- The nowiki tag helps prevent whitespace at the top of articles. |
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{ |
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{ |
name = 'indicator', |
name = 'indicator', |
args = {name = self._indicatorName}, |
args = {name = self._indicatorName}, |
content = self:renderImage() |
content = self:renderImage() |
} |
} |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Exports |
-- Exports |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local p = {} |
local p = {} |
function p._exportClasses() |
function p._exportClasses() |
-- This is used for testing purposes. |
-- This is used for testing purposes. |
return { |
return { |
Protection = Protection, |
Protection = Protection, |
Blurb = Blurb, |
Blurb = Blurb, |
BannerTemplate = BannerTemplate, |
BannerTemplate = BannerTemplate, |
Banner = Banner, |
Banner = Banner, |
Padlock = Padlock, |
Padlock = Padlock, |
} |
} |
end |
end |
function p._main(args, cfg, title) |
function p._main(args, cfg, title) |
args = args or {} |
args = args or {} |
cfg = cfg or require(CONFIG_MODULE) |
cfg = cfg or require(CONFIG_MODULE) |
local protectionObj = Protection.new(args, cfg, title) |
local protectionObj = Protection.new(args, cfg, title) |
local ret = {} |
local ret = {} |
-- If a page's edit protection is equally or more restrictive than its |
-- If a page's edit protection is equally or more restrictive than its |
-- protection from some other action, then don't bother displaying anything |
-- protection from some other action, then don't bother displaying anything |
-- for the other action (except categories). |
-- for the other action (except categories). |
if not yesno(args.catonly) and (protectionObj.action == 'edit' or |
if not yesno(args.catonly) and (protectionObj.action == 'edit' or |
args.demolevel or |
args.demolevel or |
not getReachableNodes( |
not getReachableNodes( |
cfg.hierarchy, |
cfg.hierarchy, |
protectionObj.level |
protectionObj.level |
)[effectiveProtectionLevel('edit', protectionObj.title)]) |
)[effectiveProtectionLevel('edit', protectionObj.title)]) |
then |
then |
-- Initialise the blurb object |
-- Initialise the blurb object |
local blurbObj = Blurb.new(protectionObj, args, cfg) |
local blurbObj = Blurb.new(protectionObj, args, cfg) |
-- Render the banner |
-- Render the banner |
if protectionObj:shouldShowLock() then |
if protectionObj:shouldShowLock() then |
ret[#ret + 1] = tostring( |
ret[#ret + 1] = tostring( |
(yesno(args.small) and Padlock or Banner) |
(yesno(args.small) and Padlock or Banner) |
.new(protectionObj, blurbObj, cfg) |
.new(protectionObj, blurbObj, cfg) |
) |
) |
end |
end |
end |
end |
-- Render the categories |
-- Render the categories |
if yesno(args.category) ~= false then |
if yesno(args.category) ~= false then |
ret[#ret + 1] = protectionObj:makeCategoryLinks() |
ret[#ret + 1] = protectionObj:makeCategoryLinks() |
end |
end |
return table.concat(ret) |
return table.concat(ret) |
end |
end |
function p.main(frame, cfg) |
function p.main(frame, cfg) |
cfg = cfg or require(CONFIG_MODULE) |
cfg = cfg or require(CONFIG_MODULE) |
-- Find default args, if any. |
-- Find default args, if any. |
local parent = frame.getParent and frame:getParent() |
local parent = frame.getParent and frame:getParent() |
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')] |
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 |
-- Find user args, and use the parent frame if we are being called from a |
-- wrapper template. |
-- wrapper template. |
getArgs = getArgs or require('Module:Arguments').getArgs |
getArgs = getArgs or require('Module:Arguments').getArgs |
local userArgs = getArgs(frame, { |
local userArgs = getArgs(frame, { |
parentOnly = defaultArgs, |
parentOnly = defaultArgs, |
frameOnly = not defaultArgs |
frameOnly = not defaultArgs |
}) |
}) |
-- Build the args table. User-specified args overwrite default args. |
-- Build the args table. User-specified args overwrite default args. |
local args = {} |
local args = {} |
for k, v in pairs(defaultArgs or {}) do |
for k, v in pairs(defaultArgs or {}) do |
args[k] = v |
args[k] = v |
end |
end |
for k, v in pairs(userArgs) do |
for k, v in pairs(userArgs) do |
args[k] = v |
args[k] = v |
end |
end |
return p._main(args, cfg) |
return p._main(args, cfg) |
end |
end |
return p |
return p |