Merge pull request #174 from mglaman/166-module_load_include_support

Handle dynamic file loading with module_load_include

Author: mglaman

extension.neon

@@ -48,3 +48,8 @@ services:
 		tags: [phpstan.rules.rule]
 		arguments:
 			- %drupal.drupal_root%
+	-
+		class: PHPStan\Rules\Drupal\ModuleLoadInclude
+		tags: [phpstan.rules.rule]
+		arguments:
+			- %drupal.drupal_root%

src/Rules/Drupal/ModuleLoadInclude.php

@@ -0,0 +1,88 @@
+<?php declare(strict_types=1);
+
+namespace PHPStan\Rules\Drupal;
+
+use DrupalFinder\DrupalFinder;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Drupal\ExtensionDiscovery;
+use PHPStan\Rules\Rule;
+
+/**
+ * Handles module_load_include dynamic file loading.
+ *
+ * @note may become deprecated and removed in D10
+ * @see https://www.drupal.org/project/drupal/issues/697946
+ */
+class ModuleLoadInclude implements Rule
+{
+
+    /**
+     * The project root.
+     *
+     * @var string
+     */
+    protected $projectRoot;
+
+    /**
+     * ModuleLoadInclude constructor.
+     * @param string $project_root
+     */
+    public function __construct(string $project_root)
+    {
+        $this->projectRoot = $project_root;
+    }
+
+    public function getNodeType(): string
+    {
+        return Node\Expr\FuncCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof Node\Expr\FuncCall);
+        if (!$node->name instanceof \PhpParser\Node\Name) {
+            return [];
+        }
+        $name = (string) $node->name;
+        if ($name !== 'module_load_include') {
+            return [];
+        }
+        $stop = null;
+
+        try {
+            // Try to invoke it similarily as the module handler itself.
+            $finder = new DrupalFinder();
+            $finder->locateRoot($this->projectRoot);
+            $drupal_root = $finder->getDrupalRoot();
+            $extensionDiscovery = new ExtensionDiscovery($drupal_root);
+            $modules = $extensionDiscovery->scan('module');
+            $type_arg = $node->args[0];
+            assert($type_arg->value instanceof Node\Scalar\String_);
+            $module_arg = $node->args[1];
+            assert($module_arg->value instanceof Node\Scalar\String_);
+            $name_arg = $node->args[2] ?? null;
+
+            if ($name_arg === null) {
+                $name_arg = $module_arg;
+            }
+            assert($name_arg->value instanceof Node\Scalar\String_);
+
+            $module_name = $module_arg->value->value;
+            if (!isset($modules[$module_name])) {
+                return [];
+            }
+            $type_prefix = $name_arg->value->value;
+            $type_filename = $type_arg->value->value;
+            $module = $modules[$module_name];
+            $file = $drupal_root . '/' . $module->getPath() . "/$type_prefix.$type_filename";
+            if (is_file($file)) {
+                require_once $file;
+                return [];
+            }
+            return [sprintf('File %s could not be loaded from module_load_include', $file)];
+        } catch (\Throwable $e) {
+            return ['A file could not be loaded from module_load_include'];
+        }
+    }
+}

tests/fixtures/drupal/modules/module_load_include_fixture/module_load_include_fixture.info.yml

@@ -0,0 +1,3 @@
+type: module
+name: Module with tests
+core: 8.x

tests/fixtures/drupal/modules/module_load_include_fixture/module_load_include_fixture.module

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+function test_locale_translation_inc_included() {
+    module_load_include('bulk.inc', 'locale');
+    locale_translate_get_interface_translation_files();
+    module_load_include('compare.inc', 'locale');
+    locale_translation_build_projects();
+    module_load_include('translation.inc', 'locale');
+    locale_translation_build_sources();
+}

tests/src/DrupalIntegrationTest.php

@@ -119,4 +119,10 @@ public function testThemeSettingsFile() {
         $this->assertCount(0, $errors->getErrors(), var_export($errors, TRUE));
         $this->assertCount(0, $errors->getInternalErrors(), var_export($errors, TRUE));
     }
+
+    public function testModuleLoadInclude() {
+        $errors = $this->runAnalyze(__DIR__ . '/../fixtures/drupal/modules/module_load_include_fixture/module_load_include_fixture.module');
+        $this->assertCount(0, $errors->getErrors(), var_export($errors, TRUE));
+        $this->assertCount(0, $errors->getInternalErrors(), var_export($errors, TRUE));
+    }
 }