[李景山php]thinkphp核心源码注释|Disaptcher.class.php

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006-2014 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------
namespace Think;
/**
* ThinkPHP内置的Dispatcher类
* 完成URL解析、路由和调度
* 此处先留下一个问号，route 是干什么的呢？
* 很长了，解析的不好，抽空重新解析一下
*/
class Dispatcher {

/**
* URL映射到控制器
* @access public
* @return void
*/
static public function dispatch() {
$varPath        =   C('VAR_PATHINFO');// 路径
// 'VAR_PATHINFO'          =>  's',    // 兼容模式PATHINFO获取变量例如 ?s=/module/action/id/1 后面的参数取决于URL_PATHINFO_DEPR
$varAddon       =   C('VAR_ADDON');// 插件
// 'VAR_ADDON'             =>  'addon',     // 默认的插件控制器命名空间变量
$varModule      =   C('VAR_MODULE');// 模块
// 'VAR_MODULE'            =>  'm',     // 默认模块获取变量
$varController  =   C('VAR_CONTROLLER');// 控制器
// 'VAR_CONTROLLER'        =>  'c',    // 默认控制器获取变量
$varAction      =   C('VAR_ACTION');// 方法
// 'VAR_ACTION'            =>  'a',    // 默认操作获取变量
$urlCase        =   C('URL_CASE_INSENSITIVE');// url 类型
// 'URL_CASE_INSENSITIVE'  =>  true,   // 默认false 表示URL区分大小写 true则表示不区分大小写
if(isset($_GET[$varPath])) { // 判断URL里面是否有兼容模式参数
$_SERVER['PATH_INFO'] = $_GET[$varPath];
unset($_GET[$varPath]);
}elseif(IS_CLI){ // CLI模式下 index.php module/controller/action/params/...
$_SERVER['PATH_INFO'] = isset($_SERVER['argv'][1]) ? $_SERVER['argv'][1] : '';
}
// 这里 介绍了 里面 PATH_INFO的信息

// 开启子域名部署
if(C('APP_SUB_DOMAIN_DEPLOY')) {
// 'APP_SUB_DOMAIN_DEPLOY' =>  false,   // 是否开启子域名部署
// 默认这里是不存在的
$rules      = C('APP_SUB_DOMAIN_RULES'); // 默认是空
// 'APP_SUB_DOMAIN_RULES'  =>  array(), // 子域名部署规则
if(isset($rules[$_SERVER['HTTP_HOST']])) { // 完整域名或者IP配置
// 默认运行这里是没有的
define('APP_DOMAIN',$_SERVER['HTTP_HOST']); // 当前完整域名
$rule = $rules[APP_DOMAIN]; // 当前的规则改成 APP DOMAIN 规则
}else{ // 如果跑到这里了，基本上这个了
if(strpos(C('APP_DOMAIN_SUFFIX'),'.')){ // com.cn net.cn
// $_SERVER['HTTP_HOST']＝＝'www.baidu.com'
// 'APP_DOMAIN_SUFFIX'     =>  '', // 域名后缀 如果是com.cn net.cn 之类的后缀必须设置
$domain = array_slice(explode('.', $_SERVER['HTTP_HOST']), 0, -3);
}else{
$domain = array_slice(explode('.', $_SERVER['HTTP_HOST']), 0, -2);
}
// $_SERVER['HTTP_HOST']  www.baidu.com
// $a = explode('.','www.baidu.com.cn');
// print_r(array_slice($a,0,-3));
// Array ( [0] => www )
// array_slice() 函数在数组中根据条件取出一段值，并返回。
// 总结 ：也就是取到域名了呢， 渠道真实的域名，因为他不知道前面
if(!empty($domain)) {
// 这里肯定能够得到了 比如， www
$subDomain = implode('.', $domain); // 这里拼出来的，更深层的多级域名
define('SUB_DOMAIN',$subDomain); // 当前完整子域名 找到了这个完成的子域名
$domain2   = array_pop($domain); // 二级域名 获取了这个的二级域名
if($domain) { // 存在三级域名
$domain3 = array_pop($domain);
}
if(isset($rules[$subDomain])) { // 子域名
$rule = $rules[$subDomain];// 这里 规则
}elseif(isset($rules['*.' . $domain2]) && !empty($domain3)){ // 泛三级域名
$rule = $rules['*.' . $domain2];
$panDomain = $domain3; // 泛三级规则
}elseif(isset($rules['*']) && !empty($domain2) && 'www' != $domain2 ){ // 泛二级域名
$rule      = $rules['*'];
$panDomain = $domain2;
}
}
// 分别进行规则的处理
}

if(!empty($rule)) { // 一般情况下应该是为空的
// 子域名部署规则 '子域名'=>array('模块名[/控制器名]','var1=a&var2=b');
if(is_array($rule)){
list($rule,$vars) = $rule;
}// 这里的范式，简直就是太多了， 规则一下了
$array      =   explode('/',$rule); // 还要区分 控制器，模块
// 模块绑定
define('BIND_MODULE',array_shift($array)); // 绑定对应的模块
// 控制器绑定
if(!empty($array)) { // 如果存在控制器，就绑定控制器
$controller  =   array_shift($array);
if($controller){
define('BIND_CONTROLLER',$controller);
}
}
if(isset($vars)) { // 传入参数
parse_str($vars,$parms); // parse_str(string,array)
if(isset($panDomain)){ // 如果需要处理点 东西
$pos = array_search('*', $parms); //在数组中搜索键值 "red"，并返回它的键名：
if(false !== $pos) {
// 泛域名作为参数
$parms[$pos] = $panDomain; // 替换泛参数
}
}
$_GET   =  array_merge($_GET,$parms); // 合并参数
}
}
}
// 开启子域名 结束
// 此处位置为 获取了  $rule 并且 $GET 进行了重新的准备 $rules

// 分析PATHINFO信息
if(!isset($_SERVER['PATH_INFO'])) {
$types   =  explode(',',C('URL_PATHINFO_FETCH'));
// 'URL_PATHINFO_FETCH'    =>  'ORIG_PATH_INFO,REDIRECT_PATH_INFO,REDIRECT_URL', // 用于兼容判断PATH_INFO 参数的SERVER替代变量列表
foreach ($types as $type){
if(0===strpos($type,':')) {// 支持函数判断
// 居然还能外加函数，你牛逼啊
$_SERVER['PATH_INFO'] =   call_user_func(substr($type,1));
break;
}elseif(!empty($_SERVER[$type])) {
$_SERVER['PATH_INFO'] = (0 === strpos($_SERVER[$type],$_SERVER['SCRIPT_NAME']))?
substr($_SERVER[$type], strlen($_SERVER['SCRIPT_NAME']))   :  $_SERVER[$type];
break;
}
}
} // 你这里是解析了啥呢？哈哈

$depr = C('URL_PATHINFO_DEPR');
// 'URL_PATHINFO_DEPR'     =>  '/', // PATHINFO模式下，各参数之间的分割符号
define('MODULE_PATHINFO_DEPR',  $depr); // 定义了这个

if(empty($_SERVER['PATH_INFO'])) { // 一般情况下，好像现在转成的都
$_SERVER['PATH_INFO'] = '';
define('__INFO__','');
define('__EXT__','');
}else{ // 这个是含有对应关系的
define('__INFO__',trim($_SERVER['PATH_INFO'],'/'));
// URL后缀
define('__EXT__', strtolower(pathinfo($_SERVER['PATH_INFO'],PATHINFO_EXTENSION)));
$_SERVER['PATH_INFO'] = __INFO__;
if(!defined('BIND_MODULE') && (!C('URL_ROUTER_ON') || !Route::check())){
if (__INFO__ && C('MULTI_MODULE')){ // 获取模块名
$paths      =   explode($depr,__INFO__,2);
$allowList  =   C('MODULE_ALLOW_LIST'); // 允许的模块列表
$module     =   preg_replace('/\.' . __EXT__ . '$/i', '',$paths[0]);
if( empty($allowList) || (is_array($allowList) && in_array_case($module, $allowList))){
$_GET[$varModule]       =   $module;
$_SERVER['PATH_INFO']   =   isset($paths[1])?$paths[1]:'';
}
}
}
}

// URL常量
define('__SELF__',strip_tags($_SERVER[C('URL_REQUEST_URI')]));

// 获取模块名称
define('MODULE_NAME', defined('BIND_MODULE')? BIND_MODULE : self::getModule($varModule));

// 准备好了数据、然后开始处理你需要的流程了
// 检测模块是否存在
if( MODULE_NAME && (defined('BIND_MODULE') || !in_array_case(MODULE_NAME,C('MODULE_DENY_LIST')) ) && is_dir(APP_PATH.MODULE_NAME)){
// 定义当前模块路径
define('MODULE_PATH', APP_PATH.MODULE_NAME.'/');
// 定义当前模块的模版缓存路径
C('CACHE_PATH',CACHE_PATH.MODULE_NAME.'/');
// 定义当前模块的日志目录
C('LOG_PATH',  realpath(LOG_PATH).'/'.MODULE_NAME.'/'); // 定义了 很多东西了

// 模块检测
Hook::listen('module_check'); // 监听了

// 加载模块配置文件
if(is_file(MODULE_PATH.'Conf/config'.CONF_EXT))
C(load_config(MODULE_PATH.'Conf/config'.CONF_EXT)); // 加载 不同位置
// 加载应用模式对应的配置文件
if('common' != APP_MODE && is_file(MODULE_PATH.'Conf/config_'.APP_MODE.CONF_EXT))
C(load_config(MODULE_PATH.'Conf/config_'.APP_MODE.CONF_EXT));
// 当前应用状态对应的配置文件
if(APP_STATUS && is_file(MODULE_PATH.'Conf/'.APP_STATUS.CONF_EXT))
C(load_config(MODULE_PATH.'Conf/'.APP_STATUS.CONF_EXT));

// 加载模块别名定义
if(is_file(MODULE_PATH.'Conf/alias.php'))
Think::addMap(include MODULE_PATH.'Conf/alias.php'); // 加载了 不同的类型
// 加载模块tags文件定义
if(is_file(MODULE_PATH.'Conf/tags.php'))
Hook::import(include MODULE_PATH.'Conf/tags.php');
// 加载模块函数文件
if(is_file(MODULE_PATH.'Common/function.php'))
include MODULE_PATH.'Common/function.php'; // 加载了 各种各样的东西

$urlCase        =   C('URL_CASE_INSENSITIVE');
// 加载模块的扩展配置文件
load_ext_file(MODULE_PATH); // 里面的 东西
}else{
E(L('_MODULE_NOT_EXIST_').':'.MODULE_NAME);
}

if(!defined('__APP__')){
$urlMode        =   C('URL_MODEL');
if($urlMode == URL_COMPAT ){// 兼容模式判断
define('PHP_FILE',_PHP_FILE_.'?'.$varPath.'=');
}elseif($urlMode == URL_REWRITE ) {
$url    =   dirname(_PHP_FILE_);
if($url == '/' || $url == '\\')
$url    =   '';
define('PHP_FILE',$url);
}else {
define('PHP_FILE',_PHP_FILE_);
}
// 当前应用地址
define('__APP__',strip_tags(PHP_FILE));
}
// 处理 __APP__ 里面的 东西
// 模块URL地址
$moduleName    =   defined('MODULE_ALIAS')? MODULE_ALIAS : MODULE_NAME;
define('__MODULE__',(defined('BIND_MODULE') || !C('MULTI_MODULE'))? __APP__ : __APP__.'/'.($urlCase ? strtolower($moduleName) : $moduleName));

if('' != $_SERVER['PATH_INFO'] && (!C('URL_ROUTER_ON') ||  !Route::check()) ){   // 检测路由规则 如果没有则按默认规则调度URL
Hook::listen('path_info');
// 检查禁止访问的URL后缀
if(C('URL_DENY_SUFFIX') && preg_match('/\.('.trim(C('URL_DENY_SUFFIX'),'.').')$/i', $_SERVER['PATH_INFO'])){
send_http_status(404);
exit;
}

// 去除URL后缀
$_SERVER['PATH_INFO'] = preg_replace(C('URL_HTML_SUFFIX')? '/\.('.trim(C('URL_HTML_SUFFIX'),'.').')$/i' : '/\.'.__EXT__.'$/i', '', $_SERVER['PATH_INFO']);

$depr   =   C('URL_PATHINFO_DEPR'); // 获取信息
$paths  =   explode($depr,trim($_SERVER['PATH_INFO'],$depr));

if(!defined('BIND_CONTROLLER')) {// 获取控制器
if(C('CONTROLLER_LEVEL')>1){// 控制器层次
$_GET[$varController]   =   implode('/',array_slice($paths,0,C('CONTROLLER_LEVEL')));
$paths  =   array_slice($paths, C('CONTROLLER_LEVEL'));
}else{
$_GET[$varController]   =   array_shift($paths);
}
}
// 获取操作
if(!defined('BIND_ACTION')){
$_GET[$varAction]  =   array_shift($paths);
}
// 解析剩余的URL参数
$var  =  array();
if(C('URL_PARAMS_BIND') && 1 == C('URL_PARAMS_BIND_TYPE')){
// URL参数按顺序绑定变量
$var    =   $paths;
}else{
preg_replace_callback('/(\w+)\/([^\/]+)/', function($match) use(&$var){$var[$match[1]]=strip_tags($match[2]);}, implode('/',$paths));
}
$_GET   =  array_merge($var,$_GET);
}
// 获取控制器的命名空间（路径）
define('CONTROLLER_PATH',   self::getSpace($varAddon,$urlCase));
// 获取控制器和操作名
define('CONTROLLER_NAME',   defined('BIND_CONTROLLER')? BIND_CONTROLLER : self::getController($varController,$urlCase));
define('ACTION_NAME',       defined('BIND_ACTION')? BIND_ACTION : self::getAction($varAction,$urlCase));

// 当前控制器的UR地址
$controllerName    =   defined('CONTROLLER_ALIAS')? CONTROLLER_ALIAS : CONTROLLER_NAME;
define('__CONTROLLER__',__MODULE__.$depr.(defined('BIND_CONTROLLER')? '': ( $urlCase ? parse_name($controllerName) : $controllerName )) );

// 当前操作的URL地址
define('__ACTION__',__CONTROLLER__.$depr.(defined('ACTION_ALIAS')?ACTION_ALIAS:ACTION_NAME));

//保证$_REQUEST正常取值
$_REQUEST = array_merge($_POST,$_GET,$_COOKIE); // -- 加了$_COOKIE.  保证哦..  // 搞了半天什么都有了
}
// 进过了这里的东西，折腾了一圈后发现了，其实，就是里面的 东西 都是 重新定义了 里面的 东西了。

/**
* 获得控制器的命名空间路径 便于插件机制访问
* 获取 控制器 命名空间
*/
static private function getSpace($var,$urlCase) {
$space  =   !empty($_GET[$var])?strip_tags($_GET[$var]):''; // strip_tags() 函数剥去字符串中的 HTML、XML 以及 PHP 的标签。
unset($_GET[$var]); // 删除了 里面 变量了
return $space;
}// 这里的 东西 可以变成了

/**
* 获得实际的控制器名称
* 这里 控制器
*/
static private function getController($var,$urlCase) {
$controller = (!empty($_GET[$var])? $_GET[$var]:C('DEFAULT_CONTROLLER'));
unset($_GET[$var]); // 去掉了 里面的东西了
if($maps = C('URL_CONTROLLER_MAP')) {
if(isset($maps[strtolower($controller)])) {
// 记录当前别名
define('CONTROLLER_ALIAS',strtolower($controller));
// 获取实际的控制器名
return   ucfirst($maps[CONTROLLER_ALIAS]);
}elseif(array_search(strtolower($controller),$maps)){// 这里进行了 控制 了
// 禁止访问原始控制器
return   '';
}
}
if($urlCase) {
// URL地址不区分大小写
// 智能识别方式 user_type 识别到 UserTypeController 控制器
$controller = parse_name($controller,1); // 解析 里面的 东西
}
return strip_tags(ucfirst($controller));
}

/**
* 获得实际的操作名称
* 获取了 Action 里面的
*/
static private function getAction($var,$urlCase) {
$action   = !empty($_POST[$var]) ?
$_POST[$var] :
(!empty($_GET[$var])?$_GET[$var]:C('DEFAULT_ACTION'));
unset($_POST[$var],$_GET[$var]);
if($maps = C('URL_ACTION_MAP')) {
if(isset($maps[strtolower(CONTROLLER_NAME)])) {
$maps =   $maps[strtolower(CONTROLLER_NAME)];
if(isset($maps[strtolower($action)])) {
// 记录当前别名
define('ACTION_ALIAS',strtolower($action));
// 获取实际的操作名
if(is_array($maps[ACTION_ALIAS])){
parse_str($maps[ACTION_ALIAS][1],$vars);
$_GET   =   array_merge($_GET,$vars);
return $maps[ACTION_ALIAS][0];
}else{
return $maps[ACTION_ALIAS];
}

}elseif(array_search(strtolower($action),$maps)){
// 禁止访问原始操作
return   '';
}
}
}
return strip_tags( $urlCase? strtolower($action) : $action );
}

/**
* 获得实际的模块名称
* 获取模块名
*/
static private function getModule($var) {
$module   = (!empty($_GET[$var])?$_GET[$var]:C('DEFAULT_MODULE'));
unset($_GET[$var]);
if($maps = C('URL_MODULE_MAP')) {
if(isset($maps[strtolower($module)])) {
// 记录当前别名
define('MODULE_ALIAS',strtolower($module));
// 获取实际的模块名
return   ucfirst($maps[MODULE_ALIAS]);
}elseif(array_search(strtolower($module),$maps)){
// 禁止访问原始模块
return   '';
}
}
return strip_tags(ucfirst($module));
}

}