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