src/Core/Framework/Api/Controller/InfoController.php line 59

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Api\Controller;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Flow\Api\FlowActionCollector;
  7. use Shopware\Core\Framework\Api\ApiDefinition\DefinitionService;
  8. use Shopware\Core\Framework\Api\ApiDefinition\Generator\EntitySchemaGenerator;
  9. use Shopware\Core\Framework\Api\ApiDefinition\Generator\OpenApi3Generator;
  10. use Shopware\Core\Framework\Bundle;
  11. use Shopware\Core\Framework\Context;
  12. use Shopware\Core\Framework\Event\BusinessEventCollector;
  13. use Shopware\Core\Framework\Increment\Exception\IncrementGatewayNotFoundException;
  14. use Shopware\Core\Framework\Increment\IncrementGatewayRegistry;
  15. use Shopware\Core\Framework\Log\Package;
  16. use Shopware\Core\Framework\Plugin;
  17. use Shopware\Core\Framework\Routing\Exception\InvalidRequestParameterException;
  18. use Shopware\Core\Kernel;
  19. use Shopware\Core\Maintenance\System\Service\AppUrlVerifier;
  20. use Shopware\Core\PlatformRequest;
  21. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  22. use Symfony\Component\Asset\PackageInterface;
  23. use Symfony\Component\Asset\Packages;
  24. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
  25. use Symfony\Component\HttpFoundation\JsonResponse;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\Routing\Annotation\Route;
  30. #[Route(defaults: ['_routeScope' => ['api']])]
  31. #[Package('core')]
  32. class InfoController extends AbstractController
  33. {
  34.     /**
  35.      * @param array{administration?: string} $cspTemplates
  36.      *
  37.      * @internal
  38.      */
  39.     public function __construct(private readonly DefinitionService $definitionService, private readonly ParameterBagInterface $params, private readonly Kernel $kernel, private readonly Packages $packages, private readonly BusinessEventCollector $eventCollector, private readonly IncrementGatewayRegistry $incrementGatewayRegistry, private readonly Connection $connection, private readonly AppUrlVerifier $appUrlVerifier, private readonly ?FlowActionCollector $flowActionCollector = null, private readonly bool $enableUrlFeature = true, private readonly array $cspTemplates = [])
  40.     {
  41.     }
  43.     #[Route(path: '/api/_info/openapi3.json', defaults: ['auth_required' => '%shopware.api.api_browser.auth_required_str%'], name: 'api.info.openapi3', methods: ['GET'])]
  44.     public function info(Request $request): JsonResponse
  45.     {
  46.         $apiType = $request->query->getAlpha('type', DefinitionService::TypeJsonApi);
  48.         $apiType = $this->definitionService->toApiType($apiType);
  49.         if ($apiType === null) {
  50.             throw new InvalidRequestParameterException('type');
  51.         }
  53.         $data = $this->definitionService->generate(OpenApi3Generator::FORMAT, DefinitionService::API, $apiType);
  55.         return new JsonResponse($data);
  56.     }
  58.     #[Route(path: '/api/_info/queue.json', name: 'api.info.queue', methods: ['GET'])]
  59.     public function queue(): JsonResponse
  60.     {
  61.         try {
  62.             $gateway = $this->incrementGatewayRegistry->get(IncrementGatewayRegistry::MESSAGE_QUEUE_POOL);
  63.         } catch (IncrementGatewayNotFoundException) {
  64.             // In case message_queue pool is disabled
  65.             return new JsonResponse([]);
  66.         }
  68.         // Fetch unlimited message_queue_stats
  69.         $entries = $gateway->list('message_queue_stats', -1);
  71.         return new JsonResponse(array_map(fn (array $entry) => [
  72.             'name' => $entry['key'],
  73.             'size' => (int) $entry['count'],
  74.         ], array_values($entries)));
  75.     }
  77.     #[Route(path: '/api/_info/open-api-schema.json', defaults: ['auth_required' => '%shopware.api.api_browser.auth_required_str%'], name: 'api.info.open-api-schema', methods: ['GET'])]
  78.     public function openApiSchema(): JsonResponse
  79.     {
  80.         $data = $this->definitionService->getSchema(OpenApi3Generator::FORMAT, DefinitionService::API);
  82.         return new JsonResponse($data);
  83.     }
  85.     #[Route(path: '/api/_info/entity-schema.json', name: 'api.info.entity-schema', methods: ['GET'])]
  86.     public function entitySchema(): JsonResponse
  87.     {
  88.         $data = $this->definitionService->getSchema(EntitySchemaGenerator::FORMAT, DefinitionService::API);
  90.         return new JsonResponse($data);
  91.     }
  93.     #[Route(path: '/api/_info/events.json', name: 'api.info.business-events', methods: ['GET'])]
  94.     public function businessEvents(Context $context): JsonResponse
  95.     {
  96.         $events = $this->eventCollector->collect($context);
  98.         return new JsonResponse($events);
  99.     }
  101.     #[Route(path: '/api/_info/swagger.html', defaults: ['auth_required' => '%shopware.api.api_browser.auth_required_str%'], name: 'api.info.swagger', methods: ['GET'])]
  102.     public function infoHtml(Request $request): Response
  103.     {
  104.         $nonce = $request->attributes->get(PlatformRequest::ATTRIBUTE_CSP_NONCE);
  105.         $apiType = $request->query->getAlpha('type', DefinitionService::TypeJson);
  106.         $response = $this->render(
  107.             '@Framework/swagger.html.twig',
  108.             [
  109.                 'schemaUrl' => 'api.info.openapi3',
  110.                 'cspNonce' => $nonce,
  111.                 'apiType' => $apiType,
  112.             ]
  113.         );
  115.         $cspTemplate = $this->cspTemplates['administration'] ?? '';
  116.         $cspTemplate = trim($cspTemplate);
  117.         if ($cspTemplate !== '') {
  118.             $csp = str_replace('%nonce%', $nonce, $cspTemplate);
  119.             $csp = str_replace(["\n", "\r"], ' ', $csp);
  120.             $response->headers->set('Content-Security-Policy', $csp);
  121.         }
  123.         return $response;
  124.     }
  126.     #[Route(path: '/api/_info/config', name: 'api.info.config', methods: ['GET'])]
  127.     public function config(Context $context, Request $request): JsonResponse
  128.     {
  129.         return new JsonResponse([
  130.             'version' => $this->params->get('kernel.shopware_version'),
  131.             'versionRevision' => $this->params->get('kernel.shopware_version_revision'),
  132.             'adminWorker' => [
  133.                 'enableAdminWorker' => $this->params->get('shopware.admin_worker.enable_admin_worker'),
  134.                 'enableQueueStatsWorker' => $this->params->get('shopware.admin_worker.enable_queue_stats_worker'),
  135.                 'enableNotificationWorker' => $this->params->get('shopware.admin_worker.enable_notification_worker'),
  136.                 'transports' => $this->params->get('shopware.admin_worker.transports'),
  137.             ],
  138.             'bundles' => $this->getBundles($context),
  139.             'settings' => [
  140.                 'enableUrlFeature' => $this->enableUrlFeature,
  141.                 'appUrlReachable' => $this->appUrlVerifier->isAppUrlReachable($request),
  142.                 'appsRequireAppUrl' => $this->appUrlVerifier->hasAppsThatNeedAppUrl(),
  143.                 'private_allowed_extensions' => $this->params->get('shopware.filesystem.private_allowed_extensions'),
  144.             ],
  145.         ]);
  146.     }
  148.     #[Route(path: '/api/_info/version', name: 'api.info.shopware.version', methods: ['GET'])]
  149.     #[Route(path: '/api/v1/_info/version', name: 'api.info.shopware.version_old_version', methods: ['GET'])]
  150.     public function infoShopwareVersion(): JsonResponse
  151.     {
  152.         return new JsonResponse([
  153.             'version' => $this->params->get('kernel.shopware_version'),
  154.         ]);
  155.     }
  157.     #[Route(path: '/api/_info/flow-actions.json', name: 'api.info.actions', methods: ['GET'])]
  158.     public function flowActions(Context $context): JsonResponse
  159.     {
  160.         if (!$this->flowActionCollector) {
  161.             return $this->json([]);
  162.         }
  164.         $events = $this->flowActionCollector->collect($context);
  166.         return new JsonResponse($events);
  167.     }
  169.     /**
  170.      * @return array<string, array{type: 'plugin', css: string[], js: string[], baseUrl: ?string }|array{type: 'app', name: string, active: bool, integrationId: string, baseUrl: string, version: string, permissions: array<string,string[]>}>
  171.      */
  172.     private function getBundles(Context $context): array
  173.     {
  174.         $assets = [];
  175.         $package = $this->packages->getPackage('asset');
  177.         foreach ($this->kernel->getBundles() as $bundle) {
  178.             if (!$bundle instanceof Bundle) {
  179.                 continue;
  180.             }
  182.             $bundleDirectoryName = preg_replace('/bundle$/', '', mb_strtolower($bundle->getName()));
  183.             if ($bundleDirectoryName === null) {
  184.                 throw new \RuntimeException(sprintf('Unable to generate bundle directory for bundle "%s"', $bundle->getName()));
  185.             }
  187.             $styles = array_map(static function (string $filename) use ($package, $bundleDirectoryName) {
  188.                 $url = 'bundles/' . $bundleDirectoryName . '/' . $filename;
  190.                 return $package->getUrl($url);
  191.             }, $this->getAdministrationStyles($bundle));
  193.             $scripts = array_map(static function (string $filename) use ($package, $bundleDirectoryName) {
  194.                 $url = 'bundles/' . $bundleDirectoryName . '/' . $filename;
  196.                 return $package->getUrl($url);
  197.             }, $this->getAdministrationScripts($bundle));
  199.             $baseUrl = $this->getBaseUrl($bundle, $package, $bundleDirectoryName);
  201.             if (empty($styles) && empty($scripts)) {
  202.                 if ($baseUrl === null) {
  203.                     continue;
  204.                 }
  205.             }
  207.             $assets[$bundle->getName()] = [
  208.                 'css' => $styles,
  209.                 'js' => $scripts,
  210.                 'baseUrl' => $baseUrl,
  211.                 'type' => 'plugin',
  212.             ];
  213.         }
  215.         foreach ($this->getActiveApps() as $app) {
  216.             $assets[$app['name']] = [
  217.                 'active' => (bool) $app['active'],
  218.                 'integrationId' => $app['integrationId'],
  219.                 'type' => 'app',
  220.                 'baseUrl' => $app['baseUrl'],
  221.                 'permissions' => $app['privileges'],
  222.                 'version' => $app['version'],
  223.                 'name' => $app['name'],
  224.             ];
  225.         }
  227.         return $assets;
  228.     }
  230.     /**
  231.      * @return list<string>
  232.      */
  233.     private function getAdministrationStyles(Bundle $bundle): array
  234.     {
  235.         $path = 'administration/css/' . str_replace('_', '-', (string) $bundle->getContainerPrefix()) . '.css';
  236.         $bundlePath = $bundle->getPath();
  238.         if (!file_exists($bundlePath . '/Resources/public/' . $path)) {
  239.             return [];
  240.         }
  242.         return [$path];
  243.     }
  245.     /**
  246.      * @return list<string>
  247.      */
  248.     private function getAdministrationScripts(Bundle $bundle): array
  249.     {
  250.         $path = 'administration/js/' . str_replace('_', '-', (string) $bundle->getContainerPrefix()) . '.js';
  251.         $bundlePath = $bundle->getPath();
  253.         if (!file_exists($bundlePath . '/Resources/public/' . $path)) {
  254.             return [];
  255.         }
  257.         return [$path];
  258.     }
  260.     private function getBaseUrl(Bundle $bundle, PackageInterface $package, string $bundleDirectoryName): ?string
  261.     {
  262.         if (!$bundle instanceof Plugin) {
  263.             return null;
  264.         }
  266.         if ($bundle->getAdminBaseUrl()) {
  267.             return $bundle->getAdminBaseUrl();
  268.         }
  270.         $defaultEntryFile = 'administration/index.html';
  271.         $bundlePath = $bundle->getPath();
  273.         if (!file_exists($bundlePath . '/Resources/public/' . $defaultEntryFile)) {
  274.             return null;
  275.         }
  277.         $url = 'bundles/' . $bundleDirectoryName . '/' . $defaultEntryFile;
  279.         return $package->getUrl($url);
  280.     }
  282.     /**
  283.      * @return list<array{name: string, active: int, integrationId: string, baseUrl: string, version: string, privileges: array<string,list<string>>}>
  284.      */
  285.     private function getActiveApps(): array
  286.     {
  287.         /** @var list<array{name: string, active: int, integrationId: string, baseUrl: string, version: string, privileges: ?string}> $apps */
  288.         $apps = $this->connection->fetchAllAssociative('SELECT
  289.     app.name,
  290.     app.active,
  291.     LOWER(HEX(app.integration_id)) as integrationId,
  292.     app.base_app_url as baseUrl,
  293.     app.version,
  294.     ar.privileges as privileges
  295. FROM app
  296. LEFT JOIN acl_role ar on app.acl_role_id = ar.id
  297. WHERE app.active = 1 AND app.base_app_url is not null');
  299.         return array_map(static function (array $item) {
  300.             $privileges = $item['privileges'] ? json_decode((string) $item['privileges'], true, 512, \JSON_THROW_ON_ERROR) : [];
  302.             $item['privileges'] = [];
  304.             foreach ($privileges as $privilege) {
  305.                 if (substr_count($privilege, ':') !== 1) {
  306.                     $item['privileges']['additional'][] = $privilege;
  308.                     continue;
  309.                 }
  311.                 [$entity, $key] = \explode(':', $privilege);
  312.                 $item['privileges'][$key][] = $entity;
  313.             }
  315.             return $item;
  316.         }, $apps);
  317.     }
  318. }