Modul:Commons link: Unterschied zwischen den Versionen
use require('strict') instead of require('Module:No globals')
K (2 Versionen von skanwiki:Modul:Commons_link importiert) |
(use require('strict') instead of require('Module:No globals')) |
||
Zeile 1: | Zeile 1: | ||
require('strict') | |||
-- Module to find commons galleries and categories based on wikidata entries | -- Module to find commons galleries and categories based on wikidata entries | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
local yesNo = require('Module:Yesno') | |||
local generateWarning = require('Module:If preview')._warning | |||
local p = {} | local p = {} | ||
Zeile 17: | Zeile 21: | ||
end | end | ||
function _lcfirst( | local function _lcfirst(s) | ||
return mw.ustring.lower(mw.ustring.sub(s,1,1))..mw.ustring.sub(s,2) | |||
end | |||
-- Format displayed linktext | |||
-- Arguments: | |||
-- s = string to display | |||
-- formatting = formatting table: | |||
-- formatting.linktext = if defined, override s | |||
-- formatting.lcfirst = lower case the first letter in display | |||
-- formatting.bold = whether to bold the display | |||
-- formatting.italic = whether to italicize the display | |||
-- formatting.nowrap = set nowrapping | |||
-- Returns: | |||
-- formatted string | |||
local function _formatResult(s, formatting) | |||
local resultVal = formatting.linktext or s | |||
if formatting.lcfirst then | |||
resultVal = _lcfirst(resultVal) | |||
end | end | ||
return | local style = "" | ||
if formatting.italic then style = "font-style:italic; " end | |||
if formatting.bold then style = style.."font-weight:bold; " end | |||
if formatting.nowrap then style = style.."white-space:nowrap; " end | |||
if style ~= "" then | |||
resultVal = '<span style="'..mw.text.trim(style)..'">'..resultVal..'</span>' | |||
end | |||
return resultVal | |||
end | end | ||
Zeile 27: | Zeile 54: | ||
-- Arguments: | -- Arguments: | ||
-- qid = testing only: get title of alternative page with QID=qid | -- qid = testing only: get title of alternative page with QID=qid | ||
-- nsQid = whether to return the ns of the qid page or current | |||
-- Returns: | -- Returns: | ||
-- title, namespace ( | -- title, namespace (string), qid of current page (or test page) | ||
local function _getTitleQID(qid) | local function _getTitleQID(qid,nsQid) | ||
local titleObject = mw.title.getCurrentTitle() | local titleObject = mw.title.getCurrentTitle() | ||
-- look up qid for current page (if not testing) | -- look up qid for current page (if not testing) | ||
local nsText = mw.ustring.gsub(titleObject.nsText,"_"," ") | |||
if not _validQID(qid) then | if not _validQID(qid) then | ||
qid = mw.wikibase.getEntityIdForCurrentPage() | qid = mw.wikibase.getEntityIdForCurrentPage() | ||
return titleObject.text, | return titleObject.text, nsText, qid | ||
end | end | ||
-- testing-only path: given a qid, determine title | -- testing-only path: given a qid, determine title | ||
Zeile 42: | Zeile 71: | ||
-- strip any namespace from sitelink | -- strip any namespace from sitelink | ||
local firstColon = mw.ustring.find(title,':',1,true) | local firstColon = mw.ustring.find(title,':',1,true) | ||
local qidNsText = "" | |||
if firstColon then | if firstColon then | ||
qidNsText = mw.ustring.sub(title,1,firstColon-1) | |||
title = mw.ustring.sub(title,firstColon+1) | title = mw.ustring.sub(title,firstColon+1) | ||
end | end | ||
return title, | if nsQid then | ||
return title, qidNsText, qid | |||
end | |||
return title, nsText, qid | |||
end | end | ||
Zeile 130: | Zeile 164: | ||
if commonsSitelink and mw.ustring.sub(commonsSitelink,1,9) == "Category:" then | if commonsSitelink and mw.ustring.sub(commonsSitelink,1,9) == "Category:" then | ||
categoryLink = mw.ustring.sub(commonsSitelink,10) | categoryLink = mw.ustring.sub(commonsSitelink,10) | ||
end | end | ||
-- P910 is the "topic's main category". Look for commons sitelink there | -- P910 is the "topic's main category". Look for commons sitelink there | ||
Zeile 157: | Zeile 180: | ||
if categoryLink and categoryLink ~= fallback then | if categoryLink and categoryLink ~= fallback then | ||
consistent = false | consistent = false | ||
qid = nil | |||
else | else | ||
categoryLink = fallback | categoryLink = fallback | ||
end | |||
end | |||
-- P373 is the "commons category" property for this article. This is | |||
-- a low-quality field, so should only be used as a last resort. | |||
if categoryLink == nil and _validQID(qid) then | |||
local P373 = mw.wikibase.getBestStatements(qid, "P373")[1] | |||
if P373 and P373.mainsnak.datavalue then | |||
categoryLink = P373.mainsnak.datavalue.value | |||
consistent = true -- P373 is never used if anything else is available | |||
end | end | ||
end | end | ||
return categoryLink, consistent, commonsSitelink | return categoryLink, consistent, commonsSitelink | ||
end | |||
-- Does the article have a Commons gallery, and is it consistent? | |||
-- Arguments: | |||
-- qid = QID to lookup in wikidata (for testing only) | |||
-- Returns: | |||
-- filename at Commons, bool: is wikidata consistent for this article? | |||
function p._hasGalleryConsistent(qid) | |||
local wp_title, wp_ns | |||
wp_title, wp_ns, qid = _getTitleQID(qid) | |||
return _lookupGallery(qid,true) | |||
end | end | ||
Zeile 168: | Zeile 212: | ||
-- qid = QID to lookup in wikidata (for testing only) | -- qid = QID to lookup in wikidata (for testing only) | ||
-- Returns: | -- Returns: | ||
-- filename at Commons if so, | -- filename at Commons if so, false if not | ||
function p._hasGallery(qid) | function p._hasGallery(qid) | ||
local galleryLink, consistent = p._hasGalleryConsistent(qid) | |||
return consistent and galleryLink | |||
end | |||
-- Does the article have a Commons category? Is wikidata consistent for that? | |||
-- Arguments: | |||
-- qid = QID to lookup in wikidata (for testing only) | |||
-- prefix = whether to add "Category:" to return string (default true) | |||
-- Returns: | |||
-- filename at Commons, bool: consistent | |||
function p._hasCategoryConsistent(qid,prefix) | |||
if prefix == nil then | |||
prefix = true | |||
end | |||
local wp_title, wp_ns | local wp_title, wp_ns | ||
wp_title, wp_ns, qid = _getTitleQID(qid) | wp_title, wp_ns, qid = _getTitleQID(qid) | ||
local | local categoryLink, consistent = _lookupCategory(qid,true) | ||
if | if categoryLink and prefix then | ||
categoryLink = "Category:"..categoryLink | |||
end | end | ||
return | return categoryLink, consistent | ||
end | end | ||
Zeile 182: | Zeile 240: | ||
-- Arguments: | -- Arguments: | ||
-- qid = QID to lookup in wikidata (for testing only) | -- qid = QID to lookup in wikidata (for testing only) | ||
-- prefix = whether to add "Category:" to return string (default true) | |||
-- Returns: | -- Returns: | ||
-- filename at Commons if so, blank if not | -- filename at Commons if so, blank if not | ||
function p._hasCategory(qid | function p._hasCategory(qid,prefix) | ||
local categoryLink, consistent = p._hasCategoryConsistent(qid,prefix) | |||
return consistent and categoryLink | |||
local categoryLink, consistent = | |||
end | end | ||
Zeile 198: | Zeile 252: | ||
-- namespace = namespace in Commons ("" for galleries) | -- namespace = namespace in Commons ("" for galleries) | ||
-- default = use as Commons link, don't access wikidata | -- default = use as Commons link, don't access wikidata | ||
-- search = string to search for | -- search = string to search for | ||
-- | -- fallback = string to search for if wikidata fails | ||
-- formatting = formatting parameters | |||
-- qid = QID to lookup in wikidata (for testing only) | -- qid = QID to lookup in wikidata (for testing only) | ||
-- Returns: | -- Returns: | ||
-- formatted wikilink to Commons in specified namespace | -- formatted wikilink to Commons in specified namespace | ||
function p._getCommons(namespace,default, | function p._getCommons(namespace,default,search,fallback,formatting,qid) | ||
local nsColon | local nsColon | ||
if not namespace or namespace == "" then | if not namespace or namespace == "" then | ||
Zeile 212: | Zeile 266: | ||
end | end | ||
if default then | if default then | ||
return "[[Commons:"..nsColon..default.."|".. | return "[[Commons:"..nsColon..default.."|".._formatResult(default,formatting).."]]" | ||
end | end | ||
if search then | if search then | ||
return "[[Commons:Special:Search/"..nsColon..search.."|".. | return "[[Commons:Special:Search/"..nsColon..search.."|".._formatResult(search,formatting).."]]" | ||
end | end | ||
local wp_title, wp_ns | local wp_title, wp_ns | ||
wp_title, wp_ns, qid = _getTitleQID(qid) | wp_title, wp_ns, qid = _getTitleQID(qid) | ||
local commonsLink = nil | local commonsLink = nil | ||
local consistent = true | local consistent = true | ||
Zeile 230: | Zeile 282: | ||
-- use wikidata if consistent | -- use wikidata if consistent | ||
if commonsLink and consistent then | if commonsLink and consistent then | ||
return "[[Commons:"..nsColon..commonsLink.."|".. | return "[[Commons:"..nsColon..commonsLink.."|".._formatResult(commonsLink,formatting).."]]" | ||
end | end | ||
-- if not consistent, fall back to search and add to tracking cat | -- if not consistent, fall back to search and add to tracking cat | ||
if not consistent and wp_ns == | -- construct default result (which searches for title) | ||
local searchResult = "[[Commons:Special:Search/"..nsColon..(fallback or wp_title) | |||
.."|".._formatResult(fallback or wp_title,formatting).."]]" | |||
if not consistent and wp_ns == "" then | |||
local friendlyNS | local friendlyNS | ||
if nsColon == "" then | if nsColon == "" then | ||
Zeile 248: | Zeile 303: | ||
-- Arguments: | -- Arguments: | ||
-- default = use as Commons link, don't access wikidata | -- default = use as Commons link, don't access wikidata | ||
-- search = string to search for | -- search = string to search for | ||
-- fallback = string to search for if wikidata lookup fails | |||
-- formatting = formatting parameters | |||
-- qid = QID to lookup in wikidata (for testing only) | -- qid = QID to lookup in wikidata (for testing only) | ||
-- Returns: | -- Returns: | ||
-- formatted wikilink to Commons "best" landing page | -- formatted wikilink to Commons "best" landing page | ||
function p._getGalleryOrCategory(default, | function p._getGalleryOrCategory(default, search, fallback, formatting, qid) | ||
if default then | if default then | ||
return "[[Commons:"..default.."|"..( | return "[[Commons:"..default.."|".._formatResult(default,formatting).."]]" | ||
end | end | ||
if search then | if search then | ||
return "[[Commons:Special:Search/"..search.."|"..( | return "[[Commons:Special:Search/"..search.."|".._formatResult(search,formatting).."]]" | ||
end | end | ||
local wp_title, wp_ns | local wp_title, wp_ns | ||
wp_title, wp_ns, qid = _getTitleQID(qid) | wp_title, wp_ns, qid = _getTitleQID(qid) | ||
local trackingCats = "" | local trackingCats = "" | ||
local galleryLink, consistent, commonsSitelink = _lookupGallery(qid,true) | local galleryLink, consistent, commonsSitelink = _lookupGallery(qid,true) | ||
-- use wikidata if either sitelink or P935 exist, and they both agree | -- use wikidata if either sitelink or P935 exist, and they both agree | ||
if galleryLink and consistent then | if galleryLink and consistent then | ||
return "[[Commons:"..galleryLink.."|"..( | return "[[Commons:"..galleryLink.."|".._formatResult(galleryLink,formatting).."]]" | ||
end | end | ||
if not consistent and wp_ns == | if not consistent and wp_ns == "" then | ||
trackingCats = "[[Category:Inconsistent wikidata for Commons gallery]]" | trackingCats = "[[Category:Inconsistent wikidata for Commons gallery]]" | ||
end | end | ||
Zeile 277: | Zeile 331: | ||
categoryLink, consistent = _lookupCategory(qid,false,commonsSitelink) | categoryLink, consistent = _lookupCategory(qid,false,commonsSitelink) | ||
if categoryLink and consistent then | if categoryLink and consistent then | ||
return "[[Commons:Category:"..categoryLink.."|"..( | return "[[Commons:Category:"..categoryLink.."|".._formatResult(categoryLink,formatting).."]]"..trackingCats | ||
end | end | ||
if not consistent and wp_ns == | if not consistent and wp_ns == "" then | ||
trackingCats = trackingCats.."[[Category:Inconsistent wikidata for Commons category]]" | trackingCats = trackingCats.."[[Category:Inconsistent wikidata for Commons category]]" | ||
end | end | ||
-- return search result looking for title as last attempt | |||
return "[[Commons:Special:Search/" .. (fallback or wp_title) .. | |||
"|" .. _formatResult(fallback or wp_title,formatting) .. "]]" .. trackingCats | |||
-- | |||
end | end | ||
Zeile 307: | Zeile 346: | ||
-- defaultCategory = default category link to use, instead of wikidata | -- defaultCategory = default category link to use, instead of wikidata | ||
-- categoryText = if both gallery and category, text to use in category link ("category" by default) | -- categoryText = if both gallery and category, text to use in category link ("category" by default) | ||
-- | -- oneSearch = only emit one search result | ||
-- | -- formatting = formatting parameters | ||
-- qid = qid of page to lookup in wikidata (testing only) | -- qid = qid of page to lookup in wikidata (testing only) | ||
function p._getGalleryAndCategory(defaultGallery,defaultCategory, | function p._getGalleryAndCategory(defaultGallery, defaultCategory, | ||
categoryText, oneSearch, formatting, qid | |||
) | |||
local wp_title, wp_ns | local wp_title, wp_ns | ||
wp_title, wp_ns, qid = _getTitleQID(qid) | wp_title, wp_ns, qid = _getTitleQID(qid) | ||
categoryText = categoryText or "category" | categoryText = categoryText or "category" | ||
local trackingCats = "" | local trackingCats = "" | ||
local galleryLink, galleryConsistent | local galleryLink, galleryConsistent | ||
Zeile 329: | Zeile 365: | ||
end | end | ||
local galleryGood = galleryLink and galleryConsistent | local galleryGood = galleryLink and galleryConsistent | ||
if not galleryConsistent and wp_ns == | if not galleryConsistent and wp_ns == "" then | ||
trackingCats = "[[Category:Inconsistent wikidata for Commons gallery]]" | trackingCats = "[[Category:Inconsistent wikidata for Commons gallery]]" | ||
end | end | ||
Zeile 340: | Zeile 376: | ||
end | end | ||
local categoryGood = categoryLink and categoryConsistent | local categoryGood = categoryLink and categoryConsistent | ||
if not categoryConsistent and wp_ns == | if not categoryConsistent and wp_ns == "" then | ||
trackingCats = trackingCats.."[[Category:Inconsistent wikidata for Commons category]]" | trackingCats = trackingCats.."[[Category:Inconsistent wikidata for Commons category]]" | ||
end | end | ||
local firstLink | local firstLink | ||
-- construct default result (which searches for title) | |||
local searchResult = "[[Commons:Special:Search/"..wp_title.."|".._formatResult(wp_title,formatting).."]]" | |||
if not oneSearch then | |||
searchResult = searchResult.." ([[Commons:Special:Search/Category:"..wp_title.."|"..categoryText.."]])" | |||
end | |||
local linkText = nil | |||
if galleryGood then | if galleryGood then | ||
firstLink = galleryLink | firstLink = galleryLink | ||
linkText = | linkText = galleryLink | ||
elseif categoryGood then | elseif categoryGood then | ||
firstLink = "Category:"..categoryLink | firstLink = "Category:"..categoryLink | ||
linkText = | linkText = categoryLink | ||
else | else | ||
return searchResult..trackingCats | return searchResult..trackingCats | ||
end | end | ||
local resultVal = | local resultVal = "[[Commons:"..firstLink.."|".._formatResult(linkText,formatting).."]]" | ||
if galleryGood and categoryGood then | if galleryGood and categoryGood then | ||
resultVal = resultVal.." ([[Commons:Category:"..categoryLink.."|"..categoryText.."]])" | resultVal = resultVal.." ([[Commons:Category:"..categoryLink.."|"..categoryText.."]])" | ||
end | end | ||
return resultVal..trackingCats | return resultVal..trackingCats | ||
end | |||
-- Compare two titles with their namespaces stripped | |||
local function titleMatch(s1,s2) | |||
s1 = s1 or "" | |||
s2 = s2 or "" | |||
s1 = mw.ustring.gsub(s1,"^[^:]+:","") | |||
s2 = mw.ustring.gsub(s2,"^[^:]+:","") | |||
return s1 == s2 | |||
end | |||
local galleryTrackingCats = { | |||
commons_link_on_wikidata = '[[Category:Commons link is on Wikidata]]', | |||
commons_link_defined_as_pagename = '[[Category:Commons link is defined as the pagename]]', | |||
commons_link_locally_defined = '[[Category:Commons link is locally defined]]', | |||
commons_link_from_wikidata = '[[Category:Commons link from Wikidata]]', | |||
commons_link_is_pagename = '[[Category:Commons link is the pagename]]', | |||
inconsistent = '[[Category:Inconsistent wikidata for Commons gallery]]' | |||
} | |||
local categoryTrackingCats = { | |||
commons_link_on_wikidata = '[[Category:Commons category link is on Wikidata]]', | |||
commons_link_defined_as_pagename = '[[Category:Commons category link is defined as the pagename]]', | |||
commons_link_locally_defined = '[[Category:Commons category link is locally defined]]', | |||
commons_link_from_wikidata = '[[Category:Commons category link from Wikidata]]', | |||
commons_link_is_pagename = '[[Category:Commons category link is the pagename]]', | |||
inconsistent = '[[Category:Inconsistent wikidata for Commons category]]' | |||
} | |||
local function selectTrackingCat(trackingCats,wikidata,consistent,default,title) | |||
if not consistent then | |||
return trackingCats.inconsistent | |||
end | |||
if default then | |||
-- construct warning message | |||
if default == wikidata then | |||
return trackingCats.commons_link_on_wikidata | |||
end | |||
local warning = "" | |||
if wikidata then | |||
warning = generateWarning({ | |||
"Commons link does not match Wikidata – [[Template:Commons_category#Resolving_discrepancies|please check]]" | |||
}) | |||
end | |||
if titleMatch(default,title) then | |||
return trackingCats.commons_link_defined_as_pagename .. warning | |||
end | |||
return trackingCats.commons_link_locally_defined .. warning | |||
end | |||
if wikidata then | |||
return trackingCats.commons_link_from_wikidata | |||
end | |||
return trackingCats.commons_link_is_pagename | |||
end | |||
-- Figure out tracking categories and editor warnings | |||
-- Arguments: | |||
-- default = Commons link argument passed to template | |||
-- fetchGallery = whether to fetch a gallery from Wikidata | |||
-- fetchCategory = whether to fetch a category from Wikidata | |||
-- qid = force a qid for testing | |||
-- Returns: | |||
-- tracking category and possible user warning | |||
-- | |||
-- Note: the logic for the tracking is quite different than the logic | |||
-- for generating Commons links (above). Thus, it is separated into another | |||
-- function for code clarity and maintainability. This should not seriously | |||
-- affect performance: server time is dominated by fetching wikidata entities, | |||
-- and those entities should be cached and shared between the Commons generating | |||
-- code and this tracking code. | |||
function p._tracking(default, fetchGallery, fetchCategory, qid) | |||
local title, wp_ns, wp_qid = _getTitleQID(qid,true) | |||
if wp_ns ~= "" then | |||
title = wp_ns..":"..title | |||
end | |||
-- only track if test or namespace=article or namespace=category | |||
if not (qid or wp_ns == "" or wp_ns == "Category") then | |||
return "" | |||
end | |||
-- determine title and namespace of wikidata and wp article | |||
local wikidata = nil | |||
local consistent = nil | |||
-- Tracking code works for all 4 cases of states of fetchGallery/Category | |||
-- fetchGallery takes precedence | |||
if fetchGallery then | |||
wikidata, consistent = p._hasGalleryConsistent(qid) | |||
if default or not fetchCategory or (consistent and wikidata) then | |||
return selectTrackingCat(galleryTrackingCats,wikidata,consistent, | |||
default,title) | |||
end | |||
end | |||
if fetchCategory then | |||
local cat_wikidata, cat_consistent = p._hasCategoryConsistent(qid,true) | |||
if not fetchGallery or (cat_consistent and cat_wikidata) then | |||
return selectTrackingCat(categoryTrackingCats,cat_wikidata, | |||
cat_consistent,default,title) | |||
end | |||
return selectTrackingCat(galleryTrackingCats,wikidata,consistent, | |||
default,title) | |||
end | |||
return "" -- nothing fetched, nothing tracked | |||
end | |||
local function _createFormatting(args) | |||
local formatting = {} | |||
formatting.linktext = args.linktext | |||
formatting.lcfirst = yesNo(args.lcfirst) | |||
formatting.bold = yesNo(args.bold) | |||
formatting.italic = yesNo(args.italic) | |||
formatting.nowrap = yesNo(args.nowrap) | |||
return formatting | |||
end | end | ||
Zeile 363: | Zeile 517: | ||
function p.getTitleQID(frame) | function p.getTitleQID(frame) | ||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | ||
local text, ns, qid = _getTitleQID(args[1]) | local text, ns, qid = _getTitleQID(args[1],args[2]) | ||
return text..","..ns..","..(qid or "nil") | return text..","..ns..","..(qid or "nil") | ||
end | end | ||
Zeile 377: | Zeile 531: | ||
function p.getGallery(frame) | function p.getGallery(frame) | ||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | ||
return p._getCommons("",args[1],args. | return p._getCommons("",args[1],args.search,args.fallback,_createFormatting(args),args.qid) | ||
end | end | ||
Zeile 383: | Zeile 537: | ||
function p.getCategory(frame) | function p.getCategory(frame) | ||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | ||
local retval = p._getCommons("Category", args[1], | |||
args.search, args.fallback, _createFormatting(args), args.qid | |||
) | |||
if args.tracking then | |||
local default = nil | |||
if args[1] then | |||
default = "Category:"..args[1] | |||
end | |||
retval = retval..p._tracking(default, false, true, args.qid) | |||
end | |||
return retval | |||
end | end | ||
function p.getGalleryOrCategory(frame) | function p.getGalleryOrCategory(frame) | ||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | ||
local retval = p._getGalleryOrCategory( | |||
args[1], args.search, args.fallback, _createFormatting(args), args.qid | |||
) | |||
if args.tracking then | |||
retval = retval..p._tracking(args[1],true,true,args.qid) | |||
end | |||
return retval | |||
end | end | ||
Zeile 408: | Zeile 578: | ||
function p.getGalleryAndCategory(frame) | function p.getGalleryAndCategory(frame) | ||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | ||
return p._getGalleryAndCategory(args[1],args[2],args. | return p._getGalleryAndCategory(args[1], args[2], | ||
args.categoryText, args.oneSearch, _createFormatting(args), args.qid) | |||
end | |||
function p.tracking(frame) | |||
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false}) | |||
return p._tracking(args[1], args.fetchGallery, args.fetchCategory, args.qid) | |||
end | end | ||
return p | return p |