Skip to content

README.md

Latest commit

 

History

History
199 lines (140 loc) · 7.51 KB

README.md

File metadata and controls

199 lines (140 loc) · 7.51 KB

clue/reactphp-zlib Build Status

Streaming zlib compressor and decompressor for ReactPHP, supporting compression and decompression of ZLIB format, raw DEFLATE format and GZIP format (RFC 1950, RFC 1951 and RFC 1952).

Note: This project is in beta stage! Feel free to report any issues you encounter.

Table of contents

Quickstart example

Once installed, you can use the following code to pipe a readable gzip file stream into an decompressor which emits decompressed data events for each individual file chunk:

$loop = React\EventLoop\Factory::create();
$stream = new React\Stream\ReadableResourceStream(fopen('access.log.gz', 'r'), $loop);

$decompressor = ZlibFilterStream::createGzipDecompressor();

$decompressor->on('data', function ($data) {
    echo $data;
});

$stream->pipe($decompressor);

$loop->run();

See also the examples.

Formats

This library is a lightweight wrapper around the underlying zlib library. The zlib library offers a number of different formats (sometimes referred to as encodings) detailled below.

GZIP format

This library supports the GZIP compression format as defined in RFC 1952. This is one of the more common compression formats and is used in several places:

  • PHP: gzdecode() (PHP 5.4+ only) and gzencode()
  • Files with .gz file extension, e.g. .tar.gz or .tgz archives (also known as "tarballs")
  • gzip and gunzip (and family) command line tools
  • HTTP compression with Content-Encoding: gzip header
  • Java: GZIPOutputStream

Technically, this format uses raw DEFLATE compression wrapped in a GZIP header and footer:

10 bytes header (+ optional headers) + raw DEFLATE body + 8 bytes footer

Raw DEFLATE format

This library supports the raw DEFLATE compression format as defined in RFC 1951. The DEFLATE compression algorithm returns what we refer to as "raw DEFLATE format". This raw DEFLATE format is commonly wrapped in container formats instead of being used directly:

Note: This format is not the confused with what some people call "deflate format" or "deflate encoding". These names are commonly used to refer to what we call ZLIB format.

ZLIB format

This library supports the ZLIB compression format as defined in RFC 1950. This format is commonly used in a streaming context:

  • PHP: gzcompress() and gzuncompress()
  • HTTP compression with Content-Encoding: deflate header
  • Java: DeflaterOutputStream
  • Qt's qCompress() and qUncompress() uses the ZLIB format prefixed with the uncompressed length (as UINT32BE).

Technically, this format uses raw DEFLATE compression wrapped in a ZLIB header and footer:

2 bytes header (+ optional headers) + raw DEFLATE body + 4 bytes footer

Note: This format is often referred to as the "deflate format" or "deflate encoding". This documentation avoids this name in order to avoid confusion with the raw DEFLATE format.

Usage

All classes use the Clue\React\Zlib namespace.

ZlibFilterStream

The ZlibFilterStream is a small wrapper around the underlying zlib.deflate and zlib.inflate stream compression filters offered via ext-zlib.

createCompressor()

The following methods can be used to create a compressor instance:

$compressor = ZlibFilterStream::createGzipCompressor();
$compressor = ZlibFilterStream::createDeflateCompressor();
$compressor = ZlibFilterStream::createZlibCompressor();

createDecompressor()

The following methods can be used to create a decompressor instance:

$decompressor = ZlibFilterStream::createGzipDecompressor();
$decompressor = ZlibFilterStream::createDeflateDecompressor();
$decompressor = ZlibFilterStream::createZlibDecompressor();

Inconsistencies

The stream compression filters are not exactly the most commonly used features of PHP. As such, we've spotted several inconsistencies (or bugs) between different PHP versions and HHVM. These inconsistencies exist in the underlying PHP engines and there's little we can do about this in this library.

  • All Zend PHP versions: Decompressing invalid data does not emit any data (and does not raise an error)
  • PHP 7 only: Compressing an empty string does not emit any data (not a valid compression stream)
  • HHVM only: does not currently support the GZIP and ZLIB format at all (and does not raise an error)
  • HHVM only: The zlib.deflate filter function buffers the whole string. This means that compressing a stream of 100 MB actually stores the whole string in memory before invoking the underlying compression algorithm.
  • PHP 5.3 only: Tends to SEGFAULT occasionally on shutdown?

Our test suite contains several test cases that exhibit these issues. If you feel some test case is missing or outdated, we're happy to accept PRs! :)

Install

The recommended way to install this library is through Composer. New to Composer?

This will install the latest supported version:

$ composer require clue/zlib-react:^0.2

See also the CHANGELOG for details about version upgrades.

This project aims to run on any platform and thus does not require any PHP extensions and supports running on legacy PHP 5.3 through current PHP 7+ and HHVM. It's highly recommended to use PHP 7+ for this project. Older PHP versions may suffer from a number of inconsistencies documented above.

The ext-zlib extension is not required to install this library, however it is required to actually do anything meaningful with this library. Each of the above methods will throw an Exception if this extension is missing.

Tests

To run the test suite, you first need to clone this repo and then install all dependencies through Composer:

$ composer install

To run the test suite, go to the project root and run:

$ php vendor/bin/phpunit

License

MIT

More

  • If you want to learn more about processing streams of data, refer to the documentation of the underlying react/stream component
  • If you want to process compressed tarballs (.tar.gz and .tgz file extension), you may want to use clue/tar-react on the decompressed stream.