Modulo:Wikidata

--[[
* Modulo per implementare le funzionalità dei template {{Wikidata}}, {{WikidataQ}} e {{WikidataN}}.
* Permette di accedere a Wikidata in modo più avanzato rispetto a {{#property}}.

* Il modulo è stato importato inizialmente da:
* http://test2.wikipedia.org/w/index.php?title=Module:Wikidata&oldid=52322
]]

require('Module:No globals')

local getArgs = require('Module:Arguments').getArgs

-- Messaggi di errore
local i18n = {
	["errors"] = {
		["property-param-not-provided"] = "Parametro ''property'' non fornito.",
		["qualifier-param-not-provided"] = "Parametro ''qualifier'' non fornito.",
		["entity-not-found"] = "Entità non trovata.",
		["unknown-claim-type"] = "Tipo asserzione sconosciuta.",
		["unknown-snak-type"] = "Tipo di snak sconosciuto.",
		["unknown-datavalue-type"] = "Tipo di dato sconosciuto.",
		["unknown-entity-type"] = "Tipo di entità sconosciuta."
	},
	["somevalue"] = "''valore sconosciuto''",
	["novalue"] = "''nessun valore''"
}

-------------------------------------------------------------------------------
--                             Formatters
-------------------------------------------------------------------------------

local function formatError(key)
	return '<span class="error">' .. i18n.errors[key] .. '</span>'
end

local function formatEntityId(entityId, options, formatting)
	if formatting == 'raw' then
		return entityId
	end

	local label = mw.wikibase.label(entityId)
	local link = mw.wikibase.sitelink(entityId)
	if link then
		if label then
			return '[[' .. link .. '|' .. label .. ']]'
		else
			return '[[' .. link .. ']]'
		end
	else
		return label or ''
	end
end

local function formatTime(value, options)
	local year, month, day
	local ret = ''
 
	year, month, day = value.time:match('.+(%d%d%d%d%d)%-(%d%d)%-(%d%d).+')
	if value.precision == 9 then
		ret = tonumber(year)
	elseif value.precision == 10 then
		ret = mw.getLanguage('it'):formatDate('F Y', tonumber(year) .. '-' .. month)
	elseif value.precision == 11 then
		ret = mw.getLanguage('it'):formatDate('j F Y', tonumber(year) .. '-' .. month .. '-' .. day)
		ret = ret:gsub('^1%s', '1º ')
	end
	if value.precision >= 9 and value.precision <= 11 then
		ret = ret .. (value.time:sub(1, 1) == '-' and ' a.C.' or '')
	end

	return ret
end

local function formatGlobecoordinate(value, options)
	local ret
	if options.formatting == 'latitude' then
		ret = value.latitude
	elseif options.formatting == 'longitude' then
		ret = value.longitude
	else
		ret = value.latitude .. ', ' .. value.longitude
	end
	return ret
end

local function formatFromPattern(str, options)
	-- la parentesi () extra serve per non ritornare anche il gsub.count 
	return (mw.ustring.gsub(options.pattern, '$1', str))
end

local function getEntityIdFromValue(value)
	local prefix = ''
	if value['entity-type'] == 'item' then
		prefix = 'Q'
	elseif value['entity-type'] == 'property' then
		prefix = 'P'
	else
		return formatError('unknown-entity-type')
	end
	return prefix .. value['numeric-id']
end

local function formatDatavalue(datavalue, options, formatting)
	local ret

	--Default formatters
	if datavalue.type == 'wikibase-entityid' then
		ret = formatEntityId(getEntityIdFromValue(datavalue.value), options, formatting)
	elseif datavalue.type == 'string' then
		ret = datavalue.value
	elseif datavalue.type == 'monolingualtext' then
		ret = datavalue.value.text
	elseif datavalue.type == 'time' then
		ret = formatTime(datavalue.value, options)
	elseif datavalue.type == 'globecoordinate' then
		ret = formatGlobecoordinate(datavalue.value, options)
	elseif datavalue.type == 'quantity' then
		ret = tonumber(datavalue.value.amount)
	else
		ret = formatError('unknown-datavalue-type')
	end

	return ret
end

local function formatSnak(snak, options, formatting)
	if snak.snaktype == 'somevalue' then
		return i18n['somevalue']
	elseif snak.snaktype == 'novalue' then
		return i18n['novalue']
	elseif snak.snaktype == 'value' then
		return formatDatavalue(snak.datavalue, options, formatting)
	else
		return formatError('unknown-snak-type')
	end
end

local function formatStatement(statement, options)
	if not statement.type or statement.type ~= 'statement' then
		return formatError('unknown-claim-type')
	end
 
	return formatSnak(statement.mainsnak, options)
end

local function formatStatements(claims, options)
	--Format statement and concat them cleanly
	local formattedStatements = {}
	local list_end, formattedStatement
	if options.list or options.orderedlist then
		if options.list then 
			formattedStatements[1] = '<ul><li>'
			list_end = '</li></ul>'
		else
			formattedStatements[1] = '<ol><li>'
			list_end = '</li></ol>'
		end
		options.separator = '</li><li>'
		options.conjunction = options.separator
	end
	
	for i, claim in pairs(claims) do
		formattedStatement = formatStatement(claim, options)
		-- eventuale pattern
		if options.pattern then
			formattedStatement = formatFromPattern(formattedStatement, options)
		end
		table.insert(formattedStatements, formattedStatement)
	end

	if list_end then table.insert(formattedStatements, list_end) end
	return mw.text.listToText(formattedStatements, options.separator, options.conjunction)
end

-------------------------------------------------------------------------------
--                      Lettura e selezione statement
-------------------------------------------------------------------------------

-- Ritorna true se lo statement contiene il qualifier richiesto con un dato valore
local function hasQualifierValue(statement, options)
	local ret = false
	for i, qualifier in pairs(statement.qualifiers[options.qualifier]) do	
		if formatSnak(qualifier, options, 'raw') == options.qualifiervalue then
			ret = true
			break
		end
	end
	return ret
end

-- Ritorna i claim con il rank richiesto
local function filterRankValue(claims, rank)
	local ret = {}
	for i, claim in pairs(claims) do
		if claim.rank == rank then
			table.insert(ret, claim)
		end
	end
	return ret
end

-- Ritorna una table contenente gli statement per la property richiesta.
-- Gli statement ritornati sono eventualmente filtrati in base ai parametri:
-- "rank", "qualifier", "qualifiertype" e "n"
local function getClaims(options)
	local entity, claims, filteredClaims
	
	-- get entity
	entity = mw.wikibase.getEntityObject()
	if not entity then
		error('') -- error(formatError('entity-not-found'))
	end

	-- get property
	if not options.property then
		error(formatError('property-param-not-provided'))
	end

	if entity.claims and entity.claims[options.property] and
	   #entity.claims[options.property] > 0 then
	   claims = entity.claims[options.property]
	else
		error('') --TODO error?
	end

	-- statements filtrati per rank
	if options.rank then
		if options.rank == 'best' then
			filteredClaims = filterRankValue(claims, 'preferred')
			if #filteredClaims == 0 then
				filteredClaims = filterRankValue(claims, 'normal')
			end
		else
			filteredClaims = filterRankValue(claims, options.rank)
		end
		claims = filteredClaims
	end

	-- statements filtrati per qualifier
	if options.qualifier then
		filteredClaims = {}
		for i, claim in pairs(claims) do
			if claim.qualifiers and claim.qualifiers[options.qualifier] then
				if options.qualifiervalue then
					if hasQualifierValue(claim, options) then
						table.insert(filteredClaims, claim)
					end
				else
					table.insert(filteredClaims, claim)
				end
			end
		end
		claims = filteredClaims
	end

	-- con options.qualifiertype=latest ritorna solo il più recente
	if options.qualifier and options.qualifiertype == 'latest' then
		local latest, latestTime
		for i, claim in pairs(claims) do
			if claim.qualifiers and claim.qualifiers[options.qualifier] then
				for j, qualifier in pairs(claim.qualifiers[options.qualifier]) do
					if qualifier.datavalue.type == 'time' then
						if not latestTime or qualifier.datavalue.value.time > latestTime then
							latest = claim
							latestTime = qualifier.datavalue.value.time
						end
					end
				end
			end
		end
		claims = latest and {latest} or {}
	end

	-- con options.n ritorna solo l'n-esimo elemento
	if options.n then
		local n = tonumber(options.n)
		claims = (n and n <= #claims) and {claims[n]} or {}
	end

	return claims
end

-------------------------------------------------------------------------------
--                               API
-------------------------------------------------------------------------------

local p = {}

-- Entry-point per {{#invoke:Wikidata|formatStatements}}
function p.formatStatements(frame)
	local args, ret, claims

	args = getArgs(frame, {parentOnly = true})
	-- Per riabilitare eventualmente la chiamata al modulo diretta,
	-- pur usando sempre solo getParent per il template, sostituire con:
	-- args = getArgs(frame, {wrappers = 'Template:Wikidata'})

	-- parametri posizionali
	args.property = args[1] and string.upper(args[1]) or nil
	args.value = args[2]
	-- fix uppercase
	args.qualifier = args.qualifier and string.upper(args.qualifier) or nil
	-- default rank
	args.rank = args.rank or 'best'

	-- if parameter value is already set, use it
	if args.value then
		return args.pattern and formatFromPattern(args.value, args) or args.value 
	end
	
	-- get claims
	ret, claims = pcall(getClaims, args)
	if not ret then
		return claims:match('.+%d:%s(.+)$')
	end

	return formatStatements(claims, args)
end

function p.getProperty(frame)
	return p.formatStatements(frame)
end

-- Entry-point per {{#invoke:Wikidata|getQualifier}}
function p.getQualifier(frame)
	local args, ret, claims, formattedQualifier, formattedQualifiers

	args = getArgs(frame, {parentOnly = true})
	-- args = getArgs(frame, {wrappers = 'Template:WikidataQ'})
	
	-- parametri posizionali
	args.property = args[1] and string.upper(args[1]) or nil
	args.qualifier = args[2] and string.upper(args[2]) or nil
	args.value = args[3]
	-- default rank
	args.rank = args.rank or 'best'

	-- if parameter value is already set, use it
	if args.value then
		return args.pattern and formatFromPattern(args.value, args) or args.value 
	end

	-- get qualifier name
	if not args.qualifier then
		return formatError('qualifier-param-not-provided')
	end

	-- get claims
	ret, claims = pcall(getClaims, args)
	if not ret then
		return claims:match('.+%d:%s(.+)$')
	end

	-- get qualifiers and format them
	formattedQualifiers = {}
	for i, claim in pairs(claims) do
		if claim.qualifiers and claim.qualifiers[args.qualifier] then
			for j, qualifier in pairs(claim.qualifiers[args.qualifier]) do
				formattedQualifier = formatSnak(qualifier, args)
				if args.pattern then
					formattedQualifier = formatFromPattern(formattedQualifier, args)
				end 
				table.insert(formattedQualifiers, formattedQualifier)
			end
		end
	end

	return mw.text.listToText(formattedQualifiers, args.separator, args.conjunction)
end

-- Entry-point per {{#invoke:Wikidata|N}}
function p.N(frame) 
	local args, entity, property, count

	args = getArgs(frame, {parentOnly = true})
	-- args = getArgs(frame, {wrappers = 'Template:WikidataN'})

	-- parametri posizionali
	property = args[1] and string.upper(args[1]) or nil

	if not property then
		return formatError('property-param-not-provided')
	end

	entity = mw.wikibase.getEntityObject()
	if entity and entity.claims and entity.claims[property] then
		count = #entity.claims[property]
	end

	return count or 0
end
 
return p