Modulo:Banderola ti salaknib/pagipadasan

Manipud iti Wikipedia, ti nawaya nga ensiklopedia
Darsen a mapan iti pagdaliasatan Darsen a mapan agbiruk
Dokumentasion ti modulo

Daytoy a madulo ket agpartuat kadagiti banderola ken dagiti ikono ti kandado a maikabil iti ngato dagiti nasalakniban a panid.

Panagusar[urnosen ti taudan]

Kaaduan kadagiti agar-aramat ket saan a nasken dagus nga agusar iti daytoy a modulo. Para iti pananginaon kadagiti plantilia ti salaknib kadagiti panid, mabalin nga usaren ti plantilia ti {{pp}} , wenno nalaklaka kaniamon nga usaren ti maysa kadagiti naisangayan a plantilia ti salaknib iti tabla dita baba.

Dagiti plantilia ti salaknib
Modulo:Banderola ti salaknib Panagurnos Panagiyalis Dagiti di pay maibanag a panagbaliw
Sapasap: {{pp}}
{{pp-nasalakniban}} {{pp-iyalis}} {{pp-pc1}} {{pp-pc2}}
WP:BST: {{pp-bst}} N/A N/A
Suppiat: {{pp-suppiat}} {{pp-iyalis-suppiat}} N/A
Nausar iti Umuna a Panid: {{pp-umuna-a-panid}} N/A N/A
Am-ammirisen iti Opisina: {{pp-opisina}} {{pp-isaad-manen}} {{pp-opisina-dmca}}
Tirtiris a pakabilangan: {{pp-tirtiris}} N/A N/A
Adu a pannakabuybuya a plantilia ken modulo: {{pp-plantilia}} N/A N/A
Tungtungan ti agar-aramat iti naserran nga agar-aramat: {{pp-tungtungan-agar-aramat}} N/A N/A
Bandalismo: {{pp-bandalismo}} {{pp-iyalis-bandalismo}} N/A
Napaut a termino: {{pp-semi-agnanayon}} {{pp-iyalis-agnanayon}} N/A
Pakaammo ti tungtungan a panid: {{permanente a nasalakniban}}
{{temporario a nasalakniban}}

Manipud ti wikitext[urnosen ti taudan]

{{#invoke:Banderola ti salaknib|main
| 1        = rason
| small    = wen/saan
| action   = tignay
| expiry   = panagpaso
| date     = petsa ti salaknib
| user     = nagan ti agar-aramat
| section  = nagan ti paset ti tungtungan a panid
| category = saan

Ti sintaksis ti #invoke ket mabalin a mausar iti panagpartuat kadagiti plantilia ti salaknib a naisangsangayan ngem ti {{pp}}. Kas pagarigan, mabalin ti agpartuat ti plantilia ti salaknib a kankanayon nga agiparang iti ikono ti kandado babaen ti panagusar ti kodigo ti {{#invoke:Banderola ti salaknib|main|small=yes}}. Dagiti panid a mangtawag iti plantilia ket mabalindanto pay ti agusar kadagiti argumento, kasla ti action ken expiry. Nupay kasta, daytoy ket mabalin laeng iti maysa nga agpang a kauneg; ti panid a mangtawag iti plantilia a mangtawag manen ti sabali aplantilia nga aglaon ti kodigo dita ngato ket saanto nga automatiko a mapakabaelan nga agusar kadagiti parametro a kas ti action ken expiry.

Manipud ti Lua[urnosen ti taudan]

Umuna nga ikarga ti modulo.

local mProtectionBanner = require('Modulo:Banderola ti salaknib')

Kalpasanna mabalinmonton ti agpartuat kadagiti banderola ti salaknib babaen ti panagusar ti annong ti _main .

mProtectionBanner._main(args, cfg, titleObj)

Ti args ket tabla dagiti argumento a maipasa iti modulo. Para kadagiti mabalin a tekla ken dagiti pateg para iti daytoy a tabla, kitaen ti paset dagiti parametro. Ti panagdumaduma ti cfg ken titleObj ket naikeddeng laeng para iti panagsubok; ti cfg ket manginagan ti naiduma a tabla ti konpigurasion ti tabla a mausar imbes a ti Modulo:Banderola ti salaknib/pannakaaramid, ken titleObj manginagan ti mw.title object a mausar imbes a ti agdama a titulo. args, ti cfg ken titleObj ket pagpilian amin dagitoy.

Dagiti parametro[urnosen ti taudan]

Amin dagiti parametro ket pagpilian.

  • 1 - ti rason a nakasalakniban ti panid. No maisaad, daytoy ket nasken a maysa kadagiti pateg a nailista iti tabla dagiti rason.
  • small - no maisaad iti "yes", "y", "1","true", "wen", ken "w" mapataud ti ikono ti kandado imbes a ti banderola ti napno a salaknib.
  • action - ti tignay ti salaknib. Nasken a maysa kadagiti "edit" (fpara iti normal a salaknib), "move" (para iti salaknib ti panagiyalis) wenno "autoreview" (para kadagiti di pay maibanag a panagbaliw). Ti kasisigud a pateg key edit".
  • expiry - the expiry date of the protection. This can be a date (for temporary protection), or one of the strings "indef", "indefinite", "indefinitely", or "infinite" (for indefinite protection). If this is a date, it must be valid input to the second parameter of the #time parser function.
  • date - the protection date. This must be valid input to the second parameter of the #time parser function. This argument has an effect for reasons that use the PROTECTIONDATE parameter in their configuration. As of July 2014, those were the "office" and "reset" reasons.
  • user - the username of the user to generate links for. As of July 2014, this only has an effect when the "usertalk" reason is specified.
  • section - the section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.
  • category - dagiti kategoria ket mapasardeng no maisaad daytoy iti "no", "n", "0", "false", "saan", ken "s" .

Dagiti rason[urnosen ti taudan]

The following table contains the available reasons, plus the actions for which they are available.

Rason Tignay Dekripsion
blp edit Para kadagiti panid a mangiragpat ti panagtungpal iti annuroten dagiti biograpia ti sibibiag a tattao .
dispute edit Para kadagiti panid a nasalakniban gapu kadagiti suppiat ti panagurnos.
dmca edit Para kadagiti panid a nasalakniban babaen ti Pundasion ti Wikimedia gapu kadagiti kiddaw ti panagikkat iti Digital Millennium Copyright Act.
mainpage edit Para kadagiti panid a nasalakniban gapu ta naiparang iti Umuna a Panid.
office edit Para kadagiti panid a nasalakniban babaen ti Pundasion ti Wikimedia.
reset edit Para kadagiti panid a nasalakniban babaen ti Pundasion ti Wikimedia ken "naisaad manen" iti bersion nga awan unay linaon.
sock edit Para kadagiti panid a nasalakniban gapu iti tirtiris a pakabilangan.
template edit Para kadagiti nariesgo unay a plantilia ken dagiti modulo ti Lua.
usertalk edit Para kadagiti panid a nasalakniban kadagiti makagulo a panagurnos babaen ti naisangayan nga agar-aramat.
vandalism edit Para kadagiti panid a nasalakniban kadagiti bandalismo.
dispute move Para kadagiti panid a nasalakniban kadagiti panagiyalis ti panid gapu ti suppiat iti titulo ti panid.
vandalism move Para kadagiti panid a nasalakniban kadagiti bandalismo ti panagiyalis iti panid.

Dagiti biddut[urnosen ti taudan]

Below is a list of some of the common errors that this module can produce, and how to fix them.

Imbalido a panagpaso[urnosen ti taudan]

Error: invalid expiry ("abc")

This error is produced if you supply an |expiry= parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "29 Mayo 2022". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).

Imbalido a petsa ti salaknib[urnosen ti taudan]

Biddut: imbalido a petsa ti salaknib ("abc")

This error is produced if you supply an |date= parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "29 Mayo 2022". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).

Imbalido a tignay[urnosen ti taudan]

Error: invalid action ("abc")

This error is produced if you specify an invalid protection action. There are only three valid actions: edit (the default, for normal protection), move (for move-protection), and autoreview (for pending changes). This should only be possible if you are using a template that supports manually specifying the protection action, such as {{pp}}, or if you are using #invoke directly. If this is not the case, please leave a message on Module talk:Protection banner.

Reasons cannot contain the pipe character[urnosen ti taudan]

Error: reasons cannot contain the pipe character ("|")

This error is produced if you specify a reason using the |1= parameter that includes a pipe character ("|"). Please check that you are not entering the {{!}} template into this parameter by mistake. The pipe character is disallowed as the module uses it internally. A list of valid reasons can be seen in the reasons section.

Other errors[urnosen ti taudan]

If you see an error other than the ones above, it is likely to either be a bug in the module or mistake in the configuration. Please post a message about it at Module talk:Protection banner.

Technical details[urnosen ti taudan]

This module uses configuration data from Modulo:Banderola ti salaknib/pannakaaramid. Most of the module's behaviour can be configured there, making it easily portable across different wikis and different languages.

General test cases for the module can be found at Module:Protection banner/testcases, and test cases specific to enwiki's config can be found at Module:Protection banner/config/testcases.

Bug reports and feature requests should be made on the module's talk page.

-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.

-- Initialise necessary modules.
require('Modulo:No globals')
local makeFileLink = require('Modulo:Silpo ti papeles')._main
local effectiveProtectionLevel = require('Modulo:Epektibo nga agpang ti salaknib')._main
local effectiveProtectionExpiry = require('Modulo:Epektibo a panagpaso ti salaknib')._main
local yesno = require('Modulo:Wensaan')

-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang

-- Set constants.
local CONFIG_MODULE = 'Modulo:Banderola ti salaknib/pannakaaramid'

-- Helper functions

local function makeCategoryLink(cat, sort)
	if cat then
		return string.format(

-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
	if not lang then
		lang = mw.language.getContentLanguage()
	local success, result = pcall(lang.formatDate, lang, 'U', dateString)
	if success then
		result = tonumber(result)
		if result then
			return result
		'invalid %s: %s',
	), 4)

local function makeFullUrl(page, query, display)
	return string.format(
		'[%s %s]',
		tostring(mw.uri.fullUrl(page, query)),

-- 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
		toWalk[k] = nil
		retval[k] = true
		for _,v in ipairs(graph[k]) do
			if not retval[v] then
				toWalk[v] = true

-- Protection class

local Protection = {}
Protection.__index = Protection

Protection.supportedActions = {
	edit = true,
	move = true,
	autoreview = true,
	upload = true

Protection.bannerConfigFields = {

function, cfg, title)
	local obj = {}
	obj._cfg = cfg
	obj.title = title or mw.title.getCurrentTitle()

	-- Set action
	if not args.action then
		obj.action = 'edit'
	elseif Protection.supportedActions[args.action] then
		obj.action = args.action
			'invalid action: %s',
		), 3)

	-- 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 = '*'

	-- 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')

	-- 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)

	-- Set protection date
	if then
		obj.protectionDate = validateDate(, 'protection date')
	-- Set banner config
		obj.bannerConfig = {}
		local configTables = {}
		if cfg.banners[obj.action] then
			configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
		if cfg.defaultBanners[obj.action] then
			configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
			configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
		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]
	return setmetatable(obj, Protection)

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'

function Protection:isProtected()
	return self.level ~= '*'

function Protection:shouldShowLock()
	-- Whether we should output a banner/padlock
	return self:isProtected() and not self:isUserScript()

-- Whether this page needs a protection category.
Protection.shouldHaveProtectionCategory = Protection.shouldShowLock

function Protection:isTemporary()
	return type(self.expiry) == 'number'

function Protection:makeProtectionCategory()
	if not self:shouldHaveProtectionCategory() then
		return ''

	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'

	-- Get the namespace key fragment.
	local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
	if not namespaceFragment and title.namespace % 2 == 1 then
			namespaceFragment = 'talk'

	-- 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
		local active, inactive = {}, {}
		for i, t in ipairs(order) do
			if t.val then
				active[#active + 1] = t
				inactive[#inactive + 1] = t
		noActive = #active
		attemptOrder = active
		for i, t in ipairs(inactive) do
			attemptOrder[#attemptOrder + 1] = t
	-- 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'
				local quotient = i / 2 ^ (j - 1)
				quotient = math.ceil(quotient)
				if quotient % 2 == 1 then
					key[t.keypos] = t.val
					key[t.keypos] = 'all'
		key = table.concat(key, '|')
		local attempt = cats[key]
		if attempt then
			return makeCategoryLink(attempt, title.text)
	return ''

function Protection:isIncorrect()
	local expiry = self.expiry
	return not self:shouldHaveProtectionCategory()
		or type(expiry) == 'number' and expiry < os.time()

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)

function Protection:makeCategoryLinks()
	local msg = self._cfg.msg
	local ret = {self:makeProtectionCategory()}
	if self:isIncorrect() then
		ret[#ret + 1] = makeCategoryLink(
	if self:isTemplateProtectedNonTemplate() then
		ret[#ret + 1] = makeCategoryLink(
	return table.concat(ret)

-- Blurb class

local Blurb = {}
Blurb.__index = Blurb

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

function, args, cfg)
	return setmetatable({
		_cfg = cfg,
		_protectionObj = protectionObj,
		_args = args
	}, Blurb)

-- Private methods --

function Blurb:_formatDate(num)
	-- Formats a Unix timestamp into dd Month, YYYY format.
	lang = lang or mw.language.getContentLanguage()
	local success, date = pcall(
		self._cfg.msg['expiry-date-format'] or 'j F Y',
		'@' .. tostring(num)
	if success then
		return date

function Blurb:_getExpandedMessage(msgKey)
	return self:_substituteParameters(self._cfg.msg[msgKey])

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)
				param = param or ''
				t[k] = param
				return param
	msg = msg:gsub('${(%u+)}', self._params)
	return msg

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(
			{type = 'move', page = pagename},
		-- We need the history link.
		return makeFullUrl(
			{action = 'history'},

function Blurb:_makeEditRequestParameter()
	local mEditRequest = require('Modulo:Agkiddaw iti panagurnos')
	local action = self._protectionObj.action
	local level = self._protectionObj.level
	-- Get the edit request type.
	local requestType
	if action == 'edit' then
		if level == 'autoconfirmed' then
			requestType = 'semi'
		elseif level == 'extendedconfirmed' then
			requestType = 'extended'
		elseif level == 'templateeditor' then
			requestType = 'template'
	requestType = requestType or 'full'
	-- Get the display value.
	local display = self:_getExpandedMessage('edit-request-display')

	return mEditRequest._link{type = requestType, display = display}

function Blurb:_makeExpiryParameter()
	local expiry = self._protectionObj.expiry
	if type(expiry) == 'number' then
		return self:_formatDate(expiry)
		return expiry

function Blurb:_makeExplanationBlurbParameter()
	-- Cover special cases first.
	if self._protectionObj.title.namespace == 8 then
		-- MediaWiki namespace
		return self:_getExpandedMessage('explanation-blurb-nounprotect')

	-- Get explanation blurb table keys
	local action = self._protectionObj.action
	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
			'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
		), 8)
	return self:_substituteParameters(msg)

function Blurb:_makeImageLinkParameter()
	local imageLinks = self._cfg.imageLinks
	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
		msg = imageLinks.edit.default
	return self:_substituteParameters(msg)

function Blurb:_makeIntroBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-blurb-expiry')
		return self:_getExpandedMessage('intro-blurb-noexpiry')

function Blurb:_makeIntroFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('intro-fragment-expiry')
		return self:_getExpandedMessage('intro-fragment-noexpiry')

function Blurb:_makePagetypeParameter()
	local pagetypes = self._cfg.pagetypes
	return pagetypes[self._protectionObj.title.namespace]
		or pagetypes.default
		or error('no default pagetype defined', 8)

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
		error('no protection blurb defined for protectionBlurbs.edit.default', 8)
	return self:_substituteParameters(msg)

function Blurb:_makeProtectionDateParameter()
	local protectionDate = self._protectionObj.protectionDate
	if type(protectionDate) == 'number' then
		return self:_formatDate(protectionDate)
		return protectionDate

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
		error('no protection level defined for protectionLevels.edit.default', 8)
	return self:_substituteParameters(msg)

function Blurb:_makeProtectionLogParameter()
	local pagename = self._protectionObj.title.prefixedText
	if self._protectionObj.action == 'autoreview' then
		-- We need the pending changes log.
		return makeFullUrl(
			{type = 'stable', page = pagename},
		-- We need the protection log.
		return makeFullUrl(
			{type = 'protect', page = pagename},

function Blurb:_makeTalkPageParameter()
	return string.format(
		self._args.section or 'top',

function Blurb:_makeTooltipBlurbParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-blurb-expiry')
		return self:_getExpandedMessage('tooltip-blurb-noexpiry')

function Blurb:_makeTooltipFragmentParameter()
	if self._protectionObj:isTemporary() then
		return self:_getExpandedMessage('tooltip-fragment-expiry')
		return self:_getExpandedMessage('tooltip-fragment-noexpiry')

function Blurb:_makeVandalTemplateParameter()
	return mw.getCurrentFrame():expandTemplate{
		args={self._args.user or self._protectionObj.title.baseText}

-- Public methods --

function Blurb:makeBannerText(key)
	-- Validate input.
	if not key or not Blurb.bannerTextFields[key] then
			'"%s" is not a valid banner config field',
		), 2)

	-- 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
				'bad output from banner config function with key "%s"'
					.. ' (expected string, got %s)',
			), 4)
		return self:_substituteParameters(msg)

-- BannerTemplate class

local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate

function, cfg)
	local obj = {}
	obj._cfg = cfg

	-- Set the image filename.
	local imageFilename = protectionObj.bannerConfig.image
	if imageFilename then
		obj._imageFilename = imageFilename
		-- 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()
			-- Fully protected modules and templates get the special red "indef"
			-- padlock.
			obj._imageFilename = obj._cfg.msg['image-filename-indef']
			-- 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
	return setmetatable(obj, BannerTemplate)

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

-- Banner class

local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner

function, blurbObj, cfg)
	local obj =, 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)

function Banner:__tostring()
	-- Renders the banner.
	makeMessageBox = makeMessageBox or require('Modulo:Kahon ti mensahe').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(
			explanationText and '<br />' .. explanationText or ''
	return makeMessageBox('mbox', mbargs)

-- Padlock class

local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock

function, blurbObj, cfg)
	local obj =, 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)

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()

-- Exports

local p = {}

function p._exportClasses()
	-- This is used for testing purposes.
	return {
		Protection = Protection,
		Blurb = Blurb,
		BannerTemplate = BannerTemplate,
		Banner = Banner,
		Padlock = Padlock,

function p._main(args, cfg, title)
	args = args or {}
	cfg = cfg or require(CONFIG_MODULE)

	local protectionObj =, 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(
		)[effectiveProtectionLevel('edit', protectionObj.title)])
		-- Initialise the blurb object
		local blurbObj =, args, cfg)
		-- Render the banner
		if protectionObj:shouldShowLock() then
			ret[#ret + 1] = tostring(
				(yesno(args.small) and Padlock or Banner)
				.new(protectionObj, blurbObj, cfg)

	-- Render the categories
	if yesno(args.category) ~= false then
		ret[#ret + 1] = protectionObj:makeCategoryLinks()
	return table.concat(ret)	

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('/pagipadasan$', '')]

	-- Find user args, and use the parent frame if we are being called from a
	-- wrapper template.
	getArgs = getArgs or require('Modulo:Dagiti argumento').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
	for k, v in pairs(userArgs) do
		args[k] = v
	return p._main(args, cfg)

return p