Module:Lockbox/sandbox - Revision history

Jackmcbarn: Avoid an unnecessary call to frame:preprocess

2020-07-26T21:08:59Z

Avoid an unnecessary call to frame:preprocess

← Previous revision		Revision as of 21:08, 26 July 2020
Line 44:		Line 44:
	-- This creates an extaneous self-transclusion for all pages using the		-- This creates an extaneous self-transclusion for all pages using the
	-- module, but we treat that as a necessary evil.		-- module, but we treat that as a necessary evil.
	--
	-- XXX: there seems to be no way to check for cascading protection using a
	-- Scribunto API, so we have to use frame:preprocess with the
	-- CASCADINGSOURCES parser function.
	do		do
	mw.title.getCurrentTitle():getContent() -- Generate self-transclusion		mw.title.getCurrentTitle():getContent() -- Generate self-transclusion
	local parent_title = frame:getParent():getTitle()		local parent_title = frame:getParent():getTitle()
	if ~~frame:preprocess('{{CASCADINGSOURCES:'~~ .. parent_title .. ~~'}}') == ''~~ then		if not mw.title.new(parent_title).cascadingProtection.sources[1] then
	warnings[#warnings + 1] = make_wikitext_warning(string.format(		warnings[#warnings + 1] = make_wikitext_warning(string.format(
	'the page "%s" is not cascade-protected',		'the page "%s" is not cascade-protected',

Mr. Stradivarius: use the item instead of frame.args[i] in the invalid title error message

2017-03-17T03:37:36Z

use the item instead of frame.args[i] in the invalid title error message

← Previous revision		Revision as of 03:37, 17 March 2017
Line 87:		Line 87:
	warnings[#warnings + 1] = make_wikitext_warning(string.format(		warnings[#warnings + 1] = make_wikitext_warning(string.format(
	'invalid title "%s" in argument #%d',		'invalid title "%s" in argument #%d',
	~~frame.args[i]~~,		item,
	i		i
	))		))

Mr. Stradivarius: always show warnings at the top, and use a more descriptive name than "output", seeing as it's not technically the output any more

2017-03-17T03:36:03Z

always show warnings at the top, and use a more descriptive name than "output", seeing as it's not technically the output any more

← Previous revision		Revision as of 03:36, 17 March 2017
Line 2:		Line 2:

	-- XXX: OUTRAGEOUS ABUSE OF SCRIBUNTO API		-- XXX: OUTRAGEOUS ABUSE OF SCRIBUNTO API
	-- ~~generates~~ a transclusion without incrementing the "expensive function" count		-- Generates a transclusion without incrementing the "expensive function" count
	local generate_transclusion		local generate_transclusion
	do		do
Line 12:		Line 12:
	getContent(mock_title)		getContent(mock_title)
	end		end
	-- I can do the same thing without rawset.
	end		end

	local function make_wikitext_warning(msg)		local function make_wikitext_warning(msg)
	return string.format('<strong class="warning">Warning: %s.</strong>\n', msg)		return string.format('<strong class="warning">Warning: %s.</strong>', msg)
	end		end

	function export.lock(frame)		function export.lock(frame)
	local ~~output~~ = {}		local warnings, transclusion_list = {}, {}

	-- Check if the transcluding page is cascade-protected.		-- Check if the transcluding page is cascade-protected.
Line 53:		Line 52:
	local parent_title = frame:getParent():getTitle()		local parent_title = frame:getParent():getTitle()
	if frame:preprocess('{{CASCADINGSOURCES:' .. parent_title .. '}}') == '' then		if frame:preprocess('{{CASCADINGSOURCES:' .. parent_title .. '}}') == '' then
	~~output~~[#~~output~~ + 1] = make_wikitext_warning(string.format(		warnings[#warnings + 1] = make_wikitext_warning(string.format(
	'the page "%s" is not cascade-protected',		'the page "%s" is not cascade-protected',
	parent_title		parent_title
Line 60:		Line 59:
	end		end

	-- Generate transclusions to the templates, and build the output.		-- Generate transclusions to the templates, and build the output list.
	for i, item in ipairs(frame.args) do		for i, item in ipairs(frame.args) do
	item = mw.text.trim(item)		item = mw.text.trim(item)
Line 73:		Line 72:
	if item:sub(1, 1) == ':' then		if item:sub(1, 1) == ':' then
	generate_transclusion(title)		generate_transclusion(title)
	~~output[#output + 1] =~~ '* [[' .. prefixed_text .. ']]'		table.insert(transclusion_list, '* [[' .. prefixed_text .. ']]')
	else		else
	generate_transclusion('Template:' .. prefixed_text)		generate_transclusion('Template:' .. prefixed_text)
	~~output[#output + 1] =~~ '* [[Template:' .. prefixed_text .. ']]'		table.insert(transclusion_list, '* [[Template:' .. prefixed_text .. ']]')
	end		end
	elseif ns == 6 or ns == 14 then -- File or Category namespace		elseif ns == 6 or ns == 14 then -- File or Category namespace
	generate_transclusion(title)		generate_transclusion(title)
	~~output[#output + 1] =~~ '* [[:' .. prefixed_text .. ']]'		table.insert(transclusion_list, '* [[:' .. prefixed_text .. ']]')
	else		else
	generate_transclusion(title)		generate_transclusion(title)
	~~output[#output + 1] =~~ '* [[' .. prefixed_text .. ']]'		table.insert(transclusion_list, '* [[' .. prefixed_text .. ']]')
	end		end
	else		else
	~~output~~[#~~output~~ + 1] = make_wikitext_warning(string.format(		warnings[#warnings + 1] = make_wikitext_warning(string.format(
	'invalid title "%s" in argument #%d',		'invalid title "%s" in argument #%d',
	frame.args[i],		frame.args[i],
Line 97:		Line 96:
	return ''		return ''
	else		else
			-- If there were any warnings, show them at the top. Then show the list
⚫	return table.concat(~~output~~, '\n')
			-- of transcluded pages.
			local ret = ''
			if #warnings > 0 then
			if #warnings > 1 then
			for i, warning in ipairs(warnings) do
			warnings[i] = '* ' .. warning
			end
			end
			ret = ret .. table.concat(warnings, '\n') .. '\n\n'
			end
		⚫	return ret .. table.concat(transclusion_list, '\n')
	end		end
	end		end

Mr. Stradivarius: use single quotes for strings consistently

2017-03-17T03:21:45Z

use single quotes for strings consistently

← Previous revision		Revision as of 03:21, 17 March 2017
Line 52:		Line 52:
	mw.title.getCurrentTitle():getContent() -- Generate self-transclusion		mw.title.getCurrentTitle():getContent() -- Generate self-transclusion
	local parent_title = frame:getParent():getTitle()		local parent_title = frame:getParent():getTitle()
	if frame:preprocess("{{CASCADINGSOURCES:" .. parent_title .. "}}") == "" then		if frame:preprocess('{{CASCADINGSOURCES:' .. parent_title .. '}}') == '' then
	output[#output + 1] = make_wikitext_warning(string.format(		output[#output + 1] = make_wikitext_warning(string.format(
	'the page "%s" is not cascade-protected',		'the page "%s" is not cascade-protected',
Line 95:		Line 95:

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

Mr. Stradivarius: we need to trim the items for mw.title.new

2017-03-17T03:19:20Z

we need to trim the items for mw.title.new

← Previous revision		Revision as of 03:19, 17 March 2017
Line 62:		Line 62:
	-- Generate transclusions to the templates, and build the output.		-- Generate transclusions to the templates, and build the output.
	for i, item in ipairs(frame.args) do		for i, item in ipairs(frame.args) do
			item = mw.text.trim(item)
	local title = mw.title.new(item)		local title = mw.title.new(item)
	if title then		if title then
Line 70:		Line 71:
	-- colon, assume it is a mainspace page. Otherwise, assume it is		-- colon, assume it is a mainspace page. Otherwise, assume it is
	-- a template.		-- a template.
	if item:~~find~~('^%s*:') then		if item:sub(1, 1) == ':' then
	generate_transclusion(title)		generate_transclusion(title)
	output[#output + 1] = '* [[' .. prefixed_text .. ']]'		output[#output + 1] = '* [[' .. prefixed_text .. ']]'

Mr. Stradivarius: use title objects to make page-name parsing more robust

2017-03-17T03:14:14Z

use title objects to make page-name parsing more robust

@@ Line 8: / Line 8: @@
 	local getContent = mock_title.getContent
 	function generate_transclusion(title)
-		rawset(mock_title, 'fullText', title)
+		rawset(mock_title, 'fullText', full_text)
 		getContent(mock_title)
 	end
 	-- I can do the same thing without rawset.
 end
@@ Line 48: / Line 53: @@
 		local parent_title = frame:getParent():getTitle()
 		if frame:preprocess("{{CASCADINGSOURCES:" .. parent_title .. "}}") == "" then
 		end
 	end
-	for _, item in ipairs(frame.args) do
+	for i, item in ipairs(frame.args) do
-		item = mw.text.trim(item)
+		local title = mw.title.new(item)
-		elseif ns == "Category" then
+				if item:find('^%s*:') then
-			generate_transclusion(item)
+					generate_transclusion(title)
-			output[#output + 1] = '* [[:' .. item .. ']]'
+					output[#output + 1] = '* [[' .. prefixed_text .. ']]'
-			generate_transclusion(item)
+					generate_transclusion('Template:' .. prefixed_text)
-			output[#output + 1] = '* [[' .. item .. ']]'
+					output[#output + 1] = '* [[Template:' .. prefixed_text .. ']]'
 		end
 	end

Mr. Stradivarius: improve comment, and don't transclude the parent title

2017-03-17T02:33:26Z

improve comment, and don't transclude the parent title

@@ Line 17: / Line 17: @@
 	local output = {}
-	-- check if the transcluding page is cascade-protected
+	-- Check if the transcluding page is cascade-protected.
 	do
 		mw.title.getCurrentTitle():getContent() -- Generate self-transclusion
-		generate_transclusion(parent_title)
+		local parent_title = frame:getParent():getTitle()
 		if frame:preprocess("{{CASCADINGSOURCES:" .. parent_title .. "}}") == "" then
 			output[#output + 1] = '<strong class="warning">Warning: the page "' .. parent_title .. '" is not cascade-protected.</strong>\n'

Mr. Stradivarius: add a comment about what is going on

2017-03-17T01:16:22Z

add a comment about what is going on

@@ Line 21: / Line 21: @@
 	do
 		local parent_title = frame:getParent():getTitle()
 		if frame:preprocess("{{CASCADINGSOURCES:" .. parent_title .. "}}") == "" then
 			output[#output + 1] = '<strong class="warning">Warning: the page "' .. parent_title .. '" is not cascade-protected.</strong>\n'

Mr. Stradivarius: don't transclude the current page - there should already be a transclusion from the lockbox from using #invoke there

2017-03-17T00:49:45Z

don't transclude the current page - there should already be a transclusion from the lockbox from using #invoke there

← Previous revision		Revision as of 00:49, 17 March 2017
Line 19:		Line 19:
	-- check if the transcluding page is cascade-protected		-- check if the transcluding page is cascade-protected
	-- XXX: unfortunately there is no other way; title.protectionLevels does not report cascading protection status		-- 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]]
	do		do
	local parent_title = frame:getParent():getTitle()		local parent_title = frame:getParent():getTitle()

Mr. Stradivarius: use the parent frame title instead of the current title

2017-03-16T23:47:17Z

use the parent frame title instead of the current title

← Previous revision		Revision as of 23:47, 16 March 2017
Line 17:		Line 17:
	local output = {}		local output = {}

	-- check if the ~~current~~ page is cascade-protected		-- check if the transcluding page is cascade-protected
	-- XXX: unfortunately there is no other way; title.protectionLevels does not report cascading protection status		-- 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]]		mw.title.getCurrentTitle():getContent() -- self-transclude; see [[mw:Extension:Scribunto/Lua reference manual#Title objects]]
			do
⚫	if frame:preprocess "{{CASCADINGSOURCES}}" == "" then
			local parent_title = frame:getParent():getTitle()
⚫	output[#output + 1] = '<strong class="warning">Warning: ~~this~~ page (' .. ~~mw.title.getCurrentTitle().fullText~~ .. ') is not cascade-protected.</strong>\n'
		⚫	if frame:preprocess("{{CASCADINGSOURCES:" .. parent_title .. "}}") == "" then
		⚫	output[#output + 1] = '<strong class="warning">Warning: the page "' .. parent_title .. '" is not cascade-protected.</strong>\n'
			end
	end		end