PHP 批量清除 BOM 头：原理、工具实现与使用指南

<?php
// 设置页面编码，确保日志输出正常
header('Content-Type: text/html; charset=utf-8');

// 1. 配置参数：可根据需求修改
$config = [
    'scan_dir' => '.',          // 扫描目录（默认当前目录，可通过 URL 参数 ?dir=目标目录 覆盖）
    'auto_clear' => 1,          // 1=检测并清除 BOM 头；0=仅检测，不清除
    'allowed_extensions' => [   // 仅扫描指定后缀的文件（避免扫描非代码文件，如图片、压缩包）
        'php', 'html', 'htm', 'css', 'js', 'txt', 'ini'
    ]
];

// 2. 处理 URL 参数：若传入 dir 参数，覆盖默认扫描目录
if (isset($_GET['dir']) && !empty($_GET['dir'])) {
    $config['scan_dir'] = rtrim(trim($_GET['dir']), '/\\'); // 去除目录末尾的斜杠，避免路径错误
}

// 3. 输出当前配置信息
echo '<h3>PHP 批量 BOM 头检测与清除工具</h3>';
echo '<p>当前扫描目录：' . realpath($config['scan_dir']) . '</p>';
echo '<p>当前模式：' . ($config['auto_clear'] ? '【检测并自动清除 BOM 头】' : '【仅检测 BOM 头，不清除】') . '</p>';
echo '<p>扫描文件类型：' . implode(', ', $config['allowed_extensions']) . '</p>';
echo '<hr>';

// 4. 递归扫描目录并处理文件
scanDirFiles($config['scan_dir'], $config);

/**
 * 递归扫描目录下的所有文件
 * @param string $dir 待扫描目录
 * @param array $config 配置参数
 */
function scanDirFiles($dir, $config) {
    // 打开目录，判断是否可访问
    if (!is_dir($dir) || !$dh = opendir($dir)) {
        echo '<p style="color: #999;">目录不可访问：' . $dir . '</p>';
        return;
    }

    // 遍历目录中的文件/子目录
    while (($file = readdir($dh)) !== false) {
        // 跳过当前目录（.）和上级目录（..）
        if ($file == '.' || $file == '..') {
            continue;
        }

        // 拼接完整文件路径
        $fullPath = $dir . DIRECTORY_SEPARATOR . $file;

        // 若为子目录，递归扫描
        if (is_dir($fullPath)) {
            scanDirFiles($fullPath, $config);
        } 
        // 若为文件，判断后缀是否在允许范围内，再检测 BOM 头
        else {
            $fileExt = strtolower(pathinfo($fullPath, PATHINFO_EXTENSION)); // 获取文件后缀（小写）
            if (in_array($fileExt, $config['allowed_extensions'])) {
                checkAndClearBOM($fullPath, $config['auto_clear']);
            }
        }
    }

    // 关闭目录句柄
    closedir($dh);
}

/**
 * 检测文件是否包含 BOM 头，并根据配置清除
 * @param string $filePath 文件路径
 * @param bool $autoClear 是否自动清除（true=清除，false=仅检测）
 */
function checkAndClearBOM($filePath, $autoClear) {
    // 读取文件前 3 个字节（判断是否为 BOM 头，无需读取完整文件，提升效率）
    $fileHandle = fopen($filePath, 'rb'); // 以二进制模式打开，避免编码转换影响
    if (!$fileHandle) {
        echo '<p style="color: #ff6600;">无法打开文件：' . $filePath . '</p>';
        return;
    }

    $bomBytes = fread($fileHandle, 3); // 读取前 3 个字节
    fclose($fileHandle);

    // 判断是否为 UTF-8 BOM 头（0xEF 0xBB 0xBF → 十进制 239、187、191）
    $isHasBOM = (ord($bomBytes[0]) == 239 && ord($bomBytes[1]) == 187 && ord($bomBytes[2]) == 191);

    // 输出检测结果
    echo '<p>文件：' . $filePath . ' → ';
    if ($isHasBOM) {
        if ($autoClear) {
            // 清除 BOM 头：读取文件剩余内容，重新写入（覆盖原文件）
            $fileContent = file_get_contents($filePath);
            $cleanContent = substr($fileContent, 3); // 截取第 4 个字节后的内容（去除前 3 个 BOM 字节）
            rewriteFile($filePath, $cleanContent);
            echo '<span style="color: #e74c3c;">【找到 BOM 头，已自动清除】</span></p>';
        } else {
            echo '<span style="color: #f39c12;">【找到 BOM 头，未清除】</span></p>';
        }
    } else {
        echo '<span style="color: #27ae60;">【未找到 BOM 头】</span></p>';
    }
}

/**
 * 重写文件内容（覆盖原文件），并添加文件锁防止并发写入问题
 * @param string $filePath 文件路径
 * @param string $content 清除 BOM 头后的文件内容
 */
function rewriteFile($filePath, $content) {
    $fileHandle = fopen($filePath, 'wb'); // 以二进制写入模式打开，覆盖原文件
    if (!$fileHandle) {
        echo '<p style="color: #ff0000;">清除 BOM 头失败：无法写入文件 ' . $filePath . '</p>';
        return;
    }

    flock($fileHandle, LOCK_EX); // 加排他锁，避免多进程同时写入
    fwrite($fileHandle, $content); // 写入清除 BOM 头后的内容
    flock($fileHandle, LOCK_UN); // 释放锁
    fclose($fileHandle);
}
?>