Module:ServicesList

From MaRDI portal
Revision as of 00:26, 22 November 2024 by Tconrad (talk | contribs)

Documentation for this module may be created at Module:ServicesList/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 p.convertJsonToHTMLCards(jsonResults)
    local resultsHTML = ""
    
    if jsonResults and jsonResults.results and jsonResults.results.bindings then
        local bindings = jsonResults.results.bindings
        for i = 0, #bindings do
            local binding = bindings[i]
            
            -- Extract fields from the bindings
            local name = binding.name and binding.name.value or "Unnamed Service"
            local category = binding.category and binding.category.value or "No Category"
            local maintainer = binding.maintainer and binding.maintainer.value or "Unknown maintainer"
            local maintainer_url = binding.maintainer_url and binding.maintainer_url.value or " "
            local description = binding.description and binding.description.value or "No description available."
            local status = binding.status and binding.status.value or "No status available."
            local link = binding.item and binding.item.value:gsub("entity/Q", "wiki/Service:") or "#"
            local imageName = binding.icon and binding.icon.value or "File:Test-uplad.png" -- Default placeholder image
            -- Extract only the "File:..." portion from the URL
			imageName = imageName:match("File:.*") or imageName
            local image = "[[" .. imageName .. "|200px|left|link=]]"

            -- Build individual card HTML
            resultsHTML = resultsHTML .. string.format([[
                <table style="border: 0; width: 100%%; margin: 10px 0;">
                    <tr>
                        <!-- Left column for the image -->
                        <td style="width: 200px; vertical-align: top; padding-right: 10px;">
                            %s
                        </td>
                        <!-- Right column for the text -->
                        <td style="vertical-align: top;">
                            <h3 style="font-weight: bold; margin: 0;">[%s %s]</h3>
                            <div style="font-weight: bold; margin: 2px 0 0 0;">%s (%s)</div>
                            <p style="margin: 10px 0;">%s</p>
                            <div style="font-size: 12px; color: #888;">Maintained by: [%s %s]</div>
                        </td>
                    </tr>
                </table>
            ]], image, link, name, category, status, description, maintainer_url, maintainer)
        end
    end

    return resultsHTML
end

-- Function to build the list
function p.buildServiceList(frame)
	
    -- Constructing the SPARQL query with dynamic entity target1
    local sparqlQuery = [[
PREFIX wdt: <https://portal.mardi4nfdi.de/prop/direct/>
PREFIX wd: <https://portal.mardi4nfdi.de/entity/>

SELECT ?item ?name ?maintainer ?maintainer_url ?icon ?category ?description ?status
WHERE { 
  ?item wdt:P1460 wd:Q6503324 .
  ?item rdfs:label ?name .
  OPTIONAL { ?item wdt:P19 ?maintainer_url .
             ?maintainer_url rdfs:label ?maintainer . }
  OPTIONAL { ?item wdt:P1641 ?category_url .
             ?category_url rdfs:label ?category . }
  OPTIONAL { ?item wdt:P1640 ?icon . }
  OPTIONAL { ?item wdt:P1459 ?description . }
  OPTIONAL { ?item wdt:P230 ?status_url .
             ?status_url rdfs:label ?status . 
  			 FILTER(LANG(?status) = "en") }
}
    ]]
    
    -- 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 serviceList = p.convertJsonToHTMLCards(jsonResults)
	
    return serviceList
end

-- Return the created html table
return p