Modul:Protection banner: Unterschied zwischen den Versionen
tidy this up and comment it so it will be easier for others to understand
(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) |
||
Zeile 3: | Zeile 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', | ||
Zeile 57: | Zeile 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', | ||
Zeile 63: | Zeile 75: | ||
template = 'Wikipedia template-protected pages other than templates and modules' | template = 'Wikipedia template-protected pages other than templates and modules' | ||
} | } | ||
--]] | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
Zeile 80: | Zeile 81: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local | -- Define often-used functions as local variables. | ||
local | local tconcat = table.concat | ||
local p = {} | local p = {} | ||
function 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 | if not ns or type(ns) ~= 'number' then | ||
return 'all' | return 'all' | ||
Zeile 123: | Zeile 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. | namespace = p.matchNamespace(namespace) | ||
reason = reason or 'all' | reason = reason or 'all' | ||
if not expiry then | if not expiry then | ||
Zeile 135: | Zeile 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. | ||
-- | -- 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 | |||
local | -- 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 reasonBehavior = reasonBehaviors[reason] | ||
local attemptOrder | local attemptOrder | ||
Zeile 153: | Zeile 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 | ||
Zeile 199: | Zeile 182: | ||
for i, t in ipairs(attemptOrder) do | for i, t in ipairs(attemptOrder) do | ||
local key = {} | local key = {} | ||
for j, | for j, useProperty in ipairs(t) do | ||
if | if useProperty then | ||
key[j] = | key[j] = protectionProperties[j] | ||
else | else | ||
key[j] = 'all' | key[j] = 'all' | ||
end | end | ||
end | end | ||
key = | key = tconcat(key, '-') | ||
mw.log(key) -- for debugging | mw.log(key) -- for debugging | ||
local attempt = cats[key] | local attempt = cats[key] |