پودمان:Portal

توضیحات این پودمان می‌تواند در پودمان:Portal/توضیحات قرار گیرد.

--[==[ This module is a Lua implementation of the old {{Portal}} template. As of August 2013 it is used on nearly 5,000,000 articles.
-- Please take care when updating it! It outputs two functions: p.portal, which generates a table of portals, and p.image, which
-- produces the image name for an individual portal.

-- The portal image data is kept in submodules of [[Module:Portal/images]], listed below:
-- [[Module:Portal/images/آ]]       - for portal names beginning with "آ".
-- [[Module:Portal/images/ا]]       - for portal names beginning with "ا".
-- [[Module:Portal/images/ب]]       - for portal names beginning with "ب".
-- [[Module:Portal/images/پ]]       - for portal names beginning with "پ".
-- [[Module:Portal/images/ت]]       - for portal names beginning with "ت".
-- [[Module:Portal/images/ث]]       - for portal names beginning with "ث".
-- [[Module:Portal/images/ج]]       - for portal names beginning with "ج".
-- [[Module:Portal/images/چ]]       - for portal names beginning with "چ".
-- [[Module:Portal/images/ح]]       - for portal names beginning with "ح".
-- [[Module:Portal/images/خ]]       - for portal names beginning with "خ".
-- [[Module:Portal/images/د]]       - for portal names beginning with "د".
-- [[Module:Portal/images/ذ]]       - for portal names beginning with "ذ".
-- [[Module:Portal/images/ر]]       - for portal names beginning with "ر".
-- [[Module:Portal/images/ز]]       - for portal names beginning with "ز".
-- [[Module:Portal/images/ژ]]       - for portal names beginning with "ژ".
-- [[Module:Portal/images/س]]       - for portal names beginning with "س".
-- [[Module:Portal/images/ش]]       - for portal names beginning with "ش".
-- [[Module:Portal/images/ص]]       - for portal names beginning with "ص".
-- [[Module:Portal/images/ض]]       - for portal names beginning with "ض".
-- [[Module:Portal/images/ط]]       - for portal names beginning with "ط".
-- [[Module:Portal/images/ظ]]       - for portal names beginning with "ظ".
-- [[Module:Portal/images/ع]]       - for portal names beginning with "ع".
-- [[Module:Portal/images/غ]]       - for portal names beginning with "غ".
-- [[Module:Portal/images/ف]]       - for portal names beginning with "ف".
-- [[Module:Portal/images/ق]]       - for portal names beginning with "ق".
-- [[Module:Portal/images/ک]]       - for portal names beginning with "ک".
-- [[Module:Portal/images/گ]]       - for portal names beginning with "گ".
-- [[Module:Portal/images/ل]]       - for portal names beginning with "ل".
-- [[Module:Portal/images/م]]       - for portal names beginning with "م".
-- [[Module:Portal/images/ن]]       - for portal names beginning with "ن".
-- [[Module:Portal/images/و]]       - for portal names beginning with "و".
-- [[Module:Portal/images/ه]]       - for portal names beginning with "ه".
-- [[Module:Portal/images/ی]]       - for portal names beginning with "ی".
-- [[Module:Portal/images/دیگر]]	- for portal names beginning with any other letters. This includes numbers,
-- 									  letters with diacritics, and letters in non-Latin alphabets.
-- [[Module:Portal/images/مستعارها]]	- for adding aliases for existing portal names. Use this page for variations
-- 									  in spelling and diacritics, etc., no matter what letter the portal begins with.
--
-- The images data pages are separated by the first letter to reduce server load when images are added, changed, or removed.
-- Previously all the images were on one data page at [[Module:Portal/images]], but this had the disadvantage that all
-- 5,000,000 pages using this module needed to be refreshed every time an image was added or removed.
]==]

local p = {}

-- IMPORTANT: isSandbox should be different between Module:Portal and Module:Portal/تمرین
-- That should be the only difference between the main and sandbox version
local isSandbox = false

local templatestyles = 'Module:Portal/'..(isSandbox and 'تمرین/' or '')..'styles.css'

local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local numConv = require('Module:Numeral converter').convert

-- List of non-talk namespaces which should not be tracked (Talk pages are never tracked)
local badNamespaces = {'کاربر','الگو','پیش‌نویس'}

-- Check whether to do tracking in this namespace
-- Returns true unless the page is one of the banned namespaces
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)
	-- Finds the appropriate image subpage given a lower-case
	-- portal name plus the first letter of that portal name.
	if type(s) ~= 'string' or #s < 1 then return end
	local firstLetter = mw.ustring.sub(s, 1, 1)
	local imagePage
	-- برای شناسایی صفحات فارسی رجکس خط زیر تغییر کرده‌است.
	if mw.ustring.find(firstLetter, '^[اآبپتثجچحخدذرزژسشصضطظعغفقکگلمنوهی]') and mw.title.makeTitle(828, 'Portal/images/' .. firstLetter).exists then
		imagePage = 'Module:Portal/images/' .. firstLetter .. (isSandbox and '/تمرین' or '')
	else
		imagePage = 'Module:Portal/images/دیگر' .. (isSandbox and '/تمرین' or '')
	end
	return mw.loadData(imagePage)[s]
end

local function getAlias(s)
	-- Gets an alias from the image alias data page.
	local aliasData = mw.loadData('Module:Portal/images/مستعارها' .. (isSandbox and '/تمرین' or ''))
	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)
	-- Gets the image name for a given string.
	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
	-- check for too few portals
	if #portals < args.minPortals then
		errMsg = 'لطفاً دست کم ' .. numConv('fa', args.minPortals) .. ' درگاه را مشخص کنید'
		trackingCat = (trackingEnabled and '[[رده:الگوهای درگاه با درگاه‌های خیلی کم]]' or '')
		return portals, trackingCat, errMsg
	end
	-- check for too many portals
	if args.maxPortals >= 0 and #portals > args.maxPortals then
		errMsg = 'تعداد درگاه‌های بیش از اندازه است (حداکثر = ' .. numConv('fa', args.maxPortals) .. ')'
		trackingCat = (trackingEnabled and '[[رده:الگوهای درگاه با درگاه‌های خیلی زیاد]]' or '')
		return portals, trackingCat, errMsg
	end
	if not args.redlinks or trackingEnabled then
		-- make new list of portals that exist
		local existingPortals = {}
		for _, portal in ipairs(portals) do
			local portalTitle = mw.title.new(portal, "درگاه")
			-- if portal exists, put it into list
			if portalTitle and portalTitle.exists then
				table.insert(existingPortals, portal)
			-- otherwise set tracking cat
			elseif trackingEnabled then
				trackingCat = "[[رده:الگوهای درگاه با درگاه‌های ناموجود]]"
			end
		end
		-- If redlinks is off, use portal list purged of redlinks
		portals = (args.redlinks or args['پیوند قرمز']) and portals or existingPortals
		-- if nothing left after purge, set tracking cat
		if #portals == 0 then
			trackingCat = trackingCat..(trackingEnabled and "[[رده:صفحه‌های حاوی الگوی درگاه خالی]]" or "")
		end
	end
	return portals, trackingCat, errMsg
end

function p._portal(portals, args)
	-- This function builds the portal box used by the {{portal}} template.
		
	-- Normalize all arguments
	if (args.redlinks == 'include' or args['پیوند قرمز'] == 'درج') then args.redlinks = true end
	args.addBreak = args['break'] or args['شکستن']
	for key, default in pairs({left = false, tracking = true, nominimum = false, redlinks = false, addBreak = false}) 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', 'درگاه‌ها')
		:addClass('noprint portalbox plainlist')
		:addClass((args.right or args['راست']) and 'tright' or 'tleft')
		:css('margin', args.margin or args['حاشیه'] 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 error message, put it in the box and return
	if errMsg then
		local errTag = root:tag('strong')
		errTag:addClass('error')
		errTag:css('padding','0.2em')
		errTag:wikitext('خطا: '..errMsg)
		return tostring(root)
	end
	-- if no portals (and no error), just return tracking category
	if #portals == 0 then
		return trackingCat
	end

	-- Start the list. This corresponds to the start of the wikitext table in the old [[Template:Portal]].
	local listroot = root:tag('ul')
		:css('width', (tonumber(args.boxsize or args['اندازه جعبه']) or 0) > 0
			and (args.boxsize or args['اندازه جعبه'] .. 'px')
			or (args.boxsize or args['اندازه جعبه']) )

	-- 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(mw.ustring.format('[[پرونده:%s|32x28px|class=noviewer]]', image))
					:done()
				:tag('span')
					:wikitext(mw.ustring.format('[[درگاه:%s|درگاه%s%s]]', portal, (args['break'] or args['شکستن']) and '<br />' or ' ', portal))
	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 mw.ustring.match(name, '^(.-)|') 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{'ا', 'آ', 'ب', 'پ', 'ت', 'ث',
							 'ج', 'چ', 'ح', 'خ', 'د', 'ذ',
							 'ر', 'ز', 'ژ', 'س', 'ش', 'ص', 'ض',
							 'ط', 'ظ', 'ع', 'غ', 'ف', 'ق',
							 'ک', 'گ', 'ل', 'م',
							 'ن', 'و', 'ه', 'ی', 'دیگر'} do
		images[i] = mw.loadData('Module:Portal/images/' .. subpage .. (isSandbox and '/تمرین' or ''))
	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, mw.ustring.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