阐述 WordPress `wp_is_writable()` 函数的源码：如何判断文件或目录是否可写。

各位观众老爷，晚上好！今天咱们来聊聊 WordPress 的一个“小透明”函数：wp_is_writable()。 别看它名字平平无奇，在 WordPress 的权限管理中，它可是个“老黄牛”，默默地检查着文件和目录的“健康状况”。 咱们今天就把它拉出来，扒光了看看，看看它到底是怎么判断文件/目录是否可写的。

开场白：权限的重要性，以及 wp_is_writable() 的角色

在 WordPress 中，权限问题绝对是个大问题。想象一下，如果你安装插件、上传图片，或者更新主题的时候，突然跳出来个“权限不足”的错误，是不是瞬间感觉血压都上来了？

权限不足会导致各种问题，比如：

• 无法安装或更新插件/主题
• 无法上传媒体文件
• 网站无法正常运行
• 甚至可能导致安全漏洞

wp_is_writable() 函数就是 WordPress 用来预防这些问题的一个重要工具。它负责检查文件或目录是否可写，从而确保 WordPress 能够正常执行各种操作。

wp_is_writable() 函数的定义和基本用法

首先，让我们来看看 wp_is_writable() 函数的定义：

/**
 * Tests for file writability.
 *
 * @since 2.0.0
 *
 * @param string $path Path to test for writability.
 * @return bool Whether the path is writable.
 */
function wp_is_writable( $path ) {
  // ... (函数主体代码) ...
}

这个函数接受一个参数 $path，表示要检查的文件或目录的路径。它返回一个布尔值，true 表示可写，false 表示不可写。

使用起来非常简单：

$file_path = ABSPATH . 'wp-config.php'; // 网站根目录下的 wp-config.php 文件

if ( wp_is_writable( $file_path ) ) {
  echo '文件 ' . $file_path . ' 可写！';
} else {
  echo '文件 ' . $file_path . ' 不可写！';
}

$dir_path = WP_CONTENT_DIR . '/uploads'; // uploads 目录

if ( wp_is_writable( $dir_path ) ) {
  echo '目录 ' . $dir_path . ' 可写！';
} else {
  echo '目录 ' . $dir_path . ' 不可写！';
}

源码解析：wp_is_writable() 函数的内部逻辑

好了，接下来，咱们深入到 wp_is_writable() 函数的源码中，看看它到底是怎么判断可写性的。

在 WordPress 5.8 版本中，wp_is_writable() 函数的源码如下：

function wp_is_writable( $path ) {
    if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
        if ( is_dir( $path ) ) {
            return true;
        }

        $real_path = realpath( $path );

        if ( false === $real_path ) {
            return false;
        }

        $path = $real_path;

        // Check whether Windows recognizes the file as writable.
        if ( is_writable( $path ) ) {
            return true;
        }

        /*
         * If we're on an IIS server with safe_mode off, and is_writable()
         * returns false, we can try using chmod.
         */
        if ( 'IIS' === substr( php_sapi_name(), 0, 3 ) && ! ini_get( 'safe_mode' ) ) {
            @chmod( $path, 0666 );
            return is_writable( $path );
        }

        /*
         * If is_writable() returned false and file exists, try executing
         * script.
         */
        if ( file_exists( $path ) ) {
            return false;
        }

        /*
         * Check if we're in safe mode. If so, we're out of options.
         */
        if ( ini_get( 'safe_mode' ) ) {
            return false;
        }

        /*
         * Use tempnam to create a temporary file, then check if we can
         * write to it.
         */
        if ( ! ( $fp = @fopen( trailingslashit( $path ) . uniqid( 'wp_is_writable_' ), 'ab' ) ) ) {
            return false;
        }

        @fclose( $fp );
        @unlink( $path );

        return true;
    } else {
        if ( is_dir( $path ) ) {
            /*
             * If we're on a Unix-like server, we can use is_writable() to
             * check if the directory is writable.
             */
            return is_writable( $path );
        }

        /*
         * Check if the file exists. If not, we can't write to it.
         */
        if ( ! file_exists( $path ) ) {
            return false;
        }

        /*
         * If we're on a Unix-like server, we can use is_writable() to
         * check if the file is writable.
         */
        return is_writable( $path );
    }
}

代码虽然不长，但逻辑还是比较清晰的。咱们把它拆解开来，一步一步地分析：

1. 操作系统判断：Windows 和 Unix-like 系统

if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
  // Windows 系统的处理逻辑
} else {
  // Unix-like 系统的处理逻辑
}

首先，wp_is_writable() 函数会判断当前的操作系统。因为 Windows 和 Unix-like 系统在文件权限管理方面存在差异，所以需要分别处理。

2. Windows 系统的处理逻辑

• 目录判断：

  if ( is_dir( $path ) ) {
    return true;
  }

  在 Windows 系统中，如果 $path 是一个目录，wp_is_writable() 函数会直接返回 true。 这是因为 Windows 的权限模型与 Unix-like 系统不同。在 Windows 中，目录的写入权限通常由父目录的权限决定。

• 真实路径获取：

  $real_path = realpath( $path );
  
  if ( false === $real_path ) {
      return false;
  }
  
  $path = $real_path;

  使用 realpath() 获取路径的绝对真实路径。如果无法获取，则认为不可写。

• 使用 is_writable() 函数：

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

  is_writable() 是 PHP 内置的函数，用于检查文件或目录是否可写。wp_is_writable() 函数首先会尝试使用这个函数来判断可写性。

• IIS 服务器和 safe_mode 的处理：

  if ( 'IIS' === substr( php_sapi_name(), 0, 3 ) && ! ini_get( 'safe_mode' ) ) {
    @chmod( $path, 0666 );
    return is_writable( $path );
  }

  如果运行在 IIS 服务器上，并且 safe_mode (已废弃) 没有开启，wp_is_writable() 函数会尝试使用 chmod() 函数来修改文件的权限，将其设置为 0666 (所有用户可读写)。 然后再次使用 is_writable() 函数来判断可写性。

• 文件存在性判断：

  if ( file_exists( $path ) ) {
      return false;
  }

  如果文件存在，则直接返回false，不尝试进一步操作。

• safe_mode 检查：

  if ( ini_get( 'safe_mode' ) ) {
    return false;
  }

  如果 safe_mode 开启，wp_is_writable() 函数会直接返回 false。 因为在 safe_mode 下，很多文件操作是被限制的。

• 创建临时文件：

  if ( ! ( $fp = @fopen( trailingslashit( $path ) . uniqid( 'wp_is_writable_' ), 'ab' ) ) ) {
    return false;
  }
  
  @fclose( $fp );
  @unlink( $path );
  
  return true;

  如果以上方法都失败了，wp_is_writable() 函数会尝试在 $path 目录下创建一个临时文件，并尝试写入数据。 如果创建和写入成功，则认为 $path 目录是可写的。 最后，临时文件会被删除。

3. Unix-like 系统的处理逻辑

• 目录判断：

  if ( is_dir( $path ) ) {
    return is_writable( $path );
  }

  在 Unix-like 系统中，如果 $path 是一个目录，wp_is_writable() 函数会直接使用 is_writable() 函数来判断目录是否可写。

• 文件存在性判断：

  if ( ! file_exists( $path ) ) {
    return false;
  }

  如果文件不存在，wp_is_writable() 函数会直接返回 false。

• 使用 is_writable() 函数：

  return is_writable( $path );

  如果文件存在，wp_is_writable() 函数会直接使用 is_writable() 函数来判断文件是否可写。

核心判断：is_writable() 函数

无论是 Windows 还是 Unix-like 系统，is_writable() 函数都是判断可写性的核心。 那么，is_writable() 函数又是如何判断的呢？

is_writable() 函数是 PHP 内置的函数，它的实现取决于底层的操作系统。

• 在 Unix-like 系统中：

  is_writable() 函数会检查文件的权限位。 它会检查当前用户是否具有写入文件的权限。 这包括检查文件的所有者、所属组和其他用户的权限。

• 在 Windows 系统中：

  is_writable() 函数会检查文件的 ACL (Access Control List)。 ACL 定义了哪些用户或组可以访问文件，以及他们具有哪些权限。

总结：wp_is_writable() 函数的工作流程

为了更好地理解 wp_is_writable() 函数的工作流程，咱们可以把它总结成一个流程图：

步骤	Windows 系统	Unix-like 系统
1	判断是否为目录。如果是，返回 true。	判断是否为目录。如果是，使用 is_writable() 判断目录是否可写，并返回结果。
2	获取真实路径, 无法获取则返回 false。	判断文件是否存在。如果不存在，返回 false。
3	使用 is_writable() 判断文件是否可写。如果是，返回 true。	使用 is_writable() 判断文件是否可写，并返回结果。
4	如果运行在 IIS 服务器上，并且 safe_mode 没有开启，尝试使用 chmod() 修改权限，然后再次使用 is_writable() 判断。
5	如果文件存在，则返回false。
6	如果 safe_mode 开启，返回 false。
7	尝试在目录下创建临时文件并写入数据。如果成功，返回 true；否则，返回 false。

实际应用场景：wp_is_writable() 函数的用武之地

wp_is_writable() 函数在 WordPress 中有很多应用场景，比如：

• 插件/主题安装和更新：

  在安装或更新插件/主题之前，WordPress 会使用 wp_is_writable() 函数来检查插件/主题目录是否可写。 如果不可写，WordPress 会提示用户修改权限。

• 媒体文件上传：

  在上传媒体文件之前，WordPress 会使用 wp_is_writable() 函数来检查 uploads 目录是否可写。 如果不可写，WordPress 会提示用户修改权限。

• 缓存目录：

  WordPress 的很多插件会使用缓存来提高性能。 在创建缓存目录之前，插件会使用 wp_is_writable() 函数来检查缓存目录是否可写。

• 日志文件：

  一些插件会记录日志信息。 在创建日志文件之前，插件会使用 wp_is_writable() 函数来检查日志目录是否可写。

总结和建议

wp_is_writable() 函数是 WordPress 中一个非常重要的权限检查工具。 它可以帮助 WordPress 预防各种权限问题，确保网站能够正常运行。

在使用 wp_is_writable() 函数时，需要注意以下几点：

• 正确设置文件/目录权限：

  确保 WordPress 需要写入的文件和目录具有正确的权限。 一般来说，目录的权限应该设置为 755，文件的权限应该设置为 644。

• 注意 safe_mode 的影响：

  如果 safe_mode 开启，很多文件操作会被限制。 尽量不要在 safe_mode 下运行 WordPress。 (现在几乎已经没有服务器还在使用safe_mode了)

• 考虑使用 FTP 或 SSH：

  如果无法通过 PHP 修改文件权限，可以考虑使用 FTP 或 SSH 来修改。

好了，今天的“解剖”就到这里。希望通过今天的讲解，大家对 wp_is_writable() 函数有了更深入的了解。记住，权限管理是 WordPress 安全的重要组成部分，一定要重视哦！ 祝各位玩得开心！