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

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\Emulative;
  30. use PhpParser\NodeTraverser;
  31. use PhpParser\Parser\Php7;
  32. use PhpParser\PrettyPrinter\Standard;
  33. use SebastianBergmann\Diff\Differ;
  34. use Symfony\Component\Console\Attribute\AsCommand;
  35. use Symfony\Component\Console\Command\Command;
  36. use Symfony\Component\Console\Input\InputInterface;
  37. use Symfony\Component\Console\Input\InputOption;
  38. use Symfony\Component\Console\Output\OutputInterface;
  40. #[AsCommand(name: 'api:upgrade-resource')]
  41. final class UpgradeApiResourceCommand extends Command
  42. {
  43. /**
  44. * @deprecated To be removed along with Symfony < 6.1 compatibility
  45. */
  46. protected static $defaultName = 'api:upgrade-resource';
  48. private $resourceNameCollectionFactory;
  49. private $resourceMetadataFactory;
  50. private $subresourceOperationFactory;
  51. private $subresourceTransformer;
  52. private $reader;
  53. private $identifiersExtractor;
  55. public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, SubresourceOperationFactoryInterface $subresourceOperationFactory, SubresourceTransformer $subresourceTransformer, IdentifiersExtractorInterface $identifiersExtractor, AnnotationReader $reader = null)
  56. {
  57. $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  58. $this->resourceMetadataFactory = $resourceMetadataFactory;
  59. $this->subresourceOperationFactory = $subresourceOperationFactory;
  60. $this->subresourceTransformer = $subresourceTransformer;
  61. $this->identifiersExtractor = $identifiersExtractor;
  62. $this->reader = $reader;
  64. parent::__construct();
  65. }
  67. /**
  68. * {@inheritdoc}
  69. */
  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. }
  81. /**
  82. * {@inheritdoc}
  83. */
  84. protected function execute(InputInterface $input, OutputInterface $output): int
  85. {
  86. if (!$input->getOption('force') && \PHP_VERSION_ID < 80100) {
  87. $output->write('<error>The new metadata system only works with PHP 8.1 and above.');
  89. return \defined(Command::class.'::INVALID') ? Command::INVALID : 2;
  90. }
  92. if (!class_exists(NodeTraverser::class)) {
  93. $output->writeln('Run `composer require --dev `nikic/php-parser` or install phpunit to use this command.');
  95. return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
  96. }
  98. $subresources = $this->getSubresources();
  100. $prettyPrinter = new Standard();
  101. foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  102. try {
  103. $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  104. } catch (ResourceClassNotFoundException $e) {
  105. continue;
  106. }
  108. $lexer = new Emulative([
  109. 'usedAttributes' => [
  110. 'comments',
  111. 'startLine',
  112. 'endLine',
  113. 'startTokenPos',
  114. 'endTokenPos',
  115. ],
  116. ]);
  117. $parser = new Php7($lexer);
  118. $fileName = (new \ReflectionClass($resourceClass))->getFilename();
  120. $traverser = new NodeTraverser();
  121. [$attribute, $isAnnotation] = $this->readApiResource($resourceClass);
  123. $traverser->addVisitor(new UpgradeApiFilterVisitor($this->reader, $resourceClass));
  124. $traverser->addVisitor(new UpgradeApiPropertyVisitor($this->reader, $resourceClass));
  126. if (!$attribute) {
  127. continue;
  128. }
  130. $traverser->addVisitor(new UpgradeApiResourceVisitor($attribute, $isAnnotation, $this->identifiersExtractor, $resourceClass));
  132. if (isset($subresources[$resourceClass])) {
  133. $referenceType = $resourceMetadata->getAttribute('url_generation_strategy');
  134. foreach ($subresources[$resourceClass] as $subresourceMetadata) {
  135. $traverser->addVisitor(new UpgradeApiSubresourceVisitor($subresourceMetadata, $referenceType));
  136. }
  137. }
  139. $oldCode = file_get_contents($fileName);
  140. $oldStmts = $parser->parse($oldCode);
  141. $oldTokens = $lexer->getTokens();
  143. $newStmts = $traverser->traverse($oldStmts);
  144. $newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);
  146. if (!$input->getOption('force') && $input->getOption('dry-run')) {
  147. if ($input->getOption('silent')) {
  148. continue;
  149. }
  151. if (!class_exists(Differ::class)) {
  152. $output->writeln('Run `composer require --dev sebastian/diff` or install phpunit to print a diff.');
  154. return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
  155. }
  157. $this->printDiff($oldCode, $newCode, $output);
  158. continue;
  159. }
  161. file_put_contents($fileName, $newCode);
  162. }
  164. return \defined(Command::class.'::SUCCESS') ? Command::SUCCESS : 0;
  165. }
  167. /**
  168. * This computes a local cache with resource classes having subresources.
  169. * We first loop over all the classes and re-map the metadata on the correct Resource class.
  170. * Then we transform the ApiSubresource to an ApiResource class.
  171. */
  172. private function getSubresources(): array
  173. {
  174. $localCache = [];
  175. foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  176. try {
  177. new \ReflectionClass($resourceClass);
  178. } catch (\Exception $e) {
  179. continue;
  180. }
  182. if (!isset($localCache[$resourceClass])) {
  183. $localCache[$resourceClass] = [];
  184. }
  186. foreach ($this->subresourceOperationFactory->create($resourceClass) as $subresourceMetadata) {
  187. if (!isset($localCache[$subresourceMetadata['resource_class']])) {
  188. $localCache[$subresourceMetadata['resource_class']] = [];
  189. }
  191. foreach ($localCache[$subresourceMetadata['resource_class']] as $currentSubresourceMetadata) {
  192. if ($currentSubresourceMetadata['path'] === $subresourceMetadata['path']) {
  193. continue 2;
  194. }
  195. }
  196. $localCache[$subresourceMetadata['resource_class']][] = $subresourceMetadata;
  197. }
  198. }
  200. // Compute URI variables
  201. foreach ($localCache as $class => $subresources) {
  202. if (!$subresources) {
  203. unset($localCache[$class]);
  204. continue;
  205. }
  207. foreach ($subresources as $i => $subresourceMetadata) {
  208. $localCache[$class][$i]['uri_variables'] = $this->subresourceTransformer->toUriVariables($subresourceMetadata);
  209. }
  210. }
  212. return $localCache;
  213. }
  215. private function printDiff(string $oldCode, string $newCode, OutputInterface $output): void
  216. {
  217. $consoleFormatter = new ColorConsoleDiffFormatter();
  218. $differ = new Differ();
  219. $diff = $differ->diff($oldCode, $newCode);
  220. $output->write($consoleFormatter->format($diff));
  221. }
  223. /**
  224. * @return array[ApiResource, bool]
  225. */
  226. private function readApiResource(string $resourceClass): array
  227. {
  228. $reflectionClass = new \ReflectionClass($resourceClass);
  230. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionClass->getAttributes(ApiResource::class)) {
  231. return [$attributes[0]->newInstance(), false];
  232. }
  234. if (null === $this->reader) {
  235. throw new \RuntimeException(sprintf('Resource "%s" not found.', $resourceClass));
  236. }
  238. return [$this->reader->getClassAnnotation($reflectionClass, ApiResource::class), true];
  239. }
  240. }