application/front/controller/visitor/ShaarliVisitorController.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Front\Controller\Visitor;
   6
   7 use Shaarli\Bookmark\BookmarkFilter;
   8 use Shaarli\Container\ShaarliContainer;
   9 use Slim\Http\Request;
  10 use Slim\Http\Response;
  11
  12 /**
  13  * Class ShaarliVisitorController
  14  *
  15  * All controllers accessible by visitors (non logged in users) should extend this abstract class.
  16  * Contains a few helper function for template rendering, plugins, etc.
  17  *
  18  * @package Shaarli\Front\Controller\Visitor
  19  */
  20 abstract class ShaarliVisitorController
  21 {
  22     /** @var ShaarliContainer */
  23     protected $container;
  24
  25     /** @param ShaarliContainer $container Slim container (extended for attribute completion). */
  26     public function __construct(ShaarliContainer $container)
  27     {
  28         $this->container = $container;
  29     }
  30
  31     /**
  32      * Assign variables to RainTPL template through the PageBuilder.
  33      *
  34      * @param mixed $value Value to assign to the template
  35      */
  36     protected function assignView(string $name, $value): self
  37     {
  38         $this->container->pageBuilder->assign($name, $value);
  39
  40         return $this;
  41     }
  42
  43     /**
  44      * Assign variables to RainTPL template through the PageBuilder.
  45      *
  46      * @param mixed $data Values to assign to the template and their keys
  47      */
  48     protected function assignAllView(array $data): self
  49     {
  50         foreach ($data as $key => $value) {
  51             $this->assignView($key, $value);
  52         }
  53
  54         return $this;
  55     }
  56
  57     protected function render(string $template): string
  58     {
  59         // Legacy key that used to be injected by PluginManager
  60         $this->assignView('_PAGE_', $template);
  61         $this->assignView('template', $template);
  62
  63         $this->assignView('linkcount', $this->container->bookmarkService->count(BookmarkFilter::$ALL));
  64         $this->assignView('privateLinkcount', $this->container->bookmarkService->count(BookmarkFilter::$PRIVATE));
  65
  66         $this->executeDefaultHooks($template);
  67
  68         $this->assignView('plugin_errors', $this->container->pluginManager->getErrors());
  69
  70         return $this->container->pageBuilder->render($template, $this->container->basePath);
  71     }
  72
  73     /**
  74      * Call plugin hooks for header, footer and includes, specifying which page will be rendered.
  75      * Then assign generated data to RainTPL.
  76      */
  77     protected function executeDefaultHooks(string $template): void
  78     {
  79         $common_hooks = [
  80             'includes',
  81             'header',
  82             'footer',
  83         ];
  84
  85         $parameters = $this->buildPluginParameters($template);
  86
  87         foreach ($common_hooks as $name) {
  88             $pluginData = [];
  89             $this->container->pluginManager->executeHooks(
  90                 'render_' . $name,
  91                 $pluginData,
  92                 $parameters
  93             );
  94             $this->assignView('plugins_' . $name, $pluginData);
  95         }
  96     }
  97
  98     protected function executePageHooks(string $hook, array &$data, string $template = null): void
  99     {
 100         $this->container->pluginManager->executeHooks(
 101             $hook,
 102             $data,
 103             $this->buildPluginParameters($template)
 104         );
 105     }
 106
 107     protected function buildPluginParameters(?string $template): array
 108     {
 109         return [
 110             'target' => $template,
 111             'loggedin' => $this->container->loginManager->isLoggedIn(),
 112             'basePath' => $this->container->basePath,
 113             'rootPath' => preg_replace('#/index\.php$#', '', $this->container->basePath),
 114             'bookmarkService' => $this->container->bookmarkService
 115         ];
 116     }
 117
 118     /**
 119      * Simple helper which prepend the base path to redirect path.
 120      *
 121      * @param Response $response
 122      * @param string $path Absolute path, e.g.: `/`, or `/admin/shaare/123` regardless of install directory
 123      *
 124      * @return Response updated
 125      */
 126     protected function redirect(Response $response, string $path): Response
 127     {
 128         return $response->withRedirect($this->container->basePath . $path);
 129     }
 130
 131     /**
 132      * Generates a redirection to the previous page, based on the HTTP_REFERER.
 133      * It fails back to the home page.
 134      *
 135      * @param array $loopTerms   Terms to remove from path and query string to prevent direction loop.
 136      * @param array $clearParams List of parameter to remove from the query string of the referrer.
 137      */
 138     protected function redirectFromReferer(
 139         Request $request,
 140         Response $response,
 141         array $loopTerms = [],
 142         array $clearParams = [],
 143         string $anchor = null
 144     ): Response {
 145         $defaultPath = $this->container->basePath . '/';
 146         $referer = $this->container->environment['HTTP_REFERER'] ?? null;
 147
 148         if (null !== $referer) {
 149             $currentUrl = parse_url($referer);
 150             // If the referer is not related to Shaarli instance, redirect to default
 151             if (
 152                 isset($currentUrl['host'])
 153                 && strpos(index_url($this->container->environment), $currentUrl['host']) === false
 154             ) {
 155                 return $response->withRedirect($defaultPath);
 156             }
 157
 158             parse_str($currentUrl['query'] ?? '', $params);
 159             $path = $currentUrl['path'] ?? $defaultPath;
 160         } else {
 161             $params = [];
 162             $path = $defaultPath;
 163         }
 164
 165         // Prevent redirection loop
 166         if (isset($currentUrl)) {
 167             foreach ($clearParams as $value) {
 168                 unset($params[$value]);
 169             }
 170
 171             $checkQuery = implode('', array_keys($params));
 172             foreach ($loopTerms as $value) {
 173                 if (strpos($path . $checkQuery, $value) !== false) {
 174                     $params = [];
 175                     $path = $defaultPath;
 176                     break;
 177                 }
 178             }
 179         }
 180
 181         $queryString = count($params) > 0 ? '?' . http_build_query($params) : '';
 182         $anchor = $anchor ? '#' . $anchor : '';
 183
 184         return $response->withRedirect($path . $queryString . $anchor);
 185     }
 186 }