local/modules/Front/Controller/SitemapController.php line 52

  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\ConfigQuery;
  20. use Thelia\Model\LangQuery;
  22. /**
  23.  * Controller uses to generate sitemap.xml.
  24.  *
  25.  * 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
  26.  * query string parameter.
  27.  *
  28.  * You can generate sitemap according to specific language and/or specific context (catalog/content). You have to
  29.  * use ```lang``` and ```context``` query string parameters to do so. If a language is not used in website or if the
  30.  * context is not supported the page not found is displayed.
  31.  *
  32.  * {url}/sitemap?lang=fr&context=catalog will generate a sitemap for catalog (categories and products)
  33.  * for french language.
  34.  *
  35.  * @author Julien Chanséaume <jchanseaume@openstudio.fr>
  36.  */
  37. class SitemapController extends BaseFrontController
  38. {
  39.     /**
  40.      * Folder name for sitemap cache.
  41.      */
  42.     public const SITEMAP_CACHE_DIR = 'sitemap';
  44.     /**
  45.      * Key prefix for sitemap cache.
  46.      */
  47.     public const SITEMAP_CACHE_KEY = 'sitemap';
  49.     /**
  50.      * @return Response
  51.      */
  52.     public function generateAction()
  53.     {
  54.         /** @var Request $request */
  55.         $request = $this->getRequest();
  57.         // the locale : fr, en,
  58.         $lang = $request->query->get('lang', '');
  59.         if ('' !== $lang) {
  60.             if (!$this->checkLang($lang)) {
  61.                 $this->pageNotFound();
  62.             }
  63.         }
  65.         // specific content : product, category, cms
  66.         $context = $request->query->get('context', '');
  67.         if (!\in_array($context, ['', 'catalog', 'content'])) {
  68.             $this->pageNotFound();
  69.         }
  71.         $flush = $request->query->get('flush', '');
  73.         /** @var AdapterInterface $cacheAdapter */
  74.         $cacheAdapter = $this->container->get('thelia.cache');
  76.         $cacheKey = self::SITEMAP_CACHE_KEY.$lang.$context;
  78.         $cacheItem = $cacheAdapter->getItem($cacheKey);
  80.         if (!$cacheItem->isHit() || $flush) {
  81.             $cacheExpire = (int) (ConfigQuery::read('sitemap_ttl', '7200')) ?: 7200;
  83.             // Render the view. Compression causes problems and is deactivated.
  84.             $cacheContent = $this->getParser(null)->render(
  85.                 'sitemap.html',
  86.                 [
  87.                     '_lang_' => $lang,
  88.                     '_context_' => $context,
  89.                 ],
  90.                 false
  91.             );
  93.             $cacheItem->expiresAfter($cacheExpire);
  94.             $cacheItem->set($cacheContent);
  95.             $cacheAdapter->save($cacheItem);
  96.         }
  98.         $response = new Response();
  99.         $response->setContent($cacheItem->get());
  100.         $response->headers->set('Content-Type', 'application/xml');
  102.         return $response;
  103.     }
  105.     /**
  106.      * get the cache directory for sitemap.
  107.      *
  108.      * @return mixed|string
  109.      */
  110.     protected function getCacheDir()
  111.     {
  112.         $cacheDir = $this->container->getParameter('kernel.cache_dir');
  113.         $cacheDir = rtrim($cacheDir, '/');
  114.         $cacheDir .= '/'.self::SITEMAP_CACHE_DIR.'/';
  116.         return $cacheDir;
  117.     }
  119.     /**
  120.      * Check if current user has ADMIN role.
  121.      *
  122.      * @return bool
  123.      */
  124.     protected function checkAdmin()
  125.     {
  126.         return $this->getSecurityContext()->hasAdminUser();
  127.     }
  129.     /**
  130.      * Check if a lang is used.
  131.      *
  132.      * @param $lang The lang code. e.g.: fr
  133.      *
  134.      * @return bool true if the language is used, otherwise false
  135.      */
  136.     private function checkLang($lang)
  137.     {
  138.         // load locals
  139.         $lang = LangQuery::create()
  140.             ->findOneByCode($lang);
  142.         return null !== $lang;
  143.     }
  144. }