Module:WikidataIB

Documentation for this module may be created at Module:WikidataIB/doc

-- Module to try out use of a blacklist and whitelist for infobox fields
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used
-- Fields in blacklist are never to be displayed, i.e. module must return nil in all circumstances
-- Fields in whitelist return local value if it exists or the Wikidata value otherwise
-- The name of the field that this function is called from is passed in named parameter |name
-- The name is compulsory when blacklist or whitelist is used, so the module returns nil if it is not supplied
-- blacklist is passed in named parameter |suppressfields
-- whitelist is passed in named parameter |fetchwikidata

local p = {}

local i18n =
{
    ["errors"] =
    {
        ["property-not-found"] = "Property not found.",
        ["entity-not-found"] = "Wikidata entity not found.",
        ["unknown-claim-type"] = "Unknown claim type.",
        ["unknown-entity-type"] = "Unknown entity type.",
        ["qualifier-not-found"] = "Qualifier not found.",
        ["site-not-found"] = "Wikimedia project not found.",
		["unknown-datetime-format"] = "Unknown datetime format.",
		["local-article-not-found"] = "Article is not yet available in this wiki"
    },
}

-- This is used to get a value, or a comma separated list of them if multiple values exist
p.getValue = function(frame)
	local propertyID = mw.text.trim(frame.args[1] or "")
	
	-- There may be a local parameter supplied, if it's blank, set it to nil
	local input_parm =  mw.text.trim(frame.args[2] or "")
	if input_parm and (#input_parm == 0) then input_parm = nil end
	
	-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used.
	local qid = frame.args.qid
	if qid and (#qid == 0) then qid = nil end
	
	-- The blacklist is passed in named parameter |suppressfields
	local blacklist = frame.args.suppressfields
	
	-- The whitelist is passed in named parameter |fetchwikidata
	local whitelist = frame.args.fetchwikidata
	
	-- The name of the field that this function is called from is passed in named parameter |name
	local fieldname = frame.args.name
	
	if blacklist then
		-- The name is compulsory when blacklist is used, so return nil if it is not supplied
		if not fieldname or (#fieldname == 0) then return nil end
		-- If this field is on the blacklist, then return nil
		if blacklist:find(fieldname) then return nil end
	end
	
	-- If we got this far then we're not on the blacklist
	
	-- If a non-blank input parameter was supplied return it
	if input_parm then return input_parm end
	
	-- Otherwise see if this field is on the whitelist:
	if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then
		local entity = mw.wikibase.getEntityObject(qid)
		local props
		if entity and entity.claims then
			props = entity.claims[propertyID]
		end
		if props then
			if props[1] and props[1].mainsnak.snaktype == "value" and props[1].mainsnak.datavalue.type == "wikibase-entityid" then
				-- if wiki-linked value, then output as link if possible
				local out = {}
				for k, v in pairs(props) do
					local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"])
					local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"])
					if label == nil then label = "Q" .. v.mainsnak.datavalue.value["numeric-id"] end
							
					if sitelink then
						out[#out + 1] = "[[" .. sitelink .. "|" .. label .. "]]"
					else
						out[#out + 1] = "[[:d:Q" .. v.mainsnak.datavalue.value["numeric-id"] .. "|" .. label .. "]]<abbr title='" .. i18n["errors"]["local-article-not-found"] .. "'>[*]</abbr>"
					end
				end
				return table.concat(out, ", ") .. " [[File:Blue pencil.svg |frameless |10px |alt=Edit this on Wikidata]]"
			else
				-- not a linkable article title, so just return formatted best value
				return entity:formatPropertyValues(propertyID).value
			end
		else
			-- no property stored for this article
			return nil
		end
	else
	-- not on the whitelist so just return what should be a nil input parameter
		return input_parm
	end
end

-- This is used to get coordinates for display in infobox
p.getCoords = function(frame)
	local propertyID = "P625"
	
	local input_parm =  mw.text.trim(frame.args[1] or "")
	if input_parm and (#input_parm == 0) then input_parm = nil end
	
	local qid = frame.args.qid
	if qid and (#qid == 0) then qid = nil end
	
	local blacklist = frame.args.suppressfields
	
	local whitelist = frame.args.fetchwikidata
	
	-- The name of the field that this function is called from is passed in named parameter |name
	-- it's probably 'coords' but we can't be certain
	local fieldname = frame.args.name
	
	if blacklist then
		if not fieldname or (#fieldname == 0) then return nil end
		if blacklist:find(fieldname) then return nil end
	end
	
	if input_parm then return input_parm end
	
	if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then
		local entity = mw.wikibase.getEntityObject(qid)
		local props
		if entity and entity.claims then
			props = entity.claims[propertyID]
		end
		if props then
			local lat_long = {}
			local coords = entity:formatPropertyValues(propertyID).value
			-- the latitude and longitude are returned like this: nn°nn&#39;nn.n&#34;
			-- using html entities with hex values really screws up parsing the numbers - thanks devs
			local lat = mw.ustring.match(coords, "^[^,]*")  -- everything from the start to before the comma
			local long = mw.ustring.match(coords, "[^ ]*$") -- everything from after the space to the end
			lat = lat:gsub("&#%d%d;", ":")                  -- clean out the html entities
			long = long:gsub("&#%d%d;", ":")                -- clean out the html entities
			-- read the numbers into a table
			for num in mw.ustring.gmatch(lat, "%d+%.?%d*") do
  				lat_long[#lat_long + 1] = num
			end
			lat_long[#lat_long + 1] = lat:sub(-1)
			for num in mw.ustring.gmatch(long, "%d+%.?%d*") do
				lat_long[#lat_long + 1] = num
			end
			lat_long[#lat_long + 1] = long:sub(-1)
			-- invoke template Coord with the values stored in the table
			return frame:expandTemplate{title = 'coord', args = lat_long}
		else
			-- no coords in Wikidata for this article
			return nil
		end
	else
	-- not on the whitelist so just return what should be a nil input parameter
		return input_parm
	end
end

return p