Safer nicotine wiki

Module:Commons link: Difference between revisions

← Older edit
m 1 revision imported
m 1 revision imported: Templates and CSS files
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 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 = {}


Line 17: Line 21:
end
end


function _lcfirst(doit,s)
local function _lcfirst(s)
if doit then
return mw.ustring.lower(mw.ustring.sub(s,1,1))..mw.ustring.sub(s,2)
return mw.ustring.lower(mw.ustring.sub(s,1,1))..mw.ustring.sub(s,2)
end
return s
end
end


local function warning(msg)
-- Format displayed linktext
  local frame = mw.getCurrentFrame():getParent()
-- Arguments:
  local html = ""
--  s = string to display
  if frame:preprocess( "{{REVISIONID}}" ) == "" then  
--  formatting = formatting table:
  html = '<div style="color:red"><strong>Warning:</strong> '..msg
--    formatting.linktext = if defined, override s
  html = html..' <small>(this message is shown only in preview)</small></div>'
--    formatting.lcfirst = lower case the first letter in display
  end
--    formatting.bold = whether to bold the display
  return html
--    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
    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


Line 147: Line 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
-- P373 is the "commons category" property for this article
local P373 = mw.wikibase.getBestStatements(qid, "P373")[1]
if P373 and P373.mainsnak.datavalue then
P373 = P373.mainsnak.datavalue.value
if categoryLink and categoryLink ~= P373 then
consistent = false
qid = nil  -- stop searching on inconsistent data
else
categoryLink = P373
end
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
Line 174: Line 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


Line 185: Line 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, nil if not
--  filename at Commons if so, false if not
function p._hasGallery(qid)
function p._hasGallery(qid)
local wp_title, wp_ns
local galleryLink, consistent = p._hasGalleryConsistent(qid)
wp_title, wp_ns, qid = _getTitleQID(qid)
return consistent and galleryLink
local galleryLink, consistent = _lookupGallery(qid,true)
if galleryLink and consistent then
return galleryLink
end
return nil
end
end


-- Does the article have a corresponding Commons category?
-- Does the article have a Commons category? Is wikidata consistent for that?
-- 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)
--  prefix = whether to add "Category:" to return string (default true)
-- Returns:
-- Returns:
--  filename at Commons if so, blank if not
--  filename at Commons, bool: consistent
function p._hasCategory(qid,prefix)
function p._hasCategoryConsistent(qid,prefix)
if prefix == nil then
if prefix == nil then
prefix = true
prefix = true
Line 209: Line 231:
wp_title, wp_ns, qid = _getTitleQID(qid)
wp_title, wp_ns, qid = _getTitleQID(qid)
local categoryLink, consistent = _lookupCategory(qid,true)
local categoryLink, consistent = _lookupCategory(qid,true)
if categoryLink and consistent then
if categoryLink and prefix then
if prefix then
categoryLink = "Category:"..categoryLink
categoryLink = "Category:"..categoryLink
end
return categoryLink
end
end
return nil
return categoryLink, consistent
end
 
-- Does the article have a corresponding Commons category?
-- Arguments:
--  qid = QID to lookup in wikidata (for testing only)
--  prefix = whether to add "Category:" to return string (default true)
-- Returns:
--  filename at Commons if so, blank if not
function p._hasCategory(qid,prefix)
local categoryLink, consistent = p._hasCategoryConsistent(qid,prefix)
return consistent and categoryLink
end
end


Line 222: Line 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
--  linktext = text to display in link
--  search = string to search for
--  search = string to search for
--  fallback = string to search for if wikidata fails
--  fallback = string to search for if wikidata fails
--  lcfirst = lower case the first letter in linktext
--  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,linktext,search,fallback,lcfirst,qid)
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
Line 237: Line 266:
end
end
if default then
if default then
return "[[Commons:"..nsColon..default.."|".._lcfirst(lcfirst,linktext or default).."]]"
return "[[Commons:"..nsColon..default.."|".._formatResult(default,formatting).."]]"
end
end
if search then
if search then
return "[[Commons:Special:Search/"..nsColon..search.."|".._lcfirst(lcfirst,linktext or 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)
-- construct default result (which searches for title)
local searchResult = "[[Commons:Special:Search/"..nsColon..(fallback or wp_title)
searchResult = searchResult.."|".._lcfirst(lcfirst,linktext or fallback or wp_title).."]]"
local commonsLink = nil
local commonsLink = nil
local consistent = true
local consistent = true
Line 256: Line 282:
-- use wikidata if consistent
-- use wikidata if consistent
if commonsLink and consistent then
if commonsLink and consistent then
return "[[Commons:"..nsColon..commonsLink.."|".._lcfirst(lcfirst,linktext or 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
-- 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
if not consistent and wp_ns == "" then
local friendlyNS
local friendlyNS
Line 274: Line 303:
-- Arguments:
-- Arguments:
--  default = use as Commons link, don't access wikidata
--  default = use as Commons link, don't access wikidata
--  linktext = text to display in link
--  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,linktext,search,fallback,qid)
function p._getGalleryOrCategory(default, search, fallback, formatting, qid)
if default then
if default then
return "[[Commons:"..default.."|"..(linktext or default).."]]"
return "[[Commons:"..default.."|".._formatResult(default,formatting).."]]"
end
end
if search then
if search then
return "[[Commons:Special:Search/"..search.."|"..(linktext or 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)
-- construct default result (which searches for title)
local searchResult = "[[Commons:Special:Search/"..(fallback or wp_title)
searchResult = searchResult.."|"..(linktext or fallback or wp_title).."]]"
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.."|"..(linktext or galleryLink).."]]"
return "[[Commons:"..galleryLink.."|".._formatResult(galleryLink,formatting).."]]"
end
end
if not consistent and wp_ns == "" then
if not consistent and wp_ns == "" then
Line 304: Line 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.."|"..(linktext or categoryLink).."]]"..trackingCats
return "[[Commons:Category:"..categoryLink.."|".._formatResult(categoryLink,formatting).."]]"..trackingCats
end
end
if not consistent and wp_ns == "" then
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 searchResult..trackingCats
-- return search result looking for title as last attempt
end
return "[[Commons:Special:Search/" .. (fallback or wp_title) ..
 
"|" .. _formatResult(fallback or wp_title,formatting) .. "]]" .. trackingCats
-- Make a string bold, italic, or both
-- Arguments:
--  s = string to format
--  bold = make it bold
--  italic = make it italic
-- Returns:
--  string modified with html tags
local function _formatResult(s,bold,italic)
local resultVal = ""
if bold then resultVal = "<b>" end
if italic then resultVal = resultVal.."<i>" end
resultVal = resultVal..s
if italic then resultVal = resultVal.."</i>" end
if bold then resultVal = resultVal.."</b>" end
return resultVal
end
end


Line 334: Line 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)
--  bold = whether to make first link bold
--  oneSearch = only emit one search result
--  italic = whether to make first link italic
--  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,linkText,categoryText,bold,italic,oneSearch,qid)
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"
-- construct default result (which searches for title)
local searchResult = _formatResult("[[Commons:Special:Search/"..wp_title.."|"..(linkText or wp_title).."]]",bold,italic)
if not oneSearch then
searchResult = searchResult.." ([[Commons:Special:Search/Category:"..wp_title.."|"..categoryText.."]])"
end
local trackingCats = ""
local trackingCats = ""
local galleryLink, galleryConsistent
local galleryLink, galleryConsistent
Line 371: Line 380:
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 or galleryLink
linkText = galleryLink
elseif categoryGood then
elseif categoryGood then
firstLink = "Category:"..categoryLink
firstLink = "Category:"..categoryLink
linkText = linkText or categoryLink
linkText = categoryLink
else
else
return searchResult..trackingCats
return searchResult..trackingCats
end
end
local resultVal = _formatResult("[[Commons:"..firstLink.."|"..linkText.."]]",bold,italic)
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.."]])"
Line 394: Line 409:
     s2 = mw.ustring.gsub(s2,"^[^:]+:","")
     s2 = mw.ustring.gsub(s2,"^[^:]+:","")
     return s1 == 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
end


Line 420: Line 479:
return ""
return ""
end
end
-- construct warning message
local msg = "Commons link does not match Wikidata"
msg = msg.."– [[Template:Commons_category#Resolving_discrepancies|please check]]"
local prefix = "[[Category:Commons "
if not fetchGallery and fetchCategory then
prefix = prefix.."category "
end
prefix = prefix.."link "
-- determine title and namespace of wikidata and wp article
-- determine title and namespace of wikidata and wp article
local wikidata = nil
local wikidata = nil
local consistent = nil
-- Tracking code works for all 4 cases of states of fetchGallery/Category
-- Tracking code works for all 4 cases of states of fetchGallery/Category
-- fetchGallery takes precedence
-- fetchGallery takes precedence
if fetchGallery then
if fetchGallery then
wikidata = p._hasGallery(qid)
wikidata, consistent = p._hasGalleryConsistent(qid)
if default or not fetchCategory or (consistent and wikidata) then
return selectTrackingCat(galleryTrackingCats,wikidata,consistent,
                    default,title)
end
end
end
if wikidata == nil and fetchCategory then
    if fetchCategory then
wikidata = p._hasCategory(qid,true)
local cat_wikidata, cat_consistent = p._hasCategoryConsistent(qid,true)
end
if not fetchGallery or (cat_consistent and cat_wikidata) then
     local wp_cat = (wp_ns == "Category")
return selectTrackingCat(categoryTrackingCats,cat_wikidata,
                    cat_consistent,default,title)
end
return selectTrackingCat(galleryTrackingCats,wikidata,consistent,
                    default,title)
     end
return "" -- nothing fetched, nothing tracked
end


if default then
local function _createFormatting(args)
if default == wikidata then
local formatting = {}
return prefix.."is on Wikidata]]"
formatting.linktext = args.linktext
end
formatting.lcfirst = yesNo(args.lcfirst)
if titleMatch(default,title) then
formatting.bold = yesNo(args.bold)
return prefix.."is defined as the pagename]]"..warning(msg)
formatting.italic = yesNo(args.italic)
end
formatting.nowrap = yesNo(args.nowrap)
return prefix.."is locally defined]]"..warning(msg)
return formatting
end
if wikidata then
return prefix.."from Wikidata]]"
end
return prefix.."is the pagename]]"
end
end


Line 472: Line 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.linktext,args.search,args.fallback,args.lcfirst,args.qid)
return p._getCommons("",args[1],args.search,args.fallback,_createFormatting(args),args.qid)
end
end


Line 478: Line 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.linktext,args.search,args.fallback,args.lcfirst,args.qid)
local retval = p._getCommons("Category", args[1],  
args.search, args.fallback, _createFormatting(args), args.qid
)
if args.tracking then
if args.tracking then
local default = nil
local default = nil
Line 484: Line 545:
default = "Category:"..args[1]
default = "Category:"..args[1]
end
end
retval = retval..p._tracking(default,false,true,args.qid)
retval = retval..p._tracking(default, false, true, args.qid)
end
end
return retval
return retval
Line 491: Line 552:
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.linktext,args.search,args.fallback,args.qid)
local retval = p._getGalleryOrCategory(
args[1], args.search, args.fallback, _createFormatting(args), args.qid
)
if args.tracking then
if args.tracking then
retval = retval..p._tracking(args[1],true,true,args.qid)
retval = retval..p._tracking(args[1],true,true,args.qid)
Line 515: Line 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.linktext,args.categoryText,
return p._getGalleryAndCategory(args[1], args[2],  
args.bold,args.italic,args.oneSearch,args.qid)
args.categoryText, args.oneSearch, _createFormatting(args), args.qid)
end
end


function p.tracking(frame)
function p.tracking(frame)
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false})
local args = getArgs(frame,{frameOnly=true,parentOnly=false,parentFirst=false})
return p._tracking(args[1],args.fetchGallery,args.fetchCategory,args.qid)
return p._tracking(args[1], args.fetchGallery, args.fetchCategory, args.qid)
end
end


return p
return p
Retrieved from "https://safernicotine.wiki/mediawiki/index.php/Module:Commons_link"