vendor/api-platform/core/src/Core/Bridge/Symfony/Bundle/Command/UpgradeApiResourceCommand.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Command;
  16. use ApiPlatform\Core\Annotation\ApiResource;
  17. use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
  18. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  19. use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
  20. use ApiPlatform\Core\Upgrade\ColorConsoleDiffFormatter;
  21. use ApiPlatform\Core\Upgrade\SubresourceTransformer;
  22. use ApiPlatform\Core\Upgrade\UpgradeApiFilterVisitor;
  23. use ApiPlatform\Core\Upgrade\UpgradeApiPropertyVisitor;
  24. use ApiPlatform\Core\Upgrade\UpgradeApiResourceVisitor;
  25. use ApiPlatform\Core\Upgrade\UpgradeApiSubresourceVisitor;
  26. use ApiPlatform\Exception\ResourceClassNotFoundException;
  27. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  28. use Doctrine\Common\Annotations\AnnotationReader;
  29. use PhpParser\Lexer;
  30. use PhpParser\NodeTraverser;
  31. use PhpParser\NodeVisitor\CloningVisitor;
  32. use PhpParser\Parser\Php7;
  33. use PhpParser\PrettyPrinter\Standard;
  34. use SebastianBergmann\Diff\Differ;
  35. use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
  36. use Symfony\Component\Console\Attribute\AsCommand;
  37. use Symfony\Component\Console\Command\Command;
  38. use Symfony\Component\Console\Input\InputArgument;
  39. use Symfony\Component\Console\Input\InputInterface;
  40. use Symfony\Component\Console\Input\InputOption;
  41. use Symfony\Component\Console\Output\OutputInterface;
  43. #[AsCommand(name: 'api:upgrade-resource')]
  44. final class UpgradeApiResourceCommand extends Command
  45. {
  46. /**
  47. * @deprecated To be removed along with Symfony < 6.1 compatibility
  48. */
  49. protected static $defaultName = 'api:upgrade-resource';
  51. private $resourceNameCollectionFactory;
  52. private $resourceMetadataFactory;
  53. private $subresourceOperationFactory;
  54. private $subresourceTransformer;
  55. private $reader;
  56. private $identifiersExtractor;
  58. public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, SubresourceOperationFactoryInterface $subresourceOperationFactory, SubresourceTransformer $subresourceTransformer, IdentifiersExtractorInterface $identifiersExtractor, AnnotationReader $reader = null)
  59. {
  60. $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  61. $this->resourceMetadataFactory = $resourceMetadataFactory;
  62. $this->subresourceOperationFactory = $subresourceOperationFactory;
  63. $this->subresourceTransformer = $subresourceTransformer;
  64. $this->identifiersExtractor = $identifiersExtractor;
  65. $this->reader = $reader;
  67. parent::__construct();
  68. }
  70. protected function configure()
  71. {
  72. $this
  73. ->setDescription('The "api:upgrade-resource" command upgrades your API Platform metadata from versions below 2.6 to the new metadata from versions above 2.7.
  74. Once you executed this script, make sure that the "metadata_backward_compatibility_layer" flag is set to "false" in the API Platform configuration.
  75. This will remove "ApiPlatform\Core\Annotation\ApiResource" annotation/attribute and use the "ApiPlatform\Metadata\ApiResource" attribute instead.')
  76. ->addOption('dry-run', '-d', InputOption::VALUE_OPTIONAL, 'Dry mode outputs a diff instead of writing files.', true)
  77. ->addOption('silent', '-s', InputOption::VALUE_NONE, 'Silent output.')
  78. ->addOption('force', '-f', InputOption::VALUE_NONE, 'Writes the files in place and skips PHP version check.')
  79. ->addArgument('class', InputArgument::OPTIONAL, 'A fully qualified class name.');
  80. }
  82. protected function execute(InputInterface $input, OutputInterface $output): int
  83. {
  84. if (!$input->getOption('force') && \PHP_VERSION_ID < 80100) {
  85. $output->write('<error>The new metadata system only works with PHP 8.1 and above.');
  87. return \defined(Command::class.'::INVALID') ? Command::INVALID : 2;
  88. }
  90. if (!class_exists(NodeTraverser::class)) {
  91. $output->writeln('Run `composer require --dev `nikic/php-parser` or install phpunit to use this command.');
  93. return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
  94. }
  96. $subresources = $this->getSubresources();
  98. $prettyPrinter = new Standard();
  99. foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  100. if ($input->getArgument('class') && $input->getArgument('class') !== $resourceClass) {
  101. continue;
  102. }
  104. try {
  105. $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  106. } catch (ResourceClassNotFoundException $e) {
  107. continue;
  108. }
  110. $lexer = new Lexer([
  111. 'usedAttributes' => [
  112. 'comments',
  113. 'startLine',
  114. 'endLine',
  115. 'startTokenPos',
  116. 'endTokenPos',
  117. ],
  118. ]);
  119. $parser = new Php7($lexer);
  120. $fileName = (new \ReflectionClass($resourceClass))->getFilename();
  122. $traverser = new NodeTraverser();
  123. [$attribute, $isAnnotation] = $this->readApiResource($resourceClass);
  125. $traverser->addVisitor(new UpgradeApiFilterVisitor($this->reader, $resourceClass));
  126. $traverser->addVisitor(new UpgradeApiPropertyVisitor($this->reader, $resourceClass));
  128. if (!$attribute) {
  129. continue;
  130. }
  132. $traverser->addVisitor(new UpgradeApiResourceVisitor($attribute, $isAnnotation, $this->identifiersExtractor, $resourceClass));
  134. if (isset($subresources[$resourceClass])) {
  135. $referenceType = $resourceMetadata->getAttribute('url_generation_strategy');
  136. foreach ($subresources[$resourceClass] as $subresourceMetadata) {
  137. $traverser->addVisitor(new UpgradeApiSubresourceVisitor($subresourceMetadata, $referenceType));
  138. }
  139. }
  141. $oldCode = file_get_contents($fileName);
  142. $oldStmts = $parser->parse($oldCode);
  143. $oldTokens = $lexer->getTokens();
  145. $cloningTraverser = new NodeTraverser();
  146. $cloningTraverser->addVisitor(new CloningVisitor()); // Required to preserve formatting
  148. $newStmts = $traverser->traverse($cloningTraverser->traverse($oldStmts));
  149. $newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);
  151. if (!$input->getOption('force') && $input->getOption('dry-run')) {
  152. if ($input->getOption('silent')) {
  153. continue;
  154. }
  156. if (!class_exists(Differ::class)) {
  157. $output->writeln('Run `composer require --dev sebastian/diff` or install phpunit to print a diff.');
  159. return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
  160. }
  162. $this->printDiff($oldCode, $newCode, $output);
  163. continue;
  164. }
  166. file_put_contents($fileName, $newCode);
  167. }
  169. return \defined(Command::class.'::SUCCESS') ? Command::SUCCESS : 0;
  170. }
  172. /**
  173. * This computes a local cache with resource classes having subresources.
  174. * We first loop over all the classes and re-map the metadata on the correct Resource class.
  175. * Then we transform the ApiSubresource to an ApiResource class.
  176. */
  177. private function getSubresources(): array
  178. {
  179. $localCache = [];
  180. foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  181. try {
  182. new \ReflectionClass($resourceClass);
  183. } catch (\Exception $e) {
  184. continue;
  185. }
  187. if (!isset($localCache[$resourceClass])) {
  188. $localCache[$resourceClass] = [];
  189. }
  191. foreach ($this->subresourceOperationFactory->create($resourceClass) as $subresourceMetadata) {
  192. if (!isset($localCache[$subresourceMetadata['resource_class']])) {
  193. $localCache[$subresourceMetadata['resource_class']] = [];
  194. }
  196. foreach ($localCache[$subresourceMetadata['resource_class']] as $currentSubresourceMetadata) {
  197. if ($currentSubresourceMetadata['path'] === $subresourceMetadata['path']) {
  198. continue 2;
  199. }
  200. }
  201. $localCache[$subresourceMetadata['resource_class']][] = $subresourceMetadata;
  202. }
  203. }
  205. // Compute URI variables
  206. foreach ($localCache as $class => $subresources) {
  207. if (!$subresources) {
  208. unset($localCache[$class]);
  209. continue;
  210. }
  212. foreach ($subresources as $i => $subresourceMetadata) {
  213. $localCache[$class][$i]['uri_variables'] = $this->subresourceTransformer->toUriVariables($subresourceMetadata);
  214. }
  215. }
  217. return $localCache;
  218. }
  220. private function printDiff(string $oldCode, string $newCode, OutputInterface $output): void
  221. {
  222. $consoleFormatter = new ColorConsoleDiffFormatter();
  223. $differ = class_exists(UnifiedDiffOutputBuilder::class) ? new Differ(new UnifiedDiffOutputBuilder()) : new Differ();
  224. $diff = $differ->diff($oldCode, $newCode);
  225. $output->write($consoleFormatter->format($diff));
  226. }
  228. /**
  229. * @return array[ApiResource, bool]
  230. */
  231. private function readApiResource(string $resourceClass): array
  232. {
  233. $reflectionClass = new \ReflectionClass($resourceClass);
  235. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionClass->getAttributes(ApiResource::class)) {
  236. return [$attributes[0]->newInstance(), false];
  237. }
  239. if (null === $this->reader) {
  240. throw new \RuntimeException(sprintf('Resource "%s" not found.', $resourceClass));
  241. }
  243. return [$this->reader->getClassAnnotation($reflectionClass, ApiResource::class), true];
  244. }
  245. }