CodeIgniter Common.php

<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 5.1.6 or newer
 *
 * @package CodeIgniter
 * @author ExpressionEngine Dev Team
 * @copyright Copyright (c) 2008 - 2011, EllisLab, Inc.
 * @license http://codeigniter.com/user_guide/license.html
 * @link http://codeigniter.com
 * @since Version 1.0
 * @filesource
 */


// ------------------------------------------------------------------------
//公共函数库
/**
 * Common Functions
 *
 * Loads the base classes and executes the request.
 *
 * @package CodeIgniter
 * @subpackage codeigniter
 * @category Common Functions
 * @author ExpressionEngine Dev Team
 * @link http://codeigniter.com/user_guide/
 */


// ------------------------------------------------------------------------


/**
* Determines if the current version of PHP is greater then the supplied value
*
* Since there are a few places where we conditionally test for PHP > 5
* we'll set a static variable.
*
* @access public
* @param string
* @return bool TRUE if the current version is $version or higher
*/
//判断正在使用的PHP的版本号是否高于你所提供的 version_number 。
if ( ! function_exists('is_php'))
{
function is_php($version = '5.0.0')
{
static $_is_php;
$version = (string)$version;


if ( ! isset($_is_php[$version]))
{
$_is_php[$version] = (version_compare(PHP_VERSION, $version) < 0) ? FALSE : TRUE;
}


return $_is_php[$version];
}
}


// ------------------------------------------------------------------------


/**
 * Tests for file writability
 *
 * is_writable() returns TRUE on Windows servers when you really can't write to
 * the file, based on the read-only attribute.  is_writable() is also unreliable
 * on Unix servers if safe_mode is on.
 *
 * @access private
 * @return void
 */
//在Windows平台，is_writable()函数在实际没有文件写权限时也返回真。那是因为，只有文件有只读属性时，操作系统才向PHP报告为假
//这个函数依靠对文件的先行写入来判断是否真的具有写权限。 通常情况下，只有在这个信息不可靠的平台上才推荐使用。
//注:此函数也可用于判断文件夹是否有可写权限。
if ( ! function_exists('is_really_writable'))
{
function is_really_writable($file)
{
// If we're on a Unix server with safe_mode off we call is_writable
if (DIRECTORY_SEPARATOR == '/' AND @ini_get("safe_mode") == FALSE)
{
return is_writable($file);
}


// For windows servers and safe_mode "on" installations we'll actually
// write a file then read it.  Bah...
if (is_dir($file))
{
$file = rtrim($file, '/').'/'.md5(mt_rand(1,100).mt_rand(1,100));


if (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
{
return FALSE;
}


fclose($fp);
@chmod($file, DIR_WRITE_MODE);
@unlink($file);
return TRUE;
}
elseif ( ! is_file($file) OR ($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
{
return FALSE;
}


fclose($fp);
return TRUE;
}
}


// ------------------------------------------------------------------------


/**
* Class registry
*
* This function acts as a singleton.  If the requested class does not
* exist it is instantiated and set to a static variable.  If it has
* previously been instantiated the variable is returned.
*
* @access public
* @param string the class name being requested
* @param string the directory where the class should be found
* @param string the class name prefix
* @return object
*/
//加载类，并返回一个实例
//这个函数在加载类的顺序上,是先去判断是否有你自己的扩展类，如果没有，就加载系统类。
//也就是说ci会先去你的application下面的libraries文件夹下查看有无这个类，没有去system下的libraries去寻找这个类。
if ( ! function_exists('load_class'))
{
加载类。默认是加载libraries里面的，如果要加载核心组件，$directory就为'core'
function &load_class($class, $directory = 'libraries', $prefix = 'CI_')
{
//静态数组 ,用一个静态数组，保存已经加载过的类的实例，防止多次实例消耗资源，实现单例化。
static $_classes = array();


// Does the class exist?  If so, we're done...
// 如果类已实例化，直接返回类对象
if (isset($_classes[$class]))
{
return $_classes[$class];
}


$name = FALSE;


// Look for the class first in the local application/libraries folder
// then in the native system/libraries folder
//查找类文件,先查找系统自带的类
foreach (array(APPPATH, BASEPATH) as $path)
{
//先查找application下的php类文件，然后查找system目录下的
if (file_exists($path.$directory.'/'.$class.'.php'))
{
$name = $prefix.$class;
if (class_exists($name) === FALSE)
{
require($path.$directory.'/'.$class.'.php');
}


break;
}
}


// Is the request a class extension?  If so we load it too
//查找自己扩展的类库
if (file_exists(APPPATH.$directory.'/'.config_item('subclass_prefix').$class.'.php'))
{
$name = config_item('subclass_prefix').$class;
if (class_exists($name) === FALSE)
{
require(APPPATH.$directory.'/'.config_item('subclass_prefix').$class.'.php');
}
}


// Did we find the class?
if ($name === FALSE)
{
// Note: We use exit() rather then show_error() in order to avoid a
// self-referencing loop with the Excptions class
exit('Unable to locate the specified class: '.$class.'.php');
}


// Keep track of what we just loaded
is_loaded($class);
//实例化对象
$_classes[$class] = new $name();
//返回对象
return $_classes[$class];
}
}


// --------------------------------------------------------------------


/**
* Keeps track of which libraries have been loaded.  This function is
* called by the load_class() function above
*
* @access public
* @return array
*/
 //记录有哪些类是已经被加载的。
if ( ! function_exists('is_loaded'))
{
function &is_loaded($class = '')
{
static $_is_loaded = array();


if ($class != '')
{
$_is_loaded[strtolower($class)] = $class;
}
return $_is_loaded;
}
}


// ------------------------------------------------------------------------


/**
* Loads the main config.php file
*
* This function lets us grab the config file even if the Config class
* hasn't been instantiated yet
*
* @access private
* @return array
*/
//返回application/config/config.php文件中的参数列表
//加载配置文件 同时也可以动态的替换配置文件中的配置
if ( ! function_exists('get_config'))
{
//这个$replace参数，是提供一个临时替换配置信息的机会，仅一次，因为执行一次后
//配置信息都会保存在静态变量$_config中，不能再次改变
function &get_config($replace = array())
{

static $_config;
if (isset($_config))
{
return $_config[0];
}
// Is the config file in the environment folder?
//APPPATH.'config/'.ENVIRONMENT.'/config.php路径下有config文件，就加载此文件
if ( ! defined('ENVIRONMENT') OR ! file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/config.php'))
{
$file_path = APPPATH.'config/config.php';
}


// Fetch the config file
if ( ! file_exists($file_path))
{
exit('The configuration file does not exist.');
}


require($file_path);


// Does the $config array exist in the file?
if ( ! isset($config) OR ! is_array($config))
{
exit('Your config file does not appear to be formatted correctly.');
}


// Are any values being dynamically replaced?
if (count($replace) > 0)
{
//动态的替换配置文件
foreach ($replace as $key => $val)
{
if (isset($config[$key]))
{
$config[$key] = $val;
}
}
}
return $_config[0] =& $config;
}
}


// ------------------------------------------------------------------------


/**
* Returns the specified config item
* @access public
* @return mixed
*/
  //取得配置数组中某个元素。
  //此函数获取的是从config文件直接获取的值，无法取得配置类 set_item() 函数变更后的值。
if ( ! function_exists('config_item'))
{
function config_item($item)
{
static $_config_item = array();
//根据$item返回配置文件中的某一项
if ( ! isset($_config_item[$item]))
{
$config =& get_config();


if ( ! isset($config[$item]))
{
return FALSE;
}
$_config_item[$item] = $config[$item];
}


return $_config_item[$item];
}
}


// ------------------------------------------------------------------------


/**
* Error Handler
*
* This function lets us invoke the exception class and
* display errors using the standard error template located
* in application/errors/errors.php
* This function will send the error page directly to the
* browser and exit.
*
* @access public
* @return void
*/
//调用异常类
//显示错误文件的模板，可以在core下的Exception中进行修改
if ( ! function_exists('show_error'))
{
function show_error($message, $status_code = 500, $heading = 'An Error Was Encountered')
{
$_error =& load_class('Exceptions', 'core');
echo $_error->show_error($heading, $message, 'error_general', $status_code);
exit;
}
}


// ------------------------------------------------------------------------


/**
* 404 Page Handler
*
* This function is similar to the show_error() function above
* However, instead of the standard error template it displays
* 404 errors.
*
* @access public
* @return void
*/
//显示404错误
if ( ! function_exists('show_404'))
{
function show_404($page = '', $log_error = TRUE)
{
$_error =& load_class('Exceptions', 'core');
$_error->show_404($page, $log_error);
exit;
}
}


// ------------------------------------------------------------------------


/**
* Error Logging Interface
*
* We use this as a simple mechanism to access the logging
* class and send messages to be logged.
*
* @access public
* @return void
*/
日志记录，根据配置文件是否要记录日志
if ( ! function_exists('log_message'))
{
function log_message($level = 'error', $message, $php_error = FALSE)
{
static $_log;
//是否记录日志
if (config_item('log_threshold') == 0)
{
return;
}


$_log =& load_class('Log');
$_log->write_log($level, $message, $php_error);
}
}


// ------------------------------------------------------------------------


/**
 * Set HTTP Status Header
 *
 * @access public
 * @param int the status code
 * @param string
 * @return void
 */
//此函数构造一个http响应头。$stati为响应码与其响应说明。
if ( ! function_exists('set_status_header'))
{
function set_status_header($code = 200, $text = '')
{
$stati = array(
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',


300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',


400 => 'Bad Request',
401 => 'Unauthorized',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',


500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported'
);
//$code不合法直接500错误
if ($code == '' OR ! is_numeric($code))
{
show_error('Status codes must be numeric', 500);
}
//获取代码对应的异常信息
if (isset($stati[$code]) AND $text == '')
{
$text = $stati[$code];
}


if ($text == '')
{
show_error('No status text available.  Please check your status code number or supply your own message text.', 500);
}


$server_protocol = (isset($_SERVER['SERVER_PROTOCOL'])) ? $_SERVER['SERVER_PROTOCOL'] : FALSE;


if (substr(php_sapi_name(), 0, 3) == 'cgi')
{
header("Status: {$code} {$text}", TRUE);
}
elseif ($server_protocol == 'HTTP/1.1' OR $server_protocol == 'HTTP/1.0')
{
header($server_protocol." {$code} {$text}", TRUE, $code);
}
else
{
header("HTTP/1.1 {$code} {$text}", TRUE, $code);
}
}
}


// --------------------------------------------------------------------


/**
* Exception Handler
*
* This is the custom exception handler that is declaired at the top
* of Codeigniter.php.  The main reason we use this is to permit
* PHP errors to be logged in our own log files since the user may
* not have access to server logs. Since this function
* effectively intercepts PHP errors, however, we also need
* to display errors based on the current error_reporting level.
* We do that with the use of a PHP error template.
*
* @access private
* @return void
*/
//异常处理函数
if ( ! function_exists('_exception_handler'))
{
//在CodeIgniter.php中执行set_error_handler('_exception_handler');后，以后一切非致命(非fatal)错误信息都由它处理。
  //触发错误的时候，会产生几个参数，错误级别（号），错误信息，错误文件，错误行。
function _exception_handler($severity, $message, $filepath, $line)
{
// We don't bother with "strict" notices since they tend to fill up
// the log file with excess information that isn't normally very helpful.
// For example, if you are running PHP 5 and you use version 4 style
// class functions (without prefixes like "public", "private", etc.)
// you'll get notices telling you that these have been deprecated.
//E_STRICT对于大多数情况来说都是没多大作用的错误提示，这里CI把它屏蔽掉，如果实在要查看，可以查看日志文件。
if ($severity == E_STRICT)
{
return;
}
//真正起到错误处理的是Exception组件。
$_error =& load_class('Exceptions', 'core');


// Should we display the error? We'll get the current error_reporting
// level and add its bits with the severity bits to find out.
/*
  * 注意下面的符号是&而不是&&，php的错误等级的值都是有规律的，例如1,2,4,8...（1,10,100,1000）等等，实际上，php是通过位运算来实现的，
  * 使得错误控制更精准。（类似linux的权限控制，rwx）
  * 在设置error_reporting()的时候，可通过E_XX|E_YY|E_ZZ的形式来设置，而判断的时候则通过E_XX&error_repoorting()来判断
  * E_XX有没有设置。例如1,10,100,1000相或|，则值为1111,则以后1,10,100,1000中任意一个与1111相&,值都为它本身。
  * 而E_ALL可以看到是除E_STRICT之外其它等级的“或(|)运算”。个人理解，之所以E_ALL的值是不同版本有所不同的，是
  * 因为有时候会加入新的错误级别，从而导致这个E_ALL的值也不一样。
  */
if (($severity & error_reporting()) == $severity)
{
//如果符合则交给Exception组件的show_php_error();进行处理。
$_error->show_php_error($severity, $message, $filepath, $line);
}
//下面两行只是根据配置文件判断要不要log错误信息而已。
// Should we log the error?  No?  We're done...
if (config_item('log_threshold') == 0)
{
return;
}


$_error->log_exception($severity, $message, $filepath, $line);
}
}


// --------------------------------------------------------------------


/**
 * Remove Invisible Characters
 *
 * This prevents sandwiching null characters
 * between ascii characters, like Java\0script.
 *
 * @access public
 * @param string
 * @return string
 */
//这个函数能防止在ASCII字符之间插入空字符
if ( ! function_exists('remove_invisible_characters'))
{
function remove_invisible_characters($str, $url_encoded = TRUE)
{
$non_displayables = array();

// every control character except newline (dec 10)
// carriage return (dec 13), and horizontal tab (dec 09)

if ($url_encoded)
{
$non_displayables[] = '/%0[0-8bcef]/'; // url encoded 00-08, 11, 12, 14, 15
$non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
}

$non_displayables[] = '/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]+/S'; // 00-08, 11, 12, 14-31, 127



do
{
//符合$non_displayables的模式的字符串都会被删除
$str = preg_replace($non_displayables, '', $str, -1, $count);
}
while ($count);


return $str;
}
}


// ------------------------------------------------------------------------


/**
* Returns HTML escaped variable
*
* @access public
* @param mixed
* @return mixed
*/
/*  htmlspecialchars() 函数把一些预定义的字符转换为 HTML 实体。
预定义的字符是：
& （和号） 成为 &amp;
" （双引号） 成为 &quot;
' （单引号） 成为 &#039;
< （小于） 成为 &lt;
> （大于） 成为 &gt;
 */


//利用此功能可以方便的使用htmlspecialchars()函数。它接受字符串和数组。有助于防止跨站脚本攻击（XSS）。
if ( ! function_exists('html_escape'))
{
function html_escape($var)
{
if (is_array($var))
{
return array_map('html_escape', $var);
}
else
{
return htmlspecialchars($var, ENT_QUOTES, config_item('charset'));
}
}
}


/* End of file Common.php */
/* Location: ./system/core/Common.php */