Module:Protection banner: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
(move the image name function to its proper place and rename it) |
m (1 revision imported from wikipedia:Module:Protection_banner) |
||
(160 intermediate revisions by 11 users not shown) | |||
Line 3: | Line 3: | ||
-- Initialise necessary modules. |
-- Initialise necessary modules. |
||
require('strict') |
|||
local |
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') |
local yesno = require('Module:Yesno') |
||
local mMessageBox -- only needs to be loaded if we are outputting a banner, so lazily initialise |
|||
-- 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 |
|||
-- Configuration |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local function makeCategoryLink(cat, sort) |
|||
local cfg = {} |
|||
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 |
|||
cfg.defaultBanners = { |
|||
local function validateDate(dateString, dateType) |
|||
edit = {}, |
|||
if not lang then |
|||
move = {}, |
|||
lang = mw.language.getContentLanguage() |
|||
create = {}, |
|||
end |
|||
autoreview = {} |
|||
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) |
|||
cfg.banners = { |
|||
return string.format( |
|||
-- A table of protection banners, sorted by protection type. |
|||
'[%s %s]', |
|||
tostring(mw.uri.fullUrl(page, query)), |
|||
-- $1 = Intro blurb, e.g. "This page is currently |
|||
display |
|||
-- [[Help:Protection|protected]] from editing" |
|||
) |
|||
-- $2 = "until" or "or until" depending on the expiry |
|||
end |
|||
-- $3 = "disputes", with or without a section link |
|||
-- $4 = the type of the page, e.g. "article", "template", or "page" |
|||
-- $5 = A blurb "it has been protected for x years, x months and x days." |
|||
-- $6 = the protection date |
|||
-- $7 = {{vandal-m|username}} replacement |
|||
edit = { |
|||
blp = { |
|||
text = '$1 to promote compliance with' |
|||
.. '[[Wikipedia:Biographies of living persons' |
|||
.. "|Wikipedia's policy on the biographies" |
|||
.. ' of living people]]', |
|||
tooltip = '$1 to promote compliance with the policy on biographies of' |
|||
.. ' living people', |
|||
categoryOrder = 'reason', |
|||
}, |
|||
dispute = { |
|||
text = '$1 $2 editing $3 have been resolved', |
|||
tooltip = 'due to editing disputes', |
|||
dispute = true, |
|||
categoryOrder = 'reason', |
|||
}, |
|||
office = { |
|||
text = 'This $4 is currently under the scrutiny of the' |
|||
.. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]' |
|||
.. ' and is protected. $5', |
|||
categoryOrder = 'reason', |
|||
}, |
|||
reset = { |
|||
text = 'On $6 this article was reduced to a simplified,' |
|||
..' "bare bones" version so that it may be completely rewritten to' |
|||
.. ' ensure it meets the policies of' |
|||
.. ' [[WP:NPOV|Neutral Point of View]] and [[WP:V|Verifiability]].' |
|||
.. ' Standard Wikipedia policies will apply to its rewriting—which' |
|||
.. ' will eventually be open to all editors—and will be strictly' |
|||
.. ' enforced. The article has been placed under a level of' |
|||
.. ' semi-protection temporarily during the rebuilding of this' |
|||
.. ' article.\n\nAny insertion of material directly from' |
|||
.. ' pre-protection revisions of the article will be removed, as' |
|||
.. ' will any material added to the article that is not properly' |
|||
.. ' sourced. The associated talk page(s) were also cleared on the' |
|||
.. " same date.\n\n'''Administrators may not override this action" |
|||
.. ' without approval from someone from the [[WP:OFFICE|Office]].' |
|||
.. " No editor may remove this notice.'''", |
|||
categoryOrder = 'reason', |
|||
categoryReason = 'office', |
|||
}, |
|||
sock = { |
|||
text = '$1 to prevent [[Wikipedia:Sock puppetry|sock puppets]] of' |
|||
.. ' [[Wikipedia:Blocking policy|blocked]] or' |
|||
.. ' [[Wikipedia:List of banned users|banned users]]' |
|||
.. ' from editing it', |
|||
tooltip = '$1 to prevent sock puppets of blocked or banned users from' |
|||
.. ' editing it', |
|||
categoryOrder = 'reason', |
|||
}, |
|||
usertalk = { |
|||
text = '$1 to prevent $7 from using it to make disruptive edits, such' |
|||
.. ' as abusing the' |
|||
.. ' {{[[Template:unblock|unblock]]}} template', |
|||
explanation = 'If you cannot edit this user talk page and you need to' |
|||
.. ' make a change or leave a message, you can' |
|||
.. ' [[Wikipedia:Requests for page protection' |
|||
.. '#Current requests for edits to a protected page' |
|||
.. '|request an edit]],' |
|||
.. ' [[Wikipedia:Requests for page protection' |
|||
.. '#Current requests for reduction in protection level' |
|||
.. '|request unprotection]],' |
|||
.. ' [[Special:Userlogin|log in]],' |
|||
.. ' or [[Special:UserLogin/signup|create an account]].', |
|||
categoryReason = 'all', |
|||
}, |
|||
vandalism = { |
|||
text = '$1 due to [[Wikipedia:Vandalism|vandalism]]', |
|||
tooltip = '$1 due to vandalism', |
|||
categoryOrder = 'namespace', |
|||
} |
|||
}, |
|||
move = { |
|||
dispute = { |
|||
}, |
|||
vandalism = { |
|||
}, |
|||
move = { |
|||
} |
|||
}, |
|||
create = { |
|||
}, |
|||
autoreview = { |
|||
pc1 = { |
|||
}, |
|||
pc2 = { |
|||
} |
|||
} |
|||
} |
|||
-- Given a directed graph formatted as node -> table of direct successors, |
|||
cfg.images = { |
|||
-- get a table of all nodes reachable from a given node (though always |
|||
full = 'Padlock.svg', |
|||
-- including the given node). |
|||
semi = 'Padlock-silver.svg', |
|||
local function getReachableNodes(graph, start) |
|||
template = 'Padlock-pink.svg', |
|||
local toWalk, retval = {[start] = true}, {} |
|||
pc1 = 'Padlock-silver-light.svg', |
|||
while true do |
|||
pc2 = 'Padlock-orange.svg', |
|||
-- Can't use pairs() since we're adding and removing things as we're iterating |
|||
move = 'Padlock-olive.svg', |
|||
local k = next(toWalk) -- This always gets the "first" key |
|||
indef = 'Padlock-red.svg', |
|||
if k == nil then |
|||
office = 'Padlock-black.svg', |
|||
return retval |
|||
create = 'Padlock-skyblue.svg' |
|||
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 |
|||
-------------------------------------------------------------------------------- |
|||
cfg.categories = { |
|||
-- Protection class |
|||
-- The key strings follow this format: |
|||
-------------------------------------------------------------------------------- |
|||
-- type, level, ns, reason, expiry |
|||
['all-all-all-all-all'] = 'Wikipedia protected pages', |
|||
['all-all-all-office-all'] = 'Wikipedia Office-protected pages', |
|||
['edit-all-template-all-all'] = 'Wikipedia protected templates', |
|||
['edit-autoconfirmed-all-all-all'] = 'Wikipedia semi-protected pages', |
|||
['edit-autoconfirmed-all-all-indef'] = 'Wikipedia indefinitely semi-protected pages', |
|||
['edit-autoconfirmed-all-blp-all'] = 'Wikipedia indefinitely semi-protected biographies of living people', |
|||
['edit-autoconfirmed-all-blp-temp'] = 'Wikipedia temporarily semi-protected biographies of living people', |
|||
['edit-autoconfirmed-all-dispute-all'] = 'Wikipedia pages semi-protected due to dispute', |
|||
['edit-autoconfirmed-all-sock-all'] = 'Wikipedia pages semi-protected from banned users', |
|||
['edit-autoconfirmed-all-vandalism-all'] = 'Wikipedia pages semi-protected against vandalism', |
|||
['edit-autoconfirmed-category-all-all'] = 'Wikipedia semi-protected categories', |
|||
['edit-autoconfirmed-file-all-all'] = 'Semi-protected images', |
|||
['edit-autoconfirmed-portal-all-all'] = 'Semi-protected portals', |
|||
['edit-autoconfirmed-project-all-all'] = 'Semi-protected project pages', |
|||
['edit-autoconfirmed-talk-all-all'] = 'Semi-protected talk pages', |
|||
['edit-autoconfirmed-template-all-all'] = 'Wikipedia semi-protected templates', |
|||
['edit-autoconfirmed-template-all-all'] = 'Wikipedia semi-protected templates', |
|||
['edit-autoconfirmed-user-all-all'] = 'Wikipedia semi-protected user and user talk pages', |
|||
['edit-sysop-all-blp-all'] = 'Wikipedia indefinitely protected biographies of living people', |
|||
['edit-sysop-all-blp-temp'] = 'Wikipedia temporarily protected biographies of living people', |
|||
['edit-sysop-all-dispute-all'] = 'Wikipedia pages protected due to dispute', |
|||
['edit-sysop-all-sock-all'] = 'Wikipedia pages protected from banned users', |
|||
['edit-sysop-all-vandalism-all'] = 'Wikipedia pages protected against vandalism', |
|||
['edit-sysop-category-all-all'] = 'Wikipedia protected categories', |
|||
['edit-sysop-file-all-all'] = 'Protected images', |
|||
['edit-sysop-project-all-all'] = 'Protected project pages', |
|||
['edit-sysop-talk-all-all'] = 'Protected talk pages', |
|||
['edit-sysop-template-all-all'] = 'Wikipedia protected templates', |
|||
['edit-sysop-user-all-all'] = 'Wikipedia protected user and user talk pages', |
|||
['move-sysop-all-all-all'] = 'Wikipedia move-protected pages', |
|||
['move-sysop-all-all-indef'] = 'Wikipedia indefinitely move-protected pages', |
|||
['move-sysop-all-dispute-all'] = 'Wikipedia pages move-protected due to dispute', |
|||
['move-sysop-all-vandalism-all'] = 'Wikipedia pages move-protected due to vandalism', |
|||
['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals', |
|||
['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals', |
|||
['move-sysop-project-all-all'] = 'Wikipedia move-protected project pages', |
|||
['move-sysop-talk-all-all'] = 'Wikipedia move-protected talk pages', |
|||
['move-sysop-template-all-all'] = 'Wikipedia move-protected templates', |
|||
['move-sysop-user-all-all'] = 'Wikipedia move-protected user and user talk pages', |
|||
['autoreview-autoconfirmed-all-all-all'] = 'Wikipedia pending changes protected pages (level 1)', |
|||
['autoreview-reviewer-all-all-all'] = 'Wikipedia pending changes protected pages (level 2)', |
|||
} |
|||
local Protection = {} |
|||
cfg.categoryNamespaces = { |
|||
Protection.__index = Protection |
|||
[2] = 'user', |
|||
[3] = 'user', |
|||
[4] = 'project', |
|||
[6] = 'file', |
|||
[10] = 'template', |
|||
[12] = 'project', |
|||
[14] = 'category', |
|||
[100] = 'portal', |
|||
} |
|||
Protection.supportedActions = { |
|||
cfg.pagetypeNamespaces = { |
|||
edit = true, |
|||
move = true, |
|||
autoreview = true, |
|||
[10] = 'template', |
|||
upload = true |
|||
[14] = 'category', |
|||
[828] = 'module', |
|||
default = 'page' |
|||
} |
} |
||
Protection.bannerConfigFields = { |
|||
cfg.errorCategories = { |
|||
'text', |
|||
incorrect = 'Wikipedia pages with incorrect protection templates', |
|||
'explanation', |
|||
noExpiry = 'Wikipedia protected pages without expiry', |
|||
'tooltip', |
|||
create = 'Wikipedia pages tagged as create-protected', |
|||
'alt', |
|||
template = 'Wikipedia template-protected pages other than templates and modules' |
|||
'link', |
|||
'image' |
|||
} |
} |
||
function Protection.new(args, cfg, title) |
|||
-------------------------------------------------------------------------------- |
|||
local obj = {} |
|||
-- Helper functions |
|||
obj._cfg = cfg |
|||
-------------------------------------------------------------------------------- |
|||
obj.title = title or mw.title.getCurrentTitle() |
|||
-- Set action |
|||
local function toTableEnd(t, pos) |
|||
if not args.action then |
|||
-- Sends the value at position pos to the end of array t, and shifts the |
|||
obj.action = 'edit' |
|||
-- other items down accordingly. |
|||
elseif Protection.supportedActions[args.action] then |
|||
return table.insert(t, table.remove(t, pos)) |
|||
obj.action = args.action |
|||
end |
|||
-------------------------------------------------------------------------------- |
|||
-- Banner object |
|||
-------------------------------------------------------------------------------- |
|||
local banner = {} |
|||
function banner.new(args) |
|||
local obj = {} |
|||
setmetatable(obj, { |
|||
__index = banner |
|||
}) |
|||
-- Set the protection action. |
|||
-- This is the action we are supposed to be protecting the page against, |
|||
-- and does not necessarily correspond to the actual protection status. |
|||
obj.action = args.action or 'edit' |
|||
-- Get the title object of the page we are working on. |
|||
if args.page then |
|||
obj.title = mw.title.new(args.page) |
|||
else |
else |
||
error(string.format( |
|||
obj.title = mw.title.getCurrentTitle() |
|||
'invalid action: %s', |
|||
tostring(args.action) |
|||
), 3) |
|||
end |
end |
||
-- Set level |
|||
-- Get the protection level of the title object for the given protection |
|||
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title) |
|||
-- action. This is always a string, even for invalid actions. |
|||
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then |
|||
do |
|||
-- Users need to be autoconfirmed to move pages anyway, so treat |
|||
local protectionData = p.getProtectionData(obj.title) |
|||
-- semi-move-protected pages as unprotected. |
|||
local protectionLevel = protectionData[obj.action] |
|||
obj. |
obj.level = '*' |
||
end |
end |
||
-- Set expiry |
|||
-- Fetch the banner data and copy it into the object. |
|||
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title) |
|||
-- This could be problematic if the data table and the banner object have |
|||
if effectiveExpiry == 'infinity' then |
|||
-- any duplicate keys, so check for those. |
|||
obj.expiry = 'indef' |
|||
do |
|||
elseif effectiveExpiry ~= 'unknown' then |
|||
local data |
|||
obj.expiry = validateDate(effectiveExpiry, 'expiry date') |
|||
if args.reason |
|||
end |
|||
and cfg.banners[obj.action] |
|||
and cfg.banners[obj.action][args.reason] |
|||
-- Set reason |
|||
then |
|||
if args[1] then |
|||
data = cfg.banners[obj.action][obj.reason] |
|||
obj.reason = mw.ustring.lower(args[1]) |
|||
elseif cfg.defaultBanners[obj.action] then |
|||
if obj.reason:find('|') then |
|||
data = cfg.defaultBanners[obj.action] |
|||
error('reasons cannot contain the pipe character ("|")', 3) |
|||
elseif cfg.defaultBanners.edit then |
|||
data = cfg.defaultBanners.edit |
|||
else |
|||
error('no banner data found; please define data for cfg.defaultBanners') |
|||
end |
|||
local usedFields = {} |
|||
for k in pairs(banner) do |
|||
usedFields[k] = true |
|||
end |
|||
for k in pairs(obj) do |
|||
usedFields[k] = true |
|||
end |
|||
for k, v in pairs(data) do |
|||
if usedFields[k] then |
|||
error('banner.new: duplicate config key "' .. tostring(k) .. '" detected') |
|||
else |
|||
obj[k] = v |
|||
end |
|||
end |
end |
||
end |
end |
||
-- Set protection date |
|||
-- Find whether we are outputting a padlock or a full banner. |
|||
if |
if args.date then |
||
obj.protectionDate = validateDate(args.date, 'protection date') |
|||
-- Let the config data take precedence over user-specified arguments |
|||
obj.small = yesno(args.small) or false |
|||
end |
end |
||
-- Set banner config |
|||
return obj |
|||
do |
|||
end |
|||
obj.bannerConfig = {} |
|||
local configTables = {} |
|||
function banner:fetchImageName() |
|||
if cfg.banners[obj.action] then |
|||
local image |
|||
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] |
|||
if self.reason == 'office' or self.reason == 'reset' then |
|||
image = cfg.images.office |
|||
elseif self.title.namespace == 10 or self.title.namespace == 828 then |
|||
-- We are in the template or module namespaces. |
|||
if self.protectionLevel == 'templateeditor' then |
|||
image = cfg.images.template |
|||
elseif self.protectionLevel == 'sysop' then |
|||
image = cfg.images.indef |
|||
end |
end |
||
if cfg.defaultBanners[obj.action] then |
|||
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] |
|||
image = cfg.images.create |
|||
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default |
|||
elseif self.action == 'move' |
|||
and ( |
|||
self.protectionLevel == 'templateeditor' |
|||
or self.protectionLevel == 'sysop' |
|||
) |
|||
then |
|||
image = cfg.images.move |
|||
elseif self.action == 'edit' then |
|||
if self.protectionLevel == 'sysop' then |
|||
image = cfg.images.full |
|||
elseif self.protectionLevel == 'autoconfirmed' then |
|||
image = cfg.images.semi |
|||
end |
end |
||
configTables[#configTables + 1] = cfg.masterBanner |
|||
elseif self.action == 'autoreview' then |
|||
for i, field in ipairs(Protection.bannerConfigFields) do |
|||
if self.protectionLevel == 'autoconfirmed' then |
|||
for j, t in ipairs(configTables) do |
|||
image = cfg.images.pc1 |
|||
if t[field] then |
|||
elseif self.protectionLevel == 'reviewer' then |
|||
obj.bannerConfig[field] = t[field] |
|||
image = cfg.images.pc2 |
|||
break |
|||
end |
|||
end |
|||
end |
end |
||
else |
|||
image = 'Transparent.gif' |
|||
end |
end |
||
return |
return setmetatable(obj, Protection) |
||
end |
end |
||
function Protection:isUserScript() |
|||
function banner:renderImageLink(image, size, link, text, alt) |
|||
-- Whether the page is a user JavaScript or CSS page. |
|||
--[[ |
|||
local title = self.title |
|||
-- Renders the image link wikitext All parameters are optional |
|||
return title.namespace == 2 and ( |
|||
-- apart from the display text. |
|||
title.contentModel == 'javascript' or title.contentModel == 'css' |
|||
-- |
|||
) |
|||
-- @parameters: |
|||
-- image - the image name |
|||
-- size - the image size, as a number |
|||
-- link - page linked to by the image |
|||
-- text - the tooltip text |
|||
-- alt - the alt text |
|||
-- |
|||
-- All parameters are optional apart from the text parameter. |
|||
--]] |
|||
image = image or 'Transparent.gif' |
|||
size = size or 20 |
|||
if link then |
|||
link = '|link=' .. link |
|||
else |
|||
link = '' |
|||
end |
|||
text = text or error('No text parameter supplied to p.renderImageLink') |
|||
if alt then |
|||
alt = '|alt=' .. alt |
|||
else |
|||
alt = '' |
|||
end |
|||
return string.format('[[Image:%s|%dpx%s|%s%s]]', image, size, link, text, alt) |
|||
end |
end |
||
function |
function Protection:isProtected() |
||
return self.level ~= '*' |
|||
--[[ |
|||
-- Renders the html of the padlock seen in the top-right-hand corner |
|||
-- of protected pages. |
|||
-- |
|||
-- @parameters: |
|||
-- image - the image wikitext (required) |
|||
-- right - the "right" css property value, as a string (optional) |
|||
--]] |
|||
image = image or error('No image parameter specified in p.renderPadlock') |
|||
local root = mw.html.create('div') |
|||
root |
|||
:addClass('metadata topicon nopopups') |
|||
:attr('id', 'protected-icon') |
|||
:css{display = 'none', right = right or '55px'} |
|||
:wikitext(image) |
|||
return tostring(root) |
|||
end |
end |
||
function |
function Protection:shouldShowLock() |
||
-- Whether we should output a banner/padlock |
|||
--[[ |
|||
return self:isProtected() and not self:isUserScript() |
|||
-- Renders the large protection banner placed at the top of articles, |
|||
-- using the data provided in the data table. |
|||
-- |
|||
-- @parameters: |
|||
-- page - demo page parameter to pass to {{mbox}} |
|||
-- image - the image wikitext |
|||
-- text - the text to display |
|||
-- |
|||
-- All parameters are optional. |
|||
--]] |
|||
mMessageBox = require('Module:Message box') |
|||
local mbargs = { -- arguments for the message box module |
|||
page = page, |
|||
type = 'protection', |
|||
image = image, |
|||
text = text |
|||
} |
|||
return mMessageBox.main('mbox', mbargs) |
|||
end |
end |
||
-- Whether this page needs a protection category. |
|||
function banner:export() |
|||
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock |
|||
-- Add the banner/padlock, protection category, and tracking categories. |
|||
local ret = '' |
|||
ret = ret .. self:renderBannerOrPadlock() |
|||
ret = ret .. self:renderProtectionCategory() |
|||
ret = ret .. self:renderTrackingCategories() |
|||
return ret |
|||
end |
|||
function Protection:isTemporary() |
|||
-------------------------------------------------------------------------------- |
|||
return type(self.expiry) == 'number' |
|||
-- Main functions |
|||
-------------------------------------------------------------------------------- |
|||
local p = {} |
|||
function p.main(frame) |
|||
local args = mArguments.getArgs(frame) |
|||
return p._main(args) |
|||
end |
end |
||
function |
function Protection:makeProtectionCategory() |
||
if not self:shouldHaveProtectionCategory() then |
|||
-- Gets a table containing protection data for the given title. The data |
|||
return '' |
|||
-- is cached using a metatable, and so can be indexed as needed without |
|||
end |
|||
-- a performance loss. |
|||
local protectionData = {} |
|||
local actions = { |
|||
create = true, |
|||
edit = true, |
|||
move = true, |
|||
autoreview = true |
|||
} |
|||
setmetatable(protectionData, { |
|||
__index = function (t, key) |
|||
local level |
|||
if actions[key] then |
|||
level = mProtectionLevel(key, title) |
|||
if level == 'accountcreator' then |
|||
-- Lump titleblacklisted pages in with template-protected pages, |
|||
-- since templateeditors can do both. |
|||
level = 'templateeditor' |
|||
end |
|||
end |
|||
protectionData[key] = level |
|||
return level |
|||
end |
|||
}) |
|||
return protectionData |
|||
end |
|||
local cfg = self._cfg |
|||
function p.getPagetype(ns) |
|||
local title = self.title |
|||
-- Returns a string with the page's type. Takes a namespace number as input. |
|||
local pagetype = pagetypeNamespaces[ns] or pagetypeNamespaces.default |
|||
-- Get the expiry key fragment. |
|||
if not pagetype then |
|||
local expiryFragment |
|||
error('the page type could not be found; please define a name for the key "default"') |
|||
if self.expiry == 'indef' then |
|||
expiryFragment = self.expiry |
|||
elseif type(self.expiry) == 'number' then |
|||
expiryFragment = 'temp' |
|||
end |
end |
||
return pagetype |
|||
end |
|||
-- Get the namespace key fragment. |
|||
function p.matchNamespace(ns) |
|||
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] |
|||
-- Matches a namespace number to a string that can be passed to the |
|||
if not namespaceFragment and title.namespace % 2 == 1 then |
|||
-- namespace parameter of p.getCategoryName. |
|||
namespaceFragment = 'talk' |
|||
if not ns or type(ns) ~= 'number' then |
|||
return nil |
|||
end |
end |
||
local nskey = cfg.categoryNamespaces[ns] |
|||
if not nskey and ns % 2 == 1 then |
|||
nskey = 'talk' |
|||
end |
|||
return nskey |
|||
end |
|||
-- Define the order that key fragments are tested in. This is done with an |
|||
function p.getCategoryName(cats, action, level, namespace, reason, expiry) |
|||
-- array of tables containing the value to be tested, along with its |
|||
--[[ |
|||
-- position in the cfg.protectionCategories table. |
|||
-- Gets a category name from the category table, given a combination of |
|||
local order = { |
|||
-- the protection type, the protection level, the namespace number, the |
|||
{val = expiryFragment, keypos = 1}, |
|||
-- reason for protection, and the expiry date. |
|||
{val = namespaceFragment, keypos = 2}, |
|||
--]] |
|||
{val = self.reason, keypos = 3}, |
|||
cats = cats or cfg.categories |
|||
{val = self.level, keypos = 4}, |
|||
{val = self.action, keypos = 5} |
|||
} |
|||
--[[ |
--[[ |
||
-- The old protection templates used an ad-hoc protection category system, |
|||
-- Define the properties table. Each property is a table containing the |
|||
-- with some templates prioritising namespaces in their categories, and |
|||
-- canonical order that the property is tested in, the position the |
|||
-- others prioritising the protection reason. To emulate this in this module |
|||
-- property has in the category key strings, and the property value itself. |
|||
-- 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)) |
|||
local properties = { |
|||
expiry = {order = 1, keypos = 5, val = expiry}, |
|||
namespace = {order = 2, keypos = 3, val = p.matchNamespace(namespace)}, |
|||
reason = {order = 3, keypos = 4, val = reason}, |
|||
level = {order = 4, keypos = 2, val = level}, |
|||
action = {order = 5, keypos = 1, val = action} |
|||
} |
|||
--[[ |
--[[ |
||
-- |
-- Define the attempt order. Inactive subtables (subtables with nil "value" |
||
-- fields) are moved to the end, where they will later be given the key |
|||
-- The configuration is stored in the categoryOrder field of each reason |
|||
-- "all". This is to cut down on the number of table lookups in |
|||
-- subtable of cfg.reasons. If the value is a table, then the order is the |
|||
-- cfg.protectionCategories, which grows exponentially with the number of |
|||
-- values specified in the table. If the value is a string, then the |
|||
-- non-nil keys. We keep track of the number of active subtables with the |
|||
-- property corresponding to that string is tested last (i.e. it is the most |
|||
-- noActive parameter. |
|||
-- important, because it keeps its specified value the longest) and the |
|||
-- other properties are tested in the canonical order. If the value is of |
|||
-- any other type then the canonical order is used. |
|||
--]] |
--]] |
||
local noActive, attemptOrder |
|||
local reasonTable = reason and cfg.reasons[reason] |
|||
do |
|||
local categoryOrder = reasonTable and reasonTable.categoryOrder |
|||
local active, inactive = {}, {} |
|||
local categoryOrderType = type(categoryOrder) |
|||
for i, t in ipairs(order) do |
|||
local configOrder = {} |
|||
if t.val then |
|||
active[#active + 1] = t |
|||
for i = 1, 5 do |
|||
local propertiesKey = categoryOrder[i] |
|||
if not propertiesKey then |
|||
local msg = 'no entry found for key ' |
|||
.. i |
|||
.. ' in the cfg.reasons.' |
|||
.. reason |
|||
.. '.categoryOrder table' |
|||
error(msg) |
|||
end |
|||
local property = properties[propertiesKey] |
|||
if not property then |
|||
local msg = 'invalid value "' |
|||
.. propertiesKey |
|||
.. '" detected in the cfg.reasons.' |
|||
.. reason |
|||
.. '.categoryOrder table' |
|||
error(msg) |
|||
end |
|||
if dupes[propertiesKey] then |
|||
local msg = 'duplicate values "' |
|||
.. propertiesKey |
|||
.. '" detected in the cfg.reasons.' |
|||
.. reason |
|||
.. '.categoryOrder table' |
|||
error(msg) |
|||
else |
else |
||
inactive[#inactive + 1] = t |
|||
end |
end |
||
configOrder[i] = property |
|||
end |
end |
||
noActive = #active |
|||
else |
|||
attemptOrder = active |
|||
for propertiesKey, t in pairs(properties) do |
|||
for i, t in ipairs(inactive) do |
|||
configOrder[t.order] = t |
|||
attemptOrder[#attemptOrder + 1] = t |
|||
end |
|||
if categoryOrderType == 'string' 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 |
|||
toTableEnd(configOrder, property.order) |
|||
end |
end |
||
end |
end |
||
--[[ |
--[[ |
||
-- Check increasingly generic key combinations until we find a match. If a |
|||
-- Define the attempt order. Properties with no value defined are moved |
|||
-- specific category exists for the combination of key fragments we are |
|||
-- to the end, where they will later be given the value "all". This is |
|||
-- given, that match will be found first. If not, we keep trying different |
|||
-- to cut down on the number of table lookups in the cats table, which |
|||
-- key fragment combinations until we match using the key |
|||
-- grows exponentially with the number of properties with valid values. |
|||
-- We keep track of the number of active properties with the noActive |
|||
-- parameter. |
|||
--]] |
|||
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 |
|||
local noActive = #active |
|||
local attemptOrder = active |
|||
for i, t in ipairs(inactive) do |
|||
attemptOrder[#attemptOrder + 1] = t |
|||
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". |
-- "all-all-all-all-all". |
||
-- |
-- |
||
-- To generate the keys, we index the |
-- 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 |
||
-- corresponding to |
-- 1 corresponding to other key fragments. |
||
-- val field in the property table: |
|||
-- |
-- |
||
-- j 1 2 3 |
-- j 1 2 3 |
||
Line 604: | Line 290: | ||
-- 8 0 0 0 |
-- 8 0 0 0 |
||
-- |
-- |
||
-- Values of j higher than the number of active |
-- Values of j higher than the number of active subtables are set |
||
-- to the string "all". |
-- to the string "all". |
||
-- |
-- |
||
-- A key for |
-- A key for cfg.protectionCategories is constructed for each value of i. |
||
-- The |
-- The position of the value in the key is determined by the keypos field in |
||
-- each subtable. |
|||
-- pos field in the property table. |
|||
--]] |
--]] |
||
local cats = cfg.protectionCategories |
|||
for i = 1, 2^noActive do |
for i = 1, 2^noActive do |
||
local key = {} |
local key = {} |
||
Line 626: | Line 313: | ||
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 attempt |
return makeCategoryLink(attempt, title.text) |
||
end |
end |
||
end |
end |
||
return '' |
|||
error( |
|||
end |
|||
'No category match found;' |
|||
.. ' please define the category for key "all-all-all-all-all"' |
|||
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 |
end |
||
function Blurb:_getExpandedMessage(msgKey) |
|||
--[[ |
|||
return self:_substituteParameters(self._cfg.msg[msgKey]) |
|||
When to add "Category:Wikipedia pages with incorrect protection templates": |
|||
end |
|||
* If it uses a type which is incompatible with the actual protection level of a page, or |
|||
* If an expiry date is set and is in the past |
|||
function Blurb:_substituteParameters(msg) |
|||
When to add "Category:Wikipedia protected pages without expiry": |
|||
if not self._params then |
|||
* No expiry is set, and |
|||
local parameterFuncs = {} |
|||
* Expiry can be set, and |
|||
* The protection type is not "move" (could change this?), and |
|||
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter |
|||
* The reason doesn't have "indefinitely protected" categories (pp-blp, pp-semi-indef and pp-move-indef have these), and |
|||
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter |
|||
* The reason is not the generic pp-protected (could change this?) |
|||
parameterFuncs.EXPIRY = self._makeExpiryParameter |
|||
(This leaves reasons "dispute", "vandalism", "usertalk", and "sock") |
|||
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 not yesno(args.catonly) and (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 |
return p |
Latest revision as of 17:57, August 8, 2023
Documentation for this module may be created at Module:Protection banner/doc
-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.
-- Initialise necessary modules.
require('strict')
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 not yesno(args.catonly) and (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