Jump to content

Մոդուլ:Official website

Documentation for this module may be created at Մոդուլ:Official website/doc

local makeUrl = require('Module:URL')._url

local p = {}

-- Wikidata numeric IDs of the languages to prefer, best first.
-- 180945 = Western Armenian, 8785 = Armenian.
local preferredLanguages = {180945, 8785}

-- Wrapper for pcall which returns nil on failure.
local function quickPcall(func)
	local success, result = pcall(func)
	if success then
		return result
	end
end

-- Gets the rank for a Wikidata property table. Returns 1, 0 or -1, in
-- order of rank.
local function getRank(prop)
	local rank = prop.rank
	if rank == 'preferred' then
		return 1
	elseif rank == 'normal' then
		return 0
	elseif rank == 'deprecated' then
		return -1
	else
		-- No rank or undefined rank is treated as "normal".
		return 0
	end
end

-- Finds how highly a property's language qualifier ranks in
-- preferredLanguages. Lower is better. Properties with no preferred
-- language qualifier sort last.
local function getLanguageOrder(prop)
	local ret = quickPcall(function ()
		for i, lang in ipairs(prop.qualifiers.P407) do
			local id = lang.datavalue.value['numeric-id']
			for j, preferred in ipairs(preferredLanguages) do
				if id == preferred then
					return j
				end
			end
		end
		return nil
	end)
	return ret or math.huge
end

-- Fetches the official website URL from Wikidata.
local fetchWikidataUrl
fetchWikidataUrl = function()
	-- Get objects for all official sites on Wikidata.
	local websites = quickPcall(function ()
		return mw.wikibase.getEntityObject().claims.P856
	end)

	-- Clone the objects in case other code needs them in their original order.
	websites = websites and mw.clone(websites) or {}

	-- Add the table index to the objects in case it is needed in the sort.
	for i, website in ipairs(websites) do
		website._index = i
	end

	-- Sort the websites, first by highest rank, then by preferred language,
	-- then by the website's original position in the property list. When we
	-- are done, get the URL from the highest-sorted object.
	table.sort(websites, function(ws1, ws2)
		local r1 = getRank(ws1)
		local r2 = getRank(ws2)
		if r1 ~= r2 then
			return r1 > r2
		end
		local l1 = getLanguageOrder(ws1)
		local l2 = getLanguageOrder(ws2)
		if l1 ~= l2 then
			return l1 < l2
		end
		return ws1._index < ws2._index
	end)
	local url = quickPcall(function ()
		return websites[1].mainsnak.datavalue.value
	end)

	-- Cache the result so that we only do the heavy lifting once per #invoke.
	fetchWikidataUrl = function ()
		return url
	end

	return url
end

-- Render the "edit at Wikidata" pencil, or an empty string if the page
-- has no Wikidata item.
local function renderWikidataPencil()
	local entity = mw.wikibase.getEntityObject() or {}
	local qid = entity.id
	if not qid then
		return ''
	end
	return '[[File:OOjs UI icon edit-ltr-progressive.svg |frameless |text-top |10px'
		.. ' |alt=Խմբագրել ասիկա Ուիքիտուեալներու մէջ'
		.. ' |link=https://www.wikidata.org/wiki/' .. qid .. '#P856'
		.. '|Խմբագրել ասիկա Ուիքիտուեալներու մէջ]]'
end

-- Render the URL link, plus other visible output.
local function renderUrl(options)
	if not options.url and not options.wikidataurl then
		local ret = {'<strong class="error">'
			.. 'URL չգտնուեցաւ։ Նշեցէք URL մը հոս, կամ աւելցուցէք զայն Ուիքիտուեալներու մէջ։'
			.. '</strong>'}
		local pencil = renderWikidataPencil()
		if pencil ~= '' then
			ret[#ret + 1] = pencil
		end
		return table.concat(ret, ' ')
	end
	local ret = {}
	ret[#ret + 1] = string.format(
		'<span class="official-website">%s</span>',
		makeUrl(options.url or options.wikidataurl, options.display)
	)
	if options.wikidataurl and not options.url then
		local pencil = renderWikidataPencil()
		if pencil ~= '' then
			ret[#ret + 1] = pencil
		end
	end
	if options.mobile then
		ret[#ret + 1] = '(' .. makeUrl(options.mobile, 'Բջջային') .. ')'
	end
	return table.concat(ret, ' ')
end

-- Render the tracking category.
local function renderTrackingCategory(url, wikidataurl)
	if mw.title.getCurrentTitle().namespace ~= 0 then
		return ''
	end
	local category
	if not url and not wikidataurl then
		category = 'Պաշտօնական կայքէջ առանց URL-ի'
	elseif not url and wikidataurl then
		return ''
	elseif url and wikidataurl then
		if mw.ustring.gsub(url, '/%s*$', '') ~= mw.ustring.gsub(wikidataurl, '/%s*$', '') then
			category = 'Ուիքիտուեալներու եւ Ուիքիփետիայի պաշտօնական կայքէջերը տարբեր'
		end
	else
		category = 'Ուիքիտուեալներու մէջ չգտնուող պաշտօնական կայքէջ'
	end
	return category and string.format('[[Ստորոգութիւն:%s]]', category) or ''
end

function p._main(args)
	local url = args[1] or args.URL or args.url
	local wikidataurl = fetchWikidataUrl()
	local formattedUrl = renderUrl{
		url = url,
		wikidataurl = wikidataurl,
		display = args[2] or args.name or 'Պաշտօնական կայքէջ',
		mobile = args.mobile
	}
	return formattedUrl .. renderTrackingCategory(url, wikidataurl)
end

-- Outputs the URL itself rather than a named link, and outputs nothing at
-- all when Wikidata has no value. For use inside infoboxes.
function p._url(args)
	local wikidataurl = fetchWikidataUrl()
	if not wikidataurl then
		return ''
	end
	local ret = {}
	ret[#ret + 1] = string.format(
		'<span class="official-website">%s</span>',
		makeUrl(wikidataurl)
	)
	local pencil = renderWikidataPencil()
	if pencil ~= '' then
		ret[#ret + 1] = pencil
	end
	return table.concat(ret, ' ')
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = {
			'Կաղապար:Official website',
			'Template:Official website'
		}
	})
	return p._main(args)
end

-- Entrypoint for Template:Official URL.
function p.url(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = {
			'Կաղապար:Official URL',
			'Template:Official URL'
		}
	})
	return p._url(args)
end

return p