Module:Wd: Difference between revisions

Content deleted Content added
m Protected "Module:Wd": High-risk module ([Edit=Require template editor access] (indefinite))
update from sandbox
 
(108 intermediate revisions by 11 users not shown)
Line 1:
-- Original module located at [[:en:Module:Wd]] and [[:en:Module:Wd/i18n]].
 
require("strict")
local p = {}
local argmodule_arg = ...
local i18n
local i18nPath
 
local function loadI18n(aliasesP, frame)
local title
 
if frame then
-- current module invoked by page/template, get its title from frame
title = frame:getTitle()
else
-- current module included by other module, get its title from ...
title = module_arg
end
 
function loadSubmodules(frame)
-- internationalization
if not i18n then
i18nPath = title .. "/i18n"
if frame then
i18n = require(i18nPath).init(aliasesP)
-- module invoked by page/template, get its title from frame
i18n = require(frame:getTitle().."/i18n")
else
-- module included by other module, get its title from ...
i18n = require(arg.."/i18n")
end
end
end
 
p.commandsclaimCommands = {
property = "property",
properties = "properties",
Line 24 ⟶ 30:
qualifiers = "qualifiers",
reference = "reference",
references = "references",
}
label = "label",
 
title = "title",
p.generalCommands = {
alias = "alias",
aliaseslabel = "aliaseslabel",
title = "title",
description = "description",
alias = "alias",
aliases = "aliases",
badge = "badge",
badges = "badges"
}
 
Line 53 ⟶ 65:
 
p.args = {
eid = "eid",
page = "page",
date = "date",
globalSiteId = "globalSiteId"
}
 
p.local aliasesP = {
coord = "P625",
-----------------------
authorimage = "P50P18",
publisherauthor = "P123P50",
importedFromauthorNameString = "P143P2093",
statedInpublisher = "P248P123",
pagesimportedFrom = "P304P143",
wikimediaImportURL = "P4656",
publicationDate = "P577",
startTimestatedIn = "P580P248",
endTimepages = "P582P304",
chapterlanguage = "P792P407",
retrievedhasPart = "P813P527",
referenceURLpublicationDate = "P854P577",
archiveURLstartTime = "P1065P580",
titleendTime = "P1476P582",
quotechapter = "P1683P792",
shortNameretrieved = "P1813P813",
languagereferenceURL = "P2439P854",
sectionVerseOrParagraph = "P958",
archiveDate = "P2960"
archiveURL = "P1065",
title = "P1476",
formatterURL = "P1630",
quote = "P1683",
shortName = "P1813",
definingFormula = "P2534",
archiveDate = "P2960",
inferredFrom = "P3452",
typeOfReference = "P3865",
column = "P3903",
subjectNamedAs = "P1810",
wikidataProperty = "P1687",
publishedIn = "P1433",
lastUpdate = "P5017"
}
 
Line 90 ⟶ 119:
reference = "%r",
alias = "%a",
badge = "%b",
separator = "%s",
general = "%x"
Line 98 ⟶ 128:
qualifier = "%q[%s][%r]",
reference = "%r",
propertyWithQualifier = "%p[ <span style=\"font-size:smaller85\\%\">(%q)</span>][%s][%r]",
alias = "%a[%s]",
badge = "%b[%s]"
}
 
Line 107 ⟶ 138:
[parameters.qualifier] = {"getAllQualifiers"},
[parameters.qualifier.."\\d"] = {"getQualifiers", "getQualifier"},
[parameters.alias] = {"getAlias"},
[parameters.badge] = {"getBadge"}
}
 
Line 120 ⟶ 152:
}
 
local ConfigrankTable = {}
["preferred"] = 1,
Config.__index = Config
["normal"] = 2,
["deprecated"] = 3
}
 
local function replaceAlias(id)
-- allows for recursive calls
if aliasesP[id] then
function Config.new()
id = aliasesP[id]
local cfg = {}
end
setmetatable(cfg, Config)
cfg.separators = {
-- single value objects wrapped in arrays so that we can pass by reference
["sep"] = {copyTable(defaultSeparators["sep"])},
["sep%s"] = {copyTable(defaultSeparators["sep%s"])},
["sep%q"] = {copyTable(defaultSeparators["sep%q"])},
["sep%r"] = {copyTable(defaultSeparators["sep%r"])},
["punc"] = {copyTable(defaultSeparators["punc"])}
}
cfg.entity = nil
cfg.entityID = nil
cfg.propertyID = nil
cfg.propertyValue = nil
cfg.qualifierIDs = {}
cfg.qualifierIDsAndValues = {}
cfg.bestRank = true
cfg.ranks = {true, true, false} -- preferred = true, normal = true, deprecated = false
cfg.foundRank = #cfg.ranks
cfg.flagBest = false
cfg.flagRank = false
cfg.periods = {true, true, true} -- future = true, current = true, former = true
cfg.flagPeriod = false
cfg.mdyDate = false
cfg.singleClaim = false
cfg.sourcedOnly = false
cfg.editable = false
cfg.editAtEnd = false
cfg.pageTitle = false
cfg.langCode = mw.language.getContentLanguage().code
cfg.langName = mw.language.fetchLanguageName(cfg.langCode, cfg.langCode)
cfg.langObj = mw.language.new(cfg.langCode)
cfg.states = {}
cfg.states.qualifiersCount = 0
cfg.curState = nil
cfg.prefetchedRefs = nil
return cfg
end
 
return id
local State = {}
State.__index = State
 
function State.new(cfg)
local stt = {}
setmetatable(stt, State)
stt.conf = cfg
stt.results = {}
stt.parsedFormat = {}
stt.separator = {}
stt.movSeparator = {}
stt.puncMark = {}
stt.linked = false
stt.rawValue = false
stt.shortName = false
stt.anyLanguage = false
stt.unitOnly = false
stt.singleValue = false
return stt
end
 
local function replaceAliaserrorText(IDcode, ...)
local text = i18n["errors"][code]
if p.aliasesP[ID] then
if arg then text = mw.ustring.format(text, unpack(arg)) end
ID = p.aliasesP[ID]
return text
end
return ID
end
 
local function applyStringParamsthrowError(strerrorMessage, ...)
error(errorText(errorMessage, unpack(arg)))
for i, v in ipairs(arg) do
str = mw.ustring.gsub(str, "$"..i, v)
end
return str
end
 
local function unknownDataTypeErrorreplaceDecimalMark(dataTypenum)
return applyStringParamsmw.ustring.gsub(num, "[.]", i18n['errorsnumeric']['unknown-datadecimal-typemark'], dataType1)
end
 
local function padZeros(num, numDigits)
function missingRequiredParameterError()
local numZeros
return i18n['errors']['missing-required-parameter']
local negative = false
end
 
if num < 0 then
function extraRequiredParameterError(param)
negative = true
return applyStringParams(i18n['errors']['extra-required-parameter'], param)
num = num * -1
end
end
 
num = tostring(num)
function getOrdinalSuffix(num)
numZeros = numDigits - num:len()
return i18n.getOrdinalSuffix(num)
end
 
for _ = 1, numZeros do
function addDelimiters(num)
num = "0"..num
return i18n.addDelimiters(num)
end
 
if negative then
function replaceDecimalMark(num)
num = "-"..num
return mw.ustring.gsub(num, "[.]", i18n['numeric']['decimal-mark'], 1)
end
 
return num
end
 
local function replaceSpecialChar(chr)
if chr == '_' then
-- replace underscores with spaces
Line 249 ⟶ 212:
end
 
local function replaceSpecialChars(str)
local chr
local esc = false
local strOut = ""
 
for i = 1, #str do
chr = str:sub(i,i)
 
if not esc then
if chr == '\\' then
Line 268 ⟶ 231:
end
end
 
return strOut
end
 
local function buildWikilink(target, label)
if not label or target == label then
return "[[" .. target .. "]]"
Line 282 ⟶ 245:
-- used to make frame.args mutable, to replace #frame.args (which is always 0)
-- with the actual amount and to simply copy tables
local function copyTable(tIn)
if not tIn then
return nil
end
 
local tOut = {}
 
for i, v in pairs(tIn) do
tOut[i] = v
end
 
return tOut
end
Line 298 ⟶ 261:
-- used to merge output arrays together;
-- note that it currently mutates the first input array
local function mergeArrays(a1, a2)
for i = 1, #a2 do
a1[#a1 + 1] = a2[i]
end
 
return a1
end
 
local function split(str, del)
local out = {}
local i, j = str:find(del)
 
if i and j then
out[1] = str:sub(1, i - 1)
Line 316 ⟶ 279:
out[1] = str
end
 
return out
end
 
local function parseWikidataURL(url)
local IDid
 
if url:match('^http[s]?://') then
IDid = split(url, "Q")
 
if IDid[2] then
return "Q" .. IDid[2]
end
end
 
return nil
end
 
local function 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 (explicitly give base 10 to prevent error)
 
if parts[index] == -0 then
parts[index] = tonumber("0") -- for some reason, 'parts[index] = 0' may actually store '-0', so parse from string instead
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
 
local function datePrecedesDate(aY, aM, aD, bY, bM, bD)
if aY == nil or bY == nil then
return nil
Line 411 ⟶ 374:
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
 
local function getHookName(param, index)
if hookNames[param] then
return hookNames[param][index]
Line 445 ⟶ 408:
end
 
local function alwaysTrue()
return true
end
Line 494 ⟶ 457:
-- ]
--
local function parseFormat(str)
local chr, esc, param, root, cur, prev, new
local params = {}
 
local function newObject(array)
local obj = {} -- new object
obj.str = ""
 
array[#array + 1] = obj -- array{object}
obj.parent = array
 
return obj
end
 
local function endParam()
if param > 0 then
Line 521 ⟶ 484:
end
end
 
root = {} -- array
root.req = {}
cur = newObject(root)
prev = nil
 
esc = false
param = 0
 
for i = 1, #str do
chr = str:sub(i,i)
 
if not esc then
if chr == '\\' then
Line 570 ⟶ 533:
end
end
 
cur.str = cur.str .. replaceSpecialChar(chr)
end
Line 577 ⟶ 540:
esc = false
end
 
prev = nil
end
 
endParam()
 
-- make sure that at least one required parameter has been defined
if not next(root.req) then
throwError("missing-required-parameter")
error(missingRequiredParameterError())
end
 
-- make sure that the separator parameter "%s" is not amongst the required parameters
if root.req[parameters.separator] then
error(extraRequiredParameterErrorthrowError("extra-required-parameter", parameters.separator))
end
 
return root, params
end
 
local function convertRanksortOnRank(rankclaims)
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 sortOnRank(claims)
local rankPos
local ranks = {{}, {}, {}, {}} -- preferred, normal, deprecated, (default)
local sorted = {}
 
for i_, v in ipairs(claims) do
rankPos = convertRank(rankTable[v.rank)] or 4
ranks[rankPos][#ranks[rankPos] + 1] = v
end
 
sorted = ranks[1]
sorted = mergeArrays(sorted, ranks[2])
sorted = mergeArrays(sorted, ranks[3])
 
return sorted
end
 
local function isValueInTable(searchedItem, inputTable)
-- if ID == nil then item connected to current page is used
for _, item in pairs(inputTable) do
function getShortName(ID)
if item == searchedItem then
local args = {p.aliasesP.shortName}
return true
end
if ID then
args[p.args.eid] = ID
end
return false
return p._property(args) -- "property" is single
end
 
local Config = {}
-- if ID == nil then item connected to current page is used
 
function Config:getLabel(ID, raw, link, short)
-- allows for recursive calls
raw = raw or false
function Config:new()
link = link or false
local cfg = {}
short = short or false
setmetatable(cfg, self)
self.__index = self
 
cfg.separators = {
-- single value objects wrapped in arrays so that we can pass by reference
["sep"] = {copyTable(defaultSeparators["sep"])},
["sep%s"] = {copyTable(defaultSeparators["sep%s"])},
["sep%q"] = {copyTable(defaultSeparators["sep%q"])},
["sep%r"] = {copyTable(defaultSeparators["sep%r"])},
["punc"] = {copyTable(defaultSeparators["punc"])}
}
 
cfg.entity = nil
cfg.entityID = nil
cfg.propertyID = nil
cfg.propertyValue = nil
cfg.qualifierIDs = {}
cfg.qualifierIDsAndValues = {}
 
cfg.bestRank = true
cfg.ranks = {true, true, false} -- preferred = true, normal = true, deprecated = false
cfg.foundRank = #cfg.ranks
cfg.flagBest = false
cfg.flagRank = false
 
cfg.periods = {true, true, true} -- future = true, current = true, former = true
cfg.flagPeriod = false
cfg.atDate = {parseDate(os.date('!%Y-%m-%d'))} -- today as {year, month, day}
 
cfg.mdyDate = false
cfg.singleClaim = false
cfg.sourcedOnly = false
cfg.editable = false
cfg.editAtEnd = false
 
cfg.inSitelinks = false
 
cfg.langCode = mw.language.getContentLanguage().code
cfg.langName = mw.language.fetchLanguageName(cfg.langCode, cfg.langCode)
cfg.langObj = mw.language.new(cfg.langCode)
 
cfg.siteID = mw.wikibase.getGlobalSiteId()
 
cfg.states = {}
cfg.states.qualifiersCount = 0
cfg.curState = nil
 
cfg.prefetchedRefs = nil
 
return cfg
end
 
local State = {}
 
function State:new(cfg, type)
local stt = {}
setmetatable(stt, self)
self.__index = self
 
stt.conf = cfg
stt.type = type
 
stt.results = {}
 
stt.parsedFormat = {}
stt.separator = {}
stt.movSeparator = {}
stt.puncMark = {}
 
stt.linked = false
stt.rawValue = false
stt.shortName = false
stt.anyLanguage = false
stt.unitOnly = false
stt.singleValue = false
 
return stt
end
 
-- if id == nil then item connected to current page is used
function Config:getLabel(id, raw, link, short)
local label = nil
local titleprefix, title= "", nil
 
local prefix= ""
if not id then
local lang
id = mw.wikibase.getEntityIdForCurrentPage()
 
if not id then
return ""
end
end
 
id = id:upper() -- just to be sure
 
if raw then
-- check if given id actually exists
if not ID then
if mw.wikibase.isValidEntityId(id) and mw.wikibase.entityExists(id) then
label = mw.wikibase.getEntityIdForCurrentPage()
label = id
elseif mw.wikibase.getEntity(ID) then
label = ID
if ID:sub(1,1) == "P" then
prefix = "Property:"
end
end
 
prefix, title = "d:Special:EntityPage/", label -- may ..be prefixnil
title = label -- may be nil
else
-- try short name first if requested
if short then
label = p._property{aliasesP.shortName, [p.args.eid] = id} -- get short name
label = getShortName(ID)
 
if label == "" then
label = nil
end
end
 
-- get label
if not label then
label, lang = mw.wikibase.getLabelWithLanggetLabel(IDid)
-- don't allow language fallback
if lang ~= self.langCode then
label = nil
end
end
end
 
if not label then
label = ""
Line 687 ⟶ 712:
-- build a link if requested
if not title then
if notid:sub(1,1) ID== "Q" then
title = mw.titlewikibase.getCurrentTitlegetSitelink(id).prefixedText
elseif IDid:sub(1,1) == "QP" then
title = mw.wikibase.sitelink(ID)
elseif ID:sub(1,1) == "P" then
-- properties have no sitelink, link to Wikidata instead
prefix, title = ID"d:Special:EntityPage/", id
prefix = "d:Property:"
end
end
 
label = mw.text.nowiki(label) -- escape raw label text so it cannot be wikitext markup
if title then
label = buildWikilink(prefix .. title, label)
end
end
 
return label
end
Line 709 ⟶ 732:
local value = ""
local prefix = ""
local front = " &nbsp;"
local back = ""
 
if self.entityID:sub(1,1) == "P" then
prefix = "Property:"
end
 
if self.editAtEnd then
front = '<span style="float:'
 
if self.langObj:isRTL() then
front = front .. 'left'
Line 724 ⟶ 747:
front = front .. 'right'
end
 
front = front .. '">'
back = '</span>'
end
 
value = "[[File:BlueOOjs pencilUI icon edit-ltr-progressive.svg|frameless|text-top|10px|alt=" .. i18n['info']['edit-on-wikidata'] .. "|link=https://www.wikidata.org/wiki/" .. prefix .. self.entityID .. "?uselang=" .. self.langCode
 
if self.propertyID then
value = value .. "#" .. self.propertyID
elseif self.pageTitleinSitelinks then
value = value .. "#sitelinks-wikipedia"
end
 
value = value .. "|" .. i18n['info']['edit-on-wikidata'] .. "]]"
 
return front .. value .. back
end
Line 747 ⟶ 770:
local outString = ""
local j, skip
 
for i = 1, #valuesArray do
-- check if this is a reference
Line 753 ⟶ 776:
j = i - 1
skip = false
 
-- skip this reference if it is part of a continuous row of references that already contains the exact same reference
while valuesArray[j] and valuesArray[j].refHash do
Line 762 ⟶ 785:
j = j - 1
end
 
if not skip then
-- add <ref> tag with the reference's hash as its name (to deduplicate references)
outString = outString .. mw.getCurrentFrame():extensionTag("ref", valuesArray[i][1], {name = "wikidata-" .. valuesArray[i].refHash})
end
else
Line 771 ⟶ 794:
end
end
 
return outString
end
 
function Config:convertUnit(unit, raw, link, short, unitOnly)
raw = raw or false
link = link or false
short = short or false
unitOnly = unitOnly or false
local space = " "
local label = ""
local itemID
 
if unit == "" or unit == "1" then
return nil
end
 
if unitOnly then
space = ""
end
 
itemID = parseWikidataURL(unit)
 
if itemID then
if itemID == aliasesQ.percentage then
Line 799 ⟶ 818:
else
label = self:getLabel(itemID, raw, link, short)
 
if label ~= "" then
return space .. label
Line 805 ⟶ 824:
end
end
 
return ""
end
 
function ConfigState:getValue(snak, raw, link, short, anyLang, unitOnly, noSpecial)
return self.conf:getValue(snak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly, false, self.type:sub(1,2))
raw = raw or false
end
link = link or false
 
short = short or false
function Config:getValue(snak, raw, link, short, anyLang, unitOnly, noSpecial, type)
anyLang = anyLang or false
unitOnly = unitOnly or false
noSpecial = noSpecial or false
if snak.snaktype == 'value' then
iflocal datatype = snak.datavalue.type == 'string' then
iflocal subtype = snak.datatype == 'url' and link then
local datavalue = snak.datavalue.value
 
if datatype == 'string' then
if subtype == 'url' and link then
-- create link explicitly
if raw then
-- will render as a linked number like [1]
return "[" .. snak.datavalue.value .. "]"
else
return "[" .. snak.datavalue.value .. " " .. snak.datavalue.value .. "]"
end
elseif snak.datatypesubtype == 'commonsMedia' then
if link then
return buildWikilink("c:File:" .. snak.datavalue.value, snak.datavalue.value)
elseif not raw then
return "[[File:" .. snak.datavalue.value .. "]]"
else
return snak.datavalue.value
end
elseif subtype == 'geo-shape' and link then
return buildWikilink("c:" .. datavalue, datavalue)
elseif subtype == 'math' and not raw then
local attribute = nil
 
if (type == parameters.property or (type == parameters.qualifier and self.propertyID == aliasesP.hasPart)) and snak.property == aliasesP.definingFormula then
attribute = {qid = self.entityID}
end
 
return mw.getCurrentFrame():extensionTag("math", datavalue, attribute)
elseif subtype == 'external-id' and link then
local url = p._property{aliasesP.formatterURL, [p.args.eid] = snak.property} -- get formatter URL
 
if url ~= "" then
url = mw.ustring.gsub(url, "$1", datavalue)
return "[" .. url .. " " .. datavalue .. "]"
else
return datavalue
end
elseif snak.datatype == 'geo-shape' and link then
return buildWikilink("c:" .. snak.datavalue.value, snak.datavalue.value)
elseif snak.datatype == 'math' and not raw then
return mw.getCurrentFrame():extensionTag("math", snak.datavalue.value)
else
return snak.datavalue.value
end
elseif snak.datavalue.typedatatype == 'monolingualtext' then
if anyLang or datavalue['language'] == self.langCode then
return snak.datavalue.value['text'], snak.datavalue.value['language']
elseif snak.datavalue.value['language'] == self.langCode then
return snak.datavalue.value['text']
else
return nil
end
elseif snak.datavalue.typedatatype == 'quantity' then
local value = ""
local unit
 
if not unitOnly then
-- get value and strip + signs from front
value = mw.ustring.gsub(snak.datavalue.value['amount'], "^\%+(.+)$", "%1")
 
if raw then
return value
end
 
-- replace decimal mark based on locale
value = replaceDecimalMark(value)
 
-- add delimiters for readability
value = i18n.addDelimiters(value)
end
 
unit = self:convertUnit(snak.datavalue.value['unit'], raw, link, short, unitOnly)
 
if unit then
value = value .. unit
end
 
return value
elseif snak.datavalue.typedatatype == 'time' then
local y, m, d, p, yDiv, yRound, yFull, value, calendarID, dateStr
local yFactor = 1
Line 884 ⟶ 917:
local mayAddCalendar = false
local calendar = ""
local precision = snak.datavalue.value['precision']
 
if precision == 11 then
p = "d"
Line 894 ⟶ 927:
yFactor = 10^(9-precision)
end
 
y, m, d = 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 not raw then
if precision == 6 then
Line 920 ⟶ 953:
suffix = i18n['datetime']['suffixes']['century']
end
 
suffix = i18n.getOrdinalSuffix(yRound) .. suffix
else
-- if not verbose, take the first year of the century/millennium
Line 931 ⟶ 964:
-- round decades down (e.g. 2010s)
yRound = math.floor(yDiv) * yFactor
 
if not raw then
prefix = i18n['datetime']['prefixes']['decade-period']
Line 937 ⟶ 970:
end
end
 
if raw and sign < 0 then
-- if BCE then compensate for "counting backwards"
Line 945 ⟶ 978:
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
Line 954 ⟶ 987:
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
Line 962 ⟶ 995:
end
end
 
if yRound == 0 then
-- otherwise, take the unrounded (original) number of years
Line 971 ⟶ 1,004:
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
Line 988 ⟶ 1,021:
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
Line 997 ⟶ 1,030:
end
end
 
if not raw then
if precision == 3 then
Line 1,019 ⟶ 1,052:
mayAddCalendar = true
end
 
if mayAddCalendar then
calendarID = parseWikidataURL(snak.datavalue.value['calendarmodel'])
 
if calendarID and calendarID == aliasesQ.prolepticJulianCalendar then
if not raw then
Line 1,035 ⟶ 1,068:
end
end
 
if not raw then
local ce = nil
 
if sign < 0 then
ce = i18n['datetime']['BCE']
Line 1,044 ⟶ 1,077:
ce = i18n['datetime']['CE']
end
 
if ce then
if link then
Line 1,051 ⟶ 1,084:
suffix = suffix .. " " .. ce
end
 
value = tostring(yRound)
 
if m then
dateStr = self.langObj:formatDate("F", "1-"..m.."-1")
 
if d then
if self.mdyDate then
Line 1,064 ⟶ 1,097:
end
end
 
value = dateStr .. " " .. value
end
 
value = prefix .. value .. suffix .. calendar
else
value = tostringpadZeros(yRound * sign, 4)
 
if m then
value = value .. "-" .. padZeros(m, 2)
 
if d then
value = value .. "-" .. padZeros(d, 2)
end
end
 
value = value .. calendar
end
 
return value
elseif snak.datavalue.typedatatype == 'globecoordinate' then
-- logic from https://github.com/DataValues/Geo (v4.0.1)
 
local precision, unitsPerDegree, numDigits, strFormat, value, globe
local latValue, latitude, latDegreeslatConv, latMinuteslatValue, latSecondslatLink
local lonValue, longitude, lonDegreeslonConv, lonMinuteslonValue, lonSecondslonLink
local latDirection, latDirectionN, latDirectionS, latDirectionEN
local lonDirection, lonDirectionE, lonDirectionW, lonDirectionEN
local degSymbol, minSymbol, secSymbol, separator
 
local latDegrees = nil
local latMinutes = nil
local latSeconds = nil
local lonDegrees = nil
local lonMinutes = nil
local lonSeconds = nil
 
local latDegSym = ""
local latMinSym = ""
local latSecSym = ""
local lonDegSym = ""
local lonMinSym = ""
local lonSecSym = ""
 
local latDirectionEN_N = "N"
local latDirectionEN_S = "S"
local lonDirectionEN_E = "E"
local lonDirectionEN_W = "W"
 
if not raw then
latDirectionN = i18n['coord']['latitude-north']
Line 1,103 ⟶ 1,151:
lonDirectionE = i18n['coord']['longitude-east']
lonDirectionW = i18n['coord']['longitude-west']
 
degSymbol = i18n['coord']['degrees']
minSymbol = i18n['coord']['minutes']
Line 1,113 ⟶ 1,161:
lonDirectionE = lonDirectionEN_E
lonDirectionW = lonDirectionEN_W
 
degSymbol = "/"
minSymbol = "/"
Line 1,119 ⟶ 1,167:
separator = "/"
end
 
latitude = snak.datavalue.value['latitude']
longitude = snak.datavalue.value['longitude']
 
if latitude < 0 then
latDirection = latDirectionS
Line 1,131 ⟶ 1,179:
latDirectionEN = latDirectionEN_N
end
 
if longitude < 0 then
lonDirection = lonDirectionW
Line 1,140 ⟶ 1,188:
lonDirectionEN = lonDirectionEN_E
end
 
precision = snak.datavalue.value['precision']
 
if not precision or precision <= 0 then
precision = 1 / 3600 -- precision not set (correctly), set to arcsecond
end
 
-- remove insignificant detail
latitude = math.floor(latitude / precision + 0.5) * precision
longitude = math.floor(longitude / precision + 0.5) * precision
 
if precision >= 1 - (1 / 60) and precision < 1 then
numDigits = math.ceil(-math.log10(3600 * precision))
precision = 1
elseif precision >= (1 / 60) - (1 / 3600) and precision < (1 / 60) then
if numDigits < 0 or numDigits == -0 then
precision = 1 / 60
end
 
if precision >= 1 then
unitsPerDegree = 1
elseif precision >= (1 / 60) then
unitsPerDegree = 60
else
unitsPerDegree = 3600
end
 
numDigits = math.ceil(-math.log10(unitsPerDegree * precision))
 
if numDigits <= 0 then
numDigits = tonumber("0") -- for some reason, 'numDigits = 0' may actually store '-0', so parse from string instead
end
 
strFormat = "%." .. numDigits .. "f"
 
if precision >= 1 then
-- use string.format() to strip decimal point followed by a zero (.0) for whole numbers
latSeconds latDegrees = tonumber(strFormat:format(math.floor(latitude * 3600 * 10^numDigits + 0.5) / 10^numDigits))
lonSeconds lonDegrees = tonumber(strFormat:format(math.floor(longitude * 3600 * 10^numDigits + 0.5) / 10^numDigits))
 
latMinutes = math.floor(latSeconds / 60)
lonMinutes = math.floor(lonSeconds / 60)
latSeconds = latSeconds - (latMinutes * 60)
lonSeconds = lonSeconds - (lonMinutes * 60)
latDegrees = math.floor(latMinutes / 60)
lonDegrees = math.floor(lonMinutes / 60)
latMinutes = latMinutes - (latDegrees * 60)
lonMinutes = lonMinutes - (lonDegrees * 60)
latValue = latDegrees .. degSymbol
lonValue = lonDegrees .. degSymbol
if precision < 1 then
latValue = latValue .. latMinutes .. minSymbol
lonValue = lonValue .. lonMinutes .. minSymbol
end
if precision < (1 / 60) then
latSeconds = strFormat:format(latSeconds)
lonSeconds = strFormat:format(lonSeconds)
if not raw then
latDegSym = replaceDecimalMark(latDegrees) .. degSymbol
-- replace decimal marks based on locale
latSecondslonDegSym = replaceDecimalMark(latSecondslonDegrees) .. degSymbol
else
lonSeconds = replaceDecimalMark(lonSeconds)
latDegSym = latDegrees .. degSymbol
lonDegSym = lonDegrees .. degSymbol
end
else
latConv = math.floor(latitude * unitsPerDegree * 10^numDigits + 0.5) / 10^numDigits
lonConv = math.floor(longitude * unitsPerDegree * 10^numDigits + 0.5) / 10^numDigits
 
if precision >= (1 / 60) then
latMinutes = latConv
lonMinutes = lonConv
else
latSeconds = latConv
lonSeconds = lonConv
 
latMinutes = math.floor(latSeconds / 60)
lonMinutes = math.floor(lonSeconds / 60)
 
latSeconds = strFormat:format(latSeconds - (latMinutes * 60))
lonSeconds = strFormat:format(lonSeconds - (lonMinutes * 60))
 
if not raw then
latSecSym = replaceDecimalMark(latSeconds) .. secSymbol
lonSecSym = replaceDecimalMark(lonSeconds) .. secSymbol
else
latSecSym = latSeconds .. secSymbol
lonSecSym = lonSeconds .. secSymbol
end
end
 
latDegrees = math.floor(latMinutes / 60)
lonDegrees = math.floor(lonMinutes / 60)
 
latDegSym = latDegrees .. degSymbol
lonDegSym = lonDegrees .. degSymbol
 
latMinutes = latMinutes - (latDegrees * 60)
lonMinutes = lonMinutes - (lonDegrees * 60)
 
if precision >= (1 / 60) then
latMinutes = strFormat:format(latMinutes)
lonMinutes = strFormat:format(lonMinutes)
 
if not raw then
latMinSym = replaceDecimalMark(latMinutes) .. minSymbol
lonMinSym = replaceDecimalMark(lonMinutes) .. minSymbol
else
latMinSym = latMinutes .. minSymbol
lonMinSym = lonMinutes .. minSymbol
end
else
latMinSym = latMinutes .. minSymbol
lonMinSym = lonMinutes .. minSymbol
end
latValue = latValue .. latSeconds .. secSymbol
lonValue = lonValue .. lonSeconds .. secSymbol
end
 
latValue = latValuelatDegSym .. latMinSym .. latSecSym .. latDirection
lonValue = lonValuelonDegSym .. lonMinSym .. lonSecSym .. lonDirection
 
value = latValue .. separator .. lonValue
 
if link then
globe = parseWikidataURL(snak.datavalue.value['globe'])
 
if globe then
globe = mw.wikibase.getEntitygetLabelByLang(globe):getLabel(, "en"):lower()
else
globe = "earth"
end
 
latLink = table.concat({latDegrees, latMinutes, latSeconds}, "_")
value = "[https://tools.wmflabs.org/geohack/geohack.php?language="..self.langCode.."&params="..latitude.."_"..latDirectionEN.."_"..longitude.."_"..lonDirectionEN.."_globe:"..globe.." "..value.."]"
lonLink = table.concat({lonDegrees, lonMinutes, lonSeconds}, "_")
 
value = "[https://geohack.toolforge.org/geohack.php?language="..self.langCode.."&params="..latLink.."_"..latDirectionEN.."_"..lonLink.."_"..lonDirectionEN.."_globe:"..globe.." "..value.."]"
end
 
return value
elseif snak.datavalue.typedatatype == 'wikibase-entityid' then
local label
local itemID = snak.datavalue.value['numeric-id']
 
if snak.datatypesubtype == 'wikibase-item' then
itemID = "Q" .. itemID
elseif snak.datatypesubtype == 'wikibase-property' then
itemID = "P" .. itemID
else
return '<strong class="error">' .. unknownDataTypeErrorerrorText(snak.datatype'unknown-data-type', subtype) .. '</strong>'
end
 
label = self:getLabel(itemID, raw, link, short)
 
if label == "" then
label = nil
end
 
return label
else
return '<strong class="error">' .. unknownDataTypeErrorerrorText(snak.datavalue.'unknown-data-type', datatype) .. '</strong>'
end
elseif snak.snaktype == 'somevalue' and not noSpecial then
Line 1,251 ⟶ 1,346:
function Config:getSingleRawQualifier(claim, qualifierID)
local qualifiers
 
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
 
if qualifiers and qualifiers[1] then
return self:getValue(qualifiers[1], true) -- raw = true
Line 1,263 ⟶ 1,358:
function Config:snakEqualsValue(snak, value)
local snakValue = self:getValue(snak, true) -- raw = true
 
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
 
return snakValue == value
end
Line 1,271 ⟶ 1,366:
function Config:setRank(rank)
local rankPos
 
if rank == p.flags.best then
self.bestRank = true
Line 1,277 ⟶ 1,372:
return
end
 
if rank:sub(1,9) == p.flags.preferred then
rankPos = 1
Line 1,287 ⟶ 1,382:
return
end
 
-- one of the rank flags was given, check if another one was given before
if not self.flagRank then
Line 1,294 ⟶ 1,389:
self.flagRank = true -- mark that a rank flag was given
end
 
if rank:sub(-1) == "+" then
for i = rankPos, 1, -1 do
Line 1,310 ⟶ 1,405:
function Config:setPeriod(period)
local periodPos
 
if period == p.flags.future then
periodPos = 1
Line 1,320 ⟶ 1,415:
return
end
 
-- one of the period flags was given, check if another one was given before
if not self.flagPeriod then
Line 1,326 ⟶ 1,421:
self.flagPeriod = true -- mark that a period flag was given
end
 
self.periods[periodPos] = true
end
 
function Config:qualifierMatches(claim, id, value)
local qualifiers
 
if claim.qualifiers then qualifiers = claim.qualifiers[id] end
if qualifiers then
for _, v in pairs(qualifiers) do
if self:snakEqualsValue(v, value) then
return true
end
end
elseif value == "" then
-- if the qualifier is not present then treat it the same as the special value 'novalue'
return true
end
 
return false
end
 
function Config:rankMatches(rankPos)
if self.bestRank then
return (self.ranks[rankPos] and self.foundRank >= rankPos)
else
return self.ranks[rankPos]
end
end
 
function Config:timeMatches(claim)
local startTime = nil
local startTimeY = nil
local startTimeM = nil
local startTimeD = nil
local endTime = nil
local endTimeY = nil
local endTimeM = nil
local endTimeD = nil
 
if self.periods[1] and self.periods[2] and self.periods[3] then
-- any time
return true
end
 
startTime = self:getSingleRawQualifier(claim, aliasesP.startTime)
if startTime and startTime ~= "" and startTime ~= " " then
startTimeY, startTimeM, startTimeD = parseDate(startTime)
end
 
endTime = self:getSingleRawQualifier(claim, aliasesP.endTime)
if endTime and endTime ~= "" and endTime ~= " " then
endTimeY, endTimeM, endTimeD = parseDate(endTime)
end
 
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
-- invalidate end time if it precedes start time
endTimeY = nil
endTimeM = nil
endTimeD = nil
end
 
if self.periods[1] then
-- future
if startTimeY and datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD) then
return true
end
end
 
if self.periods[2] then
-- current
if (startTimeY == nil or not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD)) and
(endTimeY == nil or datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD)) then
return true
end
end
 
if self.periods[3] then
-- former
if endTimeY and not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD) then
return true
end
end
 
return false
end
 
Line 1,333 ⟶ 1,511:
if not flag then
return false
else
flag = mw.text.trim(flag)
end
 
if flag == p.flags.linked then
self.curState.linked = true
Line 1,342 ⟶ 1,518:
elseif flag == p.flags.raw then
self.curState.rawValue = true
 
if self.curState == self.states[parameters.reference] then
-- raw reference values end with periods and require a separator (other than none)
self.separators["sep%r"][1] = {" "}
end
 
return true
elseif flag == p.flags.short then
Line 1,390 ⟶ 1,566:
function Config:processFlagOrCommand(flag)
local param = ""
 
if not flag then
return false
else
flag = mw.text.trim(flag)
end
 
if flag == p.commandsclaimCommands.property or flag == p.commandsclaimCommands.properties then
param = parameters.property
elseif flag == p.commandsclaimCommands.qualifier or flag == p.commandsclaimCommands.qualifiers then
self.states.qualifiersCount = self.states.qualifiersCount + 1
param = parameters.qualifier .. self.states.qualifiersCount
self.separators["sep"..param] = {copyTable(defaultSeparators["sep%q\\d"])}
elseif flag == p.commandsclaimCommands.reference or flag == p.commandsclaimCommands.references then
param = parameters.reference
else
return self:processFlag(flag)
end
 
if self.states[param] then
return false
end
 
-- create a new state for each command
self.states[param] = State.:new(self, param)
 
-- use "%x" as the general parameter name
self.states[param].parsedFormat = parseFormat(parameters.general) -- will be overwritten for param=="%p"
 
-- set the separator
self.states[param].separator = self.separators["sep"..param] -- will be nil for param=="%p", which will be set separately
 
if flag == p.claimCommands.property or flag == p.claimCommands.qualifier or flag == p.claimCommands.reference then
if flag:sub(-1) ~= 's' then
self.states[param].singleValue = true
end
 
self.curState = self.states[param]
 
return true
end
 
function Config:qualifierMatchesprocessSeparators(claim, ID, valueargs)
local qualifierssep
 
for i, v in pairs(self.separators) do
if claim.qualifiers then qualifiers = claim.qualifiers[ID] end
if qualifiersargs[i] then
sep = replaceSpecialChars(args[i])
for i, v in pairs(qualifiers) do
 
if self:snakEqualsValue(v, value) then
if sep ~= "" then
return true
self.separators[i][1] = {sep}
else
self.separators[i][1] = nil
end
end
elseif value == "" then
-- if the qualifier is not present then treat it the same as the special value 'novalue'
return true
end
return false
end
 
function Config:rankMatchessetFormatAndSeparators(rankPosstate, parsedFormat)
state.parsedFormat = parsedFormat
if self.bestRank then
state.separator = self.separators["sep"]
return (self.ranks[rankPos] and self.foundRank >= rankPos)
state.movSeparator = self.separators["sep"..parameters.separator]
else
state.puncMark = self.separators["punc"]
return self.ranks[rankPos]
end
end
 
function Config:timeMatches(claim)
local startTime = nil
local startTimeY = nil
local startTimeM = nil
local startTimeD = nil
local endTime = nil
local endTimeY = nil
local endTimeM = nil
local endTimeD = nil
if self.periods[1] and self.periods[2] and self.periods[3] then
-- any time
return true
end
local now = os.date('!*t')
startTime = self:getSingleRawQualifier(claim, p.aliasesP.startTime)
if startTime and startTime ~= "" and startTime ~= " " then
startTimeY, startTimeM, startTimeD = parseDate(startTime)
end
endTime = self:getSingleRawQualifier(claim, p.aliasesP.endTime)
if endTime and endTime ~= "" and endTime ~= " " then
endTimeY, endTimeM, endTimeD = 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
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
-- invalidate end time if it precedes start time
endTimeY = nil
endTimeM = nil
endTimeD = nil
end
if self.periods[1] then
-- future
if startTimeY and datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD) then
return true
end
end
if self.periods[2] then
-- current
if (startTimeY == nil or not datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD)) and
(endTimeY == nil or datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD)) then
return true
end
end
if self.periods[3] then
-- former
if endTimeY and not datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD) then
return true
end
end
return false
end
 
Line 1,537 ⟶ 1,643:
function State:claimMatches(claim)
local matches, rankPos
 
-- first of all, reset any cached values used for the previous claim
self:resetCaches()
 
-- if a property value was given, check if it matches the claim's property value
if self.conf.propertyValue then
Line 1,547 ⟶ 1,653:
matches = true
end
 
-- if any qualifier values were given, check if each matches one of the claim's qualifier values
for i, v in pairs(self.conf.qualifierIDsAndValues) do
matches = (matches and self.conf:qualifierMatches(claim, i, v))
end
 
-- check if the claim's rank and time period match
rankPos = convertRank(rankTable[claim.rank)] or 4
matches = (matches and self.conf:rankMatches(rankPos) and self.conf:timeMatches(claim))
 
-- if only claims with references must be returned, check if this one has any
if self.conf.sourcedOnly then
matches = (matches and self:isSourced(claim)) -- prefetches and caches references
end
 
return matches, rankPos
end
Line 1,570 ⟶ 1,676:
local sep = nil -- value object
local out = {} -- array with value objects
 
local function walk(formatTable, result)
local valuesArray = {} -- array with value objects
 
for i, v in pairs(formatTable.req) do
if not result[i] or not result[i][1] then
Line 1,581 ⟶ 1,687:
end
end
 
for i_, v in ipairs(formatTable) do
if v.param then
valuesArray = mergeArrays(valuesArray, result[v.str])
Line 1,588 ⟶ 1,694:
valuesArray[#valuesArray + 1] = {v.str}
end
 
if v.child then
valuesArray = mergeArrays(valuesArray, walk(v.child, result))
end
end
 
return valuesArray
end
 
-- iterate through the results from back to front, so that we know when to add separators
for i = #self.results, 1, -1 do
result = self.results[i]
 
-- if there is already some output, then add the separators
if #out > 0 then
Line 1,609 ⟶ 1,715:
result[parameters.separator] = {self.puncMark[1]} -- optional punctuation mark
end
 
valuesArray = walk(self.parsedFormat, result)
 
if #valuesArray > 0 then
if sep then
valuesArray[#valuesArray + 1] = sep
end
 
out = mergeArrays(valuesArray, out)
end
end
 
-- reset state before next iteration
self.results = {}
 
return out
end
Line 1,629 ⟶ 1,735:
-- level 1 hook
function State:getProperty(claim)
local value = {self.conf:getValue(claim.mainsnak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)} -- create one value object
 
if #value > 0 then
return {value} -- wrap the value object in an array and return it
Line 1,641 ⟶ 1,747:
function State:getQualifiers(claim, param)
local qualifiers
 
if claim.qualifiers then qualifiers = claim.qualifiers[self.conf.qualifierIDs[param]] end
if qualifiers then
Line 1,654 ⟶ 1,760:
-- level 2 hook
function State:getQualifier(snak)
local value = {self.conf:getValue(snak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)} -- create one value object
 
if #value > 0 then
return {value} -- wrap the value object in an array and return it
Line 1,667 ⟶ 1,773:
local out = {} -- array with value objects
local sep = self.conf.separators["sep"..parameters.qualifier][1] -- value object
 
-- iterate through the output of the separate "qualifier(s)" commands
for i = 1, self.conf.states.qualifiersCount do
 
-- if a hook has not been called yet, call it now
if not result[parameters.qualifier..i] then
self:callHook(parameters.qualifier..i, hooks, claim, result)
end
 
-- if there is output for this particular "qualifier(s)" command, then add it
if result[parameters.qualifier..i] and result[parameters.qualifier..i][1] then
 
-- if there is already some output, then add the separator
if #out > 0 and sep then
out[#out + 1] = sep
end
 
out = mergeArrays(out, result[parameters.qualifier..i])
end
end
 
return out
end
Line 1,697 ⟶ 1,803:
return self.conf.prefetchedRefs
end
 
if claim.references then
-- iterate through claim's reference statements to collect their values;
Line 1,708 ⟶ 1,814:
 
-- level 2 hook
-- logic determined based on https://www.wikidata.org/wiki/Help:Sources
function State:getReference(statement)
local citeParamMapping = i18n['cite']['param-mapping']
local language, referenceURL, title, statedIn, statedInRaw, template
local authorsciteConfig = {}i18n['cite']['config']
local paramsciteTypes = {}i18n['cite']['output-types']
-- will hold rendered properties of the reference which are not directly from statement.snaks,
-- Namely, is URL generated from an external ID.
local additionalProcessedProperties = {}
-- for each citation type, there will be an associative array that associates lists of rendered properties
-- to citation-template parameters
local candidateParams = {}
-- like above, but only associates one rendered property to each parameter; if the above variable
-- contains more strings for a parameter, the strings will be assigned to numbered params (e.g. "author1")
local citeParams = {}
 
local value = ""
local refciteErrors = {}
local referenceEmpty = true -- will be set to false if at least one parameter is left unremoved
 
local version = 12 -- increment this each time the below logic is changed to avoid conflict errors
 
if not statement.snaks then
return {}
end
 
-- don't use bot-added references referencing Wikimedia projects or containing "inferred from" (such references are not usable on Wikipedia)
if statement.snaks[aliasesP.importedFrom] or statement.snaks[aliasesP.wikimediaImportURL] or statement.snaks[aliasesP.inferredFrom] then
return {}
end
-- don't include "type of reference"
-- number of parameters that do not go along with "stated in"-sources other than web pages as per https://www.wikidata.org/wiki/Help:Sources;
if statement.snaks[aliasesP.typeOfReference] then
-- these are parameters of properties other than "pages(s)" and "chapter" (for books) and "title" and "publication date" (for databases) and also "stated in"
statement.snaks[aliasesP.typeOfReference] = nil
local hasExtraParams = false
end
 
if statement.snaks then
-- don't include "imported fromimage", which has been added byto aprevent botlittering
if statement.snaks[p.aliasesP.importedFromimage] then
statement.snaks[p.aliasesP.importedFromimage] = nil
end
 
-- don't include "language" if it is equal to the local one
if self:getReferenceDetail(statement.snaks, aliasesP.language) == self.conf.langName then
statement.snaks[aliasesP.language] = nil
end
if statement.snaks[aliasesP.statedIn] and not statement.snaks[aliasesP.referenceURL] then
-- "stated in" was given but "reference URL" was not.
-- get "Wikidata property" properties from the item in "stated in"
-- if any of the returned properties of the external-id datatype is in statement.snaks, generate a link from it and use the link in the reference
-- find the "Wikidata property" properties in the item from "stated in"
local wikidataPropertiesOfSource = mw.text.split(p._properties{p.flags.raw, aliasesP.wikidataProperty, [p.args.eid] = self.conf:getValue(statement.snaks[aliasesP.statedIn][1], true, false)}, ", ", true)
for i, wikidataPropertyOfSource in pairs(wikidataPropertiesOfSource) do
if statement.snaks[wikidataPropertyOfSource] and statement.snaks[wikidataPropertyOfSource][1].datatype == "external-id" then
local tempLink = self:getReferenceDetail(statement.snaks, wikidataPropertyOfSource, false, true) -- not raw, linked
if mw.ustring.match(tempLink, "^%[%Z- %Z+%]$") then -- getValue returned a URL in square brackets.
-- the link is in wiki markup, so strip the square brackets and the display text
-- gsub also returns another, discarted value, therefore the result is assigned to tempLink first
tempLink = mw.ustring.gsub(tempLink, "^%[(%Z-) %Z+%]$", "%1")
additionalProcessedProperties[aliasesP.referenceURL] = {tempLink}
statement.snaks[wikidataPropertyOfSource] = nil
break
end
end
end
end
-- initialize candidateParams and citeParams
for _, citeType in ipairs(citeTypes) do
candidateParams[citeType] = {}
citeParams[citeType] = {}
end
 
-- fill candidateParams
for _, citeType in ipairs(citeTypes) do
-- This will contain value--priority pairs for each param name.
local candidateValuesAndPriorities = {}
 
-- fill candidateValuesAndPriorities
for refProperty in pairs(statement.snaks) do
if citeErrors[citeType] then
break
end
repeat -- just a simple wrapper to emulate "continue"
-- set mappingKey and prefix
local mappingKey
local prefix = ""
if statement.snaks[refProperty][1].datatype == 'external-id' then
mappingKey = "external-id"
prefix = self.conf:getLabel(refProperty)
if prefix ~= "" then
-- not linked yet because we need the plain value for comparison first
prefix = prefix .. " "
language = self:getReferenceDetail(statement.snaks, p.aliasesP.language, false, false, false, true) -- (noUnset = true)
end
if language then
-- not part of a "stated in"-source
hasExtraParams = true
-- only add language to the reference if it differs from the local one
if self.conf.langName ~= language then
if self.linked then
-- retrieve language again, but this time with link
params[p.aliasesP.language] = self:getReferenceDetail(statement.snaks, p.aliasesP.language, false, true) -- link = true
else
mappingKey = refProperty
params[p.aliasesP.language] = language
end
local paramName = citeParamMapping[citeType][mappingKey]
-- skip properties with empty parameter name
if paramName == "" then
break -- skip this property for this value of citeType
end
-- handle unknown properties in the reference
if not paramName then
referenceEmpty = false
local error_message = errorText("unknown-property-in-ref", refProperty)
assert(error_message) -- Should not be nil
citeErrors[citeType] = error_message
break
end
-- set processedProperty
local processedProperty
local raw = false -- if the value is wanted raw
if isValueInTable(paramName, citeConfig[citeType]["raw-value-params"] or {}) then
raw = true
end
if isValueInTable(paramName, citeConfig[citeType]["numbered-params"] or {}) then
-- Multiple values may be given.
processedProperty = self:getReferenceDetails(statement.snaks, refProperty, raw, self.linked, true) -- anyLang = true
else
-- If multiple values are given, all but the first suitable one are discarted.
processedProperty = {self:getReferenceDetail(statement.snaks, refProperty, raw, self.linked and (statement.snaks[refProperty][1].datatype ~= 'url'), true)} -- link = true/false, anyLang = true
end
end
-- we have to manually unset, since the first call to getReferenceDetail was with noUnset and the second call might not have happened
statement.snaks[p.aliasesP.language] = nil
end
if #processedProperty == 0 then
authors = self:getReferenceDetails(statement.snaks, p.aliasesP.author, false, self.linked) -- link = true/false
break
if #authors > 0 then
end
-- not part of a "stated in"-source
hasExtraParams = true
referenceEmpty = false
-- add an empty entry to candidateValuesAndPriorities, if there isn't one already
if not candidateValuesAndPriorities[paramName] then
candidateValuesAndPriorities[paramName] = {}
end
-- find the priority of refProperty
local thisPropertyPriority = -1
local thisParamPrioritization = citeConfig[citeType]["prioritization"][paramName]
if thisParamPrioritization then
for i_priority, i_property in ipairs(thisParamPrioritization) do
if i_property == refProperty then
thisPropertyPriority = i_priority
end
end
end
for _, propertyValue in pairs(processedProperty) do
table.insert(
candidateValuesAndPriorities[paramName],
{prefix .. propertyValue, thisPropertyPriority}
)
end
until true
end
-- fill candidateParams[citeType]
referenceURL = self:getReferenceDetail(statement.snaks, p.aliasesP.referenceURL)
if referenceURLnot citeErrors[citeType] then
local compareValuePriorities = function(pair1, pair2)
-- not part of a "stated in"-source
if pair1[2] == -1 and pair2[2] ~= -1 then
hasExtraParams = true
return false
end
end
if pair1[2] ~= -1 and pair2[2] == -1 then
-- the next two may be part of a "stated in"-source, so retrieve them already so that they won't count as hasExtraParams
return true
title = self:getReferenceDetail(statement.snaks, p.aliasesP.title, false, false, true) -- anyLang = true
end
statedIn = self:getReferenceDetail(statement.snaks, p.aliasesP.statedIn, false, true, false, true) -- link = true, (noUnset = true)
return pair1[2] < pair2[2]
-- get title of general template for citing web references
template = mw.wikibase.sitelink(aliasesQ.citeWeb) or ""
template = split(template, ":")[2] -- split off namespace from front
-- (1) if both "reference URL" and "title" are present, then use the general template for citing web references
if referenceURL and title and template then
citeParams[i18n['cite']['url']] = referenceURL
citeParams[i18n['cite']['title']] = title
citeParams[i18n['cite']['website']] = statedIn
citeParams[i18n['cite']['language']] = params[p.aliasesP.language]
citeParams[i18n['cite']['date']] = self:getReferenceDetail(statement.snaks, p.aliasesP.publicationDate)
citeParams[i18n['cite']['access-date']] = self:getReferenceDetail(statement.snaks, p.aliasesP.retrieved)
citeParams[i18n['cite']['archive-url']] = self:getReferenceDetail(statement.snaks, p.aliasesP.archiveURL)
citeParams[i18n['cite']['archive-date']] = self:getReferenceDetail(statement.snaks, p.aliasesP.archiveDate)
citeParams[i18n['cite']['publisher']] = self:getReferenceDetail(statement.snaks, p.aliasesP.publisher, false, self.linked) -- link = true/false
citeParams[i18n['cite']['quote']] = self:getReferenceDetail(statement.snaks, p.aliasesP.quote, false, false, true) -- anyLang = true
citeParams[i18n['cite']['pages']] = self:getReferenceDetail(statement.snaks, p.aliasesP.pages)
for i, v in ipairs(authors) do
citeParams[i18n['cite']['author']..i] = v
end
-- fill candidateParams[citeType][paramName] for each used param
-- if this module is being substituted then build a regular template call, otherwise expand the template
for paramName, _ in pairs(candidateValuesAndPriorities) do
if mw.isSubsting() then
table.sort(candidateValuesAndPriorities[paramName], compareValuePriorities)
for i, v in pairs(citeParams) do
candidateParams[citeType][paramName] = {}
value = value .. "|" .. i .. "=" .. v
for _, valuePriorityPair in ipairs(candidateValuesAndPriorities[paramName]) do
table.insert(candidateParams[citeType][paramName], valuePriorityPair[1])
end
value = "{{" .. template .. value .. "}}"
else
value = mw.getCurrentFrame():expandTemplate{title=template, args=citeParams}
end
elseend
end
-- we need the raw Q-identifier for the next template
statedInRaw = self:getReferenceDetail(statement.snaks, p.aliasesP.statedIn, true) -- raw = true
-- handle additional properties
for refProperty in pairs(additionalProcessedProperties) do
-- the next three may be part of a "stated in"-source, so retrieve them already so that they won't count as hasExtraParams
for _, citeType in ipairs(citeTypes) do
params[p.aliasesP.pages] = self:getReferenceDetail(statement.snaks, p.aliasesP.pages)
repeat
params[p.aliasesP.chapter] = self:getReferenceDetail(statement.snaks, p.aliasesP.chapter)
-- skip if there already have been errors
params[p.aliasesP.publicationDate] = self:getReferenceDetail(statement.snaks, p.aliasesP.publicationDate)
if citeErrors[citeType] then
break
-- retrieve the rest of the parameters and make them count as hasExtraParams
for i in pairs(statement.snaks) do
params[i] = self:getReferenceDetail(statement.snaks, i, false, self.linked, true) -- link = true/false, anyLang = true
hasExtraParams = true
end
-- get title of template that expands a given stated-in item
template = mw.wikibase.sitelink(aliasesQ.citeQ) or ""
template = split(template, ":")[2] -- split off namespace from front
-- (2) if "stated in" is present without any parameters not belonging to a "stated in"-source, then use the template that expands the stated-in item
if statedInRaw and not hasExtraParams and template then
citeParams[i18n['cite']['pages-q']] = params[p.aliasesP.pages]
citeParams[i18n['cite']['chapter']] = params[p.aliasesP.chapter]
citeParams[i18n['cite']['date-q']] = params[p.aliasesP.publicationDate]
if mw.isSubsting() then
for i, v in pairs(citeParams) do
value = value .. "|" .. i .. "=" .. v
end
value = "{{" .. template .. "|" .. statedInRaw .. value .. "}}"
else
citeParams[1] = statedInRaw
value = mw.getCurrentFrame():expandTemplate{title=template, args=citeParams}
end
-- (3) else, do some default rendering of name-value pairs, but only if at least "stated in" or "reference URL" is present
elseif statedIn or referenceURL then
-- authors were already retrieved; start by adding them up front
if #authors > 0 then
citeParams[#citeParams + 1] = table.concat(authors, " & ")
end
local paramName = citeParamMapping[citeType][refProperty]
-- combine "reference URL" and "title" into one link if both are present
-- handle unknown properties in the reference
if referenceURL and title then
if not paramName then
citeParams[#citeParams + 1] = "[" .. referenceURL .. " " .. title .. "]"
-- Skip this additional property, but do not cause an error.
elseif referenceURL then
break
citeParams[#citeParams + 1] = referenceURL
elseif title then
citeParams[#citeParams + 1] = title
end
if paramName == "" then
break
if statedIn then
citeParams[#citeParams + 1] = statedIn
end
referenceEmpty = false
for i, v in pairs(params) do
i = self.conf:getLabel(i)
if not candidateParams[citeType][paramName] then
candidateParams[citeType][paramName] = {}
if i ~= "" then
end
citeParams[#citeParams + 1] = i .. ": " .. v
for _, propertyValue in pairs(additionalProcessedProperties[refProperty]) do
end
table.insert(candidateParams[citeType][paramName], propertyValue)
end
until true
end
end
-- fill citeParams
for _, citeType in ipairs(citeTypes) do
for paramName, paramValues in pairs(candidateParams[citeType]) do
if #paramValues == 1 or not isValueInTable(paramName, citeConfig[citeType]["numbered-params"] or {}) then
citeParams[citeType][paramName] = paramValues[1]
else
-- There is more than one value for this parameter - the values will
-- go into separate numbered parameters (e.g. "author1", "author2")
for paramNum, paramValue in pairs(paramValues) do
citeParams[citeType][paramName .. paramNum] = paramValue
end
end
end
value = table.concat(citeParams, "; ")
end
if value ~= "" then
-- handle missing mandatory parameters for the templates
value = value .. "."
for _, citeType in ipairs(citeTypes) do
for _, requiredCiteParam in pairs(citeConfig[citeType]["mandatory-params"] or {}) do
if not citeParams[citeType][requiredCiteParam] then -- The required param is not present.
if citeErrors[citeType] then -- Do not override the previous error, if it exists.
break
end
local error_message = errorText("missing-mandatory-param", requiredCiteParam)
assert(error_message) -- Should not be nil
citeErrors[citeType] = error_message
end
end
end
local citeTypeToUse = nil
 
-- choose the output template
for _, citeType in ipairs(citeTypes) do
if not citeErrors[citeType] then
citeTypeToUse = citeType
break
end
end
 
-- set refContent
local refContent = ""
if citeTypeToUse then
local templateToUse = citeConfig[citeTypeToUse]["template"]
local paramsToUse = citeParams[citeTypeToUse]
if valuenot templateToUse or templateToUse ~== "" then
throwError("no-such-reference-template", tostring(templateToUse), i18nPath, citeTypeToUse)
value = {value} -- create one value object
end
if not self.rawValue then
-- if this module is being substituted then build a regular template call, otherwise expand the template
-- this should become a <ref> tag, so safe the reference's hash for later
if mw.isSubsting() then
value.refHash = statement.hash
for i, v in pairs(paramsToUse) do
refContent = refContent .. "|" .. i .. "=" .. v
end
 
refContent = "{{" .. templateToUse .. refContent .. "}}"
ref = {value} -- wrap the value object in an array
else
xpcall(
function () refContent = mw.getCurrentFrame():expandTemplate{title=templateToUse, args=paramsToUse} end,
function () throwError("no-such-reference-template", templateToUse, i18nPath, citeTypeToUse) end
)
end
 
-- If the citation couldn't be displayed using any template, but is not empty (barring ignored propeties), throw an error.
elseif not referenceEmpty then
refContent = errorText("malformed-reference-header")
for _, citeType in ipairs(citeTypes) do
refContent = refContent .. errorText("template-failure-reason", citeConfig[citeType]["template"], citeErrors[citeType])
end
refContent = refContent .. errorText("malformed-reference-footer")
end
 
-- wrap refContent
local ref = {}
if refContent ~= "" then
ref = {refContent}
 
if not self.rawValue then
-- this should become a <ref> tag, so save the reference's hash for later
ref.refHash = "wikidata-" .. statement.hash .. "-v" .. (tonumber(i18n['version']) + version)
end
return {ref}
else
return {}
end
return ref
end
 
-- gets a detail of one particular type for a reference
function State:getReferenceDetail(snaks, dType, raw, link, anyLang, noUnset)
raw = raw or false
link = link or false
anyLang = anyLang or false
noUnset = noUnset or false
local switchLang = anyLang
local value = nil
 
if not snaks[dType] then
return nil
end
 
-- if anyLang, first try the local language and otherwise any language
repeat
for i_, v in ipairs(snaks[dType]) do
value = self.conf:getValue(v, raw, link, false, anyLang and not switchLang, false, true) -- noSpecial = true
 
if value then
break
end
end
 
if value or not anyLang then
break
end
 
switchLang = not switchLang
until anyLang and switchLang
 
if not noUnset then
-- remove detail(s) to make it possible to get the rest of the details in one loop
snaks[dType] = nil
end
return value
end
 
-- gets the details of one particular type for a reference
function State:getReferenceDetails(snaks, dType, raw, link, anyLang, noUnset)
raw = raw or false
link = link or false
anyLang = anyLang or false
noUnset = noUnset or false
local values = {}
 
if not snaks[dType] then
return {}
end
 
for i_, v in ipairs(snaks[dType]) do
-- if nil is returned then it will not be added to the table
values[#values + 1] = self.conf:getValue(v, raw, link, false, anyLang, false, true) -- noSpecial = true
end
 
if not noUnset then
-- remove detail(s) to make it possible to get the rest of the details in one loop
snaks[dType] = nil
end
return values
end
Line 1,952 ⟶ 2,161:
local value = object.value
local title = nil
 
if value and self.linked then
if self.conf.entityID:sub(1,1) == "Q" then
title = mw.wikibase.sitelinkgetSitelink(self.conf.entityID)
elseif self.conf.entityID:sub(1,1) == "P" then
title = "d:Property:" .. self.conf.entityID
end
 
if title then
value = buildWikilink(title, value)
end
end
 
value = {value} -- create one value object
 
if #value > 0 then
return {value} -- wrap the value object in an array and return it
else
return {} -- return empty array if there was no value
end
end
 
-- level 1 hook
function State:getBadge(value)
value = self.conf:getLabel(value, self.rawValue, self.linked, self.shortName)
 
if value == "" then
value = nil
end
 
value = {value} -- create one value object
 
if #value > 0 then
return {value} -- wrap the value object in an array and return it
Line 1,975 ⟶ 2,201:
 
function State:callHook(param, hooks, statement, result)
local valuesArray, refHash
-- call a parameter's hook if it has been defined and if it has not been called before
if not result[param] and hooks[param] then
local valuesArray = self[hooks[param]](self, statement, param, result, hooks) -- array with value objects
 
-- add to the result
if #valuesArray > 0 then
Line 1,990 ⟶ 2,214:
end
end
 
return false
end
Line 1,997 ⟶ 2,221:
function State:iterate(statements, hooks, matchHook)
matchHook = matchHook or alwaysTrue
 
local matches = false
local rankPos = nil
local result, gotRequired
 
for i_, v in ipairs(statements) do
-- rankPos will be nil for non-claim statements (e.g. qualifiers, references, etc.)
matches, rankPos = matchHook(self, v)
 
if matches then
result = {count = 0} -- collection of arrays with value objects
 
local function walk(formatTable)
local miss
 
for i2, v2 in pairs(formatTable.req) do
-- call a hook, adding its return value to the result
miss = self:callHook(i2, hooks, v, result)
 
if miss then
-- we miss a required value for this level, so return false
return false
end
 
if result.count == hooks.count then
-- we're done if all hooks have been called;
Line 2,027 ⟶ 2,251:
end
end
 
for i2_, v2 in ipairs(formatTable) do
if result.count == hooks.count then
-- we're done if all hooks have been called;
Line 2,034 ⟶ 2,258:
return true
end
 
if v2.child then
walk(v2.child)
end
end
 
return true
end
gotRequired = walk(self.parsedFormat)
 
-- only append the result if we got values for all required parameters on the root level
if gotRequired then
Line 2,050 ⟶ 2,274:
self.conf.foundRank = rankPos
end
 
-- append the result
self.results[#self.results + 1] = result
 
-- break if we only need a single value
if self.singleValue then
Line 2,061 ⟶ 2,285:
end
end
 
return self:out()
end
 
local function getEntityId(arg, eid, page, allowOmitPropPrefix, globalSiteId)
function p.property(frame)
local id = nil
loadSubmodules(frame)
local prop = nil
return p._property(copyTable(frame.args))
end
 
if arg then
function p._property(args)
if arg:sub(1,1) == ":" then
loadSubmodules()
page = arg
return valueCommand(args, p.commands.property)
eid = nil
end
elseif arg:sub(1,1):upper() == "Q" or arg:sub(1,9):lower() == "property:" or allowOmitPropPrefix then
eid = arg
page = nil
else
prop = arg
end
end
 
if eid then
function p.properties(frame)
if eid:sub(1,9):lower() == "property:" then
loadSubmodules(frame)
id = replaceAlias(mw.text.trim(eid:sub(10)))
return p._properties(copyTable(frame.args))
end
 
if id:sub(1,1):upper() ~= "P" then
function p._properties(args)
id = ""
loadSubmodules()
end
return valueCommand(args, p.commands.properties)
else
end
id = replaceAlias(eid)
end
elseif page then
if page:sub(1,1) == ":" then
page = mw.text.trim(page:sub(2))
end
 
id = mw.wikibase.getEntityIdForTitle(page, globalSiteId) or ""
function p.qualifier(frame)
end
loadSubmodules(frame)
return p._qualifier(copyTable(frame.args))
end
 
if not id then
function p._qualifier(args)
id = mw.wikibase.getEntityIdForCurrentPage() or ""
loadSubmodules()
end
return valueCommand(args, p.commands.qualifier)
end
 
id = id:upper()
function p.qualifiers(frame)
loadSubmodules(frame)
return p._qualifiers(copyTable(frame.args))
end
 
if not mw.wikibase.isValidEntityId(id) then
function p._qualifiers(args)
id = ""
loadSubmodules()
end
return valueCommand(args, p.commands.qualifiers)
end
 
return id, prop
function p.reference(frame)
loadSubmodules(frame)
return p._reference(copyTable(frame.args))
end
 
local function p._referencenextArg(args)
local arg = args[args.pointer]
loadSubmodules()
return valueCommand(args, p.commands.reference)
end
 
if arg then
function p.references(frame)
args.pointer = args.pointer + 1
loadSubmodules(frame)
return pmw._referencestext.trim(copyTable(frame.args)arg)
else
return nil
end
end
 
local function p._referencesclaimCommand(args, funcName)
local cfg = Config:new()
loadSubmodules()
cfg:processFlagOrCommand(funcName) -- process first command (== function name)
return valueCommand(args, p.commands.references)
end
 
local lastArg, parsedFormat, formatParams, claims, value
function valueCommand(args, funcName)
local _ = Config.new()
_:processFlagOrCommand(funcName) -- process first command (== function name)
local parsedFormat, formatParams, claims, sep, value
local hooks = {count = 0}
 
-- set the date if given;
local nextArg = args[1]
-- must come BEFORE processing the flags
local nextIndex = 2
if args[p.args.date] then
cfg.atDate = {parseDate(args[p.args.date])}
cfg.periods = {false, true, false} -- change default time constraint to 'current'
end
 
-- process flags and commands
repeat
while _:processFlagOrCommand(nextArg) do
nextArglastArg = nextArg(args[nextIndex])
until not cfg:processFlagOrCommand(lastArg)
nextIndex = nextIndex + 1
 
-- get the entity ID from either the positional argument, the eid argument or the page argument
cfg.entityID, cfg.propertyID = getEntityId(lastArg, args[p.args.eid], args[p.args.page], false, args[p.args.globalSiteId])
 
if cfg.entityID == "" then
return "" -- we cannot continue without a valid entity ID
end
 
cfg.entity = mw.wikibase.getEntity(cfg.entityID)
if nextArg then
 
nextArg = mw.text.trim(nextArg)
if not cfg.propertyID then
else
cfg.propertyID = nextArg(args)
nextArg = ""
end
 
cfg.propertyID = replaceAlias(cfg.propertyID)
-- check for optional entity ID of either item or property
 
if nextArg:sub(1,1):upper() == "Q" then
if not cfg.entity or not cfg.propertyID then
_.entityID = nextArg:upper() -- entity ID of an item was given
return "" -- we cannot continue without an entity or a property ID
_.entity = mw.wikibase.getEntity(_.entityID) -- get the item-entity based on the given ID
_.propertyID = mw.text.trim(args[nextIndex] or "") -- property ID
nextIndex = nextIndex + 1
elseif nextArg:sub(1,9):lower() == "property:" then
_.entityID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper() -- entity ID of a property was given
_.entity = mw.wikibase.getEntity(_.entityID) -- get the property-entity based on the given ID
_.propertyID = mw.text.trim(args[nextIndex] or "") -- property ID
nextIndex = nextIndex + 1
else
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
if args[p.args.eid] then
if args[p.args.eid]:sub(1,1):upper() == "Q" then
_.entityID = args[p.args.eid]:upper()
elseif args[p.args.eid]:sub(1,9):lower() == "property:" then
_.entityID = replaceAlias(mw.text.trim(args[p.args.eid]:sub(10))):upper()
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
_.entityID = replaceAlias(args[p.args.eid]):upper()
if _.entityID == "" then
-- explicitly return if value for 'eid' is empty
return ""
end
end
else
_.entityID = mw.wikibase.getEntityIdForCurrentPage() -- by default, use item-entity connected to current page
end
_.entity = mw.wikibase.getEntity(_.entityID)
_.propertyID = nextArg -- property ID
end
 
cfg.propertyID = cfg.propertyID:upper()
-- check if given property ID is an alias
 
_.propertyID = replaceAlias(_.propertyID):upper()
if not cfg.entity.claims or not cfg.entity.claims[cfg.propertyID] then
return "" -- there is no use to continue without any claims
if _.states.qualifiersCount > 0 then
end
 
claims = cfg.entity.claims[cfg.propertyID]
 
if cfg.states.qualifiersCount > 0 then
-- do further processing if "qualifier(s)" command was given
 
if #args - nextIndexargs.pointer + 1 > _cfg.states.qualifiersCount then
-- claim ID or literal value has been given
 
_cfg.propertyValue = mw.text.trimnextArg(args[nextIndex])
nextIndex = nextIndex + 1
end
 
for i = 1, _cfg.states.qualifiersCount do
nextArg = mw.text.trim(args[nextIndex] or "") -- is a qualifierID
nextIndex = nextIndex + 1
-- check if given qualifier ID is an alias and add it
_cfg.qualifierIDs[parameters.qualifier..i] = replaceAlias(nextArg(args) or ""):upper()
end
elseif _cfg.states[parameters.reference] then
-- do further processing if "reference(s)" command was given
 
cfg.propertyValue = nextArg(args)
nextArg = args[nextIndex] -- claim ID or literal value (possibly nil)
nextIndex = nextIndex + 1
if nextArg then
_.propertyValue = mw.text.trim(nextArg)
end
end
 
-- check for special property value 'somevalue' or 'novalue'
if _cfg.propertyValue then
_cfg.propertyValue = replaceSpecialChars(_cfg.propertyValue)
 
if _cfg.propertyValue ~= "" and mw.text.trim(_cfg.propertyValue) == "" then
_cfg.propertyValue = " " -- single space represents 'somevalue', whereas empty string represents 'novalue'
else
_cfg.propertyValue = mw.text.trim(_cfg.propertyValue)
end
end
 
-- parse the desired format, or choose an appropriate format
if args["format"] then
parsedFormat, formatParams = parseFormat(args["format"])
elseif _cfg.states.qualifiersCount > 0 then -- "qualifier(s)" command given
if _cfg.states[parameters.property] then -- "propert(y|ies)" command given
parsedFormat, formatParams = parseFormat(formats.propertyWithQualifier)
else
parsedFormat, formatParams = parseFormat(formats.qualifier)
end
elseif _cfg.states[parameters.property] then -- "propert(y|ies)" command given
parsedFormat, formatParams = parseFormat(formats.property)
else -- "reference(s)" command given
parsedFormat, formatParams = parseFormat(formats.reference)
end
 
-- if a "qualifier(s)" command and no "propert(y|ies)" command has been given, make the movable separator a semicolon
if _cfg.states.qualifiersCount > 0 and not _cfg.states[parameters.property] then
_cfg.separators["sep"..parameters.separator][1] = {";"}
end
 
-- if only "reference(s)" has been given, set the default separator to none (except when raw)
if _cfg.states[parameters.reference] and not _cfg.states[parameters.property] and _cfg.states.qualifiersCount == 0
and not _cfg.states[parameters.reference].rawValue then
_cfg.separators["sep"][1] = nil
end
 
-- if exactly one "qualifier(s)" command has been given, make "sep%q" point to "sep%q1" to make them equivalent;
if cfg.states.qualifiersCount == 1 then
-- must come BEFORE overriding the separator values
cfg.separators["sep"..parameters.qualifier] = cfg.separators["sep"..parameters.qualifier.."1"]
if _.states.qualifiersCount == 1 then
_.separators["sep"..parameters.qualifier] = _.separators["sep"..parameters.qualifier.."1"]
end
 
-- process overridden separator values;
-- must come AFTER parsingtweaking the formatdefault separators
cfg:processSeparators(args)
for i, v in pairs(_.separators) do
 
if args[i] then
sep = replaceSpecialChars(args[i])
if sep ~= "" then
_.separators[i][1] = {sep}
else
_.separators[i][1] = nil
end
end
end
-- define the hooks that should be called (getProperty, getQualifiers, getReferences);
-- only define a hook if both its command ("propert(y|ies)", "reference(s)", "qualifier(s)") and its parameter ("%p", "%r", "%q1", "%q2", "%q3") have been given
for i, v in pairs(_cfg.states) do
-- e.g. 'formatParams["%q1"] or formatParams["%q"]' to define hook even if "%q1" was not defined to be able to build a complete value for "%q"
if formatParams[i] or formatParams[i:sub(1, 2)] then
Line 2,279 ⟶ 2,467:
end
end
 
-- the "%q" parameter is not attached to a state, but is a collection of the results of multiple states (attached to "%q1", "%q2", "%q3", ...);
-- so if this parameter is given then this hook must be defined separately, but only if at least one "qualifier(s)" command has been given
if formatParams[parameters.qualifier] and _cfg.states.qualifiersCount > 0 then
hooks[parameters.qualifier] = getHookName(parameters.qualifier, 1)
hooks.count = hooks.count + 1
end
 
-- create a state for "properties" if it doesn't exist yet, which will be used as a base configuration for each claim iteration;
-- must come AFTER defining the hooks
if not _cfg.states[parameters.property] then
_cfg.states[parameters.property] = State.:new(_cfg, parameters.property)
 
-- if the "single" flag has been given then this state should be equivalent to "property" (singular)
if _cfg.singleClaim then
_cfg.states[parameters.property].singleValue = true
end
end
 
-- if the "sourced" flag has been given then create a state for "reference" if it doesn't exist yet, using default values,
-- which must exist in order to be able to determine if a claim has any references;
-- must come AFTER defining the hooks
if _cfg.sourcedOnly and not _cfg.states[parameters.reference] then
_cfg:processFlagOrCommand(p.commandsclaimCommands.reference) -- use singular "reference" to minimize overhead
end
 
-- set the parsed format and the separators (and optional punctuation mark);
-- must come AFTER creating the additonal states
_.states[parameters.property].parsedFormat = parsedFormat
_cfg:setFormatAndSeparators(cfg.states[parameters.property].separator, = _.separators["sep"]parsedFormat)
 
_.states[parameters.property].movSeparator = _.separators["sep"..parameters.separator]
-- process qualifier matching values, analogous to cfg.propertyValue
_.states[parameters.property].puncMark = _.separators["punc"]
-- process qualifier matching values, analogous to _.propertyValue
for i, v in pairs(args) do
i = tostring(i)
 
if i:match('^[Pp]%d+$') or p.aliasesP[i] then
v = replaceSpecialChars(v)
 
-- check for special qualifier value 'somevalue'
if v ~= "" and mw.text.trim(v) == "" then
v = " " -- single space represents 'somevalue'
end
 
_cfg.qualifierIDsAndValues[replaceAlias(i):upper()] = v
end
end
if _.entity and _.entity.claims then claims = _.entity.claims[_.propertyID] end
if claims then
-- first sort the claims on rank to pre-define the order of output (preferred first, then normal, then deprecated)
claims = sortOnRank(claims)
-- then iterate through the claims to collect values
value = _:concatValues(_.states[parameters.property]:iterate(claims, hooks, State.claimMatches)) -- pass property state with level 1 hooks and matchHook
-- if desired, add a clickable icon that may be used to edit the returned values on Wikidata
if _.editable and value ~= "" then
value = value .. _:getEditIcon()
end
return value
else
return ""
end
end
 
-- first sort the claims on rank to pre-define the order of output (preferred first, then normal, then deprecated)
function p.label(frame)
claims = sortOnRank(claims)
loadSubmodules(frame)
return p._label(copyTable(frame.args))
end
 
-- then iterate through the claims to collect values
function p._label(args)
value = cfg:concatValues(cfg.states[parameters.property]:iterate(claims, hooks, State.claimMatches)) -- pass property state with level 1 hooks and matchHook
loadSubmodules()
return nameCommand(args, p.commands.label)
end
 
-- if desired, add a clickable icon that may be used to edit the returned values on Wikidata
function p.title(frame)
if cfg.editable and value ~= "" then
loadSubmodules(frame)
value = value .. cfg:getEditIcon()
return p._title(copyTable(frame.args))
end
 
return value
function p._title(args)
loadSubmodules()
return nameCommand(args, p.commands.title)
end
 
local function p.aliasgeneralCommand(frameargs, funcName)
local cfg = Config:new()
loadSubmodules(frame)
cfg.curState = State:new(cfg)
return p._alias(copyTable(frame.args))
end
 
local lastArg
function p._alias(args)
local value = nil
loadSubmodules()
return nameCommand(args, p.commands.alias)
end
 
repeat
function p.aliases(frame)
lastArg = nextArg(args)
loadSubmodules(frame)
until not cfg:processFlag(lastArg)
return p._aliases(copyTable(frame.args))
end
 
-- get the entity ID from either the positional argument, the eid argument or the page argument
function p._aliases(args)
cfg.entityID = getEntityId(lastArg, args[p.args.eid], args[p.args.page], true, args[p.args.globalSiteId])
loadSubmodules()
return nameCommand(args, p.commands.aliases)
end
 
if cfg.entityID == "" or not mw.wikibase.entityExists(cfg.entityID) then
function nameCommand(args, funcName)
return "" -- we cannot continue without an entity
local _ = Config.new()
_.curState = State.new(_)
local ID = nil
local value = nil
local nextArg = args[1]
local nextIndex = 2
while _:processFlag(nextArg) do
nextArg = args[nextIndex]
nextIndex = nextIndex + 1
end
 
if nextArg then
nextArg = mw.text.trim(nextArg)
else
nextArg = ""
end
-- check for optional entity ID of either item or property
if nextArg:sub(1,1):upper() == "Q" then
ID = nextArg:upper() -- entity ID of an item was given
elseif nextArg:sub(1,9):lower() == "property:" then
ID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper() -- entity ID of a property was given
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
ID = replaceAlias(nextArg):upper()
if ID:sub(1,1) ~= "P" then
if ID == "" then
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
if args[p.args.eid] then
if args[p.args.eid]:sub(1,1):upper() == "Q" then
ID = args[p.args.eid]:upper()
elseif args[p.args.eid]:sub(1,9):lower() == "property:" then
ID = replaceAlias(mw.text.trim(args[p.args.eid]:sub(10))):upper()
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
ID = replaceAlias(args[p.args.eid]):upper()
if ID == "" then
-- explicitly return if value for 'eid' is empty
return ""
end
end
else
ID = nil
end
end
end
end
if ID then
_.entityID = ID
else
_.entityID = mw.wikibase.getEntityIdForCurrentPage()
end
-- serve according to the given command
if funcName == p.commandsgeneralCommands.label then
value = _cfg:getLabel(IDcfg.entityID, _cfg.curState.rawValue, _cfg.curState.linked, _cfg.curState.shortName)
elseif funcName == p.commandsgeneralCommands.title then
_cfg.pageTitleinSitelinks = true
 
if notcfg.entityID:sub(1,1) ID== "Q" then
value = mw.titlewikibase.getCurrentTitlegetSitelink()cfg.prefixedTextentityID)
elseif ID:sub(1,1) == "Q" then
value = mw.wikibase.sitelink(ID)
end
 
if _cfg.curState.linked and value then
value = buildWikilink(value)
end
elseif funcName == p.commandsgeneralCommands.alias or funcName == p.commands.aliasesdescription then
value = mw.wikibase.getDescription(cfg.entityID)
local aliases, parsedFormat, formatParams, sep
else
local parsedFormat, formatParams
local hooks = {count = 0}
 
cfg.entity = mw.wikibase.getEntity(cfg.entityID)
if funcName == p.commands.alias then
 
_.curState.singleValue = true
if funcName == p.generalCommands.alias or funcName == p.generalCommands.badge then
cfg.curState.singleValue = true
end
 
if funcName == p.generalCommands.alias or funcName == p.generalCommands.aliases then
-- parse the desired format, or parse the default aliases format
if not cfg.entity.aliases or not cfg.entity.aliases[cfg.langCode] then
if args["format"] then
return "" -- there is no use to continue without any aliasses
parsedFormat, formatParams = parseFormat(args["format"])
else end
 
parsedFormat, formatParams = parseFormat(formats.alias)
local aliases = cfg.entity.aliases[cfg.langCode]
end
 
-- parse the desired format, or parse the default aliases format
-- process overridden separator values;
if args["format"] then
-- must come AFTER parsing the format
parsedFormat, formatParams = parseFormat(args["format"])
for i, v in pairs(_.separators) do
else
if args[i] then
parsedFormat, formatParams = parseFormat(formats.alias)
sep = replaceSpecialChars(args[i])
end
 
if sep ~= "" then
-- process overridden separator values;
_.separators[i][1] = {sep}
-- must come AFTER tweaking the default separators
else
cfg:processSeparators(args)
_.separators[i][1] = nil
 
end
-- define the hook that should be called (getAlias);
-- only define the hook if the parameter ("%a") has been given
if formatParams[parameters.alias] then
hooks[parameters.alias] = getHookName(parameters.alias, 1)
hooks.count = hooks.count + 1
end
 
end
-- set the parsed format and the separators (and optional punctuation mark)
cfg:setFormatAndSeparators(cfg.curState, parsedFormat)
-- define the hook that should be called (getAlias);
 
-- only define the hook if the parameter ("%a") has been given
-- iterate to collect values
if formatParams[parameters.alias] then
value = cfg:concatValues(cfg.curState:iterate(aliases, hooks))
hooks[parameters.alias] = getHookName(parameters.alias, 1)
elseif funcName == p.generalCommands.badge or funcName == p.generalCommands.badges then
hooks.count = hooks.count + 1
if not cfg.entity.sitelinks or not cfg.entity.sitelinks[cfg.siteID] or not cfg.entity.sitelinks[cfg.siteID].badges then
end
return "" -- there is no use to continue without any badges
end
-- set the parsed format and the separators (and optional punctuation mark)
 
_.curState.parsedFormat = parsedFormat
local badges = cfg.entity.sitelinks[cfg.siteID].badges
_.curState.separator = _.separators["sep"]
 
_.curState.movSeparator = _.separators["sep"..parameters.separator]
cfg.inSitelinks = true
_.curState.puncMark = _.separators["punc"]
 
-- parse the desired format, or parse the default aliases format
_.entity = mw.wikibase.getEntity(ID)
if args["format"] then
parsedFormat, formatParams = parseFormat(args["format"])
if _.entity and _.entity.aliases then aliases = _.entity.aliases[_.langCode] end
else
if aliases then
parsedFormat, formatParams = parseFormat(formats.badge)
value = _:concatValues(_.curState:iterate(aliases, hooks))
end
 
-- process overridden separator values;
-- must come AFTER tweaking the default separators
cfg:processSeparators(args)
 
-- define the hook that should be called (getBadge);
-- only define the hook if the parameter ("%b") has been given
if formatParams[parameters.badge] then
hooks[parameters.badge] = getHookName(parameters.badge, 1)
hooks.count = hooks.count + 1
end
 
-- set the parsed format and the separators (and optional punctuation mark)
cfg:setFormatAndSeparators(cfg.curState, parsedFormat)
 
-- iterate to collect values
value = cfg:concatValues(cfg.curState:iterate(badges, hooks))
end
end
 
value = value or ""
 
if _cfg.editable and value ~= "" then
-- if desired, add a clickable icon that may be used to edit the returned value on Wikidata
value = value .. _cfg:getEditIcon()
end
 
return value
end
 
-- modules that include this module should call the functions with an underscore prepended, e.g.: p._property(args)
local function establishCommands(commandList, commandFunc)
for _, commandName in pairs(commandList) do
local function wikitextWrapper(frame)
local args = copyTable(frame.args)
args.pointer = 1
loadI18n(aliasesP, frame)
return commandFunc(args, commandName)
end
p[commandName] = wikitextWrapper
 
local function luaWrapper(args)
args = copyTable(args)
args.pointer = 1
loadI18n(aliasesP)
return commandFunc(args, commandName)
end
p["_" .. commandName] = luaWrapper
end
end
 
establishCommands(p.claimCommands, claimCommand)
establishCommands(p.generalCommands, generalCommand)
 
-- main function that is supposed to be used by wrapper templates
function p.main(frame)
if not mw.wikibase then return nil end
local f, args, i, v
 
local f, args
loadSubmodules(frame)
 
loadI18n(aliasesP, frame)
 
-- get the parent frame to take the arguments that were passed to the wrapper template
frame = frame:getParent() or frame
 
if not frame.args[1] then
errorthrowError(i18n["errors"]["no-function-specified"])
end
 
f = mw.text.trim(frame.args[1])
 
if f == "main" then
errorthrowError(i18n["errors"]["main-called-twice"])
end
 
assert(p["_"..f], applyStringParamserrorText(i18n['errors']['no-such-function'], f))
 
-- copy arguments from immutable to mutable table
args = copyTable(frame.args)
 
-- remove the function name from the list
table.remove(args, 1)
 
return p["_"..f](args)
end