Module:WikidataIB: Difference between revisions
Jump to navigation
Jump to search
>RexxS (debug) |
>RexxS (qualifierID, not qualifier) |
||
Line 431: | Line 431: | ||
-- <- debugmsg = debugmsg .. ">" .. v1.mainsnak.datavalue.value.id .."< - >" .. propvalue .. "< " | -- <- debugmsg = debugmsg .. ">" .. v1.mainsnak.datavalue.value.id .."< - >" .. propvalue .. "< " | ||
if v1.mainsnak.datavalue.value.id == propvalue and v1.qualifiers then | if v1.mainsnak.datavalue.value.id == propvalue and v1.qualifiers then | ||
debugmsg = debugmsg .. #v1.qualifiers[qualifierID] | -- <- debugmsg = debugmsg .. #v1.qualifiers[qualifierID] | ||
if v1.references then | if v1.references then | ||
-- count how many refs are sourced | -- count how many refs are sourced | ||
Line 453: | Line 453: | ||
-- if we've got this far, we have a sourced claim with qualifiers | -- if we've got this far, we have a sourced claim with qualifiers | ||
-- which matches the target, so find the value of the qualifier we want | -- which matches the target, so find the value of the qualifier we want | ||
if v1.qualifiers[ | if v1.qualifiers[qualifierID] then | ||
return mw.wikibase.renderSnaks(v1.qualifiers[qualifierID]) .. "<- found" | return mw.wikibase.renderSnaks(v1.qualifiers[qualifierID]) .. "<- found" | ||
end | end |
Revision as of 17:37, 18 December 2016
Documentation for this module may be created at Module:WikidataIB/doc
-- Module to try out use of a blacklist and whitelist for infobox fields -- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used -- Fields in blacklist are never to be displayed, i.e. module must return nil in all circumstances -- Fields in whitelist return local value if it exists or the Wikidata value otherwise -- The name of the field that this function is called from is passed in named parameter |name -- The name is compulsory when blacklist or whitelist is used, so the module returns nil if it is not supplied -- blacklist is passed in named parameter |suppressfields -- whitelist is passed in named parameter |fetchwikidata local p = {} local i18n = { ["errors"] = { ["property-not-found"] = "Property not found.", ["entity-not-found"] = "Wikidata entity not found.", ["unknown-claim-type"] = "Unknown claim type.", ["unknown-entity-type"] = "Unknown entity type.", ["qualifier-not-found"] = "Qualifier not found.", ["site-not-found"] = "Wikimedia project not found.", ["unknown-datetime-format"] = "Unknown datetime format.", ["local-article-not-found"] = "Article is available on Wikidata, but not on Wikipedia" }, } -- This is used to get a value, or a comma separated list of them if multiple values exist p.getValue = function(frame) local propertyID = mw.text.trim(frame.args[1] or "") -- There may be a local parameter supplied, if it's blank, set it to nil local input_parm = mw.text.trim(frame.args[2] or "") if input_parm and (#input_parm == 0) then input_parm = nil end -- can take a named parameter |qid which is the Wikidata ID for the article. -- This will not normally be used because it's an expensive call. local qid = frame.args.qid if qid and (#qid == 0) then qid = nil end -- The blacklist is passed in named parameter |suppressfields local blacklist = frame.args.suppressfields -- The whitelist is passed in named parameter |fetchwikidata local whitelist = frame.args.fetchwikidata -- The name of the field that this function is called from is passed in named parameter |name local fieldname = frame.args.name -- onlysourced is a boolean passed to return only values sourced to other than Wikipedia -- if nothing or an empty string is passed set it false -- if "false" or "no" or 0 is passed set it false local onlysrc = frame.args.onlysourced if onlysrc and (#onlysrc > 0) then onlysrc = onlysrc:lower() if (onlysrc == "false") or (onlysrc == "no") or (onlysrc == 0) then onlysrc = false else onlysrc = true end else onlysrc = false end -- noicon is a boolean passed to suppress the "edit at Wikidata" icon for use when the value is processed further by the infobox -- if nothing or an empty string is passed set it false -- if "false" or "no" or 0 is passed set it false local noic = frame.args.noicon if noic and (#noic > 0) then noic = noic:lower() if (noic == "false") or (noic == "no") or (noic == 0) then noic = false else noic = true end else noic = false end if blacklist then -- The name is compulsory when blacklist is used, so return nil if it is not supplied if not fieldname or (#fieldname == 0) then return nil end -- If this field is on the blacklist, then return nil if blacklist:find(fieldname) then return nil end end -- If we got this far then we're not on the blacklist -- The blacklist overrides any locally supplied parameter as well -- If a non-blank input parameter was supplied return it if input_parm then return input_parm end -- Otherwise see if this field is on the whitelist: if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then local entity = mw.wikibase.getEntityObject(qid) local props if entity and entity.claims then props = entity.claims[propertyID] end if props then local lang = mw.language.getContentLanguage().code local thisQid if qid then thisQid = qid else thisQid = entity.id end local icon = " [[File:Blue pencil.svg |frameless |text-top |10px |alt=Edit this on Wikidata |link=https://www.wikidata.org/wiki/" .. thisQid .. "?uselang=" .. lang .. "#" .. propertyID .. "|Edit this on Wikidata]]" if props[1] and props[1].mainsnak.snaktype == "value" and props[1].mainsnak.datavalue.type == "wikibase-entityid" then -- it's wiki-linked value, so output as link if possible local out = {} for k, v in pairs(props) do -- check for references, -- construct a reference list for debugging -- and count valid references local reflist = "" local refs = 0 if v.references then for kr, vr in pairs(v.references) do local ref = mw.wikibase.renderSnaks(vr.snaks) reflist = reflist .. " <span style='color:#0DD;'>" .. ref .. "</span>" if not ref:find("Wikipedia") then refs = refs + 1 end end end if (refs > 0) or (onlysrc == false) then -- has valid refs or all values required local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"]) local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"]) if label == nil then label = "Q" .. v.mainsnak.datavalue.value["numeric-id"] end if sitelink then out[#out + 1] = "[[" .. sitelink .. "|" .. label .. "]]" else out[#out + 1] = "[[:d:Q" .. v.mainsnak.datavalue.value["numeric-id"] .. "|" .. label .. "]] <span title='" .. i18n["errors"]["local-article-not-found"] .. "'>[[File:Wikidata-logo.svg|16px|alt=|link=]]</span>" end end end if #out > 0 then if noic then return table.concat(out, ", ") else return table.concat(out, ", ") .. icon end else return nil -- no items had valid reference end else -- not a linkable article title -- this needs to be expanded to cater for multiple values local reflist = "" local refs = 0 for k, v in pairs(props) do -- check for references, -- construct a reference list for debugging -- and count valid references if v.references then for kr, vr in pairs(v.references) do local ref = mw.wikibase.renderSnaks(vr.snaks) reflist = reflist .. " <span style='color:#0DD;'>" .. ref .. "</span>" if not ref:find("Wikipedia") then refs = refs + 1 end end end end if (refs > 0) or (onlysrc == false) then -- has valid refs or all values required if noic then return entity:formatPropertyValues(propertyID).value else return entity:formatPropertyValues(propertyID).value .. icon end else return nil end end else -- no property stored for this article return nil end else -- not on the whitelist so just return what should be a nil input parameter return input_parm end end -- This is used to get a value, or a comma separated list of them if multiple values exist -- but only values that are sourced are returned p.getSourcedValue = function(frame) local propertyID = mw.text.trim(frame.args[1] or "") -- There may be a local parameter supplied, if it's blank, set it to nil local input_parm = mw.text.trim(frame.args[2] or "") if input_parm and (#input_parm == 0) then input_parm = nil end -- can take a named parameter |qid which is the Wikidata ID for the article. -- This will not normally be used because it's an expensive call. local qid = frame.args.qid if qid and (#qid == 0) then qid = nil end -- The blacklist is passed in named parameter |suppressfields local blacklist = frame.args.suppressfields -- The whitelist is passed in named parameter |fetchwikidata local whitelist = frame.args.fetchwikidata -- The name of the field that this function is called from is passed in named parameter |name local fieldname = frame.args.name if blacklist then -- The name is compulsory when blacklist is used, so return nil if it is not supplied if not fieldname or (#fieldname == 0) then return nil end -- If this field is on the blacklist, then return nil if blacklist:find(fieldname) then return nil end end -- If we got this far then we're not on the blacklist -- The blacklist overrides any locally supplied parameter as well -- If a non-blank input parameter was supplied return it if input_parm then return input_parm end -- Otherwise see if this field is on the whitelist: if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then local entity = mw.wikibase.getEntityObject(qid) local props if entity and entity.claims then props = entity.claims[propertyID] end if props then local lang = mw.language.getContentLanguage().code local thisQid if qid then thisQid = qid else thisQid = entity.id end local icon = " [[File:Blue pencil.svg |frameless |text-top |10px |alt=Edit this on Wikidata |link=https://www.wikidata.org/wiki/" .. thisQid .. "?uselang=" .. lang .. "#" .. propertyID .. "|Edit this on Wikidata]]" if props[1] and props[1].mainsnak.snaktype == "value" and props[1].mainsnak.datavalue.type == "wikibase-entityid" then -- it's wiki-linked value, so output as link if possible local out = {} for k, v in pairs(props) do -- check for references, -- construct a reference list for debugging -- and count valid references local reflist = "" local refs = 0 if v.references then for kr, vr in pairs(v.references) do local ref = mw.wikibase.renderSnaks(vr.snaks) reflist = reflist .. " <span style='color:#0DD;'>" .. ref .. "</span>" if not ref:find("Wikipedia") then refs = refs + 1 end end end if refs > 0 then -- has valid refs local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"]) local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"]) if label == nil then label = "Q" .. v.mainsnak.datavalue.value["numeric-id"] end if sitelink then out[#out + 1] = "[[" .. sitelink .. "|" .. label .. "]]" else out[#out + 1] = "[[:d:Q" .. v.mainsnak.datavalue.value["numeric-id"] .. "|" .. label .. "]]<abbr title='" .. i18n["errors"]["local-article-not-found"] .. "'> [*]</abbr>" end end end if #out > 0 then return table.concat(out, ", ") .. icon else return nil -- no items had valid reference end else -- not a linkable article title -- this needs to be expanded to cater for multiple values local reflist = "" local refs = 0 for k, v in pairs(props) do -- check for references, -- construct a reference list for debugging -- and count valid references if v.references then for kr, vr in pairs(v.references) do local ref = mw.wikibase.renderSnaks(vr.snaks) reflist = reflist .. " <span style='color:#0DD;'>" .. ref .. "</span>" if not ref:find("Wikipedia") then refs = refs + 1 end end end end if refs > 0 then return entity:formatPropertyValues(propertyID).value .. icon else return nil end end else -- no property stored for this article return nil end else -- not on the whitelist so just return what should be a nil input parameter return input_parm end end -- This is used to get coordinates for display in infobox p.getCoords = function(frame) local propertyID = "P625" local input_parm = mw.text.trim(frame.args[1] or "") if input_parm and (#input_parm == 0) then input_parm = nil end local qid = frame.args.qid if qid and (#qid == 0) then qid = nil end local blacklist = frame.args.suppressfields local whitelist = frame.args.fetchwikidata -- The name of the field that this function is called from is passed in named parameter |name -- it's probably 'coords' but we can't be certain local fieldname = frame.args.name if blacklist then if not fieldname or (#fieldname == 0) then return nil end if blacklist:find(fieldname) then return nil end end if input_parm then return input_parm end if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then local entity = mw.wikibase.getEntityObject(qid) local props if entity and entity.claims then props = entity.claims[propertyID] end if props then local lat_long = {} local coords = entity:formatPropertyValues(propertyID).value -- the latitude and longitude are returned like this: nn°nn'nn.n" -- using html entities with hex values really screws up parsing the numbers - thanks devs local lat = mw.ustring.match(coords, "^[^,]*") -- everything from the start to before the comma local long = mw.ustring.match(coords, "[^ ]*$") -- everything from after the space to the end lat = lat:gsub("&#%d%d;", ":") -- clean out the html entities long = long:gsub("&#%d%d;", ":") -- clean out the html entities -- read the numbers into a table for num in mw.ustring.gmatch(lat, "%d+%.?%d*") do lat_long[#lat_long + 1] = num end lat_long[#lat_long + 1] = lat:sub(-1) for num in mw.ustring.gmatch(long, "%d+%.?%d*") do lat_long[#lat_long + 1] = num end lat_long[#lat_long + 1] = long:sub(-1) -- invoke template Coord with the values stored in the table return frame:expandTemplate{title = 'coord', args = lat_long} else -- no coords in Wikidata for this article return nil end else -- not on the whitelist so just return what should be a nil input parameter return input_parm end end -- This is used to get a formatted value of a qualifier -- -- The call needs: a property (the unnamed parameter or 1=) -- a target value for that property (pval=) -- a qualifier for that target value (qual=) -- The usual whitelisting and blacklisting of the property is implemented -- The boolean onlysourced= parameter can be set to return nothing -- when the property is unsourced (or only sourced to Wikipedia) -- p.getQualifierValue = function(frame) local propertyID = mw.text.trim(frame.args[1] or "") -- The PropertyID of the target value of the property -- whose qualifier is to be returned is passed in named parameter |pval= local propvalue = frame.args.pval -- The PropertyID of the qualifier -- whose value is to be returned is passed in named parameter |qual= local qualifierID = frame.args.qual -- Can take a named parameter |qid which is the Wikidata ID for the article. -- This will not normally be used because it's an expensive call. local qid = frame.args.qid if qid and (#qid == 0) then qid = nil end -- The blacklist is passed in named parameter |suppressfields= local blacklist = frame.args.suppressfields -- The whitelist is passed in named parameter |fetchwikidata= local whitelist = frame.args.fetchwikidata -- The name of the field to check against the whitelist and blacklist -- is passed in named parameter |name local fieldname = frame.args.name -- onlysourced is a boolean passed to return qualifiers -- only when property values are sourced to something other than Wikipedia -- if nothing or an empty string is passed set it false -- if "false" or "no" or 0 is passed set it false local onlysrc = frame.args.onlysourced if onlysrc and (#onlysrc > 0) then onlysrc = onlysrc:lower() if (onlysrc == "false") or (onlysrc == "no") or (onlysrc == 0) then onlysrc = false else onlysrc = true end else onlysrc = false end if blacklist then -- The name is compulsory when blacklist is used, so return nil if it is not supplied if not fieldname or (#fieldname == 0) then return nil end -- If this field is on the blacklist, then return nil if blacklist:find(fieldname) then return nil end end -- If we got this far then we're not on the blacklist -- So see if this field is on the whitelist: if whitelist and (whitelist:find(fieldname) or whitelist == 'ALL') then local entity = mw.wikibase.getEntityObject(qid) local props local debugmsg = "<- " if entity and entity.claims then props = entity.claims[propertyID] end if props then -- <- debugmsg = debugmsg .. #props -- Scan through the values of the property -- we want something like property is P793, significant event (in propertyID) -- whose value is something like Q385378, construction (in propvalue) -- then we can return the value(s) of a qualifier such as P580, start time (in qualifierID) for k1, v1 in pairs(props) do -- <- debugmsg = debugmsg .. v1.mainsnak.datavalue.type if v1.mainsnak.snaktype == "value" and v1.mainsnak.datavalue.type == "wikibase-entityid" then -- It's a wiki-linked value, so check if it's the target (in propvalue) -- and if it has qualifiers -- <- debugmsg = debugmsg .. ">" .. v1.mainsnak.datavalue.value.id .."< - >" .. propvalue .. "< " if v1.mainsnak.datavalue.value.id == propvalue and v1.qualifiers then -- <- debugmsg = debugmsg .. #v1.qualifiers[qualifierID] if v1.references then -- count how many refs are sourced local numrefs = 0 for k2, v2 in pairs(v1.references) do local ref = mw.wikibase.renderSnaks(v2.snaks) if not ref:find("Wikipedia") then numrefs = numrefs + 1 end end if (numrefs == 0) and (onlysrc == true) then -- no sourced refs and sourced is required --return nil return "<- no sourced refs" end else if onlysrc == true then -- no refs and sourced refs is required --return nil return "<- no refs" end end -- if we've got this far, we have a sourced claim with qualifiers -- which matches the target, so find the value of the qualifier we want if v1.qualifiers[qualifierID] then return mw.wikibase.renderSnaks(v1.qualifiers[qualifierID]) .. "<- found" end end end end -- loop through values of propertyID return "<- didn't find the target" .. debugmsg end return "<- no claims for that property" end return nil end return p