본문문서 역사

모듈:Protection banner 편집하기

귀하는 로그인되어 있지 않습니다. 이대로 편집하면 귀하의 IP 주소가 편집 기록에 남게 됩니다.

편집을 취소할 수 있습니다. 이 편집을 되돌리려면 아래의 바뀐 내용을 확인한 후 게시해주세요.

최신판 당신의 편집
2번째 줄: 2번째 줄:
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.


-- Initialise necessary modules.
local categories = {
require('Module:No globals')
['edit-semi-user-all-all'] = 'Wikipedia semi-protected user and user talk pages',
local makeFileLink = require('Module:File link')._main
['edit-semi-project-all-all'] = 'Semi-protected project pages',
local effectiveProtectionLevel = require('Module:Effective protection level')._main
['edit-semi-file-all-all'] = 'Semi-protected images',
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
['edit-semi-template-all-all'] = 'Wikipedia semi-protected templates',
local yesno = require('Module:Yesno')
['edit-semi-portal-all-all'] = 'Semi-protected portals',
 
['edit-semi-talk-all-all'] = 'Semi-protected talk pages',
-- Lazily initialise modules and objects we don't always need.
['edit-semi-all-vandalism-all'] = 'Wikipedia pages semi-protected against vandalism',
local getArgs, makeMessageBox, lang
['edit-full-user-all-all'] = 'Wikipedia protected user and user talk pages',
 
['edit-full-file-all-all'] = 'Protected images',
-- Set constants.
['edit-full-project-all-all'] = 'Protected project pages',
local CONFIG_MODULE = 'Module:Protection banner/config'
['edit-full-template-all-all'] = 'Wikipedia protected templates',
 
['edit-full-talk-all-all'] = 'Protected talk pages',
--------------------------------------------------------------------------------
['edit-full-all-vandalism-all'] = 'Wikipedia pages protected against vandalism',
-- Helper functions
['edit-semi-all-dispute-all'] = 'Wikipedia pages semi-protected due to dispute',
--------------------------------------------------------------------------------
['edit-full-all-dispute-all'] = 'Wikipedia pages protected due to dispute',
 
['move-full-all-dispute-all'] = 'Wikipedia pages move-protected due to dispute',
local function makeCategoryLink(cat, sort)
['move-full-user-all-all'] = 'Wikipedia move-protected user and user talk pages',
if cat then
['move-full-user-all-all'] = 'Wikipedia move-protected project pages',
return string.format(
['move-full-portal-all-all'] = 'Wikipedia move-protected portals',
'[[%s:%s|%s]]',
['edit-semi-template-all-all'] = 'Wikipedia semi-protected templates',
mw.site.namespaces[14].name,
['move-full-template-all-all'] = 'Wikipedia move-protected templates',
cat,
['edit-all-template-all-all'] = 'Wikipedia protected templates',
sort
['move-full-template-all-all'] = 'Wikipedia move-protected portals',
)
['edit-semi-all-sock-all'] = 'Wikipedia pages semi-protected from banned users',
end
['edit-full-all-sock-all'] = 'Wikipedia pages protected from banned users',
end
['edit-semi-all-blp-temp'] = 'Wikipedia temporarily semi-protected biographies of living people',
['edit-full-all-blp-temp'] = 'Wikipedia temporarily protected biographies of living people',
['edit-semi-all-blp-indef'] = 'Wikipedia indefinitely semi-protected biographies of living people',
['edit-full-all-blp-indef'] = 'Wikipedia indefinitely protected biographies of living people',
['edit-semi-all-all-indef'] = 'Wikipedia indefinitely semi-protected pages',
['move-full-talk-all-all'] = 'Wikipedia move-protected talk pages',
['move-full-all-all-indef'] = 'Wikipedia indefinitely move-protected pages',
['edit-semi-all-all-all'] = 'Wikipedia semi-protected pages',
['all-all-all-all-all'] = 'Wikipedia protected pages',
['edit-semi-category-all-all'] = 'Wikipedia semi-protected categories',
['edit-full-all-all-all'] = 'Wikipedia protected categories',
['move-full-all-all-all'] = 'Wikipedia move-protected pages',
['all-all-all-office-all'] = 'Wikipedia Office-protected pages',
['pc-semi-all-all-all'] = 'Wikipedia pending changes protected pages (level 1)',
['pc-reviewer-all-all-all'] = 'Wikipedia pending changes protected pages (level 2)',
}


-- Validation function for the expiry and the protection date
local nskeys = {
local function validateDate(dateString, dateType)
[2] = 'user',
if not lang then
[3] = 'user',
lang = mw.language.getContentLanguage()
[4] = 'project',
end
[6] = 'file',
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
[10] = 'template',
if success then
[12] = 'project',
result = tonumber(result)
[14] = 'category',
if result then
[100] = 'portal',
return result
end
end
error(string.format(
'invalid %s: %s',
dateType,
tostring(dateString)
), 4)
end
 
local function makeFullUrl(page, query, display)
return string.format(
'[%s %s]',
tostring(mw.uri.fullUrl(page, query)),
display
)
end
 
-- 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
 
--------------------------------------------------------------------------------
-- Protection class
--------------------------------------------------------------------------------
 
local Protection = {}
Protection.__index = Protection
 
Protection.supportedActions = {
edit = true,
move = true,
autoreview = true,
upload = true
}
}


Protection.bannerConfigFields = {
local error_categories = {
'text',
incorrect = 'Wikipedia pages with incorrect protection templates',
'explanation',
no_expiry = 'Wikipedia protected pages without expiry',
'tooltip',
create = 'Wikipedia pages tagged as create-protected',
'alt',
template = 'Wikipedia template-protected pages other than templates and modules'
'link',
'image'
}
}


function Protection.new(args, cfg, title)
local template_types = {
local obj = {}
vandalism = {
obj._cfg = cfg
namespaces = false, -- defaults to all namespaces
obj.title = title or mw.title.getCurrentTitle()
editLevels = false, -- all edit protection levels
 
moveLevels = false, -- all move protection levels
-- Set action
createLevels = false, -- all create protection levels
if not args.action then
header = false,
obj.action = 'edit'
reason = 'due to [[Wikipedia:Vandalism|vandalism]]',
elseif Protection.supportedActions[args.action] then
icon_reason = 'due to vandalism',
obj.action = args.action
else
error(string.format(
'invalid action: %s',
tostring(args.action)
), 3)
end
 
-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
obj.level = '*'
end
 
-- 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
 
-- Set reason
if args[1] then
obj.reason = mw.ustring.lower(args[1])
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
end
end
 
-- Set protection date
if args.date then
obj.protectionDate = validateDate(args.date, 'protection date')
end
-- Set banner config
do
obj.bannerConfig = {}
local configTables = {}
if cfg.banners[obj.action] then
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
end
if cfg.defaultBanners[obj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(Protection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
obj.bannerConfig[field] = t[field]
break
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
 
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
-- Get the expiry key fragment.
local expiryFragment
if self.expiry == 'indef' then
expiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
end
 
-- Get the namespace key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
if not namespaceFragment and title.namespace % 2 == 1 then
namespaceFragment = 'talk'
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
-- position in the cfg.protectionCategories table.
local order = {
{val = expiryFragment,    keypos = 1},
{val = namespaceFragment, keypos = 2},
{val = self.reason,      keypos = 3},
{val = self.level,        keypos = 4},
{val = self.action,      keypos = 5}
}
}
 
}
--[[
-- The old protection templates used an ad-hoc protection category system,
-- with some templates prioritising namespaces in their categories, and
-- others prioritising the protection reason. To emulate this in this module
-- we use the config table cfg.reasonsWithNamespacePriority to set the
-- reasons for which namespaces have priority over protection reason.
-- If we are dealing with one of those reasons, move the namespace table to
-- the end of the order table, i.e. give it highest priority. If not, the
-- reason should have highest priority, so move that to the end of the table
-- instead.
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))
--[[
-- Define the attempt order. Inactive subtables (subtables with nil "value"
-- fields) are moved to the end, where they will later be given the key
-- "all". This is to cut down on the number of table lookups in
-- cfg.protectionCategories, which grows exponentially with the number of
-- non-nil keys. We keep track of the number of active subtables with the
-- noActive parameter.
--]]
local noActive, attemptOrder
do
local active, inactive = {}, {}
for i, t in ipairs(order) do
if t.val then
active[#active + 1] = t
else
inactive[#inactive + 1] = t
end
end
noActive = #active
attemptOrder = active
for i, t in ipairs(inactive) do
attemptOrder[#attemptOrder + 1] = t
end
end
--[[
-- Check increasingly generic key combinations until we find a match. If a
-- specific category exists for the combination of key fragments we are
-- given, that match will be found first. If not, we keep trying different
-- key fragment combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the key subtables using a binary matrix
-- with indexes i and j. j is only calculated up to the number of active
-- subtables. For example, if there were three active subtables, the matrix
-- would look like this, with 0 corresponding to the key fragment "all", and
-- 1 corresponding to other key fragments.
--
--  j 1  2  3
-- i 
-- 1  1  1  1
-- 2  0  1  1
-- 3  1  0  1
-- 4  0  0  1
-- 5  1  1  0
-- 6  0  1  0
-- 7  1  0  0
-- 8  0  0  0
--
-- Values of j higher than the number of active subtables are set
-- to the string "all".
--
-- A key for cfg.protectionCategories is constructed for each value of i.
-- The position of the value in the key is determined by the keypos field in
-- each subtable.
--]]
local cats = cfg.protectionCategories
for i = 1, 2^noActive do
local key = {}
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.keypos] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.keypos] = t.val
else
key[t.keypos] = 'all'
end
end
end
key = table.concat(key, '|')
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
return ''
end
 
function Protection:isIncorrect()
local expiry = self.expiry
return not self:shouldHaveProtectionCategory()
or type(expiry) == 'number' and expiry < os.time()
end
 
function Protection:isTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
return self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end
 
function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local ret = {self:makeProtectionCategory()}
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-incorrect'],
self.title.text
)
end
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-template'],
self.title.text
)
end
return table.concat(ret)
end


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Blurb class
-- Main functions
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local Blurb = {}
local getArgs = require('Module:Arguments').getArgs
Blurb.__index = Blurb
local yesno = require('Module:Yesno')


Blurb.bannerTextFields = {
local p = {}
text = true,
explanation = true,
tooltip = true,
alt = true,
link = true
}


function Blurb.new(protectionObj, args, cfg)
function p.main(frame)
return setmetatable({
-- Get data
_cfg = cfg,
local args = getArgs(frame)
_protectionObj = protectionObj,
local title = p.getTitle(args.page)
_args = args
local protType, protLevel = p.getProtectionStatus(title)
}, Blurb)
local namespace = p.getNamespace(title)
end
local expiry = p.getExpiry(args.expiry)
local reason = p.getReason(args.reason)


-- Private methods --
-- Sort categories and build a category link with the best match
categories = p.sortCategories(categories, protType, protLevel, namespace, expiry, reason)
local category = categories[1].name
category = string.format('[[Category:%s]]', category)


function Blurb:_formatDate(num)
-- Find whether we are small or not and output a padlock or a banner as appropriate
-- Formats a Unix timestamp into dd Month, YYYY format.
local isSmall = yesno(args.small, true)
lang = lang or mw.language.getContentLanguage()
if isSmall then
local success, date = pcall(
return p.exportPadlock()
lang.formatDate,
else
lang,
return p.exportBanner()
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
if success then
return date
end
end
end
end


function Blurb:_getExpandedMessage(msgKey)
function p.parseNamespace(ns)
return self:_substituteParameters(self._cfg.msg[msgKey])
-- The ns variable is the namespace number.
end
if not ns or type(ns) ~= 'number' then
 
return 'all'
function Blurb:_substituteParameters(msg)
if not self._params then
local parameterFuncs = {}
 
parameterFuncs.CURRENTVERSION    = self._makeCurrentVersionParameter
parameterFuncs.EDITREQUEST        = self._makeEditRequestParameter
parameterFuncs.EXPIRY            = self._makeExpiryParameter
parameterFuncs.EXPLANATIONBLURB  = self._makeExplanationBlurbParameter
parameterFuncs.IMAGELINK          = self._makeImageLinkParameter
parameterFuncs.INTROBLURB        = self._makeIntroBlurbParameter
parameterFuncs.INTROFRAGMENT      = self._makeIntroFragmentParameter
parameterFuncs.PAGETYPE          = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB    = self._makeProtectionBlurbParameter
parameterFuncs.PROTECTIONDATE    = self._makeProtectionDateParameter
parameterFuncs.PROTECTIONLEVEL    = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG      = self._makeProtectionLogParameter
parameterFuncs.TALKPAGE          = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB      = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT    = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL            = self._makeVandalTemplateParameter
self._params = setmetatable({}, {
__index = function (t, k)
local param
if parameterFuncs[k] then
param = parameterFuncs[k](self)
end
param = param or ''
t[k] = param
return param
end
})
end
end
local nskey = nskeys[ns]
msg = msg:gsub('${(%u+)}', self._params)
if not nskey and ns % 2 == 1 then
return msg
nskey = 'talk'
end
elseif not nskey then
 
nskey = 'all'
function Blurb:_makeCurrentVersionParameter()
-- A link to the page history or the move log, depending on the kind of
-- protection.
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
-- We need the move log link.
return makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
self:_getExpandedMessage('current-version-move-display')
)
else
-- We need the history link.
return makeFullUrl(
pagename,
{action = 'history'},
self:_getExpandedMessage('current-version-edit-display')
)
end
end
return nskey
end
end


function Blurb:_makeEditRequestParameter()
function p.getCategoryName(cats, protType, protLevel, namespace, reason, expiry)
local mEditRequest = require('Module:Submit an edit request')
-- Preprocess parameters
local action = self._protectionObj.action
cats = cats or categories
local level = self._protectionObj.level
protType = protType or 'all'
protLevel = protLevel or 'all'
-- Get the edit request type.
namespace = p.parseNamespace(namespace)
local requestType
reason = reason or 'all'
if action == 'edit' then
if not expiry then
if level == 'autoconfirmed' then
expiry = 'all'
requestType = 'semi'
elseif expiry ~= 'indef' then
elseif level == 'extendedconfirmed' then
expiry = 'temp'
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
end
end
end
requestType = requestType or 'full'
-- Get the display value.
-- Define the key table and the order to test it in
local display = self:_getExpandedMessage('edit-request-display')
local keyTable = {protType, protLevel, namespace, reason, expiry}
 
local tryOrder
return mEditRequest._link{type = requestType, display = display}
if reason == 'vandalism' then
end
tryOrder = {5, 4, 3, 2, 1}
 
function Blurb:_makeExpiryParameter()
local expiry = self._protectionObj.expiry
if type(expiry) == 'number' then
return self:_formatDate(expiry)
else
else
return expiry
tryOrder = {5, 3, 4, 2, 1}
end
end
end
 
-- Try successively generic matches until we run out of key combinations
function Blurb:_makeExplanationBlurbParameter()
local function attemptMatch()
-- Cover special cases first.
local key = table.concat(keyTable, '-')
if self._protectionObj.title.namespace == 8 then
return cats[key]
-- MediaWiki namespace
return self:_getExpandedMessage('explanation-blurb-nounprotect')
end
end
 
local attempt = attemptMatch()
-- Get explanation blurb table keys
if attempt then
local action = self._protectionObj.action
return attempt
local level = self._protectionObj.level
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'
 
-- Find the message in the explanation blurb table and substitute any
-- parameters.
local explanations = self._cfg.explanationBlurbs
local msg
if explanations[action][level] and explanations[action][level][talkKey] then
msg = explanations[action][level][talkKey]
elseif explanations[action][level] and explanations[action][level].default then
msg = explanations[action][level].default
elseif explanations[action].default and explanations[action].default[talkKey] then
msg = explanations[action].default[talkKey]
elseif explanations[action].default and explanations[action].default.default then
msg = explanations[action].default.default
else
error(string.format(
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
end
return self:_substituteParameters(msg)
for i, keyTableKey in ipairs(tryOrder) do
end
keyTable[keyTableKey] = 'all'
 
attempt = attemptMatch()
function Blurb:_makeImageLinkParameter()
if attempt then
local imageLinks = self._cfg.imageLinks
return attempt
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if imageLinks[action][level] then
msg = imageLinks[action][level]
elseif imageLinks[action].default then
msg = imageLinks[action].default
else
msg = imageLinks.edit.default
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() 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
 
function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end
 
function Blurb:_makeProtectionBlurbParameter()
local protectionBlurbs = self._cfg.protectionBlurbs
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionBlurbs[action][level] then
msg = protectionBlurbs[action][level]
elseif protectionBlurbs[action].default then
msg = protectionBlurbs[action].default
elseif protectionBlurbs.edit.default then
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeProtectionDateParameter()
local protectionDate = self._protectionObj.protectionDate
if type(protectionDate) == 'number' then
return self:_formatDate(protectionDate)
else
return protectionDate
end
end
 
function Blurb:_makeProtectionLevelParameter()
local protectionLevels = self._cfg.protectionLevels
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionLevels[action][level] then
msg = protectionLevels[action][level]
elseif protectionLevels[action].default then
msg = protectionLevels[action].default
elseif protectionLevels.edit.default then
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
end
 
function Blurb:_makeProtectionLogParameter()
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'autoreview' then
-- We need the pending changes log.
return makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
self:_getExpandedMessage('pc-log-display')
)
else
-- We need the protection log.
return makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self:_getExpandedMessage('protection-log-display')
)
end
end
 
function Blurb:_makeTalkPageParameter()
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
self._protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
)
end
 
function Blurb:_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() 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{
title="vandal-m",
args={self._args.user or self._protectionObj.title.baseText}
}
end
 
-- Public methods --
 
function Blurb:makeBannerText(key)
-- Validate input.
if not key or not Blurb.bannerTextFields[key] then
error(string.format(
'"%s" is not a valid banner config field',
tostring(key)
), 2)
end
 
-- Generate the text.
local msg = self._protectionObj.bannerConfig[key]
if type(msg) == 'string' then
return self:_substituteParameters(msg)
elseif type(msg) == 'function' then
msg = msg(self._protectionObj, self._args)
if type(msg) ~= 'string' then
error(string.format(
'bad output from banner config function with key "%s"'
.. ' (expected string, got %s)',
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
end
end
 
--------------------------------------------------------------------------------
-- BannerTemplate class
--------------------------------------------------------------------------------
 
local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate
 
function BannerTemplate.new(protectionObj, cfg)
local obj = {}
obj._cfg = cfg
 
-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
obj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
-- generate it from the protection status and the namespace.
local action = protectionObj.action
local level = protectionObj.level
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason
-- Deal with special cases first.
if (
namespace == 10
or namespace == 828
or reason and obj._cfg.indefImageReasons[reason]
)
and action == 'edit'
and level == 'sysop'
and not protectionObj:isTemporary()
then
-- Fully protected modules and templates get the special red "indef"
-- padlock.
obj._imageFilename = obj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = obj._cfg.images
if images[action] then
if images[action][level] then
obj._imageFilename = images[action][level]
elseif images[action].default then
obj._imageFilename = images[action].default
end
end
end
end
return setmetatable(obj, BannerTemplate)
end
 
function BannerTemplate:renderImage()
local filename = self._imageFilename
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return makeFileLink{
file = filename,
size = (self.imageWidth or 20) .. 'px',
alt = self._imageAlt,
link = self._imageLink,
caption = self.imageCaption
}
end
 
--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------
 
local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner
 
function Banner.new(protectionObj, blurbObj, cfg)
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
 
function Banner:__tostring()
-- 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 = {
page = self._page,
type = 'protection',
image = self:renderImage(),
text = string.format(
"'''%s'''%s",
reasonText,
explanationText and '<br />' .. explanationText or ''
)
}
return makeMessageBox('mbox', mbargs)
end
 
--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------
 
local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock
 
function Padlock.new(protectionObj, blurbObj, cfg)
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.padlockIndicatorNames.default
or 'pp-default'
return setmetatable(obj, Padlock)
end
 
function Padlock:__tostring()
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
 
--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------
 
local p = {}
 
function p._exportClasses()
-- This is used for testing purposes.
return {
Protection = Protection,
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
}
end
 
function p._main(args, cfg, title)
args = args or {}
cfg = cfg or require(CONFIG_MODULE)
 
local protectionObj = Protection.new(args, cfg, title)
 
local ret = {}
 
-- 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 not yesno(args.catonly) and (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
end
 
error('No category match found; please define the category for key "all-all-all-all-all"')
-- Render the categories
end
if yesno(args.category) ~= false then
ret[#ret + 1] = protectionObj:makeCategoryLinks()
end
return table.concat(ret)
end
 
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, {
parentOnly = defaultArgs,
frameOnly = not defaultArgs
})
 
-- 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
end
return p._main(args, cfg)
end


return p
return p
가온 위키에서의 모든 기여는 크리에이티브 커먼즈 저작자표시-동일조건변경허락 라이선스로 배포된다는 점을 유의해 주세요(자세한 내용에 대해서는 가온 위키:저작권 문서를 읽어주세요). 만약 여기에 동의하지 않는다면 문서를 저장하지 말아 주세요.
또한, 직접 작성했거나 퍼블릭 도메인과 같은 자유 문서에서 가져왔다는 것을 보증해야 합니다. 저작권이 있는 내용을 허가 없이 저장하지 마세요!
취소 편집 도움말 (새 창에서 열림)

이 문서에서 사용한 틀: