Difference between revisions of "Module:Uses TemplateStyles"

From Sinfronteras
Jump to: navigation, search
en>Evad37
(nocat for noincluded example)
 
en>Pppery
(Fixing logic)
Line 1: Line 1:
<includeonly>{{#invoke:Uses TemplateStyles|main}}</includeonly><noinclude>
+
-- This module implements the {{Uses TemplateStyles}} template.
{{Uses TemplateStyles|Template:Uses TemplateStyles/example.css|nocat=true}}
+
local yesno = require('Module:Yesno')
{{documentation}}
+
local mList = require('Module:List')
<!-- Categories go on the /doc subpage and interwikis go on Wikidata. -->
+
local mTableTools = require('Module:TableTools')
</noinclude>
+
local mMessageBox = require('Module:Message box')
 +
 
 +
local p = {}
 +
 
 +
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 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 = '<strong class="error">Error: no TemplateStyles specified</strong>'
 +
else
 +
local tStylesLinks = {}
 +
for i, ts in ipairs(tStyles) do
 +
local sandboxLink = nil
 +
local tsTitle = mw.title.new(ts)
 +
if tsTitle then
 +
local tsSandboxTitle = mw.title.new(string.format('%s:%s/sandbox/%s', tsTitle.nsText, tsTitle.baseText, tsTitle.subpageText))
 +
if tsSandboxTitle and tsSandboxTitle.exists then
 +
sandboxLink = string.format(' ([[:%s|sandbox]])', tsSandboxTitle.prefixedText)
 +
end
 +
end
 +
tStylesLinks[i] = string.format('[[:%s]]%s', ts, sandboxLink or '')
 +
end
 +
local tStylesList = mList.makeList('bulleted', tStylesLinks)
 +
boxArgs.text = 'This ' ..
 +
(mw.title.getCurrentTitle():inNamespaces(828,829) and 'module' or 'template') ..
 +
' uses [[Wikipedia:TemplateStyles|TemplateStyles]]:\n' .. tStylesList
 +
end
 +
boxArgs.type = 'notice'
 +
boxArgs.small = true
 +
boxArgs.image = '[[File:Farm-Fresh css add.svg|32px|alt=CSS]]'
 +
return mMessageBox.main('mbox', boxArgs)
 +
end
 +
 
 +
function p.renderTrackingCategories(args, tStyles, titleObj)
 +
if yesno(args.nocat) then
 +
return ''
 +
end
 +
 +
local cats = {}
 +
 +
-- Error category
 +
if #tStyles < 1 then
 +
cats[#cats + 1] = 'Uses TemplateStyles templates with errors'
 +
end
 +
 +
-- TemplateStyles category
 +
titleObj = titleObj or mw.title.getCurrentTitle()
 +
local subpageBlacklist = {
 +
doc = true,
 +
sandbox = true,
 +
sandbox2 = true,
 +
testcases = true
 +
}
 +
if (titleObj.namespace == 10 or titleObj.namespace == 828)
 +
and not subpageBlacklist[titleObj.subpageText]
 +
then
 +
local category = args.category
 +
if not category then
 +
category = category or 'Templates using TemplateStyles'
 +
end
 +
cats[#cats + 1] = category
 +
if not yesno(args.noprotcat) 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 tsProt ~= currentProt and not addedLevelCat then
 +
cats[#cats + 1] = "Templates using TemplateStyles with a different protection level"
 +
end
 +
if tsProt and not addedPadlockCat then
 +
local content = tsTitleObj:getContent()
 +
if not content:find("{{pp-") then
 +
cats[#cats + 1] = "Templates using TemplateStyles without padlocks"
 +
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

Revision as of 21:33, 4 March 2019

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

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 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 = '<strong class="error">Error: no TemplateStyles specified</strong>'
	else
		local tStylesLinks = {}
		for i, ts in ipairs(tStyles) do
			local sandboxLink = nil
			local tsTitle = mw.title.new(ts)
			if tsTitle then
				local tsSandboxTitle = mw.title.new(string.format('%s:%s/sandbox/%s', tsTitle.nsText, tsTitle.baseText, tsTitle.subpageText))
				if tsSandboxTitle and tsSandboxTitle.exists then
					sandboxLink = string.format(' ([[:%s|sandbox]])', tsSandboxTitle.prefixedText)
				end
			end
			tStylesLinks[i] = string.format('[[:%s]]%s', ts, sandboxLink or '')
		end
		local tStylesList = mList.makeList('bulleted', tStylesLinks)
		boxArgs.text = 'This ' .. 
			(mw.title.getCurrentTitle():inNamespaces(828,829) and 'module' or 'template') ..
			' uses [[Wikipedia:TemplateStyles|TemplateStyles]]:\n' .. tStylesList
	end
	boxArgs.type = 'notice'
	boxArgs.small = true
	boxArgs.image = '[[File:Farm-Fresh css add.svg|32px|alt=CSS]]'
	return mMessageBox.main('mbox', boxArgs)
end

function p.renderTrackingCategories(args, tStyles, titleObj)
	if yesno(args.nocat) then
		return ''
	end
	
	local cats = {}
	
	-- Error category
	if #tStyles < 1 then
		cats[#cats + 1] = 'Uses TemplateStyles templates with errors'
	end
	
	-- TemplateStyles category
	titleObj = titleObj or mw.title.getCurrentTitle()
	local subpageBlacklist = {
		doc = true,
		sandbox = true,
		sandbox2 = true,
		testcases = true
	}
	if (titleObj.namespace == 10 or titleObj.namespace == 828)
		and not subpageBlacklist[titleObj.subpageText]
	then
		local category = args.category
		if not category then
			category = category or 'Templates using TemplateStyles'
		end
		cats[#cats + 1] = category
		if not yesno(args.noprotcat) 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 tsProt ~= currentProt and not addedLevelCat then
					cats[#cats + 1] = "Templates using TemplateStyles with a different protection level"
				end
				if tsProt and not addedPadlockCat then
					local content = tsTitleObj:getContent()
					if not content:find("{{pp-") then
						cats[#cats + 1] = "Templates using TemplateStyles without padlocks"
						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