application/front/controller/admin/ServerController.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Front\Controller\Admin;
   6
   7 use Shaarli\Helper\ApplicationUtils;
   8 use Shaarli\Helper\FileUtils;
   9 use Slim\Http\Request;
  10 use Slim\Http\Response;
  11
  12 /**
  13  * Slim controller used to handle Server administration page, and actions.
  14  */
  15 class ServerController extends ShaarliAdminController
  16 {
  17     /** @var string Cache type - main - by default pagecache/ and tmp/ */
  18     protected const CACHE_MAIN = 'main';
  19
  20     /** @var string Cache type - thumbnails - by default cache/ */
  21     protected const CACHE_THUMB = 'thumbnails';
  22
  23     /**
  24      * GET /admin/server - Display page Server administration
  25      */
  26     public function index(Request $request, Response $response): Response
  27     {
  28         $latestVersion = 'v' . ApplicationUtils::getVersion(
  29             ApplicationUtils::$GIT_RAW_URL . '/latest/' . ApplicationUtils::$VERSION_FILE
  30         );
  31         $currentVersion = ApplicationUtils::getVersion('./shaarli_version.php');
  32         $currentVersion = $currentVersion === 'dev' ? $currentVersion : 'v' . $currentVersion;
  33         $phpEol = new \DateTimeImmutable(ApplicationUtils::getPhpEol(PHP_VERSION));
  34
  35         $this->assignView('php_version', PHP_VERSION);
  36         $this->assignView('php_eol', format_date($phpEol, false));
  37         $this->assignView('php_has_reached_eol', $phpEol < new \DateTimeImmutable());
  38         $this->assignView('php_extensions', ApplicationUtils::getPhpExtensionsRequirement());
  39         $this->assignView('permissions', ApplicationUtils::checkResourcePermissions($this->container->conf));
  40         $this->assignView('release_url', ApplicationUtils::$GITHUB_URL . '/releases/tag/' . $latestVersion);
  41         $this->assignView('latest_version', $latestVersion);
  42         $this->assignView('current_version', $currentVersion);
  43         $this->assignView('thumbnails_mode', $this->container->conf->get('thumbnails.mode'));
  44         $this->assignView('index_url', index_url($this->container->environment));
  45         $this->assignView('client_ip', client_ip_id($this->container->environment));
  46         $this->assignView('trusted_proxies', $this->container->conf->get('security.trusted_proxies', []));
  47
  48         $this->assignView(
  49             'pagetitle',
  50             t('Server administration') . ' - ' . $this->container->conf->get('general.title', 'Shaarli')
  51         );
  52
  53         return $response->write($this->render('server'));
  54     }
  55
  56     /**
  57      * GET /admin/clear-cache?type={$type} - Action to trigger cache folder clearing (either main or thumbnails).
  58      */
  59     public function clearCache(Request $request, Response $response): Response
  60     {
  61         $exclude = ['.htaccess'];
  62
  63         if ($request->getQueryParam('type') === static::CACHE_THUMB) {
  64             $folders = [$this->container->conf->get('resource.thumbnails_cache')];
  65
  66             $this->saveWarningMessage(
  67                 t('Thumbnails cache has been cleared.') . ' ' .
  68                 '<a href="'. $this->container->basePath .'/admin/thumbnails">' . t('Please synchronize them.') .'</a>'
  69             );
  70         } else {
  71             $folders = [
  72                 $this->container->conf->get('resource.page_cache'),
  73                 $this->container->conf->get('resource.raintpl_tmp'),
  74             ];
  75
  76             $this->saveSuccessMessage(t('Shaarli\'s cache folder has been cleared!'));
  77         }
  78
  79         // Make sure that we don't delete root cache folder
  80         $folders = array_map('realpath', array_values(array_filter(array_map('trim', $folders))));
  81         foreach ($folders as $folder) {
  82             FileUtils::clearFolder($folder, false, $exclude);
  83         }
  84
  85         return $this->redirect($response, '/admin/server');
  86     }
  87 }