Module:SoftwareCitationList

Documentation for this module may be created at Module:SoftwareCitationList/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.valueLabel and binding.valueLabel.value then
                local name = binding.valueLabel.value
                local noTitle = false
                if string.find(name, "https://") then
                	name = "Unnamed Publication"
                	noTitle = true
                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 noTitle then
					local articleLink
					if sitelink then
						articleLink = "[[:" .. sitelink .. "|" .. name .. "]]"
					else
						articleLink = name
					end
					nameAndLink = "<li>" .. articleLink .. "</li>"
				else
					if sitelink then
						nameAndLink = "<li>[[:" .. sitelink .. "|" .. name .. "]]</li>"
					else
						nameAndLink = "<li>" .. name .. "</li>"
					end
				end

                resultsString = resultsString .. nameAndLink
            end
        end
    end

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


-- Function to build the list
function p.buildCitationList(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)
WHERE {
    target: wdt:P223 ?value .
    OPTIONAL { ?value rdfs:label ?valueLabel . FILTER(LANG(?valueLabel) = "en") }
    OPTIONAL { ?value wdt:P31 ?type . }
}
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 "Could not fetch data."
	end
	
	if helper.countElementsInBindings(jsonResults.results.bindings) == 0 then
        return "No records found."
	end

	local citationList = p.convertJsonToCommaSeparatedList(jsonResults, frame)
	
	-- mw.log(citationList) 
	
    return frame:preprocess(citationList)
end

-- Return the created html table
return p