Difference between revisions of "Module:Protection banner"

Revision as of 00:35, 4 March 2014

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

local categories = {
	['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-user-all-all'] = 'Wikipedia move-protected project pages',
	['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals',
	['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-template-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-indef'] = 'Wikipedia indefinitely semi-protected biographies of living people',
	['edit-sysop-all-blp-indef'] = 'Wikipedia indefinitely protected biographies of living people',
	['edit-autoconfirmed-all-all-indef'] = 'Wikipedia indefinitely semi-protected pages',
	['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',
	['all-all-all-all-all'] = 'Wikipedia protected pages',
	['edit-autoconfirmed-category-all-all'] = 'Wikipedia semi-protected categories',
	['edit-sysop-all-all-all'] = 'Wikipedia protected categories',
	['move-sysop-all-all-all'] = 'Wikipedia move-protected pages',
	['all-all-all-office-all'] = 'Wikipedia Office-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)',
}

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