1: <?php
  2: /**
  3:  * Dispatcher takes the URL information, parses it for parameters and
  4:  * tells the involved controllers what to do.
  5:  *
  6:  * This is the heart of Cake's operation.
  7:  *
  8:  * PHP 5
  9:  *
 10:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 11:  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 12:  *
 13:  * Licensed under The MIT License
 14:  * For full copyright and license information, please see the LICENSE.txt
 15:  * Redistributions of files must retain the above copyright notice.
 16:  *
 17:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 18:  * @link          http://cakephp.org CakePHP(tm) Project
 19:  * @package       Cake.Routing
 20:  * @since         CakePHP(tm) v 0.2.9
 21:  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 22:  */
 23: 
 24: App::uses('Router', 'Routing');
 25: App::uses('CakeRequest', 'Network');
 26: App::uses('CakeResponse', 'Network');
 27: App::uses('Controller', 'Controller');
 28: App::uses('Scaffold', 'Controller');
 29: App::uses('View', 'View');
 30: App::uses('Debugger', 'Utility');
 31: App::uses('CakeEvent', 'Event');
 32: App::uses('CakeEventManager', 'Event');
 33: App::uses('CakeEventListener', 'Event');
 34: 
 35: /**
 36:  * Dispatcher converts Requests into controller actions. It uses the dispatched Request
 37:  * to locate and load the correct controller. If found, the requested action is called on
 38:  * the controller.
 39:  *
 40:  * @package       Cake.Routing
 41:  */
 42: class Dispatcher implements CakeEventListener {
 43: 
 44: /**
 45:  * Event manager, used to handle dispatcher filters
 46:  *
 47:  * @var CakeEventManager
 48:  */
 49:     protected $_eventManager;
 50: 
 51: /**
 52:  * Constructor.
 53:  *
 54:  * @param string $base The base directory for the application. Writes `App.base` to Configure.
 55:  */
 56:     public function __construct($base = false) {
 57:         if ($base !== false) {
 58:             Configure::write('App.base', $base);
 59:         }
 60:     }
 61: 
 62: /**
 63:  * Returns the CakeEventManager instance or creates one if none was
 64:  * created. Attaches the default listeners and filters
 65:  *
 66:  * @return CakeEventManager
 67:  */
 68:     public function getEventManager() {
 69:         if (!$this->_eventManager) {
 70:             $this->_eventManager = new CakeEventManager();
 71:             $this->_eventManager->attach($this);
 72:             $this->_attachFilters($this->_eventManager);
 73:         }
 74:         return $this->_eventManager;
 75:     }
 76: 
 77: /**
 78:  * Returns the list of events this object listens to.
 79:  *
 80:  * @return array
 81:  */
 82:     public function implementedEvents() {
 83:         return array('Dispatcher.beforeDispatch' => 'parseParams');
 84:     }
 85: 
 86: /**
 87:  * Attaches all event listeners for this dispatcher instance. Loads the
 88:  * dispatcher filters from the configured locations.
 89:  *
 90:  * @param CakeEventManager $manager
 91:  * @return void
 92:  * @throws MissingDispatcherFilterException
 93:  */
 94:     protected function _attachFilters($manager) {
 95:         $filters = Configure::read('Dispatcher.filters');
 96:         if (empty($filters)) {
 97:             return;
 98:         }
 99: 
100:         foreach ($filters as $filter) {
101:             if (is_string($filter)) {
102:                 $filter = array('callable' => $filter);
103:             }
104:             if (is_string($filter['callable'])) {
105:                 list($plugin, $callable) = pluginSplit($filter['callable'], true);
106:                 App::uses($callable, $plugin . 'Routing/Filter');
107:                 if (!class_exists($callable)) {
108:                     throw new MissingDispatcherFilterException($callable);
109:                 }
110:                 $manager->attach(new $callable);
111:             } else {
112:                 $on = strtolower($filter['on']);
113:                 $options = array();
114:                 if (isset($filter['priority'])) {
115:                     $options = array('priority' => $filter['priority']);
116:                 }
117:                 $manager->attach($filter['callable'], 'Dispatcher.' . $on . 'Dispatch', $options);
118:             }
119:         }
120:     }
121: 
122: /**
123:  * Dispatches and invokes given Request, handing over control to the involved controller. If the controller is set
124:  * to autoRender, via Controller::$autoRender, then Dispatcher will render the view.
125:  *
126:  * Actions in CakePHP can be any public method on a controller, that is not declared in Controller. If you
127:  * want controller methods to be public and in-accessible by URL, then prefix them with a `_`.
128:  * For example `public function _loadPosts() { }` would not be accessible via URL. Private and protected methods
129:  * are also not accessible via URL.
130:  *
131:  * If no controller of given name can be found, invoke() will throw an exception.
132:  * If the controller is found, and the action is not found an exception will be thrown.
133:  *
134:  * @param CakeRequest $request Request object to dispatch.
135:  * @param CakeResponse $response Response object to put the results of the dispatch into.
136:  * @param array $additionalParams Settings array ("bare", "return") which is melded with the GET and POST params
137:  * @return string|void if `$request['return']` is set then it returns response body, null otherwise
138:  * @throws MissingControllerException When the controller is missing.
139:  */
140:     public function dispatch(CakeRequest $request, CakeResponse $response, $additionalParams = array()) {
141:         $beforeEvent = new CakeEvent('Dispatcher.beforeDispatch', $this, compact('request', 'response', 'additionalParams'));
142:         $this->getEventManager()->dispatch($beforeEvent);
143: 
144:         $request = $beforeEvent->data['request'];
145:         if ($beforeEvent->result instanceof CakeResponse) {
146:             if (isset($request->params['return'])) {
147:                 return $beforeEvent->result->body();
148:             }
149:             $beforeEvent->result->send();
150:             return;
151:         }
152: 
153:         $controller = $this->_getController($request, $response);
154: 
155:         if (!($controller instanceof Controller)) {
156:             throw new MissingControllerException(array(
157:                 'class' => Inflector::camelize($request->params['controller']) . 'Controller',
158:                 'plugin' => empty($request->params['plugin']) ? null : Inflector::camelize($request->params['plugin'])
159:             ));
160:         }
161: 
162:         $response = $this->_invoke($controller, $request, $response);
163:         if (isset($request->params['return'])) {
164:             return $response->body();
165:         }
166: 
167:         $afterEvent = new CakeEvent('Dispatcher.afterDispatch', $this, compact('request', 'response'));
168:         $this->getEventManager()->dispatch($afterEvent);
169:         $afterEvent->data['response']->send();
170:     }
171: 
172: /**
173:  * Initializes the components and models a controller will be using.
174:  * Triggers the controller action, and invokes the rendering if Controller::$autoRender is true and echo's the output.
175:  * Otherwise the return value of the controller action are returned.
176:  *
177:  * @param Controller $controller Controller to invoke
178:  * @param CakeRequest $request The request object to invoke the controller for.
179:  * @param CakeResponse $response The response object to receive the output
180:  * @return CakeResponse the resulting response object
181:  */
182:     protected function _invoke(Controller $controller, CakeRequest $request, CakeResponse $response) {
183:         $controller->constructClasses();
184:         $controller->startupProcess();
185: 
186:         $render = true;
187:         $result = $controller->invokeAction($request);
188:         if ($result instanceof CakeResponse) {
189:             $render = false;
190:             $response = $result;
191:         }
192: 
193:         if ($render && $controller->autoRender) {
194:             $response = $controller->render();
195:         } elseif (!($result instanceof CakeResponse) &&
196:             $response->body() === null
197:         ) {
198:             $response->body($result);
199:         }
200:         $controller->shutdownProcess();
201: 
202:         return $response;
203:     }
204: 
205: /**
206:  * Applies Routing and additionalParameters to the request to be dispatched.
207:  * If Routes have not been loaded they will be loaded, and app/Config/routes.php will be run.
208:  *
209:  * @param CakeEvent $event containing the request, response and additional params
210:  * @return void
211:  */
212:     public function parseParams($event) {
213:         $request = $event->data['request'];
214:         Router::setRequestInfo($request);
215:         $params = Router::parse($request->url);
216:         $request->addParams($params);
217: 
218:         if (!empty($event->data['additionalParams'])) {
219:             $request->addParams($event->data['additionalParams']);
220:         }
221:     }
222: 
223: /**
224:  * Get controller to use, either plugin controller or application controller
225:  *
226:  * @param CakeRequest $request Request object
227:  * @param CakeResponse $response Response for the controller.
228:  * @return mixed name of controller if not loaded, or object if loaded
229:  */
230:     protected function _getController($request, $response) {
231:         $ctrlClass = $this->_loadController($request);
232:         if (!$ctrlClass) {
233:             return false;
234:         }
235:         $reflection = new ReflectionClass($ctrlClass);
236:         if ($reflection->isAbstract() || $reflection->isInterface()) {
237:             return false;
238:         }
239:         return $reflection->newInstance($request, $response);
240:     }
241: 
242: /**
243:  * Load controller and return controller classname
244:  *
245:  * @param CakeRequest $request
246:  * @return string|bool Name of controller class name
247:  */
248:     protected function _loadController($request) {
249:         $pluginName = $pluginPath = $controller = null;
250:         if (!empty($request->params['plugin'])) {
251:             $pluginName = $controller = Inflector::camelize($request->params['plugin']);
252:             $pluginPath = $pluginName . '.';
253:         }
254:         if (!empty($request->params['controller'])) {
255:             $controller = Inflector::camelize($request->params['controller']);
256:         }
257:         if ($pluginPath . $controller) {
258:             $class = $controller . 'Controller';
259:             App::uses('AppController', 'Controller');
260:             App::uses($pluginName . 'AppController', $pluginPath . 'Controller');
261:             App::uses($class, $pluginPath . 'Controller');
262:             if (class_exists($class)) {
263:                 return $class;
264:             }
265:         }
266:         return false;
267:     }
268: 
269: }
270: