Modul:Wikidata utilities: Unterschied zwischen den Versionen
K (Änderte den Schutzstatus für „Modul:Wikidata utilities“ ([Bearbeiten=Nur Administratoren erlauben] (unbeschränkt) [Verschieben=Nur Administratoren erlauben] (unbeschränkt))) |
K (89 Versionen von wikivoyage:Modul:Wikidata_utilities importiert) |
||
(21 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 4: | Zeile 4: | ||
local WikidataUtilities = { | local WikidataUtilities = { | ||
suite = 'WikidataUtilities', | suite = 'WikidataUtilities', | ||
serial = ' | serial = '2022-09-04', | ||
item = 65439025 | item = 65439025 | ||
} | } | ||
Zeile 10: | Zeile 10: | ||
-- i18n | -- i18n | ||
local wd = { | local wd = { | ||
version = 'P348', | version = 'P348', | ||
retrieved = 'P813', | |||
Gregorian = 'Q12138', -- calendar models | Gregorian = 'Q12138', -- calendar models | ||
prolepticGregorian = 'Q1985727' | prolepticGregorian = 'Q1985727' | ||
} | } | ||
-- module variable | -- module variable and administration | ||
local wu = {} | local wu = { | ||
moduleInterface = WikidataUtilities | |||
} | |||
-- table storing property ids used | -- table storing property ids used | ||
Zeile 65: | Zeile 68: | ||
end | end | ||
function wu.getLabel( entity, lang ) | function wu.getLabel( entity, lang, noFallback ) | ||
if not isSet( entity ) then | if not isSet( entity ) then | ||
return nil | return nil | ||
end | end | ||
local tp = type( entity ) | |||
if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then | |||
return isSet( lang ) and mw.wikibase.getLabelByLang( entity, lang ) | return isSet( lang ) and mw.wikibase.getLabelByLang( entity, lang ) | ||
or mw.wikibase.getLabel( entity ) | or ( not noFallback and mw.wikibase.getLabel( entity ) ) | ||
elseif tp == 'table' and entity.labels then | |||
return isSet( lang ) and entity:getLabel( lang ) or entity:getLabel() | return isSet( lang ) and entity:getLabel( lang ) | ||
or ( not noFallback and entity:getLabel() ) | |||
else | |||
return nil | |||
end | end | ||
end | end | ||
Zeile 81: | Zeile 88: | ||
return nil | return nil | ||
end | end | ||
local tp = type( entity ) | |||
if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then | |||
return mw.wikibase.getSitelink( entity, globalSiteId ) | |||
elseif tp == 'table' and entity.labels then | |||
return | return entity:getSitelink( globalSiteId ) | ||
else | |||
return nil | |||
end | end | ||
end | end | ||
function wu.getSitelinkTable( entity, globalSiteId ) | |||
if not isSet( entity ) or not isSet( globalSiteId ) then | |||
return nil | |||
elseif type( entity ) == 'string' then -- entity is id | |||
entity = mw.wikibase.getEntity( entity ) | |||
end | |||
if entity and entity.sitelinks then | |||
return entity.sitelinks[ globalSiteId ] | |||
else | |||
return nil | |||
end | |||
end | |||
-- convert from url to Q id | -- convert from url to Q id | ||
Zeile 118: | Zeile 140: | ||
function wu.getBestStatements( entity, p ) | function wu.getBestStatements( entity, p ) | ||
local tp = type( entity ) | |||
if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then | |||
return mw.wikibase.getBestStatements( entity, p ) | return mw.wikibase.getBestStatements( entity, p ) | ||
elseif tp == 'table' and entity.labels then | |||
return entity:getBestStatements( p ) | |||
else | else | ||
return | return {} | ||
end | end | ||
end | end | ||
Zeile 190: | Zeile 215: | ||
function wu.getValuesByLang( entity, p, count, lang ) | function wu.getValuesByLang( entity, p, count, lang ) | ||
local ar = {} | local ar = {} | ||
local statements = wu.getStatements( entity, p | local statements = wu.getStatements( entity, p ) | ||
if #statements > 0 then | if #statements > 0 then | ||
local value | local value | ||
Zeile 197: | Zeile 222: | ||
if value.language and lang == value.language then | if value.language and lang == value.language then | ||
table.insert( ar, value.text ) | table.insert( ar, value.text ) | ||
end | |||
if count and #ar >= count then | |||
break | |||
end | end | ||
end | end | ||
Zeile 239: | Zeile 267: | ||
if #statements > 0 then | if #statements > 0 then | ||
catTable[ p ] = '' | catTable[ p ] = '' | ||
local id, value | local id, statement, value | ||
for | for i = 1, #statements do | ||
statement = statements[ i ] | |||
-- defaultId is used if a qualifier is missing | -- defaultId is used if a qualifier is missing | ||
id = defaultId | id = defaultId | ||
Zeile 249: | Zeile 278: | ||
id = qualifier.datavalue.value.id | id = qualifier.datavalue.value.id | ||
if id then | if id then | ||
catTable[ qualifierP ] = '' | |||
break | break | ||
end | end | ||
Zeile 295: | Zeile 325: | ||
-- {} : using no qualifiers/references | -- {} : using no qualifiers/references | ||
-- nil : using all qualifiers/references | -- nil : using all qualifiers/references | ||
function wu.getValuesWithQualifiers( entity, p, qualifiers, references, count, | function wu.getValuesWithQualifiers( entity, p, values, qualifiers, references, | ||
count, labelFct, ... ) | |||
local array | local array, qual | ||
local function toQualifierTable( tab, key, qualTab, labelFct, ... ) | local function toQualifierTable( tab, key, qualTab, labelFct, ... ) | ||
local v | local v | ||
Zeile 303: | Zeile 333: | ||
tab[ key ] = {} | tab[ key ] = {} | ||
end | end | ||
for | for i = 1, #qualTab do | ||
qual = qualTab[ i ] | |||
if qual.snaktype == 'value' then | if qual.snaktype == 'value' then | ||
v, tab[ key .. '-type' ] = | v, tab[ key .. '-type' ] = | ||
Zeile 316: | Zeile 347: | ||
catTable[ key ] = '' | catTable[ key ] = '' | ||
end | end | ||
end | |||
local function hasValue( tab, val ) | |||
for i = 1, #tab do | |||
if tab[ i ] == val then | |||
return true | |||
end | |||
end | |||
return false | |||
end | end | ||
Zeile 322: | Zeile 361: | ||
if #statements == 0 then | if #statements == 0 then | ||
return results | return results | ||
end | |||
local i, v | |||
if type( values ) == 'table' and #values > 0 then | |||
for i = #statements, 1, -1 do | |||
v = statements[ i ].mainsnak.datavalue.value | |||
if type( v ) ~= 'string' then | |||
v = v.id | |||
end | |||
if not isSet( v ) or not hasValue( values, v ) then | |||
table.remove( statements, i ) | |||
end | |||
end | |||
if #statements == 0 then | |||
return results | |||
end | |||
end | end | ||
catTable[ p ] = '' | catTable[ p ] = '' | ||
Zeile 332: | Zeile 386: | ||
end | end | ||
for | local key, reference, statement | ||
for i = 1, #statements do | |||
statement = statements[ i ] | |||
array = { value = analyzeDatavalue( statement.mainsnak.datavalue, labelFct, ... ), | array = { value = analyzeDatavalue( statement.mainsnak.datavalue, labelFct, ... ), | ||
[ 'value-type' ] = statement.mainsnak.datavalue.type } | [ 'value-type' ] = statement.mainsnak.datavalue.type } | ||
Zeile 342: | Zeile 398: | ||
end | end | ||
else -- table of selected qualifier properties | else -- table of selected qualifier properties | ||
for | for j = 1, #qualifiers do | ||
key = qualifiers[ j ] | |||
if statement.qualifiers[ key ] then | if statement.qualifiers[ key ] then | ||
toQualifierTable( array, key, statement.qualifiers[ key ], labelFct, ... ) | toQualifierTable( array, key, statement.qualifiers[ key ], labelFct, ... ) | ||
Zeile 352: | Zeile 409: | ||
array.references = {} | array.references = {} | ||
if statement.references then | if statement.references then | ||
for | for k = 1, #statement.references do | ||
reference = statement.references[ k ] | |||
if reference and reference.snaks then | if reference and reference.snaks then | ||
table.insert( array.references, {} ) | table.insert( array.references, {} ) | ||
Zeile 361: | Zeile 419: | ||
end | end | ||
else -- table of selected references | else -- table of selected references | ||
for | for j = 1, #references do | ||
key = references[ j ] | |||
if reference.snaks[ key ] then | if reference.snaks[ key ] then | ||
toQualifierTable( array.references[ #array.references ], | toQualifierTable( array.references[ #array.references ], | ||
Zeile 379: | Zeile 438: | ||
local sort1 = 0 | local sort1 = 0 | ||
local mult = false | local mult = false | ||
for | local result | ||
for i = 1, #results do | |||
result = results[ i ] | |||
if helper[ result.value ] then | if helper[ result.value ] then | ||
helper[ result.value ].sort2 = helper[ result.value ].sort2 + 1 | helper[ result.value ].sort2 = helper[ result.value ].sort2 + 1 | ||
Zeile 400: | Zeile 461: | ||
return results | return results | ||
end | |||
-- get lastEdit from reference retrieve date | |||
function wu.getLastedit( lastEdit, statements ) | |||
local isBoolean = type( lastEdit ) == 'boolean' | |||
if isBoolean and lastEdit == false then | |||
return lastEdit | |||
end | |||
local le = '' | |||
for _, statement in ipairs( statements ) do | |||
if statement.references then | |||
for _, reference in ipairs( statement.references ) do | |||
if reference[ wd.retrieved ] then | |||
for _, retrieved in ipairs( reference[ wd.retrieved ] ) do | |||
retrieved = wu.getDateFromTime( retrieved ) | |||
if retrieved > le then | |||
le = retrieved | |||
end | |||
end | |||
end | |||
end | |||
end | |||
end | |||
if isBoolean then | |||
return ( le ~= '' ) and le or lastEdit | |||
else | |||
return ( le > lastEdit ) and le or lastEdit | |||
end | |||
end | end | ||
Zeile 439: | Zeile 528: | ||
end | end | ||
return result | return result | ||
end | end | ||
return wu | return wu |
Aktuelle Version vom 27. Januar 2023, 08:40 Uhr
Die Dokumentation für dieses Modul kann unter Modul:Wikidata utilities/doc erstellt werden
-- Wikidata convenience utilities -- documentation local WikidataUtilities = { suite = 'WikidataUtilities', serial = '2022-09-04', item = 65439025 } -- i18n local wd = { version = 'P348', retrieved = 'P813', Gregorian = 'Q12138', -- calendar models prolepticGregorian = 'Q1985727' } -- module variable and administration local wu = { moduleInterface = WikidataUtilities } -- table storing property ids used local catTable = { P0 = '' } local function isSet( arg ) return arg and arg ~= '' end function wu.getEntity( id ) local wrongQualifier = false local entity = nil if not isSet( id ) then return '', entity, wrongQualifier end if mw.wikibase.isValidEntityId( id ) then -- expensive function call -- redirect ids marked false, too entity = mw.wikibase.getEntity( id ) end if not entity then id = '' wrongQualifier = true end return id, entity, wrongQualifier end function wu.getEntityId( id ) local wrongQualifier = false local entity = nil if not isSet( id ) then id = '' elseif mw.wikibase.isValidEntityId( id ) and mw.wikibase.entityExists( id ) then -- expensive function call -- redirect ids marked false, too entity = id else id = '' wrongQualifier = true end return id, entity, wrongQualifier end function wu.getLabel( entity, lang, noFallback ) if not isSet( entity ) then return nil end local tp = type( entity ) if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then return isSet( lang ) and mw.wikibase.getLabelByLang( entity, lang ) or ( not noFallback and mw.wikibase.getLabel( entity ) ) elseif tp == 'table' and entity.labels then return isSet( lang ) and entity:getLabel( lang ) or ( not noFallback and entity:getLabel() ) else return nil end end function wu.getSitelink( entity, globalSiteId ) if not isSet( entity ) then return nil end local tp = type( entity ) if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then return mw.wikibase.getSitelink( entity, globalSiteId ) elseif tp == 'table' and entity.labels then return entity:getSitelink( globalSiteId ) else return nil end end function wu.getSitelinkTable( entity, globalSiteId ) if not isSet( entity ) or not isSet( globalSiteId ) then return nil elseif type( entity ) == 'string' then -- entity is id entity = mw.wikibase.getEntity( entity ) end if entity and entity.sitelinks then return entity.sitelinks[ globalSiteId ] else return nil end end -- convert from url to Q id function wu.getUnit( unit ) if isSet( unit ) and type( unit ) == 'string' then return unit:gsub( 'https?://www.wikidata.org/entity/', '' ) else return '' end end -- is calendar model a Gregorian calendar? function wu.isGregorian( t ) return type( t ) == 'string' or t.calendarmodel == wd.Gregorian or t.calendarmodel == wd.prolepticGregorian end -- extract date from time function wu.getDateFromTime( t ) local model = wd.prolepticGregorian if type( t ) == 'table' then model = t.calendarmodel t = t.time end t = t:gsub( '^+', '' ):gsub( 'T.+Z$', '' ):gsub( '-00$', '' ) :gsub( '-00$', '' ) return t, model end function wu.getBestStatements( entity, p ) local tp = type( entity ) if tp == 'string' and mw.wikibase.isValidEntityId( entity ) then return mw.wikibase.getBestStatements( entity, p ) elseif tp == 'table' and entity.labels then return entity:getBestStatements( p ) else return {} end end function wu.getStatements( entity, p, count ) local ar = {} if not ( isSet( entity ) and isSet( p ) ) then return ar end local statements = wu.getBestStatements( entity, p ) count = math.min( count or #statements, #statements ) if count <= 0 then return ar end local i = 0 repeat i = i + 1 if statements[ i ].mainsnak.snaktype == 'value' then if statements[ i ].mainsnak.datatype == 'quantity' then statements[ i ].mainsnak.datavalue.value.amount = statements[ i ].mainsnak.datavalue.value.amount:gsub( '^+', '' ) statements[ i ].mainsnak.datavalue.value.unit = wu.getUnit( statements[ i ].mainsnak.datavalue.value.unit ) end table.insert( ar, statements[ i ] ) end until i >= #statements or #ar >= count return ar end function wu.getValue( entity, p ) local statements = wu.getStatements( entity, p, 1 ) if #statements > 0 then catTable[ p ] = '' return statements[ 1 ].mainsnak.datavalue.value else return '' end end function wu.getId( entity, p ) local value = '' local statements = wu.getStatements( entity, p, 1 ) if #statements > 0 then value = statements[ 1 ].mainsnak.datavalue.value value = value.id or '' if value ~= '' then catTable[ p ] = '' end end return value end function wu.getValues( entity, p, count ) local statements = wu.getStatements( entity, p, count ) if #statements > 0 then catTable[ p ] = '' for i = 1, #statements, 1 do statements[ i ] = statements[ i ].mainsnak.datavalue.value end end return statements end function wu.getValuesByLang( entity, p, count, lang ) local ar = {} local statements = wu.getStatements( entity, p ) if #statements > 0 then local value for i = 1, #statements, 1 do value = statements[ i ].mainsnak.datavalue.value if value.language and lang == value.language then table.insert( ar, value.text ) end if count and #ar >= count then break end end end if #ar > 0 then catTable[ p ] = '' end return ar end -- get values array for monolingual text function wu.getMonolingualValues( entity, p ) local result = {} local statements = wu.getStatements( entity, p, nil ) if #statements > 0 and statements[ 1 ].mainsnak.datatype == 'monolingualtext' then local hyphen, lng, value catTable[ p ] = '' for i = 1, #statements, 1 do value = statements[ i ].mainsnak.datavalue.value lng = value.language hyphen = lng:find( '-' ) if hyphen then lng = lng:sub( 1, hyphen - 1 ) end if not result[ lng ] then result[ lng ] = value.text end end end return result end function wu.getValuesByQualifier( entity, p, qualifierP, defaultId ) local result = {} if not isSet( qualifierP ) then return result elseif type( defaultId ) ~= 'string' or defaultId == '' then defaultId = 'unknown' end local statements = wu.getStatements( entity, p, nil ) if #statements > 0 then catTable[ p ] = '' local id, statement, value for i = 1, #statements do statement = statements[ i ] -- defaultId is used if a qualifier is missing id = defaultId value = statement.mainsnak.datavalue.value if statement.qualifiers and statement.qualifiers[ qualifierP ] then for _, qualifier in ipairs( statement.qualifiers[ qualifierP ] ) do if qualifier.snaktype == 'value' then id = qualifier.datavalue.value.id if id then catTable[ qualifierP ] = '' break end end end end result[ id ] = value end end return result end local function analyzeDatavalue( datavalue, labelFct, ... ) local v = datavalue.value local t = datavalue.type if type( v ) == 'table' then -- items which can be reduced to a string if t == 'wikibase-entityid' then v = v.id if type( labelFct ) == 'function' then v = labelFct( v, ... ) end elseif t == 'quantity' then v.amount = v.amount:gsub( '^+', '' ) if tonumber( v.amount ) == 0 then v.amount = '0' end if v.unit == '1' then v = tonumber( v.amount ) or 1 else v.unit = wu.getUnit( v.unit ) end elseif t == 'time' then v.calendarmodel = wu.getUnit( v.calendarmodel ) if wu.isGregorian( v ) then v = v.time end end end return v, t end -- The following function is an experimental one, not for extensive use -- for qualifiers, references -- { item1, item2, ... } : using named qualifiers/references -- {} : using no qualifiers/references -- nil : using all qualifiers/references function wu.getValuesWithQualifiers( entity, p, values, qualifiers, references, count, labelFct, ... ) local array, qual local function toQualifierTable( tab, key, qualTab, labelFct, ... ) local v if not tab[ key ] then tab[ key ] = {} end for i = 1, #qualTab do qual = qualTab[ i ] if qual.snaktype == 'value' then v, tab[ key .. '-type' ] = analyzeDatavalue( qual.datavalue, labelFct, ... ) table.insert( tab[ key ], v ) end end if #tab[ key ] == 0 then tab[ key ] = nil tab[ key .. '-type' ] = nil else catTable[ key ] = '' end end local function hasValue( tab, val ) for i = 1, #tab do if tab[ i ] == val then return true end end return false end local results = {} local statements = wu.getStatements( entity, p, count ) if #statements == 0 then return results end local i, v if type( values ) == 'table' and #values > 0 then for i = #statements, 1, -1 do v = statements[ i ].mainsnak.datavalue.value if type( v ) ~= 'string' then v = v.id end if not isSet( v ) or not hasValue( values, v ) then table.remove( statements, i ) end end if #statements == 0 then return results end end catTable[ p ] = '' if type( qualifiers ) == 'string' then qualifiers = { qualifiers } end if type( references ) == 'string' then references = { references } end local key, reference, statement for i = 1, #statements do statement = statements[ i ] array = { value = analyzeDatavalue( statement.mainsnak.datavalue, labelFct, ... ), [ 'value-type' ] = statement.mainsnak.datavalue.type } if statement.qualifiers then if not qualifiers then -- all qualifier properties for key, qualTab in pairs( statement.qualifiers ) do toQualifierTable( array, key, qualTab, labelFct, ... ) end else -- table of selected qualifier properties for j = 1, #qualifiers do key = qualifiers[ j ] if statement.qualifiers[ key ] then toQualifierTable( array, key, statement.qualifiers[ key ], labelFct, ... ) end end end end array.references = {} if statement.references then for k = 1, #statement.references do reference = statement.references[ k ] if reference and reference.snaks then table.insert( array.references, {} ) if not references then -- all references for key, refTab in pairs( reference.snaks ) do toQualifierTable( array.references[ #array.references ], key, refTab ) end else -- table of selected references for j = 1, #references do key = references[ j ] if reference.snaks[ key ] then toQualifierTable( array.references[ #array.references ], key, reference.snaks[ key ] ) end end end end end end table.insert( results, array ) end -- clustering statements with identical value local helper = {} local sort1 = 0 local mult = false local result for i = 1, #results do result = results[ i ] if helper[ result.value ] then helper[ result.value ].sort2 = helper[ result.value ].sort2 + 1 mult = true else sort1 = sort1 + 1 helper[ result.value ] = { sort1 = sort1, sort2 = 1 } end result.sort1 = helper[ result.value ].sort1 result.sort2 = helper[ result.value ].sort2 end if sort1 > 1 and mult and #results > 2 then table.sort( results, function( a, b ) return a.sort1 < b.sort1 or ( a.sort1 == b.sort1 and a.sort2 < b.sort2 ) end ) end return results end -- get lastEdit from reference retrieve date function wu.getLastedit( lastEdit, statements ) local isBoolean = type( lastEdit ) == 'boolean' if isBoolean and lastEdit == false then return lastEdit end local le = '' for _, statement in ipairs( statements ) do if statement.references then for _, reference in ipairs( statement.references ) do if reference[ wd.retrieved ] then for _, retrieved in ipairs( reference[ wd.retrieved ] ) do retrieved = wu.getDateFromTime( retrieved ) if retrieved > le then le = retrieved end end end end end end if isBoolean then return ( le ~= '' ) and le or lastEdit else return ( le > lastEdit ) and le or lastEdit end end function wu.getAliases( entity, lang ) if type( entity ) == 'string' then -- is Q id entity = mw.wikibase.getEntity( entity ) end if not lang then lang = mw.getContentLanguage():getCode() end local aliases = {} if entity and entity.aliases and entity.aliases[ lang ] then for _, alias in ipairs( entity.aliases[ lang ] ) do table.insert( aliases, alias.value ) end end return aliases end -- maintenance utilities function wu.addProperty( p ) catTable[ p ] = '' end function wu.removeProperty( p ) catTable[ p ] = nil end function wu.getCategories( formatStr ) local result = '' if not isSet( formatStr ) then formatStr = '[[Category:%s]]' end catTable.P0 = nil for key, value in pairs( catTable ) do result = result .. string.format( formatStr, key ) end return result end return wu