AbstractConfigurator.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Flex\Configurator;

use Composer\Composer;
use Composer\IO\IOInterface;
use Symfony\Flex\Lock;
use Symfony\Flex\Options;
use Symfony\Flex\Path;
use Symfony\Flex\Recipe;
use Symfony\Flex\Update\RecipeUpdate;

/**
 * @author Fabien Potencier <fabien@symfony.com>
 */
abstract class AbstractConfigurator
{
    protected $composer;
    protected $io;
    protected $options;
    protected $path;

    public function __construct(Composer $composer, IOInterface $io, Options $options)
    {
        $this->composer = $composer;
        $this->io = $io;
        $this->options = $options;
        $this->path = new Path($options->get('root-dir'));
    }

    abstract public function configure(Recipe $recipe, $config, Lock $lock, array $options = []);

    abstract public function unconfigure(Recipe $recipe, $config, Lock $lock);

    abstract public function update(RecipeUpdate $recipeUpdate, array $originalConfig, array $newConfig): void;

    protected function write($messages, $verbosity = IOInterface::VERBOSE)
    {
        if (!\is_array($messages)) {
            $messages = [$messages];
        }
        foreach ($messages as $i => $message) {
            $messages[$i] = '    '.$message;
        }
        $this->io->writeError($messages, true, $verbosity);
    }

    protected function isFileMarked(Recipe $recipe, string $file): bool
    {
        return is_file($file) && str_contains(file_get_contents($file), \sprintf('###> %s ###', $recipe->getName()));
    }

    protected function markData(Recipe $recipe, string $data): string
    {
        return "\n".\sprintf('###> %s ###%s%s%s###< %s ###%s', $recipe->getName(), "\n", rtrim($data, "\r\n"), "\n", $recipe->getName(), "\n");
    }

    protected function isFileXmlMarked(Recipe $recipe, string $file): bool
    {
        return is_file($file) && str_contains(file_get_contents($file), \sprintf('###+ %s ###', $recipe->getName()));
    }

    protected function markXmlData(Recipe $recipe, string $data): string
    {
        return "\n".\sprintf('        <!-- ###+ %s ### -->%s%s%s        <!-- ###- %s ### -->%s', $recipe->getName(), "\n", rtrim($data, "\r\n"), "\n", $recipe->getName(), "\n");
    }

    /**
     * @return bool True if section was found and replaced
     */
    protected function updateData(string $file, string $data): bool
    {
        if (!file_exists($file)) {
            return false;
        }

        $contents = file_get_contents($file);

        $newContents = $this->updateDataString($contents, $data);
        if (null === $newContents) {
            return false;
        }

        file_put_contents($file, $newContents);

        return true;
    }

    /**
     * @return string|null returns the updated content if the section was found, null if not found
     */
    protected function updateDataString(string $contents, string $data): ?string
    {
        $pieces = explode("\n", trim($data));
        $startMark = trim(reset($pieces));
        $endMark = trim(end($pieces));

        if (!str_contains($contents, $startMark) || !str_contains($contents, $endMark)) {
            return null;
        }

        $pattern = '/'.preg_quote($startMark, '/').'.*?'.preg_quote($endMark, '/').'/s';

        return preg_replace($pattern, trim($data), $contents);
    }

    protected function extractSection(Recipe $recipe, string $contents): ?string
    {
        $section = $this->markData($recipe, '----');

        $pieces = explode("\n", trim($section));
        $startMark = trim(reset($pieces));
        $endMark = trim(end($pieces));

        $pattern = '/'.preg_quote($startMark, '/').'.*?'.preg_quote($endMark, '/').'/s';

        $matches = [];
        preg_match($pattern, $contents, $matches);

        return $matches[0] ?? null;
    }
}