owncloud / updater

src/Utils/ZipExtractor.php

<?php
/**
 * @author Victor Dubiniuk <dubiniuk@owncloud.com>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\Utils;

use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\Process;
use Symfony\Component\Process\ProcessUtils;
use ZipArchive;

/**
 * Class ZipExtractor
 *
 * @package Owncloud\Updater\Utils
 */
class ZipExtractor {

	protected $file;
	protected $path;
	
	/** @var  OutputInterface */
	protected $output;

	/**
	 * @param string $file
	 * @param string $path
	 * @param OutputInterface $output
	 */
	public function __construct($file, $path, OutputInterface $output = null){
		$this->file = $file;
		$this->path = $path;
		if (!is_null($output)){
			$this->output = $output;
		}
	}

	/**
	 * @return bool
	 */
	public function extract(){
		if ($this->extractShell()){
			return true;
		}
		if (!class_exists('ZipArchive')){
			throw new \RuntimeException("Could not decompress the archive, enable the PHP zip extension or install unzip.");
		}
		return $this->extractZipArchive();
	}

	/**
	 * @return bool
	 */
	private function extractShell(){
		$command = 'unzip ' . ProcessUtils::escapeArgument($this->file) . ' -d ' . ProcessUtils::escapeArgument($this->path) . ' && chmod -R u+w ' . ProcessUtils::escapeArgument($this->path);

The method Symfony\Component\Process\ProcessUtils::escapeArgument() has been deprecated with message: since version 3.3, to be removed in 4.0. Use a command line array or give env vars to the `Process::start/run()` method instead.

		$process = new Process($command);
		$process->setTimeout(null);
		$process->run();
		if ($this->output) {
			$this->output->writeln($process->getErrorOutput());
		}
		return $process->isSuccessful();
	}

	/**
	 * @return bool
	 */
	private function extractZipArchive(){
		$zipArchive = new ZipArchive();

		if (true !== ($exitCode = $zipArchive->open($this->file))){
			throw new \UnexpectedValueException($this->getErrorMessage($exitCode), $exitCode);
		}

		if (true !== $zipArchive->extractTo($this->path)){
			throw new \RuntimeException("There was an error extracting the ZIP file. Corrupt file?");
		}

		$zipArchive->close();
		return true;
	}

	/**
	 * @param int $exitCode
	 * @return string
	 */
	protected function getErrorMessage($exitCode){
		switch ($exitCode){
			case ZipArchive::ER_EXISTS:
				return sprintf("File '%s' already exists.", $this->file);
			case ZipArchive::ER_INCONS:
				return sprintf("Zip archive '%s' is inconsistent.", $this->file);
			case ZipArchive::ER_INVAL:
				return sprintf("Invalid argument (%s)", $this->file);
			case ZipArchive::ER_MEMORY:
				return sprintf("Malloc failure (%s)", $this->file);
			case ZipArchive::ER_NOENT:
				return sprintf("No such zip file: '%s'", $this->file);
			case ZipArchive::ER_NOZIP:
				return sprintf("'%s' is not a zip archive.", $this->file);
			case ZipArchive::ER_OPEN:
				return sprintf("Can't open zip file: %s", $this->file);
			case ZipArchive::ER_READ:
				return sprintf("Zip read error (%s)", $this->file);
			case ZipArchive::ER_SEEK:
				return sprintf("Zip seek error (%s)", $this->file);
			default:
				return sprintf("'%s' is not a valid zip archive, got error code: %s", $this->file, $exitCode);
		}
	}
}