Difference between pages "Module:Protection banner/config/sandbox" and "Module:Protection banner/sandbox"

From Jonesipedia
< Module:Protection banner‎ | config(Difference between pages)
Jump to navigation Jump to search
m (1 revision imported)
 
wp>Cenarium
(remove expiry param and needsexpiry check)
 
Line 1: Line 1:
-- This module provides configuration data for [[Module:Protection banner]].
+
-- This module implements {{pp-meta}} and its daughter templates such as
 +
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.
  
return {
+
-- Initialise necessary modules.
 +
require('Module:No globals')
 +
local makeFileLink = require('Module:File link')._main
 +
local effectiveProtectionLevel = require('Module:Effective protection level')._main
 +
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
 +
local yesno = require('Module:Yesno')
  
----
+
-- Lazily initialise modules and objects we don't always need.
--
+
local getArgs, makeMessageBox, lang
--                                BANNER DATA
 
--
 
----
 
  
--[[
+
-- Set constants.
-- Banner data consists of six fields:
+
local CONFIG_MODULE = 'Module:Protection banner/config/sandbox' -- SWITCH THIS BACK TO THE MAIN CONFIG PAGE BEFORE GOING LIVE!
-- * text - the main protection text that appears at the top of protection
 
--  banners.
 
-- * explanation - the text that appears below the main protection text, used
 
--  to explain the details of the protection.
 
-- * tooltip - the tooltip text you see when you move the mouse over a small
 
--  padlock icon.
 
-- * link - the page that the small padlock icon links to.
 
-- * alt - the alt text for the small padlock icon. This is also used as tooltip
 
--  text for the large protection banners.
 
-- * image - the padlock image used in both protection banners and small padlock
 
--  icons.
 
--
 
-- The module checks in three separate tables to find a value for each field.
 
-- First it checks the banners table, which has values specific to the reason
 
-- for the page being protected. Then the module checks the defaultBanners
 
-- table, which has values specific to each protection level. Finally, the
 
-- module checks the masterBanner table, which holds data for protection
 
-- templates to use if no data has been found in the previous two tables.
 
--
 
-- The values in the banner data can take parameters. These are specified
 
-- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
 
-- enclosed in curly braces).
 
--
 
--                          Available parameters:
 
--
 
-- ${CURRENTVERSION} - a link to the page history or the move log, with the
 
-- display message "current-version-edit-display" or
 
-- "current-version-move-display".
 
--
 
-- ${EDITREQUEST} - a link to create an edit request for the current page.
 
--
 
-- ${EXPLANATIONBLURB} - an explanation blurb, e.g. "Please discuss any changes
 
-- on the talk page; you may submit a request to ask an administrator to make
 
-- an edit if it is minor or supported by consensus."
 
--
 
-- ${IMAGELINK} - a link to set the image to, depending on the protection
 
-- action and protection level.
 
--
 
-- ${INTROBLURB} - the PROTECTIONBLURB parameter, plus the expiry if an expiry
 
-- is set. E.g. "Editing of this page by new or unregistered users is currently
 
-- disabled until dd Month YYYY."
 
--
 
-- ${INTROFRAGMENT} - the same as ${INTROBLURB}, but without final punctuation
 
-- so that it can be used in run-on sentences.
 
--
 
-- ${PAGETYPE} - the type of the page, e.g. "article" or "template".
 
-- Defined in the cfg.pagetypes table.
 
--
 
-- ${PROTECTIONBLURB} - a blurb explaining the protection level of the page, e.g.
 
-- "Editing of this page by new or unregistered users is currently disabled"
 
--
 
-- ${PROTECTIONDATE} - the protection date, if it has been supplied to the
 
-- template.
 
--
 
-- ${PROTECTIONLEVEL} - the protection level, e.g. "fully protected" or
 
-- "semi-protected".
 
--
 
-- ${PROTECTIONLOG} - a link to the protection log or the pending changes log,
 
-- depending on the protection action.
 
--
 
-- ${TALKPAGE} - a link to the talk page. If a section is specified, links
 
-- straight to that talk page section.
 
--
 
-- ${TOOLTIPBLURB} - uses the PAGETYPE, PROTECTIONTYPE and EXPIRY parameters to
 
-- create a blurb like "This template is semi-protected", or "This article is
 
-- move-protected until DD Month YYYY".
 
--
 
-- ${VANDAL} - links for the specified username (or the root page name)
 
-- using Module:Vandal-m.
 
--
 
--                                Functions
 
--
 
-- For advanced users, it is possible to use Lua functions instead of strings
 
-- in the banner config tables. Using functions gives flexibility that is not
 
-- possible just by using parameters. Functions take two arguments, the
 
-- protection object and the template arguments, and they must output a string.
 
--
 
-- For example:
 
--
 
-- text = function (protectionObj, args)
 
--    if protectionObj.level == 'autoconfirmed' then
 
--        return 'foo'
 
--    else
 
--        return 'bar'
 
--    end
 
-- end
 
--
 
-- Some protection object properties and methods that may be useful:
 
-- protectionObj.action - the protection action
 
-- protectionObj.level - the protection level
 
-- protectionObj.reason - the protection reason
 
-- protectionObj.expiry - the expiry. Nil if unset, the string "indef" if set
 
--    to indefinite, and the protection time in unix time if temporary.
 
-- protectionObj.protectionDate - the protection date in unix time, or nil if
 
--    unspecified.
 
-- protectionObj.bannerConfig - the banner config found by the module. Beware
 
--    of editing the config field used by the function, as it could create an
 
--    infinite loop.
 
-- protectionObj:isProtected - returns a boolean showing whether the page is
 
--    protected.
 
-- protectionObj:isTemporary - returns a boolean showing whether the expiry is
 
--    temporary.
 
-- protectionObj:isIncorrect - returns a boolean showing whether the protection
 
--    template is incorrect.
 
--]]
 
  
-- The master banner data, used if no values have been found in banners or
+
--------------------------------------------------------------------------------
-- defaultBanners.
+
-- Helper functions
masterBanner = {
+
--------------------------------------------------------------------------------
text = '${INTROBLURB}',
 
explanation = '${EXPLANATIONBLURB}',
 
tooltip = '${TOOLTIPBLURB}',
 
link = '${IMAGELINK}',
 
alt = 'Page ${PROTECTIONLEVEL}'
 
},
 
  
-- The default banner data. This holds banner data for different protection
+
local function makeCategoryLink(cat, sort)
-- levels.
+
if cat then
-- *required* - this table needs edit, move, autoreview and upload subtables.
+
return string.format(
defaultBanners = {
+
'[[%s:%s|%s]]',
edit = {},
+
mw.site.namespaces[14].name,
move = {},
+
cat,
autoreview = {
+
sort
default = {
+
)
alt = 'Page protected with pending changes',
+
end
tooltip = 'All edits by unregistered and new users are subject to review prior to becoming visible to unregistered users',
+
end
image = 'Pending-protection-shackle.svg'
 
}
 
},
 
upload = {}
 
},
 
  
-- The banner data. This holds banner data for different protection reasons.
+
-- Validation function for the expiry and the protection date
-- In fact, the reasons specified in this table control which reasons are
+
local function validateDate(dateString, dateType)
-- valid inputs to the first positional parameter.
+
if not lang then
--
+
lang = mw.language.getContentLanguage()
-- There is also a non-standard "description" field that can be used for items
+
end
-- in this table. This is a description of the protection reason for use in the
+
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
-- module documentation.
+
if success then
--
+
result = tonumber(result)
-- *required* - this table needs edit, move, autoreview and upload subtables.
+
if result then
banners = {
+
return result
edit = {
+
end
blp = {
+
end
description = 'For pages protected to promote compliance with the'
+
error(string.format(
.. ' [[Wikipedia:Biographies of living persons'
+
'invalid %s: %s',
.. '|biographies of living persons]] policy',
+
dateType,
text = '${INTROFRAGMENT} to promote compliance with'
+
tostring(dateString)
.. ' [[Wikipedia:Biographies of living persons'
+
), 4)
.. "|Wikipedia's&nbsp;policy on&nbsp;the&nbsp;biographies"
+
end
.. ' of&nbsp;living&nbsp;people]].',
+
 
tooltip = '${TOOLTIPFRAGMENT} to promote compliance with the policy on'
+
local function makeFullUrl(page, query, display)
.. ' biographies of living people',
+
return string.format(
},
+
'[%s %s]',
dmca = {
+
tostring(mw.uri.fullUrl(page, query)),
description = 'For pages protected by the Wikimedia Foundation'
+
display
.. ' due to [[Digital Millennium Copyright Act]] takedown requests',
+
)
explanation = function (protectionObj, args)
+
end
local ret = 'Pursuant to a rights owner notice under the Digital'
+
 
.. ' Millennium Copyright Act (DMCA) regarding some content'
+
-- Given a directed graph formatted as node -> table of direct successors,
.. ' in this article, the Wikimedia Foundation acted under'
+
-- get a table of all nodes reachable from a given node (though always
.. ' applicable law and took down and restricted the content'
+
-- including the given node).
.. ' in question.'
+
local function getReachableNodes(graph, start)
if args.notice then
+
local toWalk, retval = {[start] = true}, {}
ret = ret .. ' A copy of the received notice can be found here: '
+
while true do
.. args.notice .. '.'
+
-- 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
ret = ret .. ' For more information, including websites discussing'
+
end
.. ' how to file a counter-notice, please see'
+
end
.. " [[Wikipedia:Office actions]] and the article's ${TALKPAGE}."
+
end
.. "'''Do not remove this template from the article until the"
+
return setmetatable(obj, Protection)
.. " restrictions are withdrawn'''."
+
end
return ret
+
 
end,
+
function Protection:isProtected()
image = 'Office-protection-shackle.svg',
+
return self.level ~= '*'
},
+
end
dispute = {
+
 
description = 'For pages protected due to editing disputes',
+
function Protection:isTemporary()
text = function (protectionObj, args)
+
return type(self.expiry) == 'number'
-- Find the value of "disputes".
+
end
local display = 'disputes'
+
 
local disputes
+
function Protection:makeProtectionCategory()
if args.section then
+
local cfg = self._cfg
disputes = string.format(
+
local title = self.title
'[[%s:%s#%s|%s]]',
+
mw.site.namespaces[protectionObj.title.namespace].talk.name,
+
-- Exit if the page is not protected.
protectionObj.title.text,
+
if not self:isProtected() then
args.section,
+
return ''
display
+
end
)
+
 +
-- Get the expiry key fragment.
 +
local expiryFragment
 +
if self.expiry == 'indef' then
 +
expiryFragment = self.expiry
 +
elseif type(self.expiry) == 'number' then
 +
expiryFragment = 'temp'
 +
end
 +
 
 +
-- Get the namespace key fragment.
 +
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
 +
if not namespaceFragment and title.namespace % 2 == 1 then
 +
namespaceFragment = 'talk'
 +
end
 +
 +
-- Define the order that key fragments are tested in. This is done with an
 +
-- array of tables containing the value to be tested, along with its
 +
-- position in the cfg.protectionCategories table.
 +
local order = {
 +
{val = expiryFragment,    keypos = 1},
 +
{val = namespaceFragment, keypos = 2},
 +
{val = self.reason,      keypos = 3},
 +
{val = self.level,        keypos = 4},
 +
{val = self.action,      keypos = 5}
 +
}
 +
 
 +
--[[
 +
-- The old protection templates used an ad-hoc protection category system,
 +
-- with some templates prioritising namespaces in their categories, and
 +
-- others prioritising the protection reason. To emulate this in this module
 +
-- we use the config table cfg.reasonsWithNamespacePriority to set the
 +
-- reasons for which namespaces have priority over protection reason.
 +
-- If we are dealing with one of those reasons, move the namespace table to
 +
-- the end of the order table, i.e. give it highest priority. If not, the
 +
-- reason should have highest priority, so move that to the end of the table
 +
-- instead.
 +
--]]
 +
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
 +
 +
--[[
 +
-- Define the attempt order. Inactive subtables (subtables with nil "value"
 +
-- fields) are moved to the end, where they will later be given the key
 +
-- "all". This is to cut down on the number of table lookups in
 +
-- cfg.protectionCategories, which grows exponentially with the number of
 +
-- non-nil keys. We keep track of the number of active subtables with the
 +
-- noActive parameter.
 +
--]]
 +
local noActive, attemptOrder
 +
do
 +
local active, inactive = {}, {}
 +
for i, t in ipairs(order) do
 +
if t.val then
 +
active[#active + 1] = t
 +
else
 +
inactive[#inactive + 1] = t
 +
end
 +
end
 +
noActive = #active
 +
attemptOrder = active
 +
for i, t in ipairs(inactive) do
 +
attemptOrder[#attemptOrder + 1] = t
 +
end
 +
end
 +
 +
--[[
 +
-- Check increasingly generic key combinations until we find a match. If a
 +
-- specific category exists for the combination of key fragments we are
 +
-- given, that match will be found first. If not, we keep trying different
 +
-- key fragment combinations until we match using the key
 +
-- "all-all-all-all-all".
 +
--
 +
-- To generate the keys, we index the key subtables using a binary matrix
 +
-- with indexes i and j. j is only calculated up to the number of active
 +
-- subtables. For example, if there were three active subtables, the matrix
 +
-- would look like this, with 0 corresponding to the key fragment "all", and
 +
-- 1 corresponding to other key fragments.
 +
--
 +
--  j 1  2  3
 +
-- i 
 +
-- 1  1  1  1
 +
-- 2  0  1  1
 +
-- 3  1  0  1
 +
-- 4  0  0  1
 +
-- 5  1  1  0
 +
-- 6  0  1  0
 +
-- 7  1  0  0
 +
-- 8  0  0  0
 +
--
 +
-- Values of j higher than the number of active subtables are set
 +
-- to the string "all".
 +
--
 +
-- A key for cfg.protectionCategories is constructed for each value of i.
 +
-- The position of the value in the key is determined by the keypos field in
 +
-- each subtable.
 +
--]]
 +
local cats = cfg.protectionCategories
 +
for i = 1, 2^noActive do
 +
local key = {}
 +
for j, t in ipairs(attemptOrder) do
 +
if j > noActive then
 +
key[t.keypos] = 'all'
 +
else
 +
local quotient = i / 2 ^ (j - 1)
 +
quotient = math.ceil(quotient)
 +
if quotient % 2 == 1 then
 +
key[t.keypos] = t.val
 
else
 
else
disputes = display
+
key[t.keypos] = 'all'
 
end
 
end
 +
end
 +
end
 +
key = table.concat(key, '|')
 +
local attempt = cats[key]
 +
if attempt then
 +
return makeCategoryLink(attempt, title.text)
 +
end
 +
end
 +
return ''
 +
end
 +
 +
function Protection:isIncorrect()
 +
local expiry = self.expiry
 +
return not self:isProtected()
 +
or type(expiry) == 'number' and expiry < os.time()
 +
end
 +
 +
function Protection:isTemplateProtectedNonTemplate()
 +
local action, namespace = self.action, self.title.namespace
 +
return self.level == 'templateeditor'
 +
and (
 +
(action ~= 'edit' and action ~= 'move')
 +
or (namespace ~= 10 and namespace ~= 828)
 +
)
 +
end
 +
 +
function Protection:makeCategoryLinks()
 +
local msg = self._cfg.msg
 +
local ret = { self:makeProtectionCategory() }
 +
if self:isIncorrect() then
 +
ret[#ret + 1] = makeCategoryLink(
 +
msg['tracking-category-incorrect'],
 +
self.title.text
 +
)
 +
end
 +
if self:isTemplateProtectedNonTemplate() then
 +
ret[#ret + 1] = makeCategoryLink(
 +
msg['tracking-category-template'],
 +
self.title.text
 +
)
 +
end
 +
return table.concat(ret)
 +
end
  
-- Make the blurb, depending on the expiry.
+
--------------------------------------------------------------------------------
local msg
+
-- Blurb class
if type(protectionObj.expiry) == 'number' then
+
--------------------------------------------------------------------------------
msg = '${INTROFRAGMENT} or until editing %s have been resolved.'
 
else
 
msg = '${INTROFRAGMENT} until editing %s have been resolved.'
 
end
 
return string.format(msg, disputes)
 
end,
 
explanation = "This protection is '''not''' an endorsement of the"
 
.. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
 
tooltip = '${TOOLTIPFRAGMENT} due to editing disputes',
 
},
 
ecp = {
 
description = 'For articles in topic areas authorized by'
 
.. ' [[Wikipedia:Arbitration Committee|ArbCom]] or'
 
.. ' meets the criteria for community use',
 
tooltip = 'This ${PAGETYPE} is extended-confirmed protected',
 
alt = 'Extended-protected ${PAGETYPE}',
 
},
 
mainpage = {
 
description = 'For pages protected for being displayed on the [[Main Page]]',
 
text = 'This file is currently'
 
.. ' [[Wikipedia:This page is protected|protected]] from'
 
.. ' editing because it is currently or will soon be displayed'
 
.. ' on the [[Main Page]].',
 
explanation = 'Images on the Main Page are protected due to their high'
 
.. ' visibility. Please discuss any necessary changes on the ${TALKPAGE}.'
 
.. '<br /><span style="font-size:90%;">'
 
.. "'''Administrators:''' Once this image is definitely off the Main Page,"
 
.. ' please unprotect this file, or reduce to semi-protection,'
 
.. ' as appropriate.</span>',
 
},
 
office = {
 
description = 'For pages protected by the Wikimedia Foundation',
 
text = function (protectionObj, args)
 
local ret = 'This ${PAGETYPE} is currently under the'
 
.. ' scrutiny of the'
 
.. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]'
 
.. ' and is protected.'
 
if protectionObj.protectionDate then
 
ret = ret .. ' It has been protected since ${PROTECTIONDATE}.'
 
end
 
return ret
 
end,
 
explanation = "If you can edit this page, please discuss all changes and"
 
.. " additions on the ${TALKPAGE} first. '''Do not remove protection from this"
 
.. " page unless you are authorized by the Wikimedia Foundation to do"
 
.. " so.'''",
 
image = 'Office-protection-shackle.svg',
 
},
 
reset = {
 
description = 'For pages protected by the Wikimedia Foundation and'
 
.. ' "reset" to a bare-bones version',
 
text = 'This ${PAGETYPE} is currently under the'
 
.. ' scrutiny of the'
 
.. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]'
 
.. ' and is protected.',
 
explanation = function (protectionObj, args)
 
local ret = ''
 
if protectionObj.protectionDate then
 
ret = ret .. 'On ${PROTECTIONDATE} this ${PAGETYPE} was'
 
else
 
ret = ret .. 'This ${PAGETYPE} has been'
 
end
 
ret = ret .. ' 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 ${PAGETYPE} has been ${PROTECTIONLEVEL} while'
 
.. ' it is being rebuilt.\n\n'
 
.. 'Any insertion of material directly from'
 
.. ' pre-protection revisions of the ${PAGETYPE} will be removed, as'
 
.. ' will any material added to the ${PAGETYPE} that is not properly'
 
.. ' sourced. The associated talk page(s) were also cleared on the'
 
.. " same date.\n\n"
 
.. "If you can edit this page, please discuss all changes and"
 
.. " additions on the ${TALKPAGE} first. '''Do not override"
 
.. " this action, and do not remove protection from this page,"
 
.. " unless you are authorized by the Wikimedia Foundation"
 
.. " to do so. No editor may remove this notice.'''"
 
  
return ret
+
local Blurb = {}
end,
+
Blurb.__index = Blurb
image = 'Office-protection-shackle.svg',
 
},
 
sock = {
 
description = 'For pages protected due to'
 
.. ' [[Wikipedia:Sock puppetry|sock puppetry]]',
 
text = '${INTROFRAGMENT} to prevent [[Wikipedia:Sock puppetry|sock puppets]] of'
 
.. ' [[Wikipedia:Blocking policy|blocked]] or'
 
.. ' [[Wikipedia:Banning policy|banned users]]'
 
.. ' from editing it.',
 
tooltip = '${TOOLTIPFRAGMENT} to prevent sock puppets of blocked or banned users from'
 
.. ' editing it',
 
},
 
template = {
 
description = 'For [[Wikipedia:High-risk templates|high-risk]]'
 
.. ' templates and Lua modules',
 
text = 'This is a permanently [[Help:Protection|protected]] ${PAGETYPE},'
 
.. ' as it is [[Wikipedia:High-risk templates|high-risk]].',
 
explanation = 'Please discuss any changes on the ${TALKPAGE}; you may'
 
.. ' ${EDITREQUEST} to ask an'
 
.. ' [[Wikipedia:Administrators|administrator]] or'
 
.. ' [[Wikipedia:Template editor|template editor]] to make an edit if'
 
.. ' it is [[Help:Minor edit#When to mark an edit as a minor edit'
 
.. '|uncontroversial]] or supported by'
 
.. ' [[Wikipedia:Consensus|consensus]]. You can also'
 
.. ' [[Wikipedia:Requests for page protection|request]] that the page be'
 
.. ' unprotected.',
 
tooltip = 'This high-risk ${PAGETYPE} is permanently ${PROTECTIONLEVEL}'
 
.. ' to prevent vandalism',
 
alt = 'Permanently protected ${PAGETYPE}',
 
},
 
usertalk = {
 
description = 'For pages protected against disruptive edits by a'
 
.. ' particular user',
 
text = '${INTROFRAGMENT} to prevent ${VANDAL} from using it to make disruptive edits,'
 
.. ' such as abusing the'
 
.. ' &#123;&#123;[[Template:unblock|unblock]]&#125;&#125; 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]].',
 
},
 
vandalism = {
 
description = 'For pages protected against'
 
.. ' [[Wikipedia:Vandalism|vandalism]]',
 
text = '${INTROFRAGMENT} due to [[Wikipedia:Vandalism|vandalism]].',
 
explanation = function (protectionObj, args)
 
local ret = ''
 
if protectionObj.level == 'sysop' then
 
ret = ret .. "This protection is '''not''' an endorsement of the"
 
.. ' ${CURRENTVERSION}. '
 
end
 
return ret .. '${EXPLANATIONBLURB}'
 
end,
 
tooltip = '${TOOLTIPFRAGMENT} due to vandalism',
 
}
 
},
 
move = {
 
dispute = {
 
description = 'For pages protected against page moves due to'
 
.. ' disputes over the page title',
 
explanation = "This protection is '''not''' an endorsement of the"
 
.. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
 
image = 'Move-protection-shackle.svg'
 
},
 
vandalism = {
 
description = 'For pages protected against'
 
.. ' [[Wikipedia:Vandalism#Page-move vandalism'
 
.. ' |page-move vandalism]]'
 
}
 
},
 
autoreview = {},
 
upload = {}
 
},
 
  
----
+
Blurb.bannerTextFields = {
--
+
text = true,
--                            GENERAL DATA TABLES
+
explanation = true,
--
+
tooltip = true,
----
+
alt = true,
 +
link = true
 +
}
  
----
+
function Blurb.new(protectionObj, args, cfg)
-- Protection blurbs
+
return setmetatable({
----
+
_cfg = cfg,
 +
_protectionObj = protectionObj,
 +
_args = args
 +
}, Blurb)
 +
end
  
-- This table produces the protection blurbs available with the
+
-- Private methods --
-- ${PROTECTIONBLURB} parameter. It is sorted by protection action and
 
-- protection level, and is checked by the module in the following order:
 
-- 1. page's protection action, page's protection level
 
-- 2. page's protection action, default protection level
 
-- 3. "edit" protection action, default protection level
 
--
 
-- It is possible to use banner parameters inside this table.
 
-- *required* - this table needs edit, move, autoreview and upload subtables.
 
protectionBlurbs = {
 
edit = {
 
default = 'This ${PAGETYPE} is currently [[Help:Protection|'
 
.. 'protected]] from editing',
 
autoconfirmed = 'Editing of this ${PAGETYPE} by [[Wikipedia:User access'
 
.. ' levels#New users|new]] or [[Wikipedia:User access levels#Unregistered'
 
.. ' users|unregistered]] users is currently [[Help:Protection|disabled]]',
 
extendedconfirmed = 'This ${PAGETYPE} is ${PROTECTIONLEVEL} as a result of'
 
.. ' [[Wikipedia:Arbitration Committee|ArbCom]] enforcement or meets the'
 
.. ' [[Wikipedia:Protection policy#extended|criteria for community use]]',
 
},
 
move = {
 
default = 'This ${PAGETYPE} is currently [[Help:Protection|protected]]'
 
.. ' from [[Help:Moving a page|page moves]]'
 
},
 
autoreview = {
 
default = 'All edits made to this ${PAGETYPE} by'
 
.. ' [[Wikipedia:User access levels#New users|new]] or'
 
.. ' [[Wikipedia:User access levels#Unregistered users|unregistered]]'
 
.. ' users are currently'
 
.. ' [[Wikipedia:Pending changes|subject to review]]'
 
},
 
upload = {
 
default = 'Uploading new versions of this ${PAGETYPE} is currently disabled'
 
}
 
},
 
  
----
+
function Blurb:_formatDate(num)
-- Explanation blurbs
+
-- 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
  
-- This table produces the explanation blurbs available with the
+
function Blurb:_getExpandedMessage(msgKey)
-- ${EXPLANATIONBLURB} parameter. It is sorted by protection action,
+
return self:_substituteParameters(self._cfg.msg[msgKey])
-- protection level, and whether the page is a talk page or not. If the page is
+
end
-- a talk page it will have a talk key of "talk"; otherwise it will have a talk
 
-- key of "subject". The table is checked in the following order:
 
-- 1. page's protection action, page's protection level, page's talk key
 
-- 2. page's protection action, page's protection level, default talk key
 
-- 3. page's protection action, default protection level, page's talk key
 
-- 4. page's protection action, default protection level, default talk key
 
--
 
-- It is possible to use banner parameters inside this table.
 
-- *required* - this table needs edit, move, autoreview and upload subtables.
 
explanationBlurbs = {
 
edit = {
 
autoconfirmed = {
 
subject = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details. If you'
 
.. ' cannot edit this ${PAGETYPE} and you wish to make a change, you can'
 
.. ' ${EDITREQUEST}, discuss changes on the ${TALKPAGE},'
 
.. ' [[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]].',
 
default = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details. If you'
 
.. ' cannot edit this ${PAGETYPE} and you wish to make a change, you can'
 
.. ' [[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]].',
 
},
 
extendedconfirmed = {
 
default = 'Extended confirmed protection prevents edits from all IP editors'
 
.. ' and registered users with fewer than 30 days tenure and 500 edits.'
 
.. ' The [[Wikipedia:Protection policy#extended|policy on community use]]'
 
.. ' specifies that extended confirmed protection can be applied to combat'
 
.. ' disruption, if semi-protection has proven to be ineffective.'
 
.. ' Please discuss any changes on the ${TALKPAGE}; you may'
 
.. ' ${EDITREQUEST} to ask for uncontroversial changes supported by'
 
.. ' [[Wikipedia:Consensus|consensus]].'
 
},
 
default = {
 
subject = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' Please discuss any changes on the ${TALKPAGE}; you'
 
.. ' may ${EDITREQUEST} to ask an'
 
.. ' [[Wikipedia:Administrators|administrator]] to make an edit if it'
 
.. ' is [[Help:Minor edit#When to mark an edit as a minor edit'
 
.. '|uncontroversial]] or supported by [[Wikipedia:Consensus'
 
.. '|consensus]]. You may also [[Wikipedia:Requests for'
 
.. ' page protection#Current requests for reduction in protection level'
 
.. '|request]] that this page be unprotected.',
 
default = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' You may [[Wikipedia:Requests for page'
 
.. ' protection#Current requests for edits to a protected page|request an'
 
.. ' edit]] to this page, or [[Wikipedia:Requests for'
 
.. ' page protection#Current requests for reduction in protection level'
 
.. '|ask]] for it to be unprotected.'
 
}
 
},
 
move = {
 
default = {
 
subject = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' The page may still be edited but cannot be moved'
 
.. ' until unprotected. Please discuss any suggested moves on the'
 
.. ' ${TALKPAGE} or at [[Wikipedia:Requested moves]]. You can also'
 
.. ' [[Wikipedia:Requests for page protection|request]] that the page be'
 
.. ' unprotected.',
 
default = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' The page may still be edited but cannot be moved'
 
.. ' until unprotected. Please discuss any suggested moves at'
 
.. ' [[Wikipedia:Requested moves]]. You can also'
 
.. ' [[Wikipedia:Requests for page protection|request]] that the page be'
 
.. ' unprotected.'
 
}
 
},
 
autoreview = {
 
default = {
 
default = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' Edits to this ${PAGETYPE} by new and unregistered users'
 
.. ' will not be visible to readers until they are accepted by'
 
.. ' a reviewer. To avoid the need for your edits to be'
 
.. ' reviewed, you may'
 
.. ' [[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]].'
 
},
 
},
 
upload = {
 
default = {
 
default = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' The page may still be edited but new versions of the file'
 
.. ' cannot be uploaded until it is unprotected. You can'
 
.. ' request that a new version be uploaded by using a'
 
.. ' [[Wikipedia:Edit requests|protected edit request]], or you'
 
.. ' can  [[Wikipedia:Requests for page protection|request]]'
 
.. ' that the file be unprotected.'
 
}
 
}
 
},
 
  
----
+
function Blurb:_substituteParameters(msg)
-- Protection levels
+
if not self._params then
----
+
local parameterFuncs = {}
  
-- This table provides the data for the ${PROTECTIONLEVEL} parameter, which
+
parameterFuncs.CURRENTVERSION    = self._makeCurrentVersionParameter
-- produces a short label for different protection levels. It is sorted by
+
parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
-- protection action and protection level, and is checked in the following
+
parameterFuncs.EXPIRY            = self._makeExpiryParameter
-- order:
+
parameterFuncs.EXPLANATIONBLURB  = self._makeExplanationBlurbParameter
-- 1. page's protection action, page's protection level
+
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
-- 2. page's protection action, default protection level
+
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
-- 3. "edit" protection action, default protection level
+
parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
--
+
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
-- It is possible to use banner parameters inside this table.
+
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
-- *required* - this table needs edit, move, autoreview and upload subtables.
+
parameterFuncs.PROTECTIONDATE    = self._makeProtectionDateParameter
protectionLevels = {
+
parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
edit = {
+
parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
default = 'protected',
+
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
templateeditor = 'template-protected',
+
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
extendedconfirmed = 'extended-protected',
+
parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
autoconfirmed = 'semi-protected',
+
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
},
+
move = {
+
self._params = setmetatable({}, {
default = 'move-protected'
+
__index = function (t, k)
},
+
local param
autoreview = {
+
if parameterFuncs[k] then
},
+
param = parameterFuncs[k](self)
upload = {
+
end
default = 'upload-protected'
+
param = param or ''
}
+
t[k] = param
},
+
return param
 +
end
 +
})
 +
end
 +
 +
msg = msg:gsub('${(%u+)}', self._params)
 +
return msg
 +
end
  
----
+
function Blurb:_makeCurrentVersionParameter()
-- Images
+
-- 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
  
-- This table lists different padlock images for each protection action and
+
function Blurb:_makeEditRequestParameter()
-- protection level. It is used if an image is not specified in any of the
+
local mEditRequest = require('Module:Submit an edit request')
-- banner data tables, and if the page does not satisfy the conditions for using
+
local action = self._protectionObj.action
-- the ['image-filename-indef'] image. It is checked in the following order:
+
local level = self._protectionObj.level
-- 1. page's protection action, page's protection level
+
-- 2. page's protection action, default protection level
+
-- Get the edit request type.
images = {
+
local requestType
edit = {
+
if action == 'edit' then
default = 'Full-protection-shackle.svg',
+
if level == 'autoconfirmed' then
templateeditor = 'Template-protection-shackle.svg',
+
requestType = 'semi'
extendedconfirmed = 'Extended-protection-shackle.svg',
+
elseif level == 'extendedconfirmed' then
autoconfirmed = 'Semi-protection-shackle.svg'
+
requestType = 'extended'
},
+
elseif level == 'templateeditor' then
move = {
+
requestType = 'template'
default = 'Move-protection-shackle.svg',
+
end
},
+
end
autoreview = {
+
requestType = requestType or 'full'
default = 'Pending-protection-shackle.svg'
+
},
+
-- Get the display value.
upload = {
+
local display = self:_getExpandedMessage('edit-request-display')
default = 'Upload-protection-shackle.svg'
 
}
 
},
 
  
-- Pages with a reason specified in this table will show the special "indef"
+
return mEditRequest._link{type = requestType, display = display}
-- padlock, defined in the 'image-filename-indef' message, if no expiry is set.
+
end
indefImageReasons = {
 
template = true
 
},
 
  
----
+
function Blurb:_makeExpiryParameter()
-- Image links
+
local expiry = self._protectionObj.expiry
----
+
if type(expiry) == 'number' then
 +
return self:_formatDate(expiry)
 +
else
 +
return expiry
 +
end
 +
end
  
-- This table provides the data for the ${IMAGELINK} parameter, which gets
+
function Blurb:_makeExplanationBlurbParameter()
-- the image link for small padlock icons based on the page's protection action
+
-- Cover special cases first.
-- and protection level. It is checked in the following order:
+
if self._protectionObj.title.namespace == 8 then
-- 1. page's protection action, page's protection level
+
-- MediaWiki namespace
-- 2. page's protection action, default protection level
+
return self:_getExpandedMessage('explanation-blurb-nounprotect')
-- 3. "edit" protection action, default protection level
+
end
--
 
-- It is possible to use banner parameters inside this table.
 
-- *required* - this table needs edit, move, autoreview and upload subtables.
 
imageLinks = {
 
edit = {
 
default = 'Wikipedia:Protection policy#full',
 
templateeditor = 'Wikipedia:Protection policy#template',
 
extendedconfirmed = 'Wikipedia:Protection policy#extended',
 
autoconfirmed = 'Wikipedia:Protection policy#semi'
 
},
 
move = {
 
default = 'Wikipedia:Protection policy#move'
 
},
 
autoreview = {
 
default = 'Wikipedia:Protection policy#pending'
 
},
 
upload = {
 
default = 'Wikipedia:Protection policy#upload'
 
}
 
},
 
  
----
+
-- Get explanation blurb table keys
-- Padlock indicator names
+
local action = self._protectionObj.action
----
+
local level = self._protectionObj.level
 +
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
  
-- This table provides the "name" attribute for the <indicator> extension tag
+
-- Find the message in the explanation blurb table and substitute any
-- with which small padlock icons are generated. All indicator tags on a page
+
-- parameters.
-- are displayed in alphabetical order based on this attribute, and with
+
local explanations = self._cfg.explanationBlurbs
-- indicator tags with duplicate names, the last tag on the page wins.
+
local msg
-- The attribute is chosen based on the protection action; table keys must be a
+
if explanations[action][level] and explanations[action][level][talkKey] then
-- protection action name or the string "default".
+
msg = explanations[action][level][talkKey]
padlockIndicatorNames = {
+
elseif explanations[action][level] and explanations[action][level].default then
autoreview = 'pp-autoreview',
+
msg = explanations[action][level].default
default = 'pp-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()
-- Protection categories
+
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()
-- The protection categories are stored in the protectionCategories table.
+
if self._protectionObj:isTemporary() then
-- Keys to this table are made up of the following strings:
+
return self:_getExpandedMessage('intro-blurb-expiry')
--
+
else
-- 1. the expiry date
+
return self:_getExpandedMessage('intro-blurb-noexpiry')
-- 2. the namespace
+
end
-- 3. the protection reason (e.g. "dispute" or "vandalism")
+
end
-- 4. the protection level (e.g. "sysop" or "autoconfirmed")
 
-- 5. the action (e.g. "edit" or "move")
 
--
 
-- When the module looks up a category in the table, first it will will check to
 
-- see a key exists that corresponds to all five parameters. For example, a
 
-- user page semi-protected from vandalism for two weeks would have the key
 
-- "temp-user-vandalism-autoconfirmed-edit". If no match is found, the module
 
-- changes the first part of the key to "all" and checks the table again. It
 
-- keeps checking increasingly generic key combinations until it finds the
 
-- field, or until it reaches the key "all-all-all-all-all".
 
--
 
-- The module uses a binary matrix to determine the order in which to search.
 
-- This is best demonstrated by a table. In this table, the "0" values
 
-- represent "all", and the "1" values represent the original data (e.g.
 
-- "indef" or "file" or "vandalism").
 
--
 
--        expiry    namespace reason  level    action
 
-- order
 
-- 1      1        1        1        1        1
 
-- 2      0        1        1        1        1
 
-- 3      1        0        1        1        1
 
-- 4      0        0        1        1        1
 
-- 5      1        1        0        1        1
 
-- 6      0        1        0        1        1
 
-- 7      1        0        0        1        1
 
-- 8      0        0        0        1        1
 
-- 9      1        1        1        0        1
 
-- 10    0        1        1        0        1
 
-- 11    1        0        1        0        1
 
-- 12    0        0        1        0        1
 
-- 13    1        1        0        0        1
 
-- 14    0        1        0        0        1
 
-- 15    1        0        0        0        1
 
-- 16    0        0        0        0        1
 
-- 17    1        1        1        1        0
 
-- 18    0        1        1        1        0
 
-- 19    1        0        1        1        0
 
-- 20    0        0        1        1        0
 
-- 21    1        1        0        1        0
 
-- 22    0        1        0        1        0
 
-- 23    1        0        0        1        0
 
-- 24    0        0        0        1        0
 
-- 25    1        1        1        0        0
 
-- 26    0        1        1        0        0
 
-- 27    1        0        1        0        0
 
-- 28    0        0        1        0        0
 
-- 29    1        1        0        0        0
 
-- 30    0        1        0        0        0
 
-- 31    1        0        0        0        0
 
-- 32    0        0        0        0        0
 
--
 
-- In this scheme the action has the highest priority, as it is the last
 
-- to change, and the expiry has the least priority, as it changes the most.
 
-- The priorities of the expiry, the protection level and the action are
 
-- fixed, but the priorities of the reason and the namespace can be swapped
 
-- through the use of the cfg.bannerDataNamespaceHasPriority table.
 
--]]
 
  
-- If the reason specified to the template is listed in this table,
+
function Blurb:_makeIntroFragmentParameter()
-- namespace data will take priority over reason data in the protectionCategories
+
if self._protectionObj:isTemporary() then
-- table.
+
return self:_getExpandedMessage('intro-fragment-expiry')
reasonsWithNamespacePriority = {
+
else
vandalism = true,
+
return self:_getExpandedMessage('intro-fragment-noexpiry')
},
+
end
 +
end
  
-- The string to use as a namespace key for the protectionCategories table for each
+
function Blurb:_makePagetypeParameter()
-- namespace number.
+
local pagetypes = self._cfg.pagetypes
categoryNamespaceKeys = {
+
return pagetypes[self._protectionObj.title.namespace]
[  2] = 'user',
+
or pagetypes.default
[ 3] = 'user',
+
or error('no default pagetype defined', 8)
[  4] = 'project',
+
end
[  6] = 'file',
 
8] = 'mediawiki',
 
[ 10] = 'template',
 
[ 12] = 'project',
 
[ 14] = 'category',
 
[100] = 'portal',
 
[828] = 'module',
 
},
 
  
protectionCategories = {
+
function Blurb:_makeProtectionBlurbParameter()
['all|all|all|all|all']                  = 'Wikipedia fully protected pages',
+
local protectionBlurbs = self._cfg.protectionBlurbs
['all|all|office|all|all']              = 'Wikipedia Office-protected pages',
+
local action = self._protectionObj.action
['all|all|reset|all|all']                = 'Wikipedia Office-protected pages',
+
local level = self._protectionObj.level
['all|all|dmca|all|all']                = 'Wikipedia Office-protected pages',
+
local msg
['all|all|mainpage|all|all']            = 'Wikipedia fully-protected main page files',
+
if protectionBlurbs[action][level] then
['all|all|all|extendedconfirmed|all']    = 'Wikipedia pages under 30-500 editing restriction',
+
msg = protectionBlurbs[action][level]
['all|all|ecp|extendedconfirmed|all']    = 'Wikipedia pages under 30-500 editing restriction',
+
elseif protectionBlurbs[action].default then
['all|template|all|all|edit']            = 'Wikipedia fully protected templates',
+
msg = protectionBlurbs[action].default
['all|all|all|autoconfirmed|edit']      = 'Wikipedia semi-protected pages',
+
elseif protectionBlurbs.edit.default then
['indef|all|all|autoconfirmed|edit']    = 'Wikipedia indefinitely semi-protected pages',
+
msg = protectionBlurbs.edit.default
['all|all|blp|autoconfirmed|edit']      = 'Wikipedia indefinitely semi-protected biographies of living people',
+
else
['temp|all|blp|autoconfirmed|edit']      = 'Wikipedia temporarily semi-protected biographies of living people',
+
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
['all|all|dispute|autoconfirmed|edit']  = 'Wikipedia pages semi-protected due to dispute',
+
end
['all|all|sock|autoconfirmed|edit']      = 'Wikipedia pages semi-protected from banned users',
+
return self:_substituteParameters(msg)
['all|all|vandalism|autoconfirmed|edit'] = 'Wikipedia pages semi-protected against vandalism',
+
end
['all|category|all|autoconfirmed|edit']  = 'Wikipedia semi-protected categories',
 
['all|file|all|autoconfirmed|edit']      = 'Wikipedia semi-protected files',
 
['all|portal|all|autoconfirmed|edit']    = 'Wikipedia semi-protected portals',
 
['all|project|all|autoconfirmed|edit']  = 'Wikipedia semi-protected project pages',
 
['all|talk|all|autoconfirmed|edit']      = 'Wikipedia semi-protected talk pages',
 
['all|template|all|autoconfirmed|edit']  = 'Wikipedia semi-protected templates',
 
['all|user|all|autoconfirmed|edit']      = 'Wikipedia semi-protected user and user talk pages',
 
['all|template|all|templateeditor|edit'] = 'Wikipedia template-protected templates',
 
['all|all|blp|sysop|edit']              = 'Wikipedia indefinitely protected biographies of living people',
 
['temp|all|blp|sysop|edit']             = 'Wikipedia temporarily protected biographies of living people',
 
['all|all|dispute|sysop|edit']           = 'Wikipedia pages protected due to dispute',
 
['all|all|sock|sysop|edit']              = 'Wikipedia pages protected from banned users',
 
['all|all|vandalism|sysop|edit']         = 'Wikipedia pages protected against vandalism',
 
['all|category|all|sysop|edit']         = 'Wikipedia protected categories',
 
['all|file|all|sysop|edit']             = 'Wikipedia fully-protected files',
 
['all|project|all|sysop|edit']          = 'Wikipedia fully-protected project pages',
 
['all|talk|all|sysop|edit']             = 'Wikipedia fully-protected talk pages',
 
['all|template|all|sysop|edit']          = 'Wikipedia fully protected templates',
 
['all|user|all|sysop|edit']              = 'Wikipedia protected user and user talk pages',
 
['all|module|all|all|edit']              = 'Wikipedia fully-protected modules',
 
['all|module|all|templateeditor|edit']  = 'Wikipedia template-protected modules',
 
['all|module|all|autoconfirmed|edit']    = 'Wikipedia semi-protected modules',
 
['all|all|all|sysop|move']              = 'Wikipedia move-protected pages',
 
['indef|all|all|sysop|move']            = 'Wikipedia indefinitely move-protected pages',
 
['all|all|dispute|sysop|move']          = 'Wikipedia pages move-protected due to dispute',
 
['all|all|vandalism|sysop|move']        = 'Wikipedia pages move-protected due to vandalism',
 
['all|portal|all|sysop|move']            = 'Wikipedia move-protected portals',
 
['all|portal|all|sysop|move']            = 'Wikipedia move-protected portals',
 
['all|project|all|sysop|move']          = 'Wikipedia move-protected project pages',
 
['all|talk|all|sysop|move']              = 'Wikipedia move-protected talk pages',
 
['all|template|all|sysop|move']          = 'Wikipedia move-protected templates',
 
['all|user|all|sysop|move']              = 'Wikipedia move-protected user and user talk pages',
 
['all|all|all|autoconfirmed|autoreview'] = 'Wikipedia pending changes protected pages',
 
['all|file|all|all|upload']              = 'Wikipedia upload-protected files',
 
},
 
  
----
+
function Blurb:_makeProtectionDateParameter()
-- Expiry category config
+
local protectionDate = self._protectionObj.protectionDate
----
+
if type(protectionDate) == 'number' then
 +
return self:_formatDate(protectionDate)
 +
else
 +
return protectionDate
 +
end
 +
end
  
-- This table configures the expiry category behaviour for each protection
+
function Blurb:_makeProtectionLevelParameter()
-- action.
+
local protectionLevels = self._cfg.protectionLevels
-- * If set to true, setting that action will always categorise the page if
+
local action = self._protectionObj.action
--  an expiry parameter is not set.
+
local level = self._protectionObj.level
-- * If set to false, setting that action will never categorise the page.
+
local msg
-- * If set to nil, the module will categorise the page if:
+
if protectionLevels[action][level] then
--  1) an expiry parameter is not set, and
+
msg = protectionLevels[action][level]
--  2) a reason is provided, and
+
elseif protectionLevels[action].default then
--  3) the specified reason is not blacklisted in the reasonsWithoutExpiryCheck
+
msg = protectionLevels[action].default
--      table.
+
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
  
expiryCheckActions = {
+
function Blurb:_makeProtectionLogParameter()
edit = nil,
+
local pagename = self._protectionObj.title.prefixedText
move = false,
+
if self._protectionObj.action == 'autoreview' then
autoreview = true,
+
-- We need the pending changes log.
upload = false
+
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
  
reasonsWithoutExpiryCheck = {
+
function Blurb:_makeTalkPageParameter()
blp = true,
+
return string.format(
template = true,
+
'[[%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()
-- Pagetypes
+
if self._protectionObj:isTemporary() then
----
+
return self:_getExpandedMessage('tooltip-blurb-expiry')
 +
else
 +
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
 +
end
 +
end
  
-- This table produces the page types available with the ${PAGETYPE} parameter.
+
function Blurb:_makeTooltipFragmentParameter()
-- Keys are namespace numbers, or the string "default" for the default value.
+
if self._protectionObj:isTemporary() then
pagetypes = {
+
return self:_getExpandedMessage('tooltip-fragment-expiry')
[0] = 'article',
+
else
[6] = 'file',
+
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
[10] = 'template',
+
end
[14] = 'category',
+
end
[828] = 'module',
 
default = 'page'
 
},
 
  
----
+
function Blurb:_makeVandalTemplateParameter()
-- Strings marking indefinite protection
+
return require('Module:Vandal-m')._main{
----
+
self._args.user or self._protectionObj.title.baseText
 +
}
 +
end
  
-- This table contains values passed to the expiry parameter that mean the page
+
-- Public methods --
-- is protected indefinitely.
 
indefStrings = {
 
['indef'] = true,
 
['indefinite'] = true,
 
['indefinitely'] = true,
 
['infinite'] = true,
 
},
 
  
----
+
function Blurb:makeBannerText(key)
-- Group hierarchy
+
-- 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
  
-- This table maps each group to all groups that have a superset of the original
+
-- Generate the text.
-- group's page editing permissions.
+
local msg = self._protectionObj.bannerConfig[key]
hierarchy = {
+
if type(msg) == 'string' then
sysop = {},
+
return self:_substituteParameters(msg)
reviewer = {'sysop'},
+
elseif type(msg) == 'function' then
filemover = {'sysop'},
+
msg = msg(self._protectionObj, self._args)
templateeditor = {'sysop'},
+
if type(msg) ~= 'string' then
extendedconfirmed = {'sysop'},
+
error(string.format(
autoconfirmed = {'reviewer', 'filemover', 'templateeditor', 'extendedconfirmed'},
+
'bad output from banner config function with key "%s"'
user = {'autoconfirmed'},
+
.. ' (expected string, got %s)',
['*'] = {'user'}
+
tostring(key),
},
+
type(msg)
 +
), 4)
 +
end
 +
return self:_substituteParameters(msg)
 +
end
 +
end
  
----
+
--------------------------------------------------------------------------------
-- Wrapper templates and their default arguments
+
-- BannerTemplate class
----
+
--------------------------------------------------------------------------------
  
-- This table contains wrapper templates used with the module, and their
+
local BannerTemplate = {}
-- default arguments. Templates specified in this table should contain the
+
BannerTemplate.__index = BannerTemplate
-- following invocation, and no other template content:
 
--
 
-- {{#invoke:Protection banner|main}}
 
--
 
-- If other content is desired, it can be added between
 
-- <noinclude>...</noinclude> tags.
 
--
 
-- When a user calls one of these wrapper templates, they will use the
 
-- default arguments automatically. However, users can override any of the
 
-- arguments.
 
wrappers = {
 
['Template:Pp']                        = {},
 
['Template:Pp-30-500']                  = {'ecp'},
 
['Template:Pp-blp']                    = {'blp'},
 
-- we don't need Template:Pp-create
 
['Template:Pp-dispute']                = {'dispute'},
 
['Template:Pp-main-page']              = {'mainpage'},
 
['Template:Pp-move']                    = {action = 'move'},
 
['Template:Pp-move-dispute']            = {'dispute', action = 'move'},
 
-- we don't need Template:Pp-move-indef
 
['Template:Pp-move-vandalism']          = {'vandalism', action = 'move'},
 
['Template:Pp-office']                  = {'office'},
 
['Template:Pp-office-dmca']            = {'dmca'},
 
['Template:Pp-pc']                      = {action = 'autoreview', small = true},
 
['Template:Pp-pc1']                    = {action = 'autoreview', small = true},
 
['Template:Pp-reset']                  = {'reset'},
 
['Template:Pp-semi-indef']              = {small = true},
 
['Template:Pp-sock']                    = {'sock'},
 
['Template:Pp-template']                = {'template', small = true},
 
['Template:Pp-upload']                  = {action = 'upload'},
 
['Template:Pp-usertalk']                = {'usertalk'},
 
['Template:Pp-vandalism']              = {'vandalism'},
 
},
 
  
----
+
function BannerTemplate.new(protectionObj, cfg)
--
+
local obj = {}
--                                MESSAGES
+
obj._cfg = cfg
--
 
----
 
  
msg = {
+
-- 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()
-- Intro blurb and intro fragment
+
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
  
-- These messages specify what is produced by the ${INTROBLURB} and
+
--------------------------------------------------------------------------------
-- ${INTROFRAGMENT} parameters. If the protection is temporary they use the
+
-- Banner class
-- intro-blurb-expiry or intro-fragment-expiry, and if not they use
+
--------------------------------------------------------------------------------
-- intro-blurb-noexpiry or intro-fragment-noexpiry.
 
-- It is possible to use banner parameters in these messages.
 
['intro-blurb-expiry'] = '${PROTECTIONBLURB} until ${EXPIRY}.',
 
['intro-blurb-noexpiry'] = '${PROTECTIONBLURB}.',
 
['intro-fragment-expiry'] = '${PROTECTIONBLURB} until ${EXPIRY},',
 
['intro-fragment-noexpiry'] = '${PROTECTIONBLURB}',
 
  
----
+
local Banner = setmetatable({}, BannerTemplate)
-- Tooltip blurb
+
Banner.__index = Banner
----
 
  
-- These messages specify what is produced by the ${TOOLTIPBLURB} parameter.
+
function Banner.new(protectionObj, blurbObj, cfg)
-- If the protection is temporary the tooltip-blurb-expiry message is used, and
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
-- if not the tooltip-blurb-noexpiry message is used.
+
obj.imageWidth = 40
-- It is possible to use banner parameters in these messages.
+
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
['tooltip-blurb-expiry'] = 'This ${PAGETYPE} is ${PROTECTIONLEVEL} until ${EXPIRY}.',
+
obj._reasonText = blurbObj:makeBannerText('text')
['tooltip-blurb-noexpiry'] = 'This ${PAGETYPE} is ${PROTECTIONLEVEL}.',
+
obj._explanationText = blurbObj:makeBannerText('explanation')
['tooltip-fragment-expiry'] = 'This ${PAGETYPE} is ${PROTECTIONLEVEL} until ${EXPIRY},',
+
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
['tooltip-fragment-noexpiry'] = 'This ${PAGETYPE} is ${PROTECTIONLEVEL}',
+
return setmetatable(obj, Banner)
 +
end
  
----
+
function Banner:__tostring()
-- Special explanation blurb
+
-- 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
  
-- An explanation blurb for pages that cannot be unprotected, e.g. for pages
+
--------------------------------------------------------------------------------
-- in the MediaWiki namespace.
+
-- Padlock class
-- It is possible to use banner parameters in this message.
+
--------------------------------------------------------------------------------
['explanation-blurb-nounprotect'] = 'See the [[Wikipedia:Protection policy|'
 
.. 'protection policy]] and ${PROTECTIONLOG} for more details.'
 
.. ' Please discuss any changes on the ${TALKPAGE}; you'
 
.. ' may ${EDITREQUEST} to ask an'
 
.. ' [[Wikipedia:Administrators|administrator]] to make an edit if it'
 
.. ' is [[Help:Minor edit#When to mark an edit as a minor edit'
 
.. '|uncontroversial]] or supported by [[Wikipedia:Consensus'
 
.. '|consensus]].',
 
  
----
+
local Padlock = setmetatable({}, BannerTemplate)
-- Protection log display values
+
Padlock.__index = Padlock
----
 
  
-- These messages determine the display values for the protection log link
+
function Padlock.new(protectionObj, blurbObj, cfg)
-- or the pending changes log link produced by the ${PROTECTIONLOG} parameter.
+
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
-- It is possible to use banner parameters in these messages.
+
obj.imageWidth = 20
['protection-log-display'] = 'protection log',
+
obj.imageCaption = blurbObj:makeBannerText('tooltip')
['pc-log-display'] = 'pending changes log',
+
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()
-- Current version display values
+
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
  
-- These messages determine the display values for the page history link
+
--------------------------------------------------------------------------------
-- or the move log link produced by the ${CURRENTVERSION} parameter.
+
-- Exports
-- It is possible to use banner parameters in these messages.
+
--------------------------------------------------------------------------------
['current-version-move-display'] = 'current title',
 
['current-version-edit-display'] = 'current version',
 
  
----
+
local p = {}
-- Talk page
 
----
 
  
-- This message determines the display value of the talk page link produced
+
function p._exportClasses()
-- with the ${TALKPAGE} parameter.
+
-- This is used for testing purposes.
-- It is possible to use banner parameters in this message.
+
return {
['talk-page-link-display'] = 'talk page',
+
Protection = Protection,
 +
Blurb = Blurb,
 +
BannerTemplate = BannerTemplate,
 +
Banner = Banner,
 +
Padlock = Padlock,
 +
}
 +
end
  
----
+
function p._main(args, cfg, title)
-- Edit requests
+
args = args or {}
----
+
cfg = cfg or require(CONFIG_MODULE)
  
-- This message determines the display value of the edit request link produced
+
local protectionObj = Protection.new(args, cfg, title)
-- with the ${EDITREQUEST} parameter.
 
-- It is possible to use banner parameters in this message.
 
['edit-request-display'] = 'submit an edit request',
 
  
----
+
local ret = {}
-- Expiry date format
 
----
 
  
-- This is the format for the blurb expiry date. It should be valid input for
+
-- If a page's edit protection is equally or more restrictive than its
-- the first parameter of the #time parser function.
+
-- protection from some other action, then don't bother displaying anything
['expiry-date-format'] = 'F j, Y "at" g:i a e',
+
-- for the other action (except categories).
 +
if protectionObj.action == 'edit' or
 +
args.demolevel or
 +
not getReachableNodes(
 +
cfg.hierarchy,
 +
protectionObj.level
 +
)[effectiveProtectionLevel('edit', protectionObj.title)]
 +
then
 +
-- Initialise the blurb object
 +
local blurbObj = Blurb.new(protectionObj, args, cfg)
 +
 +
-- Render the banner
 +
if protectionObj:isProtected() then
 +
ret[#ret + 1] = tostring(
 +
(yesno(args.small) and Padlock or Banner)
 +
.new(protectionObj, blurbObj, cfg)
 +
)
 +
end
 +
end
  
----
+
-- Render the categories
-- Tracking categories
+
if yesno(args.category) ~= false then
----
+
ret[#ret + 1] = protectionObj:makeCategoryLinks()
 +
end
 +
 +
return table.concat(ret)
 +
end
  
-- These messages determine which tracking categories the module outputs.
+
function p.main(frame, cfg)
['tracking-category-incorrect'] = 'Wikipedia pages with incorrect protection templates',
+
cfg = cfg or require(CONFIG_MODULE)
['tracking-category-template'] = 'Wikipedia template-protected pages other than templates and modules',
 
  
----
+
-- Find default args, if any.
-- Images
+
local parent = frame.getParent and frame:getParent()
----
+
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]
  
-- These are images that are not defined by their protection action and protection level.
+
-- Find user args, and use the parent frame if we are being called from a
['image-filename-indef'] = 'Full-protection-shackle.svg',
+
-- wrapper template.
['image-filename-default'] = 'Transparent.gif',
+
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.
-- End messages
+
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
-- End configuration
 
----
 
}
 

Revision as of 14:05, 29 September 2016

Documentation for this module may be created at Module:Protection banner/sandbox/doc

-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.

-- Initialise necessary modules.
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')

-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang

-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config/sandbox' -- SWITCH THIS BACK TO THE MAIN CONFIG PAGE BEFORE GOING LIVE!

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function makeCategoryLink(cat, sort)
	if cat then
		return string.format(
			'[[%s:%s|%s]]',
			mw.site.namespaces[14].name,
			cat,
			sort
		)
	end
end

-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
	if not lang then
		lang = mw.language.getContentLanguage()
	end
	local success, result = pcall(lang.formatDate, lang, 'U', dateString)
	if success then
		result = tonumber(result)
		if result then
			return result
		end
	end
	error(string.format(
		'invalid %s: %s',
		dateType,
		tostring(dateString)
	), 4)
end

local function makeFullUrl(page, query, display)
	return string.format(
		'[%s %s]',
		tostring(mw.uri.fullUrl(page, query)),
		display
	)
end

-- Given a directed graph formatted as node -> table of direct successors,
-- get a table of all nodes reachable from a given node (though always
-- including the given node).
local function getReachableNodes(graph, start)
	local toWalk, retval = {[start] = true}, {}
	while true do
		-- Can't use pairs() since we're adding and removing things as we're iterating
		local k = next(toWalk) -- This always gets the "first" key
		if k == nil then
			return retval
		end
		toWalk[k] = nil
		retval[k] = true
		for _,v in ipairs(graph[k]) do
			if not retval[v] then
				toWalk[v] = true
			end
		end
	end
end

--------------------------------------------------------------------------------
-- Protection class
--------------------------------------------------------------------------------

local Protection = {}
Protection.__index = Protection

Protection.supportedActions = {
	edit = true,
	move = true,
	autoreview = true,
	upload = true
}

Protection.bannerConfigFields = {
	'text',
	'explanation',
	'tooltip',
	'alt',
	'link',
	'image'
}

function Protection.new(args, cfg, title)
	local obj = {}
	obj._cfg = cfg
	obj.title = title or mw.title.getCurrentTitle()

	-- Set action
	if not args.action then
		obj.action = 'edit'
	elseif Protection.supportedActions[args.action] then
		obj.action = args.action
	else
		error(string.format(
			'invalid action: %s',
			tostring(args.action)
		), 3)
	end

	-- Set level
	obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
	if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
		-- Users need to be autoconfirmed to move pages anyway, so treat
		-- semi-move-protected pages as unprotected.
		obj.level = '*'
	end

	-- Set expiry
	local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
	if effectiveExpiry == 'infinity' then
		obj.expiry = 'indef'
	elseif effectiveExpiry ~= 'unknown' then
		obj.expiry = validateDate(effectiveExpiry, 'expiry date')
	end

	-- Set reason
	if args[1] then
		obj.reason = mw.ustring.lower(args[1])
		if obj.reason:find('|') then
			error('reasons cannot contain the pipe character ("|")', 3)
		end
	end

	-- Set protection date
	if args.date then
		obj.protectionDate = validateDate(args.date, 'protection date')
	end
	
	-- Set banner config
	do
		obj.bannerConfig = {}
		local configTables = {}
		if cfg.banners[obj.action] then
			configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
		end
		if cfg.defaultBanners[obj.action] then
			configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
			configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
		end
		configTables[#configTables + 1] = cfg.masterBanner
		for i, field in ipairs(Protection.bannerConfigFields) do
			for j, t in ipairs(configTables) do
				if t[field] then
					obj.bannerConfig[field] = t[field]
					break
				end
			end
		end
	end
	return setmetatable(obj, Protection)
end

function Protection:isProtected()
	return self.level ~= '*'
end

function Protection:isTemporary()
	return type(self.expiry) == 'number'
end

function Protection:makeProtectionCategory()
	local cfg = self._cfg
	local title = self.title
	
	-- Exit if the page is not protected.
	if not self:isProtected() then
		return ''
	end
	
	-- Get the expiry key fragment.
	local expiryFragment
	if self.expiry == 'indef' then
		expiryFragment = self.expiry
	elseif type(self.expiry) == 'number' then
		expiryFragment = 'temp'
	end

	-- Get the namespace key fragment.
	local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
	if not namespaceFragment and title.namespace % 2 == 1 then
			namespaceFragment = 'talk'
	end
 
	-- Define the order that key fragments are tested in. This is done with an
	-- array of tables containing the value to be tested, along with its
	-- position in the cfg.protectionCategories table.
	local order = {
		{val = expiryFragment,    keypos = 1},
		{val = namespaceFragment, keypos = 2},
		{val = self.reason,       keypos = 3},
		{val = self.level,        keypos = 4},
		{val = self.action,       keypos = 5}
	}

	--[[
	-- The old protection templates used an ad-hoc protection category system,
	-- with some templates prioritising namespaces in their categories, and
	-- others prioritising the protection reason. To emulate this in this module
	-- we use the config table cfg.reasonsWithNamespacePriority to set the
	-- reasons for which namespaces have priority over protection reason.
	-- If we are dealing with one of those reasons, move the namespace table to
	-- the end of the order table, i.e. give it highest priority. If not, the
	-- reason should have highest priority, so move that to the end of the table
	-- instead.
	--]]
	table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
 
	--[[
	-- Define the attempt order. Inactive subtables (subtables with nil "value"
	-- fields) are moved to the end, where they will later be given the key
	-- "all". This is to cut down on the number of table lookups in
	-- cfg.protectionCategories, which grows exponentially with the number of
	-- non-nil keys. We keep track of the number of active subtables with the
	-- noActive parameter.
	--]]
	local noActive, attemptOrder
	do
		local active, inactive = {}, {}
		for i, t in ipairs(order) do
			if t.val then
				active[#active + 1] = t
			else
				inactive[#inactive + 1] = t
			end
		end
		noActive = #active
		attemptOrder = active
		for i, t in ipairs(inactive) do
			attemptOrder[#attemptOrder + 1] = t
		end
	end
 
	--[[
	-- Check increasingly generic key combinations until we find a match. If a
	-- specific category exists for the combination of key fragments we are
	-- given, that match will be found first. If not, we keep trying different
	-- key fragment combinations until we match using the key
	-- "all-all-all-all-all".
	--
	-- To generate the keys, we index the key subtables using a binary matrix
	-- with indexes i and j. j is only calculated up to the number of active
	-- subtables. For example, if there were three active subtables, the matrix
	-- would look like this, with 0 corresponding to the key fragment "all", and
	-- 1 corresponding to other key fragments.
	-- 
	--   j 1  2  3
	-- i  
	-- 1   1  1  1
	-- 2   0  1  1
	-- 3   1  0  1
	-- 4   0  0  1
	-- 5   1  1  0
	-- 6   0  1  0
	-- 7   1  0  0
	-- 8   0  0  0
	-- 
	-- Values of j higher than the number of active subtables are set
	-- to the string "all".
	--
	-- A key for cfg.protectionCategories is constructed for each value of i.
	-- The position of the value in the key is determined by the keypos field in
	-- each subtable.
	--]]
	local cats = cfg.protectionCategories
	for i = 1, 2^noActive do
		local key = {}
		for j, t in ipairs(attemptOrder) do
			if j > noActive then
				key[t.keypos] = 'all'
			else
				local quotient = i / 2 ^ (j - 1)
				quotient = math.ceil(quotient)
				if quotient % 2 == 1 then
					key[t.keypos] = t.val
				else
					key[t.keypos] = 'all'
				end
			end
		end
		key = table.concat(key, '|')
		local attempt = cats[key]
		if attempt then
			return makeCategoryLink(attempt, title.text)
		end
	end
	return ''
end

function Protection:isIncorrect()
	local expiry = self.expiry
	return not self:isProtected()
		or type(expiry) == 'number' and expiry < os.time()
end

function Protection:isTemplateProtectedNonTemplate()
	local action, namespace = self.action, self.title.namespace
	return self.level == 'templateeditor'
		and (
			(action ~= 'edit' and action ~= 'move')
			or (namespace ~= 10 and namespace ~= 828)
		)
end

function Protection:makeCategoryLinks()
	local msg = self._cfg.msg
	local ret = { self:makeProtectionCategory() }
	if self:isIncorrect() then
		ret[#ret + 1] = makeCategoryLink(
			msg['tracking-category-incorrect'],
			self.title.text
		)
	end
	if self:isTemplateProtectedNonTemplate() then
		ret[#ret + 1] = makeCategoryLink(
			msg['tracking-category-template'],
			self.title.text
		)
	end
	return table.concat(ret)
end

--------------------------------------------------------------------------------
-- Blurb class
--------------------------------------------------------------------------------

local Blurb = {}
Blurb.__index = Blurb

Blurb.bannerTextFields = {
	text = true,
	explanation = true,
	tooltip = true,
	alt = true,
	link = true
}

function Blurb.new(protectionObj, args, cfg)
	return setmetatable({
		_cfg = cfg,
		_protectionObj = protectionObj,
		_args = args
	}, Blurb)
end

-- Private methods --

function Blurb:_formatDate(num)
	-- Formats a Unix timestamp into dd Month, YYYY format.
	lang = lang or mw.language.getContentLanguage()
	local success, date = pcall(
		lang.formatDate,
		lang,
		self._cfg.msg['expiry-date-format'] or 'j F Y',
		'@' .. tostring(num)
	)
	if success then
		return date
	end
end

function Blurb:_getExpandedMessage(msgKey)
	return self:_substituteParameters(self._cfg.msg[msgKey])
end

function Blurb:_substituteParameters(msg)
	if not self._params then
		local parameterFuncs = {}

		parameterFuncs.CURRENTVERSION     = self._makeCurrentVersionParameter
		parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
		parameterFuncs.EXPIRY             = self._makeExpiryParameter
		parameterFuncs.EXPLANATIONBLURB   = self._makeExplanationBlurbParameter
		parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
		parameterFuncs.INTROBLURB         = self._makeIntroBlurbParameter
		parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
		parameterFuncs.PAGETYPE           = self._makePagetypeParameter
		parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
		parameterFuncs.PROTECTIONDATE     = self._makeProtectionDateParameter
		parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
		parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
		parameterFuncs.TALKPAGE           = self._makeTalkPageParameter
		parameterFuncs.TOOLTIPBLURB       = self._makeTooltipBlurbParameter
		parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
		parameterFuncs.VANDAL             = self._makeVandalTemplateParameter
		
		self._params = setmetatable({}, {
			__index = function (t, k)
				local param
				if parameterFuncs[k] then
					param = parameterFuncs[k](self)
				end
				param = param or ''
				t[k] = param
				return param
			end
		})
	end
	
	msg = msg:gsub('${(%u+)}', self._params)
	return msg
end

function Blurb:_makeCurrentVersionParameter()
	-- A link to the page history or the move log, depending on the kind of
	-- protection.
	local pagename = self._protectionObj.title.prefixedText
	if self._protectionObj.action == 'move' then
		-- We need the move log link.
		return makeFullUrl(
			'Special:Log',
			{type = 'move', page = pagename},
			self:_getExpandedMessage('current-version-move-display')
		)
	else
		-- We need the history link.
		return makeFullUrl(
			pagename,
			{action = 'history'},
			self:_getExpandedMessage('current-version-edit-display')
		)
	end
end

function Blurb:_makeEditRequestParameter()
	local mEditRequest = require('Module:Submit an edit request')
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	
	-- Get the edit request type.
	local requestType
	if action == 'edit' then
		if level == 'autoconfirmed' then
			requestType = 'semi'
		elseif level == 'extendedconfirmed' then
			requestType = 'extended'
		elseif level == 'templateeditor' then
			requestType = 'template'
		end
	end
	requestType = requestType or 'full'
	
	-- Get the display value.
	local display = self:_getExpandedMessage('edit-request-display')

	return mEditRequest._link{type = requestType, display = display}
end

function Blurb:_makeExpiryParameter()
	local expiry = self._protectionObj.expiry
	if type(expiry) == 'number' then
		return self:_formatDate(expiry)
	else
		return expiry
	end
end

function Blurb:_makeExplanationBlurbParameter()
	-- Cover special cases first.
	if self._protectionObj.title.namespace == 8 then
		-- MediaWiki namespace
		return self:_getExpandedMessage('explanation-blurb-nounprotect')
	end

	-- Get explanation blurb table keys
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'

	-- Find the message in the explanation blurb table and substitute any
	-- parameters.
	local explanations = self._cfg.explanationBlurbs
	local msg
	if explanations[action][level] and explanations[action][level][talkKey] then
		msg = explanations[action][level][talkKey]
	elseif explanations[action][level] and explanations[action][level].default then
		msg = explanations[action][level].default
	elseif explanations[action].default and explanations[action].default[talkKey] then
		msg = explanations[action].default[talkKey]
	elseif explanations[action].default and explanations[action].default.default then
		msg = explanations[action].default.default
	else
		error(string.format(
			'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
			action,
			level,
			talkKey
		), 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeImageLinkParameter()
	local imageLinks = self._cfg.imageLinks
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if imageLinks[action][level] then
		msg = imageLinks[action][level]
	elseif imageLinks[action].default then
		msg = imageLinks[action].default
	else
		msg = imageLinks.edit.default
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeIntroBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-blurb-expiry')
	else
		return self:_getExpandedMessage('intro-blurb-noexpiry')
	end
end

function Blurb:_makeIntroFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-fragment-expiry')
	else
		return self:_getExpandedMessage('intro-fragment-noexpiry')
	end
end

function Blurb:_makePagetypeParameter()
	local pagetypes = self._cfg.pagetypes
	return pagetypes[self._protectionObj.title.namespace]
		or pagetypes.default
		or error('no default pagetype defined', 8)
end

function Blurb:_makeProtectionBlurbParameter()
	local protectionBlurbs = self._cfg.protectionBlurbs
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if protectionBlurbs[action][level] then
		msg = protectionBlurbs[action][level]
	elseif protectionBlurbs[action].default then
		msg = protectionBlurbs[action].default
	elseif protectionBlurbs.edit.default then
		msg = protectionBlurbs.edit.default
	else
		error('no protection blurb defined for protectionBlurbs.edit.default', 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionDateParameter()
	local protectionDate = self._protectionObj.protectionDate
	if type(protectionDate) == 'number' then
		return self:_formatDate(protectionDate)
	else
		return protectionDate
	end
end

function Blurb:_makeProtectionLevelParameter()
	local protectionLevels = self._cfg.protectionLevels
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	local msg
	if protectionLevels[action][level] then
		msg = protectionLevels[action][level]
	elseif protectionLevels[action].default then
		msg = protectionLevels[action].default
	elseif protectionLevels.edit.default then
		msg = protectionLevels.edit.default
	else
		error('no protection level defined for protectionLevels.edit.default', 8)
	end
	return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionLogParameter()
	local pagename = self._protectionObj.title.prefixedText
	if self._protectionObj.action == 'autoreview' then
		-- We need the pending changes log.
		return makeFullUrl(
			'Special:Log',
			{type = 'stable', page = pagename},
			self:_getExpandedMessage('pc-log-display')
		)
	else
		-- We need the protection log.
		return makeFullUrl(
			'Special:Log',
			{type = 'protect', page = pagename},
			self:_getExpandedMessage('protection-log-display')
		)
	end
end

function Blurb:_makeTalkPageParameter()
	return string.format(
		'[[%s:%s#%s|%s]]',
		mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
		self._protectionObj.title.text,
		self._args.section or 'top',
		self:_getExpandedMessage('talk-page-link-display')
	)
end

function Blurb:_makeTooltipBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-blurb-expiry')
	else
		return self:_getExpandedMessage('tooltip-blurb-noexpiry')
	end
end

function Blurb:_makeTooltipFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-fragment-expiry')
	else
		return self:_getExpandedMessage('tooltip-fragment-noexpiry')
	end
end

function Blurb:_makeVandalTemplateParameter()
	return require('Module:Vandal-m')._main{
		self._args.user or self._protectionObj.title.baseText
	}
end

-- Public methods --

function Blurb:makeBannerText(key)
	-- Validate input.
	if not key or not Blurb.bannerTextFields[key] then
		error(string.format(
			'"%s" is not a valid banner config field',
			tostring(key)
		), 2)
	end

	-- Generate the text.
	local msg = self._protectionObj.bannerConfig[key]
	if type(msg) == 'string' then
		return self:_substituteParameters(msg)
	elseif type(msg) == 'function' then
		msg = msg(self._protectionObj, self._args)
		if type(msg) ~= 'string' then
			error(string.format(
				'bad output from banner config function with key "%s"'
					.. ' (expected string, got %s)',
				tostring(key),
				type(msg)
			), 4)
		end
		return self:_substituteParameters(msg)
	end
end

--------------------------------------------------------------------------------
-- BannerTemplate class
--------------------------------------------------------------------------------

local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate

function BannerTemplate.new(protectionObj, cfg)
	local obj = {}
	obj._cfg = cfg

	-- Set the image filename.
	local imageFilename = protectionObj.bannerConfig.image
	if imageFilename then
		obj._imageFilename = imageFilename
	else
		-- If an image filename isn't specified explicitly in the banner config,
		-- generate it from the protection status and the namespace.
		local action = protectionObj.action
		local level = protectionObj.level
		local namespace = protectionObj.title.namespace
		local reason = protectionObj.reason
		
		-- Deal with special cases first.
		if (
			namespace == 10
			or namespace == 828
			or reason and obj._cfg.indefImageReasons[reason]
			)
			and action == 'edit'
			and level == 'sysop'
			and not protectionObj:isTemporary()
		then
			-- Fully protected modules and templates get the special red "indef"
			-- padlock.
			obj._imageFilename = obj._cfg.msg['image-filename-indef']
		else
			-- Deal with regular protection types.
			local images = obj._cfg.images
			if images[action] then
				if images[action][level] then
					obj._imageFilename = images[action][level]
				elseif images[action].default then
					obj._imageFilename = images[action].default
				end
			end
		end
	end
	return setmetatable(obj, BannerTemplate)
end

function BannerTemplate:renderImage()
	local filename = self._imageFilename
		or self._cfg.msg['image-filename-default']
		or 'Transparent.gif'
	return makeFileLink{
		file = filename,
		size = (self.imageWidth or 20) .. 'px',
		alt = self._imageAlt,
		link = self._imageLink,
		caption = self.imageCaption
	}
end

--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------

local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner

function Banner.new(protectionObj, blurbObj, cfg)
	local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
	obj.imageWidth = 40
	obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
	obj._reasonText = blurbObj:makeBannerText('text')
	obj._explanationText = blurbObj:makeBannerText('explanation')
	obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
	return setmetatable(obj, Banner)
end

function Banner:__tostring()
	-- Renders the banner.
	makeMessageBox = makeMessageBox or require('Module:Message box').main
	local reasonText = self._reasonText or error('no reason text set', 2)
	local explanationText = self._explanationText
	local mbargs = {
		page = self._page,
		type = 'protection',
		image = self:renderImage(),
		text = string.format(
			"'''%s'''%s",
			reasonText,
			explanationText and '<br />' .. explanationText or ''
		)
	}
	return makeMessageBox('mbox', mbargs)
end

--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------

local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock

function Padlock.new(protectionObj, blurbObj, cfg)
	local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
	obj.imageWidth = 20
	obj.imageCaption = blurbObj:makeBannerText('tooltip')
	obj._imageAlt = blurbObj:makeBannerText('alt')
	obj._imageLink = blurbObj:makeBannerText('link')
	obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
		or cfg.padlockIndicatorNames.default
		or 'pp-default'
	return setmetatable(obj, Padlock)
end

function Padlock:__tostring()
	local frame = mw.getCurrentFrame()
	-- The nowiki tag helps prevent whitespace at the top of articles.
	return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
		name = 'indicator',
		args = {name = self._indicatorName},
		content = self:renderImage()
	}
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p = {}

function p._exportClasses()
	-- This is used for testing purposes.
	return {
		Protection = Protection,
		Blurb = Blurb,
		BannerTemplate = BannerTemplate,
		Banner = Banner,
		Padlock = Padlock,
	}
end

function p._main(args, cfg, title)
	args = args or {}
	cfg = cfg or require(CONFIG_MODULE)

	local protectionObj = Protection.new(args, cfg, title)

	local ret = {}

	-- If a page's edit protection is equally or more restrictive than its
	-- protection from some other action, then don't bother displaying anything
	-- for the other action (except categories).
	if protectionObj.action == 'edit' or
		args.demolevel or
		not getReachableNodes(
			cfg.hierarchy,
			protectionObj.level
		)[effectiveProtectionLevel('edit', protectionObj.title)]
	then
		-- Initialise the blurb object
		local blurbObj = Blurb.new(protectionObj, args, cfg)
	
		-- Render the banner
		if protectionObj:isProtected() then
			ret[#ret + 1] = tostring(
				(yesno(args.small) and Padlock or Banner)
				.new(protectionObj, blurbObj, cfg)
			)
		end
	end

	-- Render the categories
	if yesno(args.category) ~= false then
		ret[#ret + 1] = protectionObj:makeCategoryLinks()
	end
	
	return table.concat(ret)	
end

function p.main(frame, cfg)
	cfg = cfg or require(CONFIG_MODULE)

	-- Find default args, if any.
	local parent = frame.getParent and frame:getParent()
	local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]

	-- Find user args, and use the parent frame if we are being called from a
	-- wrapper template.
	getArgs = getArgs or require('Module:Arguments').getArgs
	local userArgs = getArgs(frame, {
		parentOnly = defaultArgs,
		frameOnly = not defaultArgs
	})

	-- Build the args table. User-specified args overwrite default args.
	local args = {}
	for k, v in pairs(defaultArgs or {}) do
		args[k] = v
	end
	for k, v in pairs(userArgs) do
		args[k] = v
	end
	return p._main(args, cfg)
end

return p