Difference between revisions of "Module:Lua banner"

From NixNet
(Applying protection level tracking logic to modules too)
 
mediawiki>Tacsipacsi
(i18n using Module:TNT, load MediaWiki.org-specific configuration from /config)
Line 1: Line 1:
 
-- This module implements the {{lua}} template.
 
-- This module implements the {{lua}} template.
 +
 
local yesno = require('Module:Yesno')
 
local yesno = require('Module:Yesno')
 
local mList = require('Module:List')
 
local mList = require('Module:List')
 
local mTableTools = require('Module:TableTools')
 
local mTableTools = require('Module:TableTools')
 
local mMessageBox = require('Module:Message box')
 
local mMessageBox = require('Module:Message box')
 +
local TNT = require('Module:TNT')
  
 
local p = {}
 
local p = {}
 +
 +
local function format(msg)
 +
return TNT.format('I18n/Lua banner', msg)
 +
end
  
 
function p.main(frame)
 
function p.main(frame)
Line 29: Line 35:
 
local boxArgs = {}
 
local boxArgs = {}
 
if #modules < 1 then
 
if #modules < 1 then
boxArgs.text = '<strong class="error">Error: no modules specified</strong>'
+
boxArgs.text = string.format('<strong class="error">%s</strong>', format('error_emptylist'))
 
else
 
else
 
local moduleLinks = {}
 
local moduleLinks = {}
Line 36: Line 42:
 
end
 
end
 
local moduleList = mList.makeList('bulleted', moduleLinks)
 
local moduleList = mList.makeList('bulleted', moduleLinks)
local title = mw.title.getCurrentTitle()
+
boxArgs.text = format('header') .. '\n' .. moduleList
if title.subpageText == "doc" then
 
title = title.basePageTitle
 
end
 
if title.contentModel == "Scribunto" then
 
boxArgs.text = 'This module depends on the following other modules:' .. moduleList
 
else
 
boxArgs.text = 'This template  uses [[Wikipedia:Lua|Lua]]:\n' .. moduleList
 
end
 
 
end
 
end
 
boxArgs.type = 'notice'
 
boxArgs.type = 'notice'
 
boxArgs.small = true
 
boxArgs.small = true
boxArgs.image = '[[File:Lua-logo-nolabel.svg|30px|alt=|link=]]'
+
boxArgs.image = string.format(
 +
'[[File:Lua-logo-nolabel.svg|30px|alt=%s|link=%s]]',
 +
format('logo_alt'),
 +
format('logo_link')
 +
)
 
return mMessageBox.main('mbox', boxArgs)
 
return mMessageBox.main('mbox', boxArgs)
 
end
 
end
Line 56: Line 58:
 
return ''
 
return ''
 
end
 
end
 
+
 +
local cfg = mw.loadData('Module:Lua banner/config')
 +
 
local cats = {}
 
local cats = {}
 
+
 
-- Error category
 
-- Error category
if #modules < 1 then
+
if #modules < 1 and cfg['error_category'] then
cats[#cats + 1] = 'Lua templates with errors'
+
cats[#cats + 1] = cfg['error_category']
 
end
 
end
 
+
 
-- Lua templates category
 
-- Lua templates category
 
titleObj = titleObj or mw.title.getCurrentTitle()
 
titleObj = titleObj or mw.title.getCurrentTitle()
local subpageBlacklist = {
+
if titleObj.namespace == 10
doc = true,
+
and not cfg['subpage_blacklist'][titleObj.subpageText]
sandbox = true,
+
then
sandbox2 = true,
+
local category = args.category
testcases = true
+
if not category then
}
+
local pagename = modules[1] and mw.title.new(modules[1])
if not subpageBlacklist[titleObj.subpageText] then
+
category = pagename and cfg['module_categories'][pagename.text]
local protCatName
+
category = category or cfg['default_category']
if titleObj.namespace == 10 then
+
end
local category = args.category
+
if category then
if not category then
 
local categories = {
 
['Module:String'] = 'Lua String-based templates',
 
['Module:Math'] = 'Templates based on the Math Lua module',
 
['Module:BaseConvert'] = 'Templates based on the BaseConvert Lua module',
 
['Module:Citation'] = 'Lua-based citation templates'
 
}
 
categories['Module:Citation/CS1'] = categories['Module:Citation']
 
category = modules[1] and categories[modules[1]]
 
category = category or 'Lua-based templates'
 
end
 
 
cats[#cats + 1] = category
 
cats[#cats + 1] = category
protCatName = "Templates using under-protected Lua modules"
 
elseif titleObj.namespace == 828 then
 
protCatName = "Modules depending on under-protected modules"
 
end
 
if not args.noprotcat and protCatName then
 
local protLevels = {
 
autoconfirmed = 1,
 
extendedconfirmed = 2,
 
templateeditor = 3,
 
sysop = 4
 
}
 
local currentProt
 
if titleObj.id ~= 0 then
 
-- id is 0 (page does not exist) if am previewing before creating a template.
 
currentProt = titleObj.protectionLevels["edit"][1]
 
end
 
if currentProt == nil then currentProt = 0 else currentProt = protLevels[currentProt] end
 
for i, module in ipairs(modules) do
 
if module ~= "WP:libraryUtil" then
 
local moduleProt = mw.title.new(module).protectionLevels["edit"][1]
 
if moduleProt == nil then moduleProt = 0 else moduleProt = protLevels[moduleProt] end
 
if moduleProt < currentProt then
 
cats[#cats + 1] = protCatName
 
break
 
end
 
end
 
end
 
 
end
 
end
 
end
 
end
 +
 
for i, cat in ipairs(cats) do
 
for i, cat in ipairs(cats) do
 
cats[i] = string.format('[[Category:%s]]', cat)
 
cats[i] = string.format('[[Category:%s]]', cat)

Revision as of 23:51, 27 May 2020

Documentation for this module may be created at Module:Lua banner/doc

-- This module implements the {{lua}} template.

local yesno = require('Module:Yesno')
local mList = require('Module:List')
local mTableTools = require('Module:TableTools')
local mMessageBox = require('Module:Message box')
local TNT = require('Module:TNT')

local p = {}

local function format(msg)
	return TNT.format('I18n/Lua banner', msg)
end

function p.main(frame)
	local origArgs = frame:getParent().args
	local args = {}
	for k, v in pairs(origArgs) do
		v = v:match('^%s*(.-)%s*$')
		if v ~= '' then
			args[k] = v
		end
	end
	return p._main(args)
end

function p._main(args)
	local modules = mTableTools.compressSparseArray(args)
	local box = p.renderBox(modules)
	local trackingCategories = p.renderTrackingCategories(args, modules)
	return box .. trackingCategories
end

function p.renderBox(modules)
	local boxArgs = {}
	if #modules < 1 then
		boxArgs.text = string.format('<strong class="error">%s</strong>', format('error_emptylist'))
	else
		local moduleLinks = {}
		for i, module in ipairs(modules) do
			moduleLinks[i] = string.format('[[:%s]]', module)
		end
		local moduleList = mList.makeList('bulleted', moduleLinks)
		boxArgs.text = format('header') .. '\n' .. moduleList
	end
	boxArgs.type = 'notice'
	boxArgs.small = true
	boxArgs.image = string.format(
		'[[File:Lua-logo-nolabel.svg|30px|alt=%s|link=%s]]',
		format('logo_alt'),
		format('logo_link')
	)
	return mMessageBox.main('mbox', boxArgs)
end

function p.renderTrackingCategories(args, modules, titleObj)
	if yesno(args.nocat) then
		return ''
	end
	
	local cfg = mw.loadData('Module:Lua banner/config')
	
	local cats = {}
	
	-- Error category
	if #modules < 1 and cfg['error_category'] then
		cats[#cats + 1] = cfg['error_category']
	end
	
	-- Lua templates category
	titleObj = titleObj or mw.title.getCurrentTitle()
	if titleObj.namespace == 10 
		and not cfg['subpage_blacklist'][titleObj.subpageText]
	then
		local category = args.category
		if not category then
			local pagename = modules[1] and mw.title.new(modules[1])
			category = pagename and cfg['module_categories'][pagename.text]
			category = category or cfg['default_category']
		end
		if category then
			cats[#cats + 1] = category
		end
	end
	
	for i, cat in ipairs(cats) do
		cats[i] = string.format('[[Category:%s]]', cat)
	end
	return table.concat(cats)
end

return p