Module:Protection banner: Difference between revisions

Module:Protection banner (edit)

Revision as of 14:47, 10 March 2014

291 bytes removed , 10 years ago

tidy this up and comment it so it will be easier for others to understand

Anonymous user

wikipedia>Mr. Stradivarius

@@ Line 3: / Line 3: @@
 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',
@@ Line 57: / Line 59: @@
 }
+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',
@@ Line 63: / Line 75: @@
 	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 = {}
-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
 		return 'all'
@@ Line 123: / Line 102: @@
 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.parseNamespace(namespace)
+	namespace = p.matchNamespace(namespace)
 	reason = reason or 'all'
 	if not expiry then
@@ Line 135: / Line 118: @@
 	end
+	--[[
 	-- 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 attemptOrder
@@ Line 153: / Line 134: @@
 		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
@@ Line 199: / Line 182: @@
 	for i, t in ipairs(attemptOrder) do
 		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
 				key[j] = 'all'
 			end
 		end
-		key = table.concat(key, '-')
+		key = tconcat(key, '-')
 		mw.log(key) -- for debugging
 		local attempt = cats[key]