CoreInstaller.php

Go to the documentation of this file.

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

/***************************************************************
 * Copyright notice
 *
 * (c) 2014 Christian Opitz <christian.opitz at netresearch.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 TYPO3\CMS\Composer\Plugin\Config;
use TYPO3\CMS\Composer\Plugin\Util\Filesystem;

class CoreInstaller implements \Composer\Installer\InstallerInterface {

        const TYPO3_DIR                 = 'typo3';
        const TYPO3_INDEX_PHP   = 'index.php';

        protected $symlinks = array();

        protected $composer;

        protected $downloadManager;

        protected $filesystem;

        protected $getTypo3OrgService;

        protected $pluginConfig;

        public function __construct(\Composer\Composer $composer, Filesystem $filesystem, CoreInstaller\GetTypo3OrgService $getTypo3OrgService) {
                $this->composer = $composer;
                $this->downloadManager = $composer->getDownloadManager();
                $this->filesystem = $filesystem;
                $this->getTypo3OrgService = $getTypo3OrgService;
                $this->initializeConfiguration();
                $this->initializeSymlinks();
        }

        protected function initializeConfiguration() {
                $this->pluginConfig = Config::load($this->composer);
        }

        protected function initializeSymlinks() {
                $webDir = $this->filesystem->normalizePath($this->pluginConfig->get('web-dir'));
                $this->filesystem->ensureDirectoryExists($webDir);
                $backendDir = $this->filesystem->normalizePath($this->pluginConfig->get('backend-dir'));
                $sourcesDir = $this->determineInstallPath();
                $this->symlinks = array(
                        $sourcesDir . DIRECTORY_SEPARATOR . self::TYPO3_INDEX_PHP
                                => $webDir . DIRECTORY_SEPARATOR . self::TYPO3_INDEX_PHP,
                        $sourcesDir . DIRECTORY_SEPARATOR . self::TYPO3_DIR
                                => $backendDir
                );
        }

        public function supports($packageType) {
                return $packageType === 'typo3-cms-core';
        }

        public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package) {
                return $repo->hasPackage($package)
                        && is_readable($this->getInstallPath($package))
                        && $this->filesystem->allFilesExist($this->symlinks);
        }

        public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package) {
                $this->getTypo3OrgService->addDistToPackage($package);

                if ($this->filesystem->someFilesExist($this->symlinks)) {
                        $this->filesystem->removeSymlinks($this->symlinks);
                }

                $this->installCode($package);

                $this->filesystem->establishSymlinks($this->symlinks, FALSE);

                if (!$repo->hasPackage($package)) {
                        $repo->addPackage(clone $package);
                }
        }

        public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target) {
                $this->getTypo3OrgService->addDistToPackage($initial);
                $this->getTypo3OrgService->addDistToPackage($target);

                if ($this->filesystem->someFilesExist($this->symlinks)) {
                        $this->filesystem->removeSymlinks($this->symlinks);
                }

                $this->updateCode($initial, $target);

                $this->filesystem->establishSymlinks($this->symlinks, FALSE);

                $repo->removePackage($initial);
                if (!$repo->hasPackage($target)) {
                        $repo->addPackage(clone $target);
                }
        }

        public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package) {
                if (!$repo->hasPackage($package)) {
                        throw new \InvalidArgumentException('Package is not installed: '.$package);
                }

                if ($this->filesystem->someFilesExist($this->symlinks)) {
                        $this->filesystem->removeSymlinks($this->symlinks);
                }

                $this->removeCode($package);
                $repo->removePackage($package);
        }

        public function getInstallPath(\Composer\Package\PackageInterface $package) {
                return $this->determineInstallPath();
        }

        protected function determineInstallPath() {
                return $this->pluginConfig->get('cms-package-dir');
        }

        protected function installCode(\Composer\Package\PackageInterface $package) {
                $downloadPath = $this->getInstallPath($package);
                $this->downloadManager->download($package, $downloadPath);
        }

        protected function updateCode(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target) {
                // Currently the install path for all versions is the same.
                // In the future the install path for two core versions may differ.
                $initialDownloadPath = $this->getInstallPath($initial);
                $targetDownloadPath = $this->getInstallPath($target);
                if ($targetDownloadPath !== $initialDownloadPath) {
                        // if the target and initial dirs intersect, we force a remove + install
                        // to avoid the rename wiping the target dir as part of the initial dir cleanup
                        if (substr($initialDownloadPath, 0, strlen($targetDownloadPath)) === $targetDownloadPath
                                || substr($targetDownloadPath, 0, strlen($initialDownloadPath)) === $initialDownloadPath
                        ) {
                                $this->removeCode($initial);
                                $this->installCode($target);

                                return;
                        }

                        $this->filesystem->rename($initialDownloadPath, $targetDownloadPath);
                }
                $this->downloadManager->update($initial, $target, $targetDownloadPath);
        }

        protected function removeCode(\Composer\Package\PackageInterface $package) {
                $downloadPath = $this->getInstallPath($package);
                $this->downloadManager->remove($package, $downloadPath);
        }
}

?>