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

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