123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319 |
- <?php
- namespace Drupal\Core\Composer;
- use Composer\Installer\PackageEvent;
- use Composer\Script\Event;
- use Composer\Semver\Constraint\Constraint;
- use Composer\Util\ProcessExecutor;
- use Drupal\Component\FileSecurity\FileSecurity;
- /**
- * Provides static functions for composer script events.
- *
- * @see https://getcomposer.org/doc/articles/scripts.md
- */
- class Composer {
- protected static $packageToCleanup = [
- 'behat/mink' => ['tests', 'driver-testsuite'],
- 'behat/mink-browserkit-driver' => ['tests'],
- 'behat/mink-goutte-driver' => ['tests'],
- 'behat/mink-selenium2-driver' => ['tests'],
- 'brumann/polyfill-unserialize' => ['tests'],
- 'composer/composer' => ['bin'],
- 'drupal/coder' => ['coder_sniffer/Drupal/Test', 'coder_sniffer/DrupalPractice/Test'],
- 'doctrine/cache' => ['tests'],
- 'doctrine/collections' => ['tests'],
- 'doctrine/common' => ['tests'],
- 'doctrine/inflector' => ['tests'],
- 'doctrine/instantiator' => ['tests'],
- 'easyrdf/easyrdf' => ['scripts'],
- 'egulias/email-validator' => ['documentation', 'tests'],
- 'fabpot/goutte' => ['Goutte/Tests'],
- 'guzzlehttp/promises' => ['tests'],
- 'guzzlehttp/psr7' => ['tests'],
- 'instaclick/php-webdriver' => ['doc', 'test'],
- 'jcalderonzumba/gastonjs' => ['docs', 'examples', 'tests'],
- 'jcalderonzumba/mink-phantomjs-driver' => ['tests'],
- 'justinrainbow/json-schema' => ['demo'],
- 'laminas/laminas-escaper' => ['doc'],
- 'laminas/laminas-feed' => ['doc'],
- 'laminas/laminas-stdlib' => ['doc'],
- 'masterminds/html5' => ['bin', 'test'],
- 'mikey179/vfsStream' => ['src/test'],
- 'myclabs/deep-copy' => ['doc'],
- 'paragonie/random_compat' => ['tests'],
- 'pear/archive_tar' => ['docs', 'tests'],
- 'pear/console_getopt' => ['tests'],
- 'pear/pear-core-minimal' => ['tests'],
- 'pear/pear_exception' => ['tests'],
- 'phar-io/manifest' => ['examples', 'tests'],
- 'phar-io/version' => ['tests'],
- 'phpdocumentor/reflection-docblock' => ['tests'],
- 'phpspec/prophecy' => ['fixtures', 'spec', 'tests'],
- 'phpunit/php-code-coverage' => ['tests'],
- 'phpunit/php-timer' => ['tests'],
- 'phpunit/php-token-stream' => ['tests'],
- 'phpunit/phpunit' => ['tests'],
- 'phpunit/phpunit-mock-objects' => ['tests'],
- 'sebastian/code-unit-reverse-lookup' => ['tests'],
- 'sebastian/comparator' => ['tests'],
- 'sebastian/diff' => ['tests'],
- 'sebastian/environment' => ['tests'],
- 'sebastian/exporter' => ['tests'],
- 'sebastian/global-state' => ['tests'],
- 'sebastian/object-enumerator' => ['tests'],
- 'sebastian/object-reflector' => ['tests'],
- 'sebastian/recursion-context' => ['tests'],
- 'seld/jsonlint' => ['tests'],
- 'squizlabs/php_codesniffer' => ['tests'],
- 'stack/builder' => ['tests'],
- 'symfony/browser-kit' => ['Tests'],
- 'symfony/class-loader' => ['Tests'],
- 'symfony/console' => ['Tests'],
- 'symfony/css-selector' => ['Tests'],
- 'symfony/debug' => ['Tests'],
- 'symfony/dependency-injection' => ['Tests'],
- 'symfony/dom-crawler' => ['Tests'],
- 'symfony/filesystem' => ['Tests'],
- 'symfony/finder' => ['Tests'],
- 'symfony/event-dispatcher' => ['Tests'],
- 'symfony/http-foundation' => ['Tests'],
- 'symfony/http-kernel' => ['Tests'],
- 'symfony/phpunit-bridge' => ['Tests'],
- 'symfony/process' => ['Tests'],
- 'symfony/psr-http-message-bridge' => ['Tests'],
- 'symfony/routing' => ['Tests'],
- 'symfony/serializer' => ['Tests'],
- 'symfony/translation' => ['Tests'],
- 'symfony/validator' => ['Tests', 'Resources'],
- 'symfony/yaml' => ['Tests'],
- 'symfony-cmf/routing' => ['Test', 'Tests'],
- 'theseer/tokenizer' => ['tests'],
- 'twig/twig' => ['doc', 'ext', 'test', 'tests'],
- ];
- /**
- * Add vendor classes to Composer's static classmap.
- *
- * @param \Composer\Script\Event $event
- */
- public static function preAutoloadDump(Event $event) {
- // Get the configured vendor directory.
- $vendor_dir = $event->getComposer()->getConfig()->get('vendor-dir');
- // We need the root package so we can add our classmaps to its loader.
- $package = $event->getComposer()->getPackage();
- // We need the local repository so that we can query and see if it's likely
- // that our files are present there.
- $repository = $event->getComposer()->getRepositoryManager()->getLocalRepository();
- // This is, essentially, a null constraint. We only care whether the package
- // is present in the vendor directory yet, but findPackage() requires it.
- $constraint = new Constraint('>', '');
- // It's possible that there is no classmap specified in a custom project
- // composer.json file. We need one so we can optimize lookup for some of our
- // dependencies.
- $autoload = $package->getAutoload();
- if (!isset($autoload['classmap'])) {
- $autoload['classmap'] = [];
- }
- // Check for our packages, and then optimize them if they're present.
- if ($repository->findPackage('symfony/http-foundation', $constraint)) {
- $autoload['classmap'] = array_merge($autoload['classmap'], [
- $vendor_dir . '/symfony/http-foundation/Request.php',
- $vendor_dir . '/symfony/http-foundation/ParameterBag.php',
- $vendor_dir . '/symfony/http-foundation/FileBag.php',
- $vendor_dir . '/symfony/http-foundation/ServerBag.php',
- $vendor_dir . '/symfony/http-foundation/HeaderBag.php',
- ]);
- }
- if ($repository->findPackage('symfony/http-kernel', $constraint)) {
- $autoload['classmap'] = array_merge($autoload['classmap'], [
- $vendor_dir . '/symfony/http-kernel/HttpKernel.php',
- $vendor_dir . '/symfony/http-kernel/HttpKernelInterface.php',
- $vendor_dir . '/symfony/http-kernel/TerminableInterface.php',
- ]);
- }
- $package->setAutoload($autoload);
- }
- /**
- * Ensures that .htaccess and web.config files are present in Composer root.
- *
- * @param \Composer\Script\Event $event
- */
- public static function ensureHtaccess(Event $event) {
- // The current working directory for composer scripts is where you run
- // composer from.
- $vendor_dir = $event->getComposer()->getConfig()->get('vendor-dir');
- // Prevent access to vendor directory on Apache servers.
- FileSecurity::writeHtaccess($vendor_dir);
- // Prevent access to vendor directory on IIS servers.
- FileSecurity::writeWebConfig($vendor_dir);
- }
- /**
- * Remove possibly problematic test files from vendored projects.
- *
- * @param \Composer\Installer\PackageEvent $event
- * A PackageEvent object to get the configured composer vendor directories
- * from.
- */
- public static function vendorTestCodeCleanup(PackageEvent $event) {
- $vendor_dir = $event->getComposer()->getConfig()->get('vendor-dir');
- $io = $event->getIO();
- $op = $event->getOperation();
- if ($op->getJobType() == 'update') {
- $package = $op->getTargetPackage();
- }
- else {
- $package = $op->getPackage();
- }
- $package_key = static::findPackageKey($package->getName());
- $message = sprintf(" Processing <comment>%s</comment>", $package->getPrettyName());
- if ($io->isVeryVerbose()) {
- $io->write($message);
- }
- if ($package_key) {
- foreach (static::$packageToCleanup[$package_key] as $path) {
- $dir_to_remove = $vendor_dir . '/' . $package_key . '/' . $path;
- $print_message = $io->isVeryVerbose();
- if (is_dir($dir_to_remove)) {
- if (static::deleteRecursive($dir_to_remove)) {
- $message = sprintf(" <info>Removing directory '%s'</info>", $path);
- }
- else {
- // Always display a message if this fails as it means something has
- // gone wrong. Therefore the message has to include the package name
- // as the first informational message might not exist.
- $print_message = TRUE;
- $message = sprintf(" <error>Failure removing directory '%s'</error> in package <comment>%s</comment>.", $path, $package->getPrettyName());
- }
- }
- else {
- // If the package has changed or the --prefer-dist version does not
- // include the directory this is not an error.
- $message = sprintf(" Directory '%s' does not exist", $path);
- }
- if ($print_message) {
- $io->write($message);
- }
- }
- if ($io->isVeryVerbose()) {
- // Add a new line to separate this output from the next package.
- $io->write("");
- }
- }
- }
- /**
- * Find the array key for a given package name with a case-insensitive search.
- *
- * @param string $package_name
- * The package name from composer. This is always already lower case.
- *
- * @return string|null
- * The string key, or NULL if none was found.
- */
- protected static function findPackageKey($package_name) {
- $package_key = NULL;
- // In most cases the package name is already used as the array key.
- if (isset(static::$packageToCleanup[$package_name])) {
- $package_key = $package_name;
- }
- else {
- // Handle any mismatch in case between the package name and array key.
- // For example, the array key 'mikey179/vfsStream' needs to be found
- // when composer returns a package name of 'mikey179/vfsstream'.
- foreach (static::$packageToCleanup as $key => $dirs) {
- if (strtolower($key) === $package_name) {
- $package_key = $key;
- break;
- }
- }
- }
- return $package_key;
- }
- /**
- * Removes Composer's timeout so that scripts can run indefinitely.
- */
- public static function removeTimeout() {
- ProcessExecutor::setTimeout(0);
- }
- /**
- * Helper method to remove directories and the files they contain.
- *
- * @param string $path
- * The directory or file to remove. It must exist.
- *
- * @return bool
- * TRUE on success or FALSE on failure.
- */
- protected static function deleteRecursive($path) {
- if (is_file($path) || is_link($path)) {
- return unlink($path);
- }
- $success = TRUE;
- $dir = dir($path);
- while (($entry = $dir->read()) !== FALSE) {
- if ($entry == '.' || $entry == '..') {
- continue;
- }
- $entry_path = $path . '/' . $entry;
- $success = static::deleteRecursive($entry_path) && $success;
- }
- $dir->close();
- return rmdir($path) && $success;
- }
- /**
- * Fires the drupal-phpunit-upgrade script event if necessary.
- *
- * @param \Composer\Script\Event $event
- */
- public static function upgradePHPUnit(Event $event) {
- $repository = $event->getComposer()->getRepositoryManager()->getLocalRepository();
- // This is, essentially, a null constraint. We only care whether the package
- // is present in the vendor directory yet, but findPackage() requires it.
- $constraint = new Constraint('>', '');
- $phpunit_package = $repository->findPackage('phpunit/phpunit', $constraint);
- if (!$phpunit_package) {
- // There is nothing to do. The user is probably installing using the
- // --no-dev flag.
- return;
- }
- // If the PHP version is 7.3 or above and PHPUnit is less than version 7
- // call the drupal-phpunit-upgrade script to upgrade PHPUnit.
- if (!static::upgradePHPUnitCheck($phpunit_package->getVersion())) {
- $event->getComposer()
- ->getEventDispatcher()
- ->dispatchScript('drupal-phpunit-upgrade');
- }
- }
- /**
- * Determines if PHPUnit needs to be upgraded.
- *
- * This method is located in this file because it is possible that it is
- * called before the autoloader is available.
- *
- * @param string $phpunit_version
- * The PHPUnit version string.
- *
- * @return bool
- * TRUE if the PHPUnit needs to be upgraded, FALSE if not.
- */
- public static function upgradePHPUnitCheck($phpunit_version) {
- return !(version_compare(PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION, '7.3') >= 0 && version_compare($phpunit_version, '7.0') < 0);
- }
- }
|