Editing Module:Protection banner

From MINR.ORG WIKI

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 4: Line 4:
 
-- Initialise necessary modules.
 
-- Initialise necessary modules.
 
require('Module:No globals')
 
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
+
local newFileLink = require('Module:File link').new
 
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 20: Line 16:
  
 
local function makeCategoryLink(cat, sort)
 
local function makeCategoryLink(cat, sort)
if cat then
+
local nsText = mw.site.namespaces[14].name
 +
if cat and sort then
 
return string.format(
 
return string.format(
 
'[[%s:%s|%s]]',
 
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
+
nsText,
 
cat,
 
cat,
 
sort
 
sort
 
)
 
)
 +
elseif cat then
 +
return string.format(
 +
'[[%s:%s]]',
 +
nsText,
 +
cat
 +
)
 +
else
 +
return ''
 
end
 
end
 
end
 
end
Line 32: Line 37:
 
-- 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)
if not lang then
+
lang = lang or mw.language.getContentLanguage()
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 43: Line 46:
 
end
 
end
 
error(string.format(
 
error(string.format(
'invalid %s: %s',
+
'invalid %s ("%s")',
 
dateType,
 
dateType,
 
tostring(dateString)
 
tostring(dateString)
), 4)
+
), 0)
 
end
 
end
  
Line 57: Line 60:
 
end
 
end
  
-- Given a directed graph formatted as node -> table of direct successors,
+
local function toTableEnd(t, pos)
-- get a table of all nodes reachable from a given node (though always
+
-- Sends the value at position pos to the end of array t, and shifts the
-- including the given node).
+
-- other items down accordingly.
local function getReachableNodes(graph, start)
+
return table.insert(t, table.remove(t, pos))
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 88: Line 76:
 
edit = true,
 
edit = true,
 
move = true,
 
move = true,
autoreview = true,
+
autoreview = true
upload = true
 
 
}
 
}
  
Line 113: Line 100:
 
else
 
else
 
error(string.format(
 
error(string.format(
'invalid action: %s',
+
'invalid action ("%s")',
 
tostring(args.action)
 
tostring(args.action)
), 3)
+
), 0)
 
end
 
end
  
 
-- Set level
 
-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
+
obj.level = effectiveProtectionLevel(obj.action, obj.title)
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
+
if obj.level == 'accountcreator' then
 +
-- Lump titleblacklisted pages in with template-protected pages,
 +
-- since templateeditors can do both.
 +
obj.level = 'templateeditor'
 +
elseif 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.
Line 127: Line 118:
  
 
-- Set expiry
 
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
+
if args.expiry then
if effectiveExpiry == 'infinity' then
+
if cfg.indefStrings[args.expiry] then
obj.expiry = 'indef'
+
obj.expiry = 'indef'
elseif effectiveExpiry ~= 'unknown' then
+
elseif type(args.expiry) == 'number' then
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
+
obj.expiry = args.expiry
 +
else
 +
obj.expiry = validateDate(args.expiry, 'expiry date')
 +
end
 
end
 
end
  
Line 138: Line 132:
 
obj.reason = mw.ustring.lower(args[1])
 
obj.reason = mw.ustring.lower(args[1])
 
if obj.reason:find('|') then
 
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
+
error('reasons cannot contain the pipe character ("|")', 0)
 
end
 
end
 
end
 
end
Line 197: Line 191:
  
 
-- Get the namespace key fragment.
 
-- Get the namespace key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
+
local namespaceFragment
if not namespaceFragment and title.namespace % 2 == 1 then
+
do
namespaceFragment = 'talk'
+
namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
 +
if not namespaceFragment and title.namespace % 2 == 1 then
 +
namespaceFragment = 'talk'
 +
end
 
end
 
end
 
   
 
   
Line 224: Line 221:
 
-- instead.
 
-- instead.
 
--]]
 
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
+
if self.reason and cfg.reasonsWithNamespacePriority[self.reason] then
 +
-- table.insert(order, 3, table.remove(order, 2))
 +
toTableEnd(order, 2)
 +
else
 +
toTableEnd(order, 3)
 +
end
 
   
 
   
 
--[[
 
--[[
Line 305: Line 307:
 
end
 
end
 
return ''
 
return ''
 +
end
 +
 +
function Protection:needsExpiry()
 +
local cfg = self._cfg
 +
local actionNeedsCheck = cfg.expiryCheckActions[self.action]
 +
return not self.expiry and (
 +
actionNeedsCheck or (
 +
actionNeedsCheck == nil
 +
and self.reason -- the old {{pp-protected}} didn't check for expiry
 +
and not cfg.reasonsWithoutExpiryCheck[self.reason]
 +
)
 +
)
 
end
 
end
  
Line 325: Line 339:
 
local msg = self._cfg.msg
 
local msg = self._cfg.msg
 
local ret = { self:makeProtectionCategory() }
 
local ret = { self:makeProtectionCategory() }
 +
if self:needsExpiry() then
 +
ret[#ret + 1] = makeCategoryLink(
 +
msg['tracking-category-expiry'],
 +
self.title.text
 +
)
 +
end
 
if self:isIncorrect() then
 
if self:isIncorrect() then
 
ret[#ret + 1] = makeCategoryLink(
 
ret[#ret + 1] = makeCategoryLink(
Line 401: Line 421:
 
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 452: Line 471:
 
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 505: Line 522:
 
level,
 
level,
 
talkKey
 
talkKey
), 8)
+
))
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 545: Line 562:
 
return pagetypes[self._protectionObj.title.namespace]
 
return pagetypes[self._protectionObj.title.namespace]
 
or pagetypes.default
 
or pagetypes.default
or error('no default pagetype defined', 8)
+
or error('no default pagetype defined')
 
end
 
end
  
Line 560: Line 577:
 
msg = protectionBlurbs.edit.default
 
msg = protectionBlurbs.edit.default
 
else
 
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
+
error('no protection blurb defined for protectionBlurbs.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 586: Line 603:
 
msg = protectionLevels.edit.default
 
msg = protectionLevels.edit.default
 
else
 
else
error('no protection level defined for protectionLevels.edit.default', 8)
+
error('no protection level defined for protectionLevels.edit.default')
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 625: Line 642:
 
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
Line 665: Line 674:
 
tostring(key),
 
tostring(key),
 
type(msg)
 
type(msg)
), 4)
+
))
 
end
 
end
 
return self:_substituteParameters(msg)
 
return self:_substituteParameters(msg)
Line 692: Line 701:
 
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 (
+
if (namespace == 10 or namespace == 828)
namespace == 10
 
or namespace == 828
 
or reason and obj._cfg.indefImageReasons[reason]
 
)
 
 
and action == 'edit'
 
and action == 'edit'
 
and level == 'sysop'
 
and level == 'sysop'
Line 720: Line 724:
 
end
 
end
 
return setmetatable(obj, BannerTemplate)
 
return setmetatable(obj, BannerTemplate)
 +
end
 +
 +
function BannerTemplate:setImageWidth(width)
 +
self._imageWidth = width
 +
end
 +
 +
function BannerTemplate:setImageTooltip(tooltip)
 +
self._imageCaption = tooltip
 
end
 
end
  
Line 726: Line 738:
 
or self._cfg.msg['image-filename-default']
 
or self._cfg.msg['image-filename-default']
 
or 'Transparent.gif'
 
or 'Transparent.gif'
return makeFileLink{
+
return newFileLink(filename)
file = filename,
+
:width(self._imageWidth or 20)
size = (self.imageWidth or 20) .. 'px',
+
:alt(self._imageAlt)
alt = self._imageAlt,
+
:link(self._imageLink)
link = self._imageLink,
+
:caption(self._imageCaption)
caption = self.imageCaption
+
:render()
}
 
 
end
 
end
  
Line 744: Line 755:
 
function Banner.new(protectionObj, blurbObj, cfg)
 
function Banner.new(protectionObj, blurbObj, cfg)
 
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
 
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 40
+
obj:setImageWidth(40)
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
+
obj:setImageTooltip(blurbObj:makeBannerText('alt')) -- Large banners use the alt text for the tooltip.
 
obj._reasonText = blurbObj:makeBannerText('text')
 
obj._reasonText = blurbObj:makeBannerText('text')
 
obj._explanationText = blurbObj:makeBannerText('explanation')
 
obj._explanationText = blurbObj:makeBannerText('explanation')
Line 755: Line 766:
 
-- 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', 2)
+
local reasonText = self._reasonText or error('no reason text set')
 
local explanationText = self._explanationText
 
local explanationText = self._explanationText
 
local mbargs = {
 
local mbargs = {
Line 779: Line 790:
 
function Padlock.new(protectionObj, blurbObj, cfg)
 
function Padlock.new(protectionObj, blurbObj, cfg)
 
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
 
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
+
obj:setImageWidth(20)
obj.imageCaption = blurbObj:makeBannerText('tooltip')
+
obj:setImageTooltip(blurbObj:makeBannerText('tooltip'))
 
obj._imageAlt = blurbObj:makeBannerText('alt')
 
obj._imageAlt = blurbObj:makeBannerText('alt')
 
obj._imageLink = blurbObj:makeBannerText('link')
 
obj._imageLink = blurbObj:makeBannerText('link')
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
+
obj._right = cfg.padlockPositions[protectionObj.action]
or cfg.padlockIndicatorNames.default
+
or cfg.padlockPositions.default
or 'pp-default'
+
or '55px'
 
return setmetatable(obj, Padlock)
 
return setmetatable(obj, Padlock)
 
end
 
end
  
 
function Padlock:__tostring()
 
function Padlock:__tostring()
local frame = mw.getCurrentFrame()
+
local root = mw.html.create('div')
-- The nowiki tag helps prevent whitespace at the top of articles.
+
root
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
+
:addClass('metadata topicon nopopups')
name = 'indicator',
+
:attr('id', 'protected-icon')
args = {name = self._indicatorName},
+
:css{display = 'none', right = self._right}
content = self:renderImage()
+
:wikitext(self:renderImage())
}
+
return tostring(root)
 
end
 
end
  
Line 818: Line 829:
 
function p._main(args, cfg, title)
 
function p._main(args, cfg, title)
 
args = args or {}
 
args = args or {}
cfg = cfg or require(CONFIG_MODULE)
+
cfg = cfg or require('Module:Protection banner/config')
  
local protectionObj = Protection.new(args, cfg, title)
+
-- Initialise the protection object and check for errors
 +
local protectionObjCreated, protectionObj = pcall(
 +
Protection.new,
 +
args,
 +
cfg,
 +
title
 +
)
 +
if not protectionObjCreated then
 +
local errorBlurb = cfg.msg['error-message-blurb'] or 'Error: $1.'
 +
local errorText = mw.message.newRawMessage(errorBlurb)
 +
:params(protectionObj) -- protectionObj is the error message
 +
:plain()
 +
return string.format(
 +
'<strong class="error">%s</strong>%s',
 +
errorText,
 +
makeCategoryLink(
 +
cfg.msg['tracking-category-incorrect'],
 +
title and title.text or mw.title.getCurrentTitle().text
 +
)
 +
)
 +
end
 +
 +
-- Initialise the blurb object
 +
local blurbObj = Blurb.new(protectionObj, args, cfg)
  
 
local ret = {}
 
local ret = {}
  
-- If a page's edit protection is equally or more restrictive than its
+
-- Render the banner
-- protection from some other action, then don't bother displaying anything
+
if protectionObj:isProtected() then
-- for the other action (except categories).
+
ret[#ret + 1] = tostring(
if protectionObj.action == 'edit' or
+
(yesno(args.small) and Padlock or Banner)
args.demolevel or
+
.new(protectionObj, blurbObj, cfg)
not getReachableNodes(
+
)
cfg.hierarchy,
+
end
protectionObj.level
 
)[effectiveProtectionLevel('edit', protectionObj.title)]
 
then
 
-- Initialise the blurb object
 
local blurbObj = Blurb.new(protectionObj, args, cfg)
 
 
 
-- Render the banner
 
if protectionObj:isProtected() then
 
ret[#ret + 1] = tostring(
 
(yesno(args.small) and Padlock or Banner)
 
.new(protectionObj, blurbObj, cfg)
 
)
 
end
 
end
 
 
 
-- Render the categories
 
-- Render the categories
 
if yesno(args.category) ~= false then
 
if yesno(args.category) ~= false then
Line 855: Line 875:
  
 
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, {
+
cfg = cfg or require('Module:Protection banner/config')
parentOnly = defaultArgs,
+
local parentTitle = frame:getParent():getTitle()
frameOnly = not defaultArgs
+
parentTitle = parentTitle:gsub('/sandbox$', '')
})
+
local defaultArgs = cfg.wrappers[parentTitle] or {}
 
+
local args = getArgs(frame, {parentOnly = defaultArgs and true})
-- Build the args table. User-specified args overwrite default args.
+
for k, v in pairs(defaultArgs) do
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

Please note that all contributions to MINR.ORG WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)