解析 WordPress `wp_upload_is_writable()` 函数的源码：如何判断上传目录是否可写。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，晚上好！我是今天的主讲人，咱们今天聊聊WordPress里一个看似简单，实则暗藏玄机的函数：wp_upload_is_writable()。别看它名字平平无奇，它可是掌管着你的WordPress能不能上传文件的大权。想象一下，辛辛苦苦写了篇文章，想配张图，结果发现传不上去，是不是很崩溃？这时候，wp_upload_is_writable() 就闪亮登场了，它负责告诉你，你的上传目录是不是出了问题，能不能写入。

咱们今天就来扒一扒它的源码，看看它到底是怎么判断上传目录是否可写的。

一、源码剖析：wp_upload_is_writable() 的真面目

首先，我们找到 wp-admin/includes/file.php 这个文件，wp_upload_is_writable() 就藏在这里。

function wp_upload_is_writable( $dir ) {
    if ( empty( $dir ) ) {
        $dir = wp_upload_dir()['basedir'];
        if ( ! $dir ) {
            return false;
        }
    }

    if ( '1' == ini_get( 'safe_mode' ) && ! is_dir( $dir ) ) {
        return false;
    }

    if ( is_writable( $dir ) ) {
        return true;
    }

    if ( is_dir( $dir ) ) {
        $test_file = trailingslashit( $dir ) . 'test-upload.html';

        // Create the file (if missing).
        if ( ! @file_exists( $test_file ) ) {
            @file_put_contents( $test_file, 'test' );
        }

        /*
         * Check to see if the file exists. If it doesn't then
         * the directory is not writable.
         */
        if ( ! @file_exists( $test_file ) ) {
            return false;
        }

        /*
         * Open the file for writing. If it doesn't open, then
         * the directory is not writable.
         */
        if ( ! @fopen( $test_file, 'a' ) ) {
            return false;
        }

        // Remove the test file.
        @unlink( $test_file );

        return true;
    }

    return false;
}

怎么样，是不是感觉像在看天书？别怕，咱们来一步一步地拆解它。

二、代码逻辑：抽丝剥茧

检查目录是否为空：
```
if ( empty( $dir ) ) {
   $dir = wp_upload_dir()['basedir'];
   if ( ! $dir ) {
       return false;
   }
}
```
这段代码首先检查传入的 $dir 参数是否为空。如果为空，它会尝试从 wp_upload_dir() 函数获取上传目录的 basedir。如果 basedir 也为空，那就直接返回 false，告诉我们上传目录压根不存在。

wp_upload_dir() 函数会返回一个包含各种上传目录信息的数组，其中 basedir 就是我们想要的根目录。
安全模式检查：
```
if ( '1' == ini_get( 'safe_mode' ) && ! is_dir( $dir ) ) {
   return false;
}
```
这段代码检查 PHP 的安全模式是否开启 (safe_mode = 1)，并且判断传入的 $dir 是否存在。如果安全模式开启，并且 $dir 不是一个目录，那么就返回 false。在安全模式下，对文件系统的访问会受到更严格的限制。
直接可写性检查：
```
if ( is_writable( $dir ) ) {
   return true;
}
```
这是最简单粗暴的一步。它直接使用 PHP 内置的 is_writable() 函数来检查 $dir 是否可写。如果 is_writable() 返回 true，那就说明目录可写，直接返回 true，结束函数。

is_writable() 函数的原理，简单来说就是操作系统层面判断当前PHP进程运行的用户，是否有权限对该目录进行写入操作。
目录存在性与文件测试：
```
if ( is_dir( $dir ) ) {
   $test_file = trailingslashit( $dir ) . 'test-upload.html';

   // Create the file (if missing).
   if ( ! @file_exists( $test_file ) ) {
       @file_put_contents( $test_file, 'test' );
   }

   /*
    * Check to see if the file exists. If it doesn't then
    * the directory is not writable.
    */
   if ( ! @file_exists( $test_file ) ) {
       return false;
   }

   /*
    * Open the file for writing. If it doesn't open, then
    * the directory is not writable.
    */
   if ( ! @fopen( $test_file, 'a' ) ) {
       return false;
   }

   // Remove the test file.
   @unlink( $test_file );

   return true;
}
```
如果前面的 is_writable() 检查失败，这段代码会进行更深入的测试。
- 首先，它会判断 $dir 是否是一个目录 (is_dir($dir))。 如果不是目录，那肯定不可写，直接跳到最后的 return false。
- 然后，它会创建一个名为 test-upload.html 的测试文件。 trailingslashit() 函数的作用是在 $dir 后面加上一个斜杠，确保路径的正确性。 @ 符号的作用是抑制错误信息，防止在某些情况下出现不必要的警告。
- 接着，它会再次检查 test-upload.html 是否存在。 如果不存在，说明创建文件失败，目录不可写，返回 false。
- 然后，它会尝试以追加模式打开 test-upload.html。 如果打开失败，说明目录不可写，返回 false。
- 最后，如果一切顺利，它会删除 test-upload.html，并返回 true，表示目录可写。
最终的失败：
```
return false;
```
如果前面的所有检查都失败了，那么就说明目录真的不可写，返回 false。

三、流程图：一图胜千言

为了更清晰地理解 wp_upload_is_writable() 的执行流程，我们可以用一个流程图来表示：

graph TD
    A[开始] --> B{目录是否为空?};
    B -- 是 --> C{获取上传目录};
    C -- 获取失败 --> D[返回 false];
    C -- 获取成功 --> E{安全模式是否开启?};
    B -- 否 --> E;
    E -- 是 --> F{目录是否存在?};
    F -- 否 --> D;
    E -- 否 --> G{目录是否可写?};
    F -- 是 --> G;
    G -- 是 --> H[返回 true];
    G -- 否 --> I{目录是否存在?};
    I -- 否 --> D;
    I -- 是 --> J{创建测试文件};
    J -- 创建失败 --> D;
    J -- 创建成功 --> K{测试文件是否存在?};
    K -- 否 --> D;
    K -- 是 --> L{尝试打开测试文件(追加模式)};
    L -- 打开失败 --> D;
    L -- 打开成功 --> M{删除测试文件};
    M --> N[返回 true];
    D --> O[结束(返回 false)];
    H --> O;
    N --> O;

四、实战演练：如何排查上传问题

了解了 wp_upload_is_writable() 的源码和流程，接下来我们来模拟一些实际场景，看看如何利用它来排查上传问题。

场景 1：上传目录不存在

现象： WordPress 后台显示 "上传目录不可写" 的错误信息。
原因： 上传目录的 basedir 没有正确配置，或者目录被误删。
排查步骤：
1. 检查 wp-config.php 文件中是否定义了 WP_CONTENT_DIR 和 WP_CONTENT_URL 常量，这两个常量会影响 wp_upload_dir() 函数的返回值。
2. 检查数据库中 wp_options 表的 upload_path 选项是否正确。
3. 确认服务器上实际的上传目录是否存在，并且路径是否正确。
解决方案：
1. 正确配置 wp-config.php 文件中的相关常量。
2. 修改数据库中 wp_options 表的 upload_path 选项。
3. 创建上传目录，并确保路径与配置一致。

场景 2：权限不足

现象： WordPress 后台显示 "上传目录不可写" 的错误信息。
原因： 上传目录的权限设置不正确，导致 PHP 进程无法写入。
排查步骤：
1. 使用 SSH 登录服务器。
2. 进入上传目录的父目录。
3. 执行 ls -l 命令，查看上传目录的权限信息。
4. 确认 PHP 进程运行的用户是否具有写入权限。
解决方案：
1. 使用 chown 命令修改目录的所有者。
2. 使用 chmod 命令修改目录的权限。常见的权限设置是 755 (目录) 和 644 (文件)。例如： sudo chmod 755 /path/to/upload/directory

场景 3：磁盘空间不足

现象： WordPress 后台显示 "上传目录不可写" 的错误信息，或者上传过程中出现 "磁盘已满" 的错误。
原因： 服务器的磁盘空间不足，导致无法写入新的文件。
排查步骤：
1. 使用 SSH 登录服务器。
2. 执行 df -h 命令，查看磁盘空间的使用情况。
3. 确认磁盘空间是否已满。
解决方案：
1. 清理服务器上不必要的文件，释放磁盘空间。
2. 升级服务器的磁盘空间。

场景 4：安全模式限制

现象： WordPress 后台显示 "上传目录不可写" 的错误信息。
原因： PHP 的安全模式开启，限制了文件系统的访问。
排查步骤：
1. 检查 PHP 的 php.ini 文件，确认 safe_mode 是否设置为 On 或 1。
解决方案：
1. 禁用 PHP 的安全模式 (不推荐，除非你知道自己在做什么)。
2. 修改 php.ini 文件中的 open_basedir 指令，允许 PHP 访问上传目录。例如： open_basedir = /var/www/html:/tmp:/path/to/upload/directory

五、更深层次的思考：权限模型与安全

wp_upload_is_writable() 函数的背后，隐藏着文件系统权限模型和安全性的考量。

权限模型： Linux 系统采用的是基于用户和组的权限模型。每个文件和目录都属于一个用户和一个组，并且有读、写、执行三种权限。理解权限模型对于排查文件上传问题至关重要。
安全性： 不恰当的权限设置可能会导致安全漏洞。例如，如果上传目录的权限设置为 777 (任何人都可以读、写、执行)，那么恶意用户就可以上传恶意脚本，从而控制你的网站。

六、总结：授人以鱼不如授人以渔

今天我们深入剖析了 WordPress 的 wp_upload_is_writable() 函数，了解了它的源码、流程和背后的原理。更重要的是，我们学习了如何利用它来排查实际的上传问题。

记住，授人以鱼不如授人以渔。掌握了这些知识，你就可以举一反三，应对各种各样的上传问题，让你的 WordPress 网站运行得更加稳定和安全。

最后，留给大家一个小小的思考题：如果 wp_upload_is_writable() 返回 true，是否就意味着一定能成功上传文件？欢迎在评论区留下你的答案。

感谢大家的收看，我们下期再见！

发表回复 取消回复

发表回复取消回复