「モジュール:Wd」の版間の差分

48版 をインポートしました
template>K-iczn
(en:Module:Wd 2017年9月5日 (火) 20:13(UTC)より)
(48版 をインポートしました)
 
(7人の利用者による、間の21版が非表示)
5行目: 5行目:
local i18n
local i18n


function loadSubmodules(frame)
local function loadI18n(aliasesP, frame)
-- internationalization
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 = arg
end
 
if not i18n then
if not i18n then
if frame then
i18n = require(title .. "/i18n").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
end
end


local aliasesP = {
p.claimCommands = {
coord          = "P625",
property  = "property",
---------------
properties = "properties",
author          = "P50",
qualifier  = "qualifier",
publisher      = "P123",
qualifiers = "qualifiers",
importedFrom    = "P143",
reference  = "reference",
statedIn        = "P248",
references = "references"
pages          = "P304",
publicationDate = "P577",
startTime      = "P580",
endTime        = "P582",
chapter        = "P792",
retrieved      = "P813",
referenceURL    = "P854",
archiveURL      = "P1065",
title          = "P1476",
quote          = "P1683",
shortName      = "P1813",
language        = "P2439",
archiveDate    = "P2960"
}
}


local aliasesQ = {
p.generalCommands = {
percentage              = "Q11229",
label      = "label",
prolepticJulianCalendar = "Q1985786"
title      = "title",
description = "description",
alias      = "alias",
aliases    = "aliases",
badge      = "badge",
badges      = "badges"
}
}


local flags = {
p.flags = {
linked        = "linked",
linked        = "linked",
short        = "short",
raw          = "raw",
raw          = "raw",
short        = "short",
multilanguage = "multilanguage",
multilanguage = "multilanguage",
unit          = "unit",
unit          = "unit",
mdy          = "mdy",
-------------
single        = "single",
sourced      = "sourced",
edit          = "edit",
editAtEnd    = "edit@end",
best          = "best",
preferred    = "preferred",
preferred    = "preferred",
normal        = "normal",
normal        = "normal",
deprecated    = "deprecated",
deprecated    = "deprecated",
best          = "best",
future        = "future",
future        = "future",
current      = "current",
current      = "current",
former        = "former"
former        = "former",
edit          = "edit",
editAtEnd    = "edit@end",
mdy          = "mdy",
single        = "single",
sourced      = "sourced"
}
}


local parameters = {
p.args = {
property  = "%p",
eid  = "eid",
qualifier = "%q",
page = "page",
reference = "%r",
date = "date"
separator = "%s",
}
general  = "%x"
 
local aliasesP = {
coord                  = "P625",
-----------------------
image                  = "P18",
author                  = "P50",
publisher              = "P123",
importedFrom            = "P143",
statedIn                = "P248",
pages                  = "P304",
language                = "P407",
hasPart                = "P527",
publicationDate        = "P577",
startTime              = "P580",
endTime                = "P582",
chapter                = "P792",
retrieved              = "P813",
referenceURL            = "P854",
sectionVerseOrParagraph = "P958",
archiveURL              = "P1065",
title                  = "P1476",
formatterURL            = "P1630",
quote                  = "P1683",
shortName              = "P1813",
definingFormula        = "P2534",
archiveDate            = "P2960",
inferredFrom            = "P3452",
typeOfReference        = "P3865",
column                  = "P3903"
}
 
local aliasesQ = {
percentage              = "Q11229",
prolepticJulianCalendar = "Q1985786",
citeWeb                = "Q5637226",
citeQ                  = "Q22321052"
}
 
local parameters = {
property  = "%p",
qualifier = "%q",
reference = "%r",
alias    = "%a",
badge    = "%b",
separator = "%s",
general  = "%x"
}
}


77行目: 118行目:
qualifier            = "%q[%s][%r]",
qualifier            = "%q[%s][%r]",
reference            = "%r",
reference            = "%r",
propertyWithQualifier = "%p[ <span style=\"font-size:smaller\">(%q)</span>][%s][%r]"
propertyWithQualifier = "%p[ <span style=\"font-size:85\\%\">(%q)</span>][%s][%r]",
alias                = "%a[%s]",
badge                = "%b[%s]"
}
}


84行目: 127行目:
[parameters.reference]        = {"getReferences", "getReference"},
[parameters.reference]        = {"getReferences", "getReference"},
[parameters.qualifier]        = {"getAllQualifiers"},
[parameters.qualifier]        = {"getAllQualifiers"},
[parameters.qualifier.."\\d"] = {"getQualifiers", "getQualifier"}
[parameters.qualifier.."\\d"] = {"getQualifiers", "getQualifier"},
[parameters.alias]            = {"getAlias"},
[parameters.badge]            = {"getBadge"}
}
}


95行目: 140行目:
["sep%r"]    = nil,  -- none
["sep%r"]    = nil,  -- none
["punc"]    = nil  -- none
["punc"]    = nil  -- none
}
local rankTable = {
["preferred"]  = 1,
["normal"]    = 2,
["deprecated"] = 3
}
}


local Config = {}
local Config = {}
Config.__index = Config


-- allows for recursive calls
-- allows for recursive calls
function Config.new()
function Config:new()
local cfg = {}
local cfg = {}
setmetatable(cfg, Config)
setmetatable(cfg, self)
self.__index = self
 
cfg.separators = {
cfg.separators = {
-- single value objects wrapped in arrays so that we can pass by reference
-- single value objects wrapped in arrays so that we can pass by reference
113行目: 164行目:
["punc"]  = {copyTable(defaultSeparators["punc"])}
["punc"]  = {copyTable(defaultSeparators["punc"])}
}
}
 
cfg.entity = nil
cfg.entity = nil
cfg.entityID = nil
cfg.entityID = nil
120行目: 171行目:
cfg.qualifierIDs = {}
cfg.qualifierIDs = {}
cfg.qualifierIDsAndValues = {}
cfg.qualifierIDsAndValues = {}
 
cfg.bestRank = true
cfg.bestRank = true
cfg.ranks = {true, true, false}  -- preferred = true, normal = true, deprecated = false
cfg.ranks = {true, true, false}  -- preferred = true, normal = true, deprecated = false
126行目: 177行目:
cfg.flagBest = false
cfg.flagBest = false
cfg.flagRank = false
cfg.flagRank = false
 
cfg.periods = {true, true, true}  -- future = true, current = true, former = true
cfg.periods = {true, true, true}  -- future = true, current = true, former = true
cfg.flagPeriod = false
cfg.flagPeriod = false
cfg.atDate = {parseDate(os.date('!%Y-%m-%d'))}  -- today as {year, month, day}
 
cfg.mdyDate = false
cfg.mdyDate = false
cfg.singleClaim = false
cfg.singleClaim = false
135行目: 187行目:
cfg.editable = false
cfg.editable = false
cfg.editAtEnd = false
cfg.editAtEnd = false
 
cfg.pageTitle = false
cfg.inSitelinks = false
 
cfg.langCode = mw.language.getContentLanguage().code
cfg.langCode = mw.language.getContentLanguage().code
cfg.langName = mw.language.fetchLanguageName(cfg.langCode, cfg.langCode)
cfg.langName = mw.language.fetchLanguageName(cfg.langCode, cfg.langCode)
cfg.langObj = mw.language.new(cfg.langCode)
cfg.langObj = mw.language.new(cfg.langCode)
 
cfg.siteID = mw.wikibase.getGlobalSiteId()
 
cfg.states = {}
cfg.states = {}
cfg.states.qualifiersCount = 0
cfg.states.qualifiersCount = 0
cfg.curState = nil
cfg.curState = nil
 
cfg.prefetchedRefs = nil
cfg.prefetchedRefs = nil
 
return cfg
return cfg
end
end


local State = {}
local State = {}
State.__index = State


function State.new(cfg)
function State:new(cfg, type)
local stt = {}
local stt = {}
setmetatable(stt, State)
setmetatable(stt, self)
self.__index = self
 
stt.conf = cfg
stt.conf = cfg
stt.type = type
 
stt.results = {}
stt.results = {}
 
stt.parsedFormat = {}
stt.parsedFormat = {}
stt.separator = {}
stt.separator = {}
stt.movSeparator = {}
stt.movSeparator = {}
stt.puncMark = {}
stt.puncMark = {}
 
stt.linked = false
stt.linked = false
stt.rawValue = false
stt.rawValue = false
173行目: 228行目:
stt.unitOnly = false
stt.unitOnly = false
stt.singleValue = false
stt.singleValue = false
 
return stt
return stt
end
end


function replaceAlias(ID)
local function replaceAlias(id)
if aliasesP[ID] then
if aliasesP[id] then
ID = aliasesP[ID]
id = aliasesP[id]
end
end
 
return ID
return id
end
end


function applyStringParams(str, ...)
local function errorText(code, param)
for i, v in ipairs(arg) do
local text = i18n["errors"][code]
str = mw.ustring.gsub(str, "$"..i, v)
if param then text = mw.ustring.gsub(text, "$1", param) end
end
return text
return str
end
end


function unknownDataTypeError(dataType)
local function throwError(errorMessage, param)
return applyStringParams(i18n['errors']['unknown-data-type'], dataType)
error(errorText(errorMessage, param))
end
end


function missingRequiredParameterError()
local function replaceDecimalMark(num)
return i18n['errors']['missing-required-parameter']
return mw.ustring.gsub(num, "[.]", i18n['numeric']['decimal-mark'], 1)
end
end


function extraRequiredParameterError(param)
local function padZeros(num, numDigits)
return applyStringParams(i18n['errors']['extra-required-parameter'], param)
local numZeros
end
local negative = false
 
if num < 0 then
negative = true
num = num * -1
end
 
num = tostring(num)
numZeros = numDigits - num:len()


function getOrdinalSuffix(num)
for _ = 1, numZeros do
return i18n.getOrdinalSuffix(num)
num = "0"..num
end
end


function addDelimiters(num)
if negative then
return i18n.addDelimiters(num)
num = "-"..num
end
end


function replaceDecimalMark(num)
return num
return mw.ustring.gsub(num, "[.]", i18n['numeric']['decimal-mark'], 1)
end
end


function replaceSpecialChar(chr)
local function replaceSpecialChar(chr)
if chr == '_' then
if chr == '_' then
-- replace underscores with spaces
-- replace underscores with spaces
226行目: 286行目:
end
end


function replaceSpecialChars(str)
local function replaceSpecialChars(str)
local chr
local chr
local esc = false
local esc = false
local strOut = ""
local strOut = ""
 
for i = 1, #str do
for i = 1, #str do
chr = str:sub(i,i)
chr = str:sub(i,i)
 
if not esc then
if not esc then
if chr == '\\' then
if chr == '\\' then
245行目: 305行目:
end
end
end
end
 
return strOut
return strOut
end
end


function buildWikilink(target, label)
local function buildWikilink(target, label)
if target == label then
if not label or target == label then
return "[[" .. target .. "]]"
return "[[" .. target .. "]]"
else
else
263行目: 323行目:
return nil
return nil
end
end
 
local tOut = {}
local tOut = {}
 
for i, v in pairs(tIn) do
for i, v in pairs(tIn) do
tOut[i] = v
tOut[i] = v
end
end
 
return tOut
return tOut
end
end
275行目: 335行目:
-- used to merge output arrays together;
-- used to merge output arrays together;
-- note that it currently mutates the first input array
-- note that it currently mutates the first input array
function mergeArrays(a1, a2)
local function mergeArrays(a1, a2)
for i = 1, #a2 do
for i = 1, #a2 do
a1[#a1 + 1] = a2[i]
a1[#a1 + 1] = a2[i]
end
end
 
return a1
return a1
end
end


function parseWikidataURL(url)
local function split(str, del)
local i, j
local out = {}
local i, j = str:find(del)
if url:match('^http[s]?://') then
 
i, j = url:find("Q")
if i and j then
out[1] = str:sub(1, i - 1)
if i then
out[2] = str:sub(j + 1)
return url:sub(i)
else
end
out[1] = str
end
end
 
return out
end
 
local function parseWikidataURL(url)
local id
 
if url:match('^http[s]?://') then
id = split(url, "Q")
 
if id[2] then
return "Q" .. id[2]
end
end
 
return nil
return nil
end
end
299行目: 373行目:
function parseDate(dateStr, precision)
function parseDate(dateStr, precision)
precision = precision or "d"
precision = precision or "d"
 
local i, j, index, ptr
local i, j, index, ptr
local parts = {nil, nil, nil}
local parts = {nil, nil, nil}
 
if dateStr == nil then
if dateStr == nil then
return parts[1], parts[2], parts[3]  -- year, month, day
return parts[1], parts[2], parts[3]  -- year, month, day
end
end
 
-- 'T' for snak values, '/' for outputs with '/Julian' attached
-- 'T' for snak values, '/' for outputs with '/Julian' attached
i, j = dateStr:find("[T/]")
i, j = dateStr:find("[T/]")
 
if i then
if i then
dateStr = dateStr:sub(1, i-1)
dateStr = dateStr:sub(1, i-1)
end
end
 
local from = 1
local from = 1
 
if dateStr:sub(1,1) == "-" then
if dateStr:sub(1,1) == "-" then
-- this is a negative number, look further ahead
-- this is a negative number, look further ahead
from = 2
from = 2
end
end
 
index = 1
index = 1
ptr = 1
ptr = 1
 
i, j = dateStr:find("-", from)
i, j = dateStr:find("-", from)
 
if i then
if i then
-- year
-- year
parts[index] = tonumber(mw.ustring.gsub(dateStr:sub(ptr, i-1), "^\+(.+)$", "%1"), 10)  -- remove '+' sign (explicitly give base 10 to prevent error)
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
if parts[index] == -0 then
parts[index] = tonumber("0")  -- for some reason, 'parts[index] = 0' may actually store '-0', so parse from string instead
parts[index] = tonumber("0")  -- for some reason, 'parts[index] = 0' may actually store '-0', so parse from string instead
end
end
 
if precision == "y" then
if precision == "y" then
-- we're done
-- we're done
return parts[1], parts[2], parts[3]  -- year, month, day
return parts[1], parts[2], parts[3]  -- year, month, day
end
end
 
index = index + 1
index = index + 1
ptr = i + 1
ptr = i + 1
 
i, j = dateStr:find("-", ptr)
i, j = dateStr:find("-", ptr)
 
if i then
if i then
-- month
-- month
parts[index] = tonumber(dateStr:sub(ptr, i-1), 10)
parts[index] = tonumber(dateStr:sub(ptr, i-1), 10)
 
if precision == "m" then
if precision == "m" then
-- we're done
-- we're done
return parts[1], parts[2], parts[3]  -- year, month, day
return parts[1], parts[2], parts[3]  -- year, month, day
end
end
 
index = index + 1
index = index + 1
ptr = i + 1
ptr = i + 1
end
end
end
end
 
if dateStr:sub(ptr) ~= "" then
if dateStr:sub(ptr) ~= "" then
-- day if we have month, month if we have year, or year
-- day if we have month, month if we have year, or year
parts[index] = tonumber(dateStr:sub(ptr), 10)
parts[index] = tonumber(dateStr:sub(ptr), 10)
end
end
 
return parts[1], parts[2], parts[3]  -- year, month, day
return parts[1], parts[2], parts[3]  -- year, month, day
end
end


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


function getHookName(param, index)
local function getHookName(param, index)
if hookNames[param] then
if hookNames[param] then
return hookNames[param][index]
return hookNames[param][index]
408行目: 482行目:
end
end


function alwaysTrue()
local function alwaysTrue()
return true
return true
end
end
457行目: 531行目:
-- ]
-- ]
--
--
function parseFormat(str)
local function parseFormat(str)
local chr, esc, param, root, cur, prev, new
local chr, esc, param, root, cur, prev, new
local params = {}
local params = {}
 
local function newObject(array)
local function newObject(array)
local obj = {}  -- new object
local obj = {}  -- new object
obj.str = ""
obj.str = ""
 
array[#array + 1] = obj  -- array{object}
array[#array + 1] = obj  -- array{object}
obj.parent = array
obj.parent = array
 
return obj
return obj
end
end
 
local function endParam()
local function endParam()
if param > 0 then
if param > 0 then
484行目: 558行目:
end
end
end
end
 
root = {}  -- array
root = {}  -- array
root.req = {}
root.req = {}
cur = newObject(root)
cur = newObject(root)
prev = nil
prev = nil
 
esc = false
esc = false
param = 0
param = 0
 
for i = 1, #str do
for i = 1, #str do
chr = str:sub(i,i)
chr = str:sub(i,i)
 
if not esc then
if not esc then
if chr == '\\' then
if chr == '\\' then
533行目: 607行目:
end
end
end
end
 
cur.str = cur.str .. replaceSpecialChar(chr)
cur.str = cur.str .. replaceSpecialChar(chr)
end
end
540行目: 614行目:
esc = false
esc = false
end
end
 
prev = nil
prev = nil
end
end
 
endParam()
endParam()
return root, params
end


function convertRank(rank)
-- make sure that at least one required parameter has been defined
if rank == "preferred" then
if not next(root.req) then
return 1
throwError("missing-required-parameter")
elseif rank == "normal" then
end
return 2
 
elseif rank == "deprecated" then
-- make sure that the separator parameter "%s" is not amongst the required parameters
return 3
if root.req[parameters.separator] then
else
throwError("extra-required-parameter", parameters.separator)
return 4  -- default (in its literal sense)
end
end
return root, params
end
end


function sortOnRank(claims)
local function sortOnRank(claims)
local rankPos
local rankPos
local ranks = {{}, {}, {}, {}}  -- preferred, normal, deprecated, (default)
local ranks = {{}, {}, {}, {}}  -- preferred, normal, deprecated, (default)
local sorted = {}
local sorted = {}
 
for i, v in ipairs(claims) do
for _, v in ipairs(claims) do
rankPos = convertRank(v.rank)
rankPos = rankTable[v.rank] or 4
ranks[rankPos][#ranks[rankPos] + 1] = v
ranks[rankPos][#ranks[rankPos] + 1] = v
end
end
 
sorted = ranks[1]
sorted = ranks[1]
sorted = mergeArrays(sorted, ranks[2])
sorted = mergeArrays(sorted, ranks[2])
sorted = mergeArrays(sorted, ranks[3])
sorted = mergeArrays(sorted, ranks[3])
 
return sorted
return sorted
end
end


-- if ID == nil then item connected to current page is used
-- if id == nil then item connected to current page is used
function getShortName(ID)
function Config:getLabel(id, raw, link, short)
local args = {aliasesP.shortName}
if ID then
args["eid"] = ID
end
return p._property(args)  -- "property" is single
end
 
-- if ID == nil then item connected to current page is used
function Config:getLabel(ID, raw, link, short, pageTitle)
raw = raw or false
link = link or false
short = short or false
pageTitle = pageTitle or false
local label = nil
local label = nil
local title = nil
local title = nil
local prefix= ""
local prefix= ""
local lang
 
if not id then
if not raw or pageTitle then
id = mw.wikibase.getEntityIdForCurrentPage()
if not pageTitle then
 
-- (1) try short name
if not id then
if short then
return ""
label = getShortName(ID)
if label == "" then
label = nil
end
end
-- (2) try label
if not label then
label, lang = mw.wikibase.getLabelWithLang(ID)
-- don't allow language fallback
if lang ~= self.langCode then
label = nil
end
end
end
-- (3) try sitelink/title
if not label or link then
if not ID then
title = mw.title.getCurrentTitle().prefixedText
elseif ID:sub(1,1) == "Q" then
title = mw.wikibase.sitelink(ID)
elseif label then
-- properties have no sitelink, 'title = ID' should only be set
-- if there is a 'label' already and if it needs to be linked;
-- otherwise, it would be 'label = title == ID' even if 'pageTitle' is set
title = ID
prefix = "d:Property:"
end
label = label or title
end
end
end
end
 
-- (4) try entity ID (i.e. raw value)
id = id:upper()  -- just to be sure
if not label and not pageTitle then
 
if not ID then
if raw then
label = mw.wikibase.getEntityIdForCurrentPage()
-- check if given id actually exists
elseif mw.wikibase.getEntity(ID) then
if mw.wikibase.isValidEntityId(id) and mw.wikibase.entityExists(id) then
label = ID
label = id
 
if ID:sub(1,1) == "P" then
if id:sub(1,1) == "P" then
prefix = "Property:"
prefix = "Property:"
end
end
end
end
 
prefix = "d:" .. prefix
prefix = "d:" .. prefix
 
title = label
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
 
if label == "" then
label = nil
end
end
 
-- get label
if not label then
label = mw.wikibase.getLabelByLang(id, self.langCode)
end
end
end
 
-- add optional link
if link and title then
label = buildWikilink(prefix .. title, label)  -- label is never nil if title is not nil
end
if not label then
if not label then
label = ""
label = ""
end
elseif link then
-- build a link if requested
if not title then
if id:sub(1,1) == "Q" then
title = mw.wikibase.getSitelink(id)
elseif id:sub(1,1) == "P" then
-- properties have no sitelink, link to Wikidata instead
title = id
prefix = "d:Property:"
end
end
 
if title then
label = buildWikilink(prefix .. title, label)
end
end
 
return label
return label
end
end
673行目: 720行目:
local value = ""
local value = ""
local prefix = ""
local prefix = ""
local front = " "
local front = "&nbsp;"
local back = ""
local back = ""
 
if self.entityID:sub(1,1) == "P" then
if self.entityID:sub(1,1) == "P" then
prefix = "Property:"
prefix = "Property:"
end
end
 
if self.editAtEnd then
if self.editAtEnd then
front = '<span style="float:'
front = '<span style="float:'
 
if self.langObj:isRTL() then
if self.langObj:isRTL() then
front = front .. 'left'
front = front .. 'left'
688行目: 735行目:
front = front .. 'right'
front = front .. 'right'
end
end
 
front = front .. '">'
front = front .. '">'
back = '</span>'
back = '</span>'
end
end
 
value = "[[File:Blue pencil.svg|frameless|text-top|10px|alt=" .. i18n['info']['edit-on-wikidata'] .. "|link=https://www.wikidata.org/wiki/" .. prefix .. self.entityID .. "?uselang=" .. self.langCode
value = "[[File:OOjs UI 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
if self.propertyID then
value = value .. "#" .. self.propertyID
value = value .. "#" .. self.propertyID
elseif self.inSitelinks then
value = value .. "#sitelinks-wikipedia"
end
end
 
value = value .. "|" .. i18n['info']['edit-on-wikidata'] .. "]]"
value = value .. "|" .. i18n['info']['edit-on-wikidata'] .. "]]"
 
return front .. value .. back
return front .. value .. back
end
end
709行目: 758行目:
local outString = ""
local outString = ""
local j, skip
local j, skip
 
for i = 1, #valuesArray do
for i = 1, #valuesArray do
-- check if this is a reference
-- check if this is a reference
715行目: 764行目:
j = i - 1
j = i - 1
skip = false
skip = false
 
-- skip this reference if it is part of a continuous row of references that already contains the exact same reference
-- 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
while valuesArray[j] and valuesArray[j].refHash do
724行目: 773行目:
j = j - 1
j = j - 1
end
end
 
if not skip then
if not skip then
-- add <ref> tag with the reference's hash as its name (to deduplicate references)
-- 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})
outString = outString .. mw.getCurrentFrame():extensionTag("ref", valuesArray[i][1], {name = valuesArray[i].refHash})
end
end
else
else
733行目: 782行目:
end
end
end
end
 
-- if desired, add a clickable icon that may be used to edit the returned values on Wikidata
if self.editable and outString ~= "" then
outString = outString .. self:getEditIcon()
end
return outString
return outString
end
end


function Config:convertUnit(unit, raw, link, short, unitOnly)
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 space = " "
local label = ""
local label = ""
local itemID
 
if unit == "" or unit == "1" then
if unit == "" or unit == "1" then
return nil
return nil
end
end
 
if unitOnly then
if unitOnly then
space = ""
space = ""
end
end
 
itemID = parseWikidataURL(unit)
itemID = parseWikidataURL(unit)
 
if itemID then
if itemID then
if itemID == aliasesQ.percentage then
if itemID == aliasesQ.percentage then
766行目: 806行目:
else
else
label = self:getLabel(itemID, raw, link, short)
label = self:getLabel(itemID, raw, link, short)
 
if label ~= "" then
if label ~= "" then
return space .. label
return space .. label
772行目: 812行目:
end
end
end
end
 
return ""
return ""
end
end


function Config:getValue(snak, raw, link, short, anyLang, unitOnly, noSpecial)
function State:getValue(snak)
raw = raw or false
return self.conf:getValue(snak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly, false, self.type:sub(1,2))
link = link or false
end
short = short or false
 
anyLang = anyLang or false
function Config:getValue(snak, raw, link, short, anyLang, unitOnly, noSpecial, type)
unitOnly = unitOnly or false
noSpecial = noSpecial or false
if snak.snaktype == 'value' then
if snak.snaktype == 'value' then
if snak.datavalue.type == 'string' then
local datatype = snak.datavalue.type
if snak.datatype == 'url' and link then
local subtype = snak.datatype
local datavalue = snak.datavalue.value
 
if datatype == 'string' then
if subtype == 'url' and link then
-- create link explicitly
-- create link explicitly
if raw then
if raw then
-- will render as a linked number like [1]
-- will render as a linked number like [1]
return "[" .. snak.datavalue.value .. "]"
return "[" .. datavalue .. "]"
else
else
return "[" .. snak.datavalue.value .. " " .. snak.datavalue.value .. "]"
return "[" .. datavalue .. " " .. datavalue .. "]"
end
end
elseif snak.datatype == 'commonsMedia' then
elseif subtype == 'commonsMedia' then
if link then
if link then
return buildWikilink("c:File:" .. snak.datavalue.value, snak.datavalue.value)
return buildWikilink("c:File:" .. datavalue, datavalue)
elseif not raw then
elseif not raw then
return "[[File:" .. snak.datavalue.value .. "]]"
return "[[File:" .. datavalue .. "]]"
else
return datavalue
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
else
return snak.datavalue.value
return datavalue
end
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
else
return snak.datavalue.value
return datavalue
end
end
elseif snak.datavalue.type == 'monolingualtext' then
elseif datatype == 'monolingualtext' then
if anyLang then
if anyLang or datavalue['language'] == self.langCode then
return snak.datavalue.value['text'], snak.datavalue.value['language']
return datavalue['text']
elseif snak.datavalue.value['language'] == self.langCode then
return snak.datavalue.value['text']
else
else
return nil
return nil
end
end
elseif snak.datavalue.type == 'quantity' then
elseif datatype == 'quantity' then
local value = ""
local value = ""
local unit
local unit
 
if not unitOnly then
if not unitOnly then
-- get value and strip + signs from front
-- get value and strip + signs from front
value = mw.ustring.gsub(snak.datavalue.value['amount'], "^\+(.+)$", "%1")
value = mw.ustring.gsub(datavalue['amount'], "^\+(.+)$", "%1")
 
if raw then
if raw then
return value
return value
end
end
 
-- replace decimal mark based on locale
-- replace decimal mark based on locale
value = replaceDecimalMark(value)
value = replaceDecimalMark(value)
 
-- add delimiters for readability
-- add delimiters for readability
value = addDelimiters(value)
value = i18n.addDelimiters(value)
end
end
 
unit = self:convertUnit(snak.datavalue.value['unit'], raw, link, short, unitOnly)
unit = self:convertUnit(datavalue['unit'], raw, link, short, unitOnly)
 
if unit then
if unit then
value = value .. unit
value = value .. unit
end
end
 
return value
return value
elseif snak.datavalue.type == 'time' then
elseif datatype == 'time' then
local y, m, d, p, yDiv, yRound, yFull, value, calendarID, dateStr
local y, m, d, p, yDiv, yRound, yFull, value, calendarID, dateStr
local yFactor = 1
local yFactor = 1
851行目: 905行目:
local mayAddCalendar = false
local mayAddCalendar = false
local calendar = ""
local calendar = ""
local precision = snak.datavalue.value['precision']
local precision = datavalue['precision']
 
if precision == 11 then
if precision == 11 then
p = "d"
p = "d"
861行目: 915行目:
yFactor = 10^(9-precision)
yFactor = 10^(9-precision)
end
end
 
y, m, d = parseDate(snak.datavalue.value['time'], p)
y, m, d = parseDate(datavalue['time'], p)
 
if y < 0 then
if y < 0 then
sign = -1
sign = -1
y = y * sign
y = y * sign
end
end
 
-- if precision is tens/hundreds/thousands/millions/billions of years
-- if precision is tens/hundreds/thousands/millions/billions of years
if precision <= 8 then
if precision <= 8 then
yDiv = y / yFactor
yDiv = y / yFactor
 
-- if precision is tens/hundreds/thousands of years
-- if precision is tens/hundreds/thousands of years
if precision >= 6 then
if precision >= 6 then
mayAddCalendar = true
mayAddCalendar = true
 
if precision <= 7 then
if precision <= 7 then
-- round centuries/millenniums up (e.g. 20th century or 3rd millennium)
-- round centuries/millenniums up (e.g. 20th century or 3rd millennium)
yRound = math.ceil(yDiv)
yRound = math.ceil(yDiv)
 
if not raw then
if not raw then
if precision == 6 then
if precision == 6 then
887行目: 941行目:
suffix = i18n['datetime']['suffixes']['century']
suffix = i18n['datetime']['suffixes']['century']
end
end
 
suffix = getOrdinalSuffix(yRound) .. suffix
suffix = i18n.getOrdinalSuffix(yRound) .. suffix
else
else
-- if not verbose, take the first year of the century/millennium
-- if not verbose, take the first year of the century/millennium
898行目: 952行目:
-- round decades down (e.g. 2010s)
-- round decades down (e.g. 2010s)
yRound = math.floor(yDiv) * yFactor
yRound = math.floor(yDiv) * yFactor
 
if not raw then
if not raw then
prefix = i18n['datetime']['prefixes']['decade-period']
prefix = i18n['datetime']['prefixes']['decade-period']
904行目: 958行目:
end
end
end
end
 
if raw and sign < 0 then
if raw and sign < 0 then
-- if BCE then compensate for "counting backwards"
-- if BCE then compensate for "counting backwards"
912行目: 966行目:
else
else
local yReFactor, yReDiv, yReRound
local yReFactor, yReDiv, yReRound
 
-- round to nearest for tens of thousands of years or more
-- round to nearest for tens of thousands of years or more
yRound = math.floor(yDiv + 0.5)
yRound = math.floor(yDiv + 0.5)
 
if yRound == 0 then
if yRound == 0 then
if precision <= 2 and y ~= 0 then
if precision <= 2 and y ~= 0 then
921行目: 975行目:
yReDiv = y / yReFactor
yReDiv = y / yReFactor
yReRound = math.floor(yReDiv + 0.5)
yReRound = math.floor(yReDiv + 0.5)
 
if yReDiv == yReRound then
if yReDiv == yReRound then
-- change precision to millions of years only if we have a whole number of them
-- change precision to millions of years only if we have a whole number of them
929行目: 983行目:
end
end
end
end
 
if yRound == 0 then
if yRound == 0 then
-- otherwise, take the unrounded (original) number of years
-- otherwise, take the unrounded (original) number of years
938行目: 992行目:
end
end
end
end
 
if precision >= 1 and y ~= 0 then
if precision >= 1 and y ~= 0 then
yFull = yRound * yFactor
yFull = yRound * yFactor
 
yReFactor = 1e9
yReFactor = 1e9
yReDiv = yFull / yReFactor
yReDiv = yFull / yReFactor
yReRound = math.floor(yReDiv + 0.5)
yReRound = math.floor(yReDiv + 0.5)
 
if yReDiv == yReRound then
if yReDiv == yReRound then
-- change precision to billions of years if we're in that range
-- change precision to billions of years if we're in that range
955行目: 1,009行目:
yReDiv = yFull / yReFactor
yReDiv = yFull / yReFactor
yReRound = math.floor(yReDiv + 0.5)
yReRound = math.floor(yReDiv + 0.5)
 
if yReDiv == yReRound then
if yReDiv == yReRound then
-- change precision to millions of years if we're in that range
-- change precision to millions of years if we're in that range
964行目: 1,018行目:
end
end
end
end
 
if not raw then
if not raw then
if precision == 3 then
if precision == 3 then
986行目: 1,040行目:
mayAddCalendar = true
mayAddCalendar = true
end
end
 
if mayAddCalendar then
if mayAddCalendar then
calendarID = parseWikidataURL(snak.datavalue.value['calendarmodel'])
calendarID = parseWikidataURL(datavalue['calendarmodel'])
 
if calendarID and calendarID == aliasesQ.prolepticJulianCalendar then
if calendarID and calendarID == aliasesQ.prolepticJulianCalendar then
if not raw then
if not raw then
1,002行目: 1,056行目:
end
end
end
end
 
if not raw then
if not raw then
local ce = nil
local ce = nil
 
if sign < 0 then
if sign < 0 then
ce = i18n['datetime']['BCE']
ce = i18n['datetime']['BCE']
1,011行目: 1,065行目:
ce = i18n['datetime']['CE']
ce = i18n['datetime']['CE']
end
end
 
if ce then
if ce then
if link then
if link then
1,018行目: 1,072行目:
suffix = suffix .. " " .. ce
suffix = suffix .. " " .. ce
end
end
 
value = tostring(yRound)
value = tostring(yRound)
 
if m then
if m then
dateStr = self.langObj:formatDate("F", "1-"..m.."-1")
dateStr = self.langObj:formatDate("F", "1-"..m.."-1")
 
if d then
if d then
if self.mdyDate then
if self.mdyDate then
1,031行目: 1,085行目:
end
end
end
end
 
value = dateStr .. " " .. value
value = dateStr .. " " .. value
end
end
 
value = prefix .. value .. suffix .. calendar
value = prefix .. value .. suffix .. calendar
else
else
value = tostring(yRound * sign)
value = padZeros(yRound * sign, 4)
 
if m then
if m then
value = value .. "-" .. m
value = value .. "-" .. padZeros(m, 2)
 
if d then
if d then
value = value .. "-" .. d
value = value .. "-" .. padZeros(d, 2)
end
end
end
end
 
value = value .. calendar
value = value .. calendar
end
end
 
return value
return value
elseif snak.datavalue.type == 'globecoordinate' then
elseif datatype == 'globecoordinate' then
-- logic from https://github.com/DataValues/Geo
-- logic from https://github.com/DataValues/Geo (v4.0.1)
 
local precision, numDigits, strFormat, value, globe
local precision, unitsPerDegree, numDigits, strFormat, value, globe
local latValue, latitude, latDegrees, latMinutes, latSeconds
local latitude, latConv, latValue, latLink
local lonValue, longitude, lonDegrees, lonMinutes, lonSeconds
local longitude, lonConv, lonValue, lonLink
local latDirection, latDirectionN, latDirectionS, latDirectionEN
local latDirection, latDirectionN, latDirectionS, latDirectionEN
local lonDirection, lonDirectionE, lonDirectionW, lonDirectionEN
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_N = "N"
local latDirectionEN_S = "S"
local latDirectionEN_S = "S"
local lonDirectionEN_E = "E"
local lonDirectionEN_E = "E"
local lonDirectionEN_W = "W"
local lonDirectionEN_W = "W"
 
if not raw then
if not raw then
latDirectionN = i18n['coord']['latitude-north']
latDirectionN = i18n['coord']['latitude-north']
1,070行目: 1,139行目:
lonDirectionE = i18n['coord']['longitude-east']
lonDirectionE = i18n['coord']['longitude-east']
lonDirectionW = i18n['coord']['longitude-west']
lonDirectionW = i18n['coord']['longitude-west']
 
degSymbol = i18n['coord']['degrees']
degSymbol = i18n['coord']['degrees']
minSymbol = i18n['coord']['minutes']
minSymbol = i18n['coord']['minutes']
1,080行目: 1,149行目:
lonDirectionE = lonDirectionEN_E
lonDirectionE = lonDirectionEN_E
lonDirectionW = lonDirectionEN_W
lonDirectionW = lonDirectionEN_W
 
degSymbol = "/"
degSymbol = "/"
minSymbol = "/"
minSymbol = "/"
1,086行目: 1,155行目:
separator = "/"
separator = "/"
end
end
 
latitude = snak.datavalue.value['latitude']
latitude = datavalue['latitude']
longitude = snak.datavalue.value['longitude']
longitude = datavalue['longitude']
 
if latitude < 0 then
if latitude < 0 then
latDirection = latDirectionS
latDirection = latDirectionS
1,098行目: 1,167行目:
latDirectionEN = latDirectionEN_N
latDirectionEN = latDirectionEN_N
end
end
 
if longitude < 0 then
if longitude < 0 then
lonDirection = lonDirectionW
lonDirection = lonDirectionW
1,107行目: 1,176行目:
lonDirectionEN = lonDirectionEN_E
lonDirectionEN = lonDirectionEN_E
end
end
 
precision = snak.datavalue.value['precision']
precision = datavalue['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
latitude = math.floor(latitude / precision + 0.5) * precision
longitude = math.floor(longitude / precision + 0.5) * precision
longitude = math.floor(longitude / precision + 0.5) * precision
 
numDigits = math.ceil(-math.log10(3600 * precision))
if precision >= 1 - (1 / 60) and precision < 1 then
precision = 1
if numDigits < 0 or numDigits == -0 then
elseif precision >= (1 / 60) - (1 / 3600) and precision < (1 / 60) 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
numDigits = tonumber("0")  -- for some reason, 'numDigits = 0' may actually store '-0', so parse from string instead
end
end
 
strFormat = "%." .. numDigits .. "f"
strFormat = "%." .. numDigits .. "f"
 
-- use string.format() to strip decimal point followed by a zero (.0) for whole numbers
if precision >= 1 then
latSeconds = tonumber(strFormat:format(math.floor(latitude * 3600 * 10^numDigits + 0.5) / 10^numDigits))
latDegrees = strFormat:format(latitude)
lonSeconds = tonumber(strFormat:format(math.floor(longitude * 3600 * 10^numDigits + 0.5) / 10^numDigits))
lonDegrees = strFormat:format(longitude)
 
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
if not raw then
-- replace decimal marks based on locale
latDegSym = replaceDecimalMark(latDegrees) .. degSymbol
latSeconds = replaceDecimalMark(latSeconds)
lonDegSym = replaceDecimalMark(lonDegrees) .. degSymbol
lonSeconds = replaceDecimalMark(lonSeconds)
end
latValue = latValue .. latSeconds .. secSymbol
lonValue = lonValue .. lonSeconds .. secSymbol
end
latValue = latValue .. latDirection
lonValue = lonValue .. lonDirection
value = latValue .. separator .. lonValue
if link then
globe = parseWikidataURL(snak.datavalue.value['globe'])
if globe then
globe = mw.wikibase.getEntity(globe):getLabel("en"):lower()
else
else
globe = "earth"
latDegSym = latDegrees .. degSymbol
lonDegSym = lonDegrees .. degSymbol
end
end
value = "[https://tools.wmflabs.org/geohack/geohack.php?language="..self.langCode.."&params="..latitude.."_"..latDirectionEN.."_"..longitude.."_"..lonDirectionEN.."_globe:"..globe.." "..value.."]"
end
return value
elseif snak.datavalue.type == 'wikibase-entityid' then
local itemID = snak.datavalue.value['numeric-id']
if snak.datatype == 'wikibase-item' then
itemID = "Q" .. itemID
elseif snak.datatype == 'wikibase-property' then
itemID = "P" .. itemID
else
else
return '<strong class="error">' .. unknownDataTypeError(snak.datatype) .. '</strong>'
latConv = math.floor(latitude * unitsPerDegree * 10^numDigits + 0.5) / 10^numDigits
end
lonConv = math.floor(longitude * unitsPerDegree * 10^numDigits + 0.5) / 10^numDigits
 
return self:getLabel(itemID, raw, link, short)
if precision >= (1 / 60) then
else
latMinutes = latConv
return '<strong class="error">' .. unknownDataTypeError(snak.datavalue.type) .. '</strong>'
lonMinutes = lonConv
end
else
elseif snak.snaktype == 'somevalue' and not noSpecial then
latSeconds = latConv
if raw then
lonSeconds = lonConv
return " "  -- single space represents 'somevalue'
else
return i18n['values']['unknown']
end
elseif snak.snaktype == 'novalue' and not noSpecial then
if raw then
return ""  -- empty string represents 'novalue'
else
return i18n['values']['none']
end
else
return nil
end
end


function Config:getSingleRawQualifier(claim, qualifierID)
latMinutes = math.floor(latSeconds / 60)
local qualifiers
lonMinutes = math.floor(lonSeconds / 60)
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
if qualifiers and qualifiers[1] then
return self:getValue(qualifiers[1], true) -- raw = true
else
return nil
end
end


function Config:snakEqualsValue(snak, value)
latSeconds = strFormat:format(latSeconds - (latMinutes * 60))
local snakValue = self:getValue(snak, true) -- raw = true
lonSeconds = strFormat:format(lonSeconds - (lonMinutes * 60))
 
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
if not raw then
latSecSym = replaceDecimalMark(latSeconds) .. secSymbol
return snakValue == value
lonSecSym = replaceDecimalMark(lonSeconds) .. secSymbol
end
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)


function Config:setRank(rank)
if not raw then
local rankPos
latMinSym = replaceDecimalMark(latMinutes) .. minSymbol
lonMinSym = replaceDecimalMark(lonMinutes) .. minSymbol
if rank == flags.best then
else
self.bestRank = true
latMinSym = latMinutes .. minSymbol
self.flagBest = true  -- mark that 'best' flag was given
lonMinSym = lonMinutes .. minSymbol
return
end
end
else
latMinSym = latMinutes .. minSymbol
if rank:sub(1,9) == flags.preferred then
lonMinSym = lonMinutes .. minSymbol
rankPos = 1
end
elseif rank:sub(1,6) == flags.normal then
end
rankPos = 2
 
elseif rank:sub(1,10) == flags.deprecated then
latValue = latDegSym .. latMinSym .. latSecSym .. latDirection
rankPos = 3
lonValue = lonDegSym .. lonMinSym .. lonSecSym .. lonDirection
else
 
return
value = latValue .. separator .. lonValue
end
-- one of the rank flags was given, check if another one was given before
if not self.flagRank then
self.ranks = {false, false, false}  -- no other rank flag given before, so unset ranks
self.bestRank = self.flagBest      -- unsets bestRank only if 'best' flag was not given before
self.flagRank = true                -- mark that a rank flag was given
end
if rank:sub(-1) == "+" then
for i = rankPos, 1, -1 do
self.ranks[i] = true
end
elseif rank:sub(-1) == "-" then
for i = rankPos, #self.ranks do
self.ranks[i] = true
end
else
self.ranks[rankPos] = true
end
end


function Config:setPeriod(period)
if link then
local periodPos
globe = parseWikidataURL(datavalue['globe'])
 
if period == flags.future then
if globe then
periodPos = 1
globe = mw.wikibase.getLabelByLang(globe, "en"):lower()
elseif period == flags.current then
else
periodPos = 2
globe = "earth"
elseif period == flags.former then
end
periodPos = 3
 
else
latLink = table.concat({latDegrees, latMinutes, latSeconds}, "_")
return
lonLink = table.concat({lonDegrees, lonMinutes, lonSeconds}, "_")
end
 
value = "[https://tools.wmflabs.org/geohack/geohack.php?language="..self.langCode.."&params="..latLink.."_"..latDirectionEN.."_"..lonLink.."_"..lonDirectionEN.."_globe:"..globe.." "..value.."]"
-- one of the period flags was given, check if another one was given before
end
if not self.flagPeriod then
self.periods = {false, false, false} -- no other period flag given before, so unset periods
self.flagPeriod = true                -- mark that a period flag was given
end
self.periods[periodPos] = true
end


function Config:processFlag(flag)
return value
if not flag then
elseif datatype == 'wikibase-entityid' then
return false
local label
else
local itemID = datavalue['numeric-id']
flag = mw.text.trim(flag)
 
end
if subtype == 'wikibase-item' then
itemID = "Q" .. itemID
if flag == flags.linked then
elseif subtype == 'wikibase-property' then
self.curState.linked = true
itemID = "P" .. itemID
return true
else
elseif flag == flags.raw then
return '<strong class="error">' .. errorText('unknown-data-type', subtype) .. '</strong>'
self.curState.rawValue = true
end
 
if self.curState == self.states[parameters.reference] then
label = self:getLabel(itemID, raw, link, short)
-- raw reference values end with periods and require a separator (other than none)
 
self.separators["sep%r"][1] = {" "}
if label == "" then
label = nil
end
 
return label
else
return '<strong class="error">' .. errorText('unknown-data-type', datatype) .. '</strong>'
end
elseif snak.snaktype == 'somevalue' and not noSpecial then
if raw then
return " "  -- single space represents 'somevalue'
else
return i18n['values']['unknown']
end
elseif snak.snaktype == 'novalue' and not noSpecial then
if raw then
return ""  -- empty string represents 'novalue'
else
return i18n['values']['none']
end
end
return true
elseif flag == flags.short then
self.curState.shortName = true
return true
elseif flag == flags.multilanguage then
self.curState.anyLanguage = true
return true
elseif flag == flags.unit then
self.curState.unitOnly = true
return true
elseif flag == flags.mdy then
self.mdyDate = true
return true
elseif flag == flags.single then
self.singleClaim = true
return true
elseif flag == flags.sourced then
self.sourcedOnly = true
return true
elseif flag == flags.edit then
self.editable = true
return true
elseif flag == flags.editAtEnd then
self.editable = true
self.editAtEnd = true
return true
elseif flag == flags.best or flag:match('^'..flags.preferred..'[+-]?$') or flag:match('^'..flags.normal..'[+-]?$') or flag:match('^'..flags.deprecated..'[+-]?$') then
self:setRank(flag)
return true
elseif flag == flags.future or flag == flags.current or flag == flags.former then
self:setPeriod(flag)
return true
elseif flag == "" then
-- ignore empty flags and carry on
return true
else
else
return false
return nil
end
end
end
end


function Config:processFlagOrCommand(flag)
function Config:getSingleRawQualifier(claim, qualifierID)
local param = ""
local qualifiers
 
if not flag then
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
return false
 
if qualifiers and qualifiers[1] then
return self:getValue(qualifiers[1], true)  -- raw = true
else
else
flag = mw.text.trim(flag)
return nil
end
end
end
if flag == "property" or flag == "properties" then
 
param = parameters.property
function Config:snakEqualsValue(snak, value)
elseif flag:match('^qualifier[s]?$') then
local snakValue = self:getValue(snak, true)  -- raw = true
self.states.qualifiersCount = self.states.qualifiersCount + 1
 
param = parameters.qualifier .. self.states.qualifiersCount
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
self.separators["sep"..param] = {copyTable(defaultSeparators["sep%q\\d"])}
 
elseif flag:match('^reference[s]?$') then
return snakValue == value
param = parameters.reference
end
else
 
return self:processFlag(flag)
function Config:setRank(rank)
end
local rankPos
 
if self.states[param] then
if rank == p.flags.best then
return false
self.bestRank = true
self.flagBest = true  -- mark that 'best' flag was given
return
end
end
 
-- create a new state for each command
if rank:sub(1,9) == p.flags.preferred then
self.states[param] = State.new(self)
rankPos = 1
elseif rank:sub(1,6) == p.flags.normal then
-- use "%x" as the general parameter name
rankPos = 2
self.states[param].parsedFormat = parseFormat(parameters.general) -- will be overwritten for param=="%p"
elseif rank:sub(1,10) == p.flags.deprecated then
rankPos = 3
-- set the separator
else
self.states[param].separator = self.separators["sep"..param]  -- will be nil for param=="%p", which will be set separately
return
if flag:sub(-1) ~= 's' then
self.states[param].singleValue = true
end
end
self.curState = self.states[param]
return true
end


function Config:qualifierMatches(claim, ID, value)
-- one of the rank flags was given, check if another one was given before
local qualifiers
if not self.flagRank then
self.ranks = {false, false, false}  -- no other rank flag given before, so unset ranks
if claim.qualifiers then qualifiers = claim.qualifiers[ID] end
self.bestRank = self.flagBest      -- unsets bestRank only if 'best' flag was not given before
if qualifiers then
self.flagRank = true               -- mark that a rank flag was given
for i, 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
end
return false
end


function Config:rankMatches(rankPos)
if rank:sub(-1) == "+" then
if self.bestRank then
for i = rankPos, 1, -1 do
return (self.ranks[rankPos] and self.foundRank >= rankPos)
self.ranks[i] = true
end
elseif rank:sub(-1) == "-" then
for i = rankPos, #self.ranks do
self.ranks[i] = true
end
else
else
return self.ranks[rankPos]
self.ranks[rankPos] = true
end
end
end
end


function Config:timeMatches(claim)
function Config:setPeriod(period)
local startTime = nil
local periodPos
local startTimeY = nil
 
local startTimeM = nil
if period == p.flags.future then
local startTimeD = nil
periodPos = 1
local endTime = nil
elseif period == p.flags.current then
local endTimeY = nil
periodPos = 2
local endTimeM = nil
elseif period == p.flags.former then
local endTimeD = nil
periodPos = 3
else
if self.periods[1] and self.periods[2] and self.periods[3] then
return
-- any time
return true
end
end
 
local now = os.date('!*t')
-- one of the period flags was given, check if another one was given before
if not self.flagPeriod then
startTime = self:getSingleRawQualifier(claim, aliasesP.startTime)
self.periods = {false, false, false}  -- no other period flag given before, so unset periods
if startTime and startTime ~= "" and startTime ~= " " then
self.flagPeriod = true                -- mark that a period flag was given
startTimeY, startTimeM, startTimeD = parseDate(startTime)
end
end
 
endTime = self:getSingleRawQualifier(claim, aliasesP.endTime)
self.periods[periodPos] = true
if endTime and endTime ~= "" and endTime ~= " " then
end
endTimeY, endTimeM, endTimeD = parseDate(endTime)
 
elseif endTime == " " then
function Config:qualifierMatches(claim, id, value)
-- end time is 'unknown', assume it is somewhere in the past;
local qualifiers
-- we can do this by taking the current date as a placeholder for the end time
 
endTimeY = now['year']
if claim.qualifiers then qualifiers = claim.qualifiers[id] end
endTimeM = now['month']
if qualifiers then
endTimeD = now['day']
for _, v in pairs(qualifiers) do
end
if self:snakEqualsValue(v, value) then
return true
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
end
-- 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
elseif value == "" then
-- if the qualifier is not present then treat it the same as the special value 'novalue'
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
return false
end
end


-- determines if a claim has references by prefetching them from the claim using getReferences,
function Config:rankMatches(rankPos)
-- which applies some filtering that determines if a reference is actually returned,
if self.bestRank then
-- and caches the references for later use
return (self.ranks[rankPos] and self.foundRank >= rankPos)
function State:isSourced(claim)
else
self.conf.prefetchedRefs = self:getReferences(claim)
return self.ranks[rankPos]
return (#self.conf.prefetchedRefs > 0)
end
end
end


function State:resetCaches()
function Config:timeMatches(claim)
-- any prefetched references of the previous claim must not be used
local startTime = nil
self.conf.prefetchedRefs = nil
local startTimeY = nil
end
local startTimeM = nil
 
local startTimeD = nil
function State:claimMatches(claim)
local endTime = nil
local matches, rankPos
local endTimeY = nil
local endTimeM = nil
-- first of all, reset any cached values used for the previous claim
local endTimeD = nil
self:resetCaches()
 
if self.periods[1] and self.periods[2] and self.periods[3] then
-- if a property value was given, check if it matches the claim's property value
-- any time
if self.conf.propertyValue then
return true
matches = self.conf:snakEqualsValue(claim.mainsnak, self.conf.propertyValue)
else
matches = true
end
end
 
-- if any qualifier values were given, check if each matches one of the claim's qualifier values
startTime = self:getSingleRawQualifier(claim, aliasesP.startTime)
for i, v in pairs(self.conf.qualifierIDsAndValues) do
if startTime and startTime ~= "" and startTime ~= " " then
matches = (matches and self.conf:qualifierMatches(claim, i, v))
startTimeY, startTimeM, startTimeD = parseDate(startTime)
end
end
 
-- check if the claim's rank and time period match
endTime = self:getSingleRawQualifier(claim, aliasesP.endTime)
rankPos = convertRank(claim.rank)
if endTime and endTime ~= "" and endTime ~= " " then
matches = (matches and self.conf:rankMatches(rankPos) and self.conf:timeMatches(claim))
endTimeY, endTimeM, endTimeD = parseDate(endTime)
end
-- if only claims with references must be returned, check if this one has any
 
if self.conf.sourcedOnly then
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
matches = (matches and self:isSourced(claim)-- prefetches and caches references
-- invalidate end time if it precedes start time
endTimeY = nil
endTimeM = nil
endTimeD = nil
end
end
return matches, rankPos
end


function State:out()
if self.periods[1] then
local result  -- collection of arrays with value objects
-- future
local valuesArray  -- array with value objects
if startTimeY and datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD) then
local sep = nil  -- value object
return true
local out = {}  -- array with value objects
end
end
local function walk(formatTable, result)
 
local valuesArray = {}  -- array with value objects
if self.periods[2] then
-- current
for i, v in pairs(formatTable.req) do
if (startTimeY == nil or not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD)) and
if not result[i] or not result[i][1] then
  (endTimeY == nil or datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD)) then
-- we've got no result for a parameter that is required on this level,
return true
-- so skip this level (and its children) by returning an empty result
return {}
end
end
end
end
for i, v in ipairs(formatTable) do
 
if v.param then
if self.periods[3] then
valuesArray = mergeArrays(valuesArray, result[v.str])
-- former
elseif v.str ~= "" then
if endTimeY and not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD) then
valuesArray[#valuesArray + 1] = {v.str}
return true
end
if v.child then
valuesArray = mergeArrays(valuesArray, walk(v.child, result))
end
end
end
return valuesArray
end
end
 
-- iterate through the results from back to front, so that we know when to add separators
return false
for i = #self.results, 1, -1 do
end
result = self.results[i]
 
function Config:processFlag(flag)
-- if there is already some output, then add the separators
if not flag then
if #out > 0 then
return false
sep = self.separator[1]  -- fixed separator
result[parameters.separator] = {self.movSeparator[1]}  -- movable separator
else
sep = nil
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
end
-- reset state before next iteration
self.results = {}
return out
end


-- level 1 hook
if flag == p.flags.linked then
function State:getProperty(claim)
self.curState.linked = true
local value = {self.conf:getValue(claim.mainsnak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)}  -- create one value object
return true
elseif flag == p.flags.raw then
if #value > 0 then
self.curState.rawValue = true
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
if self.curState == self.states[parameters.reference] then
function State:getQualifiers(claim, param)
-- raw reference values end with periods and require a separator (other than none)
local qualifiers
self.separators["sep%r"][1] = {" "}
end
if claim.qualifiers then qualifiers = claim.qualifiers[self.conf.qualifierIDs[param]] end
if qualifiers then
-- iterate through claim's qualifier statements to collect their values;
-- return array with multiple value objects
return self.conf.states[param]:iterate(qualifiers, {[parameters.general] = hookNames[parameters.qualifier.."\\d"][2], count = 1})  -- pass qualifier state with level 2 hook
else
return {}  -- return empty array
end
end


-- level 2 hook
return true
function State:getQualifier(snak)
elseif flag == p.flags.short then
local value = {self.conf:getValue(snak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)-- create one value object
self.curState.shortName = true
return true
if #value > 0 then
elseif flag == p.flags.multilanguage then
return {value}  -- wrap the value object in an array and return it
self.curState.anyLanguage = true
return true
elseif flag == p.flags.unit then
self.curState.unitOnly = true
return true
elseif flag == p.flags.mdy then
self.mdyDate = true
return true
elseif flag == p.flags.single then
self.singleClaim = true
return true
elseif flag == p.flags.sourced then
self.sourcedOnly = true
return true
elseif flag == p.flags.edit then
self.editable = true
return true
elseif flag == p.flags.editAtEnd then
self.editable = true
self.editAtEnd = true
return true
elseif flag == p.flags.best or flag:match('^'..p.flags.preferred..'[+-]?$') or flag:match('^'..p.flags.normal..'[+-]?$') or flag:match('^'..p.flags.deprecated..'[+-]?$') then
self:setRank(flag)
return true
elseif flag == p.flags.future or flag == p.flags.current or flag == p.flags.former then
self:setPeriod(flag)
return true
elseif flag == "" then
-- ignore empty flags and carry on
return true
else
else
return {}  -- return empty array if there was no value
return false
end
end
end
end


-- level 1 hook
function Config:processFlagOrCommand(flag)
function State:getAllQualifiers(claim, param, result, hooks)
local param = ""
local out = {}  -- array with value objects
 
local sep = self.conf.separators["sep"..parameters.qualifier][1]  -- value object
if not flag then
return false
-- 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
end
return out
end


-- level 1 hook
if flag == p.claimCommands.property or flag == p.claimCommands.properties then
function State:getReferences(claim)
param = parameters.property
if self.conf.prefetchedRefs then
elseif flag == p.claimCommands.qualifier or flag == p.claimCommands.qualifiers then
-- return references that have been prefetched by isSourced
self.states.qualifiersCount = self.states.qualifiersCount + 1
return self.conf.prefetchedRefs
param = parameters.qualifier .. self.states.qualifiersCount
self.separators["sep"..param] = {copyTable(defaultSeparators["sep%q\\d"])}
elseif flag == p.claimCommands.reference or flag == p.claimCommands.references then
param = parameters.reference
else
return self:processFlag(flag)
end
end
 
if claim.references then
if self.states[param] then
-- iterate through claim's reference statements to collect their values;
return false
-- return array with multiple value objects
return self.conf.states[parameters.reference]:iterate(claim.references, {[parameters.general] = hookNames[parameters.reference][2], count = 1})  -- pass reference state with level 2 hook
else
return {}  -- return empty array
end
end
end


-- level 2 hook
-- create a new state for each command
-- logic determined based on https://www.wikidata.org/wiki/Help:Sources
self.states[param] = State:new(self, param)
function State:getReference(statement)
 
local language, referenceURL, title, statedIn, statedInRaw
-- use "%x" as the general parameter name
local authors = {}
self.states[param].parsedFormat = parseFormat(parameters.general)  -- will be overwritten for param=="%p"
local params = {}
 
local citeParams = {}
-- set the separator
local value = ""
self.states[param].separator = self.separators["sep"..param]  -- will be nil for param=="%p", which will be set separately
local ref = {}
 
if flag == p.claimCommands.property or flag == p.claimCommands.qualifier or flag == p.claimCommands.reference then
-- 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;
self.states[param].singleValue = true
-- these are parameters of properties other than "pages(s)" and "chapter" (for books) and "title" and "publication date" (for databases) and also "stated in"
end
local hasExtraParams = false
 
self.curState = self.states[param]
if statement.snaks then
 
-- don't include "imported from", which has been added by a bot
return true
if statement.snaks[aliasesP.importedFrom] then
end
statement.snaks[aliasesP.importedFrom] = nil
 
end
function Config:processSeparators(args)
local sep
-- not linked yet because we need the plain value for comparison first
 
language = self:getReferenceDetail(statement.snaks, aliasesP.language, false, false, false, true)  -- (noUnset = true)
for i, v in pairs(self.separators) do
if language then
if args[i] then
-- not part of a "stated in"-source
sep = replaceSpecialChars(args[i])
hasExtraParams = true
 
if sep ~= "" then
-- only add language to the reference if it differs from the local one
self.separators[i][1] = {sep}
if self.conf.langName ~= language then
else
if self.linked then
self.separators[i][1] = nil
-- retrieve language again, but this time with link
params[aliasesP.language] = self:getReferenceDetail(statement.snaks, aliasesP.language, false, true)  -- link = true
else
params[aliasesP.language] = language
end
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[aliasesP.language] = nil
end
end
end
authors = self:getReferenceDetails(statement.snaks, aliasesP.author, false, self.linked)  -- link = true/false
end
if #authors > 0 then
 
-- not part of a "stated in"-source
function Config:setFormatAndSeparators(state, parsedFormat)
hasExtraParams = true
state.parsedFormat = parsedFormat
end
state.separator = self.separators["sep"]
state.movSeparator = self.separators["sep"..parameters.separator]
referenceURL = self:getReferenceDetail(statement.snaks, aliasesP.referenceURL)
state.puncMark = self.separators["punc"]
if referenceURL then
-- not part of a "stated in"-source
hasExtraParams = true
end
-- the next two may be part of a "stated in"-source, so retrieve them already so that they won't count as hasExtraParams
title    = self:getReferenceDetail(statement.snaks, aliasesP.title, false, false, true) -- anyLang = true
statedIn = self:getReferenceDetail(statement.snaks, aliasesP.statedIn, false, true, false, true)  -- link = true, (noUnset = true)
-- (1) if both "reference URL" and "title" are present, then use the general template for citing web references
if referenceURL and title and i18n['cite']['cite-web'] and i18n['cite']['cite-web'] ~= "" then
citeParams[i18n['cite']['url']]    = referenceURL
citeParams[i18n['cite']['title']]  = title
citeParams[i18n['cite']['website']] = statedIn
citeParams[i18n['cite']['language']] = params[aliasesP.language]
citeParams[i18n['cite']['date']]        = self:getReferenceDetail(statement.snaks, aliasesP.publicationDate)
citeParams[i18n['cite']['access-date']]  = self:getReferenceDetail(statement.snaks, aliasesP.retrieved)
citeParams[i18n['cite']['archive-url']]  = self:getReferenceDetail(statement.snaks, aliasesP.archiveURL)
citeParams[i18n['cite']['archive-date']] = self:getReferenceDetail(statement.snaks, aliasesP.archiveDate)
citeParams[i18n['cite']['publisher']]    = self:getReferenceDetail(statement.snaks, aliasesP.publisher, false, self.linked)  -- link = true/false
citeParams[i18n['cite']['quote']]        = self:getReferenceDetail(statement.snaks, aliasesP.quote, false, false, true)  -- anyLang = true
for i, v in ipairs(authors) do
citeParams[i18n['cite']['author']..i] = v
end
-- if this module is being substituted then build a regular template call, otherwise expand the template
if mw.isSubsting() then
for i, v in pairs(citeParams) do
value = value .. "|" .. i .. "=" .. v
end
value = "{{" .. i18n['cite']['cite-web'] .. value .. "}}"
else
value = mw.getCurrentFrame():expandTemplate{title=i18n['cite']['cite-web'], args=citeParams}
end
else
-- we need the raw Q-identifier for the next template
statedInRaw = self:getReferenceDetail(statement.snaks, aliasesP.statedIn, true)  -- raw = true
-- the next three may be part of a "stated in"-source, so retrieve them already so that they won't count as hasExtraParams
params[aliasesP.pages]          = self:getReferenceDetail(statement.snaks, aliasesP.pages)
params[aliasesP.chapter]         = self:getReferenceDetail(statement.snaks, aliasesP.chapter)
params[aliasesP.publicationDate] = self:getReferenceDetail(statement.snaks, aliasesP.publicationDate)
-- 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
-- (2) if "stated in" is present without any parameters not belonging to a "stated in"-source, then use this template which expands the stated-in item
if statedInRaw and not hasExtraParams and i18n['cite']['cite-q'] and i18n['cite']['cite-q'] ~= "" then
citeParams[i18n['cite']['pages']]  = params[aliasesP.pages]
citeParams[i18n['cite']['chapter']] = params[aliasesP.chapter]
citeParams[i18n['cite']['date']]    = params[aliasesP.publicationDate]
if mw.isSubsting() then
for i, v in pairs(citeParams) do
value = value .. "|" .. i .. "=" .. v
end
value = "{{" .. i18n['cite']['cite-q'] .. "|" .. statedInRaw .. value .. "}}"
else
citeParams[1] = statedInRaw
value = mw.getCurrentFrame():expandTemplate{title=i18n['cite']['cite-q'], 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
-- combine "reference URL" and "title" into one link if both are present
if referenceURL and title then
citeParams[#citeParams + 1] = "[" .. referenceURL .. " " .. title .. "]"
elseif referenceURL then
citeParams[#citeParams + 1] = referenceURL
elseif title then
citeParams[#citeParams + 1] = title
end
if statedIn then
citeParams[#citeParams + 1] = statedIn
end
for i, v in pairs(params) do
i = self.conf:getLabel(i)
if i ~= "" then
citeParams[#citeParams + 1] = i .. ": " .. v
end
end
value = table.concat(citeParams, "; ")
if value ~= "" then
value = value .. "."
end
end
end
if value ~= "" then
value = {value}  -- create one value object
if not self.rawValue then
-- this should become a <ref> tag, so safe the reference's hash for later
value.refHash = statement.hash
end
ref = {value}  -- wrap the value object in an array
end
end
return ref
end
end


-- gets a detail of one particular type for a reference
-- determines if a claim has references by prefetching them from the claim using getReferences,
function State:getReferenceDetail(snaks, dType, raw, link, anyLang, noUnset)
-- which applies some filtering that determines if a reference is actually returned,
raw = raw or false
-- and caches the references for later use
link = link or false
function State:isSourced(claim)
anyLang = anyLang or false
self.conf.prefetchedRefs = self:getReferences(claim)
noUnset = noUnset or false
return (#self.conf.prefetchedRefs > 0)
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
end


-- gets the details of one particular type for a reference
function State:resetCaches()
function State:getReferenceDetails(snaks, dType, raw, link, anyLang, noUnset)
-- any prefetched references of the previous claim must not be used
raw = raw or false
self.conf.prefetchedRefs = nil
link = link or false
end
anyLang = anyLang or false
 
noUnset = noUnset or false
function State:claimMatches(claim)
local matches, rankPos
local values = {}
 
-- first of all, reset any cached values used for the previous claim
if not snaks[dType] then
self:resetCaches()
return {}
 
-- if a property value was given, check if it matches the claim's property value
if self.conf.propertyValue then
matches = self.conf:snakEqualsValue(claim.mainsnak, self.conf.propertyValue)
else
matches = true
end
end
 
for i, v in ipairs(snaks[dType]) do
-- if any qualifier values were given, check if each matches one of the claim's qualifier values
-- if nil is returned then it will not be added to the table
for i, v in pairs(self.conf.qualifierIDsAndValues) do
values[#values + 1] = self.conf:getValue(v, raw, link, false, anyLang, false, true) -- noSpecial = true
matches = (matches and self.conf:qualifierMatches(claim, i, v))
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
end
return values
end


function State:callHook(param, hooks, statement, result)
-- check if the claim's rank and time period match
local valuesArray, refHash
rankPos = rankTable[claim.rank] or 4
matches = (matches and self.conf:rankMatches(rankPos) and self.conf:timeMatches(claim))
-- 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
-- if only claims with references must be returned, check if this one has any
valuesArray = self[hooks[param]](self, statement, param, result, hooks) -- array with value objects
if self.conf.sourcedOnly then
matches = (matches and self:isSourced(claim)) -- prefetches and caches references
-- add to the result
if #valuesArray > 0 then
result[param] = valuesArray
result.count = result.count + 1
else
result[param] = {} -- an empty array to indicate that we've tried this hook already
return true  -- miss == true
end
end
end
 
return false
return matches, rankPos
end
end


-- iterate through claims, claim's qualifiers or claim's references to collect values
function State:out()
function State:iterate(statements, hooks, matchHook)
local result  -- collection of arrays with value objects
matchHook = matchHook or alwaysTrue
local valuesArray  -- array with value objects
local sep = nil -- value object
local matches = false
local out = {}  -- array with value objects
local rankPos = nil
 
local result, gotRequired
local function walk(formatTable, result)
local valuesArray = {}  -- array with value objects
for i, v in ipairs(statements) do
 
-- rankPos will be nil for non-claim statements (e.g. qualifiers, references, etc.)
for i, v in pairs(formatTable.req) do
matches, rankPos = matchHook(self, v)
if not result[i] or not result[i][1] then
-- we've got no result for a parameter that is required on this level,
if matches then
-- so skip this level (and its children) by returning an empty result
result = {count = 0}  -- collection of arrays with value objects
return {}
end
local function walk(formatTable)
end
local miss
 
for _, v in ipairs(formatTable) do
for i2, v2 in pairs(formatTable.req) do
if v.param then
-- call a hook, adding its return value to the result
valuesArray = mergeArrays(valuesArray, result[v.str])
miss = self:callHook(i2, hooks, v, result)
elseif v.str ~= "" then
valuesArray[#valuesArray + 1] = {v.str}
if miss then
end
-- we miss a required value for this level, so return false
 
return false
if v.child then
end
valuesArray = mergeArrays(valuesArray, walk(v.child, result))
if result.count == hooks.count then
-- we're done if all hooks have been called;
-- returning at this point breaks the loop
return true
end
end
for i2, v2 in ipairs(formatTable) do
if result.count == hooks.count then
-- we're done if all hooks have been called;
-- returning at this point prevents further childs from being processed
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
-- if we have a rankPos (only with matchHook() for complete claims), then update the foundRank
if rankPos and self.conf.foundRank > rankPos then
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
break
end
end
end
end
end
return valuesArray
end
end
return self:out()
end


function p.property(frame)
-- iterate through the results from back to front, so that we know when to add separators
loadSubmodules(frame)
for i = #self.results, 1, -1 do
return p._property(copyTable(frame.args))
result = self.results[i]
end


function p._property(args)
-- if there is already some output, then add the separators
loadSubmodules()
if #out > 0 then
return execCommand(args, "property")
sep = self.separator[1]  -- fixed separator
end
result[parameters.separator] = {self.movSeparator[1]}  -- movable separator
else
sep = nil
result[parameters.separator] = {self.puncMark[1]}  -- optional punctuation mark
end


function p.properties(frame)
valuesArray = walk(self.parsedFormat, result)
loadSubmodules(frame)
return p._properties(copyTable(frame.args))
end


function p._properties(args)
if #valuesArray > 0 then
loadSubmodules()
if sep then
return execCommand(args, "properties")
valuesArray[#valuesArray + 1] = sep
end
end


function p.qualifier(frame)
out = mergeArrays(valuesArray, out)
loadSubmodules(frame)
end
return p._qualifier(copyTable(frame.args))
end
end


function p._qualifier(args)
-- reset state before next iteration
loadSubmodules()
self.results = {}
return execCommand(args, "qualifier")
end


function p.qualifiers(frame)
return out
loadSubmodules(frame)
return p._qualifiers(copyTable(frame.args))
end
end


function p._qualifiers(args)
-- level 1 hook
loadSubmodules()
function State:getProperty(claim)
return execCommand(args, "qualifiers")
local value = {self:getValue(claim.mainsnak)}  -- create one value object
end


function p.reference(frame)
if #value > 0 then
loadSubmodules(frame)
return {value}  -- wrap the value object in an array and return it
return p._reference(copyTable(frame.args))
else
return {}  -- return empty array if there was no value
end
end
end


function p._reference(args)
-- level 1 hook
loadSubmodules()
function State:getQualifiers(claim, param)
return execCommand(args, "reference")
local qualifiers
end


function p.references(frame)
if claim.qualifiers then qualifiers = claim.qualifiers[self.conf.qualifierIDs[param]] end
loadSubmodules(frame)
if qualifiers then
return p._references(copyTable(frame.args))
-- iterate through claim's qualifier statements to collect their values;
end
-- return array with multiple value objects
return self.conf.states[param]:iterate(qualifiers, {[parameters.general] = hookNames[parameters.qualifier.."\\d"][2], count = 1}) -- pass qualifier state with level 2 hook
else
return {}  -- return empty array
end
end


function p._references(args)
-- level 2 hook
loadSubmodules()
function State:getQualifier(snak)
return execCommand(args, "references")
local value = {self:getValue(snak)}  -- create one value object
end


function execCommand(args, funcName)
if #value > 0 then
_ = Config.new()
return {value} -- wrap the value object in an array and return it
_:processFlagOrCommand(funcName)  -- process first command (== function name)
local parsedFormat, formatParams, claims, sep
local hooks = {count = 0}
local nextArg = args[1]
local nextIndex = 2
-- process flags and commands
while _:processFlagOrCommand(nextArg) do
nextArg = args[nextIndex]
nextIndex = nextIndex + 1
end
if nextArg then
nextArg = mw.text.trim(nextArg)
else
else
nextArg = ""
return {}  -- return empty array if there was no value
end
end
end
-- check for optional entity ID of either item or property
 
if nextArg:sub(1,1):upper() == "Q" then
-- level 1 hook
_.entityID = nextArg:upper() -- entity ID of an item was given
function State:getAllQualifiers(claim, param, result, hooks)
_.entity = mw.wikibase.getEntity(_.entityID)  -- get the item-entity based on the given ID
local out = {} -- array with value objects
_.propertyID = mw.text.trim(args[nextIndex] or "") -- property ID
local sep = self.conf.separators["sep"..parameters.qualifier][1]  -- value object
nextIndex = nextIndex + 1
 
elseif nextArg:sub(1,9):lower() == "property:" then
-- iterate through the output of the separate "qualifier(s)" commands
_.entityID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper()  -- entity ID of a property was given
for i = 1, self.conf.states.qualifiersCount do
_.entity = mw.wikibase.getEntity(_.entityID) -- get the property-entity based on the given ID
 
_.propertyID = mw.text.trim(args[nextIndex] or "")  -- property ID
-- if a hook has not been called yet, call it now
nextIndex = nextIndex + 1
if not result[parameters.qualifier..i] then
else
self:callHook(parameters.qualifier..i, hooks, claim, result)
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
if args["eid"] then
if args["eid"]:sub(1,1):upper() == "Q" then
_.entityID = args["eid"]:upper() 
elseif args["eid"]:sub(1,9):lower() == "property:" then
_.entityID = replaceAlias(mw.text.trim(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["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
end
 
_.entity = mw.wikibase.getEntity(_.entityID)
-- if there is output for this particular "qualifier(s)" command, then add it
_.propertyID = nextArg  -- property ID
if result[parameters.qualifier..i] and result[parameters.qualifier..i][1] then
end
 
-- if there is already some output, then add the separator
-- check if given property ID is an alias
if #out > 0 and sep then
_.propertyID = replaceAlias(_.propertyID):upper()
out[#out + 1] = sep
end
if _.states.qualifiersCount > 0 then
 
-- do further processing if "qualifier(s)" command was given
out = mergeArrays(out, result[parameters.qualifier..i])
if #args - nextIndex + 1 > _.states.qualifiersCount then
-- claim ID or literal value has been given
_.propertyValue = mw.text.trim(args[nextIndex])
nextIndex = nextIndex + 1
end
for i = 1, _.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
_.qualifierIDs[parameters.qualifier..i] = replaceAlias(nextArg):upper()
end
elseif _.states[parameters.reference] then
-- do further processing if "reference(s)" command was given
nextArg = args[nextIndex] -- claim ID or literal value (possibly nil)
nextIndex = nextIndex + 1
if nextArg then
_.propertyValue = mw.text.trim(nextArg)
end
end
end
end
 
-- check for special property value 'somevalue' or 'novalue'
return out
if _.propertyValue then
end
_.propertyValue = replaceSpecialChars(_.propertyValue)
 
-- level 1 hook
if _.propertyValue ~= "" and mw.text.trim(_.propertyValue) == "" then
function State:getReferences(claim)
_.propertyValue = " "  -- single space represents 'somevalue', whereas empty string represents 'novalue'
if self.conf.prefetchedRefs then
else
-- return references that have been prefetched by isSourced
_.propertyValue = mw.text.trim(_.propertyValue)
return self.conf.prefetchedRefs
end
end
end
 
-- parse the desired format, or choose an appropriate format
if claim.references then
if args["format"] then
-- iterate through claim's reference statements to collect their values;
parsedFormat, formatParams = parseFormat(args["format"])
-- return array with multiple value objects
elseif _.states.qualifiersCount > 0 then  -- "qualifier(s)" command given
return self.conf.states[parameters.reference]:iterate(claim.references, {[parameters.general] = hookNames[parameters.reference][2], count = 1}) -- pass reference state with level 2 hook
if _.states[parameters.property] then  -- "propert(y|ies)" command given
else
parsedFormat, formatParams = parseFormat(formats.propertyWithQualifier)
return {} -- return empty array
else
parsedFormat, formatParams = parseFormat(formats.qualifier)
end
elseif _.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
end
end
-- if a "qualifier(s)" command and no "propert(y|ies)" command has been given, make the movable separator a semicolon
 
if _.states.qualifiersCount > 0 and not _.states[parameters.property] then
-- level 2 hook
_.separators["sep"..parameters.separator][1] = {";"}
function State:getReference(statement)
end
local key, citeWeb, citeQ, label
local params = {}
-- if only "reference(s)" has been given, set the default separator to none (except when raw)
local citeParams = {['web'] = {}, ['q'] = {}}
if _.states[parameters.reference] and not _.states[parameters.property] and _.states.qualifiersCount == 0
local citeMismatch = {}
  and not _.states[parameters.reference].rawValue then
local useCite = nil
_.separators["sep"][1] = nil
local useParams = nil
end
local value = ""
local ref = {}
-- if exactly one "qualifier(s)" command has been given, make "sep%q" point to "sep%q1" to make them equivalent;
 
-- must come BEFORE overriding the separator values
local version = 1  -- increment this each time the below logic is changed to avoid conflict errors
if _.states.qualifiersCount == 1 then
 
_.separators["sep"..parameters.qualifier] = _.separators["sep"..parameters.qualifier.."1"]
if statement.snaks then
end
-- don't include "imported from", which is added by a bot
if statement.snaks[aliasesP.importedFrom] then
-- process overridden separator values;
statement.snaks[aliasesP.importedFrom] = nil
-- must come AFTER parsing the formats
end
for i, v in pairs(_.separators) do
 
if args[i] then
-- don't include "inferred from", which is added by a bot
sep = replaceSpecialChars(args[i])
if statement.snaks[aliasesP.inferredFrom] then
statement.snaks[aliasesP.inferredFrom] = nil
if sep ~= "" then
end
_.separators[i][1] = {sep}
 
else
-- don't include "type of reference"
_.separators[i][1] = nil
if statement.snaks[aliasesP.typeOfReference] then
end
statement.snaks[aliasesP.typeOfReference] = nil
end
end
end
 
-- don't include "image" to prevent littering
-- make sure that at least one required parameter has been defined
if statement.snaks[aliasesP.image] then
if not next(parsedFormat.req) then
statement.snaks[aliasesP.image] = nil
error(missingRequiredParameterError())
end
-- make sure that the separator parameter "%s" is not amongst the required parameters
if parsedFormat.req[parameters.separator] then
error(extraRequiredParameterError(parameters.separator))
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(_.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
hooks[i] = getHookName(i, 1)
hooks.count = hooks.count + 1
end
end
end
 
-- don't include "language" if it is equal to the local one
-- the "%q" parameter is not attached to a state, but is a collection of the results of multiple states (attached to "%q1", "%q2", "%q3", ...);
if self:getReferenceDetail(statement.snaks, aliasesP.language) == self.conf.langName then
-- 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
statement.snaks[aliasesP.language] = nil
if formatParams[parameters.qualifier] and _.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 _.states[parameters.property] then
_.states[parameters.property] = State.new(_)
-- if the "single" flag has been given then this state should be equivalent to "property" (singular)
if _.singleClaim then
_.states[parameters.property].singleValue = true
end
end
end
 
-- retrieve all the parameters
-- if the "sourced" flag has been given then create a state for "reference" if it doesn't exist yet, using default values,
for i in pairs(statement.snaks) do
-- which must exist in order to be able to determine if a claim has any references;
label = ""
-- must come AFTER defining the hooks
 
if _.sourcedOnly and not _.states[parameters.reference] then
-- multiple authors may be given
_:processFlagOrCommand("reference")  -- use singular "reference" to minimize overhead
if i == aliasesP.author then
end
params[i] = self:getReferenceDetails(statement.snaks, i, false, self.linked, true)  -- link = true/false, anyLang = true
else
-- set the parsed format and the separators (and optional punctuation mark)
params[i] = {self:getReferenceDetail(statement.snaks, i, false, (self.linked or (i == aliasesP.statedIn)) and (statement.snaks[i][1].datatype ~= 'url'), true)} -- link = true/false, anyLang = true
_.states[parameters.property].parsedFormat = parsedFormat
end
_.states[parameters.property].separator = _.separators["sep"]
 
_.states[parameters.property].movSeparator = _.separators["sep"..parameters.separator]
if #params[i] == 0 then
_.states[parameters.property].puncMark = _.separators["punc"]
params[i] = nil
else
-- process qualifier matching values, analogous to _.propertyValue
if statement.snaks[i][1].datatype == 'external-id' then
for i, v in pairs(args) do
key = "external-id"
i = tostring(i)
label = self.conf:getLabel(i)
 
if i:match('^[Pp]%d+$') or aliasesP[i] then
if label ~= "" then
v = replaceSpecialChars(v)
label = label .. " "
end
-- check for special qualifier value 'somevalue'
else
if v ~= "" and mw.text.trim(v) == "" then
key = i
v = " "  -- single space represents 'somevalue'
end
 
-- add the parameter to each matching type of citation
for j in pairs(citeParams) do
-- do so if there was no mismatch with a previous parameter
if not citeMismatch[j] then
-- check if this parameter is not mismatching itself
if i18n['cite'][j][key] then
-- continue if an option is available in the corresponding cite template
if i18n['cite'][j][key] ~= "" then
citeParams[j][i18n['cite'][j][key]] = label .. params[i][1]
 
-- if there are multiple parameter values (authors), add those too
for k=2, #params[i] do
citeParams[j][i18n['cite'][j][key]..k] = label .. params[i][k]
end
end
else
citeMismatch[j] = true
end
end
end
end
end
_.qualifierIDsAndValues[replaceAlias(i):upper()] = v
end
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
return _:concatValues(_.states[parameters.property]:iterate(claims, hooks, State.claimMatches))  -- pass property state with level 1 hooks and matchHook
else
return ""
end
end


function p.label(frame)
-- get title of general template for citing web references
loadSubmodules(frame)
citeWeb = split(mw.wikibase.getSitelink(aliasesQ.citeWeb) or "", ":")[2]  -- split off namespace from front
return p._label(copyTable(frame.args))
 
end
-- get title of template that expands stated-in references into citations
citeQ = split(mw.wikibase.getSitelink(aliasesQ.citeQ) or "", ":")[2]  -- split off namespace from front


function p._label(args, _)
-- (1) use the general template for citing web references if there is a match and if at least both "reference URL" and "title" are present
_ = _ or Config.new()
if citeWeb and not citeMismatch['web'] and citeParams['web'][i18n['cite']['web'][aliasesP.referenceURL]] and citeParams['web'][i18n['cite']['web'][aliasesP.title]] then
_.curState = State.new(_)
useCite = citeWeb
useParams = citeParams['web']
loadSubmodules()
 
-- (2) use the template that expands stated-in references into citations if there is a match and if at least "stated in" is present
local ID = nil
elseif citeQ and not citeMismatch['q'] and citeParams['q'][i18n['cite']['q'][aliasesP.statedIn]] then
local label = ""
-- we need the raw "stated in" Q-identifier for the this template
citeParams['q'][i18n['cite']['q'][aliasesP.statedIn]] = self:getReferenceDetail(statement.snaks, aliasesP.statedIn, true) -- raw = true
local nextArg = args[1]
 
local nextIndex = 2
useCite = citeQ
useParams = citeParams['q']
while _:processFlag(nextArg) do
end
nextArg = args[nextIndex]
 
nextIndex = nextIndex + 1
if useCite and useParams then
end
-- if this module is being substituted then build a regular template call, otherwise expand the template
if mw.isSubsting() then
if nextArg then
for i, v in pairs(useParams) do
nextArg = mw.text.trim(nextArg)
value = value .. "|" .. i .. "=" .. v
else
end
nextArg = ""
 
end
value = "{{" .. useCite .. value .. "}}"
else
-- check for optional entity ID of either item or property
value = mw.getCurrentFrame():expandTemplate{title=useCite, args=useParams}
if nextArg:sub(1,1):upper() == "Q" then
end
ID = nextArg:upper()  -- entity ID of an item was given
 
elseif nextArg:sub(1,9):lower() == "property:" then
-- (3) else, do some default rendering of name-value pairs, but only if at least "stated in", "reference URL" or "title" is present
ID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper()  -- entity ID of a property was given
elseif params[aliasesP.statedIn] or params[aliasesP.referenceURL] or params[aliasesP.title] then
else
citeParams['default'] = {}
-- might be entity ID of a property, or a bogus entity ID that will fail later on
 
ID = replaceAlias(nextArg):upper()
-- start by adding authors up front
if params[aliasesP.author] and #params[aliasesP.author] > 0 then
if ID:sub(1,1) ~= "P" then
citeParams['default'][#citeParams['default'] + 1] = table.concat(params[aliasesP.author], " & ")
if ID == "" then
end
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
 
if args["eid"] then
-- combine "reference URL" and "title" into one link if both are present
if args["eid"]:sub(1,1):upper() == "Q" then
if params[aliasesP.referenceURL] and params[aliasesP.title] then
ID = args["eid"]:upper()   
citeParams['default'][#citeParams['default'] + 1] = '[' .. params[aliasesP.referenceURL][1] .. ' "' .. params[aliasesP.title][1] .. '"]'
elseif args["eid"]:sub(1,9):lower() == "property:" then
elseif params[aliasesP.referenceURL] then
ID = replaceAlias(mw.text.trim(args["eid"]:sub(10))):upper()
citeParams['default'][#citeParams['default'] + 1] = params[aliasesP.referenceURL][1]
else
elseif params[aliasesP.title] then
-- might be entity ID of a property, or a bogus entity ID that will fail later on
citeParams['default'][#citeParams['default'] + 1] = '"' .. params[aliasesP.title][1] .. '"'
ID = replaceAlias(args["eid"]):upper()
end
 
if ID == "" then
-- then add "stated in"
-- explicitly return if value for 'eid' is empty
if params[aliasesP.statedIn] then
return ""
citeParams['default'][#citeParams['default'] + 1] = "''" .. params[aliasesP.statedIn][1] .. "''"
end
end
 
-- remove previously added parameters so that they won't be added a second time
params[aliasesP.author] = nil
params[aliasesP.referenceURL] = nil
params[aliasesP.title] = nil
params[aliasesP.statedIn] = nil
 
-- add the rest of the parameters
for i, v in pairs(params) do
i = self.conf:getLabel(i)
 
if i ~= "" then
citeParams['default'][#citeParams['default'] + 1] = i .. ": " .. v[1]
end
end
 
value = table.concat(citeParams['default'], "; ")
 
if value ~= "" then
value = value .. "."
end
end
 
if value ~= "" then
value = {value}  -- create one value object
 
if not self.rawValue then
-- this should become a <ref> tag, so save the reference's hash for later
value.refHash = "wikidata-" .. statement.hash .. "-v" .. (tonumber(i18n['cite']['version']) + version)
end
 
ref = {value} -- wrap the value object in an array
end
end
 
return ref
end
 
-- gets a detail of one particular type for a reference
function State:getReferenceDetail(snaks, dType, raw, link, anyLang)
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 _, 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
 
return value
end
 
-- gets the details of one particular type for a reference
function State:getReferenceDetails(snaks, dType, raw, link, anyLang)
local values = {}
 
if not snaks[dType] then
return {}
end
 
for _, 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
 
return values
end
 
-- level 1 hook
function State:getAlias(object)
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.getSitelink(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
else
return {}  -- return empty array if there was no value
end
end
 
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
valuesArray = self[hooks[param]](self, statement, param, result, hooks-- array with value objects
 
-- add to the result
if #valuesArray > 0 then
result[param] = valuesArray
result.count = result.count + 1
else
result[param] = {}  -- an empty array to indicate that we've tried this hook already
return true  -- miss == true
end
end
 
return false
end
 
-- iterate through claims, claim's qualifiers or claim's references to collect values
function State:iterate(statements, hooks, matchHook)
matchHook = matchHook or alwaysTrue
 
local matches = false
local rankPos = nil
local result, gotRequired
 
for _, 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;
-- returning at this point breaks the loop
return true
end
end
else
end
ID = nil
 
end
for _, v2 in ipairs(formatTable) do
end
if result.count == hooks.count then
end
-- we're done if all hooks have been called;
end
-- returning at this point prevents further childs from being processed
return true
if ID then
end
_.entityID = ID
 
else
if v2.child then
_.entityID = mw.wikibase.getEntityIdForCurrentPage()
walk(v2.child)
end
end
end
label = _:getLabel(ID, _.curState.rawValue, _.curState.linked, _.curState.shortName, _.pageTitle)
 
return true
if _.editable and label ~= "" then
end
-- if desired, add a clickable icon that may be used to edit the returned value on Wikidata
gotRequired = walk(self.parsedFormat)
label = label .. _:getEditIcon()
 
end
-- only append the result if we got values for all required parameters on the root level
if gotRequired then
return label
-- if we have a rankPos (only with matchHook() for complete claims), then update the foundRank
end
if rankPos and self.conf.foundRank > rankPos then
 
self.conf.foundRank = rankPos
function p.title(frame)
end
loadSubmodules(frame)
 
return p._title(copyTable(frame.args))
-- append the result
end
self.results[#self.results + 1] = result
 
 
function p._title(args, _)
-- break if we only need a single value
_ = _ or Config.new()
if self.singleValue then
_.pageTitle = true
break
-- loadSubmodules() will already be called by _label()
end
return p._label(args, _)
end
end
end
end
 
return self:out()
end
 
local function getEntityId(arg, eid, page, allowOmitPropPrefix)
local id = nil
local prop = nil
 
if arg then
if arg:sub(1,1) == ":" then
page = arg
eid = nil
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
if eid:sub(1,9):lower() == "property:" then
id = replaceAlias(mw.text.trim(eid:sub(10)))
 
if id:sub(1,1):upper() ~= "P" then
id = ""
end
else
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) or ""
end
 
if not id then
id = mw.wikibase.getEntityIdForCurrentPage() or ""
end
 
id = id:upper()
 
if not mw.wikibase.isValidEntityId(id) then
id = ""
end
 
return id, prop
end
 
local function nextArg(args)
local arg = args[args.pointer]
 
if arg then
args.pointer = args.pointer + 1
return mw.text.trim(arg)
else
return nil
end
end
 
local function claimCommand(args, funcName)
local cfg = Config:new()
cfg:processFlagOrCommand(funcName)  -- process first command (== function name)
 
local lastArg, parsedFormat, formatParams, claims, value
local hooks = {count = 0}
 
-- set the date if given;
-- must come BEFORE processing the flags
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
lastArg = nextArg(args)
until not cfg:processFlagOrCommand(lastArg)
 
-- 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])
 
if cfg.entityID == "" then
return ""  -- we cannot continue without a valid entity ID
end
 
cfg.entity = mw.wikibase.getEntity(cfg.entityID)
 
if not cfg.propertyID then
cfg.propertyID = nextArg(args)
end
 
cfg.propertyID = replaceAlias(cfg.propertyID)
 
if not cfg.entity or not cfg.propertyID then
return ""  -- we cannot continue without an entity or a property ID
end
 
cfg.propertyID = cfg.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
end
 
claims = cfg.entity.claims[cfg.propertyID]
 
if cfg.states.qualifiersCount > 0 then
-- do further processing if "qualifier(s)" command was given
 
if #args - args.pointer + 1 > cfg.states.qualifiersCount then
-- claim ID or literal value has been given
 
cfg.propertyValue = nextArg(args)
end
 
for i = 1, cfg.states.qualifiersCount do
-- 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)
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
cfg.separators["sep"..parameters.qualifier] = cfg.separators["sep"..parameters.qualifier.."1"]
end
 
-- process overridden separator values;
-- must come AFTER tweaking the default separators
cfg:processSeparators(args)
 
-- 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
hooks[i] = getHookName(i, 1)
hooks.count = hooks.count + 1
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.claimCommands.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
cfg:setFormatAndSeparators(cfg.states[parameters.property], parsedFormat)
 
-- process qualifier matching values, analogous to cfg.propertyValue
for i, v in pairs(args) do
i = tostring(i)
 
if i:match('^[Pp]%d+$') or 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
 
-- 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 = cfg:concatValues(cfg.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 cfg.editable and value ~= "" then
value = value .. cfg:getEditIcon()
end
 
return value
end
 
local function generalCommand(args, funcName)
local cfg = Config:new()
cfg.curState = State:new(cfg)
 
local lastArg
local value = nil
 
repeat
lastArg = nextArg(args)
until not cfg:processFlag(lastArg)
 
-- get the entity ID from either the positional argument, the eid argument or the page argument
cfg.entityID = getEntityId(lastArg, args[p.args.eid], args[p.args.page], true)
 
if cfg.entityID == "" or not mw.wikibase.entityExists(cfg.entityID) then
return ""  -- we cannot continue without an entity
end
 
-- serve according to the given command
if funcName == p.generalCommands.label then
value = cfg:getLabel(cfg.entityID, cfg.curState.rawValue, cfg.curState.linked, cfg.curState.shortName)
elseif funcName == p.generalCommands.title then
cfg.inSitelinks = true
 
if cfg.entityID:sub(1,1) == "Q" then
value = mw.wikibase.getSitelink(cfg.entityID)
end
 
if cfg.curState.linked and value then
value = buildWikilink(value)
end
elseif funcName == p.generalCommands.description then
value = mw.wikibase.getDescription(cfg.entityID)
else
local parsedFormat, formatParams
local hooks = {count = 0}
 
cfg.entity = mw.wikibase.getEntity(cfg.entityID)
 
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
if not cfg.entity.aliases or not cfg.entity.aliases[cfg.langCode] then
return ""  -- there is no use to continue without any aliasses
end
 
local aliases = cfg.entity.aliases[cfg.langCode]
 
-- parse the desired format, or parse the default aliases format
if args["format"] then
parsedFormat, formatParams = parseFormat(args["format"])
else
parsedFormat, formatParams = parseFormat(formats.alias)
end
 
-- process overridden separator values;
-- must come AFTER tweaking the default separators
cfg:processSeparators(args)
 
-- 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
 
-- 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(aliases, hooks))
elseif funcName == p.generalCommands.badge or funcName == p.generalCommands.badges then
if not cfg.entity.sitelinks or not cfg.entity.sitelinks[cfg.siteID] or not cfg.entity.sitelinks[cfg.siteID].badges then
return ""  -- there is no use to continue without any badges
end
 
local badges = cfg.entity.sitelinks[cfg.siteID].badges
 
cfg.inSitelinks = true
 
-- parse the desired format, or parse the default aliases format
if args["format"] then
parsedFormat, formatParams = parseFormat(args["format"])
else
parsedFormat, formatParams = parseFormat(formats.badge)
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
 
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
throwError("no-function-specified")
end
 
f = mw.text.trim(frame.args[1])
 
if f == "main" then
throwError("main-called-twice")
end
 
assert(p["_"..f], errorText('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)


-- main function that is supposed to be used by wrapper templates
function p.main(frame)
local f, args, i, v
loadSubmodules(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
error(i18n["errors"]["no-function-specified"])
end
f = mw.text.trim(frame.args[1])
if f == "main" then
error(i18n["errors"]["main-called-twice"])
end
assert(p["_"..f], applyStringParams(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)
return p["_"..f](args)
end
end


return p
return p