local/modules/Front/Controller/FeedController.php line 58

  1. <?php
  3. /*
  4.  * This file is part of the Thelia package.
  5.  * http://www.thelia.net
  6.  *
  7.  * (c) OpenStudio <info@thelia.net>
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Front\Controller;
  15. use Symfony\Component\Cache\Adapter\AdapterInterface;
  16. use Thelia\Controller\Front\BaseFrontController;
  17. use Thelia\Core\HttpFoundation\Request;
  18. use Thelia\Core\HttpFoundation\Response;
  19. use Thelia\Model\BrandQuery;
  20. use Thelia\Model\CategoryQuery;
  21. use Thelia\Model\ConfigQuery;
  22. use Thelia\Model\FolderQuery;
  23. use Thelia\Model\Lang;
  24. use Thelia\Model\LangQuery;
  26. /**
  27.  * Controller uses to generate RSS Feeds.
  28.  *
  29.  * A default cache of 2 hours is used to avoid attack. You can flush cache if you have `ADMIN` role and pass flush=1 in
  30.  * query string parameter.
  31.  *
  32.  * @author Julien Chanséaume <jchanseaume@openstudio.fr>
  33.  */
  34. class FeedController extends BaseFrontController
  35. {
  36.     /**
  37.      * Folder name for feeds cache.
  38.      */
  39.     public const FEED_CACHE_DIR = 'feeds';
  41.     /**
  42.      * Key prefix for feed cache.
  43.      */
  44.     public const FEED_CACHE_KEY = 'feed';
  46.     /**
  47.      * render the RSS feed.
  48.      *
  49.      * @param $context string   The context of the feed : catalog, content. default: catalog
  50.      * @param $lang string      The lang of the feed : fr_FR, en_US, ... default: default language of the site
  51.      * @param $id string        The id of the parent element. The id of the main parent category for catalog context.
  52.      *                          The id of the content folder for content context
  53.      *
  54.      * @throws \RuntimeException
  55.      *
  56.      * @return Response
  57.      */
  58.     public function generateAction($context, $lang, $id)
  59.     {
  60.         /** @var Request $request */
  61.         $request = $this->getRequest();
  63.         // context
  64.         if ('' === $context) {
  65.             $context = 'catalog';
  66.         } elseif (!\in_array($context, ['catalog', 'content', 'brand'])) {
  67.             $this->pageNotFound();
  68.         }
  70.         // the locale : fr_FR, en_US,
  71.         if ('' !== $lang) {
  72.             if (!$this->checkLang($lang)) {
  73.                 $this->pageNotFound();
  74.             }
  75.         } else {
  76.             try {
  77.                 $lang = Lang::getDefaultLanguage();
  78.                 $lang = $lang->getLocale();
  79.             } catch (\RuntimeException $ex) {
  80.                 // @todo generate error page
  81.                 throw new \RuntimeException('No default language is defined. Please define one.');
  82.             }
  83.         }
  84.         if (null === $lang = LangQuery::create()->findOneByLocale($lang)) {
  85.             $this->pageNotFound();
  86.         }
  87.         $lang = $lang->getId();
  89.         // check if element exists and is visible
  90.         if ('' !== $id) {
  91.             if (false === $this->checkId($context, $id)) {
  92.                 $this->pageNotFound();
  93.             }
  94.         }
  96.         $flush = $request->query->get('flush', '');
  98.         /** @var AdapterInterface $cacheAdapter */
  99.         $cacheAdapter = $this->container->get('thelia.cache');
  101.         $cacheKey = self::FEED_CACHE_KEY.$lang.$context;
  103.         $cacheItem = $cacheAdapter->getItem($cacheKey);
  105.         if (!$cacheItem->isHit() || $flush) {
  106.             $cacheExpire = (int) (ConfigQuery::read('feed_ttl', '7200')) ?: 7200;
  108.             // render the view
  109.             $cacheContent = $this->renderRaw(
  110.                 'feed',
  111.                 [
  112.                     '_context_' => $context,
  113.                     '_lang_' => $lang,
  114.                     '_id_' => $id,
  115.                 ]
  116.             );
  118.             $cacheItem->expiresAfter($cacheExpire);
  119.             $cacheItem->set($cacheContent);
  120.             $cacheAdapter->save($cacheItem);
  121.         }
  123.         $response = new Response();
  124.         $response->setContent($cacheItem->get());
  125.         $response->headers->set('Content-Type', 'application/rss+xml');
  127.         return $response;
  128.     }
  130.     /**
  131.      * get the cache directory for feeds.
  132.      *
  133.      * @return mixed|string
  134.      */
  135.     protected function getCacheDir()
  136.     {
  137.         $cacheDir = $this->container->getParameter('kernel.cache_dir');
  138.         $cacheDir = rtrim($cacheDir, '/');
  139.         $cacheDir .= '/'.self::FEED_CACHE_DIR.'/';
  141.         return $cacheDir;
  142.     }
  144.     /**
  145.      * Check if current user has ADMIN role.
  146.      *
  147.      * @return bool
  148.      */
  149.     protected function checkAdmin()
  150.     {
  151.         return $this->getSecurityContext()->hasAdminUser();
  152.     }
  154.     /**
  155.      * Check if a lang is used.
  156.      *
  157.      * @param $lang string  The lang code. e.g.: fr
  158.      *
  159.      * @return bool true if the language is used, otherwise false
  160.      */
  161.     private function checkLang($lang)
  162.     {
  163.         // load locals
  164.         $lang = LangQuery::create()
  165.             ->findOneByLocale($lang);
  167.         return null !== $lang;
  168.     }
  170.     /**
  171.      * Check if the element exists and is visible.
  172.      *
  173.      * @param $context string   catalog or content
  174.      * @param $id string        id of the element
  175.      *
  176.      * @return bool
  177.      */
  178.     private function checkId($context, $id)
  179.     {
  180.         $ret = false;
  181.         if (is_numeric($id)) {
  182.             if ('catalog' === $context) {
  183.                 $cat = CategoryQuery::create()->findPk($id);
  184.                 $ret = (null !== $cat && $cat->getVisible());
  185.             } elseif ('brand' === $context) {
  186.                 $brand = BrandQuery::create()->findPk($id);
  187.                 $ret = (null !== $brand && $brand->getVisible());
  188.             } else {
  189.                 $folder = FolderQuery::create()->findPk($id);
  190.                 $ret = (null !== $folder && $folder->getVisible());
  191.             }
  192.         }
  194.         return $ret;
  195.     }
  196. }