Modul:Participation

Module documentation[view] [edit] [history] [purge]

Dieses Modul kommt direkt auf Seiten im Namensraum "Spielteilnahme" zum Einsatz. Es prüft, ob es eine Spielfigur mit dem gleichen Namen wie die aktuelle Seite hat gibt und zeigt dann für die entsprechende Figur eine Übersicht aller Spiele und den Teilnahmestatus an. Zusätzlich gibt es für jedes Spiel eine Möglichkeit, sich direkt An- oder abzumelden.

Usage

{{#invoke:Participation|main}}

Example

See Spielteilnahme:Caspar.

local config = {
	playPlayerDelimiter = ',',
	signalAbsent = '[[File:X mark.png|13px|alt=Abwesend|Abwesend]]',
	signalPresent = '[[File:Yes check.png|13px|alt=Anwesend|Anwesend]]',
	validNamespace = 'Spielteilnahme',
	validTargetPageCategory = 'Figuren'
}

local p = {}
local smw = mw.smw
local tt = require( 'Module:TableTools' )

local currentTitle = nil

function assertCorrectNamespace( title, namespace )
	return title.nsText == namespace
end

function assesPrerequisites()
	if not assertCorrectNamespace(
		getCurrentTitle(),
		config.validNamespace
		) then
		return false, 'Diese Vorlage darf nur im Namensraum \'\''
			.. config.validNamespace
			.. '\'\' verwendet werden!'
	end
	if not assertTargetIsValid(
		getCurrentTitle().text,
		config.validTargetPageCategory
		) then
		return false, 'Die Seite mit dem Namen \'\''
			.. getCurrentTitle().text
			.. '\'\' existiert nicht oder ist keine Figur!'
	end
	return true
end

function assertTargetIsValid( targetPageName, validCategory )
	--[=[
	-- ssc's '?Category:' .. validCategory handling seems broken atm
	local query = {
		'[[' .. targetPageName .. ']]',
		'?Category:' .. validCategory
	}
	--]=]
	local query = {
		'[[' .. targetPageName .. ']]',
		'?Category#=pageCategories'
	}
	local res = smw.ask ( query )
	if not res[1] or not res[1].pageCategories then
		return false
	end
	return tt.inTable( res[1].pageCategories, 'Kategorie:' .. validCategory )
end

function alertBox( text )
	return '<div class="alert alert-danger" role="alert">'
		.. '<strong>Achtung:</strong> ' .. text
		.. '</div>'
end

function getCurrentTitle()
	if currentTitle ~= nil then
		return currentTitle
	end
	currentTitle = mw.title.getCurrentTitle()
	return currentTitle
end

function getPlayData()
	local query = {
		'[[Category:Spiele]]',
		'?#=play',
		'?Has number#=number',
		'?Has character participating#=characters',
		'?Has display name#=displayName',
		'?Has title#=title',
		'?Is held in#=place',
		'?Is held at#-F[Y]=time',
		'mainlabel=-'
	}
	res = smw.ask( query )
	if not res then
		return {}
	end
	local playData = {}
	for k, row in pairs(res) do
		if row and row.number and row.title then
			if not row.characters then
				row.characters = {}
			end
			if type( row.characters ) ~= 'table' then
				row.characters = { row.characters }
			end
			playData[row.number] = row
		end
	end
	return playData
end

function buildControlStatusAndButton( characters, character, targetPage )
	-- nach oben schieben
	local frame = mw.getCurrentFrame()
	local participating = tt.inTable( characters, character )
	local status = participating and config.signalPresent or config.signalAbsent
	local newCast = characters
	if participating then
		for k, v in pairs( newCast ) do
			if v == character then
				newCast[k] = nil
			end
		end
	else
		table.insert( newCast, character )
	end
	local button = frame:callParserFunction{ name = '#autoedit', args={
		form='Spiel',
		target=targetPage,
		'link text=' .. ( participating and 'Abmelden!' or 'Anmelden!'),
		summary='Figur ' .. character .. ' wurde ' .. ( participating and 'ausgetragen' or 'eingetragen' ),
		tooltip='Durch Klicken, die Figur ' .. character .. ( participating and ' ausgetragen' or ' eingetragen' ),
		'query string=play[cast]=' .. table.concat( newCast, config.playPlayerDelimiter ),
		'reload'
		}
	}
	button = '<div class="btn btn-' .. ( participating and 'danger' or 'success' ) .. '">' .. button .. '</div>'
	-- {{#autoedit:form=|target=|link text=|link type=|summary=|tooltip=|query string=query string parameters|reload}}
	return status, button
end

function buildControlTableHeader()
	local header = mw.html.create( 'tr' )
	header:tag('th')
		:wikitext('Spiel')
		:done()
		:tag('th')
		:wikitext('Titel')
		:done()
		:tag('th')
		:wikitext('Ort')
		:done()
		:tag('th')
		:wikitext('Jahr')
		:done()
		:tag('th')
		:wikitext('Status')
		:done()
		:tag('th')
		:wikitext('Aktion')
		:done()
	return header
end

function buildControlTableBody( playData, character )
	-- nach oben schieben
	local body = mw.html.create( '' )
	for num, play in pairs( playData ) do
		local status, button = buildControlStatusAndButton( play.characters, character, play.play )
		local tr = mw.html.create('tr')
		tr:tag( 'td' )
			:wikitext( play.number )
			:done()
		tr:tag( 'td' )
			:wikitext( '[[' .. play.play .. '|' .. play.title .. ']]' )
			:done()
		tr:tag( 'td' )
			:wikitext( play.place and play.place or 'unbekannt' )
			:done()
		tr:tag( 'td' )
			:wikitext( play.time and play.time or 'unbekannt' )
			:done()
		tr:tag( 'td' )
			:wikitext( status )
			:done()
		tr:tag( 'td' )
			:wikitext( button )
			:done()
		body:node(tr)
	end
	return body
end

function printParticipationControl( playData, character )
	local text = '== Spielteilnahmen für ' .. character .. ' ==\n'
	text = text .. 'Diese Seite zeigt Dir eine Übersicht der Spielteilnahmen für die Figur \'\''
		.. character .. [[
\'\ und erlaubt es Dir, sie für Spiele einzutragen oder aus Spielen wieder auszutragen. Bitte beachte, dass
jeder Vorgang das neu Laden der Seite nach sich zieht und daher etwas dauern kann. ]]

	local t = mw.html.create('table')
	t:addClass( 'table table-striped table-bordered sortable' )
		:node( buildControlTableHeader() )
		:node( buildControlTableBody( playData, character ) )
	return text .. tostring(t)
end

function p.main( frame )
	local assesmentResult, assesmentMessage = assesPrerequisites()
	if not assesmentResult then
		return alertBox( assesmentMessage )
	end
	-- all is well
	local playData = getPlayData()
	return printParticipationControl(
		playData,
		getCurrentTitle().text
	)
end

-- pt = require('Module:TableTools').printTable

return p