vendor/debril/rss-atom-bundle/Debril/RssAtomBundle/Controller/StreamController.php line 31

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Debril\RssAtomBundle\Controller;
  5. use FeedIo\FeedIo;
  6. use FeedIo\FeedInterface;
  7. use Symfony\Component\HttpFoundation\Response;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Bundle\FrameworkBundle\Controller\Controller;
  10. use Debril\RssAtomBundle\Provider\FeedContentProviderInterface;
  11. use Debril\RssAtomBundle\Exception\FeedException\FeedNotFoundException;
  13. /**
  14.  * Class StreamController.
  15.  */
  16. class StreamController extends Controller
  17. {
  19.     /**
  20.      * @var \DateTime
  21.      */
  22.     protected $since;
  24.     /**
  25.      * @param Request $request
  26.      * @param FeedContentProviderInterface $provider
  27.      * @param FeedIo $feedIo
  28.      * @return Response
  29.      * @throws \Exception
  30.      */
  31.     public function indexAction(Request $request, FeedContentProviderInterface $provider, FeedIo $feedIo) : Response
  32.     {
  33.         $options = $request->attributes->get('_route_params');
  34.         $this->setModifiedSince($request);
  35.         $options['Since'] = $this->getModifiedSince();
  37.         return $this->createStreamResponse(
  38.             $options,
  39.             $request->get('format', 'rss'),
  40.             $provider,
  41.             $feedIo
  42.         );
  43.     }
  45.     /**
  46.      * Extract the 'If-Modified-Since' value from the headers.
  47.      *
  48.      * @return \DateTime
  49.      */
  50.     protected function getModifiedSince() : \DateTime
  51.     {
  52.         if (is_null($this->since)) {
  53.             $this->since = new \DateTime('@0');
  54.         }
  56.         return $this->since;
  57.     }
  59.     /**
  60.      * @param Request $request
  61.      *
  62.      * @return $this
  63.      */
  64.     protected function setModifiedSince(Request $request) : self
  65.     {
  66.         $this->since = new \DateTime();
  67.         if ($request->headers->has('If-Modified-Since')) {
  68.             $string = $request->headers->get('If-Modified-Since');
  69.             $this->since = \DateTime::createFromFormat(\DateTime::RSS, $string);
  70.         } else {
  71.             $this->since->setTimestamp(1);
  72.         }
  74.         return $this;
  75.     }
  77.     /**
  78.      * Generate the HTTP response
  79.      * 200 : a full body containing the stream
  80.      * 304 : Not modified.
  81.      *
  82.      * @param array $options
  83.      * @param $format
  84.      * @param FeedContentProviderInterface $provider
  85.      * @param FeedIo $feedIo
  86.      *
  87.      * @return Response
  88.      *
  89.      * @throws \Exception
  90.      */
  91.     protected function createStreamResponse(array $options, string $format, FeedContentProviderInterface $provider, FeedIo $feedIo) : Response
  92.     {
  93.         $content = $this->getContent($options, $provider);
  95.         if ($this->mustForceRefresh() || $content->getLastModified() > $this->getModifiedSince()) {
  96.             $response = new Response($feedIo->format($content, $format));
  97.             $this->setFeedHeaders($response, $content, $format);
  99.         } else {
  100.             $response = new Response();
  101.             $response->setNotModified();
  102.         }
  104.         return $response;
  105.     }
  107.     /**
  108.      * @param Response $response
  109.      * @param FeedInterface $feed
  110.      * @param string $format
  111.      * @return $this
  112.      */
  113.     protected function setFeedHeaders(Response $response, FeedInterface $feed, string $format) : self
  114.     {
  115.         $contentType =
  116.             'json' == $format ?
  117.                 $this->getParameter('debril_rss_atom.content_type_json') :
  118.                 $this->getParameter('debril_rss_atom.content_type_xml')
  119.             ;
  120.         $response->headers->set('Content-Type', $contentType);
  121.         if (! $this->isPrivate() ) {
  122.             $response->setPublic();
  123.         }
  125.         $response->setMaxAge(3600);
  126.         $response->setLastModified($feed->getLastModified());
  128.         return $this;
  129.     }
  131.     /**
  132.      * Get the Stream's content using a FeedContentProviderInterface
  133.      * The FeedContentProviderInterface instance is provided as a service
  134.      * default : debril.provider.service.
  135.      *
  136.      * @param array  $options
  137.      * @param FeedContentProviderInterface $provider
  138.      *
  139.      * @return FeedInterface
  140.      *
  141.      * @throws \Exception
  142.      */
  143.     protected function getContent(array $options, FeedContentProviderInterface $provider) : FeedInterface
  144.     {
  145.         try {
  146.             return $provider->getFeedContent($options);
  147.         } catch (FeedNotFoundException $e) {
  148.             throw $this->createNotFoundException('feed not found');
  149.         }
  150.     }
  152.     /**
  153.      * Returns true if the controller must ignore the last modified date.
  154.      *
  155.      * @return bool
  156.      */
  157.     protected function mustForceRefresh() : bool
  158.     {
  159.         return $this->container->getParameter('debril_rss_atom.force_refresh');
  160.     }
  162.     /**
  163.      * @return boolean true if the feed must be private
  164.      */
  165.     protected function isPrivate() : bool
  166.     {
  167.         return $this->container->getParameter('debril_rss_atom.private_feeds');
  168.     }
  170. }