incorporation of code review

shaarli · Apr 19, 2023 · e4b3133 · e4b3133
1 parent 6f6cc38
commit e4b3133
Show file tree

Hide file tree

Showing 17 changed files with 161 additions and 331 deletions.
diff --git a/application/api/controllers/Links.php b/application/api/controllers/Links.php
@@ -2,7 +2,6 @@
 
 namespace Shaarli\Api\Controllers;
 
-use DI\Container;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 use Shaarli\Api\ApiUtils;
@@ -25,11 +24,6 @@ class Links extends ApiController
      */
     public static $DEFAULT_LIMIT = 20;
 
-    public function __construct(Container $ci)
-    {
-        parent::__construct($ci);
-    }
-
     /**
      * Retrieve a list of bookmarks, allowing different filters.
      *

diff --git a/application/api/exceptions/ApiException.php b/application/api/exceptions/ApiException.php
@@ -2,7 +2,6 @@
 
 namespace Shaarli\Api\Exceptions;
 
-use Slim\Http\Response;
 use Slim\Psr7\Response as SlimResponse;
 
 /**

diff --git a/application/container/ContainerBuilder.php b/application/container/ContainerBuilder.php
@@ -6,14 +6,13 @@
 
 use DI\Container;
 use malkusch\lock\mutex\FlockMutex;
+use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
 use Shaarli\Bookmark\BookmarkFileService;
 use Shaarli\Bookmark\BookmarkServiceInterface;
 use Shaarli\Config\ConfigManager;
 use Shaarli\Feed\FeedBuilder;
 use Shaarli\Formatter\FormatterFactory;
-use Shaarli\Front\Controller\Visitor\ErrorController;
-use Shaarli\Front\Controller\Visitor\ErrorNotFoundController;
 use Shaarli\History;
 use Shaarli\Http\HttpAccess;
 use Shaarli\Http\MetadataRetriever;
@@ -76,7 +75,7 @@ public function __construct(
         $this->logger = $logger;
     }
 
-    public function build(): Container
+    public function build(): ContainerInterface
     {
         $container = new Container();
 

diff --git a/application/front/ShaarliAdminMiddleware.php b/application/front/ShaarliAdminMiddleware.php
@@ -18,7 +18,7 @@ public function __invoke(Request $request, RequestHandler $handler): Response
         $this->initBasePath($request);
 
         if (true !== $this->container->get('loginManager')->isLoggedIn()) {
-            $returnUrl = urlencode($request->getServerParams()['REQUEST_URI'] ?? null);
+            $returnUrl = urlencode($request->getServerParams()['REQUEST_URI']);
 
             return $this->redirect($this->container->get('basePath') . '/login?returnurl=' . $returnUrl);
         }

diff --git a/application/front/ShaarliErrorHandler.php b/application/front/ShaarliErrorHandler.php
@@ -9,19 +9,20 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerInterface;
-use Shaarli\Bookmark\BookmarkFilter;
+use Shaarli\Front\Controller\PageTrait;
 use Shaarli\Front\Exception\ShaarliFrontException;
 use Shaarli\Render\TemplatePage;
 use Slim\Exception\HttpNotFoundException;
 use Slim\Handlers\ErrorHandler;
 use Slim\Interfaces\CallableResolverInterface;
-use Slim\Psr7\Response;
 use Slim\Psr7\Response as SlimResponse;
 use Slim\Routing\RouteContext;
 use Throwable;
 
 class ShaarliErrorHandler extends ErrorHandler
 {
+    use PageTrait;
+
     private ?Container $container;
 
     public function __construct(
@@ -41,8 +42,8 @@ public function __invoke(
         bool $logErrors,
         bool $logErrorDetails
     ): ResponseInterface {
-        $resp = parent::__invoke($request, $exception, $displayErrorDetails, $logErrors, $logErrorDetails);
-        $response = new Response();
+        parent::__invoke($request, $exception, $displayErrorDetails, $logErrors, $logErrorDetails);
+        $response = new SlimResponse();
         // Unknown error encountered
         $this->container->get('pageBuilder')->reset();
         if ($exception instanceof HttpNotFoundException) {
@@ -72,74 +73,11 @@ public function __invoke(
 
             $response = $response->withStatus(500);
         }
-
         $response->getBody()->write($this->render(TemplatePage::ERROR));
         return $response;
     }
 
-    protected function assignView(string $name, $value): self
-    {
-        $this->container->get('pageBuilder')->assign($name, $value);
-
-        return $this;
-    }
-
-    /**
-     * Call plugin hooks for header, footer and includes, specifying which page will be rendered.
-     * Then assign generated data to RainTPL.
-     */
-    protected function executeDefaultHooks(string $template): void
-    {
-        $common_hooks = [
-            'includes',
-            'header',
-            'footer',
-        ];
-
-        $parameters = $this->buildPluginParameters($template);
-
-        foreach ($common_hooks as $name) {
-            $pluginData = [];
-            $this->container->get('pluginManager')->executeHooks(
-                'render_' . $name,
-                $pluginData,
-                $parameters
-            );
-            $this->assignView('plugins_' . $name, $pluginData);
-        }
-    }
-
-    protected function buildPluginParameters(?string $template): array
-    {
-        $basePath = $this->container->get('basePath') ?? '';
-        return [
-            'target' => $template,
-            'loggedin' => $this->container->get('loginManager')->isLoggedIn(),
-            'basePath' => $this->container->get('basePath'),
-            'rootPath' => preg_replace('#/index\.php$#', '', $basePath),
-            'bookmarkService' => $this->container->get('bookmarkService')
-        ];
-    }
-
-    protected function render(string $template): string
-    {
-        // Legacy key that used to be injected by PluginManager
-        $this->assignView('_PAGE_', $template);
-        $this->assignView('template', $template);
-
-        $this->assignView('linkcount', $this->container->get('bookmarkService')->count(BookmarkFilter::$ALL));
-        $this->assignView('privateLinkcount', $this->container->get('bookmarkService')
-            ->count(BookmarkFilter::$PRIVATE));
-
-        $this->executeDefaultHooks($template);
-
-        $this->assignView('plugin_errors', $this->container->get('pluginManager')->getErrors());
-
-        $basePath = $this->container->get('basePath') ?? '';
-        return $this->container->get('pageBuilder')->render($template, $basePath);
-    }
-
-    protected function showError404($request): Response
+    protected function showError404($request): ResponseInterface
     {
         $response = new SlimResponse();
         // Request from the API

diff --git a/application/front/ShaarliMiddleware.php b/application/front/ShaarliMiddleware.php
@@ -56,7 +56,7 @@ public function __invoke(Request $request, RequestHandler $handler): Response
 
             return $handler->handle($request);
         } catch (UnauthorizedException $e) {
-            $returnUrl = urlencode($request->getServerParams()['REQUEST_URI'] ?? null);
+            $returnUrl = urlencode($request->getServerParams()['REQUEST_URI']);
 
             return $this->redirect($this->container->get('basePath') . '/login?returnurl=' . $returnUrl);
         }

diff --git a/application/front/controller/PageTrait.php b/application/front/controller/PageTrait.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shaarli\Front\Controller;
+
+use Shaarli\Bookmark\BookmarkFilter;
+
+trait PageTrait
+{
+    protected function assignView(string $name, $value): self
+    {
+        $this->container->get('pageBuilder')->assign($name, $value);
+
+        return $this;
+    }
+
+    /**
+     * Call plugin hooks for header, footer and includes, specifying which page will be rendered.
+     * Then assign generated data to RainTPL.
+     */
+    protected function executeDefaultHooks(string $template): void
+    {
+        $common_hooks = [
+            'includes',
+            'header',
+            'footer',
+        ];
+
+        $parameters = $this->buildPluginParameters($template);
+
+        foreach ($common_hooks as $name) {
+            $pluginData = [];
+            $this->container->get('pluginManager')->executeHooks(
+                'render_' . $name,
+                $pluginData,
+                $parameters
+            );
+            $this->assignView('plugins_' . $name, $pluginData);
+        }
+    }
+
+    protected function buildPluginParameters(?string $template): array
+    {
+        $basePath = $this->container->get('basePath') ?? '';
+        return [
+            'target' => $template,
+            'loggedin' => $this->container->get('loginManager')->isLoggedIn(),
+            'basePath' => $this->container->get('basePath'),
+            'rootPath' => preg_replace('#/index\.php$#', '', $basePath),
+            'bookmarkService' => $this->container->get('bookmarkService')
+        ];
+    }
+
+    protected function render(string $template): string
+    {
+        // Legacy key that used to be injected by PluginManager
+        $this->assignView('_PAGE_', $template);
+        $this->assignView('template', $template);
+
+        $this->assignView('linkcount', $this->container->get('bookmarkService')->count(BookmarkFilter::$ALL));
+        $this->assignView('privateLinkcount', $this->container->get('bookmarkService')
+            ->count(BookmarkFilter::$PRIVATE));
+
+        $this->executeDefaultHooks($template);
+
+        $this->assignView('plugin_errors', $this->container->get('pluginManager')->getErrors());
+
+        $basePath = $this->container->get('basePath') ?? '';
+        return $this->container->get('pageBuilder')->render($template, $basePath);
+    }
+}
diff --git a/application/front/controller/visitor/ErrorController.php b/application/front/controller/visitor/ErrorController.php
diff --git a/application/front/controller/visitor/ErrorNotFoundController.php b/application/front/controller/visitor/ErrorNotFoundController.php
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ @@
     namespace Shaarli\Api\Exceptions;
-    use Slim\Http\Response;
     use Slim\Psr7\Response as SlimResponse;
     /**
@@ Expand Down @@