cakephp2-php8/cake/dispatcher.php
phpnut ea15f09288 Refactoring loading of plugins.
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5464 3807eeeb-6ff5-0310-8944-8be069107fe0
2007-07-25 21:08:12 +00:00

512 lines
14 KiB
PHP

<?php
/* SVN FILE: $Id$ */
/**
* Dispatcher takes the URL information, parses it for paramters and
* tells the involved controllers what to do.
*
* This is the heart of Cake's operation.
*
* PHP versions 4 and 5
*
* CakePHP(tm) : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2005-2007, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2005-2007, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
* @package cake
* @subpackage cake.cake
* @since CakePHP(tm) v 0.2.9
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* List of helpers to include
*/
uses('router', DS.'controller'.DS.'controller');
/**
* Dispatcher translates URLs to controller-action-paramter triads.
*
* Dispatches the request, creating appropriate models and controllers.
*
* @package cake
* @subpackage cake.cake
*/
class Dispatcher extends Object {
/**
* Base URL
*
* @var string
* @access public
*/
var $base = false;
/**
* Current URL
*
* @var string
* @access public
*/
var $here = false;
/**
* Admin route (if on it)
*
* @var string
* @access public
*/
var $admin = false;
/**
* Webservice route
*
* @var string
* @access public
*/
var $webservices = null;
/**
* Plugin being served (if any)
*
* @var string
* @access public
*/
var $plugin = null;
/**
* the params for this request
*
* @var string
* @access public
*/
var $params = null;
/**
* Constructor.
*/
function __construct($url = null) {
parent::__construct();
if ($url !== null) {
return $this->dispatch($url);
}
}
/**
* Dispatches and invokes given URL, handing over control to the involved controllers, and then renders the results (if autoRender is set).
*
* If no controller of given name can be found, invoke() shows error messages in
* the form of Missing Controllers information. It does the same with Actions (methods of Controllers are called
* Actions).
*
* @param string $url URL information to work on.
* @param array $additionalParams Settings array ("bare", "return"),
* which is melded with the GET and POST params.
* @return boolean Success
* @access public
*/
function dispatch($url, $additionalParams = array()) {
$this->params = array_merge($this->parseParams($url), $additionalParams);
$missingAction = $missingView = $privateAction = false;
$this->base = $this->baseUrl();
$controller = $this->__getController();
if(!is_object($controller)) {
if (preg_match('/([\\.]+)/', $controller)) {
Router::setRequestInfo(array($this->params, array('base' => $this->base, 'webroot' => $this->webroot)));
return $this->cakeError('error404', array(array('url' => strtolower($controller),
'message' => 'Was not found on this server',
'base' => $this->base)));
} else {
Router::setRequestInfo(array($this->params, array('base' => $this->base, 'webroot' => $this->webroot)));
return $this->cakeError('missingController', array(
array(
'className' => $controller.'Controller',
'webroot' => $this->webroot,
'url' => $url,
'base' => $this->base
)
));
}
}
if (empty($this->params['action'])) {
$this->params['action'] = 'index';
}
if (defined('CAKE_ADMIN')) {
if (isset($this->params[CAKE_ADMIN])) {
$this->admin = '/'.CAKE_ADMIN ;
$url = preg_replace('/'.CAKE_ADMIN.'(\/|$)/', '', $url);
$this->params['action'] = CAKE_ADMIN.'_'.$this->params['action'];
} elseif (strpos($this->params['action'], CAKE_ADMIN) === 0) {
$privateAction = true;
}
}
$this->here = $this->base . $this->admin . '/' . $url;
$protected = array('constructclasses', 'redirect', 'set', 'setAction', 'isauthorized', 'validate', 'validateerrors',
'render', 'referer', 'disablecache', 'flash', 'generatefieldnames', 'postconditions', 'cleanupfields',
'paginate', 'beforefilter', 'beforerender', 'afterfilter', 'object', 'tostring', 'requestaction', 'log',
'cakeerror');
$classMethods = array_map("low", get_class_methods($controller));
if (in_array(low($this->params['action']), $protected) || strpos($this->params['action'], '_', 0) === 0) {
$privateAction = true;
}
if (!in_array(low($this->params['action']), $classMethods)) {
$missingAction = true;
}
if (in_array('return', array_keys($this->params)) && $this->params['return'] == 1) {
$controller->autoRender = false;
}
$controller->base = $this->base;
$controller->here = $this->here;
$controller->webroot = $this->webroot;
$controller->params = $this->params;
$controller->plugin = $this->plugin;
$controller->action = $this->params['action'];
$controller->webservices = $this->params['webservices'];
list($passedArgs, $namedArgs) = Router::getArgs($this->params, $controller->namedArgs, $controller->argSeparator);
$controller->passedArgs = $passedArgs;
$controller->namedArgs = $namedArgs;
if (!empty($controller->params['data'])) {
$controller->data =& $controller->params['data'];
} else {
$controller->data = null;
}
if (!empty($this->params['bare'])) {
$controller->autoLayout = false;
}
if (isset($this->params['layout'])) {
if ($this->params['layout'] === '') {
$controller->autoLayout = false;
} else {
$controller->layout = $this->params['layout'];
}
}
if (isset($this->params['viewPath'])) {
$controller->viewPath = $this->params['viewPath'];
}
foreach (array('components', 'helpers') as $var) {
if (isset($this->params[$var]) && !empty($this->params[$var]) && is_array($controller->{$var})) {
$diff = array_diff($this->params[$var], $controller->{$var});
$controller->{$var} = array_merge($controller->{$var}, $diff);
}
}
if (!is_null($controller->webservices)) {
array_push($controller->components, $controller->webservices);
array_push($controller->helpers, $controller->webservices);
}
Router::setRequestInfo(array($this->params, array('base' => $this->base, 'here' => $this->here, 'webroot' => $this->webroot, 'passedArgs' => $controller->passedArgs, 'argSeparator' => $controller->argSeparator, 'namedArgs' => $controller->namedArgs, 'webservices' => $controller->webservices)));
$controller->_initComponents();
if(isset($this->plugin)) {
loadPluginModels($this->plugin);
}
$controller->constructClasses();
if ($privateAction) {
$this->start($controller);
return $this->cakeError('privateAction', array(
array(
'className' => Inflector::camelize($this->params['controller']."Controller"),
'action' => $this->params['action'],
'webroot' => $this->webroot,
'url' => $url,
'base' => $this->base
)
));
}
return $this->_invoke($controller, $this->params, $missingAction);
}
/**
* Invokes given controller's render action if autoRender option is set. Otherwise the
* contents of the operation are returned as a string.
*
* @param object $controller Controller to invoke
* @param array $params Parameters with at least the 'action' to invoke
* @param boolean $missingAction Set to true if missing action should be rendered, false otherwise
* @return string Output as sent by controller
* @access protected
*/
function _invoke (&$controller, $params, $missingAction = false) {
$this->start($controller);
$classVars = get_object_vars($controller);
if ($missingAction && in_array('scaffold', array_keys($classVars))) {
uses('controller'. DS . 'scaffold');
return new Scaffold($controller, $params);
} elseif ($missingAction && !in_array('scaffold', array_keys($classVars))) {
return $this->cakeError('missingAction', array(
array(
'className' => Inflector::camelize($params['controller']."Controller"),
'action' => $params['action'],
'webroot' => $this->webroot,
'url' => $this->here,
'base' => $this->base
)
));
} else {
$output = call_user_func_array(array(&$controller, $params['action']), empty($params['pass'])? null: $params['pass']);
}
if ($controller->autoRender) {
$output = $controller->render();
}
$controller->output =& $output;
foreach ($controller->components as $c) {
$path = preg_split('/\/|\./', $c);
$c = $path[count($path) - 1];
if (isset($controller->{$c}) && is_object($controller->{$c}) && is_callable(array($controller->{$c}, 'shutdown'))) {
if (!array_key_exists('enabled', get_object_vars($controller->{$c})) || $controller->{$c}->enabled == true) {
$controller->{$c}->shutdown($controller);
}
}
}
$controller->afterFilter();
return $controller->output;
}
/**
* Starts up a controller (by calling its beforeFilter methods and
* starting its components)
*
* @param object $controller Controller to start
* @access public
*/
function start(&$controller) {
if (!empty($controller->beforeFilter)) {
if (is_array($controller->beforeFilter)) {
foreach ($controller->beforeFilter as $filter) {
if (is_callable(array($controller,$filter)) && $filter != 'beforeFilter') {
$controller->$filter();
}
}
} else {
if (is_callable(array($controller, $controller->beforeFilter)) && $controller->beforeFilter != 'beforeFilter') {
$controller->{$controller->beforeFilter}();
}
}
}
$controller->beforeFilter();
foreach ($controller->components as $c) {
$path = preg_split('/\/|\./', $c);
$c = $path[count($path) - 1];
if (isset($controller->{$c}) && is_object($controller->{$c}) && is_callable(array($controller->{$c}, 'startup'))) {
if (!array_key_exists('enabled', get_object_vars($controller->{$c})) || $controller->{$c}->enabled == true) {
$controller->{$c}->startup($controller);
}
}
}
}
/**
* Returns array of GET and POST parameters. GET parameters are taken from given URL.
*
* @param string $fromUrl URL to mine for parameter information.
* @return array Parameters found in POST and GET.
* @access public
*/
function parseParams($fromUrl) {
$Route = Router::getInstance();
extract(Router::getNamedExpressions());
include CONFIGS.'routes.php';
$params = Router::parse($fromUrl);
if (isset($_POST)) {
if (ini_get('magic_quotes_gpc') == 1) {
$params['form'] = stripslashes_deep($_POST);
} else {
$params['form'] = $_POST;
}
}
if (isset($params['form']['data'])) {
$params['data'] = Router::stripEscape($params['form']['data']);
unset($params['form']['data']);
}
if (isset($_GET)) {
if (ini_get('magic_quotes_gpc') == 1) {
$url = stripslashes_deep($_GET);
} else {
$url = $_GET;
}
if (isset($params['url'])) {
$params['url'] = am($params['url'], $url);
} else {
$params['url'] = $url;
}
}
foreach ($_FILES as $name => $data) {
if ($name != 'data') {
$params['form'][$name] = $data;
}
}
if (isset($_FILES['data'])) {
foreach ($_FILES['data'] as $key => $data) {
foreach ($data as $model => $fields) {
foreach ($fields as $field => $value) {
$params['data'][$model][$field][$key] = $value;
}
}
}
}
$params['bare'] = empty($params['ajax']) ? (empty($params['bare']) ? 0: 1) : 1;
$params['webservices'] = empty($params['webservices']) ? null : $params['webservices'];
return $params;
}
/**
* Returns a base URL and sets the proper webroot
*
* @return string Base URL
* @access public
*/
function baseUrl() {
$base = $this->base;
$this->webroot = '/';
$baseUrl = Configure::read('baseUrl');
$app = Configure::read('app');
$webroot = Configure::read('webroot');
$file = $script = null;
if (!$baseUrl && $this->base == false) {
$docRoot = env('DOCUMENT_ROOT');
$script = env('SCRIPT_FILENAME');
$base = r($docRoot, '', $script);
} elseif ($baseUrl && $this->base == false) {
$base = $baseUrl;
}
$file = basename($base);
if (($baseUrl || $this->base) && strpos($file, '.php') !== false) {
$baseUrl = true;
$file = '/'. $file;
}
$base = dirname($base);
if ($base == '/' || $base == '.') {
$base = '';
}
if (!$baseUrl && strpos($script, $app) !== false && $app === 'app') {
$base = str_replace($app.'/', '', $base);
}
$base = str_replace('//', '/', str_replace('/'.$webroot, '', $base));
$this->webroot = $base .'/';
if (!$baseUrl) {
return $base;
}
if ($baseUrl && $base == '') {
return $file;
}
if (strpos($base, $app) === false) {
$this->webroot .= '/' . $app . '/' ;
}
if ($baseUrl && strpos($this->webroot, $webroot) === false) {
$this->webroot .= $webroot . '/';
}
$this->webroot = str_replace('//', '/', $this->webroot);
return $base . $file;
}
/**
* Restructure params in case we're serving a plugin.
*
* @param array $params Array on where to re-set 'controller', 'action', and 'pass' indexes
* @return array Restructured array
* @access protected
*/
function _restructureParams($params) {
$params['plugin'] = $params['controller'];
$params['controller'] = $params['action'];
if (isset($params['pass'][0])) {
$params['action'] = $params['pass'][0];
array_shift($params['pass']);
} else {
$params['action'] = null;
}
return $params;
}
/**
* Get controller to use, either plugin controller or application controller
*
* @param array $params Array on where to re-set 'controller', 'action', and 'pass' indexes
* @return mixed name of controller if not loaded, or object if loaded
* @access protected
*/
function __getController($params = null, $continue = true) {
if(!$params) {
$params = $this->params;
}
$pluginPath = $controller = $ctrlClass = null;
if (!empty($params['controller'])) {
$controller = Inflector::camelize($params['controller']);
$ctrlClass = $controller.'Controller';
}
if (!empty($params['plugin'])) {
$this->plugin = $params['plugin'];
$pluginPath = Inflector::camelize($this->plugin).'.';
}
if ($pluginPath . $controller && loadController($pluginPath . $controller)) {
if(!class_exists($ctrlClass) && $this->plugin) {
$controller = Inflector::camelize($params['plugin']);
$ctrlClass = $controller.'Controller';
$params = am($this->params, array('plugin'=> $params['plugin'], 'controller'=> $params['plugin']));
}
if(class_exists($ctrlClass)) {
$controller =& new $ctrlClass();
}
} elseif ($continue == true){
$params = $this->_restructureParams($params);
$controller = $this->__getController($params, false);
return $controller;
}
if(!$ctrlClass) {
return false;
}
$this->params = $params;
return $controller;
}
}
?>