Module:Lockbox

Module documentation[view] [edit] [history] [purge]

This module transcludes templates whose names have been given as parameters in order to trigger cascade protection.

Usage

{{#invoke:lockbox|lock|silent=1
 | X1
 | X2
 | X3
 | ...
}}

See also

• Wikipedia:Cascade-protected items

The above documentation is transcluded from Module:Lockbox/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local export = {}

function export.lock(frame)
	local output = {}
	
	-- check if the current page is cascade-protected
	-- XXX: unfortunately there is no other way; title.protectionLevels does not report cascading protection status
	mw.title.getCurrentTitle():getContent() -- self-transclude; see [[mw:Extension:Scribunto/Lua reference manual#Title objects]]
	if frame:preprocess "{{CASCADINGSOURCES}}" == "" then
		table.insert(output, '<strong class="warning">Warning: this page (' .. mw.title.getCurrentTitle().fullText .. ') is not cascade-protected.</strong>')
	end
	
	-- transclude everything, and discard the output
	for _, item in ipairs(frame.args) do
		item = mw.text.trim(item)
		
		-- getContent() on a title object might be cleaner, but getContent() and title objects
		-- are considered "expensive". even though they are probably cheaper than actual transclusion
		frame:expandTemplate { title = item }

		if not item:match(":") then
			item = "Template:" .. item
		elseif item:match("^File:") or item:match("^Image:") then
			-- XXX: leaving this separate just in case it needs special handling
			item = ":" .. item
		elseif item:match("^Category:") then
			item = ":" .. item
		end
		table.insert(output, ('* [[%s]]'):format(item))
	end

	if frame.args.silent then
		return ""
	else
		return table.concat(output, "\n")
	end
end

return export