Modulo:DTSpecific

La documentazione per questo modulo può essere creata in Modulo:DTSpecific/man

--- This module represent the package containing specific functions to access data from the WikiBase instance DataTrek
-- @module p
-- @author Luca Mauri [[Utente:Lucamauri]]
-- Add other authors below
-- Keyword: wikitrek
local p = {}
local dump
local concat
local print
local QFromP = require('Modulo:DTGenerico').QFromP
local SeasonsQty = require('Modulo:DTSem').SeasonsQty
local LabelOrLink = require('Modulo:DTBase').LabelOrLink
--local PropertiesOnTree = require('Modulo:DTFunzioniComuni').PropertiesOnTree
local SeriesTree = require('Modulo:DTFunzioniComuni').SeriesTree

--- generates a list of backlink using SMW query.
-- 
-- @frame Info from MW session
-- @return A bullet list of appearances
function p.ListAppearancesOLD(frame)
	-- See example
	--[=[
	{{#ask: [[Interprete::Carl Tart]]
	 |?Carl Tart
	 |?Numero di produzione
	 |?Data di trasmissione
	 |format=ol
	 |sot=Numero di produzione
	 |order=asc
	 |class=sortable wikitable smwtable
	}}
	]=]

	-- See also
	--[=[
	{{#ask: [[Interprete::{{PAGENAME}}]]
	 |?{{PAGENAME}}
	}}
	]=]
	
	
	-- See example here https://github.com/SemanticMediaWiki/SemanticScribunto/blob/master/docs/mw.smw.getQueryResult.md
	-- See also here https://doc.semantic-mediawiki.org/md_content_extensions_SemanticScribunto_docs_mw_8smw_8getQueryResult.html
	local AllAppearances = {}
	local Appearances = {}
	local Appearance = {}
	local Episodes = {}
	--[=[
	local QueryResult = mw.smw.ask('[[Riferimento::' .. mw.title.getCurrentTitle().text .. ']]|?DataTrek ID|format=broadtable')
	
	if not QueryResult then
		return "''Nessun risultato''"
	else
		for _, Row in pairs(QueryResult) do
			local Items = {}
			for _, Field in pairs(Row) do
				if string.sub(Field, 1, 7) == "[[File:" then
					Items[#Items + 1] = "[[:" .. string.sub(Field, 3)
				else
					Items[#Items + 1] = Field
				end
			end
			AllBackReferences[#AllBackReferences + 1] = "*" .. table.concat(Items, ', ')
		end
		return table.concat(AllBackReferences, string.char(10))
	end
	]=]

	--local QueryResult = mw.smw.getQueryResult('[[Riferimento::' .. mw.title.getCurrentTitle().text .. ']]|?DataTrek ID')
	--local queryResult = mw.smw.getQueryResult( frame.args )
	--local QueryResult = mw.smw.getQueryResult('[[Interprete::' .. mw.title.getCurrentTitle().text .. ']]|?DataTrek ID')
	local Actor = mw.title.getCurrentTitle().text
	local QueryResult = mw.smw.getQueryResult('[[Interprete::' .. Actor .. ']]|?' .. Actor .. '|sort=Numero di produzione|order=asc')[1]
	
	if QueryResult == nil then
        return "''Nessun risultato''"
    end

    if type(QueryResult) == "table" then
        local Row = ""
        local CurrChar
        for k, v in pairs(QueryResult.results) do
        	-- v.fulltext						represents EPISODE
        	-- v.printouts[Actor][1].fulltext	represents CHARACTER
        	--[=[
        	if #v.printouts[Actor] == 1 then
        		AllAppearances[#AllAppearances + 1] = "* TEST - " .. v.printouts[Actor][1].fulltext
        	else
        		AllAppearances[#AllAppearances + 1] = "* TEST - " .. v.printouts[Actor][1].fulltext .. v.printouts[Actor][2].fulltext
        	end
    		]=]
    	
            --[=[if  v.fulltext and v.fullurl then
                myResult = myResult .. k .. " | " .. v.fulltext .. " " .. v.fullurl .. " | " .. "<br/>"
            else
                myResult = myResult .. k .. " | no page title for result set available (you probably specified ''mainlabel=-')"
            end]=]
            --[=[
            if string.sub(v.fulltext, 1, 5) == "File:" then
				Row = "[[:" .. v.fulltext .. "]]" --string.sub(v.fulltext, 3)
			else
				Row = "[[" .. v.fulltext .. "]]"
            end
            if v.printouts['DataTrek ID'][1] ~= nil then
            	Row = Row .. " - " .. v.printouts['DataTrek ID'][1]
            end
            ]=]
            
            --[=[
            for x, y in pairs(v.printouts) do
            	Row = Row .. k .. " -  " .. v.fulltext .. " - " .. x .. y[1].fulltext
            end
            ]=]
            
            if CurrChar == nil or CurrChar == "" then --or CurrChar ~= v.printouts[Actor][1].fulltext then
            	if Episodes ~= nil and CurrChar ~= nil then
            		-- episodes list contains data to print out, print it
            		Row = "[[" .. CurrChar .. "]]: [[" .. table.concat(Episodes, "]], [[") .. "]]"
            		Episodes = {}
            	end
        		
        		if v.printouts[Actor][1] == nil then
        			CurrChar = "''Senza pagina''"
        		else
        			CurrChar = v.printouts[Actor][1].fulltext
        		end
    			
            end
    		Episodes[#Episodes + 1] = v.fulltext
            
            --Row = k .. " -  " .. v.fulltext .. " - " .. v.printouts[Actor][1].fulltext
            
            --[=[
            if Appearance.Character == nil or Appearance.Character[v.fulltext] == nil then
            	Appearance.Character = v.fulltext
            end
        	
        	Appearance.Character[v.fulltext].Episodes[#Appearance.Character[v.fulltext].Episodes + 1] = v.printouts[Actor][1].fulltext
            Appearances[#Appearances + 1] = Appearence
            ]=]
			
			AllAppearances[#AllAppearances + 1] = "*" .. Row
        end
        	if Episodes ~= nil then
        		-- episodes list contains data to print out, print it
            	Row = "[[" .. CurrChar .. "]]: [[" .. table.concat(Episodes, "]], [[") .. "]]"
            	Episodes = {}
        	end
        	AllAppearances[#AllAppearances + 1] = "*" .. Row
        	
            --return '<pre>' .. dump(QueryResult) .. '</pre>'
        	return table.concat(AllAppearances, string.char(10)) --.. string.char(10) .. '<pre>' .. dump(QueryResult) .. '</pre>'
    else
    	return "''No table''"
    end

    return queryResult
end
--- generates a list of backlink using SMW query.
-- 
-- @frame Info from MW session
-- @return A bullet list of appearances
function p.ListAppearances(frame)
	local FinalArray = {}
	local FinalString = ""
	local Actor = mw.title.getCurrentTitle().text
	local QueryResult = mw.smw.getQueryResult('[[Interprete::' .. Actor .. ']]|?' .. Actor .. '|limit=500|sort=Numero di produzione|order=asc')
	
	if QueryResult == nil then
        return "''Nessun risultato''"
    end

    if type(QueryResult) == "table" then
    	for k, v in pairs(QueryResult.results) do
        	-- v.fulltext						represents EPISODE
        	-- v.printouts[Actor][1].fulltext	represents CHARACTER
        	local Episode = v.fulltext
        	local Character
        	
        	if v.printouts[Actor][1] == nil then
        		Character = "''Senza pagina''"
        	else
				for _, CurrChar in pairs(v.printouts[Actor]) do
					Character = CurrChar.fulltext
					if FinalArray[Character] == nil then
						FinalArray[Character] = {}
					end
    				table.insert(FinalArray[Character], Episode)
				end
        	end
        	
    	end
    else
    	return "''Il risultato non è una TABLE''"
    end
	
	for ID, Group in pairs(FinalArray) do
		FinalString = FinalString .. "* '''[[" .. ID .. "]]''': [[" .. table.concat(Group, "]], [[") .. "]]" .. string.char(10)
	end
	
	return FinalString
end

--- Content of a generic secondary box
-- 
-- @frame Info from MW session
-- @return Wikitext to inject in template
function p.SecBoxBuilder(frame)
	local TemplateName	
	local BoxTitle = ""
	local BoxContent = ""
	
	
	local SeriesQ
	local Short
	local CategoryNames = {}
	local UL
	local LI
	local Quantity
	local Categories
	local Seasons
	local Series
	local Preposizione
	local Others
	local Separator ="<hr />"
	local FullOutput = true
	local Output = {}
	
	-- Get page name and clean to get the name
	TemplateName = string.gsub(frame:getParent():getTitle(), "Template:", "")
	
	if TemplateName == "BoxSecEpisodio" then
		if mw.wikibase.getEntity().claims["P162"] ~= nil then
			BoxContent = BoxContent .. "<span class='titoletto'>Presentazione</span>"
			BoxContent = BoxContent .. "<p>" ..  mw.wikibase.getEntity().claims["P162"][1].mainsnak.datavalue.value .. "</p>"
		end
		
		Series = SeriesTree(frame)
		BoxContent = BoxContent .. "<span class='titoletto'>Serie</span>"
		BoxContent = BoxContent .. Series
		BoxTitle = "Titolo BoxSecEpisodio"
		--BoxContent = "Contenuto BoxSecEpisodio<br />" .. Series
	else
		--Series
	if frame.args[1] ~= nil then
		--Function is called from unliked page
		Series = mw.wikibase.getEntity(frame.args[1])
		Separator = " | "
		FullOutput = false
	elseif mw.wikibase.getEntity().claims["P14"][1].mainsnak.datavalue.value.id == "Q13" then
		-- Page is instance of Series
		Series = mw.wikibase.getEntity()
	elseif  mw.wikibase.getEntity().claims["P16"] ~= nil then
		Series = mw.wikibase.getEntity(QFromP("P16"))
	else
		-- Fall back to Short Treks
		Series = mw.wikibase.getEntity("Q8537")
	end
		
		
		BoxTitle = "Titolo " .. TemplateName
		BoxContent = "Contenuto " .. TemplateName
	end	
	
	
	
	--[=[
	Output example
	
	{{BoxSecondario
	|Titolo= Serie {{#if: {{#statements:P16}} | {{#statements:P16}} | ''No P16<!--{{#statements:P24}}-->'' }}
	|Contenuto={{#invoke:DTSpecific|SecBoxSeries|Q66}} 
	|Nome=BoxSecEpisodio
	}}
	--]=]
	return frame:expandTemplate{title = 'BoxSecondario', args = {Titolo = BoxTitle,  Contenuto = BoxContent, Nome = TemplateName}}
end

--- Content of secondary box
-- 
-- @frame Info from MW session
-- @return Wikitext to inject in template
function p.SecBoxSeries(frame)
	local SeriesQ
	local Series = ""
	local Short = ""
	local CategoryNames = {}
	local UL
	local LI
	local Quantity
	local Categories
	local Seasons
	local Series
	local Preposizione
	local Others
	local Separator ="<hr />"
	local FullOutput = true
	local Output = {}
	
	--Series
	if frame.args[1] ~= nil then
		--Function is called from unliked page
		Series = mw.wikibase.getEntity(frame.args[1])
		Separator = " | "
		FullOutput = false
	elseif mw.wikibase.getEntity().claims["P14"][1].mainsnak.datavalue.value.id == "Q13" then
		--Instance of the item is "Series"
		Series = mw.wikibase.getEntity()
	elseif mw.wikibase.getEntity().claims["P16"] ~= nil then
		Series = mw.wikibase.getEntity(QFromP("P16"))
	else
		--Episode
		Series = mw.wikibase.getEntity(mw.wikibase.getEntity(QFromP("P14")).claims["P16"][1].mainsnak.datavalue.value.id)
	end
	
	--Short name of the series
	--Short  = mw.wikibase.getEntity(SeriesQ).claims['P24'][1].mainsnak.datavalue['value']
	Short  = Series.claims['P24'][1].mainsnak.datavalue['value']
	
	if Short == "Serie Classica" or Short == "Serie Animata" then
		Preposizione = "della"
	else
		Preposizione = "di"
	end
		
	CategoryNames = {"SHORT|Serie", "Personaggi PREPOSIZIONE SHORT|Personaggi", "Episodi PREPOSIZIONE SHORT|Episodi", "SHORT - Ordine di produzione|Ordine di produzione", "SHORT - Titoli italiani|Titoli italiani"}
	
	UL = mw.html.create('ul')
	UL
		:attr('class', "compactul")
		:attr('title', "Categorie")
	
	for _, Name in ipairs(CategoryNames) do
		local Item
	
		Name = string.gsub(Name, "PREPOSIZIONE", Preposizione)
		Item = "[[:Categoria:" .. string.gsub(Name, "SHORT", Short) .. "]]"
		
		LI =  mw.html.create('li')
		LI:wikitext(Item)
		UL:node(LI)
	end
	Categories = tostring(UL)
	
	table.insert(Output, Categories)
	
	Quantity = SeasonsQty(Short)
	--mw.smw.set("Numero di stagioni = " .. Short)
	if Quantity < 1 then
		Seasons = "Errore: <1"
	else
		UL = mw.html.create('ul')
		UL
			:attr('class', "compactul")
			:attr('title', "Episodi")
		
		for Item = 0, Quantity, 1 do
			LI =  mw.html.create('li')
			
			if Item == 0 then
				LI:wikitext("[[Episodi " .. Preposizione .. " " .. Short .. "|Tutti]]")
			elseif Item == 1 then
				LI:wikitext("Stagioni: [[Stagione " .. Item .. " "  .. Preposizione .. " " .. Short .. "|" .. Item .. "]]")
			else
				LI:wikitext("[[Stagione " .. Item .. " "  .. Preposizione .. " " .. Short .. "|" .. Item .. "]]")	
			end
			UL:node(LI)
		end
		Seasons = tostring(UL)
		table.insert(Output, Seasons)
	end
	
	if FullOutput then 
		--Other pages
		UL = mw.html.create('ul')
		UL
			:attr('class', "compactul")
			:attr('title', "Altre pagine")
			
		LI =  mw.html.create('li')
		LI:wikitext("[[Personaggi ricorrenti " .. Preposizione .. " " .. Short .. "]]")
		UL:node(LI)
		
		Others = tostring(UL)
		table.insert(Output, Others)
	end
	
	if FullOutput then
		--All Series
		local SeriesQuery = mw.smw.getQueryResult('[[Istanza::Serie]]|?Abbreviazione|sort=Ordinale|order=asc')
		
		if SeriesQuery == nil then
	        Series = "''Nessun risultato''"
	    end
	
	    if type(SeriesQuery) == "table" then
	    	UL = mw.html.create('ul')
			UL
				:attr('class', "compactul")
				:attr('title', "Tutte le serie")
	    	for _, CurrSeries in ipairs(SeriesQuery.results) do
	    		--In the output, example:
	    		--"fulltext": "Star Trek: Strange New Worlds",
	    		LI =  mw.html.create('li')
	        	LI:wikitext("[[" .. (CurrSeries.fulltext or "NullFulltext") .. "|" .. (CurrSeries.printouts.Abbreviazione[1] or "NullAbbreviazione") .. "]]")
	        	
	        	UL:node(LI)
	    	end
	    	Series = tostring(UL)
	    else
	    	Series = "''Il risultato non è una TABLE''"
	    end
	    table.insert(Output, Series)
	end

	--return Categories .. "<hr />" .. Seasons .. "<hr />" .. Others .. "<hr />" .. Series 
	return table.concat(Output, Separator)
--[==[
<strong>Categorie</strong>
<ul class="compactul">
<li>[[:Categoria:Strange New Worlds|Serie]]</li>
<li>[[:Categoria:Personaggi di Strange New Worlds|Personaggi]]</li>
<li>[[:Categoria:Episodi di Strange New Worlds|Episodi]]</li>
<li>[[:Categoria:Strange New Worlds - Ordine di produzione|Ordine di produzione]]</li>
<li>[[:Categoria:Strange New Worlds - Titoli italiani|Titoli italiani]]</li>
</ul>
<hr />
]==]
end

--- Listo of "motto" sentences (P104) for Template:BoxAvvisi
-- 
-- @frame Info from MW session
-- @return Wikitext to inject in template
function p.MottoBoxes(frame)
	local Subject
	local Boxes = {}
	--Series
	if frame.args[1] ~= nil then
		--Function is called from unliked page
		Subject = mw.wikibase.getEntity(frame.args[1])
	else
		Subject = mw.wikibase.getEntity()
	end
	
	for _, Motto in ipairs(Subject.claims["P104"]) do
		local Sentence
		local Author
		local Reference
		
		Sentence = Motto.mainsnak.datavalue.value
		Author = LabelOrLink(Motto.qualifiers["P47"][1].datavalue.value.id)
		Reference =LabelOrLink(Motto.qualifiers["P58"][1].datavalue.value.id)
		
		table.insert(Boxes, frame:expandTemplate{ title = 'quote', args = {text = Sentence, sign = Author, source = Reference} })
	end
	
	return table.concat(Boxes, string.char(10))
end

--- This dumps the variable (converts it into a string representation of itself)
--
-- @param entity mixed, value to dump
-- @param indent string, can bu used to set an indentation
-- @param omitType bool, set to true to omit the (<TYPE>) in front of the value
--
-- @return string
dump = function(entity, indent, omitType)
    local entity = entity
    local indent = indent and indent or ''
    local omitType = omitType
    if type( entity ) == 'table' then
        local subtable
        if not omitType then
            subtable = '(table)[' .. #entity .. ']:'
        end
        indent = indent .. '\t'
        for k, v in pairs( entity ) do
            subtable = concat(subtable, '\n', indent, k, ': ', dump(v, indent, omitType))
        end
        return subtable
    elseif type( entity ) == 'nil' or type( entity ) == 'function' or type( entity ) == 'boolean' then
        return ( not omitType and '(' .. type(entity) .. ') ' or '' ) .. print(entity)
    elseif type( entity ) == 'string' then
        entity = mw.ustring.gsub(mw.ustring.gsub(entity, "\\'", "'"), "'", "\\'")
        return concat(omitType or '(string) ', '\'', entity, '\'')
    else
        -- number value expected
        return concat(omitType or '(' .. type( entity ) .. ') ', entity)
    end
end
--- Concatenates a variable number of strings and numbers to one single string
-- ignores tables, bools, functions, and such and replaces them with the empty string
--
-- What is the benefit of using variable.concat instead of the .. operator?
-- Answer: .. throws an error, when trying to concat bools, tables, functions, etc.
-- This here handels them by converting them to an empty string
--
-- @param ... varaibles to concatenate
--
-- @return string
concat = function(...)
    local args = {...}
    if #args == 0 then
        error('you must supply at least one argument to \'concat\' (got none)')
    end
    local firstArg = table.remove(args, 1)
    if type(firstArg) == 'string' or type(firstArg) == 'number' then
        firstArg = print(firstArg)
    else
        firstArg = ''
    end
    if #args == 0 then
        return firstArg
    else
        return firstArg .. concat(unpack(args))
    end
end
--- This function prints a variable depending on its type:
-- * tables get concatenated by a comma
-- * bools get printed as true or false
-- * strings and numbers get simple returned as string
-- * functions and nils return as emtpy string
-- @return string
print = function(v)
    if type( v ) == 'table' then
        return table.concat(v, ',')
    elseif type( v ) == 'boolean' then
        return ( v and 'true' or 'false' )
    elseif type(v) == 'string' or type(v) == 'number' then
        return tostring(v)
    else
        return ''
    end
end
return p