PHP: Komprimierungsfilter

Komprimierungsfilter

Während die Komprimierungs-Wrapper die Möglichkeit bieten, auf dem lokalen Dateisystem gzip- und bz2-kompatible Dateien zu erstellen, können sie weder mit komprimierten Netzwerkprotokollen umgehen, noch bieten sie eine Möglichkeit, einen unkomprimierten Stream zu erstellen und ihn dann zu komprimieren. Im Gegensatz dazu können Komprimierungsfilter jederzeit auf alle Stream-Ressourcen angewendet werden.

Hinweis: Komprimierungsfilter erzeugen keine Kopfzeilen und Anhänge (Trailer), wie sie von Kommandozeilenprogrammen wie gzip verwendet werden. Sie komprimieren und dekomprimieren nur die eigentlichen Nutzdaten innerhalb des Streams.

zlib.deflate und zlib.inflate

zlib.deflate (Komprimierung) und zlib.inflate (Dekomprimierung) sind Implementierungen der in » RFC 1951 beschriebenen Komprimierungsmethoden. Der deflate-Filter benötigt bis zu drei Parameter, die als assoziatives Array übergeben werden. level gibt die Komprimierungsstufe an, die verwendet werden soll (1-9). Je höher die Zahl, desto kleiner wird im Allgemeinen die Größe der komprimierten Daten, aber umso länger wird auch die Verarbeitungszeit. Es gibt auch zwei spezielle Komprimierungsstufen: 0 (keine Komprimierung) und -1 (die zlib-interne Voreinstellung - derzeit 6). window ist der Logarithmus zur Basis 2 für die Größe des Loopback-Fensters (der Speicherpuffer). Höhere Werte (bis zu 15 -- 32768 Bytes) ergeben eine bessere Komprimierung auf Kosten des Speichers, während niedrigere Werte (bis zu 9 -- 512 Bytes) eine schlechtere Komprimierung bei geringerem Speicherbedarf ergeben. Der derzeitige Standardwert für window ist 15. memory gibt an, wieviel Arbeitsspeicher zugewiesen werden soll. Die gültigen Werte reichen von 1 (minimale Zuweisung) bis 9 (maximale Zuweisung). Diese Speicherzuweisung wirkt sich nur auf die Geschwindigkeit aus und hat keinen Einfluss auf die Größe der komprimierten Daten.

Hinweis: Da die Komprimierungsstufe der am häufigsten verwendete Parameter ist, kann er auch als einfacher Integer-Wert statt als Array-Element angegeben werden.

Die zlib.*-Komprimierungsfilter sind verfügbar wenn die zlib-Unterstützung aktiviert ist.

Beispiel #1 zlib.deflate und zlib.inflate

<?php
$params = array('level' => 6, 'window' => 15, 'memory' => 9);

$original_text = "This is a test.\nThis is only a test.\nThis is not an important string.\n";
echo "Der Originaltext ist " . strlen($original_text) . " Zeichen lang.\n";

$fp = fopen('test.deflated', 'w');
stream_filter_append($fp, 'zlib.deflate', STREAM_FILTER_WRITE, $params);
fwrite($fp, $original_text);
fclose($fp);

echo "Die komprimierte Datei hat " . filesize('test.deflated') . " Bytes.\n";
echo "Der Originaltext war:\n";
/* Verwendung von readfile und zlib.inflate, um auf der Stelle zu dekomprimieren */
readfile('php://filter/zlib.inflate/resource=test.deflated');

/* Erzeugt die Ausgabe:

Der Originaltext ist 70 Zeichen lang.
Die komprimierte Datei hat 56 Bytes.
Der Originaltext war:
This is a test.
This is only a test.
This is not an important string.

 */
?>

Beispiel #2 Vereinfachte Verwendung von zlib.deflate

<?php
$original_text = "This is a test.\nThis is only a test.\nThis is not an important string.\n";
echo "Der Originaltext ist " . strlen($original_text) . " Zeichen lang.\n";

$fp = fopen('test.deflated', 'w');
/* Hier steht "6" für die Komprimierungsstufe 6 */
stream_filter_append($fp, 'zlib.deflate', STREAM_FILTER_WRITE, 6);
fwrite($fp, $original_text);
fclose($fp);

echo "Die komprimierte Datei hat " . filesize('test.deflated') . " Bytes.\n";

/* Erzeugt die Ausgabe:

Der Originaltext ist 70 Zeichen lang.
Die komprimierte Datei hat 56 Bytes.

 */
?>

bzip2.compress und bzip2.decompress

bzip2.compress und bzip2.decompress funktionieren auf die gleiche Weise wie die oben beschriebenen zlib-Filter. Der Filter bzip2.compress akzeptiert bis zu zwei Parameter, die als Elemente eines assoziativen Arrays angegeben werden: blocks ist ein ganzzahliger Wert von 1 bis 9, der die Anzahl der 100kB-Speicherblöcke angibt, die dem Arbeitsbereich zugewiesen werden sollen. work ist ebenfalls ein ganzzahliger Wert. Er reicht von 0 bis 250 und gibt an, wie viel Aufwand mit der normalen Komprimierungsmethode betrieben werden soll, bevor auf eine langsamere, aber zuverlässigere Methode zurückgegriffen wird. Wenn dieser Wert geändert wird, wirkt sich das nur auf die Geschwindigkeit der Komprimierung aus. Weder die Größe der komprimierten Ausgabe noch der Speicherverbrauch werden durch diese Einstellung verändert. Ein Wert von 0 bedeutet, dass die Bibliothek ihre Standardkonfiguration verwenden soll. Der Filter bzip2.decompress akzeptiert nur einen Parameter, der entweder als gewöhnlicher boolescher Wert oder als Element small eines assoziativen Arrays übergeben werden kann. Wenn small auf true gesetzt ist, wird die bzip-Bibliothek angewiesen, die Dekomprimierung auf Kosten der Geschwindigkeit mit minimalem Speicherplatzbedarf durchzuführen.

Die bzip2.*-Komprimierungsfilter sind verfügbar wenn die bz2-Unterstützung aktiviert ist.

Beispiel #3 bzip2.compress und bzip2.decompress

<?php
$param = array('blocks' => 9, 'work' => 0);

echo "Die Originaldatei hat " . filesize('LICENSE') . " Bytes.";

$fp = fopen('LICENSE.compressed', 'w');
stream_filter_append($fp, 'bzip2.compress', STREAM_FILTER_WRITE, $param);
fwrite($fp, file_get_contents('LICENSE'));
fclose($fp);

echo "Die komprimierte Datei hat " . filesize('LICENSE.compressed') . " Bytes.\n";

/* Erzeugt die Ausgabe:

Die Originaldatei hat 3288 Bytes.
Die komprimierte Datei hat 1488 Bytes.

 */
?>

add a note

User Contributed Notes 4 notes

down

Anonymous ¶

9 years ago


To read a gzip encoded stream from http
<?php
$opts = [
    "http" => [
        "method" => "GET",
        "header" => [ "Accept-Encoding: gzip" ],
    ]
];
$ctx = stream_context_create($opts);
$f = fopen("http://php.net", "r", false, $ctx);
// check  stream_get_meta_data($f)["wrapper_data"] has "Content-Encoding: gzip"
stream_filter_append($f, "zlib.inflate", STREAM_FILTER_READ, ["window" => 30]);
echo stream_get_contents($f); // any stream processing
fclose($f);

down

Anonymous ¶

3 years ago


To use the zlib.inflate filter with data originally written using gzcompress() or zlib.deflate, set the window option to 15 as outlined here: https://bugs.php.net/bug.php?id=68556

<?php
$fh = fopen(file_name, 'rb');
stream_filter_append($fh, 'zlib.inflate', STREAM_FILTER_READ, ['window' => 15]);
$contents = stream_get_contents($fh);
fclose($fh);

down

bohwaz ¶

6 years ago


Please note that there is currently a bug in this feature. ftell(), fseek() and fstat() functions cannot be used. Writing to a stream after using this function will not change the stream position as it should.

See bug: https://bugs.php.net/bug.php?id=49874

Also the zlib filters don't work with php://temp, php://memory and php://input streams, nothing is outputted to those streams.

down

-1

TingSong ¶

1 year ago


To decompress a gzipped stream:

<?php
$stream = fopen('https://example.com/some/file.txt.gz', 'rb');
stream_filter_append($stream, 'zlib.inflate', STREAM_FILTER_READ, ['window' => 15+16]);

// read the decompressed line directly
$line = fgets($stream);

// process the lines
?>

As the doc of zlib https://www.zlib.net/manual.html#Advanced

The 'window' parameter between 8 and 15 specified the window size from 2⁸ to 2¹⁵ bytes. It can be added by 16 for wrapping with gzip header and trailer instead of zlib wrapper.

And, window could be -8..-15 for unwrapping RAW deflate data.

add a note