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