Модуль:Пісочниця/Stiltezh/Portal

Документація модуля[створити]

--[==[ Цей модуль є реалізацією мовою Lua старого шаблону {{портал}}. Станом на квітень 2022 він використовується майже у 939 962 статтях.
-- Будь ласка, будьте обережні під час його оновлення! Він виводить дві функції: p.portal, що генерує список порталів, та p.image,
-- яка видає назву зображення для окремого порталу.

-- Дані зображень порталу зберігаються в підмодулях [[Модуль:Portal/images]], наведених нижче:
-- [[Модуль:Portal/images/all]]	    — для всіх назв порталів, окрім що містяться в підмодулях "other" та "aliases".
-- [[Модуль:Portal/images/other]]	— для всіх назв порталів, що починаються з інших літер. Сюди входять:
-- 									  цифри, літери з діакритичними знаками та літери латинського алфавіту.
-- [[Модуль:Portal/images/aliases]]	— для додавання псевдонімів до існуючих імен порталів. Використовуйте цю сторінку
-- 									  для варіацій у написанні, діакритичних знаків тощо, незалежно від того, на яку літеру починається портал.
--
-- Сторінки даних зображень поділяються лише на три підмодуля через невелику кількість,
-- яка не суттєво знизить навантаження на серверпри додаванні, зміні або видаленні зображень.
-- Раніше на англомовному розділі Вікіпедії всі зображення знаходилися на одній сторінці даних
-- у [[Модуль:Portal/images]], але це мало той недолік, що всі 5 000 000 сторінок, які використовують цей модуль,
-- необхідно було оновлювати кожного разу, коли зображення додалося або видалялося.
]==]

local p = {}

-- визначити, чи викликають нас із пісочниці
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true)
local sandbox = isSandbox and '/пісочниця' or ''

local function sandboxVersion(s)
	return isSandbox and s..'-sand' or s
end

local templatestyles = 'Модуль:Portal/пісочниця/styles.css'

local getArgs = require('Модуль:Arguments').getArgs
local yesno = require('Модуль:Yesno')

-- Список нетлумачних просторів імен, які не повинні відстежуватись (сторінки обговорення ніколи не відстежуються)
local badNamespaces = {'user','template','draft','wikipedia','користувач','шаблон','вікіпедія','обговорення'}

-- Перевірте, чи потрібно відстежувати в цьому просторі імена
-- Повертає true, якщо сторінка не належить до одного із заборонених просторів імен
local function checkTracking(title)
	local thisPage = title or mw.title.getCurrentTitle()
	if thisPage.isTalkPage then
		return false
	end
	local ns = thisPage.nsText:lower()
	for _, v in ipairs(badNamespaces) do
		if ns == v then
			return false
		end
	end
	return true
end

local function matchImagePage(s)
	-- Знаходить відповідну підсторінку зображення, задану назвою порталу.
	if type(s) ~= 'string' or #s < 1 then return end
	local firstLetter = mw.ustring.sub(s, 1, 1)
	local imagePage
	if mw.ustring.find then
		imagePage = 'Модуль:Portal/images/all/пісочниця'
	else
		imagePage = 'Модуль:Portal/images/other/пісочниця'
	end
	return mw.loadData(imagePage)[s]
end

local function getAlias(s)
	-- Отримує псевдонім із сторінки даних псевдоніма зображення.
	local aliasData = mw.loadData('Модуль:Portal/images/aliases/пісочниця')
	for portal, aliases in pairs(aliasData) do
		for _, alias in ipairs(aliases) do
			if alias == s then
				return portal
			end
		end
	end
end

local function getImageName(s)
	-- Отримує назву зображення для заданого рядка.
	local default = 'Portal-puzzle.svg|link=|alt='
	if type(s) ~= 'string' or #s < 1 then
		return default
	end
	s = mw.ustring.lower(s)
	return matchImagePage(s) or matchImagePage(getAlias(s)) or default
end

 -- Function to check argument portals for errors, generate tracking categories if needed
 --     Function first checks for too few/many portals provided
 --     Then checks the portal list to purge any portals that don't exist
 -- Arguments:
 --   portals: raw list of portals
 --   args.tracking: is tracking requested? (will not track on bad titles or namespaces)
 --   args.redlinks: should redlinks be displayed?
 --   args.minPortals: minimum number of portal arguments
 --   args.maxPortals: maximum number of portal arguments
 -- Returns:
 --   portals = list of portals, with redlinks purged (if args.redlinks=false)
 --   trackingCat = possible tracking category
 --   errorMsg = error message
function p._checkPortals(portals, args)
	local trackingCat = ''
	local errMsg = nil
	
	-- Tracking is on by default.
	-- It is disabled if any of the following is true
	-- 1/ the parameter "tracking" is set to 'no, 'n', or 'false'
	-- 2/ the current page fails the namespace or pagename tests 
	local trackingEnabled = args.tracking and checkTracking()
	
	args.minPortals = args.minPortals or 1
	args.maxPortals = args.maxPortals or -1
	-- перевірте, чи не надто мало порталів
	if #portals < args.minPortals then
		errMsg = 'будь ласка, вкажіть не менше '..args.minPortals..' портал'..(args.minPortals > 1 and 'ів' or 'а')
		trackingCat = (trackingEnabled and '[[Категорія:Шаблони порталів із дуже малою кількістю порталів]]' or '')
		return portals, trackingCat, errMsg
	end
	-- перевірте, чи не надто багато порталів
	if args.maxPortals >= 0 and #portals > args.maxPortals then
		errMsg = 'надто багато порталів (максимум = '..args.maxPortals..')'
		trackingCat = (trackingEnabled and '[[Категорія:Шаблони порталів із надто великою кількістю порталів]]' or '')
		return portals, trackingCat, errMsg
	end
	if not args.redlinks or trackingEnabled then
		-- скласти новий список існуючих порталів
		local existingPortals = {}
		for _, portal in ipairs(portals) do
			local portalTitle = mw.title.new(portal,"Портал")
			-- якщо портал існує, помістіть його до списку
			if portalTitle and portalTitle.exists then
				table.insert(existingPortals,portal)
			-- в іншому випадку встановлює категорію відстеження
			elseif trackingEnabled then
				trackingCat = "[[Категорія:Шаблони порталів із червоними посиланнями]]"
			end
		end
		-- Якщо параметр redlinks вимкнено, використовуйте список порталів, очищений від redlinks
		portals = args.redlinks and portals or existingPortals
		-- якщо після очищення нічого не залишилося, встановлює категорію відстеження
		if #portals == 0 and trackingEnabled then
			trackingCat = trackingCat.."[[Категорія:Сторінки з порожнім шаблоном порталу]]" 
		end
	end
	return portals, trackingCat, errMsg
end

function p._portal(portals, args)
	-- Ця функція створює поле порталу, яке використовується шаблоном {{портал}}..
	
	-- Нормалізуйте всі аргументи
	if args.redlinks == 'include' then args.redlinks = true end
	args.addBreak = args['break']
	for key, default in pairs({left=false,tracking=true,nominimum=false,
		                       redlinks=false,addBreak=false,border=true}) do
		if args[key] == nil then args[key] = default end
		args[key] = yesno(args[key], default)
	end

	local root = mw.html.create('div')
		:attr('role', 'navigation')
		:attr('aria-label', 'Portals')
		:addClass('noprint plainlist')
		:addClass(sandboxVersion('portalbox'))
		:addClass(args.border and sandboxVersion('portalborder') or '')
		:addClass(args.left and 'tleft' or 'tright')
		:css('margin', args.margin or nil)
		:newline()

	local trackingCat = ''
	local errMsg = nil
	args.minPortals = args.nominimum and 0 or 1
	args.maxPortals = -1
	portals, trackingCat, errMsg = p._checkPortals(portals, args)
	root:wikitext(trackingCat)
	-- якщо повідомлення про помилку, помістіть його в поле та поверніться назад
	if errMsg then
		if args.border then -- suppress error message when border=no
			local errTag = root:tag('strong')
			errTag:addClass('error')
			errTag:css('padding','0.2em')
			errTag:wikitext('Помилка: '..errMsg)
		end
		return tostring(root)
	end
	-- якщо порталів немає (і немає помилки), просто поверніть категорію відстеження
	if #portals == 0 then
		return trackingCat
	end

	-- Розпочати список. Це відповідає початку таблиці вікітексту у старому варіанті [[Шаблон:Портал]].
	local listroot = root:tag('ul')
		:css('width', (tonumber(args.boxsize) or 0) > 0 and (args.boxsize .. 'px') or args.boxsize)

	-- Display the portals specified in the positional arguments.
	for _, portal in ipairs(portals) do
		local image = getImageName(portal)

		-- Generate the html for the image and the portal name.
		listroot
			:newline()
			:tag('li')
				:tag('span')
					:wikitext(string.format('[[Файл:%s|32x28px|class=noviewer]]', image))
					:done()
				:tag('span')
					:wikitext(string.format('[[Портал:%s|Портал «%s»]]', portal, portal, args.addBreak and '<br />' or ' '))
	end
	return tostring(root)
end

function p._image(portals)
	-- Wrapper function to allow getImageName() to be accessed through #invoke.
	local name = getImageName(portals[1])
	return name:match('^(.-)|') or name -- FIXME: use a more elegant way to separate borders etc. from the image name
end

local function getAllImageTables()
	-- Returns an array containing all image subpages (minus aliases) as loaded by mw.loadData.
	local images = {}
	for i, subpage in ipairs{'all', 'other'} do
		images[i] = mw.loadData('Модуль:Portal/images/' .. subpage .. '/пісочниця')
	end
	return images
end

function p._displayAll(portals, args)
	-- This function displays all portals that have portal images. This function is for maintenance purposes and should not be used in
	-- articles, for two reasons: 1) there are over 1500 portals with portal images, and 2) the module doesn't record how the portal
	-- names are capitalized, so the portal links may be broken.
	local lang = mw.language.getContentLanguage()
	local count = 1
	for _, imageTable in ipairs(getAllImageTables()) do
		for portal in pairs(imageTable) do
			portals[count] = lang:ucfirst(portal)
			count = count + 1
		end
	end
	return p._portal(portals, args)
end

function p._imageDupes()
	-- This function searches the image subpages to find duplicate images. If duplicate images exist, it is not necessarily a bad thing,
	-- as different portals might just happen to choose the same image. However, this function is helpful in identifying images that
	-- should be moved to a portal alias for ease of maintenance.
	local exists, dupes = {}, {}
	for _, imageTable in ipairs(getAllImageTables()) do
		for portal, image in pairs(imageTable) do
			if not exists[image] then
				exists[image] = portal
			else
				table.insert(dupes, string.format('Зображення "[[:Файл:%s|%s]]" використовується для обох порталів "%s" та "%s".', image, image, exists[image], portal))
			end
		end
	end
	if #dupes < 1 then
		return 'Дублікати зображень не знайдені.'
	else
		return 'Були виявлені такі дублікати зображень:\n* ' .. table.concat(dupes, '\n* ')
	end
end

local function processPortalArgs(args)
	-- This function processes a table of arguments and returns two tables: an array of portal names for processing by ipairs, and a table of
	-- the named arguments that specify style options, etc. We need to use ipairs because we want to list all the portals in the order
	-- they were passed to the template, but we also want to be able to deal with positional arguments passed explicitly, for example
	-- {{portal|2=Politics}}. The behaviour of ipairs is undefined if nil values are present, so we need to make sure they are all removed.
	args = type(args) == 'table' and args or {}
	local portals = {}
	local namedArgs = {}
	for k, v in pairs(args) do
		if type(k) == 'number' and type(v) == 'string' then -- Make sure we have no non-string portal names.
			table.insert(portals, k)
		elseif type(k) ~= 'number' then
			namedArgs[k] = v
		end
	end
	table.sort(portals)
	for i, v in ipairs(portals) do
		portals[i] = args[v]
	end
	return portals, namedArgs
end

-- Entry point for sorting portals from other named arguments
function p._processPortalArgs(args)
	return processPortalArgs(args)
end

local function makeWrapper(funcName)
	-- Processes external arguments and sends them to the other functions.
	return function (frame)
		-- If called via #invoke, use the args passed into the invoking
		-- template, or the args passed to #invoke if any exist. Otherwise
		-- assume args are being passed directly in from the debug console
		-- or from another Lua module. 
		-- Also: trim whitespace and remove blank arguments
		local origArgs = getArgs(frame)
		-- create two tables to pass to func: an array of portal names, and a table of named arguments.
		local portals, args = processPortalArgs(origArgs)
		local results = ''
		if funcName == '_portal' or funcName == '_displayAll' then
			results = frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} }
		end
		return results .. p[funcName](portals, args) 
	end
end

for _, funcName in ipairs{'portal', 'image', 'imageDupes', 'displayAll'} do
	p[funcName] = makeWrapper('_' .. funcName)
end

return p