CI源码分析-common.php文件(公共函数)

这个文件主要是CI一些常用的函数

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
<?php
// 通过BASEPATH判断文件的执行类型,禁止用户直接访问本文件
defined('BASEPATH') OR exit('No direct script access allowed');
// 判断当前运行的 PHP 版本是否高于或等于你提供的版本号。
if ( ! function_exists('is_php'))
{
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];
}
}
// 判断文件或目录是否可写
if ( ! function_exists('is_really_writable'))
{
function is_really_writable($file)
{
// 如果是在Unix系操作系统上运行,并且PHP版本在5.4之上,没有开启安全模式
// 直接使用php自带函数进行判断可写
if (DIRECTORY_SEPARATOR === '/' && (is_php('5.4') OR ! ini_get('safe_mode')))
{
return is_writable($file);
}
// 如果是一个目录,创建一个随机文件去判断目录可写状态
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;
} // 如果不是目录也不是文件,或者是文件但是不可写,返回FALSE
elseif ( ! is_file($file) OR ($fp = @fopen($file, 'ab')) === FALSE)
{
return FALSE;
}
// 可写
fclose($fp); // 这里是关闭刚刚检测文件用的fd
return TRUE;
}
}
// 加载一个类
if ( ! function_exists('load_class'))
{
function &load_class($class, $directory = 'libraries', $param = NULL)
{
static $_classes = array();
// 检查类是不是已经被加载过,如果被加载过,直接返回
if (isset($_classes[$class]))
{
return $_classes[$class];
}
$name = FALSE;
// 先在应用目录内检查文件
// 然后在CI目录内检查文件
foreach (array(APPPATH, BASEPATH) as $path)
{
// 如果文件存在
if (file_exists($path.$directory.'/'.$class.'.php'))
{
$name = 'CI_'.$class; // 加载类名以CI_开头
// 防止同类名被重复加载
if (class_exists($name, FALSE) === FALSE)
{
require_once($path.$directory.'/'.$class.'.php');
}
break;
}
}
// 用户可以定义类前缀
// 在config/config.php文件的subclass_prefix设置中。
// 这个设置默认为MY_
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');
}
}
// 通过$name的值判断是否已经找到了这个类
if ($name === FALSE)
{
// 如果没有找到这个类,发送503响应
set_status_header(503);
echo 'Unable to locate the specified class: '.$class.'.php';
exit(5); // EXIT_UNK_CLASS
}
// 调用is_loaded,表示这个类已经加载
is_loaded($class);
$_classes[$class] = isset($param)
? new $name($param)
: new $name();
return $_classes[$class];
}
}
// 这个函数被上面那个load_class调用
// 将一个类标记为已加载
if ( ! function_exists('is_loaded'))
{
function &is_loaded($class = '')
{
static $_is_loaded = array();
if ($class !== '')
{
$_is_loaded[strtolower($class)] = $class;
}
return $_is_loaded;
}
}
// 加载配置文件,config.php
if ( ! function_exists('get_config'))
{
function &get_config(Array $replace = array())
{
static $config;
if (empty($config))
{
// 首先检查config/config.php
$file_path = APPPATH.'config/config.php';
$found = FALSE;
if (file_exists($file_path))
{
$found = TRUE;
require($file_path);
}
// 如果有针对不同环境的配置文件
if (file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/config.php'))
{
require($file_path);
}
// 如果没有找到config/config.php,并且也没有针对环境的配置
elseif ( ! $found)
{
// 发送503响应
set_status_header(503);
echo 'The configuration file does not exist.';
exit(3); // EXIT_CONFIG
}
// 如果配置文件内没有配置信息,或者配置信息不是数组
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
}
}
// 从参数内传数字,用来动态替换config的值
foreach ($replace as $key => $val)
{
$config[$key] = $val;
}
return $config;
}
}
// 读取配置条目
if ( ! function_exists('config_item'))
{
function config_item($item)
{
static $_config;
if (empty($_config))
{
// 如果是第一次读取,就需要从文件内加载
// 调用上面那个函数加载配置文件
$_config[0] =& get_config();
}
// 默认返回NULL
return isset($_config[0][$item]) ? $_config[0][$item] : NULL;
}
}
// 获取文件mime类型
if ( ! function_exists('get_mimes'))
{
function &get_mimes()
{
static $_mimes;
if (empty($_mimes))
{
$_mimes = file_exists(APPPATH.'config/mimes.php')
? include(APPPATH.'config/mimes.php')
: array();
// 允许针对环境的配置替换mime信息
if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/mimes.php'))
{
$_mimes = array_merge($_mimes, include(APPPATH.'config/'.ENVIRONMENT.'/mimes.php'));
}
}
return $_mimes;
}
}
// 判断是否为https
if ( ! function_exists('is_https'))
{
function is_https()
{
if ( ! empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off')
{
return TRUE;
}
elseif (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) === 'https')
{
return TRUE;
}
elseif ( ! empty($_SERVER['HTTP_FRONT_END_HTTPS']) && strtolower($_SERVER['HTTP_FRONT_END_HTTPS']) !== 'off')
{
return TRUE;
}
return FALSE;
}
}
// 判断CI是否在命令行运行
if ( ! function_exists('is_cli'))
{
function is_cli()
{
return (PHP_SAPI === 'cli' OR defined('STDIN'));
}
}
// 显示错误信息
if ( ! function_exists('show_error'))
{
function show_error($message, $status_code = 500, $heading = 'An Error Was Encountered')
{
$status_code = abs($status_code); // HTTP代码当然是不允许为负数的
if ($status_code < 100) //当然,代码也不能在100以下
{
// 100以下返回500错误
$exit_status = $status_code + 9; // 9 is EXIT__AUTO_MIN
$status_code = 500;
}
else
{
$exit_status = 1; // EXIT_ERROR
}
// 显示错误
$_error =& load_class('Exceptions', 'core'); // 加载异常类。这个函数在上面我们解释过
echo $_error->show_error($heading, $message, 'error_general', $status_code);
exit($exit_status);
}
}
// 显示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(4); // EXIT_UNKNOWN_FILE
}
}
// 保存日志,这个类我们在后面讲
if ( ! function_exists('log_message'))
{
function log_message($level, $message)
{
static $_log;
if ($_log === NULL)
{
$_log[0] =& load_class('Log', 'core');
}
$_log[0]->write_log($level, $message);
}
}
// 发送HTTP响应
if ( ! function_exists('set_status_header'))
{
function set_status_header($code = 200, $text = '')
{
// 这里不需要多说吧。命令行模式当然不需要发送HTTP响应
if (is_cli())
{
return;
}
// 这里的code必须是数字
if (empty($code) OR ! is_numeric($code))
{
show_error('Status codes must be numeric', 500);
}
// 从HTTP状态设置相应的文字
if (empty($text))
{
is_int($code) OR $code = (int) $code;
$stati = array(
100 => 'Continue',
101 => 'Switching Protocols',
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',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
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',
422 => 'Unprocessable Entity',
426 => 'Upgrade Required',
428 => 'Precondition Required',
429 => 'Too Many Requests',
431 => 'Request Header Fields Too Large',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported',
511 => 'Network Authentication Required',
);
// 如果存在定义
if (isset($stati[$code]))
{
$text = $stati[$code];
}
else // 如果调用者没有设置显示文字,并且根据状态也找不到对应的文字
{
show_error('No status text available. Please check your status code number or supply your own message text.', 500);
}
}
// 如果是CGI运行
if (strpos(PHP_SAPI, 'cgi') === 0)
{
header('Status: '.$code.' '.$text, TRUE);
return;
}
// 不是CGI运行,直接发送HTTP头信息
$server_protocol = (isset($_SERVER['SERVER_PROTOCOL']) && in_array($_SERVER['SERVER_PROTOCOL'], array('HTTP/1.0', 'HTTP/1.1', 'HTTP/2'), TRUE))
? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
header($server_protocol.' '.$code.' '.$text, TRUE, $code);
}
}
// CI错误报告
if ( ! function_exists('_error_handler'))
{
function _error_handler($severity, $message, $filepath, $line)
{
// 这。。。。判断错误等级
$is_error = (((E_ERROR | E_PARSE | E_COMPILE_ERROR | E_CORE_ERROR | E_USER_ERROR) & $severity) === $severity);
// 如果必须终止运行,则发送500响应
if ($is_error)
{
set_status_header(500);
}
// 如果错误不在报告列表内,则不报告
if (($severity & error_reporting()) !== $severity)
{
return;
}
// 记录错误
$_error =& load_class('Exceptions', 'core');
$_error->log_exception($severity, $message, $filepath, $line);
// 判断是否需要报告
if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors')))
{
$_error->show_php_error($severity, $message, $filepath, $line);
}
// 发送500之后终止运行
if ($is_error)
{
exit(1); // EXIT_ERROR
}
}
}
// 同上,异常处理
if ( ! function_exists('_exception_handler'))
{
function _exception_handler($exception)
{
$_error =& load_class('Exceptions', 'core');
$_error->log_exception('error', 'Exception: '.$exception->getMessage(), $exception->getFile(), $exception->getLine());
is_cli() OR set_status_header(500); // 如果不是命令行运行,则发送500
// 判断是否需要报告
if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors')))
{
$_error->show_exception($exception);
}
exit(1); // EXIT_ERROR
}
}
// 这仨函数同一个用途,看看就好了。。。我都懒得去一句一句的分析
if ( ! function_exists('_shutdown_handler'))
{
function _shutdown_handler()
{
$last_error = error_get_last();
if (isset($last_error) &&
($last_error['type'] & (E_ERROR | E_PARSE | E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_COMPILE_WARNING)))
{
_error_handler($last_error['type'], $last_error['message'], $last_error['file'], $last_error['line']);
}
}
}
// 移除不可显示的字符
if ( ! function_exists('remove_invisible_characters'))
{
function remove_invisible_characters($str, $url_encoded = TRUE)
{
$non_displayables = array();
// 如果是URL编码之后的
if ($url_encoded)
{
$non_displayables[] = '/%0[0-8bcef]/i'; // url encoded 00-08, 11, 12, 14, 15
$non_displayables[] = '/%1[0-9a-f]/i'; // url encoded 16-31
$non_displayables[] = '/%7f/i'; // url encoded 127
}
$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编码
if ( ! function_exists('html_escape'))
{
function html_escape($var, $double_encode = TRUE)
{
// 空的当然不需要编码
if (empty($var))
return $var;
// 如果是数组,则遍历之后编码返回
if (is_array($var))
{
foreach (array_keys($var) as $key)
{
$var[$key] = html_escape($var[$key], $double_encode);
}
return $var;
}
//调用原生函数
return htmlspecialchars($var, ENT_QUOTES, config_item('charset'), $double_encode);
}
}
/**
* 看到我用多行注释就懂了吧,这个函数要好好讲讲
*
* 参数转字符串
* 例如 ['a'=>'123','b'=>'456'] 转换为 a=123,b=456
* 第二个参数用来控制是否使用逗号
*/
if ( ! function_exists('_stringify_attributes'))
{
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, ',');
}
}
// ------------------------------------------------------------------------
if ( ! function_exists('function_usable'))
{
// 判断函数是否被禁用
function function_usable($function_name)
{
static $_suhosin_func_blacklist;
if (function_exists($function_name))
{
if ( ! isset($_suhosin_func_blacklist))
{
$_suhosin_func_blacklist = extension_loaded('suhosin')
? explode(',', trim(ini_get('suhosin.executor.func.blacklist')))
: array();
}
return ! in_array($function_name, $_suhosin_func_blacklist, TRUE);
}
return FALSE;
}