Application.php 17.9 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

8 9
namespace yii\base;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\helpers\Console;
Qiang Xue committed
12
use yii\web\HttpException;
.  
Qiang Xue committed
13

w  
Qiang Xue committed
14 15 16
/**
 * Application is the base class for all application classes.
 *
17
 * @property \yii\rbac\Manager $authManager The auth manager for this application. This property is read-only.
18
 * @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled.
19 20 21 22
 * This property is read-only.
 * @property \yii\db\Connection $db The database connection. This property is read-only.
 * @property ErrorHandler $errorHandler The error handler application component. This property is read-only.
 * @property \yii\base\Formatter $formatter The formatter application component. This property is read-only.
23
 * @property \yii\i18n\I18N $i18n The internationalization component. This property is read-only.
24 25 26 27
 * @property \yii\log\Logger $log The log component. This property is read-only.
 * @property \yii\web\Request|\yii\console\Request $request The request component. This property is read-only.
 * @property string $runtimePath The directory that stores runtime files. Defaults to the "runtime"
 * subdirectory under [[basePath]].
28
 * @property string $timeZone The time zone used by this application.
29 30 31 32 33
 * @property string $uniqueId The unique ID of the module. This property is read-only.
 * @property \yii\web\UrlManager $urlManager The URL manager for this application. This property is read-only.
 * @property string $vendorPath The directory that stores vendor files. Defaults to "vendor" directory under
 * [[basePath]].
 * @property View $view The view object that is used to render various view files. This property is read-only.
34
 *
w  
Qiang Xue committed
35 36
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
w  
Qiang Xue committed
37
 */
38
abstract class Application extends Module
w  
Qiang Xue committed
39
{
Qiang Xue committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
	/**
	 * @event Event an event raised before the application starts to handle a request.
	 */
	const EVENT_BEFORE_REQUEST = 'beforeRequest';
	/**
	 * @event Event an event raised after the application successfully handles a request (before the response is sent out).
	 */
	const EVENT_AFTER_REQUEST = 'afterRequest';
	/**
	 * @event ActionEvent an event raised before executing a controller action.
	 * You may set [[ActionEvent::isValid]] to be false to cancel the action execution.
	 */
	const EVENT_BEFORE_ACTION = 'beforeAction';
	/**
	 * @event ActionEvent an event raised after executing a controller action.
	 */
	const EVENT_AFTER_ACTION = 'afterAction';
57 58 59 60 61 62 63

	/**
	 * @var string the namespace that controller classes are in. If not set,
	 * it will use the "app\controllers" namespace.
	 */
	public $controllerNamespace = 'app\\controllers';

w  
Qiang Xue committed
64
	/**
Qiang Xue committed
65
	 * @var string the application name.
w  
Qiang Xue committed
66 67
	 */
	public $name = 'My Application';
Qiang Xue committed
68
	/**
Qiang Xue committed
69
	 * @var string the version of this application.
Qiang Xue committed
70 71
	 */
	public $version = '1.0';
w  
Qiang Xue committed
72
	/**
Qiang Xue committed
73
	 * @var string the charset currently used for the application.
w  
Qiang Xue committed
74 75
	 */
	public $charset = 'UTF-8';
Qiang Xue committed
76 77 78 79 80
	/**
	 * @var string the language that is meant to be used for end users.
	 * @see sourceLanguage
	 */
	public $language = 'en_US';
w  
Qiang Xue committed
81 82
	/**
	 * @var string the language that the application is written in. This mainly refers to
Qiang Xue committed
83
	 * the language that the messages and view files are written in.
.  
Qiang Xue committed
84
	 * @see language
w  
Qiang Xue committed
85
	 */
Qiang Xue committed
86
	public $sourceLanguage = 'en_US';
Qiang Xue committed
87
	/**
88
	 * @var Controller the currently active controller instance
Qiang Xue committed
89 90
	 */
	public $controller;
Qiang Xue committed
91
	/**
92
	 * @var string|boolean the layout that should be applied for views in this application. Defaults to 'main'.
Qiang Xue committed
93 94 95
	 * If this is false, layout will be disabled.
	 */
	public $layout = 'main';
96 97 98 99 100 101
	/**
	 * @var integer the size of the reserved memory. A portion of memory is pre-allocated so that
	 * when an out-of-memory issue occurs, the error handler is able to handle the error with
	 * the help of this reserved memory. If you set this value to be 0, no memory will be reserved.
	 * Defaults to 256KB.
	 */
102
	public $memoryReserveSize = 262144;
Qiang Xue committed
103 104 105 106 107 108 109 110 111 112 113 114
	/**
	 * @var string the requested route
	 */
	public $requestedRoute;
	/**
	 * @var Action the requested Action. If null, it means the request cannot be resolved into an action.
	 */
	public $requestedAction;
	/**
	 * @var array the parameters supplied to the requested action.
	 */
	public $requestedParams;
Qiang Xue committed
115 116 117 118 119 120 121 122 123 124 125 126
	/**
	 * @var array list of installed Yii extensions. Each array element represents a single extension
	 * with the following structure:
	 *
	 * ~~~
	 * [
	 *     'name' => 'extension name',
	 *     'version' => 'version number',
	 *     'bootstrap' => 'BootstrapClassName',
	 * ]
	 * ~~~
	 */
127
	public $extensions = [];
w  
Qiang Xue committed
128

129
	/**
Alexander Makarov committed
130
	 * @var string Used to reserve memory for fatal error handler.
131 132 133
	 */
	private $_memoryReserve;

w  
Qiang Xue committed
134 135
	/**
	 * Constructor.
136 137
	 * @param array $config name-value pairs that will be used to initialize the object properties.
	 * Note that the configuration must contain both [[id]] and [[basePath]].
138
	 * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing.
w  
Qiang Xue committed
139
	 */
Alexander Makarov committed
140
	public function __construct($config = [])
w  
Qiang Xue committed
141
	{
Qiang Xue committed
142
		Yii::$app = $this;
143

144 145 146 147 148 149 150 151 152 153
		$this->preInit($config);
		$this->registerErrorHandlers();
		$this->registerCoreComponents();

		Component::__construct($config);
	}

	/**
	 * Pre-initializes the application.
	 * This method is called at the beginning of the application constructor.
154 155
	 * It initializes several important application properties.
	 * If you override this method, please make sure you call the parent implementation.
156
	 * @param array $config the application configuration
157
	 * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing.
158
	 */
159
	public function preInit(&$config)
160
	{
161 162 163 164 165 166 167 168 169 170
		if (!isset($config['id'])) {
			throw new InvalidConfigException('The "id" configuration is required.');
		}
		if (isset($config['basePath'])) {
			$this->setBasePath($config['basePath']);
			unset($config['basePath']);
		} else {
			throw new InvalidConfigException('The "basePath" configuration is required.');
		}

171 172
		if (isset($config['vendorPath'])) {
			$this->setVendorPath($config['vendorPath']);
173
			unset($config['vendorPath']);
174 175 176
		} else {
			// set "@vendor"
			$this->getVendorPath();
177
		}
178 179 180 181 182 183
		if (isset($config['runtimePath'])) {
			$this->setRuntimePath($config['runtimePath']);
			unset($config['runtimePath']);
		} else {
			// set "@runtime"
			$this->getRuntimePath();
184
		}
185

186 187 188 189 190
		if (isset($config['timeZone'])) {
			$this->setTimeZone($config['timeZone']);
			unset($config['timeZone']);
		} elseif (!ini_get('date.timezone')) {
			$this->setTimeZone('UTC');
191
		}
.  
Qiang Xue committed
192
	}
w  
Qiang Xue committed
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
	/**
	 * @inheritdoc
	 */
	public function init()
	{
		parent::init();
		$this->initExtensions($this->extensions);
	}

	/**
	 * Initializes the extensions.
	 * @param array $extensions the extensions to be initialized. Please refer to [[extensions]]
	 * for the structure of the extension array.
	 */
	protected function initExtensions($extensions)
	{
		foreach ($extensions as $extension) {
			if (isset($extension['bootstrap'])) {
				/** @var Extension $class */
				$class = $extension['bootstrap'];
				$class::init();
			}
		}
	}

Qiang Xue committed
219 220 221 222 223 224 225 226 227 228
	/**
	 * Loads components that are declared in [[preload]].
	 * @throws InvalidConfigException if a component or module to be preloaded is unknown
	 */
	public function preloadComponents()
	{
		$this->getComponent('log');
		parent::preloadComponents();
	}

.  
Qiang Xue committed
229
	/**
Qiang Xue committed
230
	 * Registers error handlers.
.  
Qiang Xue committed
231
	 */
Qiang Xue committed
232
	public function registerErrorHandlers()
.  
Qiang Xue committed
233
	{
Qiang Xue committed
234
		if (YII_ENABLE_ERROR_HANDLER) {
235
			ini_set('display_errors', 0);
Alexander Makarov committed
236 237
			set_exception_handler([$this, 'handleException']);
			set_error_handler([$this, 'handleError'], error_reporting());
238 239
			if ($this->memoryReserveSize > 0) {
				$this->_memoryReserve = str_repeat('x', $this->memoryReserveSize);
240
			}
Alexander Makarov committed
241
			register_shutdown_function([$this, 'handleFatalError']);
Qiang Xue committed
242
		}
w  
Qiang Xue committed
243 244
	}

Qiang Xue committed
245 246 247 248 249 250 251 252 253 254
	/**
	 * Returns an ID that uniquely identifies this module among all modules within the current application.
	 * Since this is an application instance, it will always return an empty string.
	 * @return string the unique ID of the module.
	 */
	public function getUniqueId()
	{
		return '';
	}

255 256 257 258 259 260 261 262 263 264 265 266
	/**
	 * Sets the root directory of the applicaition and the @app alias.
	 * This method can only be invoked at the beginning of the constructor.
	 * @param string $path the root directory of the application.
	 * @throws InvalidParamException if the directory does not exist.
	 */
	public function setBasePath($path)
	{
		parent::setBasePath($path);
		Yii::setAlias('@app', $this->getBasePath());
	}

Qiang Xue committed
267 268 269 270 271 272 273
	/**
	 * Runs the application.
	 * This is the main entrance of an application.
	 * @return integer the exit status (0 means normal, non-zero values mean abnormal)
	 */
	public function run()
	{
Qiang Xue committed
274
		$this->trigger(self::EVENT_BEFORE_REQUEST);
275
		$response = $this->handleRequest($this->getRequest());
Qiang Xue committed
276
		$this->trigger(self::EVENT_AFTER_REQUEST);
277
		$response->send();
278
		return $response->exitStatus;
Qiang Xue committed
279 280
	}

w  
Qiang Xue committed
281
	/**
282 283 284 285 286 287 288
	 * Handles the specified request.
	 *
	 * This method should return an instance of [[Response]] or its child class
	 * which represents the handling result of the request.
	 *
	 * @param Request $request the request to be handled
	 * @return Response the resulting response
Qiang Xue committed
289
	 */
290
	abstract public function handleRequest($request);
291

292

Qiang Xue committed
293 294
	private $_runtimePath;

w  
Qiang Xue committed
295 296
	/**
	 * Returns the directory that stores runtime files.
297 298
	 * @return string the directory that stores runtime files.
	 * Defaults to the "runtime" subdirectory under [[basePath]].
w  
Qiang Xue committed
299 300 301
	 */
	public function getRuntimePath()
	{
Qiang Xue committed
302
		if ($this->_runtimePath === null) {
w  
Qiang Xue committed
303 304
			$this->setRuntimePath($this->getBasePath() . DIRECTORY_SEPARATOR . 'runtime');
		}
Qiang Xue committed
305
		return $this->_runtimePath;
w  
Qiang Xue committed
306 307 308 309 310 311 312 313
	}

	/**
	 * Sets the directory that stores runtime files.
	 * @param string $path the directory that stores runtime files.
	 */
	public function setRuntimePath($path)
	{
314 315
		$this->_runtimePath = Yii::getAlias($path);
		Yii::setAlias('@runtime', $this->_runtimePath);
w  
Qiang Xue committed
316 317
	}

Qiang Xue committed
318 319 320 321
	private $_vendorPath;

	/**
	 * Returns the directory that stores vendor files.
322
	 * @return string the directory that stores vendor files.
323
	 * Defaults to "vendor" directory under [[basePath]].
Qiang Xue committed
324 325 326
	 */
	public function getVendorPath()
	{
Qiang Xue committed
327
		if ($this->_vendorPath === null) {
Qiang Xue committed
328 329 330 331 332 333 334 335 336 337 338
			$this->setVendorPath($this->getBasePath() . DIRECTORY_SEPARATOR . 'vendor');
		}
		return $this->_vendorPath;
	}

	/**
	 * Sets the directory that stores vendor files.
	 * @param string $path the directory that stores vendor files.
	 */
	public function setVendorPath($path)
	{
Qiang Xue committed
339
		$this->_vendorPath = Yii::getAlias($path);
340
		Yii::setAlias('@vendor', $this->_vendorPath);
Qiang Xue committed
341 342
	}

w  
Qiang Xue committed
343 344 345
	/**
	 * Returns the time zone used by this application.
	 * This is a simple wrapper of PHP function date_default_timezone_get().
346 347
	 * If time zone is not configured in php.ini or application config,
	 * it will be set to UTC by default.
w  
Qiang Xue committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
	 * @return string the time zone used by this application.
	 * @see http://php.net/manual/en/function.date-default-timezone-get.php
	 */
	public function getTimeZone()
	{
		return date_default_timezone_get();
	}

	/**
	 * Sets the time zone used by this application.
	 * This is a simple wrapper of PHP function date_default_timezone_set().
	 * @param string $value the time zone used by this application.
	 * @see http://php.net/manual/en/function.date-default-timezone-set.php
	 */
	public function setTimeZone($value)
	{
		date_default_timezone_set($value);
	}

	/**
	 * Returns the database connection component.
Qiang Xue committed
369
	 * @return \yii\db\Connection the database connection
w  
Qiang Xue committed
370 371 372 373 374 375
	 */
	public function getDb()
	{
		return $this->getComponent('db');
	}

Qiang Xue committed
376 377 378 379 380 381 382 383 384
	/**
	 * Returns the log component.
	 * @return \yii\log\Logger the log component
	 */
	public function getLog()
	{
		return $this->getComponent('log');
	}

w  
Qiang Xue committed
385 386
	/**
	 * Returns the error handler component.
.  
Qiang Xue committed
387
	 * @return ErrorHandler the error handler application component.
w  
Qiang Xue committed
388 389 390 391 392 393 394 395
	 */
	public function getErrorHandler()
	{
		return $this->getComponent('errorHandler');
	}

	/**
	 * Returns the cache component.
.  
Qiang Xue committed
396
	 * @return \yii\caching\Cache the cache application component. Null if the component is not enabled.
w  
Qiang Xue committed
397 398 399 400 401 402
	 */
	public function getCache()
	{
		return $this->getComponent('cache');
	}

403 404 405 406 407 408 409 410 411
	/**
	 * Returns the formatter component.
	 * @return \yii\base\Formatter the formatter application component.
	 */
	public function getFormatter()
	{
		return $this->getComponent('formatter');
	}

w  
Qiang Xue committed
412 413
	/**
	 * Returns the request component.
414
	 * @return \yii\web\Request|\yii\console\Request the request component
w  
Qiang Xue committed
415 416 417 418 419 420
	 */
	public function getRequest()
	{
		return $this->getComponent('request');
	}

Qiang Xue committed
421
	/**
Qiang Xue committed
422 423
	 * Returns the view object.
	 * @return View the view object that is used to render various view files.
Qiang Xue committed
424
	 */
Qiang Xue committed
425
	public function getView()
Qiang Xue committed
426
	{
Qiang Xue committed
427
		return $this->getComponent('view');
Qiang Xue committed
428 429
	}

Qiang Xue committed
430 431 432 433 434 435 436 437 438
	/**
	 * Returns the URL manager for this application.
	 * @return \yii\web\UrlManager the URL manager for this application.
	 */
	public function getUrlManager()
	{
		return $this->getComponent('urlManager');
	}

Qiang Xue committed
439 440 441 442
	/**
	 * Returns the internationalization (i18n) component
	 * @return \yii\i18n\I18N the internationalization component
	 */
443
	public function getI18n()
Qiang Xue committed
444 445 446 447
	{
		return $this->getComponent('i18n');
	}

Qiang Xue committed
448
	/**
449
	 * Returns the auth manager for this application.
450
	 * @return \yii\rbac\Manager the auth manager for this application.
Qiang Xue committed
451 452 453
	 */
	public function getAuthManager()
	{
454
		return $this->getComponent('authManager');
Qiang Xue committed
455 456
	}

w  
Qiang Xue committed
457 458 459 460
	/**
	 * Registers the core application components.
	 * @see setComponents
	 */
.  
Qiang Xue committed
461
	public function registerCoreComponents()
w  
Qiang Xue committed
462
	{
Alexander Makarov committed
463 464 465 466 467 468 469 470
		$this->setComponents([
			'log' => ['class' => 'yii\log\Logger'],
			'errorHandler' => ['class' => 'yii\base\ErrorHandler'],
			'formatter' => ['class' => 'yii\base\Formatter'],
			'i18n' => ['class' => 'yii\i18n\I18N'],
			'urlManager' => ['class' => 'yii\web\UrlManager'],
			'view' => ['class' => 'yii\base\View'],
		]);
w  
Qiang Xue committed
471
	}
Qiang Xue committed
472

473 474 475
	/**
	 * Handles uncaught PHP exceptions.
	 *
476
	 * This method is implemented as a PHP exception handler.
477
	 *
478
	 * @param \Exception $exception the exception that is not caught
479 480 481 482 483 484 485 486 487 488 489
	 */
	public function handleException($exception)
	{
		// disable error capturing to avoid recursive errors while handling exceptions
		restore_error_handler();
		restore_exception_handler();
		try {
			$this->logException($exception);
			if (($handler = $this->getErrorHandler()) !== null) {
				$handler->handle($exception);
			} else {
490
				echo $this->renderException($exception);
491 492
			}
		} catch (\Exception $e) {
493
			// exception could be thrown in ErrorHandler::handle()
494 495 496 497
			$msg = (string)$e;
			$msg .= "\nPrevious exception:\n";
			$msg .= (string)$exception;
			if (YII_DEBUG) {
498 499 500 501 502
				if (PHP_SAPI === 'cli') {
					echo $msg . "\n";
				} else {
					echo '<pre>' . htmlspecialchars($msg, ENT_QUOTES, $this->charset) . '</pre>';
				}
503 504 505 506 507 508 509
			}
			$msg .= "\n\$_SERVER = " . var_export($_SERVER, true);
			error_log($msg);
			exit(1);
		}
	}

Qiang Xue committed
510 511 512 513 514 515 516 517 518
	/**
	 * Handles PHP execution errors such as warnings, notices.
	 *
	 * This method is used as a PHP error handler. It will simply raise an `ErrorException`.
	 *
	 * @param integer $code the level of the error raised
	 * @param string $message the error message
	 * @param string $file the filename that the error was raised in
	 * @param integer $line the line number the error was raised at
519 520
	 *
	 * @throws ErrorException
Qiang Xue committed
521 522 523 524
	 */
	public function handleError($code, $message, $file, $line)
	{
		if (error_reporting() !== 0) {
525 526 527 528 529 530 531 532
			// load ErrorException manually here because autoloading them will not work
			// when error occurs while autoloading a class
			if (!class_exists('\\yii\\base\\Exception', false)) {
				require_once(__DIR__ . '/Exception.php');
			}
			if (!class_exists('\\yii\\base\\ErrorException', false)) {
				require_once(__DIR__ . '/ErrorException.php');
			}
533 534 535 536 537
			$exception = new ErrorException($message, $code, $code, $file, $line);

			// in case error appeared in __toString method we can't throw any exception
			$trace = debug_backtrace(false);
			array_shift($trace);
Qiang Xue committed
538 539
			foreach ($trace as $frame) {
				if ($frame['function'] == '__toString') {
540
					$this->handleException($exception);
541
					exit(1);
542 543 544 545
				}
			}

			throw $exception;
Qiang Xue committed
546 547 548 549
		}
	}

	/**
550
	 * Handles fatal PHP errors
Qiang Xue committed
551
	 */
552
	public function handleFatalError()
Qiang Xue committed
553
	{
554 555
		unset($this->_memoryReserve);

556 557 558 559 560 561 562 563 564
		// load ErrorException manually here because autoloading them will not work
		// when error occurs while autoloading a class
		if (!class_exists('\\yii\\base\\Exception', false)) {
			require_once(__DIR__ . '/Exception.php');
		}
		if (!class_exists('\\yii\\base\\ErrorException', false)) {
			require_once(__DIR__ . '/ErrorException.php');
		}

565 566 567 568 569 570
		$error = error_get_last();

		if (ErrorException::isFatalError($error)) {
			$exception = new ErrorException($error['message'], $error['type'], $error['type'], $error['file'], $error['line']);
			// use error_log because it's too late to use Yii log
			error_log($exception);
Qiang Xue committed
571

572 573 574 575
			if (($handler = $this->getErrorHandler()) !== null) {
				$handler->handle($exception);
			} else {
				echo $this->renderException($exception);
Qiang Xue committed
576
			}
577 578

			exit(1);
Qiang Xue committed
579 580 581
		}
	}

Qiang Xue committed
582 583 584
	/**
	 * Renders an exception without using rich format.
	 * @param \Exception $exception the exception to be rendered.
585
	 * @return string the rendering result
Qiang Xue committed
586 587 588
	 */
	public function renderException($exception)
	{
Qiang Xue committed
589
		if ($exception instanceof Exception && ($exception instanceof UserException || !YII_DEBUG)) {
Qiang Xue committed
590
			$message = $exception->getName() . ': ' . $exception->getMessage();
Qiang Xue committed
591 592 593
			if (Yii::$app->controller instanceof \yii\console\Controller) {
				$message = Yii::$app->controller->ansiFormat($message, Console::FG_RED);
			}
Qiang Xue committed
594 595 596
		} else {
			$message = YII_DEBUG ? (string)$exception : 'Error: ' . $exception->getMessage();
		}
597 598
		if (PHP_SAPI === 'cli') {
			return $message . "\n";
Qiang Xue committed
599
		} else {
600
			return '<pre>' . htmlspecialchars($message, ENT_QUOTES, $this->charset) . '</pre>';
Qiang Xue committed
601 602 603
		}
	}

604 605 606 607
	/**
	 * Logs the given exception
	 * @param \Exception $exception the exception to be logged
	 */
Qiang Xue committed
608 609 610 611 612 613 614 615 616 617 618 619
	protected function logException($exception)
	{
		$category = get_class($exception);
		if ($exception instanceof HttpException) {
			/** @var $exception HttpException */
			$category .= '\\' . $exception->statusCode;
		} elseif ($exception instanceof \ErrorException) {
			/** @var $exception \ErrorException */
			$category .= '\\' . $exception->getSeverity();
		}
		Yii::error((string)$exception, $category);
	}
w  
Qiang Xue committed
620
}