From 7b2ba6ef820335df682fbe3dcfaceef3a62cf4a5 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Mon, 18 May 2020 17:17:36 +0200
Subject: RSS/ATOM feeds: process through Slim controller

---
 application/container/ContainerBuilder.php         | 10 +++
 application/container/ShaarliContainer.php         |  2 +
 application/feed/FeedBuilder.php                   |  2 +-
 application/front/controllers/FeedController.php   | 79 ++++++++++++++++++++++
 .../front/controllers/ShaarliController.php        | 14 ++++
 5 files changed, 106 insertions(+), 1 deletion(-)
 create mode 100644 application/front/controllers/FeedController.php

(limited to 'application')

diff --git a/application/container/ContainerBuilder.php b/application/container/ContainerBuilder.php
index 199f3f67..84406979 100644
--- a/application/container/ContainerBuilder.php
+++ b/application/container/ContainerBuilder.php
@@ -7,6 +7,7 @@ namespace Shaarli\Container;
 use Shaarli\Bookmark\BookmarkFileService;
 use Shaarli\Bookmark\BookmarkServiceInterface;
 use Shaarli\Config\ConfigManager;
+use Shaarli\Feed\FeedBuilder;
 use Shaarli\Formatter\FormatterFactory;
 use Shaarli\History;
 use Shaarli\Plugin\PluginManager;
@@ -100,6 +101,15 @@ class ContainerBuilder
             );
         };
 
+        $container['feedBuilder'] = function (ShaarliContainer $container): FeedBuilder {
+            return new FeedBuilder(
+                $container->bookmarkService,
+                $container->formatterFactory->getFormatter(),
+                $container->environment,
+                $container->loginManager->isLoggedIn()
+            );
+        };
+
         return $container;
     }
 }
diff --git a/application/container/ShaarliContainer.php b/application/container/ShaarliContainer.php
index 3995f669..deb07197 100644
--- a/application/container/ShaarliContainer.php
+++ b/application/container/ShaarliContainer.php
@@ -6,6 +6,7 @@ namespace Shaarli\Container;
 
 use Shaarli\Bookmark\BookmarkServiceInterface;
 use Shaarli\Config\ConfigManager;
+use Shaarli\Feed\FeedBuilder;
 use Shaarli\Formatter\FormatterFactory;
 use Shaarli\History;
 use Shaarli\Plugin\PluginManager;
@@ -29,6 +30,7 @@ use Slim\Container;
  * @property PluginManager            $pluginManager
  * @property FormatterFactory         $formatterFactory
  * @property PageCacheManager         $pageCacheManager
+ * @property FeedBuilder              $feedBuilder
  */
 class ShaarliContainer extends Container
 {
diff --git a/application/feed/FeedBuilder.php b/application/feed/FeedBuilder.php
index bcf27c2c..c97ae1ea 100644
--- a/application/feed/FeedBuilder.php
+++ b/application/feed/FeedBuilder.php
@@ -78,7 +78,7 @@ class FeedBuilder
      * @param array                    $serverInfo $_SERVER.
      * @param boolean                  $isLoggedIn True if the user is currently logged in, false otherwise.
      */
-    public function __construct($linkDB, $formatter, array $serverInfo, $isLoggedIn)
+    public function __construct($linkDB, $formatter, $serverInfo, $isLoggedIn)
     {
         $this->linkDB = $linkDB;
         $this->formatter = $formatter;
diff --git a/application/front/controllers/FeedController.php b/application/front/controllers/FeedController.php
new file mode 100644
index 00000000..78d826d9
--- /dev/null
+++ b/application/front/controllers/FeedController.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shaarli\Front\Controller;
+
+use Shaarli\Feed\FeedBuilder;
+use Slim\Http\Request;
+use Slim\Http\Response;
+
+/**
+ * Class FeedController
+ *
+ * Slim controller handling ATOM and RSS feed.
+ *
+ * @package Front\Controller
+ */
+class FeedController extends ShaarliController
+{
+    public function atom(Request $request, Response $response): Response
+    {
+        return $this->processRequest(FeedBuilder::$FEED_ATOM, $request, $response);
+    }
+
+    public function rss(Request $request, Response $response): Response
+    {
+        return $this->processRequest(FeedBuilder::$FEED_RSS, $request, $response);
+    }
+
+    protected function processRequest(string $feedType, Request $request, Response $response): Response
+    {
+        $response = $response->withHeader('Content-Type', 'application/'. $feedType .'+xml; charset=utf-8');
+
+        $pageUrl = page_url($this->container->environment);
+        $cache = $this->container->pageCacheManager->getCachePage($pageUrl);
+
+        $cached = $cache->cachedVersion();
+        if (!empty($cached)) {
+            return $response->write($cached);
+        }
+
+        // Generate data.
+        $this->container->feedBuilder->setLocale(strtolower(setlocale(LC_COLLATE, 0)));
+        $this->container->feedBuilder->setHideDates($this->container->conf->get('privacy.hide_timestamps', false));
+        $this->container->feedBuilder->setUsePermalinks(
+            null !== $request->getParam('permalinks') || !$this->container->conf->get('feed.rss_permalinks')
+        );
+
+        $data = $this->container->feedBuilder->buildData($feedType, $request->getParams());
+
+        $this->executeHooks($data, $feedType);
+        $this->assignAllView($data);
+
+        $content = $this->render('feed.'. $feedType);
+
+        $cache->cache($content);
+
+        return $response->write($content);
+    }
+
+    /**
+     * @param mixed[] $data Template data
+     *
+     * @return mixed[] Template data after active plugins hook execution.
+     */
+    protected function executeHooks(array $data, string $feedType): array
+    {
+        $this->container->pluginManager->executeHooks(
+            'render_feed',
+            $data,
+            [
+                'loggedin' => $this->container->loginManager->isLoggedIn(),
+                'target' => $feedType,
+            ]
+        );
+
+        return $data;
+    }
+}
diff --git a/application/front/controllers/ShaarliController.php b/application/front/controllers/ShaarliController.php
index 2b828588..0c5d363e 100644
--- a/application/front/controllers/ShaarliController.php
+++ b/application/front/controllers/ShaarliController.php
@@ -30,6 +30,20 @@ abstract class ShaarliController
         return $this;
     }
 
+    /**
+     * Assign variables to RainTPL template through the PageBuilder.
+     *
+     * @param mixed $data Values to assign to the template and their keys
+     */
+    protected function assignAllView(array $data): self
+    {
+        foreach ($data as $key => $value) {
+            $this->assignView($key, $value);
+        }
+
+        return $this;
+    }
+
     protected function render(string $template): string
     {
         $this->assignView('linkcount', $this->container->bookmarkService->count(BookmarkFilter::$ALL));
-- 
cgit v1.2.3