Difference between revisions of "Module:Uses TemplateStyles"

From NixNet
m (1 revision imported)
(i18n using Module:TNT and a /config subpage, so that folks copying it to other wikis have better chances to get it translated)
Line 4: Line 4:
 
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/Uses TemplateStyles', msg, ...)
 +
end
 +
 +
local function getConfig()
 +
return mw.loadData('Module:Uses TemplateStyles/config')
 +
end
  
 
function p.main(frame)
 
function p.main(frame)
Line 19: Line 28:
 
end
 
end
  
function p._main(args)
+
function p._main(args, cfg)
 
local tStyles = mTableTools.compressSparseArray(args)
 
local tStyles = mTableTools.compressSparseArray(args)
 
local box = p.renderBox(tStyles)
 
local box = p.renderBox(tStyles)
Line 29: Line 38:
 
local boxArgs = {}
 
local boxArgs = {}
 
if #tStyles < 1 then
 
if #tStyles < 1 then
boxArgs.text = '<strong class="error">Error: no TemplateStyles specified</strong>'
+
boxArgs.text = string.format('<strong class="error">%s</strong>', format('error-emptylist'))
 
else
 
else
 +
local cfg = getConfig()
 
local tStylesLinks = {}
 
local tStylesLinks = {}
 
for i, ts in ipairs(tStyles) do
 
for i, ts in ipairs(tStyles) do
 +
local link = string.format('[[:%s]]', ts)
 
local sandboxLink = nil
 
local sandboxLink = nil
 
local tsTitle = mw.title.new(ts)
 
local tsTitle = mw.title.new(ts)
if tsTitle then
+
if tsTitle and cfg['sandbox_title'] then
local tsSandboxTitle = mw.title.new(string.format('%s:%s/sandbox/%s', tsTitle.nsText, tsTitle.baseText, tsTitle.subpageText))
+
local tsSandboxTitle = mw.title.new(string.format(
 +
'%s:%s/%s/%s', tsTitle.nsText, tsTitle.baseText, cfg['sandbox_title'], tsTitle.subpageText))
 
if tsSandboxTitle and tsSandboxTitle.exists then
 
if tsSandboxTitle and tsSandboxTitle.exists then
sandboxLink = string.format(' ([[:%s|sandbox]])', tsSandboxTitle.prefixedText)
+
sandboxLink = format('sandboxlink', link, ':' .. tsSandboxTitle.prefixedText)
 
end
 
end
 
end
 
end
tStylesLinks[i] = string.format('[[:%s]]%s', ts, sandboxLink or '')
+
tStylesLinks[i] = sandboxLink or link
 
end
 
end
 
local tStylesList = mList.makeList('bulleted', tStylesLinks)
 
local tStylesList = mList.makeList('bulleted', tStylesLinks)
boxArgs.text = 'This ' ..
+
boxArgs.text = format(
(mw.title.getCurrentTitle():inNamespaces(828,829) and 'module' or 'template') ..
+
mw.title.getCurrentTitle():inNamespaces(828,829) and 'header-module' or 'header-template') ..
' uses [[Wikipedia:TemplateStyles|TemplateStyles]]:\n' .. tStylesList
+
'\n' .. tStylesList
 
end
 
end
 
boxArgs.type = 'notice'
 
boxArgs.type = 'notice'
 
boxArgs.small = true
 
boxArgs.small = true
boxArgs.image = '[[File:Farm-Fresh css add.svg|32px|alt=CSS]]'
+
boxArgs.image = string.format('[[File:Farm-Fresh css add.svg|32px|alt=%s]]', format('logo-alt'))
 
return mMessageBox.main('mbox', boxArgs)
 
return mMessageBox.main('mbox', boxArgs)
 
end
 
end
Line 58: Line 70:
 
return ''
 
return ''
 
end
 
end
 +
 +
local cfg = getConfig()
 
 
 
local cats = {}
 
local cats = {}
 
 
 
-- Error category
 
-- Error category
if #tStyles < 1 then
+
if #tStyles < 1 and cfg['error_category'] then
cats[#cats + 1] = 'Uses TemplateStyles templates with errors'
+
cats[#cats + 1] = cfg['error_category']
 
end
 
end
 
 
 
-- TemplateStyles category
 
-- TemplateStyles category
 
titleObj = titleObj or mw.title.getCurrentTitle()
 
titleObj = titleObj or mw.title.getCurrentTitle()
local subpageBlacklist = {
 
doc = true,
 
sandbox = true,
 
sandbox2 = true,
 
testcases = true
 
}
 
 
if (titleObj.namespace == 10 or titleObj.namespace == 828)
 
if (titleObj.namespace == 10 or titleObj.namespace == 828)
and not subpageBlacklist[titleObj.subpageText]
+
and not cfg['subpage_blacklist'][titleObj.subpageText]
 
then
 
then
local category = args.category
+
local category = args.category or cfg['default_category']
if not category then
+
if category then
category = category or 'Templates using TemplateStyles'
+
cats[#cats + 1] = category
 
end
 
end
cats[#cats + 1] = category
+
if not yesno(args.noprotcat) and (cfg['protection_conflict_category'] or cfg['padlock_pattern']) then
if not yesno(args.noprotcat) then
 
 
local currentProt = titleObj.protectionLevels["edit"] and titleObj.protectionLevels["edit"][1] or nil
 
local currentProt = titleObj.protectionLevels["edit"] and titleObj.protectionLevels["edit"][1] or nil
 
local addedLevelCat = false
 
local addedLevelCat = false
Line 89: Line 96:
 
local tsTitleObj = mw.title.new(ts)
 
local tsTitleObj = mw.title.new(ts)
 
local tsProt = tsTitleObj.protectionLevels["edit"] and tsTitleObj.protectionLevels["edit"][1] or nil
 
local tsProt = tsTitleObj.protectionLevels["edit"] and tsTitleObj.protectionLevels["edit"][1] or nil
if tsProt ~= currentProt and not addedLevelCat then
+
if cfg['protection_conflict_category'] and tsProt ~= currentProt and not addedLevelCat then
cats[#cats + 1] = "Templates using TemplateStyles with a different protection level"
+
cats[#cats + 1] = cfg['protection_conflict_category']
 
end
 
end
if tsProt and not addedPadlockCat then
+
if cfg['padlock_pattern'] and tsProt and not addedPadlockCat then
 
local content = tsTitleObj:getContent()
 
local content = tsTitleObj:getContent()
if not content:find("{{pp-") then
+
if not content:find(cfg['padlock_pattern']) then
cats[#cats + 1] = "Templates using TemplateStyles without padlocks"
+
cats[#cats + 1] = cfg['missing_padlock_category']
 
addedPadlockCat = true
 
addedPadlockCat = true
 
end
 
end

Revision as of 18:48, 11 July 2020

Documentation for this module may be created at Module:Uses TemplateStyles/doc

-- This module implements the {{Uses TemplateStyles}} 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/Uses TemplateStyles', msg, ...)
end

local function getConfig()
	return mw.loadData('Module:Uses TemplateStyles/config')
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, cfg)
	local tStyles = mTableTools.compressSparseArray(args)
	local box = p.renderBox(tStyles)
	local trackingCategories = p.renderTrackingCategories(args, tStyles)
	return box .. trackingCategories
end

function p.renderBox(tStyles)
	local boxArgs = {}
	if #tStyles < 1 then
		boxArgs.text = string.format('<strong class="error">%s</strong>', format('error-emptylist'))
	else
		local cfg = getConfig()
		local tStylesLinks = {}
		for i, ts in ipairs(tStyles) do
			local link = string.format('[[:%s]]', ts)
			local sandboxLink = nil
			local tsTitle = mw.title.new(ts)
			if tsTitle and cfg['sandbox_title'] then
				local tsSandboxTitle = mw.title.new(string.format(
					'%s:%s/%s/%s', tsTitle.nsText, tsTitle.baseText, cfg['sandbox_title'], tsTitle.subpageText))
				if tsSandboxTitle and tsSandboxTitle.exists then
					sandboxLink = format('sandboxlink', link, ':' .. tsSandboxTitle.prefixedText)
				end
			end
			tStylesLinks[i] = sandboxLink or link
		end
		local tStylesList = mList.makeList('bulleted', tStylesLinks)
		boxArgs.text = format(
			mw.title.getCurrentTitle():inNamespaces(828,829) and 'header-module' or 'header-template') ..
			'\n' .. tStylesList
	end
	boxArgs.type = 'notice'
	boxArgs.small = true
	boxArgs.image = string.format('[[File:Farm-Fresh css add.svg|32px|alt=%s]]', format('logo-alt'))
	return mMessageBox.main('mbox', boxArgs)
end

function p.renderTrackingCategories(args, tStyles, titleObj)
	if yesno(args.nocat) then
		return ''
	end
	
	local cfg = getConfig()
	
	local cats = {}
	
	-- Error category
	if #tStyles < 1 and cfg['error_category'] then
		cats[#cats + 1] = cfg['error_category']
	end
	
	-- TemplateStyles category
	titleObj = titleObj or mw.title.getCurrentTitle()
	if (titleObj.namespace == 10 or titleObj.namespace == 828)
		and not cfg['subpage_blacklist'][titleObj.subpageText]
	then
		local category = args.category or cfg['default_category']
		if category then
			cats[#cats + 1] = category
		end
		if not yesno(args.noprotcat) and (cfg['protection_conflict_category'] or cfg['padlock_pattern']) then
			local currentProt = titleObj.protectionLevels["edit"] and titleObj.protectionLevels["edit"][1] or nil
			local addedLevelCat = false
			local addedPadlockCat = false
			for i, ts in ipairs(tStyles) do
				local tsTitleObj = mw.title.new(ts)
				local tsProt = tsTitleObj.protectionLevels["edit"] and tsTitleObj.protectionLevels["edit"][1] or nil
				if cfg['protection_conflict_category'] and tsProt ~= currentProt and not addedLevelCat then
					cats[#cats + 1] = cfg['protection_conflict_category']
				end
				if cfg['padlock_pattern'] and tsProt and not addedPadlockCat then
					local content = tsTitleObj:getContent()
					if not content:find(cfg['padlock_pattern']) then
						cats[#cats + 1] = cfg['missing_padlock_category']
						addedPadlockCat = true
					end
				end
			end
		end
	end
	for i, cat in ipairs(cats) do
		cats[i] = string.format('[[Category:%s]]', cat)
	end
	return table.concat(cats)
end

return p