Module:PublicationUsesSoftwareList

Documentation for this module may be created at Module:PublicationUsesSoftwareList/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 name = binding.valueLabel.value
                if string.find(name, "https://") then
                	name = helper.titleNotAvailableStrPlain()
                end

				-- Extract QID from value URI
				local qid = binding.value.value:match("(Q%d+)$")

				-- Get sitelink via mw.wikibase
				local sitelink = mw.wikibase.getSitelink(qid)
				local nameAndLink
				if sitelink then
					nameAndLink = "<li>[[:" .. sitelink .. "|" .. name .. "]]</li>"
				else
					nameAndLink = "<li>" .. name .. "</li>"
				end

                resultsString = resultsString .. nameAndLink
            end
        end
    end

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


-- Function to build the list
function p.getUsedSoftwareList(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 ?property ?propertyLabel ?value (COALESCE(?valueLabel, STR(?value)) AS ?valueLabel)
WHERE {
    target: wdt:P1463 ?value .
    BIND(wdt:P1463 AS ?property)
    OPTIONAL { ?value rdfs:label ?valueLabel . FILTER(LANG(?valueLabel) = "en") }
    OPTIONAL { ?property rdfs:label ?propertyLabel . FILTER(LANG(?propertyLabel) = "en") }
}
ORDER BY ?propertyLabel
]]
    
    -- 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) 

	local result = [[
<div class="keywords-header">
<span class="keywords-title">Uses Software</span>
<div class="keywords-line"></div>
</div>
]] .. frame:preprocess('<div class="keywords-list">' .. linkList .. '</div>')

    return result
end

-- Return the created html table
return p