TheCoreDev/sterivein
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reimplementing sitemap functionality using Thelia loop

Browse Source
This commit is contained in:
Julien Chanséaume
2014-04-29 17:14:44 +02:00
parent 9ee9a88156
commit d04ca672fb
4 changed files with 54 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
core/lib/Thelia/Model/Tools/SitemapURL.php
View File

@@ -1,120 +0,0 @@
<?php
/*************************************************************************************/
/* This file is part of the Thelia package. */
/* */
/* Copyright (c) OpenStudio */
/* email : dev@thelia.net */
/* web : http://www.thelia.net */
/* */
/* For the full copyright and license information, please view the LICENSE.txt */
/* file that was distributed with this source code. */
/*************************************************************************************/
namespace Thelia\Model\Tools;
/**
* Class SitemapURL
* @package Thelia\Model\Tools
* @author Julien Chanséaume <jchanseaume@openstudio.fr>
*/
class SitemapURL
{
/**
* URL of the page.
*
* @var string
*/
protected $loc = null;
/**
* The date of last modification of the file.
*
* @var string
*/
protected $lastmod = null;
/**
* How frequently the page is likely to change.
*
* @var string
*/
protected $changfreq = null;
/**
* The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0.
*
* @var float
*/
protected $priotity = null;
public function __construct($loc, $lastmod=null)
{
$this->loc = $loc;
$this->lastmod = $lastmod;
}
/**
* @param string $changfreq
*/
public function setChangfreq($changfreq)
{
$this->changfreq = $changfreq;
}
/**
* @return string
*/
public function getChangfreq()
{
return $this->changfreq;
}
/**
* @param string $lastmod
*/
public function setLastmod($lastmod)
{
$this->lastmod = $lastmod;
}
/**
* @return string
*/
public function getLastmod()
{
return $this->lastmod;
}
/**
* @param string $loc
*/
public function setLoc($loc)
{
$this->loc = $loc;
}
/**
* @return string
*/
public function getLoc()
{
return $this->loc;
}
/**
* @param float $priotity
*/
public function setPriotity($priotity)
{
$this->priotity = $priotity;
}
/**
* @return float
*/
public function getPriotity()
{
return $this->priotity;
}
}

58
core/lib/Thelia/Tools/SitemapURLNormalizer.php
View File

@@ -1,58 +0,0 @@
<?php
/*************************************************************************************/
/* This file is part of the Thelia package. */
/* */
/* Copyright (c) OpenStudio */
/* email : dev@thelia.net */
/* web : http://www.thelia.net */
/* */
/* For the full copyright and license information, please view the LICENSE.txt */
/* file that was distributed with this source code. */
/*************************************************************************************/
namespace Thelia\Tools;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\SerializerAwareNormalizer;
use Thelia\Model\Tools\SitemapURL;
/**
* Class SitemapURLNormalizer
* @package Thelia\Tools
* @author Julien Chanséaume <jchanseaume@openstudio.fr>
*/
class SitemapURLNormalizer extends SerializerAwareNormalizer implements NormalizerInterface
{
public function normalize($object, $format = null, array $context = array())
{
$normalizeSitemapURL = array(
'loc' => $this->urlEncode($object->getLoc())
);
if (null !== $object->getLastmod()) {
$normalizeSitemapURL['lastmod'] = $object->getLastmod();
}
if (null !== $object->getChangfreq()) {
$normalizeSitemapURL['changfreq'] = $object->getChangfreq();
}
if (null !== $object->getPriotity()) {
$normalizeSitemapURL['priority'] = $object->getPriotity();
}
return $normalizeSitemapURL;
}
protected function urlEncode($url)
{
return str_replace(array('&', '"', '\'', '<', '>'), array('&amp;', '&apos;', '&quot;', '&gt;', '&lt;'), $url);
}
// public function denormalize($data, $class, $format = null) {}
public function supportsNormalization($data, $format = null)
{
return $data instanceof SitemapURL;
}
public function supportsDenormalization($data, $type, $format = null)
{
return false;
}
}

212
local/modules/Front/Controller/SitemapController.php
View File

@@ -13,28 +13,13 @@
namespace Front\Controller; namespace Front\Controller;
use Propel\Runtime\ActiveQuery\Criteria;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Serializer;
use Thelia\Controller\Front\BaseFrontController; use Thelia\Controller\Front\BaseFrontController;
use Thelia\Core\HttpFoundation\Request; use Thelia\Core\HttpFoundation\Request;
use Thelia\Core\HttpFoundation\Response; use Thelia\Core\HttpFoundation\Response;
use Thelia\Log\Tlog; use Thelia\Log\Tlog;
use Thelia\Model\CategoryQuery;
use Thelia\Model\Category;
use Thelia\Model\ConfigQuery; use Thelia\Model\ConfigQuery;
use Thelia\Model\Content;
use Thelia\Model\ContentQuery;
use Thelia\Model\Folder;
use Thelia\Model\FolderQuery;
use Thelia\Model\LangQuery; use Thelia\Model\LangQuery;
use Thelia\Model\Lang; use Thelia\Model\Lang;
use Thelia\Model\Product;
use Thelia\Model\ProductQuery;
use Thelia\Model\Tools\SitemapURL;
use Thelia\Tools\SitemapURLNormalizer;
use Thelia\Tools\URL;
/** /**
@@ -51,46 +36,9 @@ class SitemapController extends BaseFrontController {
const SITEMAP_DIR = "sitemap"; const SITEMAP_DIR = "sitemap";
/** /**
* String array of active locals : fr_FR, en_US, ... * Folder name for sitemap cache
*
* @var array
*/ */
protected $locales = array(); const SITEMAP_FILE = "sitemap";
/**
* Array of ` Thelia\Model\Tools\SitemapURL` object for categories
*
* @var array
*/
protected $categoryUrls = array();
/**
* Array of ` Thelia\Model\Tools\SitemapURL` object for products
*
* @var array
*/
protected $productUrls = array();
/**
* Array of ` Thelia\Model\Tools\SitemapURL` object for folders
*
* @var array
*/
protected $folderUrls = array();
/**
* Array of ` Thelia\Model\Tools\SitemapURL` object for contents
*
* @var array
*/
protected $contentUrls = array();
/**
* Array of ` Thelia\Model\Tools\SitemapURL` object for static contents
*
* @var array
*/
protected $staticUrls = array();
/** /**
* @return Response * @return Response
@@ -101,33 +49,16 @@ class SitemapController extends BaseFrontController {
// check if already cached // check if already cached
/** @var Request $request */ /** @var Request $request */
$request = $this->getRequest(); $request = $this->getRequest();
$locale = $request->query->get("locale");
// todo: implement contextual sitemap : product, category, cms
$context = $request->query->get("context", ""); $context = $request->query->get("context", "");
$flush = $request->query->get("flush", ""); $flush = $request->query->get("flush", "");
$expire = ConfigQuery::read("sitemap_ttl", '7200'); $expire = ConfigQuery::read("sitemap_ttl", '7200');
// load locals
$langs = LangQuery::create()->find();
/** @var Lang $lang */
foreach ($langs AS $lang){
if (null !== $locale) {
if ($locale === $lang->getLocale()){
$this->locales[] = $lang->getLocale();
break;
}
}
else {
$this->locales[] = $lang->getLocale();
}
}
// check if sitemap already in cache // check if sitemap already in cache
$cacheDir = $this->getCacheDir(); $cacheDir = $this->getCacheDir();
$sitemapHash = md5("sitemap." . implode($this->locales) . "." . $context); $cacheFileURL = $cacheDir . self::SITEMAP_FILE . '.xml';
$expire = intval($expire) ?: 7200; $expire = intval($expire) ?: 7200;
$cacheFileURL = $cacheDir . $sitemapHash . '.xml';
$cacheContent = null; $cacheContent = null;
if (!($this->checkAdmin() && "" !== $flush)){ if (!($this->checkAdmin() && "" !== $flush)){
try { try {
$cacheContent = $this->getCache($cacheFileURL, $expire); $cacheContent = $this->getCache($cacheFileURL, $expire);
@@ -138,25 +69,9 @@ class SitemapController extends BaseFrontController {
} }
if (null === $cacheContent){ if (null === $cacheContent){
$encoders = array(new XmlEncoder("urlset"), new JsonEncoder());
$normalizers = array(new SitemapURLNormalizer());
$serializer = new Serializer($normalizers, $encoders);
$this->findStaticUrls(); // render the view
$this->findCategoryUrls(); $cacheContent = $this->renderRaw("sitemap");
$this->findFolderUrls();
$map = array();
$map['@xmlns'] = "http://www.sitemaps.org/schemas/sitemap/0.9";
$map['url'] = array_merge(
$this->staticUrls,
$this->categoryUrls,
$this->productUrls,
$this->folderUrls,
$this->contentUrls
);
$cacheContent = $serializer->serialize($map, 'xml');
// save cache // save cache
try { try {
@@ -175,118 +90,6 @@ class SitemapController extends BaseFrontController {
return $response; return $response;
} }
/**
* Get all static URLs
*
* @param int $parent Parent category id
*/
protected function findStaticUrls()
{
$url = URL::getInstance()->getIndexPage();
$home = new SitemapURL($url);
$home->setPriotity(1.0);
$this->staticUrls[] = $home;
}
/**
* Get all child visible categories of category id `$parent`
* This function is recursive and is called for all child categories
*
* @param int $parent Parent category id
*/
protected function findCategoryUrls($parent = 0)
{
$categoryQuery = CategoryQuery::create();
$categoryQuery->filterByParent($parent);
$categoryQuery->filterByVisible(true, Criteria::EQUAL);
$categories = $categoryQuery->find();
/** @var Category $category */
foreach($categories AS $category){
foreach ($this->locales AS $local){
$loc = $category->getUrl($local);
$this->categoryUrls[] = new SitemapURL($loc, $category->getUpdatedAt("c"));
}
// call sub categories
$this->findCategoryUrls($category->getId());
// call products
$this->findProductUrls($category);
}
}
/**
* Get all visible product which have `category` as default category
*
* @param Category $category
*/
protected function findProductUrls(Category $category = null)
{
$products = ProductQuery::create()
//->filterByCategory($category)
->filterByVisible(true, Criteria::EQUAL)
->joinProductCategory()
->where('ProductCategory.default_category' . Criteria::EQUAL . '1')
->where('ProductCategory.category_id = ?', $category->getId())
->find();
/** @var Product $product */
foreach($products AS $product){
foreach ($this->locales AS $local){
$loc = $product->getUrl($local);
$this->productUrls[] = new SitemapURL($loc, $product->getUpdatedAt("c"));
}
}
}
/**
* Get all child visible folders of folder id `$parent`
* This function is recursive and is called for all child folders
*
* @param int $parent Parent folder id
*/
protected function findFolderUrls($parent = 0)
{
$folderQuery = FolderQuery::create();
$folderQuery->filterByParent($parent);
$folderQuery->filterByVisible(true, Criteria::EQUAL);
$folders = $folderQuery->find();
/** @var Folder $folders */
foreach($folders AS $folder){
foreach ($this->locales AS $local){
$loc = $folder->getUrl($local);
$this->folderUrls[] = new SitemapURL($loc, $folder->getUpdatedAt("c"));
}
// call sub folders
$this->findFolderUrls($folder->getId());
// call contents
$this->findContentUrls($folder);
}
}
/**
* Get all visible content which have in `$folder` folder
*
* @param Folder $folder
*/
protected function findContentUrls(Folder $folder=null)
{
$contents = ContentQuery::create()
->filterByVisible(true, Criteria::EQUAL)
->filterByFolder($folder)
->find();
/** @var Content $content */
foreach($contents AS $content){
foreach ($this->locales AS $local){
$loc = $content->getUrl($local);
$this->contentUrls[] = new SitemapURL($loc, $content->getUpdatedAt("c"));
}
}
}
/** /**
* Check if current user has ADMIN role * Check if current user has ADMIN role
* *
@@ -334,7 +137,6 @@ class SitemapController extends BaseFrontController {
} }
} }
/** /**
* Retrieve the cache dir used for sitemaps * Retrieve the cache dir used for sitemaps
* *
@@ -343,7 +145,7 @@ class SitemapController extends BaseFrontController {
*/ */
protected function getCacheDir() protected function getCacheDir()
{ {
$cacheDir = $this->container->getParameter("kernel.cache_dir") . $cacheDir = $this->container->getParameter("kernel.cache_dir");
$cacheDir = rtrim($cacheDir, '/'); $cacheDir = rtrim($cacheDir, '/');
$cacheDir .= '/' . self::SITEMAP_DIR . '/'; $cacheDir .= '/' . self::SITEMAP_DIR . '/';
if (! is_dir($cacheDir)){ if (! is_dir($cacheDir)){

47
templates/frontOffice/default/sitemap.html Normal file
View File

@@ -0,0 +1,47 @@
<?xml version="1.0"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>{url path="/"}</loc>
</url>
<!-- categories -->
{loop type="lang" name="category_lang"}
{loop type="category" name="category" lang="$ID"}
<url>
<loc>{$URL}</loc>
<lastmod>{format_date date=$UPDATE_DATE format="c"}</lastmod>
{*
You can also set priority and changefreq
<priority>0.8</priority>
<changefreq>weekly</changefreq>
*}
</url>
{/loop}
{/loop}
<!-- products -->
{loop type="lang" name="product_lang"}
{loop type="product" name="product" lang="$ID"}
<url>
<loc>{$URL}</loc>
<lastmod>{format_date date=$UPDATE_DATE format="c"}</lastmod>
</url>
{/loop}
{/loop}
<!-- folders -->
{loop type="lang" name="folder_lang"}
{loop type="folder" name="folder" lang="$ID"}
<url>
<loc>{$URL}</loc>
<lastmod>{format_date date=$UPDATE_DATE format="c"}</lastmod>
</url>
{/loop}
{/loop}
<!-- contents -->
{loop type="lang" name="content_lang"}
{loop type="content" name="content" lang="$ID"}
<url>
<loc>{$URL}</loc>
<lastmod>{format_date date=$UPDATE_DATE format="c"}</lastmod>
</url>
{/loop}
{/loop}
</urlset>