史上第一强：Discuz!源代码分析系列(1)－－./include/common.inc.php

我是小站长

好久没有开始写一篇像样的技术文档了，五一难得有这么多的时间，就早起来写一篇好的文章给大家吧~最近都忙一些自己的事情，没多少机会上网来回答问题，实在抱歉……
好了，言归正传，这次我打算写一个系列的文章，把Discuz的核心文件的源代码一一分解解释出来，大家都知道Discuz的源代码是很经得起时间的考验的，是众多程序员智慧的结晶，我想大家能借鉴一下也是很不错的，唯一一点不好就是，不是OOP(面向对象)的，我最近看了几个框架(framework)，也用了一下，感觉OOP的编程让人热血沸腾，大大提高了开发效率，一个小型论坛的开发的话不用像Discuz 这样写这么这么多的代码，很是不错，不过说到面向对象，当然要看看Java，Jsp 或ASP.NET，前两个看得我郁闷，没看了，只学会了ASP.NET，感觉很不错，比PHP先进多了，针对事件、驱动编程，封装，编译，跨平台，听着就觉得很帅了，很适合大型应用，呵呵，扯远了……

申明下版权：
1.这里面的每个中文字都是我打的，code部分是引用的，当然我也加了一点注释在里面了。
2.如果要转载的话请注明

1. 转自[url]www.discuz.net[/url]　作者：郭鑫

复制代码

3.由于我个人的能力有限，写这篇文章没有参考一点资料，甚至连本地环境也没有搭建（遇到了白屏问题），所以难免会有错误的地方，大家发现了的话请跟帖或者联系我吧，我会尽快更正。

第一个文件当然是分析./include/common.inc.php这个文件，这个是Discuz的核心中的核心，基本上每次操作都include到了这个文件，下面就分七段来分析这个文件：

Section One:

1. 
   
2. //定义PHP一些环境
   
3. error_reporting(0);
   
4. set_magic_quotes_runtime(0);
   
5. 
   
6. //设置Discuz开始的时间
   
7. $mtime = explode(' ', microtime());
   
8. $discuz_starttime = $mtime[1] + $mtime[0];
   
9. 
   
10. //定义一些常量
    
11. define('SYS_DEBUG', FALSE);
    
12. define('IN_DISCUZ', TRUE);
    
13. define('DISCUZ_ROOT', substr(dirname(__FILE__), 0, -7)); //获得绝对目录
    
14. 
    
15. //通用性
    
16. if(PHP_VERSION < '4.1.0') {
    
17.         $_GET = &$HTTP_GET_VARS;
    
18.         $_POST = &$HTTP_POST_VARS;
    
19.         $_COOKIE = &$HTTP_COOKIE_VARS;
    
20.         $_SERVER = &$HTTP_SERVER_VARS;
    
21.         $_ENV = &$HTTP_ENV_VARS;
    
22.         $_FILES = &$HTTP_POST_FILES;
    
23. }
    

复制代码

这一段基本上就是设置一下错误报告，把magic_quotes这个sick家伙给关了，然后定一个开始的时间，这样我们在论坛底部看到的Process Time就是通过这个开始的时间和一个结束的时间的差来计算的，然后定义一个IN_DISCUZ为真，这个IN_DISCUZ常量的作用就是在其他inc这样的包含文件中防止被非法引用，一旦没有这个常量的话就出现Access Denied这样的字样然后退出。然后获得Discuz运行的绝对目录。接下来是判断PHP 的版本是4.1 以下还是以上，因为PHP以4.1为一个分界线，在4.1以下以$HTTP_GET_VARS[‘xx’]这样的方式来得到get过来的值，而以后用$_GET来得到get过来的值，这样做的目的是为了无论是什么样的PHP版本，都能用$_GET这样的方式得到，有通用性~！

Section Two:

1. 
   
2. require_once DISCUZ_ROOT.'./include/global.func.php';
   

复制代码

把include/global.inc.php引用进来，这个文件是Discuz的核心函数文件，包含了Discuz用到的很多通用的函数，可以说它就是一个大的通用函数库。

1. 
   
2. define('ISROBOT', getrobot());
   
3. if(defined('NOROBOT') && ISROBOT) {
   
4.         exit(header("HTTP/1.1 403 Forbidden"));
   
5. }
   

复制代码

这里是定义一个ISROBOT常量，看看浏览者是什么东东，比方说如果浏览者是一个robot那么就直接来一个 403 Forbidden了……

1. 
   
2. define('MAGIC_QUOTES_GPC', get_magic_quotes_gpc());
   
3. isset($_REQUEST['GLOBALS']) && exit('Access Error');
   
4. foreach(array('_COOKIE', '_POST', '_GET') as $_request) {
   
5.         foreach($_request as $_key => $_value) {
   
6.                 $_key{0} != '_' && $_key = daddslashes($_value);
   
7.         }
   
8. }
   
9. (!MAGIC_QUOTES_GPC) && $_FILES = daddslashes($_FILES);
   

复制代码

此处是过滤提交的变量用的，提高安全性的用法。。

1. 
   
2. $charset = $dbcharset = $forumfounders = $metakeywords = $extrahead = '';
   
3. $plugins = $hooks = $admincp = array();
   
4. 
   
5. require_once DISCUZ_ROOT.'./config.inc.php';
   
6. 
   
7. $_DCOOKIE = $_DSESSION = $_DCACHE = $_DPLUGIN = $advlist = array();
   
8. 
   
9. $prelength = strlen($cookiepre);
   
10. foreach($_COOKIE as $key => $val) {
    
11.         if(substr($key, 0, $prelength) == $cookiepre) {
    
12.                 $_DCOOKIE[(substr($key, $prelength))] = MAGIC_QUOTES_GPC ? $val : daddslashes($val);
    
13.         }
    
14. }
    

复制代码

初始化一些变量，然后引用config.inc.php这个配置文件，这样开始初始化程序的一些东西了。接下来的一个循环把$_COOKIE中的东西取出来存到$_DCOOKIE这个数组中。注意：在登陆的时候Discuz会把登陆信息存放到$_COOKIE中去。在下面一段会有取出的代码。

1. 
   
2. unset($prelength, $_request, $_key, $_value);
   
3. $timestamp = time();
   
4. 
   
5. if($attackevasive) {
   
6.         require_once DISCUZ_ROOT.'./include/security.inc.php';
   
7. }
   

复制代码

这一部分代码是提高安全用的，防一些非法的入侵，include/security.inc.php文件中就是这样一些检查。

1. 
   
2. require_once DISCUZ_ROOT.'./include/db_'.$database.'.class.php';
   
3. 
   
4. 
   
5. $PHP_SELF = $_SERVER['PHP_SELF'] ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
   
6. $SCRIPT_FILENAME = str_replace('\\\\', '/', (isset($_SERVER['PATH_TRANSLATED']) ? $_SERVER['PATH_TRANSLATED'] : $_SERVER['SCRIPT_FILENAME']));
   
7. $boardurl = 'http://'.$_SERVER['HTTP_HOST'].preg_replace("/\/+(api|archiver|wap)?\/*$/i", '', substr($PHP_SELF, 0, strrpos($PHP_SELF, '/'))).'/';
   
8. 
   
9. if(getenv('HTTP_CLIENT_IP') && strcasecmp(getenv('HTTP_CLIENT_IP'), 'unknown')) {
   
10.         $onlineip = getenv('HTTP_CLIENT_IP');
    
11. } elseif(getenv('HTTP_X_FORWARDED_FOR') && strcasecmp(getenv('HTTP_X_FORWARDED_FOR'), 'unknown')) {
    
12.         $onlineip = getenv('HTTP_X_FORWARDED_FOR');
    
13. } elseif(getenv('REMOTE_ADDR') && strcasecmp(getenv('REMOTE_ADDR'), 'unknown')) {
    
14.         $onlineip = getenv('REMOTE_ADDR');
    
15. } elseif(isset($_SERVER['REMOTE_ADDR']) && $_SERVER['REMOTE_ADDR'] && strcasecmp($_SERVER['REMOTE_ADDR'], 'unknown')) {
    
16.         $onlineip = $_SERVER['REMOTE_ADDR'];
    
17. }
    

复制代码

第一行是把include/db_mysql.class.php引用进来，这个文件是一个数据库的类。我觉得是不是放在这里太早了点？
然后接下的作用就是得到自身的名称$PHP_SELF，自身的文件名字$SCRIPT_FILENAME，论坛的地址$boardurl，得到浏览者的一些信息，比方说ip地址，浏览器类型等等。

Section Three:

1. 
   
2. preg_match("/[\d\.]{7,15}/", $onlineip, $onlineipmatches);
   
3. $onlineip = $onlineipmatches[0] ? $onlineipmatches[0] : 'unknown';
   
4. unset($onlineipmatches);
   

复制代码

看看ip是不是点分段，7-15个数字之间，用到了一个正则表达式，

1. 
   
2. $cachelost = (@include DISCUZ_ROOT.'./forumdata/cache/cache_settings.php') ? '' : 'settings';
   
3. @extract($_DCACHE['settings']);
   

复制代码

这一段是获得./forumdata/cache/cache_settings.php（即缓存下的设置数组，并展开，方面以后的写法

1. 
   
2. if($gzipcompress && function_exists('ob_gzhandler') && CURSCRIPT != 'wap') {
   
3.         ob_start('ob_gzhandler');
   
4. } else {
   
5.         $gzipcompress = 0;
   
6.         ob_start();
   
7. }
   

复制代码

检查gzip是不是打开了，打开就用ob_gzhandler，没有就用ob_start。

1. 
   
2. if(!empty($loadctrl) && substr(PHP_OS, 0, 3) != 'WIN') {
   
3.         if($fp = @fopen('/proc/loadavg', 'r')) {
   
4.                 list($loadaverage) = explode(' ', fread($fp, 6));
   
5.                 fclose($fp);
   
6.                 if($loadaverage > $loadctrl) {
   
7.                         header("HTTP/1.0 503 Service Unavailable");
   
8.                         include DISCUZ_ROOT.'./include/serverbusy.htm';
   
9.                         exit();
   
10.                 }
    
11.         }
    
12. }

复制代码

看到了熟悉的service unavailable了吧？呵呵，平衡负载用的。

1. 
   
2. if(defined('CURSCRIPT') && in_array(CURSCRIPT, array('index', 'forumdisplay', 'viewthread', 'post', 'blog', 'pm', 'topicadmin', 'register', 'archiver'))) {
   
3.         $cachelost .= (@include DISCUZ_ROOT.'./forumdata/cache/cache_'.CURSCRIPT.'.php') ? '' : ' '.CURSCRIPT;
   
4. }
   

复制代码

游客，如果您要查看本帖隐藏内容请回复

耗子

:) 收藏了 很需要！

398601673

:) 收藏了 很需要！

tcfa

支持支持zc

yuanbintb

收藏了，学习一下

plaodj

:) 收藏了 很需要！

71954443

DDDDDDDDDDDDDDDDDDD

DayFall

感谢分享！

aike45

:) 收藏了 很需要！:) 收藏了 很需要！