Streams – Ein kleines Beispiel

Stellen wir uns mal folgendes Problem vor. Wir haben einen Contentserver, auf dem alle meine Texte gespeichert sind. Jetzt habe ich einen Client, der diesen Inhalt nutzen will. Dummerweise ist die Verbindung zwischen Server und Client nicht die beste und somit sollte alles, was einmal abgerufen wurde auch beim Client gespeichert werden, um den nächsten Abruf zu beschleunigen.

Da ich schon immer mal was mit StreamWrappern bauen wollte, hier eine Lösung für das Problem, implementiert über Streams. Wie immer ist es nur ein Proof of Concept und kann an vielen Stellen noch verbessert werden. Es funktioniert aber schon und kann als Inspiration für viele weitere Streams gelten.

Wenn ich auf den gewünschten Inhalt zugreife, dann hätte ich das gerne so bequem wir möglich. Das beste wäre, wenn ich noch nicht mal wissen muss, dass es einen Cache gibt. Noch besser wäre es natürlich, wenn ich nicht mal wissen müsste, dass es ein Server ist, der mir das ganze zur Verfügung stellt. Ich schreibe hier natürlich nur Anforderungen auf, für die ich auch eine Lösung habe. Gemein, oder? Wie will ich also den Aufruf gestalten. Ich stelle mir das so vor:

$text = file_get_contents( "content://1.txt" ) );

Um so einen Aufruf möglich zu machen, muss man in PHP eigentlich nur ein paar Zeilen Code schreiben und schon klappt es. 45 sind es, wobei da nur 13 wirklich geschrieben sind und die anderen einfach nur delegieren. Schauen wir uns den Code doch einfach mal an:

class ContentStream
{
  static public $localPath;
  static public $remotePath;

  private $handle;

  function stream_open($path, $mode, $options, &$opened_path)
  {
    $pathArray = parse_url($path);
    $filename  = $pathArray['host'];

    $remoteFileName = self::$remotePath.DIRECTORY_SEPARATOR.$filename;
    $localFileName  = self::$localPath.DIRECTORY_SEPARATOR.$filename;
    if ( !file_exists( $localFileName ) )
    {
      file_put_contents( $localFileName, file_get_contents( $remoteFileName ) );
    }
    $this->handle = fopen( $localFileName, $mode );
    return true;
  }

  function stream_read($count)
  {
    return fgets( $this->handle, $count );
  }

  function stream_eof()
  {
    return feof( $this->handle );
  }

  function stream_stat( )
  {
    return fstat($this->handle);
  }

}

Eigentlich brauch der Code keine Erklärung. Alle Methode außer stream_open leiten die Anfrage einfach an das native Handling von PHP weiter. Im stream_open schaue ich einfach, ob die Datei lokal existiert, falls nicht, dann hole sie und setze den Handle auf das Teil. Um den Stream zu „konfigurieren“ und registrieren fehlen nur noch folgende drei Zeilen:

ContentStream::$localPath = 'local';
ContentStream::$remotePath = 'remote';

stream_wrapper_register("content", "ContentStream");

Wie vorhin gesagt: Der Code ist in 15min entstanden. Es muss an vielen Stellen verbessert werden, aber er funktioniert für das kleine Beispiel. Ich hoffe, ihr fühlt euch inspiriert und baut den weltbesten Stream.