Y.class.php 13 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
<?php
/**
 * Y框架主入口文件 
 * 
 * @example 应用框架
 * <pre>
 *     $y = Framework_Y::instance($config);
 *     $y -> dispatch();
 * </pre>
 * 
 * @name Framework_Y
 * @package framework
 * @version 0.2 (2012-12-13 16:32:56) <fei.hong@yoho.cn> 
 * @since 0.1 (2012-6-26) <xiaoma>
 */
defined('DS') || define('DS', DIRECTORY_SEPARATOR);
defined('Y_DIR') || define('Y_DIR', dirname(__FILE__));

class Framework_Y 
{
	/**
	 * 初始化框架-初始化运行环境
	 *
	 * @param array $config 应用配置项
	 */
	private function __construct($config = null) 
	{
		self::registerAutoload();
		
		if (is_array($config))
		{ 
			$this->configure($config);
		}
	}
	
	/**
	 * 初始化框架配置
	 * 
	 * @param array $config 配置项
	 * @return void
	 * @since 0.2
	 */
	private function configure($config)
	{
		// 禁止 magic quotes
		if (phpversion() < '5.3')
		{
			set_magic_quotes_runtime(false);
		}
		
// 		// 处理被 magic quotes 自动转义过的数据
// 		if (get_magic_quotes_gpc())
// 		{
// 			$in = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
// 			while (list($k, $v) = each($in))
// 			{
// 				foreach ($v as $key => $val)
// 				{
// 					if (! is_array($val))
// 					{
// 						if (is_string($val) && ! is_numeric($val))
// 						{
// 							$in[$k][$key] = stripslashes($val);
// 						}
// 						continue;
// 					}
// 					$in[] = &$in[$k][$key];
// 				}
// 			}
// 			unset($in);
// 		}
		
		// 调试开关
		if (isset($config['Debug']) && $config['Debug'])
		{
    		ini_set('error_reporting', E_ALL);
    		ini_set('display_errors', 1);
    		
    		set_error_handler(array($this, 'handleError'), error_reporting());
		}
		
		// 设置时区
		if (isset($config['Default_Timezone']))
		{
			date_default_timezone_set($config['Default_Timezone']);
		}
		
		// 设置引入
		if (isset($config['Include_Path']))
		{
			set_include_path('.' . PATH_SEPARATOR . $config['Include_Path'] . PATH_SEPARATOR . get_include_path());
		}
		
		// 设置Session
		if (isset($config['Session_Handler']) && $config['Session_Handler'])
		{
			$saveHandlerClass = $config['Session_Handler'];
			$saveHandler = new $saveHandlerClass();
        	
        	session_set_save_handler(
        		array(&$saveHandler, 'open'), 
        		array(&$saveHandler, 'close'),
        		array(&$saveHandler, 'read'),
	            array(&$saveHandler, 'write'),
	            array(&$saveHandler, 'destroy'),
	            array(&$saveHandler, 'gc')
            );
		}
		
		// 初始化插件. 检查是否已经初始化, 如外部已设置,则不进行初始化,支持外部可扩展
		if (isset($config['Plugins'], $config['Plugins']['event']) && null === Framework_YPlugin::getPluginsConfig())
		{
			Framework_YPlugin::importPlugins($config['Plugins']);
		}
	    
	    // 静态注册APP应用配置, 备框架应用
	    C('APP', $config);
	}
	
	/**
	 * 请求派遣
	 * 
	 * @since 0.2
	 * @version 0.3
	 */
	public function dispatch($args = array())
	{
		// 实例化HTTP请求对象
		$request = Framework_YHttpRequest::instance();
		if ($args !== array() && is_array($args))
		{
			$request->setParams($args);
		}
		// 获得请求对应的 UDI(统一目的地信息)
		$udi = $request->requestUDI(true);
	
		// 模块名
		$module = $udi[Framework_YHttpRequest::UDI_MODULE];
		if ($module !== Framework_YHttpRequest::UDI_DEFAULT_MODULE)
		{
			$dir = C('APP.Module_Dir') . DS . strtolower($module);
			set_include_path('.' . PATH_SEPARATOR . $dir . PATH_SEPARATOR . get_include_path());
		}
		else
		{
			$dir = C('APP.Root_Dir');
		}
		
		$className = 'Controller_';
		$classFile = $dir . DS . 'controller';
		
		// 目录名
		$namespace = $udi[Framework_YHttpRequest::UDI_NAMESPACE];
		if ($namespace !== Framework_YHttpRequest::UDI_DEFAULT_NAMESPACE)
		{
			$className .= ucfirst($namespace) . '_';
			$classFile .= DS . $namespace;
		}
		
		// 控制器名
		$controller = ucfirst($udi[Framework_YHttpRequest::UDI_CONTROLLER]);
		
		// 类文件的完整路径
		$classFile .= DS . $controller . '.class.php';
		// 类的名称, 格式: Controller_目录名_控制器名
		$className .= $controller;
		
		// 存放响应结果
		$response = '';
		
		do
		{
			// 判断控制器文件是否存在
			if (!file_exists($classFile))
			{
				$response = $this->_on_controller_not_found($className);
				break;
			}
			
			// 执行插件
			if (null !== ($response = Framework_YPlugin::execute('beforeDispatch')))
			{
				break;
			}
			
			// 判断类文件是否能够加载
			if (!self::import($className, $dir))
			{
				break;
			}
			
			// 执行的操作
			$action = $udi[Framework_YHttpRequest::UDI_ACTION];
			
			$class = new $className();
			// 如果指定动作存在, 则调用执行Action
			if ($class->existsAction($action))
			{
				$response = $class->execute($action, $args);
				break;
			}
			
			// 如果指定动作不存在, 则尝试调用控制器的 _on_action_not_defined() 函数处理错误
			// 如果控制器的 _on_action_not_defined() 函数没有返回处理结果, 则由当前默认应用程序对象的 _on_action_not_defined() 函数处理
			if (method_exists($class, '_on_action_not_defined'))
			{
				$response = $class->_on_action_not_defined($action);
				break;
			}
			
			$response = $this->_on_action_not_defined($action);
		}
		while (false);
	
		// 如果返回的是对象并且包含execute方法,就执行此方法
		if (is_object($response) && method_exists($response, 'execute'))
		{
			$response = $response->execute();
		}
		// 如果是一个 Framework_Response_YForward 对象,则将请求进行转发
		elseif ($response instanceof Framework_Response_YForward)
		{
			$args = $response->getArgs();
			$response = $this->dispatch($args);
		}
	
		// 执行afterRender方法, 通知已经完成视图渲染并返回
		if (is_string($response))
		{
			Framework_YPlugin::execute('afterRender', $response);
		}
	
		echo (string) $response;
	}
	
	/**
	 * 实例化应用
	 *
	 * @param array $config 应用配置项
	 * @return Framework_Y
	 */
	public static function instance($config = null)
	{
		static $instance = null;
		
		if (null === $instance)
		{
			$instance = new self($config);
		}
		
		return $instance;
	}
	
	/**
	 * 加载类文件
	 *
	 * @param string $className  类的文件名
	 * @param string $dir  类文件所在的目录
	 * @param string $suffix  文件的后缀名
	 * @return boolean
	 * @since 0.3
	 */
	public static function import($className, $dir = '', $suffix = '.class.php')
	{
		// 若类或接口已定义, 则直接返回加载成功:true
		if (class_exists($className, false) || interface_exists($className, false))
		{
			return true;
		}
	
		// 若是加载框架类, 则直接加载并返回加载成功:true
		if (isset(self::$_coreClasses[$className]))
		{
			include Y_DIR . DS . self::$_coreClasses[$className];
			return true;
		}
	
		// 判断加载类文件的命名是否符合规范, 不符合则直接返回加载失败:false
		if (false === ($pos = strrpos($className, '_')))
		{
			return false;
		}
	
		// 构建类文件的完整路径, 返回格式: "路径/路径/文件名"
		$dir = empty($dir) ? '' : rtrim($dir, '\\/') . DS;
		$dir .= strtolower(str_replace('_', DS, substr($className, 0, $pos + 1)));
		$classFile = $dir . ucfirst(substr($className, $pos + 1)) . $suffix;
	
		// 文件绝对路径判断文件是否存在 (PHP > 5.2)
		if (function_exists('stream_resolve_include_path'))
		{
			if (false !== ($classFile = stream_resolve_include_path($classFile)))
			{
				require $classFile;
				return true;
			}
		}
		else
		{
			require $classFile;
			return true;
		}
	
		return false;
	}
	
	/**
	 * 注册自动加载
	 *
	 * @param string $func 注册方法
	 * @param boolean $enable 注册还是注稍
	 * @return void
	 * @since 0.3
	 */
	public static function registerAutoload($func = 'Framework_Y::import', $enable = true)
	{
		$enable ? spl_autoload_register($func) : spl_autoload_unregister($func);
	}

	/**
	 * 处理运行时发生的错误
	 *
	 * @param integer $code
	 * @param string $message
	 * @param string $file
	 * @param integer $line
	 */
	public function handleError($code, $message, $file, $line)
	{
		if ($code & error_reporting())
		{
			restore_error_handler();
			
			$log = "$message $file on line: $line<br>Stack trace:<br>";
			
			$trace = debug_backtrace();
			array_shift($trace);
			
			foreach ($trace as $i => $t)
			{
				if (! isset($t['file']))
					$t['file'] = 'unknown';
				if (! isset($t['line']))
					$t['line'] = 0;
				if (! isset($t['function']))
					$t['function'] = 'unknown';
				$log .= "#$i {$t['file']}({$t['line']}): ";
				if (isset($t['object']) && is_object($t['object']))
					$log .= get_class($t['object']).'->';
				$log .= "{$t['function']}()\n";
			}
			
			if (isset($_SERVER['REQUEST_URI']))
			{
				$log .= 'REQUEST_URI=' . $_SERVER['REQUEST_URI'] . "\n";
			}
			
			echo $log;
		}
	}
	
	/**
	 * 未定义的控制器 - 将错误指派到Error控制器
	 */
	protected function _on_controller_not_found($class) 
	{
		$controller = new Framework_YController();
		return $controller->_forward('default::error', array(
			'sign' => '_on_controller_not_found', 
			'error' => 'Undefined Controller: ' . $class 
		));
	}
	
	/**
	 * 未定义的操作方法 - 将错误指派到Error控制器
	 */
	protected function _on_action_not_defined($action) 
	{
		$controller = new Framework_YController();
		return $controller->_forward('default::error', array(
			'sign' => '_on_action_not_defined', 
			'error' => 'Undefined Action: ' . $action . 'Action' 
		));
	}
	
	/**
	 * 无权限 - 将错误指派到Error控制器
	 */
	protected function _on_not_allow() 
	{
		$controller = new Framework_YController();
		return $controller->_forward('default::error', array(
			'sign' => '_on_not_allow', 
			'error' => 'Not allow to access' 
		));
	}
	
	/**
	 * 核心类文件定义
	 *
	 * @var array
	 * @since 0.2
	 */
	private static $_coreClasses = array(
		'Framework_YComponent'	 => 'YComponent.class.php',
		'Framework_YController'	 => 'YController.class.php',
		'Framework_YException'	 => 'YException.class.php',
		'Framework_YHttpRequest' => 'YHttpRequest.class.php',
		'Framework_YLoader'	     => 'YLoader.class.php',
		'Framework_YPlugin'	     => 'YPlugin.class.php',
		'Framework_YRouter'	     => 'YRouter.class.php',
		'Framework_YService'	 => 'YService.class.php',
		'Framework_YView'	     => 'YView.class.php',
		'Framework_Response_YForward'     => 'response/YForward.class.php',
		'Framework_Response_YRedirect'    => 'response/YRedirect.class.php',
	);

}

/**
 * 转换 HTML 特殊字符,等同于 htmlspecialchars()
 *
 * @param string $text
 * @return string
 */
function h($text) 
{
	return htmlspecialchars($text);
}

/**
 * 用于输出一个变量的内容
 *
 * @param mixed $vars 要输出的变量
 * @param string $label 输出变量时显示的标签
 * @param boolean $return 是否返回输出内容
 *
 * @return string
 */
function dump($vars, $label = null, $return = false) 
{
	if (ini_get('html_errors')) 
	{
		$content = "<pre>\n";
		if ($label !== null && $label !== '') 
		{
			$content .= "<strong>{$label} :</strong>\n";
		}
		$content .= htmlspecialchars(print_r($vars, true));
		$content .= "\n</pre>\n";
	} 
	else 
	{
		$content = "\n";
		if ($label !== null && $label !== '') 
		{
			$content .= $label . " :\n";
		}
		$content .= print_r($vars, true) . "\n";
	}
	
	if ($return) 
	{
		return $content;
	}
	else
	{
		echo $content;
	}
}

/**
 * 设置/获取配置值(获取时,最多仅支持二维数组)
 *
 * @param string $name 配置名
 * @param mixed $value 对应值
 * @return mixed
 */
function C($name = null, $value = null) 
{
    static $_config = array();
    
    // 无参数时获取所有
    if (null === $name)
    {
        return $_config;
    }
    
    // 优先执行设置获取或赋值
    if (is_string($name)) 
    {
        if (!strpos($name, '.')) 
        {
            $name = strtolower($name);
            if (null === $value)
            {
            	return isset($_config[$name]) ? $_config[$name] : null;
            }
            $_config[$name] = $value;
        }
        else 
        {
	        // 二维数组设置和获取支持
	        $name = explode('.', $name);
	        $name[0] = strtolower($name[0]);
	        if (null === $value)
	        {
	        	return isset($_config[$name[0]][$name[1]]) ? $_config[$name[0]][$name[1]] : null;
	        }
	        $_config[$name[0]][$name[1]] = $value;
        }
        return;
    }
    
    // 批量设置
    if (is_array($name))
    {
        return $_config = array_merge($_config, array_change_key_case($name));
    }
    
    return null; // 避免非法参数
}

/**
 * Framework_YHttpRequest::url() 方法的简写,用于构造一个 URL 地址
 *
 * url() 方法的参数比较复杂,请参考 Framework_YHttpRequest::url() 方法的详细说明。
 *
 * @param string $udi UDI 字符串
 * @param array|string $params 附加参数数组
 * @param string $route 路由名
 * @param array $opts 控制如何生成 URL 的选项
 *
 * @return string 生成的 URL 地址
 */
function url($udi, $params = null, $route = null, array $opts = null)
{
	return Framework_YHttpRequest::instance()->url($udi, $params, $route, $opts);
}