Logo Search packages:      
Sourcecode: cakephp1.2 version File versions  Download package

dispatcher.php

<?php
/* SVN FILE: $Id: dispatcher.php 5875 2007-10-23 00:25:51Z phpnut $ */
/**
 * 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: 5875 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-10-22 19:25:51 -0500 (Mon, 22 Oct 2007) $
 * @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
 */
00042 class Dispatcher extends Object {
/**
 * Base URL
 *
 * @var string
 * @access public
 */
      var $base = false;
/**
 * webroot path
 *
 * @var string
 * @access public
 */
      var $webroot = '/';
/**
 * 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.
 */
00095       function __construct($url = null, $base = false) {
            parent::__construct();
            if($base !== false) {
                  Configure::write('App.base', $base);
            }
            $this->base = Configure::read('App.base');
            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
 */
00117       function dispatch($url = null, $additionalParams = array()) {
            if ($this->base === false) {
                  $this->base = $this->baseUrl();
            }
            if ($url !== null) {
                  $_GET['url'] = $url;
            }

            $url = $this->getUrl();
            $this->here = $this->base . '/' . $url;
            $this->cached($url);
            $this->params = array_merge($this->parseParams($url), $additionalParams);

            $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', true),
                                                                                    'base' => $this->base)));
                  } else {
                        Router::setRequestInfo(array($this->params, array('base' => $this->base, 'webroot' => $this->webroot)));
                        return $this->cakeError('missingController', array(
                              array(
                                    'className' => Inflector::camelize($this->params['controller']) . 'Controller',
                                    'webroot' => $this->webroot,
                                    'url' => $url,
                                    'base' => $this->base
                              )
                        ));
                  }
            }

            $missingAction = $missingView = $privateAction = false;

            if (empty($this->params['action'])) {
                  $this->params['action'] = 'index';
            }

            $prefixes = Router::prefixes();
            if (!empty($prefixes)) {
                  if (isset($this->params['prefix'])) {
                        $this->params['action'] = $this->params['prefix'] . '_' . $this->params['action'];
                  } elseif (strpos($this->params['action'], '_') !== false) {
                        list($prefix, $action) = explode('_', $this->params['action']);
                        $privateAction = in_array($prefix, $prefixes);
                  }
            }

            $protected = array_map('strtolower', get_class_methods('controller'));
            $classMethods = array_map('strtolower', 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->plugin = $this->plugin;
            $controller->params =& $this->params;
            $controller->action =& $this->params['action'];
            $controller->webservices =& $this->params['webservices'];
            $controller->passedArgs =& $this->params['pass'];

            if (!empty($this->params['data'])) {
                  $controller->data =& $this->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)));
            $controller->_initComponents();

            if(isset($this->plugin)) {
                  loadPluginModels($this->plugin);
            }

            $controller->constructClasses();

            $this->start($controller);

            if ($privateAction) {
                  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
 */
00260       function _invoke(&$controller, $params, $missingAction = false) {
            $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'])? array(): $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
 */
00304       function start(&$controller) {
            if (!empty($controller->beforeFilter)) {
                  trigger_error(sprintf(__('Dispatcher::start - Controller::$beforeFilter property usage is deprecated and will no longer be supported.  Use Controller::beforeFilter().', true)), E_USER_WARNING);

                  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
 */
00340       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
 */
00397       function baseUrl() {
            if($this->base !== false) {
                  $this->webroot = $this->base .'/';
                  return $this->base;
            }

            $base = '';
            $this->webroot = '/';

            $config = Configure::read('App');
            extract($config);

            $file = null;
            if (!$baseUrl) {
                  $base = env('PHP_SELF');
            } elseif ($baseUrl) {
                  $base = $baseUrl;
                  $file = '/' . basename($base);
            }

            $base = dirname($base);
            if (in_array($base, array(DS, '.'))) {
                  $base = '';
            }

            if(!$baseUrl) {
                  if($base == '') {
                        $this->webroot = '/';
                        return $base;
                  }
                  if($dir === 'app') {
                        $base =  str_replace('/app', '', $base);
                  }
                  if ($webroot === 'webroot') {
                        $base =  str_replace('/webroot', '', $base);
                  }
                  $this->webroot = $base .'/';
                  return $base;
            }

            $this->webroot = $base .'/';

            if (strpos($this->webroot, $dir) === false) {
                  $this->webroot .=  $dir . '/' ;
            }
            if (strpos($this->webroot, $webroot) === false) {
                  $this->webroot .= $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
 */
00454       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 of parameters
 * @return mixed name of controller if not loaded, or object if loaded
 * @access private
 */
00473       function __getController($params = null) {
            if (!is_array($params)) {
                  $params = $this->params;
            }

            $controller = false;
            if (!$ctrlClass = $this->__loadController($params)) {
                  if(!isset($params['plugin'])) {
                        $params = $this->_restructureParams($params);
                  }
                  if (!$ctrlClass = $this->__loadController($params)) {
                        $params = am($params, array('controller'=> $params['plugin'],
                                                                  'action'=> $params['controller'],
                                                                  'pass' => am($params['pass'], Router::getArgs($params['action']))
                                                            )
                                                );
                        if (!$ctrlClass = $this->__loadController($params)) {
                              return false;
                        }
                  }
            }

            if (class_exists($ctrlClass)) {
                  $this->params = $params;
                  $controller =& new $ctrlClass();
            }

            return $controller;
      }
/**
 * Load controller and return controller class
 *
 * @param array $params Array of parameters
 * @return string|bool Name of controller class name
 * @access private
 */
00509       function __loadController($params) {
            $pluginName = $pluginPath = $controller = $ctrlClass = null;

            if (!empty($params['plugin'])) {
                  $this->plugin = $params['plugin'];
                  $pluginName = Inflector::camelize($params['plugin']);
                  $pluginPath = $pluginName . '.';
                  $this->params['controller'] = $this->plugin;
                  $controller = $pluginName;
            }

            if (!empty($params['controller'])) {
                  $controller = Inflector::camelize($params['controller']);
            }

            if ($pluginPath . $controller) {
                  if (loadController($pluginPath . $controller)) {
                        $ctrlClass = $controller . 'Controller';
                        return $ctrlClass;
                  }
            }
            return false;
      }
/**
 * Returns the REQUEST_URI from the server environment, or, failing that,
 * constructs a new one, using the PHP_SELF constant and other variables.
 *
 * @return string URI
 * @access public
 */
00539       function uri() {
            if ($uri = env('HTTP_X_REWRITE_URL')) {
            } elseif ($uri = env('REQUEST_URI')) {
            } else {
                  if ($uri = env('argv')) {
                        if (defined('SERVER_IIS') && SERVER_IIS) {
                              if (key($_GET) && strpos(key($_GET), '?') !== false) {
                                    unset($_GET[key($_GET)]);
                              }
                              $uri = preg_split('/\?/', $uri[0], 2);
                              if (isset($uri[1])) {
                                    foreach (preg_split('/&/', $uri[1]) as $var) {
                                          @list($key, $val) = explode('=', $var);
                                          $_GET[$key] = $val;
                                    }
                              }
                              $uri = $this->base . $uri[0];
                        } else {
                              $uri = env('PHP_SELF') . '/' . $uri[0];
                        }
                  } else {
                        $uri = env('PHP_SELF') . '/' . env('QUERY_STRING');
                  }
            }
            return str_replace('//', '/', preg_replace('/\?url=/', '/', $uri));
      }
/**
 * Returns and sets the $_GET[url] derived from the REQUEST_URI
 *
 * @param string $uri Request URI
 * @param string $base Base path
 * @return string URL
 * @access public
 */
00573       function getUrl($uri = null, $base = null) {
            if (empty($_GET['url'])) {
                  if ($uri == null) {
                        $uri = $this->uri();
                  }
                  if ($base == null) {
                        $base = $this->base;
                  }
                  $url = null;
                  if ($uri === '/' || $uri == dirname($base).'/' || $url == $base) {
                        $url = $_GET['url'] = '/';
                  } else {
                        if (strpos($uri, $base) !== false) {
                              $elements = explode($base, $uri);
                        } elseif (preg_match('/^[\/\?\/|\/\?|\?\/]/', $uri)) {
                              $elements = array(1 => preg_replace('/^[\/\?\/|\/\?|\?\/]/', '', $uri));
                        } else {
                              $elements = array();
                        }
                        if (!empty($elements[1])) {
                              $_GET['url'] = $elements[1];
                              $url = $elements[1];
                        } else {
                              $url = $_GET['url'] = '/';
                        }
                        if (strpos($url, '/') === 0 && $url != '/') {
                              $url = $_GET['url'] = substr($url, 1);
                        }
                  }
            } else {
                  $url = $_GET['url'];
            }
            if($url{0} == '/') {
                  $url = substr($url, 1);
            }
            return $url;
      }
/**
 * Outputs cached dispatch for js, css, view cache
 *
 * @param string $url Requested URL
 * @access public
 */
00616       function cached($url) {
            if (strpos($url, 'ccss/') === 0) {
                  include WWW_ROOT . DS . 'css.php';
                  exit();
            }

            $folders = array('js' => 'text/javascript', 'css' => 'text/css');
            $requestPath = explode('/', $url);

            if (in_array($requestPath[0], array_keys($folders))) {
                  if (file_exists(VENDORS . join(DS, $requestPath))) {
                        $fileModified = filemtime(VENDORS . join(DS, $requestPath));
                        header("Date: " . date("D, j M Y G:i:s ", $fileModified) . 'GMT');
                        header('Content-type: ' . $folders[$requestPath[0]]);
                        header("Expires: " . gmdate("D, j M Y H:i:s", time() + DAY) . " GMT");
                        header("Cache-Control: cache");
                        header("Pragma: cache");
                        include (VENDORS . join(DS, $requestPath));
                        exit();
                  }
            }

            if (Configure::read('Cache.check') === true) {
                  $filename = CACHE . 'views' . DS . convertSlash($url) . '.php';
                  if (!file_exists($filename)) {
                        $filename = CACHE . 'views' . DS . convertSlash($url) . '_index.php';
                  }
                  if (file_exists($filename)) {
                        uses('controller' . DS . 'component', DS . 'view' . DS . 'view');
                        $v = null;
                        $view = new View($v);
                        $view->renderCache($filename, getMicrotime());
                  }
            }
      }
}

?>

Generated by  Doxygen 1.6.0   Back to index