Fixed bug that __FILE__ and __DIR__ cannot be rewritten successfully in proxy classes. (#5794)

Co-authored-by: Deeka Wong <[email protected]>
Co-authored-by: 李铭昕 <[email protected]>

Author: 3 people

src/Aop/ProxyCallVisitor.php

@@ -11,6 +11,7 @@
  */
 namespace Hyperf\Di\Aop;
 
+use Hyperf\Support\Composer;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\Assign;
@@ -21,9 +22,12 @@
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\MagicConst\Class_ as MagicConstClass;
+use PhpParser\Node\Scalar\MagicConst\Dir as MagicConstDir;
+use PhpParser\Node\Scalar\MagicConst\File as MagicConstFile;
 use PhpParser\Node\Scalar\MagicConst\Function_ as MagicConstFunction;
 use PhpParser\Node\Scalar\MagicConst\Method as MagicConstMethod;
 use PhpParser\Node\Scalar\MagicConst\Trait_ as MagicConstTrait;
+use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Expression;
@@ -113,6 +117,18 @@ public function leaveNode(Node $node)
                     return new Variable('__method__');
                 }
                 break;
+            case $node instanceof MagicConstDir:
+                // Rewrite __DIR__ as the real directory path
+                if ($file = Composer::getLoader()->findFile($this->visitorMetadata->className)) {
+                    return new String_(dirname(realpath($file)));
+                }
+                break;
+            case $node instanceof MagicConstFile:
+                // Rewrite __FILE__ to the real file path
+                if ($file = Composer::getLoader()->findFile($this->visitorMetadata->className)) {
+                    return new String_(realpath($file));
+                }
+                break;
         }
         return null;
     }

tests/AstTest.php

@@ -27,6 +27,7 @@
 use HyperfTest\Di\Stub\Ast\FooTrait;
 use HyperfTest\Di\Stub\FooEnumStruct;
 use HyperfTest\Di\Stub\Par2;
+use HyperfTest\Di\Stub\PathStub;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -71,6 +72,35 @@ function __construct()
 }', $code);
     }
 
+    public function testMagicConstDirAndFile()
+    {
+        $ast = new Ast();
+        $code = $ast->proxy(PathStub::class);
+        $path = (new PathStub())->file();
+        $dir = (new PathStub())->dir();
+
+        $this->assertSame($this->license . '
+namespace HyperfTest\Di\Stub;
+
+class PathStub
+{
+    use \Hyperf\Di\Aop\ProxyTrait;
+    use \Hyperf\Di\Aop\PropertyHandlerTrait;
+    function __construct()
+    {
+        $this->__handlePropertyHandler(__CLASS__);
+    }
+    public function file() : string
+    {
+        return \'' . $path . '\';
+    }
+    public function dir() : string
+    {
+        return \'' . $dir . '\';
+    }
+}', $code);
+    }
+
     public function testParentWith()
     {
         $ast = new Ast();

tests/Stub/PathStub.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\Di\Stub;
+
+class PathStub
+{
+    public function file(): string
+    {
+        return __FILE__;
+    }
+
+    public function dir(): string
+    {
+        return __DIR__;
+    }
+}