Your IP : 216.73.216.43
<?php
declare (strict_types=1);
namespace Rector\Core\Application\FileProcessor;
use RectorPrefix202304\Nette\Utils\Strings;
use PHPStan\AnalysedCodeException;
use Rector\ChangesReporting\ValueObjectFactory\ErrorFactory;
use Rector\Core\Application\FileDecorator\FileDiffFileDecorator;
use Rector\Core\Application\FileProcessor;
use Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector;
use Rector\Core\Contract\Console\OutputStyleInterface;
use Rector\Core\Contract\Processor\FileProcessorInterface;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\FileSystem\FilePathHelper;
use Rector\Core\PhpParser\Printer\FormatPerservingPrinter;
use Rector\Core\Provider\CurrentFileProvider;
use Rector\Core\ValueObject\Application\File;
use Rector\Core\ValueObject\Configuration;
use Rector\Core\ValueObject\Error\SystemError;
use Rector\Core\ValueObject\Reporting\FileDiff;
use Rector\Parallel\ValueObject\Bridge;
use Rector\PostRector\Application\PostFileProcessor;
use Rector\Testing\PHPUnit\StaticPHPUnitEnvironment;
use Throwable;
final class PhpFileProcessor implements FileProcessorInterface
{
/**
* @var string
* @see https://regex101.com/r/xP2MGa/1
*/
private const OPEN_TAG_SPACED_REGEX = '#^(?<open_tag_spaced>[^\\S\\r\\n]+\\<\\?php)#m';
/**
* @readonly
* @var \Rector\Core\PhpParser\Printer\FormatPerservingPrinter
*/
private $formatPerservingPrinter;
/**
* @readonly
* @var \Rector\Core\Application\FileProcessor
*/
private $fileProcessor;
/**
* @readonly
* @var \Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector
*/
private $removedAndAddedFilesCollector;
/**
* @readonly
* @var \Rector\Core\Contract\Console\OutputStyleInterface
*/
private $rectorOutputStyle;
/**
* @readonly
* @var \Rector\Core\Application\FileDecorator\FileDiffFileDecorator
*/
private $fileDiffFileDecorator;
/**
* @readonly
* @var \Rector\Core\Provider\CurrentFileProvider
*/
private $currentFileProvider;
/**
* @readonly
* @var \Rector\PostRector\Application\PostFileProcessor
*/
private $postFileProcessor;
/**
* @readonly
* @var \Rector\ChangesReporting\ValueObjectFactory\ErrorFactory
*/
private $errorFactory;
/**
* @readonly
* @var \Rector\Core\FileSystem\FilePathHelper
*/
private $filePathHelper;
public function __construct(FormatPerservingPrinter $formatPerservingPrinter, FileProcessor $fileProcessor, RemovedAndAddedFilesCollector $removedAndAddedFilesCollector, OutputStyleInterface $rectorOutputStyle, FileDiffFileDecorator $fileDiffFileDecorator, CurrentFileProvider $currentFileProvider, PostFileProcessor $postFileProcessor, ErrorFactory $errorFactory, FilePathHelper $filePathHelper)
{
$this->formatPerservingPrinter = $formatPerservingPrinter;
$this->fileProcessor = $fileProcessor;
$this->removedAndAddedFilesCollector = $removedAndAddedFilesCollector;
$this->rectorOutputStyle = $rectorOutputStyle;
$this->fileDiffFileDecorator = $fileDiffFileDecorator;
$this->currentFileProvider = $currentFileProvider;
$this->postFileProcessor = $postFileProcessor;
$this->errorFactory = $errorFactory;
$this->filePathHelper = $filePathHelper;
}
/**
* @return array{system_errors: SystemError[], file_diffs: FileDiff[]}
*/
public function process(File $file, Configuration $configuration) : array
{
$systemErrorsAndFileDiffs = [Bridge::SYSTEM_ERRORS => [], Bridge::FILE_DIFFS => []];
// 1. parse files to nodes
$parsingSystemErrors = $this->parseFileAndDecorateNodes($file);
if ($parsingSystemErrors !== []) {
// we cannot process this file as the parsing and type resolving itself went wrong
$systemErrorsAndFileDiffs[Bridge::SYSTEM_ERRORS] = $parsingSystemErrors;
return $systemErrorsAndFileDiffs;
}
// 2. change nodes with Rectors
do {
$file->changeHasChanged(\false);
$this->fileProcessor->refactor($file, $configuration);
// 3. apply post rectors
$newStmts = $this->postFileProcessor->traverse($file->getNewStmts());
// this is needed for new tokens added in "afterTraverse()"
$file->changeNewStmts($newStmts);
// 4. print to file or string
// important to detect if file has changed
$this->printFile($file, $configuration);
} while ($file->hasChanged());
// return json here
$fileDiff = $file->getFileDiff();
if (!$fileDiff instanceof FileDiff) {
return $systemErrorsAndFileDiffs;
}
$systemErrorsAndFileDiffs[Bridge::FILE_DIFFS] = [$fileDiff];
return $systemErrorsAndFileDiffs;
}
public function supports(File $file, Configuration $configuration) : bool
{
$filePathExtension = \pathinfo($file->getFilePath(), \PATHINFO_EXTENSION);
return \in_array($filePathExtension, $configuration->getFileExtensions(), \true);
}
/**
* @return string[]
*/
public function getSupportedFileExtensions() : array
{
return ['php'];
}
/**
* @return SystemError[]
*/
private function parseFileAndDecorateNodes(File $file) : array
{
$this->currentFileProvider->setFile($file);
$this->notifyFile($file);
try {
$this->fileProcessor->parseFileInfoToLocalCache($file);
} catch (ShouldNotHappenException $shouldNotHappenException) {
throw $shouldNotHappenException;
} catch (AnalysedCodeException $analysedCodeException) {
// inform about missing classes in tests
if (StaticPHPUnitEnvironment::isPHPUnitRun()) {
throw $analysedCodeException;
}
$autoloadSystemError = $this->errorFactory->createAutoloadError($analysedCodeException, $file->getFilePath());
return [$autoloadSystemError];
} catch (Throwable $throwable) {
if ($this->rectorOutputStyle->isVerbose() || StaticPHPUnitEnvironment::isPHPUnitRun()) {
throw $throwable;
}
$relativeFilePath = $this->filePathHelper->relativePath($file->getFilePath());
$systemError = new SystemError($throwable->getMessage(), $relativeFilePath, $throwable->getLine());
return [$systemError];
}
return [];
}
private function printFile(File $file, Configuration $configuration) : void
{
$filePath = $file->getFilePath();
if ($this->removedAndAddedFilesCollector->isFileRemoved($filePath)) {
// skip, because this file exists no more
return;
}
// only save to string first, no need to print to file when not needed
$newContent = $this->formatPerservingPrinter->printParsedStmstAndTokensToString($file);
/**
* When no diff applied, the PostRector may still change the content, that's why printing still needed
* On printing, the space may be wiped, these below check compare with original file content used to verify
* that no change actually needed
*/
if (!$file->getFileDiff() instanceof FileDiff) {
/**
* Handle new line or space before <?php or InlineHTML node wiped on print format preserving
* On very first content level
*/
$originalFileContent = $file->getOriginalFileContent();
$ltrimOriginalFileContent = \ltrim($originalFileContent);
if ($ltrimOriginalFileContent === $newContent) {
return;
}
$cleanOriginalContent = Strings::replace($ltrimOriginalFileContent, self::OPEN_TAG_SPACED_REGEX, '<?php');
$cleanNewContent = Strings::replace($newContent, self::OPEN_TAG_SPACED_REGEX, '<?php');
/**
* Handle space before <?php wiped on print format preserving
* On inside content level
*/
if ($cleanOriginalContent === $cleanNewContent) {
return;
}
}
if (!$configuration->isDryRun()) {
$this->formatPerservingPrinter->dumpFile($file->getFilePath(), $newContent);
}
$file->changeFileContent($newContent);
$this->fileDiffFileDecorator->decorate([$file]);
}
private function notifyFile(File $file) : void
{
if (!$this->rectorOutputStyle->isVerbose()) {
return;
}
$relativeFilePath = $this->filePathHelper->relativePath($file->getFilePath());
$this->rectorOutputStyle->writeln($relativeFilePath);
}
}