Fixed an issue that could occurr when checking files on network drives (ref #2965)

Author: gsherwood

package.xml

@@ -38,6 +38,9 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Vincent Langlet for the patch
   - The PSR2.Methods.FunctionCallSignature.SpaceBeforeCloseBracket error message is now reported on the closing parenthesis token
     -- Previously, the error was being reported on the function keyword, leading to confusing line numbers in the error report
+  - Fixed an issue that could occurr when checking files on network drives, such as with WSL2 on Windows 10
+    -- This works around a long-standing PHP bug with is_readable()
+    -- Thanks to Michael S for the patch
  </notes>
  <contents>
   <dir name="/">

src/Files/LocalFile.php

@@ -12,6 +12,7 @@
 use PHP_CodeSniffer\Ruleset;
 use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Util\Cache;
+use PHP_CodeSniffer\Util\Common;
 
 class LocalFile extends File
 {
@@ -29,7 +30,7 @@ class LocalFile extends File
     public function __construct($path, Ruleset $ruleset, Config $config)
     {
         $this->path = trim($path);
-        if (is_readable($this->path) === false) {
+        if (Common::isReadable($this->path) === false) {
             parent::__construct($this->path, $ruleset, $config);
             $error = 'Error opening file; file no longer exists or you do not have access to read the file';
             $this->addMessage(true, $error, 1, 1, 'Internal.LocalFile', [], 5, false);

src/Util/Common.php

@@ -48,6 +48,34 @@ public static function isPharFile($path)
     }//end isPharFile()
 
 
+    /**
+     * Checks if a file is readable.
+     *
+     * Addresses PHP bug related to reading files from network drives on Windows.
+     * e.g. when using WSL2.
+     *
+     * @param string $path The path to the file.
+     *
+     * @return boolean
+     */
+    public static function isReadable($path)
+    {
+        if (is_readable($path) === true) {
+            return true;
+        }
+
+        if (file_exists($path) === true && is_file($path) === true) {
+            $f = @fopen($path, 'rb');
+            if (fclose($f) === true) {
+                return true;
+            }
+        }
+
+        return false;
+
+    }//end isReadable()
+
+
     /**
      * CodeSniffer alternative for realpath.
      *