PHP去除BOM头

文章转自warman团队 小囧~ 原始链接https://www.oschina.net/code/snippet_162279_10073

今天客户两台服务器做了负载均衡之后，发现一个Ajax对两台服务器后台相同API调用返回了不同参数，查找了好久小囧帮我找到了问题所在，当我远程文件上传到服务器时产生了BOM头,导致返回的JSON产生了差异。(浏览器打印数据产生了小红点就是BOM头的原因)。服务器跑如下脚本之后可以清除带BOM头文件

BOM: Byte Order Mark 

UTF-8 BOM又叫UTF-8 签名,其实UTF-8 的BOM对UFT-8没有作用,是为了支援UTF-16,UTF-32才加上的BOM,BOM签名的意思就是告诉编辑器当前文件采用何种编码,方便编辑器识别,但是BOM虽然在编辑器中不显示,但是会产生输出,就像多了一个空行,

如果您在修改任何PHP文件後发生：

* 不能登入或者不能登出； * 页顶出现一条空白； * 页顶出现错误警告； * 其它不正常的情况。

则多半是编辑器的问题。

本程序采用UTF-8编码。现在几乎所有的文本编辑软件都可以显示并编辑UTF-8编码的文件。但是很遗憾，其中很多软件的表现并不理想。

类似WINDOWS自带的记事本等软件，在保存一个以UTF-8编码的文件时，会在文件开始的地方插入三个不可见的字符（0xEF 0xBB 0xBF，即BOM）。它是一串隐藏的字符，用于让记事本等编辑器识别这个文件是否以UTF-8编码。对于一般的文件，这样并不会产生什么麻烦。但对于 PHP来说，BOM是个大麻烦。

PHP并不会忽略BOM，所以在读取、包含或者引用这些文件时，会把BOM作为该文件开头正文的一部分。根据嵌入式语言的特点，这串字符将被直接执行（显示）出来。由此造成即使页面的 top padding 设置为0，也无法让整个网页紧贴浏览器顶部，因为在html一开头有这3个字符呢！

最大的麻烦还不是这个。受COOKIE送出机制的限制，在这些文件开头已经有BOM的文件中，COOKIE无法送出（因为在COOKIE送出前PHP已经送出了文件头），所以登入和登出功能失效。一切依赖COOKIE、SESSION实现的功能全部无效。

因此，在编辑、更改任何文本文件时，请务必使用不会乱加BOM的编辑器。Linux下的编辑器应该都没有这个问题。WINDOWS下，请勿使用记事本等编辑器。推荐的编辑器是： Editplus 2.12版本以上； EmEditor； UltraEdit（需要取消‘添加BOM’的相关选项）； Dreamweaver（需要取消‘添加BOM’的相关选项） 等。

对于已经添加了BOM的文件，要取消的话，可以用以上编辑器另存一次。（Editplus需要先另存为gb，再另存为UTF-8。） ，以下是程序解决方案:

<?php

 

$auto = 1;

checkdir( 'C:\project\weibo' );

function checkdir( $basedir ){

if ( $dh = opendir( $basedir )) {

   while (( $file = readdir( $dh )) !== false) {

     if ( $file {0} == '.' )

     {

         continue ;

     }

    if ( $file != '.' && $file != '..' ){

     if (! is_dir ( $basedir . "/" . $file )) {

      echo "filename: $basedir/$file " .checkBOM( "$basedir/$file" ). " <br>" ;

     } else {

 

      $dirname = $basedir . "/" . $file ;

      checkdir( $dirname );

     }

    }

   }

closedir ( $dh );

}

}

function checkBOM ( $filename ) {

global $auto ;

$contents = file_get_contents ( $filename );

$charset [1] = substr ( $contents , 0, 1);

$charset [2] = substr ( $contents , 1, 1);

$charset [3] = substr ( $contents , 2, 1);

if (ord( $charset [1]) == 239 && ord( $charset [2]) == 187 && ord( $charset [3]) == 191) {

   if ( $auto == 1) {

    $rest = substr ( $contents , 3);

    rewrite ( $filename , $rest );

    return ( "<font color=red>BOM found, automatically removed.</font>" );

   } else {

    return ( "<font color=red>BOM found.</font>" );

   }

}

else return ( "BOM Not Found." );

}

function rewrite ( $filename , $data ) {

$filenum = fopen ( $filename , "w" );

flock ( $filenum , LOCK_EX);

fwrite( $filenum , $data );

fclose( $filenum );

}

?>