mitmario.dev

Eine Liste, die wächst

PHP Sandbox 3 Min Lesezeit 3 BeispieleLektion 6 von 7

Du schickst einen Gruß ins Gästebuch, und er steht auf der Seite. Beim nächsten Aufruf ist er weg, und so nützt er niemandem. Was ein Besucher abschickt, lebt nur so lange wie seine Anfrage. Soll eine Liste wachsen, muss sie zwischen zwei Anfragen irgendwo liegen, und hier liegt sie in einer JSON-Datei wie in Abschnitt 8. Alles andere kommt aus diesem Abschnitt, also das Formular, die Prüfung, die Weiterleitung und die maskierte Ausgabe. Nur der Upload bleibt draußen, denn hier kommt nur Text an.

Der Ablauf, einmal am Stück

Die Liste in einer Datei
<?php

declare(strict_types=1);

// Alles aus diesem Abschnitt zusammen, an einem Gaestebuch:
// entgegennehmen, pruefen, anhaengen, weiterleiten, anzeigen. Jeder
// Eintrag im Browser macht die Liste um eine Zeile laenger.

function e(?string $wert): string
{
    return htmlspecialchars($wert ?? "", ENT_QUOTES, "UTF-8");
}

$datei = __DIR__ . "/gaestebuch.json";
$eintraege = json_decode(file_get_contents($datei), true) ?? [];

if ($_SERVER["REQUEST_METHOD"] === "POST") {
    $name = trim($_POST["name"] ?? "");
    $gruss = trim($_POST["gruss"] ?? "");

    if ($name !== "" && $gruss !== "") {
        $eintraege[] = ["name" => $name, "gruss" => $gruss];
        file_put_contents($datei, json_encode($eintraege, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
    }

    header("Location: /", true, 302);
    exit;
}

?>
<!doctype html>
<html lang="de">
<head>
    <meta charset="utf-8">
    <title>Gästebuch</title>
</head>
<body>
    <h1>Gästebuch</h1>

    <form method="post" action="/">
        <p><label>Name: <input type="text" name="name"></label></p>
        <p><label>Gruß: <input type="text" name="gruss" size="30"></label></p>
        <button type="submit">Eintragen</button>
    </form>

    <ul>
<?php foreach ($eintraege as $eintrag) { ?>
        <li><?= e($eintrag["name"]) ?>: <?= e($eintrag["gruss"]) ?></li>
<?php } ?>
    </ul>

    <p>Einträge: <?= count($eintraege) ?></p>
</body>
</html>

Es sind fünf Schritte, und sie stehen immer in dieser Reihenfolge.

Zuerst wird die Liste gelesen, ganz oben und in jedem Fall. Du brauchst sie zum Anzeigen und zum Anhängen, und einmal lesen ist besser als zweimal.

Dann kommt die Frage, ob überhaupt etwas abgeschickt wurde. Wenn ja, wird geprüft, ob Name und Gruß brauchbar sind. Beide kommen als neuer Eintrag hinten an die Liste, die Datei wird zurückgeschrieben, und dann wird weitergeleitet.

Ganz unten kommt die Anzeige. Die gibt nur noch aus, was in der Liste steht, jeden Wert durch e().

Einen zweiten Zweig für das Anzeigen gibt es nicht. Nach dem Weiterleiten ist das Programm zu Ende, also gilt alles darunter nur noch für ein GET. Das spart eine Verschachtelung, und es ist der übliche Aufbau einer solchen Datei.

Die Datei gibt es noch nicht

Wenn die Datei noch nicht da ist
<?php

declare(strict_types=1);

// Beim allerersten Aufruf einer frisch hochgeladenen Anwendung
// gibt es die Datei noch gar nicht. Das ist der Normalfall und
// kein Fehler, behandelt werden muss er trotzdem.

$datei = __DIR__ . "/notizen.json";

echo "So nicht:\n";
$roh = file_get_contents($datei);
var_dump($roh);

echo "\nSo schon:\n";
$notizen = is_file($datei) ? (json_decode(file_get_contents($datei), true) ?? []) : [];
var_dump($notizen);

echo "\nUnd nach dem ersten Schreiben:\n";
file_put_contents($datei, json_encode(["Milch"]));
var_dump(json_decode(file_get_contents($datei), true));

// Aufraeumen, damit auch der naechste Lauf ohne die Datei anfaengt.
unlink($datei);

Beim ersten Aufruf einer frisch hochgeladenen Anwendung ist die Datei nicht da. file_get_contents gibt dann nach einer Warnung false zurück, und ab da arbeitet das Programm mit einem Wert, den niemand gemeint hat. Reicht es das false an json_decode() weiter, bricht es dort mit einem TypeError ab, denn die Datei fängt mit declare(strict_types=1) an.

Zwei Handgriffe machen daraus einen sauberen Fall. is_file() fragt vorher, ob es die Datei überhaupt gibt, und ?? [] fängt ab, dass in der Datei etwas Kaputtes stand. Mit beiden fängt die Liste leer an, wenn nichts da ist.

Dieses Beispiel läuft als Skript und nicht als Server, also mit php index.php im Terminal. Dort stehen Ausgabe und Warnung auf zwei Kanälen nebeneinander, die Warnung in Rot, und du siehst auf einen Blick, welche der drei Fassungen sie ausgelöst hat. Auf einer Seite stünde sie mitten im Text. Am Ende wird die Datei wieder weggeräumt, damit auch der nächste Lauf ohne sie anfängt. Auch das dritte Beispiel läuft als Skript. Dort geht es um eine Reihenfolge und nicht um eine Seite.

Warum das noch keine Datenbank ist

Zwei Besucher im selben Moment
<?php

declare(strict_types=1);

// Zwei Besucher kommen gleichzeitig an. Beide lesen dieselbe
// Liste, beide haengen etwas an, beide schreiben zurueck. Einer
// der beiden Eintraege ist danach weg.

$datei = __DIR__ . "/liste.json";
file_put_contents($datei, json_encode(["Brot"]));

// Besucher A liest.
$a = json_decode(file_get_contents($datei), true);

// Besucher B liest im selben Moment und sieht dieselbe Liste.
$b = json_decode(file_get_contents($datei), true);

// A haengt an und schreibt zurueck.
$a[] = "Milch";
file_put_contents($datei, json_encode($a));

// B haengt an und schreibt zurueck. Seine Liste kennt die Milch
// nicht, denn er hat vor A gelesen.
$b[] = "Butter";
file_put_contents($datei, json_encode($b));

echo "In der Datei steht jetzt: ", file_get_contents($datei), "\n";
echo "Die Milch von Besucher A ist weg, und keiner der beiden hat\n";
echo "etwas falsch gemacht.\n";

Eine JSON-Datei als Speicher ist für eine kleine Sache völlig in Ordnung. Composer hält die Liste seiner Pakete auch in composer.json.

Der Ablauf ist ja lesen, ändern, zurückschreiben. Zwischen dem Lesen und dem Zurückschreiben vergeht Zeit, und in dieser Zeit kann ein zweiter Besucher dieselbe Datei gelesen haben. Er schreibt dann eine Liste zurück, in der die Änderung des ersten nie vorkam. Ein Eintrag ist weg. Niemand hat einen Fehler gemacht, und in keinem Protokoll steht etwas davon.

Bei zwei Notizen am Tag passiert das nie. Bei zwanzig Besuchern gleichzeitig passiert es, und zwar nicht jedes Mal, sondern manchmal. Deshalb kannst du es kaum nachstellen.

Es gibt Mittel dagegen. Mit flock() lässt sich die Datei vom Lesen bis zum Zurückschreiben sperren, und ein zweiter Besucher, der dieselbe Sperre haben will, wartet so lange. Der Schalter LOCK_EX an file_put_contents reicht dafür nicht. Er sperrt nur den Schreibvorgang selbst, und das Lesen davor bleibt offen.

Der eigentliche Ausweg ist eine Datenbank, also ein Programm, das für diese Arbeit gebaut ist. Sie lässt mehrere Schreibende der Reihe nach an die Daten, statt dass einer die Arbeit des anderen überschreibt. Sie kann in einem Zug ändern, statt erst zu lesen und dann zurückzuschreiben. Und sie findet einen Eintrag, ohne die ganze Liste durchzugehen. In Abschnitt 14 zieht die Notizliste aus der Aufgabe in eine SQLite-Datenbank um, und dann ist dieses Problem weg.

In der Aufgabe fehlt der Notizliste nur noch der Zweig, der eine neue Notiz annimmt.

Zum Mitnehmen

Die Seite liest zuerst die Liste aus der Datei. Ein POST hängt den geprüften Eintrag an, schreibt zurück und leitet weiter, und was darunter steht, zeigt bei einem GET nur noch an. Fehlt die Datei noch, fängt die Liste leer an statt mit einer Warnung, und schreiben zwei Besucher gleichzeitig, verliert einer seinen Eintrag; auf Dauer hilft dagegen erst eine Datenbank.

Jetzt du

Basis Konto, kostenlos

Zu 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.