-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
Bootstrap.php
443 lines (410 loc) · 12.8 KB
/
Bootstrap.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<?php
/**
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\App;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\AppInterface;
use Magento\Framework\Autoload\AutoloaderRegistry;
use Magento\Framework\Autoload\Populator;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Filesystem\DriverPool;
use Magento\Framework\Profiler;
use Magento\Framework\Config\File\ConfigFilePool;
/**
* A bootstrap of Magento application
*
* Performs basic initialization root function: injects init parameters and creates object manager
* Can create/run applications
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Bootstrap
{
/**#@+
* Possible errors that can be triggered by the bootstrap
*/
const ERR_MAINTENANCE = 901;
const ERR_IS_INSTALLED = 902;
/**#@- */
/**#@+
* Initialization parameters that allow control bootstrap behavior of asserting maintenance mode or is installed
*
* Possible values:
* - true -- set expectation that it is required
* - false -- set expectation that is required not to
* - null -- bypass the assertion completely
*
* If key is absent in the parameters array, the default behavior will be used
* @see DEFAULT_REQUIRE_MAINTENANCE
* @see DEFAULT_REQUIRE_IS_INSTALLED
*/
const PARAM_REQUIRE_MAINTENANCE = 'MAGE_REQUIRE_MAINTENANCE';
const PARAM_REQUIRE_IS_INSTALLED = 'MAGE_REQUIRE_IS_INSTALLED';
/**#@- */
/**#@+
* Default behavior of bootstrap assertions
*/
const DEFAULT_REQUIRE_MAINTENANCE = false;
const DEFAULT_REQUIRE_IS_INSTALLED = true;
/**#@- */
/**
* Initialization parameter for custom directory paths
*/
const INIT_PARAM_FILESYSTEM_DIR_PATHS = 'MAGE_DIRS';
/**
* Initialization parameter for additional filesystem drivers
*/
const INIT_PARAM_FILESYSTEM_DRIVERS = 'MAGE_FILESYSTEM_DRIVERS';
/**
* The initialization parameters (normally come from the $_SERVER)
*
* @var array
*/
private $server;
/**
* Root directory
*
* @var string
*/
private $rootDir;
/**
* Object manager
*
* @var \Magento\Framework\ObjectManagerInterface
*/
private $objectManager;
/**
* Maintenance mode manager
*
* @var \Magento\Framework\App\MaintenanceMode
*/
private $maintenance;
/**
* Bootstrap-specific error code that may have been set in runtime
*
* @var int
*/
private $errorCode = 0;
/**
* Attribute for creating object manager
*
* @var ObjectManagerFactory
*/
private $factory;
/**
* Static method so that client code does not have to create Object Manager Factory every time Bootstrap is called
*
* @param string $rootDir
* @param array $initParams
* @param ObjectManagerFactory $factory
* @return Bootstrap
*/
public static function create($rootDir, array $initParams, ObjectManagerFactory $factory = null)
{
self::populateAutoloader($rootDir, $initParams);
if ($factory === null) {
$factory = self::createObjectManagerFactory($rootDir, $initParams);
}
return new self($factory, $rootDir, $initParams);
}
/**
* Populates autoloader with mapping info
*
* @param string $rootDir
* @param array $initParams
* @return void
*/
public static function populateAutoloader($rootDir, $initParams)
{
$dirList = self::createFilesystemDirectoryList($rootDir, $initParams);
$autoloadWrapper = AutoloaderRegistry::getAutoloader();
Populator::populateMappings($autoloadWrapper, $dirList, new ComponentRegistrar());
}
/**
* Creates instance of object manager factory
*
* @param string $rootDir
* @param array $initParams
* @return ObjectManagerFactory
*/
public static function createObjectManagerFactory($rootDir, array $initParams)
{
$dirList = self::createFilesystemDirectoryList($rootDir, $initParams);
$driverPool = self::createFilesystemDriverPool($initParams);
$configFilePool = self::createConfigFilePool();
return new ObjectManagerFactory($dirList, $driverPool, $configFilePool);
}
/**
* Creates instance of filesystem directory list
*
* @param string $rootDir
* @param array $initParams
* @return DirectoryList
*/
public static function createFilesystemDirectoryList($rootDir, array $initParams)
{
$customDirs = [];
if (isset($initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS])) {
$customDirs = $initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS];
}
return new DirectoryList($rootDir, $customDirs);
}
/**
* Creates instance of filesystem driver pool
*
* @param array $initParams
* @return DriverPool
*/
public static function createFilesystemDriverPool(array $initParams)
{
$extraDrivers = [];
if (isset($initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DRIVERS])) {
$extraDrivers = $initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DRIVERS];
};
return new DriverPool($extraDrivers);
}
/**
* Creates instance of configuration files pool
*
* @return DriverPool
*/
public static function createConfigFilePool()
{
return new ConfigFilePool();
}
/**
* Constructor
*
* @param ObjectManagerFactory $factory
* @param string $rootDir
* @param array $initParams
*/
public function __construct(ObjectManagerFactory $factory, $rootDir, array $initParams)
{
$this->factory = $factory;
$this->rootDir = $rootDir;
$this->server = $initParams;
}
/**
* Gets the current parameters
*
* @return array
*/
public function getParams()
{
return $this->server;
}
/**
* Factory method for creating application instances
*
* @param string $type
* @param array $arguments
* @return \Magento\Framework\AppInterface
* @throws \InvalidArgumentException
*/
public function createApplication($type, $arguments = [])
{
try {
$this->initObjectManager();
$application = $this->objectManager->create($type, $arguments);
if (!($application instanceof AppInterface)) {
throw new \InvalidArgumentException("The provided class doesn't implement AppInterface: {$type}");
}
return $application;
} catch (\Exception $e) {
$this->terminate($e);
}
}
/**
* Runs an application
*
* @param \Magento\Framework\AppInterface $application
* @return void
*/
public function run(AppInterface $application)
{
try {
try {
\Magento\Framework\Profiler::start('magento');
$this->initErrorHandler();
$this->initObjectManager();
$this->assertMaintenance();
$this->assertInstalled();
$response = $application->launch();
$response->sendResponse();
\Magento\Framework\Profiler::stop('magento');
} catch (\Exception $e) {
\Magento\Framework\Profiler::stop('magento');
if (!$application->catchException($this, $e)) {
throw $e;
}
}
} catch (\Exception $e) {
$this->terminate($e);
}
}
/**
* Asserts maintenance mode
*
* @return void
* @throws \Exception
*/
protected function assertMaintenance()
{
$isExpected = $this->getIsExpected(self::PARAM_REQUIRE_MAINTENANCE, self::DEFAULT_REQUIRE_MAINTENANCE);
if (null === $isExpected) {
return;
}
$this->initObjectManager();
/** @var \Magento\Framework\App\MaintenanceMode $maintenance */
$this->maintenance = $this->objectManager->get('Magento\Framework\App\MaintenanceMode');
$isOn = $this->maintenance->isOn(isset($this->server['REMOTE_ADDR']) ? $this->server['REMOTE_ADDR'] : '');
if ($isOn && !$isExpected) {
$this->errorCode = self::ERR_MAINTENANCE;
throw new \Exception('Unable to proceed: the maintenance mode is enabled. ');
}
if (!$isOn && $isExpected) {
$this->errorCode = self::ERR_MAINTENANCE;
throw new \Exception('Unable to proceed: the maintenance mode must be enabled first. ');
}
}
/**
* Asserts whether application is installed
*
* @return void
* @throws \Exception
*/
protected function assertInstalled()
{
$isExpected = $this->getIsExpected(self::PARAM_REQUIRE_IS_INSTALLED, self::DEFAULT_REQUIRE_IS_INSTALLED);
if (null === $isExpected) {
return;
}
$this->initObjectManager();
$isInstalled = $this->isInstalled();
if (!$isInstalled && $isExpected) {
$this->errorCode = self::ERR_IS_INSTALLED;
throw new \Exception('Error: Application is not installed yet. ');
}
if ($isInstalled && !$isExpected) {
$this->errorCode = self::ERR_IS_INSTALLED;
throw new \Exception('Error: Application is already installed. ');
}
}
/**
* Analyze a key in the initialization parameters as "is expected" parameter
*
* If there is no such key, returns default value. Otherwise casts it to boolean, unless it is null
*
* @param string $key
* @param bool $default
* @return bool|null
*/
private function getIsExpected($key, $default)
{
if (array_key_exists($key, $this->server)) {
if (isset($this->server[$key])) {
return (bool)(int)$this->server[$key];
}
return null;
}
return $default;
}
/**
* Determines whether application is installed
*
* @return bool
*/
private function isInstalled()
{
$this->initObjectManager();
/** @var \Magento\Framework\App\DeploymentConfig $deploymentConfig */
$deploymentConfig = $this->objectManager->get('Magento\Framework\App\DeploymentConfig');
return $deploymentConfig->isAvailable();
}
/**
* Gets the object manager instance
*
* @return \Magento\Framework\ObjectManagerInterface
*/
public function getObjectManager()
{
$this->initObjectManager();
return $this->objectManager;
}
/**
* Sets a custom error handler
*
* @return void
*/
private function initErrorHandler()
{
$handler = new ErrorHandler();
set_error_handler([$handler, 'handler']);
}
/**
* Initializes object manager
*
* @return void
*/
private function initObjectManager()
{
if (!$this->objectManager) {
$this->objectManager = $this->factory->create($this->server);
$this->maintenance = $this->objectManager->get('Magento\Framework\App\MaintenanceMode');
}
}
/**
* Getter for error code
*
* @return int
*/
public function getErrorCode()
{
return $this->errorCode;
}
/**
* Checks whether developer mode is set in the initialization parameters
*
* @return bool
*/
public function isDeveloperMode()
{
if (isset($this->server[State::PARAM_MODE]) && $this->server[State::PARAM_MODE] == State::MODE_DEVELOPER) {
return true;
}
/** @var \Magento\Framework\App\DeploymentConfig $deploymentConfig */
$deploymentConfig = $this->getObjectManager()->get('Magento\Framework\App\DeploymentConfig');
if ($deploymentConfig->get(State::PARAM_MODE) == State::MODE_DEVELOPER) {
return true;
}
return false;
}
/**
* Display an exception and terminate program execution
*
* @param \Exception $e
* @return void
* @SuppressWarnings(PHPMD.ExitExpression)
*/
protected function terminate(\Exception $e)
{
if ($this->isDeveloperMode()) {
echo $e;
} else {
$message = "An error has happened during application run. See exception log for details.\n";
try {
if (!$this->objectManager) {
throw new \DomainException();
}
$this->objectManager->get('Psr\Log\LoggerInterface')->critical($e);
} catch (\Exception $e) {
$message .= "Could not write error message to log. Please use developer mode to see the message.\n";
}
echo $message;
}
exit(1);
}
}