Viewing file:  SitemapGenerator.php (5.32 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Spatie\Sitemap;
use Closure;
use GuzzleHttp\Psr7\Uri;
use Illuminate\Support\Collection;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;
use Spatie\Browsershot\Browsershot;
use Spatie\Crawler\Crawler;
use Spatie\Crawler\CrawlProfiles\CrawlProfile;
use Spatie\Sitemap\Crawler\Observer;
use Spatie\Sitemap\Crawler\Profile;
use Spatie\Sitemap\Tags\Url;
class SitemapGenerator
{
protected Collection $sitemaps;
protected Uri $urlToBeCrawled;
protected Crawler $crawler;
/** @var callable */
protected $shouldCrawl;
/** @var callable */
protected $hasCrawled;
protected int $concurrency = 10;
protected bool | int $maximumTagsPerSitemap = false;
protected ?int $maximumCrawlCount = null;
public static function create(string $urlToBeCrawled): static
{
return app(static::class)->setUrl($urlToBeCrawled);
}
public function __construct(Crawler $crawler)
{
$this->crawler = $crawler;
$this->sitemaps = new Collection([new Sitemap]);
$this->hasCrawled = fn (Url $url, ResponseInterface $response = null) => $url;
}
public function configureCrawler(Closure $closure): static
{
call_user_func_array($closure, [$this->crawler]);
return $this;
}
public function setConcurrency(int $concurrency): static
{
$this->concurrency = $concurrency;
return $this;
}
public function setMaximumCrawlCount(int $maximumCrawlCount): static
{
$this->maximumCrawlCount = $maximumCrawlCount;
return $this;
}
public function maxTagsPerSitemap(int $maximumTagsPerSitemap = 50000): static
{
$this->maximumTagsPerSitemap = $maximumTagsPerSitemap;
return $this;
}
public function setUrl(string $urlToBeCrawled): static
{
$this->urlToBeCrawled = new Uri($urlToBeCrawled);
if ($this->urlToBeCrawled->getPath() === '') {
$this->urlToBeCrawled = $this->urlToBeCrawled->withPath('/');
}
return $this;
}
public function shouldCrawl(callable $shouldCrawl): static
{
$this->shouldCrawl = $shouldCrawl;
return $this;
}
public function hasCrawled(callable $hasCrawled): static
{
$this->hasCrawled = $hasCrawled;
return $this;
}
public function getSitemap(): Sitemap
{
if (config('sitemap.execute_javascript')) {
$this->crawler->executeJavaScript();
}
if (config('sitemap.chrome_binary_path')) {
$this->crawler
->setBrowsershot((new Browsershot)->setChromePath(config('sitemap.chrome_binary_path')))
->acceptNofollowLinks();
}
if (! is_null($this->maximumCrawlCount)) {
$this->crawler->setTotalCrawlLimit($this->maximumCrawlCount);
}
$this->crawler
->setCrawlProfile($this->getCrawlProfile())
->setCrawlObserver($this->getCrawlObserver())
->setConcurrency($this->concurrency)
->startCrawling($this->urlToBeCrawled);
return $this->sitemaps->first();
}
public function writeToFile(string $path): static
{
$sitemap = $this->getSitemap();
if ($this->maximumTagsPerSitemap) {
$sitemap = SitemapIndex::create();
$format = str_replace('.xml', '_%d.xml', $path);
// Parses each sub-sitemaps, writes and push them into the sitemap index
$this->sitemaps->each(function (Sitemap $item, int $key) use ($sitemap, $format) {
$path = sprintf($format, $key);
$item->writeToFile(sprintf($format, $key));
$sitemap->add(last(explode('public', $path)));
});
}
$sitemap->writeToFile($path);
return $this;
}
protected function getCrawlProfile(): CrawlProfile
{
$shouldCrawl = function (UriInterface $url) {
if ($url->getHost() !== $this->urlToBeCrawled->getHost()) {
return false;
}
if (! is_callable($this->shouldCrawl)) {
return true;
}
return ($this->shouldCrawl)($url);
};
$profileClass = config('sitemap.crawl_profile', Profile::class);
$profile = new $profileClass($this->urlToBeCrawled);
if (method_exists($profile, 'shouldCrawlCallback')) {
$profile->shouldCrawlCallback($shouldCrawl);
}
return $profile;
}
protected function getCrawlObserver(): Observer
{
$performAfterUrlHasBeenCrawled = function (UriInterface $crawlerUrl, ResponseInterface $response = null) {
$sitemapUrl = ($this->hasCrawled)(Url::create((string) $crawlerUrl), $response);
if ($this->shouldStartNewSitemapFile()) {
$this->sitemaps->push(new Sitemap);
}
if ($sitemapUrl) {
$this->sitemaps->last()->add($sitemapUrl);
}
};
return new Observer($performAfterUrlHasBeenCrawled);
}
protected function shouldStartNewSitemapFile(): bool
{
if (! $this->maximumTagsPerSitemap) {
return false;
}
$currentNumberOfTags = count($this->sitemaps->last()->getTags());
return $currentNumberOfTags >= $this->maximumTagsPerSitemap;
}
}
|