Module:Wd

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

local p = {}

local State = {}
State.__index = State

-- allows for recursive calls
function State.new()
	local stt = {}
	setmetatable(stt, State)
	
	stt.outPreferred = {}
	stt.outNormal = {}
	stt.outDeprecated = {}
	
	stt.bestRank = true
	stt.foundRank = 3
	stt.maxRank = nil
	stt.minRank = nil
	
	stt.period = 0
	
	stt.linked = false
	stt.propertyWithQualifier = false
	
	stt.withUnit = false
	stt.shortName = false
	stt.singleValue = false
	
	stt.langCode = mw.language.getContentLanguage().code
	stt.langObj = mw.language.new(stt.langCode)
	
	stt:setRankBoundaries("best")
	
	return stt
end

function State:unknownDatatypeError(type)
	return "<strong class=\"error\">Unknown or unsupported datatype '" .. type .. "'</strong>"
end

function State:parseDate(dateStr, precision)
	precision = precision or "d"
	local i, j, index, ptr
	local parts = {nil, nil, nil}
	
	if dateStr == nil then
		return parts[1], parts[2], parts[3]  -- year, month, day
	end
	
	-- 'T' for snak values, '/' for outputs with '/Julian' attached
	i, j = dateStr:find("[T/]")
	
	if i then
		dateStr = dateStr:sub(1, i-1)
	end
	
	local from = 1
	
	if dateStr:sub(1,1) == "-" then
		-- this is a negative number, look further ahead
		from = 2
	end
	
	index = 1
	ptr = 1
	
	i, j = dateStr:find("-", from)
	
	if i then
		-- year
		parts[index] = tonumber(mw.ustring.gsub(dateStr:sub(ptr, i-1), "^\+(.+)$", "%1"), 10)  -- remove + sign
		
		-- apparently, 0 can have a negative sign in Lua... so do this to get rid of it
		if parts[index] == 0 then
			parts[index] = 0
		end
		
		if precision == "y" then
			-- we're done
			return parts[1], parts[2], parts[3]  -- year, month, day
		end
		
		index = index + 1
		ptr = i + 1
		
		i, j = dateStr:find("-", ptr)
		
		if i then
			-- month
			parts[index] = tonumber(dateStr:sub(ptr, i-1), 10)
			
			if precision == "m" then
				-- we're done
				return parts[1], parts[2], parts[3]  -- year, month, day
			end
			
			index = index + 1
			ptr = i + 1
		end
	end
	
	if dateStr:sub(ptr) ~= "" then
		-- day if we have month, month if we have year, or year
		parts[index] = tonumber(dateStr:sub(ptr), 10)
	end
	
	return parts[1], parts[2], parts[3]  -- year, month, day
end

function State:convertUnit(unit, addLink)
	addLink = addLink or false
	local i, j, itemID, label, target
	
	if unit == "" or unit == "1" then
		return nil
	end
	
	if unit:match('^http[s]?://') then
		i, j = unit:find("Q")
		
		if i then
			itemID = unit:sub(i)
			
			if itemID == "Q11229" then  -- 'percentage'
				return "%"
			else
				label = mw.wikibase.label(itemID)
				target = nil
				
				if addLink or label == nil then
					target = mw.wikibase.sitelink(itemID)
				end
				
				if addLink then
					if target then
						return " " .. "[[" .. target .. "|" .. (label or target) .. "]]"
					end
					
					if not label then
						return " " .. "[[:d:" .. itemID .. "|" .. itemID .. "]]"
					end
				end
				
				return " " .. (label or target or itemID)
			end
		end
	end
	
	return " " .. unit
end

function State:getShortName(itemID)
	return p._property({"single", itemID, "P1813"})  -- 'short name'
end

function State:getOrdinalSuffix(num)
	if tostring(num):sub(-2,-2) == '1' then
		return "th"  -- 10th, 11th, 12th, 13th, ... 19th
	end
	
	num = tostring(num):sub(-1)
	
	if num == '1' then
		return "st"
	elseif num == '2' then
		return "nd"
	elseif num == '3' then
		return "rd"
	else
		return "th"
	end
end

function State:getValue(snak, addUnit, addLink)
	addUnit = addUnit or false
	addLink = addLink or false
	
	if snak.snaktype == 'value' then
		if snak.datavalue.type == 'string' then
			return snak.datavalue.value
		elseif snak.datavalue.type == 'monolingualtext' then
			if snak.datavalue.value['language'] == self.langCode then
				return snak.datavalue.value['text']
			else
				return nil
			end
		elseif snak.datavalue.type == 'quantity' then
			-- strip + signs from front
			local value = mw.ustring.gsub(snak.datavalue.value['amount'], "^\+(.+)$", "%1")
			
			if addUnit then
				local unit = self:convertUnit(snak.datavalue.value['unit'], addLink)
				if unit then
					value = value .. unit
				end
			end
			
			return value
		elseif snak.datavalue.type == 'time' then
			local y, m, d, p, i, j, yDiv, yRound, yFull, value, calendarID
			local yFactor = 1
			local sign = 1
			local suffix = ""
			local mayAddCalendar = false
			local calendar = ""
			local precision = snak.datavalue.value['precision']
			
			if precision == 11 then
				p = "d"
			elseif precision == 10 then
				p = "m"
			else
				p = "y"
				yFactor = 10^(9-precision)
			end
			
			y, m, d = self:parseDate(snak.datavalue.value['time'], p)
			
			if y < 0 then
				sign = -1
				y = y * sign
			end
			
			-- if precision is tens/hundreds/thousands/millions/billions of years
			if precision <= 8 then
				yDiv = y / yFactor
				
				-- if precision is tens/hundreds/thousands of years
				if precision >= 6 then
					mayAddCalendar = true
					
					if precision <= 7 then
						-- round centuries/millenniums up (e.g. 20th century or 3rd millennium)
						yRound = math.ceil(yDiv)
						
						if addUnit then
							if precision == 6 then
								suffix = " millennium"
							else
								suffix = " century"
							end
							
							suffix = self:getOrdinalSuffix(yRound) .. suffix
						else
							-- if no unit added, take the first year of the century/millennium
							-- (e.g. 1901 for 20th century or 2001 for 3rd millennium)
							yRound = (yRound - 1) * yFactor + 1
						end
					else
						-- precision == 8
						-- round decades down (e.g. 2010s)
						yRound = math.floor(yDiv) * yFactor
						
						if addUnit then
							suffix = "s"
						end
					end
					
					if not addUnit and sign < 0 then
						-- if BCE then compensate for "counting backwards"
						-- (e.g. -2019 for 2010s BCE, -2000 for 20th century BCE or -3000 for 3rd millennium BCE)
						yRound = yRound + yFactor - 1
					end
				else
					local yReFactor, yReDiv, yReRound
					
					-- round to nearest for tens of thousands of years or more
					yRound = math.floor(yDiv + 0.5)
					
					if yRound == 0 then
						if precision <= 2 and y ~= 0 then
							yReFactor = 1e6
							yReDiv = y / yReFactor
							yReRound = math.floor(yReDiv + 0.5)
							
							if yReDiv == yReRound then
								-- change precision to millions of years only if we have a whole number of them
								precision = 3
								yFactor = yReFactor
								yRound = yReRound
							end
						end
						
						if yRound == 0 then
							-- otherwise, take the unrounded (original) number of years
							precision = 5
							yFactor = 1
							yRound = y
							mayAddCalendar = true
						end
					end
					
					if precision >= 1 and y ~= 0 then
						yFull = yRound * yFactor
						
						yReFactor = 1e9
						yReDiv = yFull / yReFactor
						yReRound = math.floor(yReDiv + 0.5)
						
						if yReDiv == yReRound then
							-- change precision to billions of years if we're in that range
							precision = 0
							yFactor = yReFactor
							yRound = yReRound
						else
							yReFactor = 1e6
							yReDiv = yFull / yReFactor
							yReRound = math.floor(yReDiv + 0.5)
							
							if yReDiv == yReRound then
								-- change precision to millions of years if we're in that range
								precision = 3
								yFactor = yReFactor
								yRound = yReRound
							end
						end
					end
					
					if addUnit then
						if precision == 3 then
							suffix = " million years"
						elseif precision == 0 then
							suffix = " billion years"
						else
							yRound = yRound * yFactor
							if yRound == 1 then
								suffix = " year"
							else
								suffix = " years"
							end
						end
					else
						yRound = yRound * yFactor
					end
				end
			else
				yRound = y
				mayAddCalendar = true
			end
			
			if mayAddCalendar then
				calendarID = snak.datavalue.value['calendarmodel']
				
				if calendarID:match('^http[s]?://') then
					i, j = calendarID:find("Q")
					
					if i then
						calendarID = calendarID:sub(i)
						
						if calendarID == "Q1985786" then  -- 'Proleptic Julian calendar'
							if addUnit then
								if addLink then
									calendar = " ([[Julian calendar|Julian]])"
								else
									calendar = " (Julian)"
								end
							else
								calendar = "/Julian"
							end
						end
					end
				end
			end
			
			if addUnit then
				local ce = nil
				
				if sign < 0 then
					ce = "BCE"
				elseif precision <= 5 then
					ce = "CE"
				end
				
				if ce then
					if addLink then
						ce = "[[Common Era|" .. ce .. "]]"
					end
					suffix = suffix .. " " .. ce
				end
				
				value = tostring(yRound)
				
				if m then
					value = self.langObj:formatDate("F", "1-"..m.."-1") .. " " .. value
					
					if d then
						value = d .. " " .. value
					end
				end
				
				value = value .. suffix .. calendar
			else
				value = tostring(yRound * sign)
				
				if m then
					value = value .. "-" .. m
					
					if d then
						value = value .. "-" .. d
					end
				end
				
				value = value .. calendar
			end
			
			return value
		elseif snak.datavalue.type == 'wikibase-entityid' then
			local value = ""
			local target = nil
			local itemID = "Q" .. snak.datavalue.value['numeric-id']
			
			if self.shortName then
				value = self:getShortName(itemID)
			end
			
			if value == "" then
				value = mw.wikibase.label(itemID)
			end
			
			if addLink or value == nil then
				target = mw.wikibase.sitelink(itemID)
			end
			
			if addLink then
				if target then
					value = "[[" .. target .. "|" .. (value or target) .. "]]"
				elseif not value then
					value = "[[:d:" .. itemID .. "|" .. itemID .. "]]"
				end
			elseif not value then
				value = (target or itemID)
			end
			
			return value
		else
			return self:unknownDatatypeError(snak.datavalue.type)
		end
	elseif snak.snaktype == 'somevalue' then
		return "unknown"
	elseif snak.snaktype == 'novalue' then
		return "none"
	else
		return nil
	end
end

function State:getRawValue(snak)
	if snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then
		return "Q" .. snak.datavalue.value['numeric-id']
	elseif snak.snaktype == 'somevalue' then
		return " "  -- single space represents 'somevalue'
	elseif snak.snaktype == 'novalue' then
		return ""  -- empty value represents 'novalue'
	else
		return self:getValue(snak, false, false)
	end
end

function State:getSingleRawQualifier(claim, qualifierID)
	local qualifiers
	
	if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
	
	if qualifiers and qualifiers[1] then
		return self:getRawValue(qualifiers[1])
	else
		return nil
	end
end

function State:snakEqualsValue(snak, value)
	local snakValue = self:getRawValue(snak)
	
	if snakValue and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
	
	return snakValue == value
end

function State:setRankBoundaries(rank)
	local rankPos
	
	if (rank == "best") then
		self.bestRank = true
		self.foundRank = 3
		return
	else
		self.bestRank = false
	end
	
	if (rank:sub(1,9) == "preferred") then
		rankPos = 1
	elseif (rank:sub(1,6) == "normal") then
		rankPos = 2
	elseif (rank:sub(1,10) == "deprecated") then
		rankPos = 3
	end
	
	if (rank:sub(-1) == "+") then
		self.maxRank = 1
		self.minRank = rankPos
	elseif (rank:sub(-1) == "-") then
		self.maxRank = rankPos
		self.minRank = 3
	else
		self.maxRank = rankPos
		self.minRank = rankPos
	end
end

function State:convertRank(rank)
	if (rank == "preferred") then
		return 1
	elseif (rank == "normal") then
		return 2
	elseif (rank == "deprecated") then
		return 3
	else
		return 4  -- default (in its literal sense)
	end
end

function State:rankMatches(rankPos)
	if self.bestRank then
		if self.foundRank > rankPos then
			self.foundRank = rankPos
			
			-- found a better rank, reset worse rank outputs
			if self.foundRank == 1 then
				self.outNormal = {}
				self.outDeprecated = {}
			elseif self.foundRank == 2 then
				self.outDeprecated = {}
			end
		end
		
		return self.foundRank >= rankPos  -- == would also work here
	else
		return (self.maxRank <= rankPos and rankPos <= self.minRank)
	end
end

function State:datePrecedesDate(aY, aM, aD, bY, bM, bD)
	if aY == nil or bY == nil then
		return nil
	end
	aM = aM or 1
	aD = aD or 1
	bM = bM or 1
	bD = bD or 1
	
	if aY < bY then
		return true
	end
	
	if aY > bY then
		return false
	end
	
	if aM < bM then
		return true
	end
	
	if aM > bM then
		return false
	end
	
	if aD < bD then
		return true
	end
	
	return false
end

function State:timeMatches(claim)
	local startTimeY = nil
	local startTimeM = nil
	local startTimeD = nil
	local endTimeY = nil
	local endTimeM = nil
	local endTimeD = nil
	
	if self.period == 0 then
		-- any time
		return true
	end
	
	local now = os.date('!*t')
	
	if self.period <= 2 then
		local startTime = self:getSingleRawQualifier(claim, "P580")  -- 'start time'
		if startTime ~= "" and startTime ~= " " then
			startTimeY, startTimeM, startTimeD = self:parseDate(startTime)
		end
	end
	if self.period >= 2 then
		local endTime = self:getSingleRawQualifier(claim, "P582")  -- 'end time'
		if endTime ~= "" and endTime ~= " " then
			endTimeY, endTimeM, endTimeD = self:parseDate(endTime)
		elseif endTime == " " then
			-- end time is 'unknown', assume it is somewhere in the past;
			-- we can do this by taking the current date as a placeholder for the end time
			endTimeY = now['year']
			endTimeM = now['month']
			endTimeD = now['day']
		end
	end
	
	if self.period == 1 then
		-- future
		if startTimeY == nil or not self:datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD) then
			return false
		else
			return true
		end
	elseif self.period == 2 then
		-- current
		if (startTimeY ~= nil and self:datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD)) or
		   (endTimeY ~= nil and not self:datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD)) then
		    return false
		else
		   	return true
		end
	elseif self.period == 3 then
		-- former
		if endTimeY == nil or self:datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD) then
			return false
		else
			return true
		end
	end
end

function State:appendOutput(value, rankPos)
	local done = false
	
	if rankPos == 1 then
		self.outPreferred[#self.outPreferred + 1] = value
		
		if self.singleValue then
			done = true
		end
	elseif rankPos == 2 then
		self.outNormal[#self.outNormal + 1] = value
		
		if self.singleValue and not self.bestRank and self.maxRank == 2 then
			done = true
		end
	elseif rankPos == 3 then
		self.outDeprecated[#self.outDeprecated + 1] = value
		
		if self.singleValue and not self.bestRank and self.maxRank == 3 then
			done = true
		end
	end
	
	return done
end

function State:out()
	local out = ""
	
	if self.outDeprecated[1] then
		if self.singleValue then
			out = self.outDeprecated[1]
		else
			out = table.concat(self.outDeprecated, ", ")
		end
	end
	
	if self.outNormal[1] then
		if self.singleValue then
			out = self.outNormal[1]
		else
			if out ~= "" then
				out = "; " .. out
			end
			
			out = table.concat(self.outNormal, ", ") .. out
		end
	end
	
	if self.outPreferred[1] then
		if self.singleValue then
			out = self.outPreferred[1]
		else
			if out ~= "" then
				out = "; " .. out
			end
			
			out = table.concat(self.outPreferred, ", ") .. out
		end
	end
	
	return out
end

function State:processFlag(flag)
	if flag == "linked" then
		self.linked = true
		return true
	elseif flag == "unit" then
		self.withUnit = true
		return true
	elseif flag == "short" then
		self.shortName = true
		return true
	elseif flag == "single" then
		self.singleValue = true
		return true
	elseif flag == "best" or flag:match('^preferred[+-]?$') or flag:match('^normal[+-]?$') or flag:match('^deprecated[+-]?$') then
		self:setRankBoundaries(flag)
		return true
	elseif flag == "future" then
		self.period = 1
		return true
	elseif flag == "current" then
		self.period = 2
		return true
	elseif flag == "former" then
		self.period = 3
		return true
	else
		return false
	end
end

function p.property(frame)
	return p._property(frame.args)
end

function p._property(args)
	local _ = State.new()
	
	local entity, propertyID, claims, rankPos, value, done
	local nextArg = mw.text.trim(args[1] or "")
	local nextIndex = 2
	
	while _:processFlag(nextArg) do
		nextArg = mw.text.trim(args[nextIndex] or "")
		nextIndex = nextIndex + 1
	end
	
	if nextArg:sub(1,1):upper() == "Q" then
		entity = mw.wikibase.getEntity(nextArg)
		propertyID = mw.text.trim(args[nextIndex] or ""):upper()
	else
		entity = mw.wikibase.getEntity()
		propertyID = nextArg:upper()
	end
	
	if entity and entity.claims then claims = entity.claims[propertyID] end
	if claims then
		for i, v in ipairs(claims) do
			rankPos = _:convertRank(v.rank)
			if _:rankMatches(rankPos) and _:timeMatches(v) then
				value = _:getValue(v.mainsnak, _.withUnit, _.linked)
				if value then
					done = _:appendOutput(value, rankPos)
					if done then
						break
					end
				end
			end
		end
		return _:out()
	else
		return ""
	end
end

function p.qualifier(frame)
	return p._qualifier(frame.args)
end

function p._qualifier(args, _)
	_ = _ or State.new()
	
	local entity, propertyID, propertyValue, qualifierID, claims, qualifiers, rankPos, outValue, outInter, outQualifiers
	local done = false
	
	local nextArg = mw.text.trim(args[1] or "")
	local nextIndex = 2
	
	while _:processFlag(nextArg) do
		nextArg = mw.text.trim(args[nextIndex] or "")
		nextIndex = nextIndex + 1
	end
	
	if nextArg:sub(1,1):upper() == "Q" then
		entity = mw.wikibase.getEntity(nextArg)
		propertyID = mw.text.trim(args[nextIndex] or ""):upper()
		nextIndex = nextIndex + 1
	else
		entity = mw.wikibase.getEntity()
		propertyID = nextArg:upper()
	end
	
	nextArg = args[nextIndex]
	nextIndex = nextIndex + 1
	
	qualifierID = nextArg
	
	nextArg = mw.text.trim(args[nextIndex] or "")
	nextIndex = nextIndex + 1
	
	if nextArg == "" then
		-- claim ID or literal value has NOT been given
		propertyValue = nil
		qualifierID = mw.text.trim(qualifierID or ""):upper()
	else
		-- claim ID or literal value has been given
		propertyValue = qualifierID  -- cannot be nil when reached; empty value represents 'novalue'
		if propertyValue ~= "" and mw.text.trim(propertyValue) == "" then
			propertyValue = " "  -- single space represents 'somevalue'
		else
			propertyValue = mw.text.trim(propertyValue)
		end
		qualifierID = nextArg:upper()
	end
	
	if entity and entity.claims then claims = entity.claims[propertyID] end
	if claims then
		for i, v in ipairs(claims) do
			rankPos = _:convertRank(v.rank)
			if propertyValue == nil or _:snakEqualsValue(v.mainsnak, propertyValue) then
				if _:rankMatches(rankPos) and _:timeMatches(v) then
					outValue = nil
					outInter = nil
					outQualifiers = {}
					
					if _.propertyWithQualifier then
						-- get the property value first
						outValue = _:getValue(v.mainsnak, _.withUnit, _.linked)
					end
					
					if v.qualifiers then qualifiers = v.qualifiers[qualifierID] end
					if (not _.propertyWithQualifier or outValue) and qualifiers then
						-- get a bare qualifier, or the qualifiers connected to the property if it had a value
						for i2, v2 in ipairs(qualifiers) do
							outInter = _:getValue(v2, _.withUnit, _.linked)
							if outInter then
								if not _.propertyWithQualifier then
									done = _:appendOutput(outInter, rankPos)
									if done then
										break
									end
								else
									outQualifiers[#outQualifiers + 1] = outInter
								end
							end
						end
					end
					
					if _.propertyWithQualifier and outValue then
						outQualifiers = table.concat(outQualifiers, ", ")
						
						if outQualifiers ~= "" then
							outQualifiers = " <span style=\"font-size:smaller\">(" .. outQualifiers .. ")</span>"
							outValue = outValue .. outQualifiers
						end
						
						done = _:appendOutput(outValue, rankPos)
					end
					
					if done then
						break
					end
				end
			end
		end
		return _:out()
	else
		return ""
	end
end

function p.propertyWithQualifier(frame)
	return p._propertyWithQualifier(frame.args)
end

function p._propertyWithQualifier(args)
	local _ = State.new()
	_.propertyWithQualifier = true
	_.withUnit = true
	return p._qualifier(args, _)
end

function p.label(frame)
	return p._label(frame.args)
end

function p._label(args)
	local _ = State.new()
	
	local label = ""
	local target = ""
	local nextArg = mw.text.trim(args[1] or "")
	local nextIndex = 2
	
	while _:processFlag(nextArg) do
		nextArg = mw.text.trim(args[nextIndex] or "")
		nextIndex = nextIndex + 1
	end
	
	if nextArg then
		if nextArg:sub(1,1):upper() == "Q" then
			if _.shortName then
				label = _:getShortName(nextArg)
			end
			
			if label == "" then
				label = mw.wikibase.label(nextArg)
			end
			
			if _.linked or label == nil then
				target = mw.wikibase.sitelink(nextArg)
			end
			
			if _.linked and target then
				label = "[[" .. target .. "|" .. (label or target) .. "]]"
			end
		else
			label = mw.wikibase.label(nextArg)
		end
		
		return (label or target)
	else
		return mw.wikibase.label()
	end
end

-- main function that may be used by wrapper templates
function p.main(frame)
	local f, args, i, v
	
	frame = frame:getParent() or frame
	f = mw.text.trim(frame.args[1] or "")
	assert(p[f], 'The function "' .. f .. '" does not exist')
	
    args = {}
    for i, v in ipairs(frame.args) do
    	if i > 1 then
        	args[i-1] = v
        end
    end
	frame.args = args
	
	return p[f](frame)
end

return p