T3xDownloader.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Composer\Installer\Downloader;

/***************************************************************
 * Copyright notice
 *
 * (c) 2013 Sascha Egerer <sascha.egerer@dkd.de>
 * All rights reserved
 *
 * This script is part of the TYPO3 project. The TYPO3 project is
 * free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 *
 * This script 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 General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use Composer\Package\PackageInterface;
use Composer\Downloader\ArchiveDownloader;
use Composer\Downloader\ChangeReportInterface;

class T3xDownloader extends ArchiveDownloader implements ChangeReportInterface {

        protected $package;

        public function download(PackageInterface $package, $path) {
                // set package so we can use it in the extract method
                $this->package = $package;
                parent::download($package, $path);
        }

        protected function extract($file, $path) {
                // get file contents
                $fileContentStream = file_get_contents($file);
                $extensionData = $this->decodeTerExchangeData($fileContentStream);

                if (substr($path, -1) !== DIRECTORY_SEPARATOR) {
                        $path .= DIRECTORY_SEPARATOR;
                }

                $files = $this->extractFilesArrayFromExtensionData($extensionData);
                $directories = $this->extractDirectoriesFromExtensionData($files);
                $this->createDirectoriesForExtensionFiles($directories, $path);
                $this->writeExtensionFiles($files, $path);
                $this->writeEmConf($extensionData, $path);
        }

        public function getLocalChanges(PackageInterface $package, $path) {
                $messages = array();
                $path = rtrim($path, '/') . '/';

                // check if there is a ext_emconf.php
                try {
                        $emMetaData = $this->getEmConfMetaData($path);
                        $extensionFiles = unserialize($emMetaData['_md5_values_when_last_written']);
                        foreach ($extensionFiles as $extensionFileName => $extensionFileHash) {
                                if (substr($extensionFileName, -1) === '/') {
                                        continue;
                                }
                                if (is_file($path . $extensionFileName)) {
                                        $localFileContentHash = md5(file_get_contents($path . $extensionFileName));

                                        if (substr($localFileContentHash, 0, 4) !== $extensionFileHash) {
                                                $messages[] = $extensionFileName . ' - File is modified';
                                        }
                                } else {
                                        $messages[] = $extensionFileName . ' - File is missing';
                                }
                        }


                        if ($package->getPrettyVersion() !== $emMetaData['version']) {
                                $messages[] = 'Local Version is ' . $emMetaData['version'] . ' but should be ' . $package->getPrettyVersion();
                        }

                        unset($EM_CONF);
                } catch (\RuntimeException $e) {
                        $messages[] = $e->getMessage();
                }

                return implode("\n", $messages);
        }

        protected function getEmConfMetaData($path) {
                if (!is_file($path . 'ext_emconf.php')) {
                        throw new \RuntimeException('Package is unstable. "ext_emconf.php" is missing', 1439568877);
                }
                $_EXTKEY = basename($path);
                include($path . 'ext_emconf.php');

                if (!is_array($EM_CONF[$_EXTKEY])) {
                        throw new \RuntimeException('Package is unstable. "ext_emconf.php" is corrupt', 1439569163);
                }

                return $EM_CONF[$_EXTKEY];
        }

        public function decodeTerExchangeData($stream) {
                $parts = explode(':', $stream, 3);
                if ($parts[1] === 'gzcompress') {
                        if (function_exists('gzuncompress')) {
                                $parts[2] = gzuncompress($parts[2]);
                        } else {
                                throw new \RuntimeException('Decoding Error: No decompressor available for compressed content. gzcompress()/gzuncompress() functions are not available!', 1359124403);
                        }
                }
                if (md5($parts[2]) === $parts[0]) {
                        $output = unserialize($parts[2]);
                        if (!is_array($output)) {
                                throw new \RuntimeException('Error: Content could not be unserialized to an array. Strange (since MD5 hashes match!)', 1359124554);
                        }
                } else {
                        throw new \RuntimeException('Error: MD5 mismatch. Maybe the extension file was downloaded and saved as a text file and thereby corrupted!?', 1359124556);
                }
                return $output;
        }


        protected function extractFilesArrayFromExtensionData(array $extensionData) {
                return $extensionData['FILES'];
        }

        protected function extractDirectoriesFromExtensionData(array $files) {
                $directories = array();
                foreach ($files as $filePath => $file) {
                        preg_match('/(.*)\\//', $filePath, $matches);
                        if (count($matches) > 0) {
                                $directories[] = $matches[0];
                        }
                }
                return $directories;
        }

        protected function createDirectoriesForExtensionFiles(array $directories, $rootPath) {
                foreach ($directories as $directory) {
                        $this->createNestedDirectory($rootPath . $directory);
                }
        }

        protected function createNestedDirectory($directory) {
                $currentPath = $directory;
                if (!@is_dir($currentPath)) {
                        do {
                                $separatorPosition = strrpos($currentPath, DIRECTORY_SEPARATOR);
                                $currentPath = substr($currentPath, 0, $separatorPosition);
                        } while (!is_dir($currentPath) && $separatorPosition !== FALSE);

                        $result = @mkdir($directory, 0777, TRUE);
                        if (!$result) {
                                throw new \RuntimeException('Could not create directory "' . $directory . '"!', 1170251400);
                        }
                }
        }

        protected function writeExtensionFiles(array $files, $rootPath) {
                foreach ($files as $file) {
                        if (empty($file['name']) || substr($file['name'], -1) === '/') {
                                continue;
                        }
                        $filename = $rootPath . $file['name'];
                        $content = $file['content'];
                        if ($fd = fopen($filename, 'wb')) {
                                fwrite($fd, $content);
                                fclose($fd);
                        }
                }
        }

        protected function writeEmConf(array $extensionData, $path) {
                $emConfFileData = array();
                if (file_exists($path . 'ext_emconf.php')) {
                        $emConfFileData = $this->getEmConfMetaData($path);
                }
                $extensionData['EM_CONF'] = array_replace_recursive($emConfFileData, $extensionData['EM_CONF']);
                $emConfContent = $this->constructEmConf($extensionData);
                if ($fd = fopen($path . 'ext_emconf.php', 'wb')) {
                        fwrite($fd, $emConfContent);
                        fclose($fd);
                }
        }

        public function constructEmConf(array $extensionData) {
                $emConf = $this->fixEmConf($extensionData['EM_CONF']);
                $emConf['_md5_values_when_last_written'] = serialize($this->extensionMD5array($extensionData['FILES']));
                $uniqueIdentifier = md5($emConf['_md5_values_when_last_written']);
                $emConf = var_export($emConf, TRUE);
                $code = '<?php

/***************************************************************
 * Extension Manager/Repository config file for ext "' . $extensionData['extKey'] . '".
 *
 * Auto generated | Identifier: ' . $uniqueIdentifier . '
 *
 * Manual updates:
 * Only the data in the array - everything else is removed by next
 * writing. "version" and "dependencies" must not be touched!
 ***************************************************************/

$EM_CONF[$_EXTKEY] = ' . $emConf . ';

?>';
                return str_replace('  ', chr(9), $code);
        }

        function extensionMD5array(array $filesArray) {
                $md5Array = array();

                // Traverse files.
                foreach ($filesArray as $fileName => $fileInfo) {
                        $fileName = ltrim($fileName, '/');
                        if ($fileName !== 'ext_emconf.php') {
                                $md5Array[$fileName] = substr($fileInfo['content_md5'], 0, 4);
                        }
                }

                return $md5Array;
        }

        public function fixEmConf(array $emConf) {
                if (
                        !isset($emConf['constraints']) || !isset($emConf['constraints']['depends'])
                        || !isset($emConf['constraints']['conflicts']) || !isset($emConf['constraints']['suggests'])
                ) {
                        if (!isset($emConf['constraints']) || !isset($emConf['constraints']['depends'])) {
                                $emConf['constraints']['depends'] = $this->stringToDependency($emConf['dependencies']);
                                if ((string)$emConf['PHP_version'] !== '') {
                                        $emConf['constraints']['depends']['php'] = $emConf['PHP_version'];
                                }
                                if ((string)$emConf['TYPO3_version'] !== '') {
                                        $emConf['constraints']['depends']['typo3'] = $emConf['TYPO3_version'];
                                }
                        }
                        if (!isset($emConf['constraints']) || !isset($emConf['constraints']['conflicts'])) {
                                $emConf['constraints']['conflicts'] = $this->stringToDependency($emConf['conflicts']);
                        }
                        if (!isset($emConf['constraints']) || !isset($emConf['constraints']['suggests'])) {
                                $emConf['constraints']['suggests'] = array();
                        }
                } elseif (isset($emConf['constraints']) && isset($emConf['dependencies'])) {
                        $emConf['suggests'] = isset($emConf['suggests']) ? $emConf['suggests'] : array();
                        $emConf['dependencies'] = $this->dependencyToString($emConf['constraints']);
                        $emConf['conflicts'] = $this->dependencyToString($emConf['constraints'], 'conflicts');
                }

                // Remove TER v1-style entries
                unset($emConf['dependencies']);
                unset($emConf['conflicts']);
                unset($emConf['suggests']);
                unset($emConf['private']);
                unset($emConf['download_password']);
                unset($emConf['TYPO3_version']);
                unset($emConf['PHP_version']);
                unset($emConf['internal']);
                unset($emConf['module']);
                unset($emConf['loadOrder']);
                unset($emConf['lockType']);
                unset($emConf['shy']);
                unset($emConf['priority']);
                unset($emConf['modify_tables']);
                unset($emConf['CGLcompliance']);
                unset($emConf['CGLcompliance_note']);

                return $emConf;
        }

        static public function dependencyToString($dependency, $type = 'depends') {
                if (is_array($dependency)) {
                        if (isset($dependency[$type]['php'])) {
                                unset($dependency[$type]['php']);
                        }
                        if (isset($dependency[$type]['typo3'])) {
                                unset($dependency[$type]['typo3']);
                        }
                        $dependencyString = count($dependency[$type]) ? implode(',', array_keys($dependency[$type])) : '';
                        return $dependencyString;
                }
                return '';
        }

        public function stringToDependency($dependency) {
                $constraint = array();
                if (is_string($dependency) && strlen($dependency)) {
                        $dependency = explode(',', $dependency);
                        foreach ($dependency as $v) {
                                $constraint[$v] = '';
                        }
                }
                return $constraint;
        }

        protected function convertDependencies($dependencies) {
                $newDependencies = array();
                $dependenciesArray = unserialize($dependencies);
                if (is_array($dependenciesArray)) {
                        foreach ($dependenciesArray as $version) {
                                if (!empty($version['extensionKey'])) {
                                        $newDependencies[$version['kind']][$version['extensionKey']] = $version['versionRange'];
                                }
                        }
                }
                return $newDependencies;
        }
}