Difference between revisions of "Module:Protection banner"

From Amanita Research
Jump to navigation Jump to search
(fix logic for reasonBehavior == 'all' and fix the office protection category key)
(tidy this up and comment it so it will be easier for others to understand)
Line 3: Line 3:
  
 
local categories = {
 
local categories = {
 +
-- The key strings follow this format:
 +
-- type, level, ns, reason, expiry
 
['edit-autoconfirmed-user-all-all'] = 'Wikipedia semi-protected user and user talk pages',
 
['edit-autoconfirmed-user-all-all'] = 'Wikipedia semi-protected user and user talk pages',
 
['edit-autoconfirmed-project-all-all'] = 'Semi-protected project pages',
 
['edit-autoconfirmed-project-all-all'] = 'Semi-protected project pages',
Line 57: Line 59:
 
}
 
}
  
 +
local reasonBehaviors = {
 +
vandalism = 'namespaceFirst',
 +
dispute = 'reasonFirst',
 +
blp = 'reasonFirst',
 +
sock = 'reasonFirst',
 +
office = 'reasonFirst',
 +
}
 +
 +
--[[
 +
-- Not currently used
 
local error_categories = {
 
local error_categories = {
 
incorrect = 'Wikipedia pages with incorrect protection templates',
 
incorrect = 'Wikipedia pages with incorrect protection templates',
Line 63: Line 75:
 
template = 'Wikipedia template-protected pages other than templates and modules'
 
template = 'Wikipedia template-protected pages other than templates and modules'
 
}
 
}
−
 
+
--]]
−
local template_types = {
 
−
vandalism = {
 
−
namespaces = false, -- defaults to all namespaces
 
−
editLevels = false, -- all edit protection levels
 
−
moveLevels = false, -- all move protection levels
 
−
createLevels = false, -- all create protection levels
 
−
header = false,
 
−
reason = 'due to [[Wikipedia:Vandalism|vandalism]]',
 
−
icon_reason = 'due to vandalism',
 
−
}
 
−
}
 
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
Line 80: Line 81:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local getArgs = require('Module:Arguments').getArgs
+
-- Define often-used functions as local variables.
−
local yesno = require('Module:Yesno')
+
local tconcat = table.concat
  
 
local p = {}
 
local p = {}
  
−
function p.main(frame)
+
function p.matchNamespace(ns)
−
-- Get data
+
-- Matches a namespace number to a string that can be passed to the
−
local args = getArgs(frame)
+
-- namespacep parameter of p.getCategoryName.
−
local title = p.getTitle(args.page)
 
−
local protType, protLevel = p.getProtectionStatus(title)
 
−
local namespace = p.getNamespace(title)
 
−
local expiry = p.getExpiry(args.expiry)
 
−
local reason = p.getReason(args.reason)
 
−
 
 
−
-- Sort categories and build a category link with the best match
 
−
categories = p.sortCategories(categories, protType, protLevel, namespace, expiry, reason)
 
−
local category = categories[1].name
 
−
category = string.format('[[Category:%s]]', category)
 
−
 
 
−
-- Find whether we are small or not and output a padlock or a banner as appropriate
 
−
local isSmall = yesno(args.small, true)
 
−
if isSmall then
 
−
return p.exportPadlock()
 
−
else
 
−
return p.exportBanner()
 
−
end
 
−
end
 
−
 
 
−
function p.parseNamespace(ns)
 
−
-- The ns variable is the namespace number.
 
 
if not ns or type(ns) ~= 'number' then
 
if not ns or type(ns) ~= 'number' then
 
return 'all'
 
return 'all'
Line 123: Line 102:
  
 
function p.getCategoryName(cats, protType, protLevel, namespace, reason, expiry)
 
function p.getCategoryName(cats, protType, protLevel, namespace, reason, expiry)
 +
-- Gets a category name from the category table, given a combination of
 +
-- the protection type, the protection level, the namespace number, the
 +
-- reason for protection, and the expiry date.
 +
 
-- Preprocess parameters
 
-- Preprocess parameters
 
cats = cats or categories
 
cats = cats or categories
 
protType = protType or 'all'
 
protType = protType or 'all'
 
protLevel = protLevel or 'all'
 
protLevel = protLevel or 'all'
−
namespace = p.parseNamespace(namespace)
+
namespace = p.matchNamespace(namespace)
 
reason = reason or 'all'
 
reason = reason or 'all'
 
if not expiry then
 
if not expiry then
Line 135: Line 118:
 
end
 
end
 
 
 +
--[[
 
-- Define the key table and the order to test it in.
 
-- Define the key table and the order to test it in.
−
-- This part is a little like playing regex golf - we have to make up a new
+
-- The idiosyncracies of the old template system have been distilled down to
−
-- rule for every idiosyncracy that was in the old template system.
+
-- two basic behaviors - templates that prioritise matching the reason over
−
local keyTable = {protType, protLevel, namespace, reason, expiry}
+
-- matching the namespace, and templates that prioritise matching the
−
+
-- namespace over matching the reason. In each case the function tries to
−
local reasonBehaviors = {
+
-- match specific keys, and if there is no match, it proceeds to match
−
vandalism = 'namespaceFirst',
+
-- increasingly generic keys, until eventually it will match the key
−
dispute = 'reasonFirst',
+
-- "all-all-all-all-all".
−
blp = 'reasonFirst',
+
--]]
−
sock = 'reasonFirst',
+
local protectionProperties = {protType, protLevel, namespace, reason, expiry}
−
office = 'reasonFirst',
 
−
}
 
−
 
 
 
local reasonBehavior = reasonBehaviors[reason]
 
local reasonBehavior = reasonBehaviors[reason]
 
local attemptOrder  
 
local attemptOrder  
Line 153: Line 134:
 
attemptOrder = {
 
attemptOrder = {
 
-- type, level, ns, reason, expiry
 
-- type, level, ns, reason, expiry
 +
-- true corresponds to the original protectionProperties key,
 +
-- and false corresponds to the key "all".
 
{true, true, true, true, true},    -- 1
 
{true, true, true, true, true},    -- 1
 
{true, true, true, true, false},    -- 2
 
{true, true, true, true, false},    -- 2
Line 199: Line 182:
 
for i, t in ipairs(attemptOrder) do
 
for i, t in ipairs(attemptOrder) do
 
local key = {}
 
local key = {}
−
for j, useKeyTable in ipairs(t) do
+
for j, useProperty in ipairs(t) do
−
if useKeyTable then
+
if useProperty then
−
key[j] = keyTable[j]
+
key[j] = protectionProperties[j]
 
else
 
else
 
key[j] = 'all'
 
key[j] = 'all'
 
end
 
end
 
end
 
end
−
key = table.concat(key, '-')
+
key = tconcat(key, '-')
 
mw.log(key) -- for debugging
 
mw.log(key) -- for debugging
 
local attempt = cats[key]
 
local attempt = cats[key]

Revision as of 14:47, 10 March 2014

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

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

local categories = {
	-- The key strings follow this format:
	-- type, level, ns, reason, expiry
	['edit-autoconfirmed-user-all-all'] = 'Wikipedia semi-protected user and user talk pages',
	['edit-autoconfirmed-project-all-all'] = 'Semi-protected project pages',
	['edit-autoconfirmed-file-all-all'] = 'Semi-protected images',
	['edit-autoconfirmed-template-all-all'] = 'Wikipedia semi-protected templates',
	['edit-autoconfirmed-portal-all-all'] = 'Semi-protected portals',
	['edit-autoconfirmed-talk-all-all'] = 'Semi-protected talk pages',
	['edit-autoconfirmed-all-vandalism-all'] = 'Wikipedia pages semi-protected against vandalism',
	['edit-sysop-user-all-all'] = 'Wikipedia protected user and user talk pages',
	['edit-sysop-file-all-all'] = 'Protected images',
	['edit-sysop-project-all-all'] = 'Protected project pages',
	['edit-sysop-template-all-all'] = 'Wikipedia protected templates',
	['edit-sysop-talk-all-all'] = 'Protected talk pages',
	['edit-sysop-all-vandalism-all'] = 'Wikipedia pages protected against vandalism',
	['edit-autoconfirmed-all-dispute-all'] = 'Wikipedia pages semi-protected due to dispute',
	['edit-sysop-all-dispute-all'] = 'Wikipedia pages protected due to dispute',
	['move-sysop-all-dispute-all'] = 'Wikipedia pages move-protected due to dispute',
	['move-sysop-user-all-all'] = 'Wikipedia move-protected user and user talk pages',
	['move-sysop-project-all-all'] = 'Wikipedia move-protected project pages',
	['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals',
	['move-sysop-all-vandalism-all'] = 'Wikipedia pages move-protected due to vandalism',
	['edit-autoconfirmed-template-all-all'] = 'Wikipedia semi-protected templates',
	['move-sysop-template-all-all'] = 'Wikipedia move-protected templates',
	['edit-all-template-all-all'] = 'Wikipedia protected templates',
	['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals',
	['edit-autoconfirmed-all-sock-all'] = 'Wikipedia pages semi-protected from banned users',
	['edit-sysop-all-sock-all'] = 'Wikipedia pages protected from banned users',
	['edit-autoconfirmed-all-blp-temp'] = 'Wikipedia temporarily semi-protected biographies of living people',
	['edit-sysop-all-blp-temp'] = 'Wikipedia temporarily protected biographies of living people',
	['edit-autoconfirmed-all-blp-all'] = 'Wikipedia indefinitely semi-protected biographies of living people',
	['edit-sysop-all-blp-all'] = 'Wikipedia indefinitely protected biographies of living people',
	['edit-autoconfirmed-all-all-indef'] = 'Wikipedia indefinitely semi-protected pages',
	['edit-autoconfirmed-category-all-all'] = 'Wikipedia semi-protected categories',
	['edit-sysop-category-all-all'] = 'Wikipedia protected categories',
	['move-sysop-talk-all-all'] = 'Wikipedia move-protected talk pages',
	['move-sysop-all-all-indef'] = 'Wikipedia indefinitely move-protected pages',
	['edit-autoconfirmed-all-all-all'] = 'Wikipedia semi-protected pages',
	['move-sysop-all-all-all'] = 'Wikipedia move-protected pages',
	['pc-autoconfirmed-all-all-all'] = 'Wikipedia pending changes protected pages (level 1)',
	['pc-reviewer-all-all-all'] = 'Wikipedia pending changes protected pages (level 2)',
	['all-all-all-office-all'] = 'Wikipedia Office-protected pages',
	['all-all-all-all-all'] = 'Wikipedia protected pages',
}

local nskeys = {
	[2] = 'user',
	[3] = 'user',
	[4] = 'project',
	[6] = 'file',
	[10] = 'template',
	[12] = 'project',
	[14] = 'category',
	[100] = 'portal',
}

local reasonBehaviors = {
	vandalism = 'namespaceFirst',
	dispute = 'reasonFirst',
	blp = 'reasonFirst',
	sock = 'reasonFirst',
	office = 'reasonFirst',
}

--[[
-- Not currently used
local error_categories = {
	incorrect = 'Wikipedia pages with incorrect protection templates',
	no_expiry = 'Wikipedia protected pages without expiry',
	create = 'Wikipedia pages tagged as create-protected',
	template = 'Wikipedia template-protected pages other than templates and modules'
}
--]]

--------------------------------------------------------------------------------
-- Main functions
--------------------------------------------------------------------------------

-- Define often-used functions as local variables.
local tconcat = table.concat

local p = {}

function p.matchNamespace(ns)
	-- Matches a namespace number to a string that can be passed to the
	-- namespacep parameter of p.getCategoryName.
	if not ns or type(ns) ~= 'number' then
		return 'all'
	end
	local nskey = nskeys[ns]
	if not nskey and ns % 2 == 1 then
		nskey = 'talk'
	elseif not nskey then
		nskey = 'all'
	end
	return nskey
end

function p.getCategoryName(cats, protType, protLevel, namespace, reason, expiry)
	-- Gets a category name from the category table, given a combination of
	-- the protection type, the protection level, the namespace number, the
	-- reason for protection, and the expiry date.
	
	-- Preprocess parameters
	cats = cats or categories
	protType = protType or 'all'
	protLevel = protLevel or 'all'
	namespace = p.matchNamespace(namespace)
	reason = reason or 'all'
	if not expiry then
		expiry = 'all'
	elseif expiry ~= 'indef' then
		expiry = 'temp'
	end
	
	--[[
	-- Define the key table and the order to test it in.
	-- The idiosyncracies of the old template system have been distilled down to
	-- two basic behaviors - templates that prioritise matching the reason over
	-- matching the namespace, and templates that prioritise matching the
	-- namespace over matching the reason. In each case the function tries to
	-- match specific keys, and if there is no match, it proceeds to match
	-- increasingly generic keys, until eventually it will match the key
	-- "all-all-all-all-all".
	--]]
	local protectionProperties = {protType, protLevel, namespace, reason, expiry}
	local reasonBehavior = reasonBehaviors[reason]
	local attemptOrder 
	if reasonBehavior == 'namespaceFirst' then
		attemptOrder = {
			-- type, level, ns, reason, expiry
			-- true corresponds to the original protectionProperties key,
			-- and false corresponds to the key "all".
			{true, true, true, true, true},     -- 1
			{true, true, true, true, false},    -- 2
			{true, true, true, false, true},    -- 3
			{true, true, true, false, false},   -- 4
			{true, false, true, true, true},    -- 5
			{true, false, true, true, false},   -- 6
			{true, false, true, false, true},   -- 7
			{true, false, true, false, false},  -- 8
			{false, false, true, false, false}, -- 9
			{true, true, false, true, true},    -- 10
			{true, true, false, true, false},   -- 11
			{true, true, false, false, true},   -- 12
			{true, false, false, true, true},   -- 13
			{true, false, false, true, false},  -- 14
			{true, false, false, false, true},  -- 15
			{true, false, false, false, false}, -- 16
			{false, false, false, false, false} -- 17
		}
	elseif reasonBehavior == 'reasonFirst' or reason == 'all' then
		attemptOrder = {
			-- type, level, ns, reason, expiry
			{true, true, true, true, true},     -- 1
			{true, true, true, true, false},    -- 2
			{true, true, false, true, true},    -- 3
			{true, true, false, true, false},   -- 4
			{true, false, true, true, true},    -- 5
			{true, false, true, true, false},   -- 6
			{true, false, false, true, true},   -- 7
			{true, false, false, true, false},  -- 8
			{false, false, false, true, false}, -- 9
			{true, true, true, false, true},    -- 10
			{true, true, true, false, false},   -- 11
			{true, true, false, false, true},   -- 12
			{true, false, true, false, true},   -- 13
			{true, false, true, false, false},  -- 14
			{true, false, false, false, true},  -- 15
			{true, false, false, false, false}, -- 16
			{false, false, false, false, false} -- 17
		}
	else
		error(reason .. ' is not a valid reason')
	end
	
	-- Try successively generic matches until we run out of key combinations
	for i, t in ipairs(attemptOrder) do
		local key = {}
		for j, useProperty in ipairs(t) do
			if useProperty then
				key[j] = protectionProperties[j]
			else
				key[j] = 'all'
			end
		end
		key = tconcat(key, '-')
		mw.log(key) -- for debugging
		local attempt = cats[key]
		if attempt then
			return attempt
		end
	end
	error('No category match found; please define the category for key "all-all-all-all-all"')
end			

return p
Retrieved from "https://amanitaresearch.com/index.php?title=Module:Protection_banner&oldid=3729"