Skip to content

magento/magento2#32599: Fix segfault when base URL config is empty #41082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swnsma wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from
+335 −27
Open

magento/magento2#32599: Fix segfault when base URL config is empty #41082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 44 additions & 24 deletions app/code/Magento/Store/Model/Config/Placeholder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@

namespace Magento\Store\Model\Config;

use Magento\Framework\App\RequestInterface;
use Magento\Framework\Exception\LocalizedException;

/**
* Placeholder configuration values processor. Replace placeholders in configuration with config values
*/
class Placeholder implements PlaceholderInterface
{
/**
* @var \Magento\Framework\App\RequestInterface
* @var RequestInterface
*/
protected $request;

Expand All @@ -27,11 +30,11 @@ class Placeholder implements PlaceholderInterface
protected $urlPlaceholder;

/**
* @param \Magento\Framework\App\RequestInterface $request
* @param RequestInterface $request
* @param string[] $urlPaths
* @param string $urlPlaceholder
*/
public function __construct(\Magento\Framework\App\RequestInterface $request, $urlPaths, $urlPlaceholder)
public function __construct(RequestInterface $request, $urlPaths, $urlPlaceholder)
{
$this->request = $request;
$this->urlPaths = $urlPaths;
Expand All @@ -43,6 +46,7 @@ public function __construct(\Magento\Framework\App\RequestInterface $request, $u
*
* @param array $data
* @return array
* @throws LocalizedException
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function process(array $data = [])
Expand Down Expand Up @@ -71,6 +75,7 @@ function (&$value, $key, $data) {
* @param array &$data
* @param string $path
* @return void
* @throws LocalizedException
*/
protected function _processData(&$data, $path)
{
Expand All @@ -90,30 +95,42 @@ protected function _processData(&$data, $path)
* @param string $value
* @param array $data
* @return string
* @throws LocalizedException
*/
protected function _processPlaceholders($value, $data)
{
$placeholder = $this->_getPlaceholder($value);
if ($placeholder) {
$url = false;
if ($placeholder == 'unsecure_base_url') {
$url = $this->_getValue($this->urlPaths['unsecureBaseUrl'], $data);
} elseif ($placeholder == 'secure_base_url') {
$url = $this->_getValue($this->urlPaths['secureBaseUrl'], $data);
}
if (!$placeholder) {
return $value;
}

if ($url) {
$value = str_replace('{{' . $placeholder . '}}', $url, $value);
} elseif (strpos($value, (string)$this->urlPlaceholder) !== false) {
$distroBaseUrl = $this->request->getDistroBaseUrl();
$url = null;
if ($placeholder === 'unsecure_base_url') {
$url = $this->_getValue($this->urlPaths['unsecureBaseUrl'], $data);
} elseif ($placeholder === 'secure_base_url') {
$url = $this->_getValue($this->urlPaths['secureBaseUrl'], $data);
}

$value = str_replace($this->urlPlaceholder, $distroBaseUrl, $value);
}
$originalValue = $value;

if (null !== $this->_getPlaceholder($value)) {
$value = $this->_processPlaceholders($value, $data);
}
if ($url) {
$value = str_replace('{{' . $placeholder . '}}', $url, $value);
} elseif (str_contains((string) $value, (string) $this->urlPlaceholder)) {
$value = str_replace($this->urlPlaceholder, $this->request->getDistroBaseUrl(), $value);
} else {
$configPath = $placeholder === 'secure_base_url'
? $this->urlPaths['secureBaseUrl']
: $this->urlPaths['unsecureBaseUrl'];
throw new LocalizedException(
__('Cannot resolve "{{%1}}" because "%2" is empty.', $placeholder, $configPath)
);
}

// Only recurse when the value changed; otherwise unresolved placeholders loop forever.
if ($value !== $originalValue && $this->_getPlaceholder($value) !== null) {
$value = $this->_processPlaceholders($value, $data);
}

return $value;
}

Expand All @@ -125,11 +142,14 @@ protected function _processPlaceholders($value, $data)
*/
protected function _getPlaceholder($value)
{
if (is_string($value) && preg_match('/{{(.*)}}.*/', $value, $matches)) {
if (!is_string($value) || $value === '') {
return null;
}
if (preg_match('/{{(.*)}}.*/', $value, $matches)) {
$placeholder = $matches[1];
if ($placeholder == 'unsecure_base_url' ||
$placeholder == 'secure_base_url' ||
strpos($value, (string)$this->urlPlaceholder) !== false
if ($placeholder === 'unsecure_base_url' ||
$placeholder === 'secure_base_url' ||
str_contains($value, (string) $this->urlPlaceholder)
) {
return $placeholder;
}
Expand All @@ -142,7 +162,7 @@ protected function _getPlaceholder($value)
*
* @param string $path
* @param array $data
* @return array|null
* @return array|string|null
*/
protected function _getValue($path, array $data)
{
Expand Down
97 changes: 94 additions & 3 deletions app/code/Magento/Store/Test/Unit/Model/Config/PlaceholderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@
namespace Magento\Store\Test\Unit\Model\Config;

use Magento\Framework\App\Request\Http;
use Magento\Store\Model\Config\Processor\Placeholder as PlaceholderProcessor;
use Magento\Framework\Exception\LocalizedException;
use Magento\Store\Model\Config\Placeholder;
use Magento\Store\Model\Store;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class PlaceholderTest extends TestCase
{
/**
* @var PlaceholderProcessor
* @var Placeholder
*/
protected $_model;

Expand All @@ -35,7 +37,7 @@ protected function setUp(): void
)->willReturn(
'http://localhost/'
);
$this->_model = new \Magento\Store\Model\Config\Placeholder(
$this->_model = new Placeholder(
$this->_requestMock,
[
'unsecureBaseUrl' => Store::XML_PATH_UNSECURE_BASE_URL,
Expand Down Expand Up @@ -83,4 +85,93 @@ public function testProcessEmptyArray()
$expectedResult = [];
$this->assertEquals($expectedResult, $this->_model->process($data));
}

/**
* @param mixed $secureBaseUrl
*/
#[DataProvider('emptySecureBaseUrlDataProvider')]
public function testProcessThrowsWhenSecureBaseUrlIsEmpty($secureBaseUrl): void
{
$this->expectException(LocalizedException::class);
$this->expectExceptionMessage(
'Cannot resolve "{{secure_base_url}}" because "web/secure/base_url" is empty.'
);

$this->_model->process([
'web' => [
'unsecure' => [
'base_url' => 'http://localhost/',
],
'secure' => [
'base_url' => $secureBaseUrl,
'base_link_url' => '{{secure_base_url}}website/de',
],
],
]);
}

/**
* @return array
*/
public static function emptySecureBaseUrlDataProvider(): array
{
return [
'null' => [null],
'empty string' => [''],
];
}

/**
* @param mixed $unsecureBaseUrl
*/
#[DataProvider('emptyUnsecureBaseUrlDataProvider')]
public function testProcessThrowsWhenUnsecureBaseUrlIsEmpty($unsecureBaseUrl): void
{
$this->expectException(LocalizedException::class);
$this->expectExceptionMessage(
'Cannot resolve "{{unsecure_base_url}}" because "web/unsecure/base_url" is empty.'
);

$this->_model->process([
'web' => [
'unsecure' => [
'base_url' => $unsecureBaseUrl,
'base_link_url' => '{{unsecure_base_url}}website/de',
],
'secure' => [
'base_url' => 'https://localhost/',
],
],
]);
}

/**
* @return array
*/
public static function emptyUnsecureBaseUrlDataProvider(): array
{
return [
'null' => [null],
'empty string' => [''],
];
}

public function testProcessThrowsWhenSecureBaseUrlPathIsMissing(): void
{
$this->expectException(LocalizedException::class);
$this->expectExceptionMessage(
'Cannot resolve "{{secure_base_url}}" because "web/secure/base_url" is empty.'
);

$this->_model->process([
'web' => [
'unsecure' => [
'base_url' => 'http://localhost/',
],
'secure' => [
'base_link_url' => '{{secure_base_url}}website/de',
],
],
]);
}
}
Loading