Merge remote-tracking branch 'origin/MC-29362' into 2.4-develop-pr2

Author: serhii-balko

app/code/Magento/Sitemap/Model/Sitemap.php

@@ -739,8 +739,11 @@ protected function _getFormattedLastmodDate($date)
      */
     protected function _getDocumentRoot()
     {
-        return $this->filesystem->getDirectoryRead($this->documentRoot->getPath())
-            ->getAbsolutePath();
+        if (PHP_SAPI === 'cli') {
+            return $this->getDocumentRootFromBaseDir() ?? '';
+        }
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
+        return realpath($this->_request->getServer('DOCUMENT_ROOT'));
     }
 
     /**
@@ -754,10 +757,14 @@ protected function _getStoreBaseDomain()
         $storeParsedUrl = parse_url($this->_getStoreBaseUrl());
         $url = $storeParsedUrl['scheme'] . '://' . $storeParsedUrl['host'];
 
-        $documentRoot = trim(str_replace('\\', '/', $this->_getDocumentRoot()), '/');
-        $baseDir = trim(str_replace('\\', '/', $this->_getBaseDir()), '/');
+        // Set document root to false if we were unable to get it
+        $documentRoot = $this->_getDocumentRoot() ?: false;
+        if ($documentRoot) {
+            $documentRoot = trim(str_replace(DIRECTORY_SEPARATOR, '/', $documentRoot), '/');
+        }
+        $baseDir = trim(str_replace(DIRECTORY_SEPARATOR, '/', $this->_getBaseDir()), '/');
 
-        if (strpos($baseDir, (string) $documentRoot) === 0) {
+        if ($documentRoot !== false && strpos($baseDir, (string) $documentRoot) === 0) {
             //case when basedir is in document root
             $installationFolder = trim(str_replace($documentRoot, '', $baseDir), '/');
             $storeDomain = rtrim($url . '/' . $installationFolder, '/');
@@ -878,4 +885,30 @@ public function getIdentities()
             Value::CACHE_TAG . '_' . $this->getStoreId(),
         ];
     }
+
+    /**
+     * Get document root using base directory (root directory) and base path (base url path)
+     *
+     * Document root is determined using formula: BaseDir = DocumentRoot + BasePath.
+     * Returns <b>NULL</b> if BaseDir does not end with BasePath (e.g document root contains a symlink to BaseDir).
+     *
+     * @return string|null
+     */
+    private function getDocumentRootFromBaseDir(): ?string
+    {
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
+        $basePath = rtrim(parse_url($this->_getStoreBaseUrl(UrlInterface::URL_TYPE_WEB), PHP_URL_PATH) ?: '', '/');
+        $basePath = str_replace('/', DIRECTORY_SEPARATOR, $basePath);
+        $basePath = rtrim($basePath, DIRECTORY_SEPARATOR);
+        $baseDir = rtrim($this->_getBaseDir(), DIRECTORY_SEPARATOR);
+        $length = strlen($basePath);
+        if (!$length) {
+            $documentRoot = $baseDir;
+        } elseif (substr($baseDir, -$length) === $basePath) {
+            $documentRoot = rtrim(substr($baseDir, 0, strlen($baseDir) - $length), DIRECTORY_SEPARATOR);
+        } else {
+            $documentRoot = null;
+        }
+        return $documentRoot;
+    }
 }

app/code/Magento/Sitemap/Test/Unit/Model/SitemapTest.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\Sitemap\Test\Unit\Model;
 
+use Magento\Framework\App\Request\Http;
 use Magento\Framework\DataObject;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\Write as DirectoryWrite;
@@ -86,6 +87,15 @@ class SitemapTest extends \PHPUnit\Framework\TestCase
      */
     private $configReaderMock;
 
+    /**
+     * @var Http|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $request;
+    /**
+     * @var Store|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $store;
+
     /**
      * @inheritdoc
      */
@@ -143,6 +153,12 @@ protected function setUp()
 
         $this->configReaderMock = $this->getMockForAbstractClass(SitemapConfigReaderInterface::class);
         $this->itemProviderMock = $this->getMockForAbstractClass(ItemProviderInterface::class);
+        $this->request = $this->createMock(Http::class);
+        $this->store = $this->createPartialMock(Store::class, ['isFrontUrlSecure', 'getBaseUrl']);
+        $this->storeManagerMock = $this->createMock(StoreManagerInterface::class);
+        $this->storeManagerMock->expects($this->any())
+            ->method('getStore')
+            ->willReturn($this->store);
     }
 
     /**
@@ -476,25 +492,15 @@ function ($from, $to) {
 
         $model = $this->getModelMock(true);
 
-        $storeMock = $this->getMockBuilder(Store::class)
-            ->setMethods(['isFrontUrlSecure', 'getBaseUrl'])
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $storeMock->expects($this->atLeastOnce())
+        $this->store->expects($this->atLeastOnce())
             ->method('isFrontUrlSecure')
             ->willReturn(false);
 
-        $storeMock->expects($this->atLeastOnce())
+        $this->store->expects($this->atLeastOnce())
             ->method('getBaseUrl')
             ->with($this->isType('string'), false)
             ->willReturn('http://store.com/');
 
-        $this->storeManagerMock->expects($this->atLeastOnce())
-            ->method('getStore')
-            ->with(1)
-            ->willReturn($storeMock);
-
         return $model;
     }
 
@@ -599,10 +605,6 @@ private function getModelConstructorArgs()
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->storeManagerMock = $this->getMockBuilder(StoreManagerInterface::class)
-            ->setMethods(['getStore'])
-            ->getMockForAbstractClass();
-
         $objectManager = new ObjectManager($this);
         $escaper = $objectManager->getObject(\Magento\Framework\Escaper::class);
 
@@ -617,7 +619,8 @@ private function getModelConstructorArgs()
                 'filesystem' => $this->filesystemMock,
                 'itemProvider' => $this->itemProviderMock,
                 'configReader' => $this->configReaderMock,
-                'escaper' => $escaper
+                'escaper' => $escaper,
+                'request' => $this->request,
             ]
         );
         $constructArguments['resource'] = null;
@@ -732,4 +735,62 @@ public static function siteUrlDataProvider()
             ]
         ];
     }
+
+    /**
+     * Check site URL getter
+     *
+     * @param string $storeBaseUrl
+     * @param string $baseDir
+     * @param string $documentRoot
+     * @dataProvider getDocumentRootFromBaseDirUrlDataProvider
+     */
+    public function testGetDocumentRootFromBaseDir(
+        string $storeBaseUrl,
+        string $baseDir,
+        ?string $documentRoot
+    ) {
+        $this->store->setCode('store');
+        $this->store->method('getBaseUrl')->willReturn($storeBaseUrl);
+        $this->directoryMock->method('getAbsolutePath')->willReturn($baseDir);
+        /** @var $model Sitemap */
+        $model = $this->getMockBuilder(Sitemap::class)
+            ->setMethods(['_construct'])
+            ->setConstructorArgs($this->getModelConstructorArgs())
+            ->getMock();
+
+        $method = new \ReflectionMethod($model, 'getDocumentRootFromBaseDir');
+        $method->setAccessible(true);
+        $this->assertSame($documentRoot, $method->invoke($model));
+    }
+
+    /**
+     * Provides test cases for document root testing
+     *
+     * @return array
+     */
+    public function getDocumentRootFromBaseDirUrlDataProvider(): array
+    {
+        return [
+            [
+                'http://magento.com/',
+                '/var/www',
+                '/var/www',
+            ],
+            [
+                'http://magento.com/usa',
+                '/var/www/usa',
+                '/var/www',
+            ],
+            [
+                'http://magento.com/usa/tx',
+                '/var/www/usa/tx',
+                '/var/www',
+            ],
+            'symlink <document root>/usa/txt -> /var/www/html' => [
+                'http://magento.com/usa/tx',
+                '/var/www/html',
+                null,
+            ],
+        ];
+    }
 }