Difference between revisions of "Module:Protection banner"

From Timelines
Jump to: navigation, search
(change this to something that should work if I can get the order figured out)
(key components are in the correct order now - property order still a long way off, though)
Line 84: Line 84:
 
local tconcat = table.concat
 
local tconcat = table.concat
 
local tinsert = table.insert
 
local tinsert = table.insert
 +
local tremove = table.remove
 
local floor = math.floor
 
local floor = math.floor
 +
 +
local function toTableEnd(t, pos)
 +
-- Sends the item at position pos to the end of array t,
 +
-- and shifts all the other array items down accordingly.
 +
tinsert(t, tremove(t, pos))
 +
end
  
 
local p = {}
 
local p = {}
Line 92: Line 99:
 
-- namespace parameter of p.getCategoryName.
 
-- namespace parameter of p.getCategoryName.
 
if not ns or type(ns) ~= 'number' then
 
if not ns or type(ns) ~= 'number' then
−
return 'all'
+
return nil
 
end
 
end
 
local nskey = nskeys[ns]
 
local nskey = nskeys[ns]
−
if not nskey then
+
if not nskey and ns % 2 == 1 then
−
if ns % 2 == 1 then
 
 
nskey = 'talk'
 
nskey = 'talk'
−
else
 
−
nskey = 'all'
 
−
end
 
 
end
 
end
 
return nskey
 
return nskey
Line 109: Line 112:
 
-- the protection type, the protection level, the namespace number, the
 
-- the protection type, the protection level, the namespace number, the
 
-- reason for protection, and the expiry date.
 
-- reason for protection, and the expiry date.
−
 
−
-- Preprocess parameters
 
 
cats = cats or categories
 
cats = cats or categories
−
local properties = {}
+
 
−
properties.protType = protType or 'all'
+
local properties = {
−
properties.protLevel = protLevel or 'all'
+
{pos = 5, val = expiry},
−
properties.namespace = p.matchNamespace(namespace)
+
{pos = 3, val = namespace},
−
properties.reason = reason or 'all'
+
{pos = 2, val = protLevel},
−
if not expiry then
+
{pos = 1, val = protType},
−
properties.expiry = 'all'
+
{pos = 4, val = reason}
−
elseif expiry ~= 'indef' then
+
}
−
properties.expiry = 'temp'
+
 
 +
local behavior = 'reasonFirst'
 +
if reason then
 +
behavior = behaviors[reason]
 +
if behavior == 'namespaceFirst' then
 +
toTableEnd(properties, 2) -- move namespace to the end
 +
elseif behavior ~= 'reasonFirst' then
 +
error(reason .. ' is not a valid reason')
 +
end
 
end
 
end
  
−
local order = {'expiry', 'namespace', 'protLevel', 'protType', 'reason'}  
+
local active, inactive = {}, {}
−
local behavior = behaviors[reason]
+
for i, t in ipairs(properties) do
−
if behavior == 'namespaceFirst' then
+
if t.val then
−
tinsert(order, table.remove(order, 2)) -- move namespace to the end
+
active[#active + 1] = t
−
elseif behavior ~= 'reasonFirst' and reason ~= 'all' then
+
else
−
error(reason .. ' is not a valid reason')
+
inactive[#inactive + 1] = t
 +
end
 
end
 
end
 +
local noActive = #active
  
−
local activePropertyKeys = {}
+
local attemptOrder = active
−
for i, propertyKey in ipairs(order) do
+
for i, t in ipairs(inactive) do
−
if properties[propertyKey] ~= 'all' then
+
attemptOrder[#attemptOrder + 1] = t
−
activePropertyKeys[#activePropertyKeys + 1] = propertyKey
 
−
end
 
 
end
 
end
−
local noActiveProperties = #activePropertyKeys
+
 
−
+
for i = 1, 2^noActive do
−
-- Try successively generic matches until we run out of key combinations
+
local key = {}
−
for i = 1, 2^noActiveProperties do
+
for j, t in ipairs(attemptOrder) do
−
local categoryKey = {}
+
local pos = t.pos
−
for pos = 1, 5 do
+
local val = t.val
−
if pos > noActiveProperties then
+
if j > noActive then
−
categoryKey[pos] = 'all'
+
key[pos] = 'all'
 
else
 
else
−
local quotient = i / 2 ^ (pos - 1)
+
local quotient = i / 2 ^ (j - 1)
 
quotient = floor(quotient)
 
quotient = floor(quotient)
 
if quotient % 2 == 1 then
 
if quotient % 2 == 1 then
−
categoryKey[pos] = properties[activePropertyKeys[pos]]
+
key[pos] = val
−
else -- quotient % 2 == 0
+
else
−
categoryKey[pos] = 'all'
+
key[pos] = 'all'
 
end
 
end
 
end
 
end
 
end
 
end
−
categoryKey = tconcat(categoryKey, '-')
+
key = tconcat(key, '-')
−
mw.log(categoryKey) -- for debugging
+
mw.log(key) -- for debugging
−
local attempt = cats[categoryKey]
+
local attempt = cats[key]
 
if attempt then
 
if attempt then
 
return attempt
 
return attempt

Revision as of 04:52, 11 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 behaviors = {
	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 tinsert = table.insert
local tremove = table.remove
local floor = math.floor

local function toTableEnd(t, pos)
	-- Sends the item at position pos to the end of array t,
	-- and shifts all the other array items down accordingly.
	tinsert(t, tremove(t, pos))
end

local p = {}

function p.matchNamespace(ns)
	-- Matches a namespace number to a string that can be passed to the
	-- namespace parameter of p.getCategoryName.
	if not ns or type(ns) ~= 'number' then
		return nil
	end
	local nskey = nskeys[ns]
	if not nskey and ns % 2 == 1 then
			nskey = 'talk'
	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.
	cats = cats or categories

	local properties = {
		{pos = 5, val = expiry},
		{pos = 3, val = namespace},
		{pos = 2, val = protLevel},
		{pos = 1, val = protType},
		{pos = 4, val = reason}
	}

	local behavior = 'reasonFirst'
	if reason then
		behavior = behaviors[reason]
		if behavior == 'namespaceFirst' then
			toTableEnd(properties, 2) -- move namespace to the end
		elseif behavior ~= 'reasonFirst' then
			error(reason .. ' is not a valid reason')
		end
	end

	local active, inactive = {}, {}
	for i, t in ipairs(properties) do
		if t.val then
			active[#active + 1] = t
		else
			inactive[#inactive + 1] = t
		end
	end
	local noActive = #active

	local attemptOrder = active
	for i, t in ipairs(inactive) do
		attemptOrder[#attemptOrder + 1] = t
	end

	for i = 1, 2^noActive do
		local key = {}
		for j, t in ipairs(attemptOrder) do
			local pos = t.pos
			local val = t.val
			if j > noActive then
				key[pos] = 'all'
			else
				local quotient = i / 2 ^ (j - 1)
				quotient = floor(quotient)
				if quotient % 2 == 1 then
					key[pos] = val
				else
					key[pos] = 'all'
				end
			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 "http://timelines.issarice.com/index.php?title=Module:Protection_banner&oldid=4942"