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

48版 をインポートしました
template>K-iczn
(en:Module:Wd 2017年9月30日 (土) 09:42(UTC)より)
(48版 をインポートしました)
 
(7人の利用者による、間の17版が非表示)
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


p.commands = {
p.claimCommands = {
property  = "property",
property  = "property",
properties = "properties",
properties = "properties",
24行目: 27行目:
qualifiers = "qualifiers",
qualifiers = "qualifiers",
reference  = "reference",
reference  = "reference",
references = "references",
references = "references"
label     = "label",
}
title     = "title",
 
alias     = "alias",
p.generalCommands = {
aliases   = "aliases"
label       = "label",
title       = "title",
description = "description",
alias       = "alias",
aliases     = "aliases",
badge      = "badge",
badges      = "badges"
}
}


53行目: 62行目:


p.args = {
p.args = {
eid = "eid"
eid = "eid",
page = "page",
date = "date"
}
}


p.aliasesP = {
local aliasesP = {
coord           = "P625",
coord                   = "P625",
---------------
-----------------------
author         = "P50",
image                  = "P18",
publisher       = "P123",
author                 = "P50",
importedFrom   = "P143",
publisher               = "P123",
statedIn       = "P248",
importedFrom           = "P143",
pages           = "P304",
statedIn               = "P248",
publicationDate = "P577",
pages                   = "P304",
startTime       = "P580",
language                = "P407",
endTime         = "P582",
hasPart                = "P527",
chapter         = "P792",
publicationDate         = "P577",
retrieved       = "P813",
startTime               = "P580",
referenceURL   = "P854",
endTime                 = "P582",
archiveURL     = "P1065",
chapter                 = "P792",
title           = "P1476",
retrieved               = "P813",
quote           = "P1683",
referenceURL           = "P854",
shortName       = "P1813",
sectionVerseOrParagraph = "P958",
language        = "P2439",
archiveURL             = "P1065",
archiveDate     = "P2960"
title                   = "P1476",
formatterURL            = "P1630",
quote                   = "P1683",
shortName               = "P1813",
definingFormula        = "P2534",
archiveDate             = "P2960",
inferredFrom            = "P3452",
typeOfReference        = "P3865",
column                  = "P3903"
}
}


90行目: 109行目:
reference = "%r",
reference = "%r",
alias    = "%a",
alias    = "%a",
badge    = "%b",
separator = "%s",
separator = "%s",
general  = "%x"
general  = "%x"
98行目: 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]"
alias                = "%a[%s]",
badge                = "%b[%s]"
}
}


107行目: 128行目:
[parameters.qualifier]        = {"getAllQualifiers"},
[parameters.qualifier]        = {"getAllQualifiers"},
[parameters.qualifier.."\\d"] = {"getQualifiers", "getQualifier"},
[parameters.qualifier.."\\d"] = {"getQualifiers", "getQualifier"},
[parameters.alias]            = {"getAlias"}
[parameters.alias]            = {"getAlias"},
[parameters.badge]            = {"getBadge"}
}
}


118行目: 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
136行目: 164行目:
["punc"]  = {copyTable(defaultSeparators["punc"])}
["punc"]  = {copyTable(defaultSeparators["punc"])}
}
}
 
cfg.entity = nil
cfg.entity = nil
cfg.entityID = nil
cfg.entityID = nil
143行目: 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
149行目: 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
158行目: 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
196行目: 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 p.aliasesP[ID] then
if aliasesP[id] then
ID = p.aliasesP[ID]
id = aliasesP[id]
end
end
return ID
end


function applyStringParams(str, ...)
return id
for i, v in ipairs(arg) do
str = mw.ustring.gsub(str, "$"..i, v)
end
return str
end
end


function unknownDataTypeError(dataType)
local function errorText(code, param)
return applyStringParams(i18n['errors']['unknown-data-type'], dataType)
local text = i18n["errors"][code]
if param then text = mw.ustring.gsub(text, "$1", param) end
return text
end
end


function missingRequiredParameterError()
local function throwError(errorMessage, param)
return i18n['errors']['missing-required-parameter']
error(errorText(errorMessage, param))
end
end


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


function getOrdinalSuffix(num)
local function padZeros(num, numDigits)
return i18n.getOrdinalSuffix(num)
local numZeros
end
local negative = false
 
if num < 0 then
negative = true
num = num * -1
end
 
num = tostring(num)
numZeros = numDigits - num:len()
 
for _ = 1, numZeros do
num = "0"..num
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
249行目: 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
268行目: 305行目:
end
end
end
end
 
return strOut
return strOut
end
end


function buildWikilink(target, label)
local function buildWikilink(target, label)
if not label or target == label then
if not label or target == label then
return "[[" .. target .. "]]"
return "[[" .. target .. "]]"
286行目: 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
298行目: 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 split(str, del)
local function split(str, del)
local out = {}
local out = {}
local i, j = str:find(del)
local i, j = str:find(del)
 
if i and j then
if i and j then
out[1] = str:sub(1, i - 1)
out[1] = str:sub(1, i - 1)
316行目: 353行目:
out[1] = str
out[1] = str
end
end
 
return out
return out
end
end


function parseWikidataURL(url)
local function parseWikidataURL(url)
local ID
local id
 
if url:match('^http[s]?://') then
if url:match('^http[s]?://') then
ID = split(url, "Q")
id = split(url, "Q")
 
if ID[2] then
if id[2] then
return "Q" .. ID[2]
return "Q" .. id[2]
end
end
end
end
 
return nil
return nil
end
end
336行目: 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
411行目: 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]
445行目: 482行目:
end
end


function alwaysTrue()
local function alwaysTrue()
return true
return true
end
end
494行目: 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
521行目: 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
570行目: 607行目:
end
end
end
end
 
cur.str = cur.str .. replaceSpecialChar(chr)
cur.str = cur.str .. replaceSpecialChar(chr)
end
end
577行目: 614行目:
esc = false
esc = false
end
end
 
prev = nil
prev = nil
end
end
 
endParam()
endParam()
 
-- make sure that at least one required parameter has been defined
-- make sure that at least one required parameter has been defined
if not next(root.req) then
if not next(root.req) then
error(missingRequiredParameterError())
throwError("missing-required-parameter")
end
end
 
-- make sure that the separator parameter "%s" is not amongst the required parameters
-- make sure that the separator parameter "%s" is not amongst the required parameters
if root.req[parameters.separator] then
if root.req[parameters.separator] then
error(extraRequiredParameterError(parameters.separator))
throwError("extra-required-parameter", parameters.separator)
end
end
 
return root, params
return root, params
end
end


function convertRank(rank)
local function sortOnRank(claims)
if rank == "preferred" then
return 1
elseif rank == "normal" then
return 2
elseif rank == "deprecated" then
return 3
else
return 4  -- default (in its literal sense)
end
end
 
function sortOnRank(claims)
local rankPos
local 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 = {p.aliasesP.shortName}
if ID then
args[p.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)
raw = raw or false
link = link or false
short = short or false
local label = nil
local label = nil
local title = nil
local title = nil
local prefix= ""
local prefix= ""
local lang
 
if not id then
id = mw.wikibase.getEntityIdForCurrentPage()
 
if not id then
return ""
end
end
 
id = id:upper()  -- just to be sure
 
if raw then
if raw then
if not ID then
-- check if given id actually exists
label = mw.wikibase.getEntityIdForCurrentPage()
if mw.wikibase.isValidEntityId(id) and mw.wikibase.entityExists(id) then
elseif mw.wikibase.getEntity(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  -- may be nil
title = label  -- may be nil
else
else
-- try short name first if requested
-- try short name first if requested
if short then
if short then
label = getShortName(ID)
label = p._property{aliasesP.shortName, [p.args.eid] = id}  -- get short name
 
if label == "" then
if label == "" then
label = nil
label = nil
end
end
end
end
 
-- get label
-- get label
if not label then
if not label then
label, lang = mw.wikibase.getLabelWithLang(ID)
label = mw.wikibase.getLabelByLang(id, self.langCode)
-- don't allow language fallback
if lang ~= self.langCode then
label = nil
end
end
end
end
end
 
if not label then
if not label then
label = ""
label = ""
687行目: 700行目:
-- build a link if requested
-- build a link if requested
if not title then
if not title then
if not ID then
if id:sub(1,1) == "Q" then
title = mw.title.getCurrentTitle().prefixedText
title = mw.wikibase.getSitelink(id)
elseif ID:sub(1,1) == "Q" then
elseif id:sub(1,1) == "P" then
title = mw.wikibase.sitelink(ID)
elseif ID:sub(1,1) == "P" then
-- properties have no sitelink, link to Wikidata instead
-- properties have no sitelink, link to Wikidata instead
title = ID
title = id
prefix = "d:Property:"
prefix = "d:Property:"
end
end
end
end
 
if title then
if title then
label = buildWikilink(prefix .. title, label)
label = buildWikilink(prefix .. title, label)
end
end
end
end
 
return label
return label
end
end
709行目: 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'
724行目: 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.pageTitle then
elseif self.inSitelinks then
value = value .. "#sitelinks-wikipedia"
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
747行目: 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
753行目: 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
762行目: 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
771行目: 782行目:
end
end
end
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
799行目: 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
805行目: 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
else
return snak.datavalue.value
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
return datavalue
end
end
elseif snak.datatype == 'geo-shape' and link then
else
return buildWikilink("c:" .. snak.datavalue.value, snak.datavalue.value)
return datavalue
elseif snak.datatype == 'math' and not raw then
end
return mw.getCurrentFrame():extensionTag("math", snak.datavalue.value)
elseif datatype == 'monolingualtext' then
else
if anyLang or datavalue['language'] == self.langCode then
return snak.datavalue.value
return datavalue['text']
end
elseif snak.datavalue.type == 'monolingualtext' then
if anyLang then
return snak.datavalue.value['text'], snak.datavalue.value['language']
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
884行目: 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"
894行目: 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
920行目: 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
931行目: 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']
937行目: 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"
945行目: 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
954行目: 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
962行目: 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
971行目: 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
988行目: 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
997行目: 1,018行目:
end
end
end
end
 
if not raw then
if not raw then
if precision == 3 then
if precision == 3 then
1,019行目: 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,035行目: 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,044行目: 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,051行目: 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,064行目: 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,103行目: 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,113行目: 1,149行目:
lonDirectionE = lonDirectionEN_E
lonDirectionE = lonDirectionEN_E
lonDirectionW = lonDirectionEN_W
lonDirectionW = lonDirectionEN_W
 
degSymbol = "/"
degSymbol = "/"
minSymbol = "/"
minSymbol = "/"
1,119行目: 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,131行目: 1,167行目:
latDirectionEN = latDirectionEN_N
latDirectionEN = latDirectionEN_N
end
end
 
if longitude < 0 then
if longitude < 0 then
lonDirection = lonDirectionW
lonDirection = lonDirectionW
1,140行目: 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 label
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
 
label = self:getLabel(itemID, raw, link, short)
if precision >= (1 / 60) then
latMinutes = latConv
if label == "" then
lonMinutes = lonConv
label = nil
else
latSeconds = latConv
lonSeconds = lonConv
 
latMinutes = math.floor(latSeconds / 60)
lonMinutes = math.floor(lonSeconds / 60)
 
latSeconds = strFormat:format(latSeconds - (latMinutes * 60))
lonSeconds = strFormat:format(lonSeconds - (lonMinutes * 60))
 
if not raw then
latSecSym = replaceDecimalMark(latSeconds) .. secSymbol
lonSecSym = replaceDecimalMark(lonSeconds) .. secSymbol
else
latSecSym = latSeconds .. secSymbol
lonSecSym = lonSeconds .. secSymbol
end
end
 
latDegrees = math.floor(latMinutes / 60)
lonDegrees = math.floor(lonMinutes / 60)
 
latDegSym = latDegrees .. degSymbol
lonDegSym = lonDegrees .. degSymbol
 
latMinutes = latMinutes - (latDegrees * 60)
lonMinutes = lonMinutes - (lonDegrees * 60)
 
if precision >= (1 / 60) then
latMinutes = strFormat:format(latMinutes)
lonMinutes = strFormat:format(lonMinutes)
 
if not raw then
latMinSym = replaceDecimalMark(latMinutes) .. minSymbol
lonMinSym = replaceDecimalMark(lonMinutes) .. minSymbol
else
latMinSym = latMinutes .. minSymbol
lonMinSym = lonMinutes .. minSymbol
end
else
latMinSym = latMinutes .. minSymbol
lonMinSym = lonMinutes .. minSymbol
end
end
end
return label
else
return '<strong class="error">' .. unknownDataTypeError(snak.datavalue.type) .. '</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
else
return nil
end
end


function Config:getSingleRawQualifier(claim, qualifierID)
latValue = latDegSym .. latMinSym .. latSecSym .. latDirection
local qualifiers
lonValue = lonDegSym .. lonMinSym .. lonSecSym .. lonDirection
 
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
value = latValue .. separator .. lonValue
if qualifiers and qualifiers[1] then
return self:getValue(qualifiers[1], true)  -- raw = true
else
return nil
end
end


function Config:snakEqualsValue(snak, value)
if link then
local snakValue = self:getValue(snak, true)  -- raw = true
globe = parseWikidataURL(datavalue['globe'])
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
return snakValue == value
end


function Config:setRank(rank)
if globe then
local rankPos
globe = mw.wikibase.getLabelByLang(globe, "en"):lower()
else
if rank == p.flags.best then
globe = "earth"
self.bestRank = true
end
self.flagBest = true  -- mark that 'best' flag was given
 
return
latLink = table.concat({latDegrees, latMinutes, latSeconds}, "_")
end
lonLink = table.concat({lonDegrees, lonMinutes, lonSeconds}, "_")
 
if rank:sub(1,9) == p.flags.preferred then
value = "[https://tools.wmflabs.org/geohack/geohack.php?language="..self.langCode.."&params="..latLink.."_"..latDirectionEN.."_"..lonLink.."_"..lonDirectionEN.."_globe:"..globe.." "..value.."]"
rankPos = 1
end
elseif rank:sub(1,6) == p.flags.normal then
 
rankPos = 2
return value
elseif rank:sub(1,10) == p.flags.deprecated then
elseif datatype == 'wikibase-entityid' then
rankPos = 3
local label
else
local itemID = datavalue['numeric-id']
return
 
end
if subtype == 'wikibase-item' then
itemID = "Q" .. itemID
-- one of the rank flags was given, check if another one was given before
elseif subtype == 'wikibase-property' then
if not self.flagRank then
itemID = "P" .. itemID
self.ranks = {false, false, false}  -- no other rank flag given before, so unset ranks
else
self.bestRank = self.flagBest      -- unsets bestRank only if 'best' flag was not given before
return '<strong class="error">' .. errorText('unknown-data-type', subtype) .. '</strong>'
self.flagRank = true                -- mark that a rank flag was given
end
end
 
label = self:getLabel(itemID, raw, link, short)
if rank:sub(-1) == "+" then
 
for i = rankPos, 1, -1 do
if label == "" then
self.ranks[i] = true
label = nil
end
 
return label
else
return '<strong class="error">' .. errorText('unknown-data-type', datatype) .. '</strong>'
end
end
elseif rank:sub(-1) == "-" then
elseif snak.snaktype == 'somevalue' and not noSpecial then
for i = rankPos, #self.ranks do
if raw then
self.ranks[i] = true
return " "  -- single space represents 'somevalue'
end
else
else
return i18n['values']['unknown']
self.ranks[rankPos] = true
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
end
end


function Config:setPeriod(period)
function Config:getSingleRawQualifier(claim, qualifierID)
local periodPos
local qualifiers
 
if period == p.flags.future then
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
periodPos = 1
 
elseif period == p.flags.current then
if qualifiers and qualifiers[1] then
periodPos = 2
return self:getValue(qualifiers[1], true)  -- raw = true
elseif period == p.flags.former then
periodPos = 3
else
else
return
return nil
end
end
-- one of the period flags was given, check if another one was given before
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
end


function Config:processFlag(flag)
function Config:snakEqualsValue(snak, value)
if not flag then
local snakValue = self:getValue(snak, true)  -- raw = true
return false
 
else
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
flag = mw.text.trim(flag)
 
return snakValue == value
end
 
function Config:setRank(rank)
local rankPos
 
if rank == p.flags.best then
self.bestRank = true
self.flagBest = true  -- mark that 'best' flag was given
return
end
end
 
if flag == p.flags.linked then
if rank:sub(1,9) == p.flags.preferred then
self.curState.linked = true
rankPos = 1
return true
elseif rank:sub(1,6) == p.flags.normal then
elseif flag == p.flags.raw then
rankPos = 2
self.curState.rawValue = true
elseif rank:sub(1,10) == p.flags.deprecated then
rankPos = 3
if self.curState == self.states[parameters.reference] then
else
-- raw reference values end with periods and require a separator (other than none)
return
self.separators["sep%r"][1] = {" "}
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
end
elseif rank:sub(-1) == "-" then
return true
for i = rankPos, #self.ranks do
elseif flag == p.flags.short then
self.ranks[i] = true
self.curState.shortName = true
end
return true
else
elseif flag == p.flags.multilanguage then
self.ranks[rankPos] = true
self.curState.anyLanguage = true
end
return true
end
elseif flag == p.flags.unit then
 
self.curState.unitOnly = true
function Config:setPeriod(period)
return true
local periodPos
elseif flag == p.flags.mdy then
 
self.mdyDate = true
if period == p.flags.future then
return true
periodPos = 1
elseif flag == p.flags.single then
elseif period == p.flags.current then
self.singleClaim = true
periodPos = 2
return true
elseif period == p.flags.former then
elseif flag == p.flags.sourced then
periodPos = 3
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 false
return
end
end
end


function Config:processFlagOrCommand(flag)
-- one of the period flags was given, check if another one was given before
local param = ""
if not self.flagPeriod then
self.periods = {false, false, false}  -- no other period flag given before, so unset periods
if not flag then
self.flagPeriod = true                -- mark that a period flag was given
return false
else
flag = mw.text.trim(flag)
end
end
 
if flag == p.commands.property or flag == p.commands.properties then
self.periods[periodPos] = true
param = parameters.property
end
elseif flag == p.commands.qualifier or flag == p.commands.qualifiers then
 
self.states.qualifiersCount = self.states.qualifiersCount + 1
function Config:qualifierMatches(claim, id, value)
param = parameters.qualifier .. self.states.qualifiersCount
local qualifiers
self.separators["sep"..param] = {copyTable(defaultSeparators["sep%q\\d"])}
 
elseif flag == p.commands.reference or flag == p.commands.references then
if claim.qualifiers then qualifiers = claim.qualifiers[id] end
param = parameters.reference
if qualifiers then
else
for _, v in pairs(qualifiers) do
return self:processFlag(flag)
if self:snakEqualsValue(v, value) then
end
return true
end
if self.states[param] then
return false
end
-- create a new state for each command
self.states[param] = State.new(self)
-- use "%x" as the general parameter name
self.states[param].parsedFormat = parseFormat(parameters.general)  -- will be overwritten for param=="%p"
-- set the separator
self.states[param].separator = self.separators["sep"..param]  -- will be nil for param=="%p", which will be set separately
if flag:sub(-1) ~= 's' then
self.states[param].singleValue = true
end
self.curState = self.states[param]
return true
end
 
function Config:qualifierMatches(claim, ID, value)
local qualifiers
if claim.qualifiers then qualifiers = claim.qualifiers[ID] end
if qualifiers then
for i, v in pairs(qualifiers) do
if self:snakEqualsValue(v, value) then
return true
end
end
end
elseif value == "" then
elseif value == "" then
1,445行目: 1,427行目:
return true
return true
end
end
 
return false
return false
end
end
1,466行目: 1,448行目:
local endTimeM = nil
local endTimeM = nil
local endTimeD = nil
local endTimeD = nil
 
if self.periods[1] and self.periods[2] and self.periods[3] then
if self.periods[1] and self.periods[2] and self.periods[3] then
-- any time
-- any time
return true
return true
end
end
 
local now = os.date('!*t')
startTime = self:getSingleRawQualifier(claim, aliasesP.startTime)
startTime = self:getSingleRawQualifier(claim, p.aliasesP.startTime)
if startTime and startTime ~= "" and startTime ~= " " then
if startTime and startTime ~= "" and startTime ~= " " then
startTimeY, startTimeM, startTimeD = parseDate(startTime)
startTimeY, startTimeM, startTimeD = parseDate(startTime)
end
end
 
endTime = self:getSingleRawQualifier(claim, p.aliasesP.endTime)
endTime = self:getSingleRawQualifier(claim, aliasesP.endTime)
if endTime and endTime ~= "" and endTime ~= " " then
if endTime and endTime ~= "" and endTime ~= " " then
endTimeY, endTimeM, endTimeD = parseDate(endTime)
endTimeY, endTimeM, endTimeD = parseDate(endTime)
elseif endTime == " " then
-- end time is 'unknown', assume it is somewhere in the past;
-- we can do this by taking the current date as a placeholder for the end time
endTimeY = now['year']
endTimeM = now['month']
endTimeD = now['day']
end
end
 
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
if startTimeY ~= nil and endTimeY ~= nil and datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
-- invalidate end time if it precedes start time
-- invalidate end time if it precedes start time
1,496行目: 1,470行目:
endTimeD = nil
endTimeD = nil
end
end
 
if self.periods[1] then
if self.periods[1] then
-- future
-- future
if startTimeY and datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD) then
if startTimeY and datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD) then
return true
return true
end
end
end
end
 
if self.periods[2] then
if self.periods[2] then
-- current
-- current
if (startTimeY == nil or not datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD)) and
if (startTimeY == nil or not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], startTimeY, startTimeM, startTimeD)) and
  (endTimeY == nil or datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD)) then
  (endTimeY == nil or datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD)) then
return true
return true
end
end
end
end
 
if self.periods[3] then
if self.periods[3] then
-- former
-- former
if endTimeY and not datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD) then
if endTimeY and not datePrecedesDate(self.atDate[1], self.atDate[2], self.atDate[3], endTimeY, endTimeM, endTimeD) then
return true
return true
end
end
end
end
 
return false
return false
end
end


-- determines if a claim has references by prefetching them from the claim using getReferences,
function Config:processFlag(flag)
-- which applies some filtering that determines if a reference is actually returned,
if not flag then
-- and caches the references for later use
return false
function State:isSourced(claim)
end
self.conf.prefetchedRefs = self:getReferences(claim)
 
return (#self.conf.prefetchedRefs > 0)
if flag == p.flags.linked then
end
self.curState.linked = true
return true
elseif flag == p.flags.raw then
self.curState.rawValue = true


function State:resetCaches()
if self.curState == self.states[parameters.reference] then
-- any prefetched references of the previous claim must not be used
-- raw reference values end with periods and require a separator (other than none)
self.conf.prefetchedRefs = nil
self.separators["sep%r"][1] = {" "}
end
end


function State:claimMatches(claim)
return true
local matches, rankPos
elseif flag == p.flags.short then
self.curState.shortName = true
-- first of all, reset any cached values used for the previous claim
return true
self:resetCaches()
elseif flag == p.flags.multilanguage then
self.curState.anyLanguage = true
-- if a property value was given, check if it matches the claim's property value
return true
if self.conf.propertyValue then
elseif flag == p.flags.unit then
matches = self.conf:snakEqualsValue(claim.mainsnak, self.conf.propertyValue)
self.curState.unitOnly = true
else
return true
matches = true
elseif flag == p.flags.mdy then
end
self.mdyDate = true
return true
-- if any qualifier values were given, check if each matches one of the claim's qualifier values
elseif flag == p.flags.single then
for i, v in pairs(self.conf.qualifierIDsAndValues) do
self.singleClaim = true
matches = (matches and self.conf:qualifierMatches(claim, i, v))
return true
end
elseif flag == p.flags.sourced then
self.sourcedOnly = true
-- check if the claim's rank and time period match
return true
rankPos = convertRank(claim.rank)
elseif flag == p.flags.edit then
matches = (matches and self.conf:rankMatches(rankPos) and self.conf:timeMatches(claim))
self.editable = true
return true
-- if only claims with references must be returned, check if this one has any
elseif flag == p.flags.editAtEnd then
if self.conf.sourcedOnly then
self.editable = true
matches = (matches and self:isSourced(claim)-- prefetches and caches references
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
return false
end
end
return matches, rankPos
end
end


function State:out()
function Config:processFlagOrCommand(flag)
local result  -- collection of arrays with value objects
local param = ""
local valuesArray  -- array with value objects
 
local sep = nil  -- value object
if not flag then
local out = {}  -- array with value objects
return false
local function walk(formatTable, result)
local valuesArray = {}  -- array with value objects
for i, v in pairs(formatTable.req) do
if not result[i] or not result[i][1] then
-- we've got no result for a parameter that is required on this level,
-- so skip this level (and its children) by returning an empty result
return {}
end
end
for i, v in ipairs(formatTable) do
if v.param then
valuesArray = mergeArrays(valuesArray, result[v.str])
elseif v.str ~= "" then
valuesArray[#valuesArray + 1] = {v.str}
end
if v.child then
valuesArray = mergeArrays(valuesArray, walk(v.child, result))
end
end
return valuesArray
end
end
 
-- iterate through the results from back to front, so that we know when to add separators
if flag == p.claimCommands.property or flag == p.claimCommands.properties then
for i = #self.results, 1, -1 do
param = parameters.property
result = self.results[i]
elseif flag == p.claimCommands.qualifier or flag == p.claimCommands.qualifiers then
self.states.qualifiersCount = self.states.qualifiersCount + 1
-- if there is already some output, then add the separators
param = parameters.qualifier .. self.states.qualifiersCount
if #out > 0 then
self.separators["sep"..param] = {copyTable(defaultSeparators["sep%q\\d"])}
sep = self.separator[1]  -- fixed separator
elseif flag == p.claimCommands.reference or flag == p.claimCommands.references then
result[parameters.separator] = {self.movSeparator[1]}  -- movable separator
param = parameters.reference
else
else
sep = nil
return self:processFlag(flag)
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 self.states[param] then
function State:getProperty(claim)
return false
local value = {self.conf:getValue(claim.mainsnak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)}  -- create one value object
if #value > 0 then
return {value}  -- wrap the value object in an array and return it
else
return {}  -- return empty array if there was no value
end
end
end


-- level 1 hook
-- create a new state for each command
function State:getQualifiers(claim, param)
self.states[param] = State:new(self, param)
local qualifiers
 
-- use "%x" as the general parameter name
if claim.qualifiers then qualifiers = claim.qualifiers[self.conf.qualifierIDs[param]] end
self.states[param].parsedFormat = parseFormat(parameters.general)  -- will be overwritten for param=="%p"
if qualifiers then
 
-- iterate through claim's qualifier statements to collect their values;
-- set the separator
-- return array with multiple value objects
self.states[param].separator = self.separators["sep"..param]  -- will be nil for param=="%p", which will be set separately
return self.conf.states[param]:iterate(qualifiers, {[parameters.general] = hookNames[parameters.qualifier.."\\d"][2], count = 1}) -- pass qualifier state with level 2 hook
 
else
if flag == p.claimCommands.property or flag == p.claimCommands.qualifier or flag == p.claimCommands.reference then
return {}  -- return empty array
self.states[param].singleValue = true
end
end
self.curState = self.states[param]
return true
end
end


-- level 2 hook
function Config:processSeparators(args)
function State:getQualifier(snak)
local sep
local value = {self.conf:getValue(snak, self.rawValue, self.linked, self.shortName, self.anyLanguage, self.unitOnly)}  -- create one value object
 
for i, v in pairs(self.separators) do
if #value > 0 then
if args[i] then
return {value} -- wrap the value object in an array and return it
sep = replaceSpecialChars(args[i])
else
 
return {}  -- return empty array if there was no value
if sep ~= "" then
self.separators[i][1] = {sep}
else
self.separators[i][1] = nil
end
end
end
end
end
end


-- level 1 hook
function Config:setFormatAndSeparators(state, parsedFormat)
function State:getAllQualifiers(claim, param, result, hooks)
state.parsedFormat = parsedFormat
local out = {}  -- array with value objects
state.separator = self.separators["sep"]
local sep = self.conf.separators["sep"..parameters.qualifier][1] -- value object
state.movSeparator = self.separators["sep"..parameters.separator]
state.puncMark = self.separators["punc"]
-- iterate through the output of the separate "qualifier(s)" commands
end
for i = 1, self.conf.states.qualifiersCount do
 
-- determines if a claim has references by prefetching them from the claim using getReferences,
-- if a hook has not been called yet, call it now
-- which applies some filtering that determines if a reference is actually returned,
if not result[parameters.qualifier..i] then
-- and caches the references for later use
self:callHook(parameters.qualifier..i, hooks, claim, result)
function State:isSourced(claim)
end
self.conf.prefetchedRefs = self:getReferences(claim)
return (#self.conf.prefetchedRefs > 0)
-- if there is output for this particular "qualifier(s)" command, then add it
end
if result[parameters.qualifier..i] and result[parameters.qualifier..i][1] then
 
function State:resetCaches()
-- if there is already some output, then add the separator
-- any prefetched references of the previous claim must not be used
if #out > 0 and sep then
self.conf.prefetchedRefs = nil
out[#out + 1] = sep
end
out = mergeArrays(out, result[parameters.qualifier..i])
end
end
return out
end
end


-- level 1 hook
function State:claimMatches(claim)
function State:getReferences(claim)
local matches, rankPos
if self.conf.prefetchedRefs then
 
-- return references that have been prefetched by isSourced
-- first of all, reset any cached values used for the previous claim
return self.conf.prefetchedRefs
self:resetCaches()
 
-- 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
 
if claim.references then
-- if any qualifier values were given, check if each matches one of the claim's qualifier values
-- iterate through claim's reference statements to collect their values;
for i, v in pairs(self.conf.qualifierIDsAndValues) do
-- return array with multiple value objects
matches = (matches and self.conf:qualifierMatches(claim, i, v))
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
-- check if the claim's rank and time period match
-- logic determined based on https://www.wikidata.org/wiki/Help:Sources
rankPos = rankTable[claim.rank] or 4
function State:getReference(statement)
matches = (matches and self.conf:rankMatches(rankPos) and self.conf:timeMatches(claim))
local language, referenceURL, title, statedIn, statedInRaw, template
 
local authors = {}
-- if only claims with references must be returned, check if this one has any
local params = {}
if self.conf.sourcedOnly then
local citeParams = {}
matches = (matches and self:isSourced(claim))  -- prefetches and caches references
local value = ""
end
local ref = {}
 
return matches, rankPos
-- 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;
end
-- these are parameters of properties other than "pages(s)" and "chapter" (for books) and "title" and "publication date" (for databases) and also "stated in"
 
local hasExtraParams = false
function State:out()
local result  -- collection of arrays with value objects
if statement.snaks then
local valuesArray  -- array with value objects
-- don't include "imported from", which has been added by a bot
local sep = nil  -- value object
if statement.snaks[p.aliasesP.importedFrom] then
local out = {}  -- array with value objects
statement.snaks[p.aliasesP.importedFrom] = nil
 
end
local function walk(formatTable, result)
local valuesArray = {}  -- array with value objects
-- not linked yet because we need the plain value for comparison first
 
language = self:getReferenceDetail(statement.snaks, p.aliasesP.language, false, false, false, true)  -- (noUnset = true)
for i, v in pairs(formatTable.req) do
if language then
if not result[i] or not result[i][1] then
-- not part of a "stated in"-source
-- we've got no result for a parameter that is required on this level,
hasExtraParams = true
-- so skip this level (and its children) by returning an empty result
return {}
-- only add language to the reference if it differs from the local one
if self.conf.langName ~= language then
if self.linked then
-- retrieve language again, but this time with link
params[p.aliasesP.language] = self:getReferenceDetail(statement.snaks, p.aliasesP.language, false, true) -- link = true
else
params[p.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[p.aliasesP.language] = nil
end
end
 
authors = self:getReferenceDetails(statement.snaks, p.aliasesP.author, false, self.linked)  -- link = true/false
for _, v in ipairs(formatTable) do
if #authors > 0 then
if v.param then
-- not part of a "stated in"-source
valuesArray = mergeArrays(valuesArray, result[v.str])
hasExtraParams = true
elseif v.str ~= "" then
end
valuesArray[#valuesArray + 1] = {v.str}
referenceURL = self:getReferenceDetail(statement.snaks, p.aliasesP.referenceURL)
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, p.aliasesP.title, false, false, true)  -- anyLang = true
statedIn = self:getReferenceDetail(statement.snaks, p.aliasesP.statedIn, false, true, false, true)  -- link = true, (noUnset = true)
-- get title of general template for citing web references
template = mw.wikibase.sitelink(aliasesQ.citeWeb) or ""
template = split(template, ":")[2]  -- split off namespace from front
-- (1) if both "reference URL" and "title" are present, then use the general template for citing web references
if referenceURL and title and template then
citeParams[i18n['cite']['url']]    = referenceURL
citeParams[i18n['cite']['title']]  = title
citeParams[i18n['cite']['website']] = statedIn
citeParams[i18n['cite']['language']] = params[p.aliasesP.language]
citeParams[i18n['cite']['date']]        = self:getReferenceDetail(statement.snaks, p.aliasesP.publicationDate)
citeParams[i18n['cite']['access-date']]  = self:getReferenceDetail(statement.snaks, p.aliasesP.retrieved)
citeParams[i18n['cite']['archive-url']] = self:getReferenceDetail(statement.snaks, p.aliasesP.archiveURL)
citeParams[i18n['cite']['archive-date']] = self:getReferenceDetail(statement.snaks, p.aliasesP.archiveDate)
citeParams[i18n['cite']['publisher']]    = self:getReferenceDetail(statement.snaks, p.aliasesP.publisher, false, self.linked)  -- link = true/false
citeParams[i18n['cite']['quote']]        = self:getReferenceDetail(statement.snaks, p.aliasesP.quote, false, false, true)  -- anyLang = true
citeParams[i18n['cite']['pages']]        = self:getReferenceDetail(statement.snaks, p.aliasesP.pages)
for i, v in ipairs(authors) do
citeParams[i18n['cite']['author']..i] = v
end
end
 
-- if this module is being substituted then build a regular template call, otherwise expand the template
if v.child then
if mw.isSubsting() then
valuesArray = mergeArrays(valuesArray, walk(v.child, result))
for i, v in pairs(citeParams) do
value = value .. "|" .. i .. "=" .. v
end
value = "{{" .. template .. value .. "}}"
else
value = mw.getCurrentFrame():expandTemplate{title=template, args=citeParams}
end
else
-- we need the raw Q-identifier for the next template
statedInRaw = self:getReferenceDetail(statement.snaks, p.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[p.aliasesP.pages]          = self:getReferenceDetail(statement.snaks, p.aliasesP.pages)
params[p.aliasesP.chapter]        = self:getReferenceDetail(statement.snaks, p.aliasesP.chapter)
params[p.aliasesP.publicationDate] = self:getReferenceDetail(statement.snaks, p.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
-- get title of template that expands a given stated-in item
template = mw.wikibase.sitelink(aliasesQ.citeQ) or ""
template = split(template, ":")[2]  -- split off namespace from front
-- (2) if "stated in" is present without any parameters not belonging to a "stated in"-source, then use the template that expands the stated-in item
if statedInRaw and not hasExtraParams and template then
citeParams[i18n['cite']['pages-q']] = params[p.aliasesP.pages]
citeParams[i18n['cite']['chapter']] = params[p.aliasesP.chapter]
citeParams[i18n['cite']['date-q']]  = params[p.aliasesP.publicationDate]
if mw.isSubsting() then
for i, v in pairs(citeParams) do
value = value .. "|" .. i .. "=" .. v
end
value = "{{" .. template .. "|" .. statedInRaw .. value .. "}}"
else
citeParams[1] = statedInRaw
value = mw.getCurrentFrame():expandTemplate{title=template, args=citeParams}
end
-- (3) else, do some default rendering of name-value pairs, but only if at least "stated in" or "reference URL" is present
elseif statedIn or referenceURL then
-- authors were already retrieved; start by adding them up front
if #authors > 0 then
citeParams[#citeParams + 1] = table.concat(authors, " & ")
end
-- 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
end
end
 
if value ~= "" then
return valuesArray
value = {value}  -- create one value object
end
 
if not self.rawValue then
-- iterate through the results from back to front, so that we know when to add separators
-- this should become a <ref> tag, so safe the reference's hash for later
for i = #self.results, 1, -1 do
value.refHash = statement.hash
result = self.results[i]
 
-- if there is already some output, then add the separators
if #out > 0 then
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
end
 
ref = {value}  -- wrap the value object in an array
out = mergeArrays(valuesArray, out)
end
end
end
end
 
return ref
-- reset state before next iteration
self.results = {}
 
return out
end
end


-- gets a detail of one particular type for a reference
-- level 1 hook
function State:getReferenceDetail(snaks, dType, raw, link, anyLang, noUnset)
function State:getProperty(claim)
raw = raw or false
local value = {self:getValue(claim.mainsnak)}  -- create one value object
link = link or false
 
anyLang = anyLang or false
if #value > 0 then
noUnset = noUnset or false
return {value}  -- wrap the value object in an array and return it
else
local switchLang = anyLang
return {}  -- return empty array if there was no value
local value = nil
if not snaks[dType] then
return nil
end
end
end
-- if anyLang, first try the local language and otherwise any language
 
repeat
-- level 1 hook
for i, v in ipairs(snaks[dType]) do
function State:getQualifiers(claim, param)
value = self.conf:getValue(v, raw, link, false, anyLang and not switchLang, false, true) -- noSpecial = true
local qualifiers
if value then
break
end
end
if value or not anyLang then
break
end
switchLang = not switchLang
until anyLang and switchLang
if not noUnset then
-- remove detail(s) to make it possible to get the rest of the details in one loop
snaks[dType] = nil
end
return value
end


-- gets the details of one particular type for a reference
if claim.qualifiers then qualifiers = claim.qualifiers[self.conf.qualifierIDs[param]] end
function State:getReferenceDetails(snaks, dType, raw, link, anyLang, noUnset)
if qualifiers then
raw = raw or false
-- iterate through claim's qualifier statements to collect their values;
link = link or false
-- return array with multiple value objects
anyLang = anyLang or false
return self.conf.states[param]:iterate(qualifiers, {[parameters.general] = hookNames[parameters.qualifier.."\\d"][2], count = 1})  -- pass qualifier state with level 2 hook
noUnset = noUnset or false
else
return {}  -- return empty array
local values = {}
if not snaks[dType] then
return {}
end
for i, v in ipairs(snaks[dType]) do
-- if nil is returned then it will not be added to the table
values[#values + 1] = self.conf:getValue(v, raw, link, false, anyLang, false, true)  -- noSpecial = true
end
end
if not noUnset then
-- remove detail(s) to make it possible to get the rest of the details in one loop
snaks[dType] = nil
end
return values
end
end


-- level 1 hook
-- level 2 hook
function State:getAlias(object)
function State:getQualifier(snak)
local value = object.value
local value = {self:getValue(snak)}  -- create one value object
local title = nil
 
if value and self.linked then
if self.conf.entityID:sub(1,1) == "Q" then
title = mw.wikibase.sitelink(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
if #value > 0 then
return {value}  -- wrap the value object in an array and return it
return {value}  -- wrap the value object in an array and return it
1,974行目: 1,757行目:
end
end


function State:callHook(param, hooks, statement, result)
-- level 1 hook
local valuesArray, refHash
function State:getAllQualifiers(claim, param, result, hooks)
local out = {}  -- array with value objects
-- call a parameter's hook if it has been defined and if it has not been called before
local sep = self.conf.separators["sep"..parameters.qualifier][1]  -- value object
if not result[param] and hooks[param] then
 
valuesArray = self[hooks[param]](self, statement, param, result, hooks) -- array with value objects
-- iterate through the output of the separate "qualifier(s)" commands
for i = 1, self.conf.states.qualifiersCount do
-- add to the result
 
if #valuesArray > 0 then
-- if a hook has not been called yet, call it now
result[param] = valuesArray
if not result[parameters.qualifier..i] then
result.count = result.count + 1
self:callHook(parameters.qualifier..i, hooks, claim, result)
else
end
result[param] = {}  -- an empty array to indicate that we've tried this hook already
 
return true  -- miss == true
-- 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
end
 
return false
return out
end
end


-- iterate through claims, claim's qualifiers or claim's references to collect values
-- level 1 hook
function State:iterate(statements, hooks, matchHook)
function State:getReferences(claim)
matchHook = matchHook or alwaysTrue
if self.conf.prefetchedRefs then
-- return references that have been prefetched by isSourced
local matches = false
return self.conf.prefetchedRefs
local rankPos = nil
end
local result, gotRequired
 
if claim.references then
for i, v in ipairs(statements) do
-- iterate through claim's reference statements to collect their values;
-- rankPos will be nil for non-claim statements (e.g. qualifiers, references, etc.)
-- return array with multiple value objects
matches, rankPos = matchHook(self, v)
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
if matches then
return {}  -- return empty array
result = {count = 0}  -- collection of arrays with value objects
end
end
local function walk(formatTable)
 
local miss
-- level 2 hook
function State:getReference(statement)
for i2, v2 in pairs(formatTable.req) do
local key, citeWeb, citeQ, label
-- call a hook, adding its return value to the result
local params = {}
miss = self:callHook(i2, hooks, v, result)
local citeParams = {['web'] = {}, ['q'] = {}}
local citeMismatch = {}
if miss then
local useCite = nil
-- we miss a required value for this level, so return false
local useParams = nil
return false
local value = ""
end
local ref = {}
 
if result.count == hooks.count then
local version = 1  -- increment this each time the below logic is changed to avoid conflict errors
-- we're done if all hooks have been called;
 
-- returning at this point breaks the loop
if statement.snaks then
return true
-- don't include "imported from", which is added by a bot
if statement.snaks[aliasesP.importedFrom] then
statement.snaks[aliasesP.importedFrom] = nil
end
 
-- don't include "inferred from", which is added by a bot
if statement.snaks[aliasesP.inferredFrom] then
statement.snaks[aliasesP.inferredFrom] = nil
end
 
-- don't include "type of reference"
if statement.snaks[aliasesP.typeOfReference] then
statement.snaks[aliasesP.typeOfReference] = nil
end
 
-- don't include "image" to prevent littering
if statement.snaks[aliasesP.image] then
statement.snaks[aliasesP.image] = nil
end
 
-- don't include "language" if it is equal to the local one
if self:getReferenceDetail(statement.snaks, aliasesP.language) == self.conf.langName then
statement.snaks[aliasesP.language] = nil
end
 
-- retrieve all the parameters
for i in pairs(statement.snaks) do
label = ""
 
-- multiple authors may be given
if i == aliasesP.author then
params[i] = self:getReferenceDetails(statement.snaks, i, false, self.linked, true) -- link = true/false, anyLang = true
else
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
end
 
if #params[i] == 0 then
params[i] = nil
else
if statement.snaks[i][1].datatype == 'external-id' then
key = "external-id"
label = self.conf:getLabel(i)
 
if label ~= "" then
label = label .. " "
end
end
else
key = i
end
end
 
for i2, v2 in ipairs(formatTable) do
-- add the parameter to each matching type of citation
if result.count == hooks.count then
for j in pairs(citeParams) do
-- we're done if all hooks have been called;
-- do so if there was no mismatch with a previous parameter
-- returning at this point prevents further childs from being processed
if not citeMismatch[j] then
return true
-- check if this parameter is not mismatching itself
end
if i18n['cite'][j][key] then
-- continue if an option is available in the corresponding cite template
if v2.child then
if i18n['cite'][j][key] ~= "" then
walk(v2.child)
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
return true
end
end
gotRequired = walk(self.parsedFormat)
end
 
-- only append the result if we got values for all required parameters on the root level
-- get title of general template for citing web references
if gotRequired then
citeWeb = split(mw.wikibase.getSitelink(aliasesQ.citeWeb) or "", ":")[2]  -- split off namespace from front
-- if we have a rankPos (only with matchHook() for complete claims), then update the foundRank
 
if rankPos and self.conf.foundRank > rankPos then
-- get title of template that expands stated-in references into citations
self.conf.foundRank = rankPos
citeQ = split(mw.wikibase.getSitelink(aliasesQ.citeQ) or "", ":")[2]  -- split off namespace from front
end
 
-- (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
-- append the result
if citeWeb and not citeMismatch['web'] and citeParams['web'][i18n['cite']['web'][aliasesP.referenceURL]] and citeParams['web'][i18n['cite']['web'][aliasesP.title]] then
self.results[#self.results + 1] = result
useCite = citeWeb
useParams = citeParams['web']
-- break if we only need a single value
 
if self.singleValue then
-- (2) use the template that expands stated-in references into citations if there is a match and if at least "stated in" is present
break
elseif citeQ and not citeMismatch['q'] and citeParams['q'][i18n['cite']['q'][aliasesP.statedIn]] then
-- 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
 
useCite = citeQ
useParams = citeParams['q']
end
 
if useCite and useParams then
-- 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(useParams) do
value = value .. "|" .. i .. "=" .. v
end
end
value = "{{" .. useCite .. value .. "}}"
else
value = mw.getCurrentFrame():expandTemplate{title=useCite, args=useParams}
end
end
end
end
return self:out()
end


function p.property(frame)
-- (3) else, do some default rendering of name-value pairs, but only if at least "stated in", "reference URL" or "title" is present
loadSubmodules(frame)
elseif params[aliasesP.statedIn] or params[aliasesP.referenceURL] or params[aliasesP.title] then
return p._property(copyTable(frame.args))
citeParams['default'] = {}
end


function p._property(args)
-- start by adding authors up front
loadSubmodules()
if params[aliasesP.author] and #params[aliasesP.author] > 0 then
return valueCommand(args, p.commands.property)
citeParams['default'][#citeParams['default'] + 1] = table.concat(params[aliasesP.author], " & ")
end
end


function p.properties(frame)
-- combine "reference URL" and "title" into one link if both are present
loadSubmodules(frame)
if params[aliasesP.referenceURL] and params[aliasesP.title] then
return p._properties(copyTable(frame.args))
citeParams['default'][#citeParams['default'] + 1] = '[' .. params[aliasesP.referenceURL][1] .. ' "' .. params[aliasesP.title][1] .. '"]'
end
elseif params[aliasesP.referenceURL] then
citeParams['default'][#citeParams['default'] + 1] = params[aliasesP.referenceURL][1]
elseif params[aliasesP.title] then
citeParams['default'][#citeParams['default'] + 1] = '"' .. params[aliasesP.title][1] .. '"'
end


function p._properties(args)
-- then add "stated in"
loadSubmodules()
if params[aliasesP.statedIn] then
return valueCommand(args, p.commands.properties)
citeParams['default'][#citeParams['default'] + 1] = "''" .. params[aliasesP.statedIn][1] .. "''"
end
end


function p.qualifier(frame)
-- remove previously added parameters so that they won't be added a second time
loadSubmodules(frame)
params[aliasesP.author] = nil
return p._qualifier(copyTable(frame.args))
params[aliasesP.referenceURL] = nil
end
params[aliasesP.title] = nil
params[aliasesP.statedIn] = nil


function p._qualifier(args)
-- add the rest of the parameters
loadSubmodules()
for i, v in pairs(params) do
return valueCommand(args, p.commands.qualifier)
i = self.conf:getLabel(i)
end


function p.qualifiers(frame)
if i ~= "" then
loadSubmodules(frame)
citeParams['default'][#citeParams['default'] + 1] = i .. ": " .. v[1]
return p._qualifiers(copyTable(frame.args))
end
end
end
 
value = table.concat(citeParams['default'], "; ")
 
if value ~= "" then
value = value .. "."
end
end


function p._qualifiers(args)
if value ~= "" then
loadSubmodules()
value = {value}  -- create one value object
return valueCommand(args, p.commands.qualifiers)
end


function p.reference(frame)
if not self.rawValue then
loadSubmodules(frame)
-- this should become a <ref> tag, so save the reference's hash for later
return p._reference(copyTable(frame.args))
value.refHash = "wikidata-" .. statement.hash .. "-v" .. (tonumber(i18n['cite']['version']) + version)
end
end


function p._reference(args)
ref = {value}  -- wrap the value object in an array
loadSubmodules()
end
return valueCommand(args, p.commands.reference)
end
end


function p.references(frame)
return ref
loadSubmodules(frame)
return p._references(copyTable(frame.args))
end
end


function p._references(args)
-- gets a detail of one particular type for a reference
loadSubmodules()
function State:getReferenceDetail(snaks, dType, raw, link, anyLang)
return valueCommand(args, p.commands.references)
local switchLang = anyLang
end
local value = nil


function valueCommand(args, funcName)
if not snaks[dType] then
local _ = Config.new()
return nil
_:processFlagOrCommand(funcName)  -- process first command (== function name)
local parsedFormat, formatParams, claims, sep, value
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
end
 
if nextArg then
-- if anyLang, first try the local language and otherwise any language
nextArg = mw.text.trim(nextArg)
repeat
else
for _, v in ipairs(snaks[dType]) do
nextArg = ""
value = self.conf:getValue(v, raw, link, false, anyLang and not switchLang, false, true)  -- noSpecial = true
end
 
if value then
-- check for optional entity ID of either item or property
break
if nextArg:sub(1,1):upper() == "Q" then
_.entityID = nextArg:upper()  -- entity ID of an item was given
_.entity = mw.wikibase.getEntity(_.entityID)  -- get the item-entity based on the given ID
_.propertyID = mw.text.trim(args[nextIndex] or "")  -- property ID
nextIndex = nextIndex + 1
elseif nextArg:sub(1,9):lower() == "property:" then
_.entityID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper()  -- entity ID of a property was given
_.entity = mw.wikibase.getEntity(_.entityID)  -- get the property-entity based on the given ID
_.propertyID = mw.text.trim(args[nextIndex] or "") -- property ID
nextIndex = nextIndex + 1
else
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
if args[p.args.eid] then
if args[p.args.eid]:sub(1,1):upper() == "Q" then
_.entityID = args[p.args.eid]:upper()   
elseif args[p.args.eid]:sub(1,9):lower() == "property:" then
_.entityID = replaceAlias(mw.text.trim(args[p.args.eid]:sub(10))):upper()
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
_.entityID = replaceAlias(args[p.args.eid]):upper()
if _.entityID == "" then
-- explicitly return if value for 'eid' is empty
return ""
end
end
end
else
_.entityID = mw.wikibase.getEntityIdForCurrentPage()  -- by default, use item-entity connected to current page
end
end
 
_.entity = mw.wikibase.getEntity(_.entityID)
if value or not anyLang then
_.propertyID = nextArg  -- property ID
break
end
-- check if given property ID is an alias
_.propertyID = replaceAlias(_.propertyID):upper()
if _.states.qualifiersCount > 0 then
-- do further processing if "qualifier(s)" command was given
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
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
end
 
-- check for special property value 'somevalue' or 'novalue'
return values
if _.propertyValue then
end
_.propertyValue = replaceSpecialChars(_.propertyValue)
 
-- level 1 hook
if _.propertyValue ~= "" and mw.text.trim(_.propertyValue) == "" then
function State:getAlias(object)
_.propertyValue = " " -- single space represents 'somevalue', whereas empty string represents 'novalue'
local value = object.value
else
local title = nil
_.propertyValue = mw.text.trim(_.propertyValue)
 
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
end
end
 
-- parse the desired format, or choose an appropriate format
value = {value}  -- create one value object
if args["format"] then
 
parsedFormat, formatParams = parseFormat(args["format"])
if #value > 0 then
elseif _.states.qualifiersCount > 0 then -- "qualifier(s)" command given
return {value} -- wrap the value object in an array and return it
if _.states[parameters.property] then -- "propert(y|ies)" command given
else
parsedFormat, formatParams = parseFormat(formats.propertyWithQualifier)
return {} -- return empty array if there was no value
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 1 hook
_.separators["sep"..parameters.separator][1] = {";"}
function State:getBadge(value)
value = self.conf:getLabel(value, self.rawValue, self.linked, self.shortName)
 
if value == "" then
value = nil
end
end
 
-- if only "reference(s)" has been given, set the default separator to none (except when raw)
value = {value}  -- create one value object
if _.states[parameters.reference] and not _.states[parameters.property] and _.states.qualifiersCount == 0
 
  and not _.states[parameters.reference].rawValue then
if #value > 0 then
_.separators["sep"][1] = nil
return {value}  -- wrap the value object in an array and return it
end
else
return {}  -- return empty array if there was no value
-- if exactly one "qualifier(s)" command has been given, make "sep%q" point to "sep%q1" to make them equivalent;
end
-- must come BEFORE overriding the separator values
end
if _.states.qualifiersCount == 1 then
 
_.separators["sep"..parameters.qualifier] = _.separators["sep"..parameters.qualifier.."1"]
function State:callHook(param, hooks, statement, result)
end
local valuesArray, refHash
 
-- process overridden separator values;
-- call a parameter's hook if it has been defined and if it has not been called before
-- must come AFTER parsing the format
if not result[param] and hooks[param] then
for i, v in pairs(_.separators) do
valuesArray = self[hooks[param]](self, statement, param, result, hooks)  -- array with value objects
if args[i] then
 
sep = replaceSpecialChars(args[i])
-- add to the result
if #valuesArray > 0 then
if sep ~= "" then
result[param] = valuesArray
_.separators[i][1] = {sep}
result.count = result.count + 1
else
else
_.separators[i][1] = nil
result[param] = {}  -- an empty array to indicate that we've tried this hook already
end
return true  -- miss == true
end
end
end
end
-- define the hooks that should be called (getProperty, getQualifiers, getReferences);
-- only define a hook if both its command ("propert(y|ies)", "reference(s)", "qualifier(s)") and its parameter ("%p", "%r", "%q1", "%q2", "%q3") have been given
for i, v in pairs(_.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 _.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
-- 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 _.sourcedOnly and not _.states[parameters.reference] then
_:processFlagOrCommand(p.commands.reference)  -- use singular "reference" to minimize overhead
end
-- set the parsed format and the separators (and optional punctuation mark)
_.states[parameters.property].parsedFormat = parsedFormat
_.states[parameters.property].separator = _.separators["sep"]
_.states[parameters.property].movSeparator = _.separators["sep"..parameters.separator]
_.states[parameters.property].puncMark = _.separators["punc"]
-- process qualifier matching values, analogous to _.propertyValue
for i, v in pairs(args) do
i = tostring(i)
if i:match('^[Pp]%d+$') or p.aliasesP[i] then
v = replaceSpecialChars(v)
-- check for special qualifier value 'somevalue'
if v ~= "" and mw.text.trim(v) == "" then
v = " "  -- single space represents 'somevalue'
end
_.qualifierIDsAndValues[replaceAlias(i):upper()] = v
end
end
if _.entity and _.entity.claims then claims = _.entity.claims[_.propertyID] end
if claims then
-- first sort the claims on rank to pre-define the order of output (preferred first, then normal, then deprecated)
claims = sortOnRank(claims)
-- then iterate through the claims to collect values
value = _:concatValues(_.states[parameters.property]:iterate(claims, hooks, State.claimMatches))  -- pass property state with level 1 hooks and matchHook
-- if desired, add a clickable icon that may be used to edit the returned values on Wikidata
if _.editable and value ~= "" then
value = value .. _:getEditIcon()
end
return value
else
return ""
end
end


function p.label(frame)
return false
loadSubmodules(frame)
end
return p._label(copyTable(frame.args))
 
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


function p._label(args)
for i2, v2 in pairs(formatTable.req) do
loadSubmodules()
-- call a hook, adding its return value to the result
return nameCommand(args, p.commands.label)
miss = self:callHook(i2, hooks, v, result)
end


function p.title(frame)
if miss then
loadSubmodules(frame)
-- we miss a required value for this level, so return false
return p._title(copyTable(frame.args))
return false
end
end


function p._title(args)
if result.count == hooks.count then
loadSubmodules()
-- we're done if all hooks have been called;
return nameCommand(args, p.commands.title)
-- returning at this point breaks the loop
end
return true
end
end


function p.alias(frame)
for _, v2 in ipairs(formatTable) do
loadSubmodules(frame)
if result.count == hooks.count then
return p._alias(copyTable(frame.args))
-- we're done if all hooks have been called;
end
-- returning at this point prevents further childs from being processed
return true
end


function p._alias(args)
if v2.child then
loadSubmodules()
walk(v2.child)
return nameCommand(args, p.commands.alias)
end
end
end


function p.aliases(frame)
return true
loadSubmodules(frame)
end
return p._aliases(copyTable(frame.args))
gotRequired = walk(self.parsedFormat)
end
 
-- 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


function p._aliases(args)
-- append the result
loadSubmodules()
self.results[#self.results + 1] = result
return nameCommand(args, p.commands.aliases)
end


function nameCommand(args, funcName)
-- break if we only need a single value
local _ = Config.new()
if self.singleValue then
_.curState = State.new(_)
break
local ID = nil
local value = nil
local nextArg = args[1]
local nextIndex = 2
while _:processFlag(nextArg) do
nextArg = args[nextIndex]
nextIndex = nextIndex + 1
end
if nextArg then
nextArg = mw.text.trim(nextArg)
else
nextArg = ""
end
-- check for optional entity ID of either item or property
if nextArg:sub(1,1):upper() == "Q" then
ID = nextArg:upper()  -- entity ID of an item was given
elseif nextArg:sub(1,9):lower() == "property:" then
ID = replaceAlias(mw.text.trim(nextArg:sub(10))):upper()  -- entity ID of a property was given
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
ID = replaceAlias(nextArg):upper()
if ID:sub(1,1) ~= "P" then
if ID == "" then
-- no positional entity ID was given, so get entity ID from 'eid' if it was given
if args[p.args.eid] then
if args[p.args.eid]:sub(1,1):upper() == "Q" then
ID = args[p.args.eid]:upper() 
elseif args[p.args.eid]:sub(1,9):lower() == "property:" then
ID = replaceAlias(mw.text.trim(args[p.args.eid]:sub(10))):upper()
else
-- might be entity ID of a property, or a bogus entity ID that will fail later on
ID = replaceAlias(args[p.args.eid]):upper()
if ID == "" then
-- explicitly return if value for 'eid' is empty
return ""
end
end
else
ID = nil
end
end
end
end
end
end
end
end
 
if ID then
return self:out()
_.entityID = ID
end
else
 
_.entityID = mw.wikibase.getEntityIdForCurrentPage()
local function getEntityId(arg, eid, page, allowOmitPropPrefix)
end
local id = nil
local prop = nil
-- serve according to the given command
 
if funcName == p.commands.label then
if arg then
value = _:getLabel(ID, _.curState.rawValue, _.curState.linked, _.curState.shortName)
if arg:sub(1,1) == ":" then
elseif funcName == p.commands.title then
page = arg
_.pageTitle = true
eid = nil
elseif arg:sub(1,1):upper() == "Q" or arg:sub(1,9):lower() == "property:" or allowOmitPropPrefix then
if not ID then
eid = arg
value = mw.title.getCurrentTitle().prefixedText
page = nil
elseif ID:sub(1,1) == "Q" then
else
value = mw.wikibase.sitelink(ID)
prop = arg
end
end
end
if _.curState.linked and value then
 
value = buildWikilink(value)
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
end
elseif funcName == p.commands.alias or funcName == p.commands.aliases then
elseif page then
local aliases, parsedFormat, formatParams, sep
if page:sub(1,1) == ":" then
local hooks = {count = 0}
page = mw.text.trim(page:sub(2))
if funcName == p.commands.alias then
_.curState.singleValue = true
end
end
-- 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 parsing the format
for i, v in pairs(_.separators) do
if args[i] then
sep = replaceSpecialChars(args[i])
if sep ~= "" then
_.separators[i][1] = {sep}
else
_.separators[i][1] = nil
end
end
end
-- define the 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)
_.curState.parsedFormat = parsedFormat
_.curState.separator = _.separators["sep"]
_.curState.movSeparator = _.separators["sep"..parameters.separator]
_.curState.puncMark = _.separators["punc"]
_.entity = mw.wikibase.getEntity(ID)
if _.entity and _.entity.aliases then aliases = _.entity.aliases[_.langCode] end
if aliases then
value = _:concatValues(_.curState:iterate(aliases, hooks))
end
end
value = value or ""
if _.editable and value ~= "" then
-- if desired, add a clickable icon that may be used to edit the returned value on Wikidata
value = value .. _:getEditIcon()
end
return value
end


-- main function that is supposed to be used by wrapper templates
id = mw.wikibase.getEntityIdForTitle(page) or ""
function p.main(frame)
end
local f, args, i, v
 
if not id then
loadSubmodules(frame)
id = mw.wikibase.getEntityIdForCurrentPage() or ""
end
-- get the parent frame to take the arguments that were passed to the wrapper template
 
frame = frame:getParent() or frame
id = id:upper()
 
if not frame.args[1] then
if not mw.wikibase.isValidEntityId(id) then
error(i18n["errors"]["no-function-specified"])
id = ""
end
end
 
f = mw.text.trim(frame.args[1])
return id, prop
end
if f == "main" then
 
error(i18n["errors"]["main-called-twice"])
local function nextArg(args)
end
local arg = args[args.pointer]
 
assert(p["_"..f], applyStringParams(i18n['errors']['no-such-function'], f))
if arg then
args.pointer = args.pointer + 1
-- copy arguments from immutable to mutable table
return mw.text.trim(arg)
args = copyTable(frame.args)
else
return nil
-- remove the function name from the list
end
table.remove(args, 1)
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)
 
return p["_"..f](args)
return p["_"..f](args)
end
end


return p
return p