441
edits
(fix Module:Submit an edit request function name) |
m (236 revisions imported from wikipedia:Module:Protection_banner: see Topic:Vtixlm0q28eo6jtf) |
||
(38 intermediate revisions by 8 users not shown) | |||
Line 4: | Line 4: | ||
-- Initialise necessary modules. | -- Initialise necessary modules. | ||
require('Module:No globals') | require('Module:No globals') | ||
local | local makeFileLink = require('Module:File link')._main | ||
local effectiveProtectionLevel = require('Module:Effective protection level')._main | local effectiveProtectionLevel = require('Module:Effective protection level')._main | ||
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main | |||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
-- Lazily initialise modules and objects we don't always need. | -- Lazily initialise modules and objects we don't always need. | ||
local getArgs, makeMessageBox, lang | local getArgs, makeMessageBox, lang | ||
-- Set constants. | |||
local CONFIG_MODULE = 'Module:Protection banner/config' | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
Line 16: | Line 19: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local function makeCategoryLink(cat) | local function makeCategoryLink(cat, sort) | ||
if cat then | if cat then | ||
return string.format( | return string.format( | ||
'[[%s:%s]]', | '[[%s:%s|%s]]', | ||
mw.site.namespaces[14].name, | mw.site.namespaces[14].name, | ||
cat | cat, | ||
sort | |||
) | ) | ||
end | end | ||
end | end | ||
Line 30: | Line 32: | ||
-- Validation function for the expiry and the protection date | -- Validation function for the expiry and the protection date | ||
local function validateDate(dateString, dateType) | local function validateDate(dateString, dateType) | ||
lang = | if not lang then | ||
lang = mw.language.getContentLanguage() | |||
end | |||
local success, result = pcall(lang.formatDate, lang, 'U', dateString) | local success, result = pcall(lang.formatDate, lang, 'U', dateString) | ||
if success then | if success then | ||
Line 39: | Line 43: | ||
end | end | ||
error(string.format( | error(string.format( | ||
'invalid %s | 'invalid %s: %s', | ||
dateType, | dateType, | ||
tostring(dateString) | tostring(dateString) | ||
), | ), 4) | ||
end | end | ||
Line 53: | Line 57: | ||
end | end | ||
local function | -- Given a directed graph formatted as node -> table of direct successors, | ||
-- | -- get a table of all nodes reachable from a given node (though always | ||
-- including the given node). | |||
local function getReachableNodes(graph, start) | |||
local toWalk, retval = {[start] = true}, {} | |||
while true do | |||
-- Can't use pairs() since we're adding and removing things as we're iterating | |||
local k = next(toWalk) -- This always gets the "first" key | |||
if k == nil then | |||
return retval | |||
end | |||
toWalk[k] = nil | |||
retval[k] = true | |||
for _,v in ipairs(graph[k]) do | |||
if not retval[v] then | |||
toWalk[v] = true | |||
end | |||
end | |||
end | |||
end | end | ||
Line 63: | Line 82: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local Protection = | local Protection = {} | ||
Protection.__index = Protection | |||
Protection.supportedActions = { | Protection.supportedActions = { | ||
edit = true, | edit = true, | ||
move = true, | move = true, | ||
autoreview = true | autoreview = true, | ||
upload = true | |||
} | } | ||
Line 80: | Line 101: | ||
} | } | ||
function Protection | function Protection.new(args, cfg, title) | ||
local obj = {} | |||
obj._cfg = cfg | |||
obj.title = title or mw.title.getCurrentTitle() | |||
-- Set action | -- Set action | ||
if not args.action then | if not args.action then | ||
obj.action = 'edit' | |||
elseif | elseif Protection.supportedActions[args.action] then | ||
obj.action = args.action | |||
else | else | ||
error(string.format( | error(string.format( | ||
'invalid action | 'invalid action: %s', | ||
tostring(args.action) | tostring(args.action) | ||
), | ), 3) | ||
end | end | ||
-- Set level | -- Set level | ||
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title) | |||
if | if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then | ||
-- Users need to be autoconfirmed to move pages anyway, so treat | -- Users need to be autoconfirmed to move pages anyway, so treat | ||
-- semi-move-protected pages as unprotected. | -- semi-move-protected pages as unprotected. | ||
obj.level = '*' | |||
end | end | ||
-- Set expiry | -- Set expiry | ||
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title) | |||
if effectiveExpiry == 'infinity' then | |||
obj.expiry = 'indef' | |||
elseif effectiveExpiry ~= 'unknown' then | |||
obj.expiry = validateDate(effectiveExpiry, 'expiry date') | |||
end | end | ||
-- Set reason | -- Set reason | ||
if args[1] then | if args[1] then | ||
obj.reason = mw.ustring.lower(args[1]) | |||
if | if obj.reason:find('|') then | ||
error('reasons cannot contain the pipe character ("|")', | error('reasons cannot contain the pipe character ("|")', 3) | ||
end | end | ||
end | end | ||
Line 129: | Line 144: | ||
-- Set protection date | -- Set protection date | ||
if args.date then | if args.date then | ||
obj.protectionDate = validateDate(args.date, 'protection date') | |||
end | end | ||
-- Set banner config | -- Set banner config | ||
do | do | ||
obj.bannerConfig = {} | |||
local configTables = {} | local configTables = {} | ||
if cfg.banners[ | if cfg.banners[obj.action] then | ||
configTables[#configTables + 1] = cfg.banners[ | configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason] | ||
end | end | ||
if cfg.defaultBanners[ | if cfg.defaultBanners[obj.action] then | ||
configTables[#configTables + 1] = cfg.defaultBanners[ | configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level] | ||
configTables[#configTables + 1] = cfg.defaultBanners[ | configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default | ||
end | end | ||
configTables[#configTables + 1] = cfg.masterBanner | configTables[#configTables + 1] = cfg.masterBanner | ||
for i, field in ipairs( | for i, field in ipairs(Protection.bannerConfigFields) do | ||
for j, t in ipairs(configTables) do | for j, t in ipairs(configTables) do | ||
if t[field] then | if t[field] then | ||
obj.bannerConfig[field] = t[field] | |||
break | break | ||
end | end | ||
Line 153: | Line 168: | ||
end | end | ||
end | end | ||
return setmetatable(obj, Protection) | |||
end | |||
function Protection:isUserScript() | |||
-- Whether the page is a user JavaScript or CSS page. | |||
local title = self.title | |||
return title.namespace == 2 and ( | |||
title.contentModel == 'javascript' or title.contentModel == 'css' | |||
) | |||
end | end | ||
function Protection:isProtected() | function Protection:isProtected() | ||
return self.level ~= '*' | return self.level ~= '*' | ||
end | |||
function Protection:shouldShowLock() | |||
-- Whether we should output a banner/padlock | |||
return self:isProtected() and not self:isUserScript() | |||
end | |||
-- Whether this page needs a protection category. | |||
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock | |||
function Protection:isTemporary() | |||
return type(self.expiry) == 'number' | |||
end | end | ||
function Protection:makeProtectionCategory() | function Protection:makeProtectionCategory() | ||
if not self:shouldHaveProtectionCategory() then | |||
return '' | |||
end | |||
local cfg = self._cfg | local cfg = self._cfg | ||
local title = self.title | local title = self.title | ||
-- Get the expiry key fragment. | -- Get the expiry key fragment. | ||
Line 177: | Line 212: | ||
-- Get the namespace key fragment. | -- Get the namespace key fragment. | ||
local | local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace] | ||
if not namespaceFragment and title.namespace % 2 == 1 then | |||
namespaceFragment = 'talk' | |||
end | end | ||
-- Define the order that key fragments are tested in. This is done with an | -- Define the order that key fragments are tested in. This is done with an | ||
-- array of tables containing the value to be tested, along with its | -- array of tables containing the value to be tested, along with its | ||
Line 207: | Line 239: | ||
-- instead. | -- instead. | ||
--]] | --]] | ||
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3)) | |||
--[[ | --[[ | ||
Line 289: | Line 316: | ||
local attempt = cats[key] | local attempt = cats[key] | ||
if attempt then | if attempt then | ||
return makeCategoryLink(attempt) | return makeCategoryLink(attempt, title.text) | ||
end | end | ||
end | end | ||
return '' | return '' | ||
end | end | ||
function Protection:isIncorrect() | function Protection:isIncorrect() | ||
local expiry = self.expiry | local expiry = self.expiry | ||
return not self: | return not self:shouldHaveProtectionCategory() | ||
or type(expiry) == 'number' and expiry < os.time() | or type(expiry) == 'number' and expiry < os.time() | ||
end | end | ||
Line 320: | Line 339: | ||
function Protection:makeCategoryLinks() | function Protection:makeCategoryLinks() | ||
local msg = self._cfg.msg | local msg = self._cfg.msg | ||
local ret = { self:makeProtectionCategory() } | local ret = {self:makeProtectionCategory()} | ||
if self:isIncorrect() then | if self:isIncorrect() then | ||
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-incorrect']) | ret[#ret + 1] = makeCategoryLink( | ||
msg['tracking-category-incorrect'], | |||
self.title.text | |||
) | |||
end | end | ||
if self:isTemplateProtectedNonTemplate() then | if self:isTemplateProtectedNonTemplate() then | ||
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-template']) | ret[#ret + 1] = makeCategoryLink( | ||
msg['tracking-category-template'], | |||
self.title.text | |||
) | |||
end | end | ||
return table.concat(ret) | return table.concat(ret) | ||
Line 337: | Line 359: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local Blurb = | local Blurb = {} | ||
Blurb.__index = Blurb | |||
Blurb.bannerTextFields = { | Blurb.bannerTextFields = { | ||
Line 347: | Line 370: | ||
} | } | ||
function Blurb | function Blurb.new(protectionObj, args, cfg) | ||
return setmetatable({ | |||
_cfg = cfg, | |||
_protectionObj = protectionObj, | |||
_args = args | |||
}, Blurb) | |||
end | end | ||
Line 383: | Line 408: | ||
parameterFuncs.IMAGELINK = self._makeImageLinkParameter | parameterFuncs.IMAGELINK = self._makeImageLinkParameter | ||
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter | parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter | ||
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter | |||
parameterFuncs.PAGETYPE = self._makePagetypeParameter | parameterFuncs.PAGETYPE = self._makePagetypeParameter | ||
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter | parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter | ||
Line 390: | Line 416: | ||
parameterFuncs.TALKPAGE = self._makeTalkPageParameter | parameterFuncs.TALKPAGE = self._makeTalkPageParameter | ||
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter | parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter | ||
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter | |||
parameterFuncs.VANDAL = self._makeVandalTemplateParameter | parameterFuncs.VANDAL = self._makeVandalTemplateParameter | ||
Line 440: | Line 467: | ||
if level == 'autoconfirmed' then | if level == 'autoconfirmed' then | ||
requestType = 'semi' | requestType = 'semi' | ||
elseif level == 'extendedconfirmed' then | |||
requestType = 'extended' | |||
elseif level == 'templateeditor' then | elseif level == 'templateeditor' then | ||
requestType = 'template' | requestType = 'template' | ||
Line 491: | Line 520: | ||
level, | level, | ||
talkKey | talkKey | ||
)) | ), 8) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 512: | Line 541: | ||
function Blurb:_makeIntroBlurbParameter() | function Blurb:_makeIntroBlurbParameter() | ||
if | if self._protectionObj:isTemporary() then | ||
return self:_getExpandedMessage('intro-blurb-expiry') | return self:_getExpandedMessage('intro-blurb-expiry') | ||
else | else | ||
return self:_getExpandedMessage('intro-blurb-noexpiry') | return self:_getExpandedMessage('intro-blurb-noexpiry') | ||
end | |||
end | |||
function Blurb:_makeIntroFragmentParameter() | |||
if self._protectionObj:isTemporary() then | |||
return self:_getExpandedMessage('intro-fragment-expiry') | |||
else | |||
return self:_getExpandedMessage('intro-fragment-noexpiry') | |||
end | end | ||
end | end | ||
Line 523: | Line 560: | ||
return pagetypes[self._protectionObj.title.namespace] | return pagetypes[self._protectionObj.title.namespace] | ||
or pagetypes.default | or pagetypes.default | ||
or error('no default pagetype defined') | or error('no default pagetype defined', 8) | ||
end | end | ||
Line 538: | Line 575: | ||
msg = protectionBlurbs.edit.default | msg = protectionBlurbs.edit.default | ||
else | else | ||
error('no protection blurb defined for protectionBlurbs.edit.default') | error('no protection blurb defined for protectionBlurbs.edit.default', 8) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 564: | Line 601: | ||
msg = protectionLevels.edit.default | msg = protectionLevels.edit.default | ||
else | else | ||
error('no protection level defined for protectionLevels.edit.default') | error('no protection level defined for protectionLevels.edit.default', 8) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 599: | Line 636: | ||
function Blurb:_makeTooltipBlurbParameter() | function Blurb:_makeTooltipBlurbParameter() | ||
if | if self._protectionObj:isTemporary() then | ||
return self:_getExpandedMessage('tooltip-blurb-expiry') | return self:_getExpandedMessage('tooltip-blurb-expiry') | ||
else | else | ||
return self:_getExpandedMessage('tooltip-blurb-noexpiry') | return self:_getExpandedMessage('tooltip-blurb-noexpiry') | ||
end | |||
end | |||
function Blurb:_makeTooltipFragmentParameter() | |||
if self._protectionObj:isTemporary() then | |||
return self:_getExpandedMessage('tooltip-fragment-expiry') | |||
else | |||
return self:_getExpandedMessage('tooltip-fragment-noexpiry') | |||
end | end | ||
end | end | ||
function Blurb:_makeVandalTemplateParameter() | function Blurb:_makeVandalTemplateParameter() | ||
return | return mw.getCurrentFrame():expandTemplate{ | ||
self._args.user or self._protectionObj.title.baseText | title="vandal-m", | ||
args={self._args.user or self._protectionObj.title.baseText} | |||
} | } | ||
end | end | ||
Line 635: | Line 681: | ||
tostring(key), | tostring(key), | ||
type(msg) | type(msg) | ||
)) | ), 4) | ||
end | end | ||
return self:_substituteParameters(msg) | return self:_substituteParameters(msg) | ||
Line 645: | Line 691: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local BannerTemplate = | local BannerTemplate = {} | ||
BannerTemplate.__index = BannerTemplate | |||
function BannerTemplate | function BannerTemplate.new(protectionObj, cfg) | ||
local obj = {} | |||
obj._cfg = cfg | |||
-- Set the image filename. | -- Set the image filename. | ||
local imageFilename = protectionObj.bannerConfig.image | local imageFilename = protectionObj.bannerConfig.image | ||
if imageFilename then | if imageFilename then | ||
obj._imageFilename = imageFilename | |||
else | else | ||
-- If an image filename isn't specified explicitly in the banner config, | -- If an image filename isn't specified explicitly in the banner config, | ||
Line 659: | Line 707: | ||
local action = protectionObj.action | local action = protectionObj.action | ||
local level = protectionObj.level | local level = protectionObj.level | ||
local namespace = protectionObj.title.namespace | local namespace = protectionObj.title.namespace | ||
local reason = protectionObj.reason | |||
-- Deal with special cases first. | -- Deal with special cases first. | ||
if (namespace == 10 or namespace == 828) | if ( | ||
namespace == 10 | |||
or namespace == 828 | |||
or reason and obj._cfg.indefImageReasons[reason] | |||
) | |||
and action == 'edit' | and action == 'edit' | ||
and level == 'sysop' | and level == 'sysop' | ||
and not | and not protectionObj:isTemporary() | ||
then | then | ||
-- Fully protected modules and templates get the special red "indef" | -- Fully protected modules and templates get the special red "indef" | ||
-- padlock. | -- padlock. | ||
obj._imageFilename = obj._cfg.msg['image-filename-indef'] | |||
else | else | ||
-- Deal with regular protection types. | -- Deal with regular protection types. | ||
local images = | local images = obj._cfg.images | ||
if images[action] then | if images[action] then | ||
if images[action][level] then | if images[action][level] then | ||
obj._imageFilename = images[action][level] | |||
elseif images[action].default then | elseif images[action].default then | ||
obj._imageFilename = images[action].default | |||
end | end | ||
end | end | ||
end | end | ||
end | end | ||
return setmetatable(obj, BannerTemplate) | |||
end | end | ||
Line 697: | Line 742: | ||
or self._cfg.msg['image-filename-default'] | or self._cfg.msg['image-filename-default'] | ||
or 'Transparent.gif' | or 'Transparent.gif' | ||
return | return makeFileLink{ | ||
file = filename, | |||
size = (self.imageWidth or 20) .. 'px', | |||
alt = self._imageAlt, | |||
link = self._imageLink, | |||
caption = self.imageCaption | |||
} | |||
end | end | ||
Line 709: | Line 755: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local Banner = BannerTemplate | local Banner = setmetatable({}, BannerTemplate) | ||
Banner.__index = Banner | |||
function Banner | function Banner.new(protectionObj, blurbObj, cfg) | ||
BannerTemplate. | local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. | ||
obj.imageWidth = 40 | |||
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip. | |||
obj._reasonText = blurbObj:makeBannerText('text') | |||
obj._explanationText = blurbObj:makeBannerText('explanation') | |||
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing. | |||
return setmetatable(obj, Banner) | |||
end | end | ||
Line 723: | Line 771: | ||
-- Renders the banner. | -- Renders the banner. | ||
makeMessageBox = makeMessageBox or require('Module:Message box').main | makeMessageBox = makeMessageBox or require('Module:Message box').main | ||
local reasonText = self._reasonText or error('no reason text set') | local reasonText = self._reasonText or error('no reason text set', 2) | ||
local explanationText = self._explanationText | local explanationText = self._explanationText | ||
local mbargs = { | local mbargs = { | ||
Line 742: | Line 790: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local Padlock = BannerTemplate | local Padlock = setmetatable({}, BannerTemplate) | ||
Padlock.__index = Padlock | |||
function Padlock | function Padlock.new(protectionObj, blurbObj, cfg) | ||
BannerTemplate. | local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb. | ||
obj.imageWidth = 20 | |||
obj.imageCaption = blurbObj:makeBannerText('tooltip') | |||
obj._imageAlt = blurbObj:makeBannerText('alt') | |||
obj._imageLink = blurbObj:makeBannerText('link') | |||
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action] | |||
or cfg. | or cfg.padlockIndicatorNames.default | ||
or ' | or 'pp-default' | ||
return setmetatable(obj, Padlock) | |||
end | end | ||
function Padlock:__tostring() | function Padlock:__tostring() | ||
local | local frame = mw.getCurrentFrame() | ||
-- The nowiki tag helps prevent whitespace at the top of articles. | |||
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{ | |||
name = 'indicator', | |||
args = {name = self._indicatorName}, | |||
content = self:renderImage() | |||
} | |||
end | end | ||
Line 784: | Line 834: | ||
function p._main(args, cfg, title) | function p._main(args, cfg, title) | ||
args = args or {} | args = args or {} | ||
cfg = cfg or require( | cfg = cfg or require(CONFIG_MODULE) | ||
local protectionObj = Protection.new(args, cfg, title) | |||
local | |||
local ret = {} | local ret = {} | ||
-- Render the banner | -- If a page's edit protection is equally or more restrictive than its | ||
-- protection from some other action, then don't bother displaying anything | |||
-- for the other action (except categories). | |||
if protectionObj.action == 'edit' or | |||
args.demolevel or | |||
not getReachableNodes( | |||
cfg.hierarchy, | |||
protectionObj.level | |||
)[effectiveProtectionLevel('edit', protectionObj.title)] | |||
then | |||
-- Initialise the blurb object | |||
local blurbObj = Blurb.new(protectionObj, args, cfg) | |||
-- Render the banner | |||
if protectionObj:shouldShowLock() then | |||
ret[#ret + 1] = tostring( | |||
(yesno(args.small) and Padlock or Banner) | |||
.new(protectionObj, blurbObj, cfg) | |||
) | |||
end | |||
end | end | ||
-- Render the categories | -- Render the categories | ||
if yesno(args.category) ~= false then | if yesno(args.category) ~= false then | ||
Line 827: | Line 871: | ||
function p.main(frame, cfg) | function p.main(frame, cfg) | ||
cfg = cfg or require(CONFIG_MODULE) | |||
-- Find default args, if any. | |||
local parent = frame.getParent and frame:getParent() | |||
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')] | |||
-- Find user args, and use the parent frame if we are being called from a | |||
-- wrapper template. | |||
getArgs = getArgs or require('Module:Arguments').getArgs | getArgs = getArgs or require('Module:Arguments').getArgs | ||
local userArgs = getArgs(frame, { | |||
parentOnly = defaultArgs, | |||
frameOnly = not defaultArgs | |||
local | }) | ||
for k, v in pairs( | -- Build the args table. User-specified args overwrite default args. | ||
local args = {} | |||
for k, v in pairs(defaultArgs or {}) do | |||
args[k] = v | |||
end | |||
for k, v in pairs(userArgs) do | |||
args[k] = v | args[k] = v | ||
end | end |