Abschnitt 16 · Lektion 3
Ein Front Controller
Liegt jede Seite in einer eigenen Datei, entscheidet der Server am Dateinamen, welcher Code läuft. Gibt es zu einer Adresse keine Datei, antwortet deshalb der Server und nicht deine Anwendung. Was er dann antwortet, hängt davon ab, welcher Server es ist.
In der Aufgabe von Lektion 10.5 hast du schon drei Seiten aus einer einzigen Datei gebaut, die den Pfad liest und danach verzweigt. Ein Front Controller ist dieselbe Idee, nur für jede Adresse der Anwendung und mit einer Funktion je Adresse. Für eine Handvoll Seiten reicht eine Datei je Seite trotzdem.
Wo diese Bauweise an ihre Grenze kommt
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Impressum</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1>Impressum</h1>
<p>Angaben nach Paragraf 5 DDG.</p>
<p><a href="/">Zurück zur Startseite</a></p>
</body>
</html> <!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Startseite</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1>Startseite</h1>
<p>Zwei Dateien, zwei Adressen. Nach einem Klick auf das
<a href="/impressum.php">Impressum</a> steht der Dateiname in der
Adresszeile, und er steht in jedem Link.</p>
<p>Unter <code>/gibtesnicht.php</code> kommt ab PHP 8.4 diese Startseite
zurück, mit Status 200, obwohl es die Seite nicht gibt. Der Code hier
merkt davon nichts.</p>
</body>
</html> Der Link im ersten Beispiel führt zu /impressum.php, und derselbe Dateiname steht in jedem Link,
der dorthin zeigt. Willst du die Seite umbenennen, änderst du die Datei und alle Links.
Dann der Vorspann. Jede Seite soll die Sitzung starten, Fehler abfangen und prüfen, ob jemand angemeldet ist. Das steht dann in jeder einzelnen Datei, und beim Anlegen der nächsten vergisst man es. So entsteht eine Seite, die sich ohne Anmeldung aufrufen lässt, und alle anderen sind geschützt.
Dazu kommen die falschen Adressen. Tippst du im ersten Beispiel /gibtesnicht.php in die
Adresszeile, kommt die Startseite. Im Reiter Netzwerk steht dabei Status 200, obwohl es diese Seite
gar nicht gibt. curl -si localhost:3000/gibtesnicht.php | head -1 sagt es in einer Zeile:
200 OK. Ab PHP 8.4 nimmt php -S bei einem unbekannten Pfad einfach die Indexdatei. index.php
merkt davon nichts und weiß nicht, dass sie gerade als Vertretung läuft. Ein Apache ohne weitere
Einstellung und php -S unter PHP 8.2 und PHP 8.3 schicken stattdessen ihre eigene Fehlerseite. Die
kann deine Anwendung weder gestalten noch protokollieren, denn ihr Code startet gar nicht erst.
Alles durch eine Tür
<?php
declare(strict_types=1);
// Links der Pfad, rechts der Name der Funktion, die ihn beantwortet.
// Wer eine Seite umbenennen will, aendert diese Zeile und sonst
// nichts.
return [
"/" => "seiteStart",
"/impressum" => "seiteImpressum",
"/datenschutz" => "seiteDatenschutz",
]; <?php
declare(strict_types=1);
// Ein Front Controller in seiner kleinsten Form. Alle drei Adressen
// landen in dieser Datei, und erst der Code hier entscheidet, welche
// Funktion antwortet.
$routen = require __DIR__ . "/routen.php";
function seiteStart(): string
{
return "<h1>Startseite</h1>
<p>Drei Adressen, eine Datei. Beim
<a href=\"/impressum\">Impressum</a> und beim
<a href=\"/datenschutz\">Datenschutz</a> steht in der Adresszeile
kein .php mehr.</p>
<p>Unter <code>/gibtesnicht</code> antwortet diesmal der Code dieser
Datei, mit seiner eigenen Seite und einer 404.</p>";
}
function seiteImpressum(): string
{
return "<h1>Impressum</h1><p>Angaben nach Paragraf 5 DDG.</p>
<p><a href=\"/\">Zurück</a></p>";
}
function seiteDatenschutz(): string
{
return "<h1>Datenschutz</h1><p>Diese Seite setzt keine Cookies.</p>
<p><a href=\"/\">Zurück</a></p>";
}
// Bei einer Adresse wie //impressum findet parse_url() keinen Pfad und
// gibt null oder false zurueck, das ?: macht daraus einen leeren Text.
$pfad = parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH) ?: "";
if (isset($routen[$pfad])) {
$inhalt = $routen[$pfad]();
} else {
http_response_code(404);
$inhalt = "<h1>Nicht gefunden</h1><p>Die Adresse " . htmlspecialchars($pfad, ENT_QUOTES, "UTF-8")
. " kennt diese Anwendung nicht.</p><p><a href=\"/\">Zurück</a></p>";
}
?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Front Controller</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<?= $inhalt ?>
</body>
</html> Ein Front Controller dreht das um. Jede Anfrage landet in derselben Datei, und dort entscheidet dein
Code, was passiert. Im zweiten Beispiel steht die kleinste Form davon. Drei Adressen, eine Datei,
und in der Adresszeile steht kein .php mehr. Bei /gibtesnicht antwortet diesmal der eigene Code,
mit seiner eigenen Seite und einer 404, die er selbst gesetzt hat. Du siehst sie im Reiter Netzwerk
und mit curl -si localhost:3000/gibtesnicht | head -1 auch im Terminal.
Darin stecken zwei Teile. Die Routentabelle (englisch routing table) ist ein gewöhnliches Array.
Links steht der Pfad, rechts der Name der Funktion, die ihn beantwortet. Der Verteiler (englisch
dispatcher) ist ein if mit else. Er sieht nach, ob es einen Eintrag gibt, und ruft dann die
Funktion auf oder setzt eine 404.
An dieser einen Stelle kommt alles vorbei. Ein session_start() steht dort einmal statt zwanzigmal,
eine Anmeldeprüfung ebenso. Zieht eine Seite um, ändert sich eine Zeile in der Tabelle.
Wie das auf einem echten Server funktioniert
Damit wirklich jede Adresse in index.php landet, muss der Webserver mitspielen. Bei Apache ist das
eine Regel in der .htaccess („wenn es zu diesem Pfad keine Datei gibt, nimm index.php“), bei
nginx eine try_files-Zeile. Beides findest du in den Anleitungen der Frameworks, also der fertigen
Gerüste für ganze Anwendungen, und gemeint ist beide Male dasselbe.
In diesem Kurs braucht es dafür nichts. Hier hilft dieselbe Eigenheit von php -S, die im ersten
Beispiel noch gestört hat. Ab PHP 8.4 nimmt der Server zu einem Pfad ohne Datei die Indexdatei, auch
bei /gibtesnicht.php. Unter PHP 8.2 und PHP 8.3 bekommt ein Pfad mit Punkt im letzten Stück noch
die 404 des Servers. Auf dem eigenen Rechner mit älterem PHP bekommt php -S deshalb ein kleines
Routerskript mit, das für jede vorhandene Datei return false sagt und alles andere an index.php
gibt.
Für /impressum gibt es keine Datei, also landet der Aufruf in index.php, und der echte Pfad
steht in $_SERVER["REQUEST_URI"]. Im ersten Beispiel war das eine stille Falschantwort. Hier ist
es genau richtig so, denn jetzt sieht der Code selbst nach, ob es die Adresse gibt. Seit Abschnitt
10 steckt dieser Rückfall schon in den Aufgaben, etwa hinter /login in Lektion 12.5.
Nur ein Ordner ist öffentlich
; Die Konfiguration dieser Anwendung. Sie liegt im selben Ordner wie
; index.php, also im oeffentlichen Verzeichnis. Das ist der Fehler,
; den dieses Beispiel vorfuehrt.
datenbank = privat/daten.db
db_passwort = db-passwort-im-klartext
modus = betrieb <?php
declare(strict_types=1);
// Diese Anwendung hat keinen eigenen oeffentlichen Ordner: Der Server
// liefert alles aus, was neben index.php liegt. Was das heisst, siehst
// du mit einem einzigen Aufruf.
$konfig = parse_ini_file(__DIR__ . "/konfiguration.ini");
?>
<!doctype html>
<html lang="de">
<head><meta charset="utf-8"><title>Alles im selben Ordner</title>
<style>body{font-family:system-ui,sans-serif;max-width:34rem;margin:2rem auto}</style></head>
<body>
<h1>Alles im selben Ordner</h1>
<p>Diese Seite läuft in der Betriebsart <strong><?= $konfig["modus"] ?></strong>.
Woher sie das weiß, steht in <code>konfiguration.ini</code>, und die
Datei liegt gleich nebenan.</p>
<p>Unter <a href="/konfiguration.ini">/konfiguration.ini</a> liefert der
Server sie aus, im Klartext, samt Passwort.</p>
</body>
</html> Geht ohnehin alles durch eine Datei, muss der Browser auch nur noch diese eine erreichen. Daraus
ergibt sich ein öffentlicher Ordner für index.php und die Stylesheets. Alles andere liegt daneben,
außerhalb davon.
Im dritten Beispiel liegt die Konfiguration neben index.php. Der Server liefert sie auf Anfrage
aus, im Klartext und mit dem Passwort darin. Dafür reicht /konfiguration.ini in der Adresszeile
oder curl -s localhost:3000/konfiguration.ini im Terminal. Kaputt ist dabei nichts. Der Server
macht nur seine Arbeit und gibt eine Datei aus dem öffentlichen Verzeichnis heraus, so wie die
Datenbankdatei im Abschnitt über Sicherheit.
Liegt die Datei außerhalb der Dokumentwurzel, gibt es sie für den Server nicht. Ab PHP 8.4 landet
der Aufruf dann auf dem Front Controller, und der antwortet mit 404. Unter PHP 8.2 und PHP 8.3 tut
das php -S selbst.
In der Aufgabe fehlt der Anwendung aus dem zweiten Beispiel nur noch ihr Verteiler.
Zum Mitnehmen
Ein Front Controller ist die eine Datei, durch die jede Anfrage geht, und eine Tabelle sagt ihm, welche Funktion zu welchem Pfad gehört. Öffentlich ist nur sein Ordner, alles andere liegt daneben und ist von außen nicht zu erreichen.
Jetzt du
Basis Konto, kostenlosZu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.
Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.
In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.
Was in dieser Lektion steckt
-
Artikel mit 3 Beispielen zum Ausprobieren
Steht hier, ohne Konto lesbar.
-
Aufgabe, dein Code läuft auf einem Server
Öffnet sich mit dem Basis Konto.