Module:Protection banner: Difference between revisions
en>Mr. Stradivarius (use ipairs to make the attempt loop a little more efficient) |
en>Mr. Stradivarius (change this to something that should work if I can get the order figured out) |
||
(15 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
local categories = { | local categories = { | ||
['edit- | -- The key strings follow this format: | ||
['edit- | -- type, level, ns, reason, expiry | ||
['edit- | ['edit-autoconfirmed-user-all-all'] = 'Wikipedia semi-protected user and user talk pages', | ||
['edit- | ['edit-autoconfirmed-project-all-all'] = 'Semi-protected project pages', | ||
['edit- | ['edit-autoconfirmed-file-all-all'] = 'Semi-protected images', | ||
['edit- | ['edit-autoconfirmed-template-all-all'] = 'Wikipedia semi-protected templates', | ||
['edit- | ['edit-autoconfirmed-portal-all-all'] = 'Semi-protected portals', | ||
['edit- | ['edit-autoconfirmed-talk-all-all'] = 'Semi-protected talk pages', | ||
['edit- | ['edit-autoconfirmed-all-vandalism-all'] = 'Wikipedia pages semi-protected against vandalism', | ||
['edit- | ['edit-sysop-user-all-all'] = 'Wikipedia protected user and user talk pages', | ||
['edit- | ['edit-sysop-file-all-all'] = 'Protected images', | ||
['edit- | ['edit-sysop-project-all-all'] = 'Protected project pages', | ||
['edit- | ['edit-sysop-template-all-all'] = 'Wikipedia protected templates', | ||
['edit- | ['edit-sysop-talk-all-all'] = 'Protected talk pages', | ||
['edit- | ['edit-sysop-all-vandalism-all'] = 'Wikipedia pages protected against vandalism', | ||
['move- | ['edit-autoconfirmed-all-dispute-all'] = 'Wikipedia pages semi-protected due to dispute', | ||
['move- | ['edit-sysop-all-dispute-all'] = 'Wikipedia pages protected due to dispute', | ||
['move- | ['move-sysop-all-dispute-all'] = 'Wikipedia pages move-protected due to dispute', | ||
['move- | ['move-sysop-user-all-all'] = 'Wikipedia move-protected user and user talk pages', | ||
['edit- | ['move-sysop-project-all-all'] = 'Wikipedia move-protected project pages', | ||
['move- | ['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', | ['edit-all-template-all-all'] = 'Wikipedia protected templates', | ||
['move- | ['move-sysop-portal-all-all'] = 'Wikipedia move-protected portals', | ||
['edit- | ['edit-autoconfirmed-all-sock-all'] = 'Wikipedia pages semi-protected from banned users', | ||
['edit- | ['edit-sysop-all-sock-all'] = 'Wikipedia pages protected from banned users', | ||
['edit- | ['edit-autoconfirmed-all-blp-temp'] = 'Wikipedia temporarily semi-protected biographies of living people', | ||
['edit- | ['edit-sysop-all-blp-temp'] = 'Wikipedia temporarily protected biographies of living people', | ||
['edit- | ['edit-autoconfirmed-all-blp-all'] = 'Wikipedia indefinitely semi-protected biographies of living people', | ||
['edit- | ['edit-sysop-all-blp-all'] = 'Wikipedia indefinitely protected biographies of living people', | ||
['edit- | ['edit-autoconfirmed-all-all-indef'] = 'Wikipedia indefinitely semi-protected pages', | ||
['move- | ['edit-autoconfirmed-category-all-all'] = 'Wikipedia semi-protected categories', | ||
['move- | ['edit-sysop-category-all-all'] = 'Wikipedia protected categories', | ||
['edit-semi-all-all-all'] = 'Wikipedia | ['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', | ['all-all-all-all-all'] = 'Wikipedia protected pages', | ||
} | } | ||
Line 56: | Line 59: | ||
} | } | ||
local behaviors = { | |||
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', | ||
Line 62: | Line 75: | ||
template = 'Wikipedia template-protected pages other than templates and modules' | template = 'Wikipedia template-protected pages other than templates and modules' | ||
} | } | ||
--]] | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
Line 79: | Line 81: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local | -- Define often-used functions as local variables. | ||
local | local tconcat = table.concat | ||
local tinsert = table.insert | |||
local floor = math.floor | |||
local p = {} | local p = {} | ||
function 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 | if not ns or type(ns) ~= 'number' then | ||
return 'all' | return 'all' | ||
end | end | ||
local nskey = nskeys[ns] | local nskey = nskeys[ns] | ||
if not nskey | if not nskey then | ||
if ns % 2 == 1 then | |||
nskey = 'talk' | |||
else | |||
nskey = 'all' | |||
end | |||
end | end | ||
return nskey | return nskey | ||
Line 122: | Line 106: | ||
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' | local properties = {} | ||
protLevel = protLevel or 'all' | properties.protType = protType or 'all' | ||
namespace = p. | properties.protLevel = protLevel or 'all' | ||
reason = reason or 'all' | properties.namespace = p.matchNamespace(namespace) | ||
properties.reason = reason or 'all' | |||
if not expiry then | if not expiry then | ||
expiry = 'all' | properties.expiry = 'all' | ||
elseif expiry ~= 'indef' then | elseif expiry ~= 'indef' then | ||
expiry = 'temp' | properties.expiry = 'temp' | ||
end | |||
local order = {'expiry', 'namespace', 'protLevel', 'protType', 'reason'} | |||
local behavior = behaviors[reason] | |||
if behavior == 'namespaceFirst' then | |||
tinsert(order, table.remove(order, 2)) -- move namespace to the end | |||
elseif behavior ~= 'reasonFirst' and reason ~= 'all' then | |||
error(reason .. ' is not a valid reason') | |||
end | end | ||
local activePropertyKeys = {} | |||
for i, propertyKey in ipairs(order) do | |||
if properties[propertyKey] ~= 'all' then | |||
local | activePropertyKeys[#activePropertyKeys + 1] = propertyKey | ||
end | |||
end | end | ||
local noActiveProperties = #activePropertyKeys | |||
-- Try successively generic matches until we run out of key combinations | -- Try successively generic matches until we run out of key combinations | ||
for i, | for i = 1, 2^noActiveProperties do | ||
local | local categoryKey = {} | ||
for | for pos = 1, 5 do | ||
if | if pos > noActiveProperties then | ||
categoryKey[pos] = 'all' | |||
else | else | ||
local quotient = i / 2 ^ (pos - 1) | |||
quotient = floor(quotient) | |||
if quotient % 2 == 1 then | |||
categoryKey[pos] = properties[activePropertyKeys[pos]] | |||
else -- quotient % 2 == 0 | |||
categoryKey[pos] = 'all' | |||
end | |||
end | end | ||
end | end | ||
categoryKey = tconcat(categoryKey, '-') | |||
mw.log( | mw.log(categoryKey) -- for debugging | ||
local attempt = cats[ | local attempt = cats[categoryKey] | ||
if attempt then | if attempt then | ||
return attempt | return attempt | ||
Line 174: | Line 163: | ||
end | end | ||
error('No category match found; please define the category for key "all-all-all-all-all"') | error('No category match found; please define the category for key "all-all-all-all-all"') | ||
end | end | ||
return p | return p |
Revision as of 07:23, 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 floor = math.floor
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 'all'
end
local nskey = nskeys[ns]
if not nskey then
if ns % 2 == 1 then
nskey = 'talk'
else
nskey = 'all'
end
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.
-- Preprocess parameters
cats = cats or categories
local properties = {}
properties.protType = protType or 'all'
properties.protLevel = protLevel or 'all'
properties.namespace = p.matchNamespace(namespace)
properties.reason = reason or 'all'
if not expiry then
properties.expiry = 'all'
elseif expiry ~= 'indef' then
properties.expiry = 'temp'
end
local order = {'expiry', 'namespace', 'protLevel', 'protType', 'reason'}
local behavior = behaviors[reason]
if behavior == 'namespaceFirst' then
tinsert(order, table.remove(order, 2)) -- move namespace to the end
elseif behavior ~= 'reasonFirst' and reason ~= 'all' then
error(reason .. ' is not a valid reason')
end
local activePropertyKeys = {}
for i, propertyKey in ipairs(order) do
if properties[propertyKey] ~= 'all' then
activePropertyKeys[#activePropertyKeys + 1] = propertyKey
end
end
local noActiveProperties = #activePropertyKeys
-- Try successively generic matches until we run out of key combinations
for i = 1, 2^noActiveProperties do
local categoryKey = {}
for pos = 1, 5 do
if pos > noActiveProperties then
categoryKey[pos] = 'all'
else
local quotient = i / 2 ^ (pos - 1)
quotient = floor(quotient)
if quotient % 2 == 1 then
categoryKey[pos] = properties[activePropertyKeys[pos]]
else -- quotient % 2 == 0
categoryKey[pos] = 'all'
end
end
end
categoryKey = tconcat(categoryKey, '-')
mw.log(categoryKey) -- for debugging
local attempt = cats[categoryKey]
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