%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/*
* This file is part of the Sonata Project package.
*
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Sonata\Exporter\Writer;
/**
* Generates a sitemap site from.
*/
class SitemapWriter implements WriterInterface
{
const LIMIT_SIZE = 10485760;
const LIMIT_URL = 50000;
/**
* @var string
*/
protected $folder;
/**
* @var string
*/
protected $pattern;
/**
* @var string
*/
protected $groupName;
/**
* @var bool
*/
protected $autoIndex;
/**
* @var resource
*/
protected $buffer;
/**
* @var array
*/
protected $headers;
/**
* @var int
*/
protected $bufferSize = 0;
/**
* @var int
*/
protected $bufferUrlCount = 0;
/**
* @var int
*/
protected $bufferPart = 0;
/**
* @param string $folder The folder to store the sitemap.xml file
* @param mixed $groupName Name of sub-sitemap (optional)
* @param array $headers Indicate the need for namespace in the header sitemap
* @param bool $autoIndex If you want to generate index of sitemap (optional)
*/
public function __construct($folder, $groupName = false, array $headers = [], $autoIndex = true)
{
$this->folder = $folder;
$this->groupName = \is_string($groupName) ? $groupName : '';
$this->headers = $headers;
$this->autoIndex = $autoIndex;
$this->pattern = 'sitemap_'.($this->groupName ? $this->groupName.'_' : '').'%05d.xml';
}
/**
* Returns the status of auto generation of index site map.
*
* @return bool
*/
public function isAutoIndex()
{
return $this->autoIndex;
}
/**
* Returns folder to store the sitemap.xml file.
*
* @return string
*/
public function getFolder()
{
return $this->folder;
}
/**
* {@inheritdoc}
*/
public function open()
{
$this->bufferPart = 0;
$this->generateNewPart();
}
/**
* {@inheritdoc}
*/
public function write(array $data)
{
$data = $this->buildData($data);
switch ($data['type']) {
case 'video':
$line = $this->generateVideoLine($data);
break;
case 'image':
$line = $this->generateImageLine($data);
break;
case 'default':
default:
$line = $this->generateDefaultLine($data);
}
$this->addSitemapLine($line);
}
/**
* {@inheritdoc}
*/
public function close()
{
if ($this->buffer) {
$this->closeSitemap();
}
if ($this->autoIndex) {
self::generateSitemapIndex(
$this->folder,
'sitemap_'.($this->groupName ? $this->groupName.'_' : '').'*.xml',
'sitemap'.($this->groupName ? '_'.$this->groupName : '').'.xml'
);
}
}
/**
* Generates the sitemap index from the sitemap part avaible in the folder.
*
* @param string $folder A folder to write sitemap index
* @param string $baseUrl A base URL
* @param string $pattern A sitemap pattern, optional
* @param string $filename A sitemap file name, optional
*/
public static function generateSitemapIndex($folder, $baseUrl, $pattern = 'sitemap*.xml', $filename = 'sitemap.xml')
{
$content = "<?xml version='1.0' encoding='UTF-8'?".">\n<sitemapindex xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.sitemaps.org/schemas/sitemap/1.0 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd' xmlns='http://www.sitemaps.org/schemas/sitemap/0.9'>\n";
foreach (glob(sprintf('%s/%s', $folder, $pattern)) as $file) {
$stat = stat($file);
$content .= sprintf("\t".'<sitemap><loc>%s/%s</loc><lastmod>%s</lastmod></sitemap>'."\n",
$baseUrl,
basename($file),
date('Y-m-d', $stat['mtime'])
);
}
$content .= '</sitemapindex>';
file_put_contents(sprintf('%s/%s', $folder, $filename), $content);
}
/**
* Generate a new sitemap part.
*
* @throws \RuntimeException
*/
protected function generateNewPart()
{
if ($this->buffer) {
$this->closeSitemap();
}
$this->bufferUrlCount = 0;
$this->bufferSize = 0;
++$this->bufferPart;
if (!is_writable($this->folder)) {
throw new \RuntimeException(sprintf('Unable to write to folder: %s', $this->folder));
}
$filename = sprintf($this->pattern, $this->bufferPart);
$this->buffer = fopen($this->folder.'/'.$filename, 'w');
$this->bufferSize += fwrite($this->buffer, '<?xml version="1.0" encoding="UTF-8"?>'."\n".'<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"'.$this->getHeaderByFlag().'>'."\n");
}
/**
* Add a new line into the sitemap part.
*
* @param string $line
*/
protected function addSitemapLine($line)
{
if ($this->bufferUrlCount >= self::LIMIT_URL) {
$this->generateNewPart();
}
if (($this->bufferSize + \strlen($line) + 9) > self::LIMIT_SIZE) {
$this->generateNewPart();
}
++$this->bufferUrlCount;
$this->bufferSize += fwrite($this->buffer, $line);
}
/**
* Build data with default parameters.
*
* @param array $data List of parameters
*
* @return array
*/
protected function buildData(array $data)
{
$default = [
'url' => null,
'lastmod' => 'now',
'changefreq' => 'weekly',
'priority' => 0.5,
'type' => 'default',
];
$data = array_merge($default, $data);
$this->fixDataType($data);
return $data;
}
/**
* Fix type of data, if data type is specific,
* he must to be defined in data and he must to be a array.
*
* @param array &$data List of parameters
*/
protected function fixDataType(array &$data)
{
if ('default' === $data['type']) {
return;
}
$valid_var_name = [
'image' => 'images',
'video' => 'video',
];
if (!isset($valid_var_name[$data['type']], $data[$valid_var_name[$data['type']]]) || !\is_array($data[$valid_var_name[$data['type']]])) {
$data['type'] = 'default';
}
}
/**
* Generate standard line of sitemap.
*
* @param array $data List of parameters
*
* @return string
*/
protected function generateDefaultLine(array $data)
{
return sprintf(' '.'<url><loc>%s</loc><lastmod>%s</lastmod><changefreq>%s</changefreq><priority>%s</priority></url>'."\n", $data['url'], date('Y-m-d', strtotime($data['lastmod'])), $data['changefreq'], $data['priority']);
}
/**
* Generate image line of sitemap.
*
* @param array $data List of parameters
*
* @return string
*/
protected function generateImageLine(array $data)
{
$images = '';
if (\count($data['images']) > 1000) {
$data['images'] = array_splice($data['images'], 1000);
}
$builder = [
'url' => 'loc',
'location' => 'geo_location',
];
foreach ($data['images'] as $image) {
$images .= '<image:image>';
foreach ($image as $key => $element) {
$images .= sprintf('<image:%1$s>%2$s</image:%1$s>', (isset($builder[$key]) ? $builder[$key] : $key), $element);
}
$images .= '</image:image>';
}
return sprintf(' '.'<url><loc>%s</loc>%s</url>'."\n", $data['url'], $images);
}
/**
* Generate video line of sitemap.
*
* @param array $data List of parameters
*
* @return string
*/
protected function generateVideoLine(array $data)
{
$videos = '';
$builder = [
'thumbnail' => 'thumbnail_loc',
];
foreach ($data['video'] as $key => $video) {
$videos .= sprintf('<video:%1$s>%2$s</video:%1$s>', (isset($builder[$key]) ? $builder[$key] : $key), $video);
}
return sprintf(' '.'<url><loc>%s</loc><video:video>%s</video:video></url>'."\n", $data['url'], $videos);
}
/**
* Generate additional header with namespace adapted to the content.
*
* @return string
*/
protected function getHeaderByFlag()
{
$namespaces = [
'video' => 'xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"',
'image' => 'xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"',
];
$result = '';
foreach ($this->headers as $flag) {
$result .= ' '.$namespaces[$flag];
}
return $result;
}
/**
* Close the sitemap part.
*/
protected function closeSitemap()
{
fwrite($this->buffer, '</urlset>');
fclose($this->buffer);
}
}
class_exists(\Exporter\Writer\SitemapWriter::class);
Zerion Mini Shell 1.0