Source for file Application.php

Documentation is available at Application.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Application
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25: require_once dirname(__FILE__) . '/../Application/ApplicationException.php';
26:
27:
28:
29: /**
30: * Front Controller.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Application
35: */
36: class Application extends Object
37: {
38: /** @var int */
39: public static $maxLoop = 20;
40:
41: /** @var array */
42: public $defaultServices = array(
43: 'Nette\Application\IRouter' => 'Nette\Application\MultiRouter',
44: 'Nette\Application\IPresenterLoader' => 'Nette\Application\PresenterLoader',
45: );
46:
47: /** @var bool enable fault barrier? */
48: public $catchExceptions;
49:
50: /** @var string */
51: public $errorPresenter;
52:
53: /** @var array of function(Application $sender) */
54: public $onStartup;
55:
56: /** @var array of function(Application $sender, \Exception $e = NULL) */
57: public $onShutdown;
58:
59: /** @var array of function(Application $sender, PresenterRequest $request) */
60: public $onRequest;
61:
62: /** @var array of function(Application $sender, \Exception $e) */
63: public $onError;
64:
65: /** @var array of string */
66: public $allowedMethods = array('GET', 'POST', 'HEAD');
67:
68: /** @var array of PresenterRequest */
69: private $requests = array();
70:
71: /** @var Presenter */
72: private $presenter;
73:
74: /** @var ServiceLocator */
75: private $serviceLocator;
76:
77:
78:
79: /**
80: * Dispatch a HTTP request to a front controller.
81: */
82: public function run()
83: {
84: $httpRequest = $this->getHttpRequest();
85: $httpResponse = $this->getHttpResponse();
86:
87: $httpRequest->setEncoding('UTF-8');
88: $httpResponse->setHeader('X-Powered-By', 'Nette Framework');
89:
90: if (Environment::getVariable('baseUri') === NULL) {
91: Environment::setVariable('baseUri', $httpRequest->getUri()->basePath);
92: }
93:
94: // check HTTP method
95: $method = $httpRequest->getMethod();
96: if ($this->allowedMethods) {
97: if (!in_array($method, $this->allowedMethods, TRUE)) {
98: $httpResponse->setCode(IHttpResponse::S501_NOT_IMPLEMENTED);
99: $httpResponse->setHeader('Allow', implode(',', $this->allowedMethods));
100: $method = htmlSpecialChars($method);
101: die("<h1>Method $method is not implemented</h1>");
102: }
103: }
104:
105: // dispatching
106: $request = NULL;
107: $hasError = FALSE;
108: do {
109: try {
110: if (count($this->requests) > self::$maxLoop) {
111: throw new ApplicationException('Too many loops detected in application life cycle.');
112: }
113:
114: if (!$request) {
115: $this->onStartup($this);
116:
117: // default router
118: $router = $this->getRouter();
119: if ($router instanceof MultiRouter && !count($router)) {
120: $router[] = new SimpleRouter(array(
121: 'presenter' => 'Default',
122: 'action' => 'default',
123: ));
124: }
125:
126: // routing
127: $request = $router->match($httpRequest);
128: if (!($request instanceof PresenterRequest)) {
129: $request = NULL;
130: throw new BadRequestException('No route for HTTP request.');
131: }
132:
133: if (strcasecmp($request->getPresenterName(), $this->errorPresenter) === 0) {
134: throw new BadRequestException('Invalid request.');
135: }
136: }
137:
138: $this->requests[] = $request;
139: $this->onRequest($this, $request);
140:
141: // Instantiate presenter
142: $presenter = $request->getPresenterName();
143: try {
144: $class = $this->getPresenterLoader()->getPresenterClass($presenter);
145: $request->modify('name', $presenter);
146: } catch (InvalidPresenterException $e) {
147: throw new BadRequestException($e->getMessage(), 404, $e);
148: }
149: $this->presenter = new $class($request);
150:
151: // Instantiate topmost service locator
152: $this->presenter->setServiceLocator(new ServiceLocator($this->serviceLocator));
153:
154: // Execute presenter
155: $this->presenter->run();
156: break;
157:
158: } catch (RedirectingException $e) {
159: // not error, presenter redirects to new URL
160: $httpResponse->redirect($e->getUri(), $e->getCode());
161: break;
162:
163: } catch (ForwardingException $e) {
164: // not error, presenter forwards to new request
165: $request = $e->getRequest();
166:
167: } catch (AbortException $e) {
168: // not error, application is correctly terminated
169: unset($e);
170: break;
171:
172: } catch (Exception $e) {
173: // fault barrier
174: if ($this->catchExceptions === NULL) {
175: $this->catchExceptions = Environment::isProduction();
176: }
177:
178: if (!$this->catchExceptions) {
179: throw $e;
180: }
181:
182: $this->onError($this, $e);
183:
184: if ($hasError) {
185: $e = new ApplicationException('An error occured while executing error-presenter', 0, $e);
186:
187: } elseif ($this->errorPresenter) {
188: $hasError = TRUE;
189: $request = new PresenterRequest(
190: $this->errorPresenter,
191: PresenterRequest::FORWARD,
192: array('exception' => $e)
193: );
194: continue;
195: }
196:
197: if ($e instanceof BadRequestException) {
198: if (!$httpResponse->isSent()) {
199: $httpResponse->setCode($e->getCode());
200: }
201: echo "<title>404 Not Found</title>\n\n<h1>Not Found</h1>\n\n<p>The requested URL was not found on this server.</p>";
202: break;
203:
204: } else {
205: if (!$httpResponse->isSent()) {
206: $httpResponse->setCode(500);
207: }
208: Debug::processException($e, FALSE);
209: echo "<title>500 Internal Server Error</title>\n\n<h1>Server Error</h1>\n\n",
210: "<p>The server encountered an internal error and was unable to complete your request. Please try again later.</p>";
211: break;
212: }
213: }
214: } while (1);
215:
216: $this->onShutdown($this, isset($e) ? $e : NULL);
217: }
218:
219:
220:
221: /**
222: * Returns all processed requests.
223: * @return array of PresenterRequest
224: */
225: final public function getRequests()
226: {
227: return $this->requests;
228: }
229:
230:
231:
232: /**
233: * Returns current presenter.
234: * @return Presenter
235: */
236: final public function getPresenter()
237: {
238: return $this->presenter;
239: }
240:
241:
242:
243: /********************* services ****************d*g**/
244:
245:
246:
247: /**
248: * Gets the service locator (experimental).
249: * @return IServiceLocator
250: */
251: final public function getServiceLocator()
252: {
253: if ($this->serviceLocator === NULL) {
254: $this->serviceLocator = new ServiceLocator(Environment::getServiceLocator());
255:
256: foreach ($this->defaultServices as $name => $service) {
257: if ($this->serviceLocator->getService($name, FALSE) === NULL) {
258: $this->serviceLocator->addService($service, $name);
259: }
260: }
261: }
262: return $this->serviceLocator;
263: }
264:
265:
266:
267: /**
268: * Gets the service object of the specified type.
269: * @param string service name
270: * @param bool throw exception if service doesn't exist?
271: * @return mixed
272: */
273: final public function getService($name, $need = TRUE)
274: {
275: return $this->getServiceLocator()->getService($name, $need);
276: }
277:
278:
279:
280: /**
281: * Returns router.
282: * @return IRouter
283: */
284: public function getRouter()
285: {
286: return $this->getServiceLocator()->getService('Nette\Application\IRouter');
287: }
288:
289:
290:
291: /**
292: * Changes router.
293: * @param IRouter
294: * @return void
295: */
296: public function setRouter(IRouter $router)
297: {
298: $this->getServiceLocator()->addService($router, 'Nette\Application\IRouter');
299: }
300:
301:
302:
303: /**
304: * Returns presenter loader.
305: * @return IPresenterLoader
306: */
307: public function getPresenterLoader()
308: {
309: return $this->getServiceLocator()->getService('Nette\Application\IPresenterLoader');
310: }
311:
312:
313:
314: /********************* request serialization ****************d*g**/
315:
316:
317:
318: /**
319: * @return string
320: */
321: public function storeRequest()
322: {
323: $session = $this->getSession()->getNamespace('Nette.Application/requests');
324: do {
325: $key = substr(md5(lcg_value()), 0, 4);
326: } while (isset($session->$key));
327:
328: $session->$key = end($this->requests);
329: $session->setExpiration(10 * 60, 'requests');
330: return $key;
331: }
332:
333:
334:
335: /**
336: * @param string
337: * @return void
338: */
339: public function restoreRequest($key)
340: {
341: $session = $this->getSession()->getNamespace('Nette.Application/requests');
342: if (isset($session->$key)) {
343: $request = $session->$key;
344: unset($session->$key);
345: throw new ForwardingException($request);
346: }
347: }
348:
349:
350:
351: /********************* backend ****************d*g**/
352:
353:
354:
355: /**
356: * @return IHttpRequest
357: */
358: protected function getHttpRequest()
359: {
360: return Environment::getHttpRequest();
361: }
362:
363:
364:
365: /**
366: * @return IHttpResponse
367: */
368: protected function getHttpResponse()
369: {
370: return Environment::getHttpResponse();
371: }
372:
373:
374:
375: /**
376: * @return Session
377: */
378: protected function getSession()
379: {
380: return Environment::getSession();
381: }
382:
383: }

Source for file Application.php

Namespaces