application/front/controller/admin/PluginsController.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Front\Controller\Admin;
   6
   7 use Exception;
   8 use Shaarli\Render\TemplatePage;
   9 use Slim\Http\Request;
  10 use Slim\Http\Response;
  11
  12 /**
  13  * Class PluginsController
  14  *
  15  * Slim controller used to handle Shaarli plugins configuration page (display + save new config).
  16  */
  17 class PluginsController extends ShaarliAdminController
  18 {
  19     /**
  20      * GET /admin/plugins - Displays the configuration page
  21      */
  22     public function index(Request $request, Response $response): Response
  23     {
  24         $pluginMeta = $this->container->pluginManager->getPluginsMeta();
  25
  26         // Split plugins into 2 arrays: ordered enabled plugins and disabled.
  27         $enabledPlugins = array_filter($pluginMeta, function ($v) {
  28             return ($v['order'] ?? false) !== false;
  29         });
  30         $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $this->container->conf->get('plugins', []));
  31         uasort(
  32             $enabledPlugins,
  33             function ($a, $b) {
  34                 return $a['order'] - $b['order'];
  35             }
  36         );
  37         $disabledPlugins = array_filter($pluginMeta, function ($v) {
  38             return ($v['order'] ?? false) === false;
  39         });
  40
  41         $this->assignView('enabledPlugins', $enabledPlugins);
  42         $this->assignView('disabledPlugins', $disabledPlugins);
  43         $this->assignView(
  44             'pagetitle',
  45             t('Plugin Administration') .' - '. $this->container->conf->get('general.title', 'Shaarli')
  46         );
  47
  48         return $response->write($this->render(TemplatePage::PLUGINS_ADMIN));
  49     }
  50
  51     /**
  52      * POST /admin/plugins - Update Shaarli's configuration
  53      */
  54     public function save(Request $request, Response $response): Response
  55     {
  56         $this->checkToken($request);
  57
  58         try {
  59             $parameters = $request->getParams() ?? [];
  60
  61             $this->executeHooks($parameters);
  62
  63             if (isset($parameters['parameters_form'])) {
  64                 unset($parameters['parameters_form']);
  65                 foreach ($parameters as $param => $value) {
  66                     $this->container->conf->set('plugins.'. $param, escape($value));
  67                 }
  68             } else {
  69                 $this->container->conf->set('general.enabled_plugins', save_plugin_config($parameters));
  70             }
  71
  72             $this->container->conf->write($this->container->loginManager->isLoggedIn());
  73             $this->container->history->updateSettings();
  74
  75             $this->saveSuccessMessage(t('Setting successfully saved.'));
  76         } catch (Exception $e) {
  77             $this->saveErrorMessage(
  78                 t('Error while saving plugin configuration: ') . PHP_EOL . $e->getMessage()
  79             );
  80         }
  81
  82         return $this->redirect($response, '/admin/plugins');
  83     }
  84
  85     /**
  86      * @param mixed[] $data Variables passed to the template engine
  87      *
  88      * @return mixed[] Template data after active plugins render_picwall hook execution.
  89      */
  90     protected function executeHooks(array $data): array
  91     {
  92         $this->container->pluginManager->executeHooks(
  93             'save_plugin_parameters',
  94             $data
  95         );
  96
  97         return $data;
  98     }
  99 }