CivWiki

Module:Protection banner: Difference between revisions

Module Discussion

Module:Protection banner (view source)

Revision as of 18:14, 5 May 2021

1,199 bytes added ,  3 years ago
m
1 revision imported from wikipedia:Module:Protection_banner
(Protection:makeProtectionCategory - return a blank string on no match)
m (1 revision imported from wikipedia:Module:Protection_banner)
 
(46 intermediate revisions by 12 users not shown)
Line 4:
-- Initialise necessary modules.
require('Module:No globals')
local classmakeFileLink = require('Module:MiddleclassFile link').class_main
local newFileLink = require('Module:File link').new
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')
 
-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang
 
-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'
 
--------------------------------------------------------------------------------
Line 16 ⟶ 19:
--------------------------------------------------------------------------------
 
local function makeCategoryLink(cat, sort)
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat,
sort
)
else
return ''
end
end
Line 30 ⟶ 32:
-- Validation function for the expiry and the protection date
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)
if success then
Line 39 ⟶ 43:
end
error(string.format(
'invalid %s: ("%s")',
dateType,
tostring(dateString)
), 04)
end
 
Line 53 ⟶ 57:
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
 
Line 63 ⟶ 82:
--------------------------------------------------------------------------------
 
local Protection = class('Protection'){}
Protection.__index = Protection
 
Protection.supportedActions = {
edit = true,
move = true,
autoreview = true,
upload = true
}
 
Line 80 ⟶ 101:
}
 
function Protection:initialize.new(args, cfg, title)
self._cfglocal obj = cfg{}
obj._cfg = cfg
self.title = title or mw.title.getCurrentTitle()
obj.title = title or mw.title.getCurrentTitle()
 
-- Set action
if not args.action then
selfobj.action = 'edit'
elseif selfProtection.supportedActions[args.action] then
selfobj.action = args.action
else
error(string.format(
'invalid action: ("%s")',
tostring(args.action)
), 03)
end
 
-- Set level
selfobj.level = args.demolevel or effectiveProtectionLevel(selfobj.action, selfobj.title)
if selfnot obj.level or (obj.action == 'move' and obj.level == 'accountcreatorautoconfirmed') then
-- Lump titleblacklisted pages in with template-protected pages,
-- since templateeditors can do both.
self.level = 'templateeditor'
elseif not self.level or (self.action == 'move' and self.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
selfobj.level = '*'
end
 
-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if args.expiry then
if cfg.indefStrings[args.expiry]effectiveExpiry == 'infinity' then
selfobj.expiry = 'indef'
elseif type(args.expiry)effectiveExpiry =~= 'numberunknown' then
selfobj.expiry = args.validateDate(effectiveExpiry, 'expiry date')
else
self.expiry = validateDate(args.expiry, 'expiry date')
end
end
 
-- Set reason
if args[1] then
selfobj.reason = mw.ustring.lower(args[1])
if selfobj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 03)
end
end
Line 129 ⟶ 144:
-- Set protection date
if args.date then
selfobj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
selfobj.bannerConfig = {}
local configTables = {}
if cfg.banners[selfobj.action] then
configTables[#configTables + 1] = cfg.banners[selfobj.action][selfobj.reason]
end
if cfg.defaultBanners[selfobj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action][selfobj.level]
configTables[#configTables + 1] = cfg.defaultBanners[selfobj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(selfProtection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
selfobj.bannerConfig[field] = t[field]
break
end
Line 153 ⟶ 168:
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
 
function Protection:isProtected()
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
 
function Protection:makeProtectionCategory()
if not self:shouldHaveProtectionCategory() then
return ''
end
 
local cfg = self._cfg
local title = self.title
-- Exit if the page is not protected.
if not self:isProtected() then
return ''
end
-- Get the expiry key fragment.
Line 177 ⟶ 212:
 
-- Get the namespace key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
if not namespaceFragment and title.namespace % 2 == 1 then
do
namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]'talk'
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
-- array of tables containing the value to be tested, along with its
Line 207 ⟶ 239:
-- instead.
--]]
iftable.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] thenand 2 or 3))
-- table.insert(order, 3, table.remove(order, 2))
toTableEnd(order, 2)
else
toTableEnd(order, 3)
end
--[[
Line 289 ⟶ 316:
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
return ''
end
 
function Protection:needsExpiry()
local cfg = self._cfg
return not self.expiry
and cfg.expiryCheckActions[self.action]
and self.reason -- the old {{pp-protected}} didn't check for expiry
and not cfg.reasonsWithoutExpiryCheck[self.reason]
end
 
function Protection:isIncorrect()
local expiry = self.expiry
return not self:isProtectedshouldHaveProtectionCategory()
or type(expiry) == 'number' and expiry < os.time()
end
Line 320 ⟶ 339:
function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local ret = { self:makeProtectionCategory() }
if self:needsExpiry() then
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-expiry'])
end
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-incorrect'])
msg['tracking-category-incorrect'],
self.title.text
)
end
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink(msg['tracking-category-template'])
msg['tracking-category-template'],
self.title.text
)
end
return table.concat(ret)
Line 337 ⟶ 359:
--------------------------------------------------------------------------------
 
local Blurb = class('Blurb'){}
Blurb.__index = Blurb
 
Blurb.bannerTextFields = {
Line 347 ⟶ 370:
}
 
function Blurb:initialize.new(protectionObj, args, cfg)
return setmetatable({
self._cfg = cfg
_cfg = cfg,
self._protectionObj = protectionObj
_protectionObj = protectionObj,
self._args = args
_args = args
}, Blurb)
end
 
Line 378 ⟶ 403:
 
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter
parameterFuncs.DISPUTEBLURB = self._makeDisputeBlurbParameter
parameterFuncs.DISPUTESECTION = self._makeDisputeSectionParameter
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter
parameterFuncs.EXPIRY = self._makeExpiryParameter
Line 385 ⟶ 408:
parameterFuncs.IMAGELINK = self._makeImageLinkParameter
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter
parameterFuncs.OFFICEBLURB INTROFRAGMENT = self._makeOfficeBlurbParameter_makeIntroFragmentParameter
parameterFuncs.PAGETYPE = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter
Line 391 ⟶ 414:
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter
parameterFuncs.RESETBLURB = self._makeResetBlurbParameter
parameterFuncs.TALKPAGE = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL = self._makeVandalTemplateParameter
Line 438 ⟶ 461:
local action = self._protectionObj.action
local level = self._protectionObj.level
-- Get the display message key.
local key
if action == 'edit' and level == 'autoconfirmed' then
key = 'edit-request-semi-display'
else
key = 'edit-request-full-display'
end
local display = self:_getExpandedMessage(key)
-- Get the edit request type.
Line 453 ⟶ 467:
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
Line 459 ⟶ 475:
requestType = requestType or 'full'
-- Get the display value.
return mEditRequest.exportLinkToLua{type = requestType, display = display}
local display = self:_getExpandedMessage('edit-request-display')
 
return mEditRequest._link{type = requestType, display = display}
end
 
Line 501 ⟶ 520:
level,
talkKey
), 8)
end
return self:_substituteParameters(msg)
Line 522 ⟶ 541:
 
function Blurb:_makeIntroBlurbParameter()
if type(self._protectionObj.expiry:isTemporary() == 'number' then
return self:_getExpandedMessage('intro-blurb-expiry')
else
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
Line 533 ⟶ 560:
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end
 
Line 548 ⟶ 575:
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
Line 574 ⟶ 601:
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
Line 609 ⟶ 636:
 
function Blurb:_makeTooltipBlurbParameter()
if type(self._protectionObj.expiry:isTemporary() == 'number' then
return self:_getExpandedMessage('tooltip-blurb-expiry')
else
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
 
function Blurb:_makeVandalTemplateParameter()
return mw.getCurrentFrame():expandTemplate{
return require('Module:Vandal-m')._main{
title="vandal-m",
self._args.user or self._protectionObj.title.baseText
args={self._args.user or self._protectionObj.title.baseText}
}
end
Line 645 ⟶ 681:
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
Line 655 ⟶ 691:
--------------------------------------------------------------------------------
 
local BannerTemplate = class('BannerTemplate'){}
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate:initialize.new(protectionObj, cfg)
self._cfglocal obj = cfg{}
obj._cfg = cfg
 
-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
selfobj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
Line 669 ⟶ 707:
local action = protectionObj.action
local level = protectionObj.level
local expiry = protectionObj.expiry
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason
-- 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 level == 'sysop'
and not expiryprotectionObj:isTemporary()
then
-- Fully protected modules and templates get the special red "indef"
-- padlock.
selfobj._imageFilename = selfobj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = selfobj._cfg.images
if images[action] then
if images[action][level] then
selfobj._imageFilename = images[action][level]
elseif images[action].default then
selfobj._imageFilename = images[action].default
end
end
end
end
return setmetatable(obj, BannerTemplate)
end
 
function BannerTemplate:setImageWidth(width)
self._imageWidth = width
end
 
function BannerTemplate:setImageTooltip(tooltip)
self._imageCaption = tooltip
end
 
Line 707 ⟶ 742:
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return newFileLink(filename)makeFileLink{
file = filename,
:width(self._imageWidth or 20)
:altsize = (self._imageAltimageWidth or 20) .. 'px',
:link(alt = self._imageLink)_imageAlt,
:caption(link = self._imageCaption)_imageLink,
caption = self.imageCaption
:render()
}
end
 
Line 719 ⟶ 755:
--------------------------------------------------------------------------------
 
local Banner = BannerTemplate:subclasssetmetatable('Banner'{}, BannerTemplate)
Banner.__index = Banner
 
function Banner:initialize.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.initializenew(self, protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 40
self:setImageWidth(40)
self:setImageTooltip(obj.imageCaption = blurbObj:makeBannerText('alt')) -- Large banners use the alt text for the tooltip.
selfobj._reasonText = blurbObj:makeBannerText('text')
selfobj._explanationText = blurbObj:makeBannerText('explanation')
selfobj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
return setmetatable(obj, Banner)
end
 
Line 733 ⟶ 771:
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local mbargs = {
Line 752 ⟶ 790:
--------------------------------------------------------------------------------
 
local Padlock = BannerTemplate:subclasssetmetatable('Padlock'{}, BannerTemplate)
Padlock.__index = Padlock
 
function Padlock:initialize.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.initializenew(self, protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
self:setImageWidth(20)
self:setImageTooltip(obj.imageCaption = blurbObj:makeBannerText('tooltip'))
selfobj._imageAlt = blurbObj:makeBannerText('alt')
selfobj._imageLink = blurbObj:makeBannerText('link')
selfobj._right_indicatorName = cfg.padlockPositionspadlockIndicatorNames[protectionObj.action]
or cfg.padlockPositionspadlockIndicatorNames.default
or '55pxpp-default'
return setmetatable(obj, Padlock)
end
 
function Padlock:__tostring()
local rootframe = mw.html.creategetCurrentFrame('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')
:css{displayargs = 'none', right{name = self._right_indicatorName},
:wikitext(content = self:renderImage())
}
return tostring(root)
end
 
Line 794 ⟶ 834:
function p._main(args, cfg, title)
args = args or {}
cfg = cfg or require('Module:Protection banner/config'CONFIG_MODULE)
 
local protectionObj = Protection.new(args, cfg, title)
-- Initialise the protection object and check for errors
local protectionObjCreated, protectionObj = pcall(
Protection.new, Protection, -- equivalent to 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'])
)
end
-- Initialise the blurb object
local blurbObj = Blurb:new(protectionObj, args, cfg)
 
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:shouldShowLock() then
ret[#ret + 1] = tostring(
(yesno(args.small) and Padlock or Banner)
.new(protectionObj, blurbObj, cfg)
)
end
end
 
-- Render the categories
if yesno(args.category) ~= false then
Line 837 ⟶ 871:
 
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
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
end
Retrieved from "https://civwiki.org/wiki/Special:MobileDiff/23468...29206"