src/Administration/Controller/NotificationController.php line 87

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Administration\Controller;
  5. use Shopware\Administration\Notification\Exception\NotificationThrottledException;
  6. use Shopware\Administration\Notification\NotificationService;
  7. use Shopware\Core\Framework\Api\Context\AdminApiSource;
  8. use Shopware\Core\Framework\Api\Context\Exception\InvalidContextSourceException;
  9. use Shopware\Core\Framework\Context;
  10. use Shopware\Core\Framework\Log\Package;
  11. use Shopware\Core\Framework\RateLimiter\Exception\RateLimitExceededException;
  12. use Shopware\Core\Framework\RateLimiter\RateLimiter;
  13. use Shopware\Core\Framework\Uuid\Uuid;
  14. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  15. use Symfony\Component\HttpFoundation\JsonResponse;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\Routing\Annotation\Route;
  20. #[Route(defaults: ['_routeScope' => ['api']])]
  21. #[Package('administration')]
  22. class NotificationController extends AbstractController
  23. {
  24.     final public const NOTIFICATION = 'notification';
  26.     final public const LIMIT = 5;
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(private readonly RateLimiter $rateLimiter, private readonly NotificationService $notificationService)
  32.     {
  33.     }
  35.     #[Route(path: '/api/notification', name: 'api.notification', defaults: ['_acl' => ['notification:create']], methods: ['POST'])]
  36.     public function saveNotification(Request $request, Context $context): Response
  37.     {
  38.         $status = $request->request->get('status');
  39.         $message = $request->request->get('message');
  40.         $adminOnly = (bool) $request->request->get('adminOnly', false);
  41.         $requiredPrivileges = $request->request->all('requiredPrivileges');
  43.         $source = $context->getSource();
  44.         if (!$source instanceof AdminApiSource) {
  45.             throw new InvalidContextSourceException(AdminApiSource::class, $context->getSource()::class);
  46.         }
  48.         if (empty($status) || empty($message)) {
  49.             throw new \InvalidArgumentException('status and message cannot be empty');
  50.         }
  52.         if (!\is_array($requiredPrivileges)) {
  53.             throw new \InvalidArgumentException('requiredPrivileges must be an array');
  54.         }
  56.         $integrationId = $source->getIntegrationId();
  57.         $createdByUserId = $source->getUserId();
  59.         try {
  60.             $cacheKey = $createdByUserId ?? $integrationId . '-' . $request->getClientIp();
  61.             $this->rateLimiter->ensureAccepted(self::NOTIFICATION, $cacheKey);
  62.         } catch (RateLimitExceededException $exception) {
  63.             throw new NotificationThrottledException($exception->getWaitTime(), $exception);
  64.         }
  66.         $notificationId = Uuid::randomHex();
  67.         $this->notificationService->createNotification([
  68.             'id' => $notificationId,
  69.             'status' => $status,
  70.             'message' => $message,
  71.             'adminOnly' => $adminOnly,
  72.             'requiredPrivileges' => $requiredPrivileges,
  73.             'createdByIntegrationId' => $integrationId,
  74.             'createdByUserId' => $createdByUserId,
  75.         ], $context);
  77.         return new JsonResponse(['id' => $notificationId]);
  78.     }
  80.     #[Route(path: '/api/notification/message', name: 'api.notification.message', methods: ['GET'])]
  81.     public function fetchNotification(Request $request, Context $context): Response
  82.     {
  83.         $limit = $request->query->get('limit');
  84.         $limit = $limit ? (int) $limit : self::LIMIT;
  85.         $latestTimestamp = $request->query->has('latestTimestamp') ? (string) $request->query->get('latestTimestamp') : null;
  87.         $responseData = $this->notificationService->getNotifications($context, $limit, $latestTimestamp);
  89.         return new JsonResponse($responseData);
  90.     }
  91. }