An application for managing observed trials motorbike and bicycle competitions. The documentation, code, and user interface are all in German.
JavaScript Perl HTML Perl6 Python Makefile Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.OLD

TrialInfo
=========

TrialInfo ist ein Auswertungssystem für Trial Motorrad- und Fahrrad-
Wettbewerbe. Es unterstützt alle wesentlichen Schritte zur Verwaltung einzelner
Veranstaltungen und zur Erstellung von Gesamtwertungen über mehrere
Veranstaltungen.

Folgende Funktionen werden unterstützt:

 * Anlegen, Ändern und Löschen von Veranstaltungen.  Konfigurieren von
   Veranstaltungen (Wertungen, Klassen, befahrene Sektionen, usw.).

 * Anlegen und Ändern von Fahrern, Zuweisen von Startnummern, Auswahl der
   Starter einer Veranstaltung.

 * Verwaltung von Gruppen und Erstellung von Gruppenwertungen.

 * Erfassung der Ergebnisse (Punkte, Ausfall, Stechen, Start- und Zielzeit).

 * Erstellung verschiedener Fahrerlisten und von Ergebnislisten online und
   als PDF-Dateien.

 * Definition von Veranstaltungsreihen (enthaltene Veranstaltungen und Klassen,
   Anzahl der Läufe und Streichresultate, Startnummernänderungen zwischen
   Veranstaltungen).

 * Import von und Export auf Dateien. Import vom und Export in das Programm
   TrialTool von Ortwin Sann [1].

 * Import direkt von einem Server. Laufende Synchronisierung auf einen Server.

 * Präsentationsmodus (für einen externen Bildschirm).

Das System ist komplett über einen Web-Browser bedienbar.  Es kann von mehreren
Geräten aus gleichzeitig verwendet werden. Wird dabei versucht, die selben
Daten mehrfach zu verändern, dann werden diese Konflikte erkannt, und es kommt
zu Fehlermeldungen


Systemvoraussetzungen
=====================

 * Ein einigermaßen aktuelles Linux-System.  (Dieses System kann auch
   innerhalb einer virtuellen Maschine laufen.)

 * Die Scriptsprache Perl. Zusätzlich folgende Pakete oder Perl-Module:
   perl-DBD-MySQL, perl-CGI, perl-JSON, perl-Clone, perl-URI-Escape oder
   perl-Any-URI-Escape + perl-URI-Escape-XS, perl-Class-Accessor-Lite,
   perl-Module-Load, perl-Module-Loaded, perl-Encode-Locale, perl-IO-Zlib,
   perl-PDF-API2, perl-HTML-Entities-Interpolate.

   (Die Paketnamen weichen teilweise ab; unter Debian heißt perl-PDF-API2
   z.B. libpdf-api2-perl.)

 * Die Datenbank MySQL (bzw. MariaDB).

 * Den Apache Web-Server.


Konfiguration
=============

Datenbank
---------

In MySQL ist wichtig, dass eine transaktionsfähige Datenbank-Engine  (InnoDB,
nicht MyISAM) verwendet wird.


  Beispiel
  --------

  $ mysqladmin --user=root password
  New password: 
  Confirm new password: 

  $ mysql --user=root --password
  Enter password: 
  > CREATE DATABASE trialinfo CHARACTER SET utf8;
  > CREATE USER 'trialinfo'@'localhost' IDENTIFIED BY 'password';
  > CREATE USER 'trialinfo'@'%' IDENTIFIED BY 'password';
  > GRANT ALL PRIVILEGES ON trialinfo.* TO 'trialinfo'@'%';


Die anfängliche Datenbankstruktur lässt sich danach mit "db-sync
--create-tables" erzeugen.


  Beispiel
  --------
  $ ./db-sync.pl --db='mysql:trialinfo;host=localhost' \
		 --user=admin \
		 --password=password \
		 --create-tables


  /etc/my.cnf.d/server.cnf
  ------------------------
  Add STRICT_TRANS_TABLES to sql_mode:

  [server]
  sql_mode=STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION


Web Server
----------

Die Dateien im Verzeichnis "htdocs" müssen in einem Dokumentenverzeichnis
liegen; die Dateien im Verzeichnis "cgi-bin" in einem Verzeichnis, in dem der
Web Server CGI-Scripts ausführen darf.

Die *.shtml - Dateien müssen vom Web Server als Server Side Include-Dateien
(SSI) verarbeitet werden.

  Beispielkonfiguration für Apache:

    <VirtualHost *:80>
	DocumentRoot /home/agruen/trialinfo/htdocs
	ServerName www.trialinfo.at

	ScriptAlias /cgi-bin/ "/home/agruen/trialinfo/cgi-bin/"

	<LocationMatch ".*">
	    Require all granted
	</LocationMatch>

	<Directory "/home/agruen/trialinfo/htdocs">
	    Options Indexes
	    AllowOverride All
	</Directory>

	<Directory "/home/agruen/trialinfo/cgi-bin">
	    Options None
	    AllowOverride All
	</Directory>

	<LocationMatch "^/(|login/?|admin/|register/event/\d+|logout|signup|reset|change-password|admin/config.js|api/.*)$">
	    ProxyPassMatch "http://localhost:3080/$1"
	</LocationMatch>
    </VirtualHost>

Die Verzeichnisse htdocs/veranstalter/, cgi-bin/veranstalter/, admin/, api/
geben auch Zugriff auf Funktionen, die üblicherweise nicht öffentlich
zugänglich sein sollen.

Je nach Konfiguration kann es sein, dass die Konfiguration für TrialInfo mit
dem Befehl "a2ensite" aktiviert werden muss.

Standardmäßig ist der Zugriff auf den Veranstalter-Bereich auf die Gruppe
"veranstalter" beschränkt.  Zum Rechtemodell in der Administration siehe unten.

Um Benutzer zu definieren, muss eine Datei .htpasswd erzeugt werden (Utility
"hdpasswd"). Diesen Benutzern müssen dann in der Datei .htgroup die
entsprechenden Gruppen zugewiesen werden.


SELinux
-------

  $ semanage fcontext -a -t httpd_sys_content_t '/home/agruenba/trialinfo/htdocs'(/.*)?'
  $ restorecon -r /home/agruenba/trialinfo/htdocs
  $ semanage port -a -t http_port_t -p tcp 3080

  Wenn die Daten in einem Home Directory liegen, lässt sich SELinux nicht
  leicht so konfigurieren, dass die CGI-Scripts funktionieren.  Sonst sollte
  folgendes klappen:

  $ semanage fcontext -a -t httpd_sys_script_exec_t '/home/agruenba/trialinfo/cgi-bin(/.*)?'
  $ restorecon -r /home/agruenba/trialinfo/cgi-bin

  So kann man selbst erstellte File Context-Regeln anzeigen:

  $ semanage fcontext -l -C


Systemd
-------

  /etc/systemd/system/trialinfo.service
  ------------------------------------------
  [Unit]
  Description=TrialInfo

  [Service]
  ExecStart=/usr/bin/node index.js
  WorkingDirectory=/var/www/trialinfo/backend/dist
  StandardOutput=journal
  SyslogIdentifier=trialinfo
  User=trialinfo
  Group=trialinfo
  Environment=NODE_ENV=production
  Environment=TRIALINFO=systemd


  /etc/systemd/system/trialinfo.socket
  -----------------------------------------
  [Socket]
  ListenStream=3080

  [Install]
  WantedBy=sockets.target


  $ systemctl daemon-reload
  $ systemctl enable trialinfo.socket

  $ journalctl -u trialinfo
  $ journalctl -f -u trialinfo

Git post-receive hook
---------------------

    export GIT_WORK_TREE=/var/www/trialinfo
    git checkout -f

    make -C $GIT_WORK_TREE install
    make -C $GIT_WORK_TREE build

    sudo /bin/systemctl stop trialinfo.service
    sudo /bin/systemctl restart trialinfo.socket


Herunterladen und erzeugen diverser Dateien
-------------------------------------------

Um einige Dateien wie Angular.js herunterzuladen und passende .htaccess-Dateien
zu erzeugen, kann Make verwendet werden:

  $ make
  $ make install


Apache-Module
-------------

Auf manchen Systemen wie Ubuntu 15.04 müssen die verwendeten Apache-Module
mit folgendem Befehl aktiviert werden:

  $ a2enmod include.load cgid.load authz_groupfile.load rewrite.load


Scripts
-------

Die Scripts lassen sich über die Datei lib/Auswertung.pm konfigurieren.  Die
Einstellungen dort betreffen Dinge wie die Zugriffsdaten auf die Datenbank.

Achtung: Diese Datei lib/Auswertung.pm muss per Hand erzeugt werden, teilweise
BEVOR DIE SCRIPTS VERWENDET WERDEN KÖNNEN.  Eine Vorlage dafür befindet sich in
der Datei lib/Auswertung.pm.txt.


DEB-Paket bauen
===============

$ dnf install dpkg dpkg-dev debhelper devscripts
$ make release
$ ./deb.sh trialinfo-0.1.tar.gz
$ debsign ... ?

(When dpkg-buildpackage builds packages builds packages as non-root, it uses
fakeroot which makes the build takes extremely long.)


Veranstaltungsverwaltung
========================

Nach der Konfiguration der verschiedenen Komponenten ist die
Veranstaltungsverwaltung im Pfad /admin/ auf dem Web-Server verfügbar.


Rechtemodell und Rechteverwaltung
=================================

Auf den Administrationsbereich haben nur für den Web-Server definierte Benutzer
Zugriff.  Dabei sehen Benutzer nur diejenigen Veranstaltungen und
Veranstaltungsreihen, zu denen sie zumindest Lesezugriff haben.

Legt ein Benutzer eine neue Veranstaltung oder Veranstaltungsreihe an, dann
bekommt er dort Schreib-/Lesezugriff.  Falls der Benutzer zu diesem Zeitpunkt
noch nicht in der Datenbank existiert, wird er dort angelegt.

Zusätzlich können Benutzer als Administratoren markiert sein, dann haben sie
Schreib-/Lesezugriff auf alle Veranstaltungen und Veranstaltungsreihen.

Weiters lassen sich direkt in der Datenbank zusätzliche Rechte vergeben, es
lassen sich Gruppen von Benutzern definieren, und es kann definiert werden, wie
Berechtigungen zwischen Veranstaltungen "vererbt werden", wenn eine
Veranstaltung auf Basis einer anderen Veranstaltung erzeugt wird.

Veranstaltungen "erben" auch die Zugehörigkeit zu Veranstaltungsreihen von
ihrer Basisveranstaltung, sofern der Benutzer Schreibzugriff auf die jeweilige
Veranstaltungsreihe hat.


Reihung in der Jahreswertung
============================

Fahrer werden zunächst anhand ihrer Gesamtpunkteanzahl gereiht, wobei die
Punkte aus Streichresultaten abgezogen sind.

Bei gleichem Punktestand werden alle erzielten Ergebnisse inklusive der
Streichresultate verglichen.  Der Fahrer mit mehr guten Platzierungen, also mit
mehr ersten Plätzen, oder mit mehr zweiten Plätzen bei gleicher Anzahl erster
Plätze, usw., gewinnt.

Danach gewinnt der Fahrer mit mehr Streichpunkten.

Wenn danach immer noch Gleichstand herrscht, werden beide Fahrer momentan
gleich gereiht.


WeasyPrint
==========

WeasyPrint Wird verwendet, um am Server HTML nach PDF zu konvertieren.
Weasyprint ist zwar speziell für die Ergebnislisten mit ihren großen Tabellen
sehr langsam, dafür erzeugt es aber einen ordentlichen Seitenumbruch, was z.B.
WebKit-basierte Lösungen wie wkhtmltopdf nur sehr mangelhaft beherrschen.

  yum install weasyprint


Perl-Module
===========
git://github.com/zigorou/perl-json-pointer.git
git://github.com/zigorou/perl-json-patch.git


Lizenz
======

Dieser Text und die Programme stehen under der GNU Affero General Public License
Version 3, http://www.gnu.org/licenses/agpl-3.0.html.


Referenzen
==========

[1] http://www.ortwinsann.de/trialtool/