application/container/ContainerBuilder.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Container;
   6
   7 use malkusch\lock\mutex\FlockMutex;
   8 use Shaarli\Bookmark\BookmarkFileService;
   9 use Shaarli\Bookmark\BookmarkServiceInterface;
  10 use Shaarli\Config\ConfigManager;
  11 use Shaarli\Feed\FeedBuilder;
  12 use Shaarli\Formatter\FormatterFactory;
  13 use Shaarli\Front\Controller\Visitor\ErrorController;
  14 use Shaarli\Front\Controller\Visitor\ErrorNotFoundController;
  15 use Shaarli\History;
  16 use Shaarli\Http\HttpAccess;
  17 use Shaarli\Netscape\NetscapeBookmarkUtils;
  18 use Shaarli\Plugin\PluginManager;
  19 use Shaarli\Render\PageBuilder;
  20 use Shaarli\Render\PageCacheManager;
  21 use Shaarli\Security\CookieManager;
  22 use Shaarli\Security\LoginManager;
  23 use Shaarli\Security\SessionManager;
  24 use Shaarli\Thumbnailer;
  25 use Shaarli\Updater\Updater;
  26 use Shaarli\Updater\UpdaterUtils;
  27
  28 /**
  29  * Class ContainerBuilder
  30  *
  31  * Helper used to build a Slim container instance with Shaarli's object dependencies.
  32  * Note that most injected objects MUST be added as closures, to let the container instantiate
  33  * only the objects it requires during the execution.
  34  *
  35  * @package Container
  36  */
  37 class ContainerBuilder
  38 {
  39     /** @var ConfigManager */
  40     protected $conf;
  41
  42     /** @var SessionManager */
  43     protected $session;
  44
  45     /** @var CookieManager */
  46     protected $cookieManager;
  47
  48     /** @var LoginManager */
  49     protected $login;
  50
  51     /** @var string|null */
  52     protected $basePath = null;
  53
  54     public function __construct(
  55         ConfigManager $conf,
  56         SessionManager $session,
  57         CookieManager $cookieManager,
  58         LoginManager $login
  59     ) {
  60         $this->conf = $conf;
  61         $this->session = $session;
  62         $this->login = $login;
  63         $this->cookieManager = $cookieManager;
  64     }
  65
  66     public function build(): ShaarliContainer
  67     {
  68         $container = new ShaarliContainer();
  69
  70         $container['conf'] = $this->conf;
  71         $container['sessionManager'] = $this->session;
  72         $container['cookieManager'] = $this->cookieManager;
  73         $container['loginManager'] = $this->login;
  74         $container['basePath'] = $this->basePath;
  75
  76         $container['plugins'] = function (ShaarliContainer $container): PluginManager {
  77             return new PluginManager($container->conf);
  78         };
  79
  80         $container['history'] = function (ShaarliContainer $container): History {
  81             return new History($container->conf->get('resource.history'));
  82         };
  83
  84         $container['bookmarkService'] = function (ShaarliContainer $container): BookmarkServiceInterface {
  85             return new BookmarkFileService(
  86                 $container->conf,
  87                 $container->history,
  88                 new FlockMutex(fopen(SHAARLI_MUTEX_FILE, 'r'), 2),
  89                 $container->loginManager->isLoggedIn()
  90             );
  91         };
  92
  93         $container['pageBuilder'] = function (ShaarliContainer $container): PageBuilder {
  94             return new PageBuilder(
  95                 $container->conf,
  96                 $container->sessionManager->getSession(),
  97                 $container->bookmarkService,
  98                 $container->sessionManager->generateToken(),
  99                 $container->loginManager->isLoggedIn()
 100             );
 101         };
 102
 103         $container['pluginManager'] = function (ShaarliContainer $container): PluginManager {
 104             $pluginManager = new PluginManager($container->conf);
 105
 106             $pluginManager->load($container->conf->get('general.enabled_plugins'));
 107
 108             return $pluginManager;
 109         };
 110
 111         $container['formatterFactory'] = function (ShaarliContainer $container): FormatterFactory {
 112             return new FormatterFactory(
 113                 $container->conf,
 114                 $container->loginManager->isLoggedIn()
 115             );
 116         };
 117
 118         $container['pageCacheManager'] = function (ShaarliContainer $container): PageCacheManager {
 119             return new PageCacheManager(
 120                 $container->conf->get('resource.page_cache'),
 121                 $container->loginManager->isLoggedIn()
 122             );
 123         };
 124
 125         $container['feedBuilder'] = function (ShaarliContainer $container): FeedBuilder {
 126             return new FeedBuilder(
 127                 $container->bookmarkService,
 128                 $container->formatterFactory->getFormatter(),
 129                 $container->environment,
 130                 $container->loginManager->isLoggedIn()
 131             );
 132         };
 133
 134         $container['thumbnailer'] = function (ShaarliContainer $container): Thumbnailer {
 135             return new Thumbnailer($container->conf);
 136         };
 137
 138         $container['httpAccess'] = function (): HttpAccess {
 139             return new HttpAccess();
 140         };
 141
 142         $container['netscapeBookmarkUtils'] = function (ShaarliContainer $container): NetscapeBookmarkUtils {
 143             return new NetscapeBookmarkUtils($container->bookmarkService, $container->conf, $container->history);
 144         };
 145
 146         $container['updater'] = function (ShaarliContainer $container): Updater {
 147             return new Updater(
 148                 UpdaterUtils::read_updates_file($container->conf->get('resource.updates')),
 149                 $container->bookmarkService,
 150                 $container->conf,
 151                 $container->loginManager->isLoggedIn()
 152             );
 153         };
 154
 155         $container['notFoundHandler'] = function (ShaarliContainer $container): ErrorNotFoundController {
 156             return new ErrorNotFoundController($container);
 157         };
 158         $container['errorHandler'] = function (ShaarliContainer $container): ErrorController {
 159             return new ErrorController($container);
 160         };
 161         $container['phpErrorHandler'] = function (ShaarliContainer $container): ErrorController {
 162             return new ErrorController($container);
 163         };
 164
 165         return $container;
 166     }
 167 }