Portables Datei-Sperrverfahren (advisory locking)

Beschreibung

flock(resource $stream, int $operation, int &$would_block = null): bool

flock() erlaubt, ein einfaches Leser-/Schreiber-Modell umzusetzen, was auf nahezu jeder Plattform (inklusive der meisten Unix-Abkömmlinge und sogar Windows) genutzt werden kann.

Die Sperre wird auch von fclose() gelöst oder wenn stream vom Garbage-Collector eingesammelt wird.

PHP unterstützt ein portables Verfahren, um komplette Dateien "beratend" zu sperren (was bedeutet, dass alle zugreifenden Programme das gleiche Sperrverfahren nutzen müssen, oder die Sperre wird nicht wirken). Standardmäßig wird diese Funktion blockieren, bis die angefragte Sperre erlangt wurde; dies kann mit der unten dokumentierten Option LOCK_NB gesteuert werden.

Parameter-Liste

stream

Eine Dateisystemressource (resource), wie sie in der Regel von fopen() zurückgegeben wird.

operation

operation ist einer der folgenden Werte:

LOCK_SH, um eine geteilte Sperre (Leser) zu erhalten.
LOCK_EX, um eine exklusive Sperre (Schreiber) zu erhalten.
LOCK_UN, um eine Sperre zu lösen (geteilt oder exklusiv).

Man kann auch LOCK_NB als Bitmaske zu einer der obigen Operationen hinzufügen, wenn flock() während des Sperrversuchs nicht blockieren soll.

would_block

Das optionale dritte Argument wird auf 1 gesetzt, falls die Sperre blockieren würde (EWOULDBLOCK-Fehlernummer).

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Beispiele

Beispiel #1 flock()-Beispiel

<?php

$fp = fopen("/tmp/lock.txt", "r+");

if (flock($fp, LOCK_EX)) { // exklusive Sperre
    ftruncate($fp, 0); // kürze Datei
    fwrite($fp, "Schreibe hier irgendwas\n");
    fflush($fp); // leere Ausgabepuffer, bevor die Sperre aufgehoben wird
    flock($fp, LOCK_UN); // hebe Sperre auf
} else {
    echo "Konnte Sperre nicht erhalten!";
}

fclose($fp);

?>

Beispiel #2 flock() mit der Option LOCK_NB

<?php
$fp = fopen('/tmp/lock.txt', 'r+');

/* Aktiviere die LOCK_NB-Option bei einer LOCK_EX-Operation */
if(!flock($fp, LOCK_EX | LOCK_NB)) {
    echo 'Kann Sperre nicht erhalten';
    exit(-1);
}

/* ... */

fclose($fp);
?>

Anmerkungen

Hinweis:
flock() nutzt unter Windows "verbindliche" (mandatory) anstatt "beratende" (advisory) Sperren. "Verbindliches" Sperren wird auch unter Linux und System-V-basierten Betriebssystemen durch den üblichen Mechanismus, der von dem fcntl()-Systemaufruf geliefert wird, unterstützt: das heißt, falls bei der fraglichen Datei das setgid-Zugriffs-Bit gesetzt ist und das Ausführungs-Bit für Gruppen null ist. Unter Linux muss das Dateisystem zusätzlich mit der Mount-Option mand eingebunden sein, damit dies Auswirkungen hat.

Hinweis:
Da flock() einen Dateizeiger benötigt, muss unter Umständen eine spezielle Sperrdatei benutzt werden, um den Zugriff auf eine Datei zu schützen, welche Sie mittels Öffnen im Schreibmodus (mit dem Argument "w" or "w+" von fopen()) kürzen wollen.

Hinweis:
Kann nur mit Dateizeigern verwendet werden, die von fopen() für lokale Dateien zurückgegeben wurden, oder mit Dateizeigern, die auf Userspace-Streams zeigen, die die streamWrapper::stream_lock()-Methode implementieren.

Warnung

Weist man dem stream-Argument einen anderen Wert zu, wird nachfolgender Code die Sperre lösen.

Warnung

Bei einigen Betriebssystemen ist flock() auf dem Prozesslevel implementiert. Wenn Sie eine Multithreaded-Server-API benutzen, können Sie sich nicht auf flock() verlassen, um Dateien vor anderen PHP-Skripten zu schützen, welche in parallelen Threads der gleichen Server-Instanz laufen!

flock() wird von antiquierten Dateisystemen wie FAT und dessen Derivaten nicht unterstützt, und gibt deshalb in solchen Umgebungen immer false zurück.

Hinweis:
Wenn der sperrende Prozess unter Windows die Datei ein zweites Mal öffnet, kann er auf die Datei über dieses zweite Handle zugreifen, bis er die Datei entsperrt.