Merge pull request #7163 from dvz/explicit-symlink-resolution

Add explicit `resolveSymlinks` option for project directories
vimeo · Jan 10, 2022 · d52c3f0 · d52c3f0
2 parents 206332b + daaa74c
commit d52c3f0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 16 deletions.
diff --git a/config.xsd b/config.xsd
@@ -118,6 +118,7 @@
     <xs:complexType name="ProjectDirectoryAttributeType">
         <xs:attribute name="name" type="xs:string" use="required" />
         <xs:attribute name="ignoreTypeStats" type="xs:string" />
+        <xs:attribute name="resolveSymlinks" type="xs:boolean" />
         <xs:attribute name="useStrictTypes" type="xs:string" />
         <xs:anyAttribute processContents="skip"/>
     </xs:complexType>

diff --git a/src/Psalm/Config/FileFilter.php b/src/Psalm/Config/FileFilter.php
@@ -2,6 +2,7 @@
 
 namespace Psalm\Config;
 
+use FilesystemIterator;
 use Psalm\Exception\ConfigException;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
@@ -112,6 +113,7 @@ public static function loadFromArray(
             foreach ($config['directory'] as $directory) {
                 $directory_path = (string) ($directory['name'] ?? '');
                 $ignore_type_stats = (bool) ($directory['ignoreTypeStats'] ?? false);
+                $resolve_symlinks = (bool) ($directory['resolveSymlinks'] ?? false);
                 $declare_strict_types = (bool) ($directory['useStrictTypes'] ?? false);
 
                 if ($directory_path[0] === '/' && DIRECTORY_SEPARATOR === '/') {
@@ -182,27 +184,33 @@ public static function loadFromArray(
                     );
                 }
 
-                /** @var RecursiveDirectoryIterator */
-                $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory_path));
-                $iterator->rewind();
+                if ($resolve_symlinks) {
+                    /** @var RecursiveDirectoryIterator */
+                    $iterator = new RecursiveIteratorIterator(
+                        new RecursiveDirectoryIterator($directory_path, FilesystemIterator::SKIP_DOTS)
+                    );
+                    $iterator->rewind();
 
-                while ($iterator->valid()) {
-                    if (!$iterator->isDot() && $iterator->isLink()) {
-                        $linked_path = readlink($iterator->getPathname());
+                    while ($iterator->valid()) {
+                        if ($iterator->isLink()) {
+                            $linked_path = readlink($iterator->getPathname());
 
-                        if (stripos($linked_path, $directory_path) !== 0) {
-                            if ($ignore_type_stats && $filter instanceof ProjectFileFilter) {
-                                $filter->ignore_type_stats[$directory_path] = true;
-                            }
+                            if (stripos($linked_path, $directory_path) !== 0) {
+                                if ($ignore_type_stats && $filter instanceof ProjectFileFilter) {
+                                    $filter->ignore_type_stats[$directory_path] = true;
+                                }
 
-                            if ($declare_strict_types && $filter instanceof ProjectFileFilter) {
-                                $filter->declare_strict_types[$directory_path] = true;
-                            }
+                                if ($declare_strict_types && $filter instanceof ProjectFileFilter) {
+                                    $filter->declare_strict_types[$directory_path] = true;
+                                }
 
-                            if (is_dir($linked_path)) {
-                                $filter->addDirectory($linked_path);
+                                if (is_dir($linked_path)) {
+                                    $filter->addDirectory($linked_path);
+                                }
                             }
                         }
+
+                        $iterator->next();
                     }
 
                     $iterator->next();
@@ -346,6 +354,7 @@ public static function loadFromXMLElement(
                 $config['directory'][] = [
                     'name' => (string) $directory['name'],
                     'ignoreTypeStats' => strtolower((string) ($directory['ignoreTypeStats'] ?? '')) === 'true',
+                    'resolveSymlinks' => strtolower((string) ($directory['resolveSymlinks'] ?? '')) === 'true',
                     'useStrictTypes' => strtolower((string) ($directory['useStrictTypes'] ?? '')) === 'true',
                 ];
             }

diff --git a/tests/Config/ConfigTest.php b/tests/Config/ConfigTest.php
@@ -188,7 +188,7 @@ public function testIgnoreSymlinkedProjectDirectory(): void
                     <projectFiles>
                         <directory name="tests" />
                         <ignoreFiles>
-                            <directory name="tests/fixtures/symlinktest/ignored" />
+                            <directory name="tests/fixtures/symlinktest/ignored" resolveSymlinks="true" />
                         </ignoreFiles>
                     </projectFiles>
                 </psalm>'