Module:PublicationCitesWork

From MaRDI portal

Documentation for this module may be created at Module:PublicationCitesWork/doc

-- Required module containing helper methods
local helper = require('Module:HelperMethods')

-- Required modules for SPARQL queries and HTML table generation
local sparql = require('SPARQL')
local mwHtml = require('mw.html')

-- Main table to hold all functions
local p = {}

-- Function to convert JSON results into a comma-separated string
function p.convertJsonToCommaSeparatedList(jsonResults, frame)
	local resultsString = ""
	
	if jsonResults and jsonResults.results and jsonResults.results.bindings then
        local bindings = jsonResults.results.bindings
        for i = 0, #bindings do
            local binding = bindings[i]
            if binding and binding.valueLabel and binding.valueLabel.value then
                local noTitle = false 
                local name = binding.valueLabel.value

                -- Extract zbmath_de_number if present, otherwise nil
                local zbmath_de_number = binding.zbmath_de_number and binding.zbmath_de_number.value or nil

                if string.find(name, "https://") then
                	name = helper.titleNotAvailableStrPlain(zbmath_de_number)
                	noTitle = true
                end
                
				-- Determine display prefix based on type
				local itemType = binding.type and binding.type.value or ""
				local itemTypeQID = itemType:match("Q%d+")				
				
				local displayPrefix = ""
				
				if itemTypeQID == "Q56885" then
					displayPrefix = "(DATASET) "
				elseif itemTypeQID == "Q56887" then
					-- publication, no display prefix
				elseif itemTypeQID == "Q57080" then
					displayPrefix = "(SOFTWARE) "
				elseif itemTypeQID == "Q68657" then
					displayPrefix = "(WORKFLOW) "
				end                
				
				-- Extract QID from value URI
				local qid = binding.value.value:match("(Q%d+)$")

				-- Get sitelink and label via mw.wikibase
				local sitelink = mw.wikibase.getSitelink(qid)
				local nameAndLink

				if noTitle then
					local articleLink
					if sitelink then
						articleLink = "[[:" .. sitelink .. "|" .. displayPrefix .. name .. "]]"
					else
						articleLink = displayPrefix .. name
					end
					local reasonLink = frame:preprocess(helper.titleNotAvailableReasonLink())
					nameAndLink = "<li>" .. articleLink .. " (" .. reasonLink .. ")</li>"
				else
					local label = mw.wikibase.getLabel(qid) or qid
					if sitelink then
						nameAndLink = "<li>[[:" .. sitelink .. "|" .. displayPrefix .. label .. "]]</li>"
					else
						nameAndLink = "<li>" .. displayPrefix .. label .. "</li>"
					end
				end

                resultsString = resultsString .. nameAndLink
            end
        end
    end

	return "<ul> " .. resultsString .. " </ul>"
end


-- Function to build the list
function p.getCitesWorkList(frame)
	
    -- Retrieve target1 from frame arguments or return error message if not set
	local target1 = frame.args[1]
    if not target1 or target1 == '' then
        return "No records found"
    end    
    
    -- Constructing the SPARQL query with dynamic entity target1
    local sparqlQuery = [[
PREFIX target: <https://portal.mardi4nfdi.de/entity/]] .. target1 .. [[>
PREFIX wdt: <https://portal.mardi4nfdi.de/prop/direct/>
PREFIX wd: <https://portal.mardi4nfdi.de/entity/>
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>

SELECT ?value (COALESCE(?valueLabel, STR(?value)) AS ?valueLabel) (SAMPLE(?type) AS ?type) (SAMPLE(?typeLabel) AS ?typeLabel) (SAMPLE(?zbmath_de_number) AS ?zbmath_de_number)
WHERE {
  target: wdt:P223 ?value .
  OPTIONAL { ?value rdfs:label ?valueLabel . FILTER(LANG(?valueLabel) = "en") }
  OPTIONAL {
    ?value wdt:P31 ?type .
    OPTIONAL { ?type rdfs:label ?typeLabel . FILTER(LANG(?typeLabel) = "en") }
  }
  OPTIONAL { ?value wdt:P1451 ?zbmath_de_number . }
}
GROUP BY ?value ?valueLabel
ORDER BY ?valueLabel]]
    
    -- mw.log( sparqlQuery )
    
	-- Executing the SPARQL query and retrieving results in JSON format
	local jsonResults = sparql.runQuery(sparqlQuery)
	
	mw.logObject(jsonResults)

	-- Handle error in SPARQL query execution
	if jsonResults and jsonResults.error then
    	mw.log("Error in SPARQL query: " .. tostring(jsonResults.error))
    	return nil
	end

	if not jsonResults then
        return nil
	end
	
	if helper.countElementsInBindings(jsonResults.results.bindings) == 0 then
        return nil
	end

	local linkList = p.convertJsonToCommaSeparatedList(jsonResults, frame)
	-- mw.log(linkList) 
	
	return frame:preprocess('<div class="keywords-list">' .. linkList .. '</div>')

end

-- Return the created html table
return p