Difference between revisions of "Module:Protection banner"

Revision as of 16:40, 3 March 2014

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

local categories = {
	{
		name = 'Wikipedia semi-protected user and user talk pages',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[2] = true, [3] = true} -- User and user talk
	},
	{
		name = 'Semi-protected project pages',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[4] = true} -- Project
	},
	{
		name = 'Semi-protected images',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[6] = true} -- File
	},
	{
		name = 'Wikipedia semi-protected templates',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[10] = true} -- Template
	},
	{
		name = 'Semi-protected portals',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[100] = true} -- Portal
	},
	{
		name = 'Semi-protected talk pages',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {talk = true}
	},
	{
		name = 'Wikipedia pages semi-protected against vandalism',
		type = 'edit',
		level = 'autoconfirmed',
		reason = 'vandalism'
	},
	{
		name = 'Wikipedia protected user and user talk pages',
		type = 'edit',
		level = 'sysop',
		ns = {[2] = true, [3] = true} -- User and user talk
	},
	{
		name = 'Protected images',
		type = 'edit',
		level = 'sysop',
		ns = {[6] = true} -- File
	},
	{
		name = 'Protected project pages',
		type = 'edit',
		level = 'sysop',
		ns = {[4] = true, [12] = true} -- Project and Help
	},
	{
		name = 'Wikipedia protected templates',
		type = 'edit',
		level = 'sysop',
		ns = {[10] = true}, -- Template
	},
	{
		name = 'Protected talk pages',
		type = 'edit',
		level = 'sysop',
		ns = {talk = true}
	},
	{
		name = 'Wikipedia pages protected against vandalism',
		type = 'edit',
		level = 'sysop',
		reason = 'vandalism'
	},
	{
		name = 'Wikipedia pages semi-protected due to dispute',
		type = 'edit',
		level = 'autoconfirmed',
		reason = 'dispute'
	},
	{
		name = 'Wikipedia pages protected due to dispute',
		type = 'edit',
		level = 'sysop',
		reason = 'dispute'
	},
	{
		name = 'Wikipedia pages move-protected due to dispute',
		type = 'move',
		level = 'sysop',
		reason = 'dispute'
	},
	{
		name = 'Wikipedia move-protected user and user talk pages',
		type = 'move',
		level = 'sysop',
		ns = {[2] = true, [3] = true} -- User and user talk
	},
	{
		name = 'Wikipedia move-protected project pages',
		type = 'move',
		level = 'sysop',
		ns = {[4] = true} -- Project
	},
	{
		name = 'Wikipedia move-protected portals',
		type = 'move',
		level = 'sysop',
		ns = {[100] = true} -- Portal
	},
	{
		name = 'Wikipedia semi-protected templates',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[10] = true} -- Template
	},
	{
		name = 'Wikipedia move-protected templates',
		type = 'move',
		level = 'sysop',
		ns = {[10] = true} -- Template
	},
	{
		name = 'Wikipedia protected templates',
		type = 'edit',
		ns = {[10] = true} -- Template
	},
	{
		name = 'Wikipedia move-protected portals',
		type = 'move',
		level = 'sysop',
		ns = {[100] = true} -- Portal
	},
	{
		name = 'Wikipedia pages semi-protected from banned users',
		type = 'edit',
		level = 'autoconfirmed',
		reason = 'sock'
	},
	{
		name = 'Wikipedia pages protected from banned users',
		type = 'edit',
		level = 'sysop',
		reason = 'sock'
	},
	{
		name = 'Wikipedia temporarily semi-protected biographies of living people',
		type = 'edit',
		level = 'autoconfirmed',
		reason = 'blp',
		expiry = 'temp'
	},
	{
		name = 'Wikipedia temporarily protected biographies of living people',
		type = 'edit',
		level = 'sysop',
		reason = 'blp',
		expiry = 'temp'
	},
	{
		name = 'Wikipedia indefinitely semi-protected biographies of living people',
		type = 'edit',
		level = 'autoconfirmed',
		reason = 'blp',
		expiry = 'indef'
	},
	{
		name = 'Wikipedia indefinitely protected biographies of living people',
		type = 'edit',
		level = 'sysop',
		reason = 'blp',
		expiry = 'indef'
	},
	{
		name = 'Wikipedia indefinitely semi-protected pages',
		type = 'edit',
		level = 'autoconfirmed',
		expiry = 'indef'
	},
	{
		name = 'Wikipedia move-protected talk pages',
		type = 'move',
		level = 'sysop',
		ns = {talk = true}
	},
	{
		name = 'Wikipedia indefinitely move-protected pages',
		type = 'move',
		level = 'sysop',
		expiry = 'indef'
	},
	{
		name = 'Wikipedia semi-protected pages',
		type = 'edit',
		level = 'autoconfirmed'
	},
	{
		name = 'Wikipedia protected pages',
	},
	{
		name = 'Wikipedia semi-protected categories',
		type = 'edit',
		level = 'autoconfirmed',
		ns = {[14] = true}
	},
	{
		name = 'Wikipedia protected categories',
		type = 'edit',
		ns = {[14] = true} -- Category
	},
	{
		name = 'Wikipedia move-protected pages',
		type = 'move',
		level = 'sysop'
	},
	{
		name = 'Wikipedia Office-protected pages',
		reason = 'office'
	},
	{
		name = 'Wikipedia pending changes protected pages (level 1)',
		type = 'pc',
		level = 'autoconfirmed'
	},
	{
		name = 'Wikipedia pending changes protected pages (level 2)',
		type = 'pc',
		level = 'reviewer'
	},
}

local error_categories = {
	incorrect = 'Wikipedia pages with incorrect protection templates',
	no_expiry = 'Wikipedia protected pages without expiry',
	create = 'Wikipedia pages tagged as create-protected'
}

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',
	}
}

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

local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')

local p = {}

function p.main(frame)
	-- Get data
	local args = getArgs(frame)
	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.matchCategory(cats, protType, protLevel, namespace, expiry, reason)
	local function isValidCat(t)
		--[[
		-- Does a first parse over the categories, removing any that explicitly
		-- name a wrong parameter. This accounts for the majority of all of the
		-- categories.
		--
		-- We check the parameters most likely to be wrong first. This saves on
		-- table lookups, which shoud make the function faster.
		--]]
		local testType, testLevel, testNs, testExpiry, testReason
		testReason = t.reason
		if testReason and testReason ~= reason then
			return false
		end
		testNs = t.namespace
		if testNs and not testNs[namespace] then
			return false
		end
		testExpiry = t.expiry
		if testExpiry and testExpiry ~= expiry then
			return false
		end
		testLevel = t.level
		if testLevel and testLevel ~= protLevel then
			return false
		end
		testType = t.type
		if testType and testType ~= protType then
			return false
		end
		return true
	end

	-- Remove invalid cats.
	local sortCats = {}
	for i, t in ipairs(cats) do
		if isValidCat(t) then
			sortCats[#sortCats + 1] = t
		end
	end

	-- Sort the remaining cats.
	-- The categories which are left either explicitly name the right parameter,
	-- or implicitly allow all values for that parameter.
	table.sort(sortCats, function (t1, t2)
		local type1 = t1.type
		local type2 = t2.type
		local level1 = t1.level
		local level2 = t2.level
		local ns1 = t1.namespace
		local ns2 = t2.namespace
		local exp1 = t1.expiry
		local exp2 = t2.expiry
		local reason1 = t1.reason
		local reason2 = t2.reason

		local score1 = 0
		local score2 = 0
	end)
end			

return p