Module:Lockbox: Difference between revisions

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 = {}

-- XXX: OUTRAGEOUS ABUSE OF SCRIBUNTO API
-- generates a transclusion without incrementing the "expensive function" count
local generate_transclusion
do 
	local mock_title = mw.title.new(mw.title.getCurrentTitle().id)
	rawset(mock_title, 'getContent', mock_title.getContent)
	function generate_transclusion(title)
		rawset(mock_title, 'fullText', title)
		mock_title:getContent()
	end
end

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>\n')
	end
	
	local match = string.match

	for _, item in ipairs(frame.args) do
		item = mw.text.trim(item)
		
		local ns, rest = match(item, "^(.-):(.*)")
		if not ns or not mw.site.namespaces[ns] then
			generate_transclusion('Template:' .. item)
			table.insert(output, '* [[Template:' .. item .. ']]\n')
		elseif (ns == "File") or (ns == "Image") then
			generate_transclusion(item)
			table.insert(output, '* [[:' .. item .. ']]\n')
		elseif ns == "Category" then
			generate_transclusion(item)
			table.insert(output, '* [[:' .. item .. ']]\n')
		elseif rest ~= '' then
			generate_transclusion(item)
			table.insert(output, '* [[' .. item .. ']]\n')
		end
	end

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

return export