vendor/shopware/administration/Controller/NotificationController.php line 98

Open in your IDE?
  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\Routing\Annotation\Acl;
  14. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  15. use Shopware\Core\Framework\Routing\Annotation\Since;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  18. use Symfony\Component\HttpFoundation\JsonResponse;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpFoundation\Response;
  21. use Symfony\Component\Routing\Annotation\Route;
  23. /**
  24.  * @Route(defaults={"_routeScope"={"api"}})
  25.  */
  26. #[Package('administration')]
  27. class NotificationController extends AbstractController
  28. {
  29.     public const NOTIFICATION = 'notification';
  31.     public const LIMIT = 5;
  33.     private RateLimiter $rateLimiter;
  35.     private NotificationService $notificationService;
  37.     /**
  38.      * @internal
  39.      */
  40.     public function __construct(RateLimiter $rateLimiter, NotificationService $notificationService)
  41.     {
  42.         $this->rateLimiter = $rateLimiter;
  43.         $this->notificationService = $notificationService;
  44.     }
  46.     /**
  47.      * @Since("6.4.7.0")
  48.      * @Route("/api/notification", name="api.notification", methods={"POST"}, defaults={"_acl"={"notification:create"}})
  49.      */
  50.     public function saveNotification(Request $request, Context $context): Response
  51.     {
  52.         $status = $request->request->get('status');
  53.         $message = $request->request->get('message');
  54.         $adminOnly = (bool) $request->request->get('adminOnly', false);
  55.         $requiredPrivileges = $request->request->all('requiredPrivileges');
  57.         $source = $context->getSource();
  58.         if (!$source instanceof AdminApiSource) {
  59.             throw new InvalidContextSourceException(AdminApiSource::class, \get_class($context->getSource()));
  60.         }
  62.         if (empty($status) || empty($message)) {
  63.             throw new \InvalidArgumentException('status and message cannot be empty');
  64.         }
  66.         if (!\is_array($requiredPrivileges)) {
  67.             throw new \InvalidArgumentException('requiredPrivileges must be an array');
  68.         }
  70.         $integrationId = $source->getIntegrationId();
  71.         $createdByUserId = $source->getUserId();
  73.         try {
  74.             $cacheKey = $createdByUserId ?? $integrationId . '-' . $request->getClientIp();
  75.             $this->rateLimiter->ensureAccepted(self::NOTIFICATION, $cacheKey);
  76.         } catch (RateLimitExceededException $exception) {
  77.             throw new NotificationThrottledException($exception->getWaitTime(), $exception);
  78.         }
  80.         $notificationId = Uuid::randomHex();
  81.         $this->notificationService->createNotification([
  82.             'id' => $notificationId,
  83.             'status' => $status,
  84.             'message' => $message,
  85.             'adminOnly' => $adminOnly,
  86.             'requiredPrivileges' => $requiredPrivileges,
  87.             'createdByIntegrationId' => $integrationId,
  88.             'createdByUserId' => $createdByUserId,
  89.         ], $context);
  91.         return new JsonResponse(['id' => $notificationId]);
  92.     }
  94.     /**
  95.      * @Since("6.4.7.0")
  96.      * @Route("/api/notification/message", name="api.notification.message", methods={"GET"})
  97.      */
  98.     public function fetchNotification(Request $request, Context $context): Response
  99.     {
  100.         $limit = $request->query->get('limit');
  101.         $limit = $limit ? (int) $limit : self::LIMIT;
  102.         $latestTimestamp = $request->query->has('latestTimestamp') ? (string) $request->query->get('latestTimestamp') : null;
  104.         $responseData = $this->notificationService->getNotifications($context, $limit, $latestTimestamp);
  106.         return new JsonResponse($responseData);
  107.     }
  108. }