CodeIgniter源码阅读笔记2之Common.php
文件的一开始就有如下代码：
defined('BASEPATH') OR exit('No direct script access allowed');
这个是为了防止直接访问文件而写的，这样可以保证是从index.php访问过来的。
接下来两段代码引入了两个文件：
/*
* ------------------------------------------------------
* Load the framework constants
* ------------------------------------------------------
*/
// 引入全局变量文件
// 包括文件权限、open的标志位、是否显示backtrace、退出状态码
if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/constants.php'))
{
require_once(APPPATH.'config/'.ENVIRONMENT.'/constants.php');
}
require_once(APPPATH.'config/constants.php');
/*
* ------------------------------------------------------
* Load the global functions
* ------------------------------------------------------
*/
// 引入全局函数
require_once(BASEPATH.'core/Common.php');
我在注释中已经写明了这两个文件的作用，constants.php这个文件比较普通，没啥需要注意的，我们看看Common.php这个文件。
这个文件中定义了一些常用的公共函数，而且定义的方式也是比较特别，采用了如下的形式：
if (! function_exists('function_name'))
{
function function_name () {
//TODO
}
}
很明显这是为了防止函数名重复而采取的容错措施，所以用户在自己定义系统级的全局函数的时候也应该采用这种方式，防止函数名重复。
我们依次每个函数看一下。
is_php
很明显这个函数是用于判断版本号的，函数内部有一个static的$_is_php变量，用于缓存version_compare的结果，这样可以每次在使用is_php函数的时候提高效率。
/**
* Determines if the current version of PHP is equal to or greater than the supplied value
*
* @param string
* @return bool TRUE if the current version is $version or higher
*/
function is_php($version)
{
static $_is_php;
$version = (string) $version;
if ( ! isset($_is_php[$version]))
{
$_is_php[$version] = version_compare(PHP_VERSION, $version, '>=');
}
return $_is_php[$version];
}
is_really_writable
这个函数是用于判断某个文件或目录是否可写，本质上该函数是is_writable()的封装，至于为何要封装，有两点原因：
- 在windows系统中，如果设置了read-only属性，is_writable()会返回true，但是实际上该文件、目录并不可写。
- 在unix系统中，如果safe_mode的值为on，那么is_writable()的结果也会出现问题。
因此，is_really_writable()需要对这两种情况进行特殊判断，如果在Unix系统上，而且safe_mode的值为off，直接调用is_writable()。否则的话，如果目标是目录，则尝试写入一个文件来判断是否可写，如果目标是文件，则尝试使用fopen来判断是否可写。
/**
* 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.
*
* @link https://bugs.php.net/bug.php?id=54709
* @param string
* @return bool
*/
function is_really_writable($file)
{
// If we're on a Unix server with safe_mode off we call is_writable
if (DIRECTORY_SEPARATOR === '/' && (is_php('5.4') OR ! ini_get('safe_mode')))
{
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());
if (($fp = @fopen($file, 'ab')) === FALSE)
{
return FALSE;
}
fclose($fp);
@chmod($file, 0777);
@unlink($file);
return TRUE;
}
elseif ( ! is_file($file) OR ($fp = @fopen($file, 'ab')) === FALSE)
{
return FALSE;
}
fclose($fp);
return TRUE;
}
load_class
这个函数比较特殊，返回的是类实例的引用，（参考资料：http://www.nowamagic.net/academy/detail/1205559）
该函数接受三个参数，分别是要加载的类名，该类文件所在的目录，以及传递给该类的构造函数的参数。
该函数的内部有一个$_classes数组，用于缓存已经实例化的类。如果需要加载的类已经加载过了，则直接从$_classes数组中进行返回。
对于类文件的寻找，会先寻找application/libraries目录，如果没有找到则会寻找system/libraries目录，如果这两个目录都没有找到的话，再继续从用户提供的$directory目录进行寻找。
查找完成后，继续查找扩展目录，如果找到的话把扩展文件也包含进来。
如果没有找到的话则返回503并退出。
接下来调用is_loaded()函数将其加入已经加载类的列表中，然后调用构造函数，并返回类的实例。
/**
* 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.
*
* @param string the class name being requested
* @param string the directory where the class should be found
* @param string an optional argument to pass to the class constructor
* @return object
*/
function &load_class($class, $directory = 'libraries', $param = NULL)
{
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)
{
if (file_exists($path.$directory.'/'.$class.'.php'))
{
$name = 'CI_'.$class;
if (class_exists($name, FALSE) === FALSE)
{
require_once($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) === FALSE)
{
require_once(APPPATH.$directory.'/'.$name.'.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 Exceptions class
set_status_header(503);
echo 'Unable to locate the specified class: '.$class.'.php';
exit(5); // EXIT_UNK_CLASS
}
// Keep track of what we just loaded
is_loaded($class);
$_classes[$class] = isset($param)
? new $name($param)
: new $name();
return $_classes[$class];
}
is_loaded
这个函数比较简单，注意下同样也是返回的引用。
/**
* Keeps track of which libraries have been loaded. This function is
* called by the load_class() function above
*
* @param string
* @return array
*/
function &is_loaded($class = '')
{
static $_is_loaded = array();
if ($class !== '')
{
$_is_loaded[strtolower($class)] = $class;
}
return $_is_loaded;
}
get_config
该函数主要是读取主要的config.php文件，可以在Config类没有实例化的情况下收集配置信息。注意该函数也是返回引用的。
这个函数只会加载主配置文件，如果存在对应环境的配置文件，则会加载对应的配置文件，因为在整个框架配置完成前（config实例化之前），需要该函数来读取对应的配置文件。
这里有一次动态替换配置信息的机会，只需要传递对应的数组即可，只有一次机会的原因在下个函数中说明。
/**
* Loads the main config.php file
*
* This function lets us grab the config file even if the Config class
* hasn't been instantiated yet
*
* @param array
* @return array
*/
function &get_config(Array $replace = array())
{
static $config;
if (empty($config))
{
$file_path = APPPATH.'config/config.php';
$found = FALSE;
if (file_exists($file_path))
{
$found = TRUE;
require($file_path);
}
// Is the config file in the environment folder?
if (file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/config.php'))
{
require($file_path);
}
elseif ( ! $found)
{
set_status_header(503);
echo 'The configuration file does not exist.';
exit(3); // EXIT_CONFIG
}
// Does the $config array exist in the file?
if ( ! isset($config) OR ! is_array($config))
{
set_status_header(503);
echo 'Your config file does not appear to be formatted correctly.';
exit(3); // EXIT_CONFIG
}
}
// Are any values being dynamically added or replaced?
foreach ($replace as $key => $val)
{
$config[$key] = $val;
}
return $config;
}
config_item
这个函数用于获取特定的配置项目，这里有一个$_config变量，用做类似缓存的作用，所以下面的get_config函数只有一次执行机会，这也是为何上面的函数说只有一次动态修改变量的机会。因为引用类型不能直接赋值给静态变量，所以这里使用数组的方式赋值。
/**
* Returns the specified config item
*
* @param string
* @return mixed
*/
function config_item($item)
{
static $_config;
if (empty($_config))
{
// references cannot be directly assigned to static variables, so we use an array
$_config[0] =& get_config();
}
return isset($_config[0][$item]) ? $_config[0][$item] : NULL;
}
get_mimes
这个文件也比较简单，就是返回了mimes.php文件中定义的MIME类型。
/**
* Returns the MIME types array from config/mimes.php
*
* @return array
*/
function &get_mimes()
{
static $_mimes;
if (empty($_mimes))
{
if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/mimes.php'))
{
$_mimes = include(APPPATH.'config/'.ENVIRONMENT.'/mimes.php');
}
elseif (file_exists(APPPATH.'config/mimes.php'))
{
$_mimes = include(APPPATH.'config/mimes.php');
}
else
{
$_mimes = array();
}
}
return $_mimes;
}
is_https/is_cli
这两个函数都比较简单，没啥好说的。
show_error/show_404
这俩函数没啥好说的，都会终止代码的执行，并显示相关的错误信息。
log_message
调用Log class来记录log信息，代码比较简单。
据说如果主配置文件中log_threshold被设置为0，则不会记录任何Log信息。
set_status_header
CI框架允许用户自定义HTTP协议的头信息，CI的Output组件提供了set_status_header接口，通过这个接口可以设置头信息。
_error_handler/_exception_handler/_shutdown_handler
一系列的错误处理函数，没有什么很特别的地方，与其他框架的类似。
remove_invisible_characters
这个函数比较简单，去除$str中的不可见字符，根据是否设置了$url_encoded参数来满足不同情况下的需求。
/**
* Remove Invisible Characters
*
* This prevents sandwiching null characters
* between ascii characters, like Java\0script.
*
* @param string
* @param bool
* @return string
*/
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
{
$str = preg_replace($non_displayables, '', $str, -1, $count);
}
while ($count);
return $str;
}
html_escape
这个函数是个递归调用，对传入参数数组中的每一个元素进行htmlspecialchars操作。
/**
* Returns HTML escaped variable.
*
* @param mixed $var The input string or array of strings to be escaped.
* @param bool $double_encode $double_encode set to FALSE prevents escaping twice.
* @return mixed The escaped string or array of strings as a result.
*/
function html_escape($var, $double_encode = TRUE)
{
if (empty($var))
{
return $var;
}
if (is_array($var))
{
return array_map('html_escape', $var, array_fill(0, count($var), $double_encode));
}
return htmlspecialchars($var, ENT_QUOTES, config_item('charset'), $double_encode);
}
_stringify_attributes
这个函数也比较简单，将传进来的数组展开为key=val的形式再传出，第二参数可以指定val的部分是否有双引号包裹。
/**
* Stringify attributes for use in HTML tags.
*
* Helper function used to convert a string, array, or object
* of attributes to a string.
*
* @param mixed string, array, object
* @param bool
* @return string
*/
function _stringify_attributes($attributes, $js = FALSE)
{
$atts = NULL;
if (empty($attributes))
{
return $atts;
}
if (is_string($attributes))
{
return ' '.$attributes;
}
$attributes = (array) $attributes;
foreach ($attributes as $key => $val)
{
$atts .= ($js) ? $key.'='.$val.',' : ' '.$key.'="'.$val.'"';
}
return rtrim($atts, ',');
}
function_usable
用于检测某个函数是否可用，因为如果加载了Suhosin扩展的话，会造成一些影响。注释中解释的比较明白了。
/**
* Function usable
*
* Executes a function_exists() check, and if the Suhosin PHP
* extension is loaded - checks whether the function that is
* checked might be disabled in there as well.
*
* This is useful as function_exists() will return FALSE for
* functions disabled via the *disable_functions* php.ini
* setting, but not for *suhosin.executor.func.blacklist* and
* *suhosin.executor.disable_eval*. These settings will just
* terminate script execution if a disabled function is executed.
*
* The above described behavior turned out to be a bug in Suhosin,
* but even though a fix was commited for 0.9.34 on 2012-02-12,
* that version is yet to be released. This function will therefore
* be just temporary, but would probably be kept for a few years.
*
* @link http://www.hardened-php.net/suhosin/
* @param string $function_name Function to check for
* @return bool TRUE if the function exists and is safe to call,
* FALSE otherwise.
*/
function function_usable($function_name)
{
static $_suhosin_func_blacklist;
if (function_exists($function_name))
{
if ( ! isset($_suhosin_func_blacklist))
{
if (extension_loaded('suhosin'))
{
$_suhosin_func_blacklist = explode(',', trim(ini_get('suhosin.executor.func.blacklist')));
if ( ! in_array('eval', $_suhosin_func_blacklist, TRUE) && ini_get('suhosin.executor.disable_eval'))
{
$_suhosin_func_blacklist[] = 'eval';
}
}
else
{
$_suhosin_func_blacklist = array();
}
}
return ! in_array($function_name, $_suhosin_func_blacklist, TRUE);
}
return FALSE;
}
