Ein Webservice zum Generieren von biographischen Links aus einem Set von Beacon-Dateien, der zugleich die zugehörigen Personendaten aus der GND anzeigt. Die Beacon-Dateien werden von der Anwendung gecached und können per Skript aktualisiert werden. Die Liste der Datenquellen kann händisch bearbeitet werden. In der vorliegenden Version ist die Anwendung für die HAB Wolfenbüttel programmiert. Ressourcen der HAB werden gesondert hervorgehoben.
Die Anwendung ist in PHP geschrieben und ist unter PHP 5.6 oder höher lauffähig. Zuletzt wurde sie für Version 8.3.11 notdürftig angepasst, eine grundlegende Aktualisierung auch des Fremdcodes steht aus. Sie verwendet das Templatesystem Twig (Version 1.42) und die Symfony-Komponente Yaml (Version 2.2).
Ausgeführt wird die Datei public/index.php. Die Templates für die Darstellung der Website liegen unter templates/twig. Die Beacon-Dateien liegen im Verzeichnis data/beaconFiles, dort wird der Zeitpunkt des letzten Update in der Datei changeDate gespeichert. Die auszuwertenden Datenquellen sind in data/sources.yml definiert.
Der eigene Quellcode liegt unter src/HAB und wird durch Einbinden von vendor/autoload.php geladen. Folgende Klassen werden bereitgestellt:
Klasse zur Validierung einer GND-Nummer. Methoden:
- __construct($string): Validiert die als
$stringübergebene GND-Nummer, das Ergebnis steht in der Eigenschaftvalid. - __toString(): Gibt die GND-Nummer aus.
Die Klasse automatisiert eine Anfrage an die Metadatenschnittstelle http://hub.culturegraph.org/entityfacts/{id}. Methoden:
- __construct(GND $gnd): Lädt die Daten von der Schnittstelle und legt sie in den Properties des Objekts ab, dies sind:
preferredName,type,variantNames(Array),info,dateBirth,placeBirth,dateDeath,placeDeath,placesActivity(Array),academicDegree,relations(Array mit mehreren assoziativen Arrays),familiarRelations(Array mit mehreren assoziativen Arrays).
Verwaltung einer Sammlung von Beacon-Dateien, die lokal gecacht werden, Durchsuchen der Dateien und Erzeugung von Links auf Nachweissysteme für Personen. Methoden:
- __construct($update = true, $folder = null): Einlesen der Datenquellen, Validieren der Dateien und Ordner, Aktualisieren der Beacon-Dateien, sofern welche fehlen oder das letzte Update zu lange her ist (s. Eigenschaft update_int). Über den Parameter $update kann das Update unterdrückt werden. Über den Parameter $folder kann der relative Pfad des Ordners data/beaconFiles angepasst werden, wenn das Skript nicht im Ordner public ausführt wird.
- update(): Update der gecacheten Beacon-Dateien, Abspeichern eines Unix-Timestamp unter changeDate im selben Ordner.
- getLinks(GND $gnd, $target = ''): Durchsuchen der Beacon-Dateien auf Treffer für eine GND-Nummer, Ausgabe von Links im HTML-Format. Über den Parameter $target kann beeinflusst werden, ob die Links in einem neuen Tab geöffnet werden.
- getSelectedLinks(gnd $gnd, $hab = true, $target = ''): Dasselbe wie getLinks(), nur dass wenn der Parameter $hab auf true gesetzt ist, nur die Quellen ausgewertet werden, die in der Eigenschaft
sourcesHABangegeben sind. Im anderen Fall werden nur alle anderen Datenquellen berücksichtigt. - getLinksMulti($gndArray, $target = ''): Überprüfen von mehreren GND-Nummern, die als Array übergeben werden. Rückgabewert ist ein Array von Links im HTML-Format.
- getTypeArray(): Ausgabe der Datenquellen, gruppiert nach der in sources.yml hinterlegten Eigenschaft
dbtype. - validate(): Validieren des Objekts auf Integrität, d. h. Vorhandensein aller Ordner und Dateien.
$repository = new \HAB\BeaconRepository();
$gnd = new \HAB\GND('136201733');
$request = new \HAB\RequestGND($gnd);
$links = $repository->getLinks($gnd, '_blank');
echo $request->preferredName.':<br>';
echo implode('<br>', $links);Dies erzeugt die Ausgabe:
Melusine von der Schulenburg:<br>
<a href="http://tools.wmflabs.org/persondata/redirect/gnd/de/136201733" target="_blank">Wikipedia</a><br>
<a href="http://www.deutsche-biographie.de/pnd136201733.html" target="_blank">Deutsche Biographie</a><br>
<a href="http://jdgdb.bbaw.de/cgi-bin/jdg?t_idn_erg=x&idn=GND:136201733" target="_blank">Jahresberichte für deutsche Geschichte</a>Die Anwendung ist auf einem Server mit PHP 5.6 oder höher lauffähig. Für eine handliche URL muss der ggf. einzurichtende virtuelle Host auf den Ordner public zeigen, wo das Skript index.php ausgeführt wird.
Sofern Docker installiert ist, kann die Anwendung mit den in der Datei docker-compose.yml definierten Einstellungen zum Laufen gebracht werden. Dafür muss im selben Verzeichnis folgender Befehl ausgeführt werden:
docker-compose up -dSie läuft dann unter der Adresse http://localhost:82/public/.
Die Datenquellen sind in der Datei data/sources.yml festgelegt. Die Auswahl beruht im Wesentlichen auf der Seite https://de.wikipedia.org/wiki/Wikipedia:BEACON. Hinzu kommen lokale Quellen zu Beständen der HAB. Damit Änderungen wirksam werden, muss erst ein Update durchgeführt werden. Für jede Datenquelle muss eine eindeutige ID vergeben werden, dazu kommen folgende Felder:
- label: Die Benennung des Nachweissystems
- location: Die Adresse, von der die Beacon-Datei heruntergeladen werden kann.
- target: Das Muster, mit dem für einzelne GND-Nummern URLs gebildet werden können. In der Regel steht dies in der Beacon-Datei unter #target.
- type: "default", sofern eine URL mit GND-Nummer und target gebildet wird, "specified", sofern in der Beacon-Datei hinter der GND-Nummer interne IDs bzw. eigene URLs angegeben sind.
- dbtype: Eine frei zu vergebende Angabe des Datenbanktyps wie z. B. "Regionalbiographie". Diese steuern die Anzeige der Datenquellen auf der Website.
Das Update wird entweder beim Instanziieren der Klasse BeaconRepository durchgeführt, wenn mehr Sekunden als in der Eigenschaft BeaconRepository::update_int angegeben vergangen sind, oder es kann mit dem Skript update.php manuell angestoßen werden. Hierbei werden alle Beacon-Dateien unterschiedslos im Ordner data/beaconFiles neu geladen, obsolete werden nicht gelöscht.
Fehlgeschlagene Downloadversuche werden in der Ausgabe angezeigt. Sofern der Download an einem unbekannten Zertifikat scheitert, kann man das Zertifikat manuell herunterladen und an die Datei certs/collection.pem anhängen.
Written with StackEdit.