vendor/can/rest/src/Can/RestBundle/EventListener/WantDigestListener.php line 39

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\EventListener;
  5. use Can\RestBundle\CanRestBundle;
  6. use Can\RestBundle\Negotiation\NegotiationConfiguration;
  7. use Can\RestBundle\Negotiation\NegotiationHeader;
  8. use Can\RestBundle\Negotiation\StopNegotiationException;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Component\HttpFoundation\Response;
  12. use Symfony\Component\HttpKernel\Event\RequestEvent;
  13. use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
  14. use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
  16. /**
  17.  * Performs the instance digest negotiation.
  18.  *
  19.  * This is supposed to be performed after actual content negotiation takes
  20.  * place, so if an error occurs, the error response may be generated in the
  21.  * appropriate format, if necessary.
  22.  *
  23.  * @group negotiation
  24.  *
  25.  * @package can/rest-bundle
  26.  * @author lechecacharro <lechecacharro@gmail.com>
  27.  */
  28. class WantDigestListener extends NegotiationListener
  29. {
  31.     /**
  32.      * Performs the instance digest negotiation.
  33.      *
  34.      * @param RequestEvent $event
  35.      *
  36.      * @throws NotAcceptableHttpException
  37.      * @throws UnprocessableEntityHttpException
  38.      */
  39.     public function onRequest(RequestEvent $event): void
  40.     {
  41.         if (! $this->configuration->isAcceptInstanceDigests()) {
  42.             return;
  43.         }
  45.         if (! $event->isMasterRequest()) {
  46.             return;
  47.         }
  49.         $request = $event->getRequest();
  51.         if (! $request->attributes->get(CanRestBundle::ATTR_SERVICE_ZONE)) {
  52.             return;
  53.         }
  55.         $wantDigest = $this->getWantDigest($request);
  57.         if (! $wantDigest) {
  58.             return;
  59.         }
  61.         $digest = null;
  63.         try {
  64.             $digest = $this->negotiate($this->provider->getDigestNegotiator(), $wantDigest);
  65.         } catch (StopNegotiationException $e) {
  66.             // Failthrough
  67.         }
  69.         if (null === $digest) {
  70.             if ($this->configuration->isStrictDigestPolicy()) {
  71.                 $event->setResponse($this->createDigestClientErrorResponse());
  72.             } else {
  73.                 // Just choose an arbitrary ingest algorithm and continue --
  74.                 // currently we choose the one that requires less effort to
  75.                 // the server
  76.                 $digest = $this->selectArbitraryDigest();
  77.             }
  78.         }
  80.         $request->attributes->set(CanRestBundle::ATTR_NEGOTIATION_DIGEST, $digest);
  81.     }
  84.     /**
  85.      * @param Request $request
  86.      *
  87.      * @return string | null
  88.      */
  89.     private function getWantDigest(Request $request): ?string
  90.     {
  91.         return $this->getNegotiationHeader($request, NegotiationHeader::WANT_DIGEST);
  92.     }
  94.     /**
  95.      * @return Response
  96.      */
  97.     private function createDigestClientErrorResponse(): Response
  98.     {
  99.         $response = new Response('', $this->configuration->getDigestClientErrorStatus());
  100.         $response->headers->set(NegotiationHeader::WANT_DIGEST, implode(', ', $this->configuration->getDigests()));
  102.         return $response;
  103.     }
  105.     /**
  106.      * Note that it is safe to assume that the list of digests algorithm names
  107.      * is not empty, as the {@link NegotiationConfiguration::isAcceptInstanceDigests()}
  108.      * method has already been called.
  109.      *
  110.      * @return string
  111.      */
  112.     private function selectArbitraryDigest(): string
  113.     {
  114.         // FIXME
  115.         // Use a priority list; do not choose at random
  116.         return $this->configuration->getDigests()[0];
  117.     }
  119. }