* @final */ class Gz extends AbstractCompressionAlgorithm { /** * Compression Options * array( * 'level' => Compression level 0-9 * 'mode' => Compression mode, can be 'compress', 'deflate' * 'archive' => Archive to use * ) * * @var Options */ protected $options = [ 'level' => 9, 'mode' => 'compress', 'archive' => null, ]; /** * @param null|Options|iterable $options (Optional) Options to set * @throws Exception\ExtensionNotLoadedException If zlib extension not loaded. */ public function __construct($options = null) { if (! extension_loaded('zlib')) { throw new Exception\ExtensionNotLoadedException('This filter needs the zlib extension'); } parent::__construct($options); } /** * Returns the set compression level * * @return int */ public function getLevel() { return $this->options['level']; } /** * Sets a new compression level * * @param int $level * @throws Exception\InvalidArgumentException * @return self */ public function setLevel($level) { if (($level < 0) || ($level > 9)) { throw new Exception\InvalidArgumentException('Level must be between 0 and 9'); } $this->options['level'] = (int) $level; return $this; } /** * Returns the set compression mode * * @return string */ public function getMode() { return $this->options['mode']; } /** * Sets a new compression mode * * @param string $mode Supported are 'compress', 'deflate' and 'file' * @return self * @throws Exception\InvalidArgumentException For invalid $mode value. */ public function setMode($mode) { if ($mode !== 'compress' && $mode !== 'deflate') { throw new Exception\InvalidArgumentException('Given compression mode not supported'); } $this->options['mode'] = $mode; return $this; } /** * Returns the set archive * * @return string|null */ public function getArchive() { return $this->options['archive']; } /** * Sets the archive to use for de-/compression * * @param string $archive Archive to use * @return self */ public function setArchive($archive) { $this->options['archive'] = (string) $archive; return $this; } /** * Compresses the given content * * @param string $content * @return string * @throws Exception\RuntimeException If unable to open archive or error during decompression. */ public function compress($content) { $archive = $this->getArchive(); if (is_string($archive) && $archive !== '') { $file = gzopen($archive, 'w' . $this->getLevel()); if (! $file) { throw new Exception\RuntimeException("Error opening the archive '" . $archive . "'"); } gzwrite($file, $content); gzclose($file); $compressed = true; } elseif ($this->options['mode'] === 'deflate') { $compressed = gzdeflate($content, $this->getLevel()); } else { $compressed = gzcompress($content, $this->getLevel()); } if ($compressed === false) { throw new Exception\RuntimeException('Error during compression'); } return $compressed; } /** * Decompresses the given content * * @param string $content * @return string * @throws Exception\RuntimeException If unable to open archive or error during decompression. */ public function decompress($content) { $archive = $this->getArchive(); $mode = $this->getMode(); //check if there are null byte characters before doing a file_exists check if (null !== $content && ! str_contains($content, "\0") && file_exists($content)) { $archive = $content; } if (null !== $archive && file_exists($archive)) { $handler = fopen($archive, 'rb'); if (! $handler) { throw new Exception\RuntimeException("Error opening the archive '" . $archive . "'"); } fseek($handler, -4, SEEK_END); $packet = fread($handler, 4); $bytes = unpack('V', $packet); $size = end($bytes); fclose($handler); $file = gzopen($archive, 'r'); $compressed = gzread($file, $size); gzclose($file); } elseif ($mode === 'deflate' && null !== $content) { $compressed = gzinflate($content); } elseif (null !== $content) { $compressed = gzuncompress($content); } else { $compressed = false; } if ($compressed === false) { throw new Exception\RuntimeException('Error during decompression'); } return $compressed; } /** * Returns the adapter name * * @return string */ public function toString() { return 'Gz'; } }