]>
Commit | Line | Data |
---|---|---|
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 LoggerInterface */ | |
54 | protected $logger; | |
55 | ||
56 | /** @var string|null */ | |
57 | protected $basePath = null; | |
58 | ||
59 | public function __construct( | |
60 | ConfigManager $conf, | |
61 | SessionManager $session, | |
62 | CookieManager $cookieManager, | |
63 | LoginManager $login, | |
64 | LoggerInterface $logger | |
65 | ) { | |
66 | $this->conf = $conf; | |
67 | $this->session = $session; | |
68 | $this->login = $login; | |
69 | $this->cookieManager = $cookieManager; | |
70 | $this->logger = $logger; | |
71 | } | |
72 | ||
73 | public function build(): ShaarliContainer | |
74 | { | |
75 | $container = new ShaarliContainer(); | |
76 | ||
77 | $container['conf'] = $this->conf; | |
78 | $container['sessionManager'] = $this->session; | |
79 | $container['cookieManager'] = $this->cookieManager; | |
80 | $container['loginManager'] = $this->login; | |
81 | $container['logger'] = $this->logger; | |
82 | $container['basePath'] = $this->basePath; | |
83 | ||
84 | $container['plugins'] = function (ShaarliContainer $container): PluginManager { | |
85 | return new PluginManager($container->conf); | |
86 | }; | |
87 | ||
88 | $container['history'] = function (ShaarliContainer $container): History { | |
89 | return new History($container->conf->get('resource.history')); | |
90 | }; | |
91 | ||
92 | $container['bookmarkService'] = function (ShaarliContainer $container): BookmarkServiceInterface { | |
93 | return new BookmarkFileService( | |
94 | $container->conf, | |
95 | $container->history, | |
96 | new FlockMutex(fopen(SHAARLI_MUTEX_FILE, 'r'), 2), | |
97 | $container->loginManager->isLoggedIn() | |
98 | ); | |
99 | }; | |
100 | ||
101 | $container['metadataRetriever'] = function (ShaarliContainer $container): MetadataRetriever { | |
102 | return new MetadataRetriever($container->conf, $container->httpAccess); | |
103 | }; | |
104 | ||
105 | $container['pageBuilder'] = function (ShaarliContainer $container): PageBuilder { | |
106 | return new PageBuilder( | |
107 | $container->conf, | |
108 | $container->sessionManager->getSession(), | |
109 | $container->logger, | |
110 | $container->bookmarkService, | |
111 | $container->sessionManager->generateToken(), | |
112 | $container->loginManager->isLoggedIn() | |
113 | ); | |
114 | }; | |
115 | ||
116 | $container['pluginManager'] = function (ShaarliContainer $container): PluginManager { | |
117 | $pluginManager = new PluginManager($container->conf); | |
118 | ||
119 | $pluginManager->load($container->conf->get('general.enabled_plugins')); | |
120 | ||
121 | return $pluginManager; | |
122 | }; | |
123 | ||
124 | $container['formatterFactory'] = function (ShaarliContainer $container): FormatterFactory { | |
125 | return new FormatterFactory( | |
126 | $container->conf, | |
127 | $container->loginManager->isLoggedIn() | |
128 | ); | |
129 | }; | |
130 | ||
131 | $container['pageCacheManager'] = function (ShaarliContainer $container): PageCacheManager { | |
132 | return new PageCacheManager( | |
133 | $container->conf->get('resource.page_cache'), | |
134 | $container->loginManager->isLoggedIn() | |
135 | ); | |
136 | }; | |
137 | ||
138 | $container['feedBuilder'] = function (ShaarliContainer $container): FeedBuilder { | |
139 | return new FeedBuilder( | |
140 | $container->bookmarkService, | |
141 | $container->formatterFactory->getFormatter(), | |
142 | $container->environment, | |
143 | $container->loginManager->isLoggedIn() | |
144 | ); | |
145 | }; | |
146 | ||
147 | $container['thumbnailer'] = function (ShaarliContainer $container): Thumbnailer { | |
148 | return new Thumbnailer($container->conf); | |
149 | }; | |
150 | ||
151 | $container['httpAccess'] = function (): HttpAccess { | |
152 | return new HttpAccess(); | |
153 | }; | |
154 | ||
155 | $container['netscapeBookmarkUtils'] = function (ShaarliContainer $container): NetscapeBookmarkUtils { | |
156 | return new NetscapeBookmarkUtils($container->bookmarkService, $container->conf, $container->history); | |
157 | }; | |
158 | ||
159 | $container['updater'] = function (ShaarliContainer $container): Updater { | |
160 | return new Updater( | |
161 | UpdaterUtils::read_updates_file($container->conf->get('resource.updates')), | |
162 | $container->bookmarkService, | |
163 | $container->conf, | |
164 | $container->loginManager->isLoggedIn() | |
165 | ); | |
166 | }; | |
167 | ||
168 | $container['notFoundHandler'] = function (ShaarliContainer $container): ErrorNotFoundController { | |
169 | return new ErrorNotFoundController($container); | |
170 | }; | |
171 | $container['errorHandler'] = function (ShaarliContainer $container): ErrorController { | |
172 | return new ErrorController($container); | |
173 | }; | |
174 | $container['phpErrorHandler'] = function (ShaarliContainer $container): ErrorController { | |
175 | return new ErrorController($container); | |
176 | }; | |
177 | ||
178 | return $container; | |
179 | } | |
180 | } |