Sitemap generator and route handling and remove // from opengraph image

Author: OStefan2001

bin/sitemap

@@ -0,0 +1,23 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+use Light\App\Service\SitemapGenerator;
+
+chdir(__DIR__ . '/../');
+
+require 'vendor/autoload.php';
+
+$container        = require 'config/container.php';
+$sitemapGenerator = $container->get(SitemapGenerator::class);
+
+$count = $sitemapGenerator->write();
+
+printf(
+    "Done. %d url%s written to %s%s",
+    $count,
+    $count === 1 ? '' : 's',
+    $sitemapGenerator->getSitemapFile(),
+    PHP_EOL
+);

config/autoload/local.php.dist

@@ -59,6 +59,9 @@ return [
     'feed'                 => [
         'path' => realpath(__DIR__ . '/../../public/feed.xml'),
     ],
+    'sitemap'              => [
+        'path' => realpath(__DIR__ . '/../../public/sitemap.xml'),
+    ],
     'routes'               => [
         'page' => [
             'contact'                          => 'contact',

public/sitemap.xml

@@ -16,11 +16,15 @@
 use Light\App\Factory\GetFeedViewHandlerFactory;
 use Light\App\Factory\GetIndexViewHandlerFactory;
 use Light\App\Factory\GetMarkdownArticleHandlerFactory;
+use Light\App\Factory\GetSitemapViewHandlerFactory;
+use Light\App\Factory\SitemapGeneratorFactory;
 use Light\App\Handler\GetFeedViewHandler;
 use Light\App\Handler\GetIndexViewHandler;
 use Light\App\Handler\GetMarkdownArticleHandler;
+use Light\App\Handler\GetSitemapViewHandler;
 use Light\App\Resolver\EntityListenerResolver;
 use Light\App\Service\FeedGenerator;
+use Light\App\Service\SitemapGenerator;
 use Mezzio\Application;
 use Roave\PsrContainerDoctrine\EntityManagerFactory;
 use Symfony\Component\Cache\Adapter\AdapterInterface;
@@ -121,7 +125,9 @@ public function getDependencies(): array
                 GetIndexViewHandler::class            => GetIndexViewHandlerFactory::class,
                 GetFeedViewHandler::class             => GetFeedViewHandlerFactory::class,
                 GetMarkdownArticleHandler::class      => GetMarkdownArticleHandlerFactory::class,
+                GetSitemapViewHandler::class          => GetSitemapViewHandlerFactory::class,
                 FeedGenerator::class                  => FeedGeneratorFactory::class,
+                SitemapGenerator::class               => SitemapGeneratorFactory::class,
             ],
             'aliases'    => [
                 EntityManager::class          => 'doctrine.entity_manager.orm_default',

src/App/src/ConfigProvider.php

@@ -9,7 +9,6 @@
 use Psr\Container\ContainerInterface;
 
 use function assert;
-use function rtrim;
 
 class FeedGeneratorFactory
 {
@@ -23,7 +22,7 @@ public function __invoke(ContainerInterface $container): FeedGenerator
         return new FeedGenerator(
             $postRepository,
             $config['feed']['path'],
-            rtrim($config['application']['baseUrl'] ?? '', '/') . '/',
+            $config['application']['baseUrl'] ?? '',
             $config['application']['meta']['title'] ?? '',
             $config['application']['meta']['description'] ?? '',
             $config['application']['meta']['image'] ?? '',

src/App/src/Factory/FeedGeneratorFactory.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Factory;
+
+use Light\App\Handler\GetSitemapViewHandler;
+use Light\App\Service\SitemapGenerator;
+use Light\Blog\Repository\CategoryRepository;
+use Mezzio\Template\TemplateRendererInterface;
+use Psr\Container\ContainerInterface;
+
+use function assert;
+
+class GetSitemapViewHandlerFactory
+{
+    /**
+     * @param class-string $requestedName
+     */
+    public function __invoke(ContainerInterface $container, string $requestedName): GetSitemapViewHandler
+    {
+        $template = $container->get(TemplateRendererInterface::class);
+        assert($template instanceof TemplateRendererInterface);
+
+        $categoryRepository = $container->get(CategoryRepository::class);
+        assert($categoryRepository instanceof CategoryRepository);
+
+        $sitemapGenerator = $container->get(SitemapGenerator::class);
+        assert($sitemapGenerator instanceof SitemapGenerator);
+
+        return new GetSitemapViewHandler($template, $categoryRepository, $sitemapGenerator);
+    }
+}

src/App/src/Factory/GetSitemapViewHandlerFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Factory;
+
+use Light\App\Service\SitemapGenerator;
+use Light\Blog\Repository\PostRepository;
+use Psr\Container\ContainerInterface;
+
+use function assert;
+
+class SitemapGeneratorFactory
+{
+    public function __invoke(ContainerInterface $container): SitemapGenerator
+    {
+        $postRepository = $container->get(PostRepository::class);
+        assert($postRepository instanceof PostRepository);
+
+        $config = $container->get('config');
+
+        return new SitemapGenerator(
+            $postRepository,
+            $config['sitemap']['path'],
+            $config['application']['baseUrl'] ?? '',
+        );
+    }
+}

src/App/src/Factory/SitemapGeneratorFactory.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Light\App\Handler;
+
+use Fig\Http\Message\StatusCodeInterface;
+use Laminas\Diactoros\Response\HtmlResponse;
+use Laminas\Diactoros\Response\XmlResponse;
+use Light\App\Service\SitemapGenerator;
+use Light\Blog\Entity\Category;
+use Light\Blog\Repository\CategoryRepository;
+use Mezzio\Template\TemplateRendererInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Throwable;
+
+use function file_get_contents;
+use function filesize;
+use function is_file;
+
+class GetSitemapViewHandler implements RequestHandlerInterface
+{
+    public function __construct(
+        private readonly TemplateRendererInterface $template,
+        private readonly CategoryRepository $categoryRepository,
+        private readonly SitemapGenerator $sitemapGenerator,
+    ) {
+    }
+
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        $sitemapFile = $this->sitemapGenerator->getSitemapFile();
+
+        if (! is_file($sitemapFile) || filesize($sitemapFile) === 0) {
+            try {
+                $this->sitemapGenerator->write();
+            } catch (Throwable) {
+            }
+        }
+
+        if (! is_file($sitemapFile) || filesize($sitemapFile) === 0) {
+            return $this->notFound($this->categoryRepository->getCategories());
+        }
+
+        return new XmlResponse(
+            (string) file_get_contents($sitemapFile),
+            StatusCodeInterface::STATUS_OK,
+            ['Content-Type' => SitemapGenerator::CONTENT_TYPE]
+        );
+    }
+
+    /**
+     * @param Category[] $categories
+     */
+    private function notFound(array $categories): HtmlResponse
+    {
+        return new HtmlResponse(
+            $this->template->render('error::404', [
+                'categories' => $categories,
+            ]),
+            StatusCodeInterface::STATUS_NOT_FOUND
+        );
+    }
+}

src/App/src/Handler/GetSitemapViewHandler.php

@@ -8,6 +8,7 @@
 use Light\App\Handler\GetFeedViewHandler;
 use Light\App\Handler\GetIndexViewHandler;
 use Light\App\Handler\GetMarkdownArticleHandler;
+use Light\App\Handler\GetSitemapViewHandler;
 use Mezzio\Application;
 use Psr\Container\ContainerInterface;
 
@@ -21,6 +22,7 @@ public function __invoke(ContainerInterface $container, string $serviceName, cal
         assert($app instanceof Application);
         $app->get('/', [GetIndexViewHandler::class], 'app::index');
         $app->get('/feed/', [GetFeedViewHandler::class], 'app::feed');
+        $app->get('/sitemap/', [GetSitemapViewHandler::class], 'app::sitemap');
         $app->get('/{categorySlug}/{slug}.md', [GetMarkdownArticleHandler::class], 'app::markdown-article');
 
         $app->get('/{first}', function ($request) {

src/App/src/RoutesDelegator.php

@@ -55,7 +55,7 @@ public function write(): int
         $this->appendText($dom, $channel, 'lastBuildDate', (new DateTimeImmutable())->format(DateTimeInterface::RSS));
 
         foreach ($posts as $post) {
-            $link = $this->baseUrl . $post->getCategory()->getSlug() . '/' . $post->getSlug() . '/';
+            $link = $this->baseUrl . '/' . $post->getCategory()->getSlug() . '/' . $post->getSlug() . '/';
 
             $item = $dom->createElement('item');
             $channel->appendChild($item);