Application.php 16.3 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 23 24 25 26 27
 * 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.
 * @property \yii\i18n\I18N $i18N The internationalization component. This property is read-only.
 * @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';
w  
Qiang Xue committed
57
	/**
Qiang Xue committed
58
	 * @var string the application name.
w  
Qiang Xue committed
59 60
	 */
	public $name = 'My Application';
Qiang Xue committed
61
	/**
Qiang Xue committed
62
	 * @var string the version of this application.
Qiang Xue committed
63 64
	 */
	public $version = '1.0';
w  
Qiang Xue committed
65
	/**
Qiang Xue committed
66
	 * @var string the charset currently used for the application.
w  
Qiang Xue committed
67 68
	 */
	public $charset = 'UTF-8';
Qiang Xue committed
69 70 71 72 73
	/**
	 * @var string the language that is meant to be used for end users.
	 * @see sourceLanguage
	 */
	public $language = 'en_US';
w  
Qiang Xue committed
74 75
	/**
	 * @var string the language that the application is written in. This mainly refers to
Qiang Xue committed
76
	 * the language that the messages and view files are written in.
.  
Qiang Xue committed
77
	 * @see language
w  
Qiang Xue committed
78
	 */
Qiang Xue committed
79
	public $sourceLanguage = 'en_US';
Qiang Xue committed
80
	/**
Qiang Xue committed
81
	 * @var array IDs of the components that need to be loaded when the application starts.
Qiang Xue committed
82
	 */
Qiang Xue committed
83
	public $preload = array();
Qiang Xue committed
84
	/**
85
	 * @var Controller the currently active controller instance
Qiang Xue committed
86 87
	 */
	public $controller;
Qiang Xue committed
88
	/**
89
	 * @var string|boolean the layout that should be applied for views in this application. Defaults to 'main'.
Qiang Xue committed
90 91 92
	 * If this is false, layout will be disabled.
	 */
	public $layout = 'main';
93 94 95 96 97 98
	/**
	 * @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.
	 */
99
	public $memoryReserveSize = 262144;
Qiang Xue committed
100 101 102 103 104 105 106 107 108 109 110 111
	/**
	 * @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;
w  
Qiang Xue committed
112

113
	/**
Alexander Makarov committed
114
	 * @var string Used to reserve memory for fatal error handler.
115 116 117
	 */
	private $_memoryReserve;

w  
Qiang Xue committed
118 119
	/**
	 * Constructor.
120 121
	 * @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]].
122
	 * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing.
w  
Qiang Xue committed
123
	 */
124
	public function __construct($config = array())
w  
Qiang Xue committed
125
	{
Qiang Xue committed
126
		Yii::$app = $this;
127 128 129 130 131 132 133 134 135
		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.');
		}
136

137 138 139 140 141 142 143 144 145 146 147 148 149
		$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.
	 * @param array $config the application configuration
	 */
150
	public function preInit(&$config)
151
	{
152 153
		if (isset($config['vendorPath'])) {
			$this->setVendorPath($config['vendorPath']);
154
			unset($config['vendorPath']);
155 156 157
		} else {
			// set "@vendor"
			$this->getVendorPath();
158
		}
159 160 161 162 163 164
		if (isset($config['runtimePath'])) {
			$this->setRuntimePath($config['runtimePath']);
			unset($config['runtimePath']);
		} else {
			// set "@runtime"
			$this->getRuntimePath();
165
		}
166 167 168 169 170
		if (isset($config['timeZone'])) {
			$this->setTimeZone($config['timeZone']);
			unset($config['timeZone']);
		} elseif (!ini_get('date.timezone')) {
			$this->setTimeZone('UTC');
171
		}
.  
Qiang Xue committed
172
	}
w  
Qiang Xue committed
173

Qiang Xue committed
174 175 176 177 178 179 180 181 182 183
	/**
	 * 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
184
	/**
Qiang Xue committed
185
	 * Registers error handlers.
.  
Qiang Xue committed
186
	 */
Qiang Xue committed
187
	public function registerErrorHandlers()
.  
Qiang Xue committed
188
	{
Qiang Xue committed
189
		if (YII_ENABLE_ERROR_HANDLER) {
190
			ini_set('display_errors', 0);
Qiang Xue committed
191 192
			set_exception_handler(array($this, 'handleException'));
			set_error_handler(array($this, 'handleError'), error_reporting());
193 194
			if ($this->memoryReserveSize > 0) {
				$this->_memoryReserve = str_repeat('x', $this->memoryReserveSize);
195
			}
Qiang Xue committed
196
			register_shutdown_function(array($this, 'handleFatalError'));
Qiang Xue committed
197
		}
w  
Qiang Xue committed
198 199
	}

Qiang Xue committed
200 201 202 203 204 205 206 207 208 209
	/**
	 * 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 '';
	}

Qiang Xue committed
210 211 212 213 214 215 216
	/**
	 * 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
217
		$this->trigger(self::EVENT_BEFORE_REQUEST);
218
		$response = $this->handleRequest($this->getRequest());
Qiang Xue committed
219
		$this->trigger(self::EVENT_AFTER_REQUEST);
220
		$response->send();
221
		return $response->exitStatus;
Qiang Xue committed
222 223
	}

w  
Qiang Xue committed
224
	/**
225 226 227 228 229 230 231
	 * 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
232
	 */
233
	abstract public function handleRequest($request);
234

235

Qiang Xue committed
236 237
	private $_runtimePath;

w  
Qiang Xue committed
238 239
	/**
	 * Returns the directory that stores runtime files.
240 241
	 * @return string the directory that stores runtime files.
	 * Defaults to the "runtime" subdirectory under [[basePath]].
w  
Qiang Xue committed
242 243 244
	 */
	public function getRuntimePath()
	{
Qiang Xue committed
245
		if ($this->_runtimePath === null) {
w  
Qiang Xue committed
246 247
			$this->setRuntimePath($this->getBasePath() . DIRECTORY_SEPARATOR . 'runtime');
		}
Qiang Xue committed
248
		return $this->_runtimePath;
w  
Qiang Xue committed
249 250 251 252 253 254 255 256
	}

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

Qiang Xue committed
261 262 263 264
	private $_vendorPath;

	/**
	 * Returns the directory that stores vendor files.
265
	 * @return string the directory that stores vendor files.
266
	 * Defaults to "vendor" directory under [[basePath]].
Qiang Xue committed
267 268 269
	 */
	public function getVendorPath()
	{
Qiang Xue committed
270
		if ($this->_vendorPath === null) {
Qiang Xue committed
271 272 273 274 275 276 277 278 279 280 281
			$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
282
		$this->_vendorPath = Yii::getAlias($path);
283
		Yii::setAlias('@vendor', $this->_vendorPath);
Qiang Xue committed
284 285
	}

w  
Qiang Xue committed
286 287 288
	/**
	 * Returns the time zone used by this application.
	 * This is a simple wrapper of PHP function date_default_timezone_get().
289 290
	 * If time zone is not configured in php.ini or application config,
	 * it will be set to UTC by default.
w  
Qiang Xue committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
	 * @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
312
	 * @return \yii\db\Connection the database connection
w  
Qiang Xue committed
313 314 315 316 317 318
	 */
	public function getDb()
	{
		return $this->getComponent('db');
	}

Qiang Xue committed
319 320 321 322 323 324 325 326 327
	/**
	 * Returns the log component.
	 * @return \yii\log\Logger the log component
	 */
	public function getLog()
	{
		return $this->getComponent('log');
	}

w  
Qiang Xue committed
328 329
	/**
	 * Returns the error handler component.
.  
Qiang Xue committed
330
	 * @return ErrorHandler the error handler application component.
w  
Qiang Xue committed
331 332 333 334 335 336 337 338
	 */
	public function getErrorHandler()
	{
		return $this->getComponent('errorHandler');
	}

	/**
	 * Returns the cache component.
.  
Qiang Xue committed
339
	 * @return \yii\caching\Cache the cache application component. Null if the component is not enabled.
w  
Qiang Xue committed
340 341 342 343 344 345
	 */
	public function getCache()
	{
		return $this->getComponent('cache');
	}

346 347 348 349 350 351 352 353 354
	/**
	 * Returns the formatter component.
	 * @return \yii\base\Formatter the formatter application component.
	 */
	public function getFormatter()
	{
		return $this->getComponent('formatter');
	}

w  
Qiang Xue committed
355 356
	/**
	 * Returns the request component.
357
	 * @return \yii\web\Request|\yii\console\Request the request component
w  
Qiang Xue committed
358 359 360 361 362 363
	 */
	public function getRequest()
	{
		return $this->getComponent('request');
	}

Qiang Xue committed
364
	/**
Qiang Xue committed
365 366
	 * Returns the view object.
	 * @return View the view object that is used to render various view files.
Qiang Xue committed
367
	 */
Qiang Xue committed
368
	public function getView()
Qiang Xue committed
369
	{
Qiang Xue committed
370
		return $this->getComponent('view');
Qiang Xue committed
371 372
	}

Qiang Xue committed
373 374 375 376 377 378 379 380 381
	/**
	 * 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
382 383 384 385 386 387 388 389 390
	/**
	 * Returns the internationalization (i18n) component
	 * @return \yii\i18n\I18N the internationalization component
	 */
	public function getI18N()
	{
		return $this->getComponent('i18n');
	}

Qiang Xue committed
391
	/**
392
	 * Returns the auth manager for this application.
393
	 * @return \yii\rbac\Manager the auth manager for this application.
Qiang Xue committed
394 395 396
	 */
	public function getAuthManager()
	{
397
		return $this->getComponent('authManager');
Qiang Xue committed
398 399
	}

w  
Qiang Xue committed
400 401 402 403
	/**
	 * Registers the core application components.
	 * @see setComponents
	 */
.  
Qiang Xue committed
404
	public function registerCoreComponents()
w  
Qiang Xue committed
405
	{
.  
Qiang Xue committed
406
		$this->setComponents(array(
Qiang Xue committed
407 408 409
			'log' => array(
				'class' => 'yii\log\Logger',
			),
.  
Qiang Xue committed
410 411 412
			'errorHandler' => array(
				'class' => 'yii\base\ErrorHandler',
			),
413 414 415
			'formatter' => array(
				'class' => 'yii\base\Formatter',
			),
Qiang Xue committed
416 417
			'i18n' => array(
				'class' => 'yii\i18n\I18N',
w  
Qiang Xue committed
418
			),
Qiang Xue committed
419 420
			'urlManager' => array(
				'class' => 'yii\web\UrlManager',
w  
Qiang Xue committed
421
			),
Qiang Xue committed
422 423 424
			'view' => array(
				'class' => 'yii\base\View',
			),
.  
Qiang Xue committed
425
		));
w  
Qiang Xue committed
426
	}
Qiang Xue committed
427

428 429 430
	/**
	 * Handles uncaught PHP exceptions.
	 *
431
	 * This method is implemented as a PHP exception handler.
432
	 *
433
	 * @param \Exception $exception the exception that is not caught
434 435 436 437 438 439 440 441 442 443 444
	 */
	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 {
445
				echo $this->renderException($exception);
446 447
			}
		} catch (\Exception $e) {
448
			// exception could be thrown in ErrorHandler::handle()
449 450 451 452 453 454 455 456 457 458 459 460
			$msg = (string)$e;
			$msg .= "\nPrevious exception:\n";
			$msg .= (string)$exception;
			if (YII_DEBUG) {
				echo $msg;
			}
			$msg .= "\n\$_SERVER = " . var_export($_SERVER, true);
			error_log($msg);
			exit(1);
		}
	}

Qiang Xue committed
461 462 463 464 465 466 467 468 469
	/**
	 * 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
470 471
	 *
	 * @throws ErrorException
Qiang Xue committed
472 473 474 475
	 */
	public function handleError($code, $message, $file, $line)
	{
		if (error_reporting() !== 0) {
476 477 478 479 480 481 482 483
			// 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');
			}
484 485 486 487 488
			$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
489 490
			foreach ($trace as $frame) {
				if ($frame['function'] == '__toString') {
491
					$this->handleException($exception);
492
					exit(1);
493 494 495 496
				}
			}

			throw $exception;
Qiang Xue committed
497 498 499 500
		}
	}

	/**
501
	 * Handles fatal PHP errors
Qiang Xue committed
502
	 */
503
	public function handleFatalError()
Qiang Xue committed
504
	{
505 506
		unset($this->_memoryReserve);

507 508 509 510 511 512 513 514 515
		// 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');
		}

516 517 518 519 520 521
		$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
522

523 524 525 526
			if (($handler = $this->getErrorHandler()) !== null) {
				$handler->handle($exception);
			} else {
				echo $this->renderException($exception);
Qiang Xue committed
527
			}
528 529

			exit(1);
Qiang Xue committed
530 531 532
		}
	}

Qiang Xue committed
533 534 535
	/**
	 * Renders an exception without using rich format.
	 * @param \Exception $exception the exception to be rendered.
536
	 * @return string the rendering result
Qiang Xue committed
537 538 539
	 */
	public function renderException($exception)
	{
Qiang Xue committed
540
		if ($exception instanceof Exception && ($exception instanceof UserException || !YII_DEBUG)) {
Qiang Xue committed
541
			$message = $exception->getName() . ': ' . $exception->getMessage();
Qiang Xue committed
542 543 544
			if (Yii::$app->controller instanceof \yii\console\Controller) {
				$message = Yii::$app->controller->ansiFormat($message, Console::FG_RED);
			}
Qiang Xue committed
545 546 547
		} else {
			$message = YII_DEBUG ? (string)$exception : 'Error: ' . $exception->getMessage();
		}
548 549
		if (PHP_SAPI === 'cli') {
			return $message . "\n";
Qiang Xue committed
550
		} else {
551
			return '<pre>' . htmlspecialchars($message, ENT_QUOTES, $this->charset) . '</pre>';
Qiang Xue committed
552 553 554
		}
	}

555 556 557 558
	/**
	 * Logs the given exception
	 * @param \Exception $exception the exception to be logged
	 */
Qiang Xue committed
559 560 561 562 563 564 565 566 567 568 569 570
	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
571
}