@ -1,4 +1,4 @@
--XOWA:updated 201 7-03-16
--XOWA:updated 201 9-08-19
--[[
Registers and defines functions to handle Wikibase Entities through the Scribunto extension .
@ -10,7 +10,8 @@
] ]
local php = mw_interface
local entity = { }
mw_interface = nil
local Entity = { }
local metatable = { }
local methodtable = { }
local util = require ' libraryUtil '
@ -20,31 +21,124 @@ local checkTypeMulti = util.checkTypeMulti
metatable.__index = methodtable
-- Claim ranks (Claim::RANK_* in PHP)
e ntity.claimRanks = {
E ntity.claimRanks = {
RANK_TRUTH = 3 ,
RANK_PREFERRED = 2 ,
RANK_NORMAL = 1 ,
RANK_DEPRECATED = 0
}
-- Is this a valid property id (Pnnn)?
--
-- @param {string} propertyId
local isValidPropertyId = function ( propertyId )
return type ( propertyId ) == ' string ' and propertyId : match ( ' ^P[1-9]%d*$ ' )
end
-- Log access to claims of entity
--
-- @param {string} entityId
-- @param {string} propertyId
local addStatementUsage = function ( entityId , propertyId )
if isValidPropertyId ( propertyId ) then
-- Only attempt to track the usage if we have a valid property id.
php.addStatementUsage ( entityId , propertyId )
end
end
-- Function to mask an entity's subtables in order to log access
-- Code for logging based on: http://www.lua.org/pil/13.4.4.html
--
-- @param {table} entity
-- @param {string} tableName
-- @param {function} usageFunc
local maskEntityTable = function ( entity , tableName , usageFunc )
if entity [ tableName ] == nil then
return
end
local actualEntityTable = entity [ tableName ]
entity [ tableName ] = { }
local pseudoTableMetatable = { }
pseudoTableMetatable.__index = function ( _ , key )
usageFunc ( entity.id , key )
return actualEntityTable [ key ]
end
pseudoTableMetatable.__newindex = function ( _ , _ , _ )
error ( ' Entity cannot be modified ' , 2 )
end
local logNext = function ( _ , key )
local k , v = next ( actualEntityTable , key )
if k ~= nil then
usageFunc ( entity.id , k )
end
return k , v
end
pseudoTableMetatable.__pairs = function ( _ )
return logNext , { } , nil
end
setmetatable ( entity [ tableName ] , pseudoTableMetatable )
end
local noUsageTracking = function ( )
end
-- Function to mask an entity's subtables in order to log access and prevent modifications
--
-- @param {table} entity
-- @param {bool} fineGrainedTracking
local maskEntityTables = function ( entity , fineGrainedTracking )
if fineGrainedTracking then
maskEntityTable ( entity , ' claims ' , addStatementUsage )
maskEntityTable ( entity , ' labels ' , php.addLabelUsage )
maskEntityTable ( entity , ' sitelinks ' , php.addSiteLinksUsage )
maskEntityTable ( entity , ' descriptions ' , php.addDescriptionUsage )
maskEntityTable ( entity , ' aliases ' , php.addOtherUsage )
else
maskEntityTable ( entity , ' claims ' , noUsageTracking )
maskEntityTable ( entity , ' labels ' , noUsageTracking )
maskEntityTable ( entity , ' sitelinks ' , noUsageTracking )
maskEntityTable ( entity , ' descriptions ' , noUsageTracking )
maskEntityTable ( entity , ' aliases ' , noUsageTracking )
end
end
-- Create new entity object from given data
--
-- @param {table} data
entity.create = function ( data )
if type ( data ) ~= ' table ' or type ( data.schemaVersion ) ~= ' number ' then
error ( ' The entity data must be a table obtained via mw.wikibase.getEntityObject ' )
Entity.create = function ( data )
if type ( data ) ~= ' table ' then
error ( ' Expected a table obtained via mw.wikibase.getEntityObject, got ' .. type ( data ) .. ' instead ' )
end
if next ( data ) == nil then
error ( ' Expected a non-empty table obtained via mw.wikibase.getEntityObject ' )
end
if type ( data.schemaVersion ) ~= ' number ' then
error ( ' data.schemaVersion must be a number, got ' .. type ( data.schemaVersion ) .. ' instead ' )
end
if data.schemaVersion < 2 then
error ( ' mw.wikibase.entity must not be constructed using legacy data ' )
end
if type ( data.id ) ~= ' string ' then
error ( ' data.id must be a string, got ' .. type ( data.id ) .. ' instead ' )
end
local entity = data
setmetatable ( entity , metatable )
maskEntityTables( entity , php.getSetting ( ' fineGrainedLuaTracking ' ) )
setmetatable ( entity , metatable )
return entity
end
-- Get the id serialization from this entity.
methodtable.getId = function ( entity )
return entity.id
end
-- Get a term of a given type for a given language code or the content language (on monolingual wikis)
-- or the user's language (on multilingual wikis).
-- Second return parameter is the language the term is in.
@ -53,6 +147,8 @@ end
-- @param {string} termType A valid key in the entity table (either labels, descriptions or aliases)
-- @param {string|number} langCode
local getTermAndLang = function ( entity , termType , langCode )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.getTermAndLang.call ' )
langCode = langCode or php.getLanguageCode ( )
if langCode == nil then
@ -121,6 +217,8 @@ end
--
-- @param {string|number} [globalSiteId]
methodtable.getSitelink = function ( entity , globalSiteId )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.getSitelink.call ' )
checkTypeMulti ( ' getSitelink ' , 1 , globalSiteId , { ' string ' , ' number ' , ' nil ' } )
if entity.sitelinks == nil then
@ -142,18 +240,39 @@ methodtable.getSitelink = function( entity, globalSiteId )
return sitelink.title
end
-- Get the best statements with the given property id
--
-- @param {string} propertyId
methodtable.getBestStatements = function ( entity , propertyId )
if entity.claims == nil or not entity.claims [ propertyId ] then
-- @param {table} entity
-- @param {string} propertyLabelOrId
-- @param {string} funcName for error logging
local getEntityStatements = function ( entity , propertyLabelOrId , funcName )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.getEntityStatements.call ' )
checkType ( funcName , 1 , propertyLabelOrId , ' string ' )
if not entity.claims then
return { }
end
local propertyId = propertyLabelOrId
if not isValidPropertyId ( propertyId ) then
propertyId = mw.wikibase . resolvePropertyId ( propertyId )
end
if propertyId and entity.claims [ propertyId ] then
return entity.claims [ propertyId ]
end
return { }
end
-- Get the best statements with the given property id or label
--
-- @param {string} propertyLabelOrId
methodtable.getBestStatements = function ( entity , propertyLabelOrId )
local entityStatements = getEntityStatements ( entity , propertyLabelOrId , ' getBestStatements ' )
local statements = { }
local bestRank = ' normal '
for k , statement in pairs ( entity.claims [ propertyId ] ) do
for _, statement in pairs ( entityStatements ) do
if statement.rank == bestRank then
statements [ # statements + 1 ] = statement
elseif statement.rank == ' preferred ' then
@ -165,8 +284,17 @@ methodtable.getBestStatements = function( entity, propertyId )
return statements
end
-- Get all statements with the given property id or label
--
-- @param {string} propertyLabelOrId
methodtable.getAllStatements = function ( entity , propertyLabelOrId )
return getEntityStatements ( entity , propertyLabelOrId , ' getAllStatements ' )
end
-- Get a table with all property ids attached to the entity.
methodtable.getProperties = function ( entity )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.getProperties.call ' )
if entity.claims == nil then
return { }
end
@ -175,7 +303,7 @@ methodtable.getProperties = function( entity )
local properties = { }
local n = 0
for k , v in pairs ( entity.claims ) do
for k , _ in pairs ( entity.claims ) do
n = n + 1
properties [ n ] = k
end
@ -199,8 +327,8 @@ local formatValuesByPropertyId = function( entity, phpFormatterFunction, propert
)
local label
if : match ( ' ^P%d+$ ' ) then
label = mw.wikibase . l abel( propertyLabelOrId )
if isValidPropertyId( propertyLabelOrId ) then
label = mw.wikibase . getL abel( propertyLabelOrId )
end
if label == nil then
@ -220,6 +348,8 @@ end
-- @param {string} propertyLabelOrId
-- @param {table} [acceptableRanks]
methodtable.formatPropertyValues = function ( entity , propertyLabelOrId , acceptableRanks )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.formatPropertyValues.call ' )
checkType ( ' formatPropertyValues ' , 1 , propertyLabelOrId , ' string ' )
checkTypeMulti ( ' formatPropertyValues ' , 2 , acceptableRanks , { ' table ' , ' nil ' } )
@ -237,6 +367,8 @@ end
-- @param {string} propertyLabelOrId
-- @param {table} [acceptableRanks]
methodtable.formatStatements = function ( entity , propertyLabelOrId , acceptableRanks )
php.incrementStatsKey ( ' wikibase.client.scribunto.entity.formatStatements.call ' )
checkType ( ' formatStatements ' , 1 , propertyLabelOrId , ' string ' )
checkTypeMulti ( ' formatStatements ' , 2 , acceptableRanks , { ' table ' , ' nil ' } )
@ -248,8 +380,7 @@ methodtable.formatStatements = function( entity, propertyLabelOrId, acceptableRa
) ;
end
mw.wikibase . entity = entity
package.loaded [ ' mw.wikibase.entity ' ] = entity
mw_interface = nil
mw.wikibase . entity = Entity
package.loaded [ ' mw.wikibase.entity ' ] = Entity
return e ntity
return E ntity
gnosygnu
5 years ago