composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

N°3677 - Fix AttributeImage.default_image URLs not up to date after app_root_url change (#526)

Browse Source 
Many thanks to @sg-gcouronne for this contribution !
This commit is contained in:
Pierre Goiffon
2024-01-22 16:02:41 +01:00
committed by GitHub
parent 31225b9e23
commit 1e3ef6846d
5 changed files with 85 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
application/utils.inc.php
View File

@@ -23,6 +23,7 @@ use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
use Combodo\iTop\Application\UI\Hook\iKeyboardShortcut;
use Combodo\iTop\Application\WebPage\WebPage;
use Combodo\iTop\Service\Module\ModuleService;
use Combodo\iTop\Test\UnitTest\Application\utilsTest;
use ScssPhp\ScssPhp\Compiler;
use ScssPhp\ScssPhp\OutputStyle;
use ScssPhp\ScssPhp\ValueConverter;
@@ -167,7 +168,11 @@ class utils
private static $iNextId = 0;
private static $m_sAppRootUrl = null;
/**
* @var ?string
* @used-by GetAbsoluteUrlAppRoot
*/
private static $sAbsoluteUrlAppRootCache = null;
protected static function LoadParamFile($sParamFile)
{
@@ -1037,28 +1042,27 @@ class utils
return $bTrustProxies;
}
/**
* Returns the absolute URL to the application root path
*
* @param bool $bForceTrustProxy
*
* @return string The absolute URL to the application root, without the first slash
*
* @throws \Exception
*
* @since 2.7.4 $bForceTrustProxy param added
*/
/**
* Returns the absolute URL to the application root path
*
* @param bool $bForceTrustProxy
*
* @return string The absolute URL to the application root, without the first slash
*
* @throws \Exception
*
* @since 2.7.4 $bForceTrustProxy param added
*/
public static function GetAbsoluteUrlAppRoot($bForceTrustProxy = false)
{
$sUrl = static::$m_sAppRootUrl;
if ($sUrl === null || $bForceTrustProxy)
if (static::$sAbsoluteUrlAppRootCache === null || $bForceTrustProxy)
{
$sUrl = self::GetConfig()->Get('app_root_url');
if ($sUrl == '')
static::$sAbsoluteUrlAppRootCache = self::GetConfig()->Get('app_root_url');
if (static::$sAbsoluteUrlAppRootCache == '')
{
$sUrl = self::GetDefaultUrlAppRoot($bForceTrustProxy);
static::$sAbsoluteUrlAppRootCache = self::GetDefaultUrlAppRoot($bForceTrustProxy);
}
elseif (strpos($sUrl, SERVER_NAME_PLACEHOLDER) > -1)
elseif (strpos(static::$sAbsoluteUrlAppRootCache, SERVER_NAME_PLACEHOLDER) > -1)
{
if (isset($_SERVER['SERVER_NAME']))
{
@@ -1069,11 +1073,10 @@ class utils
// CLI mode ?
$sServerName = php_uname('n');
}
$sUrl = str_replace(SERVER_NAME_PLACEHOLDER, $sServerName, $sUrl);
static::$sAbsoluteUrlAppRootCache = str_replace(SERVER_NAME_PLACEHOLDER, $sServerName, static::$sAbsoluteUrlAppRootCache);
}
static::$m_sAppRootUrl = $sUrl;
}
return static::$m_sAppRootUrl;
return static::$sAbsoluteUrlAppRootCache;
}
/**

14
core/attributedef.class.inc.php
View File

@@ -8654,6 +8654,20 @@ class AttributeImage extends AttributeBlob
parent::__construct($sCode, $aParams);
}
public function Get($sParamName)
{
$oParamValue = parent::Get($sParamName);
if ($sParamName === 'default_image') {
/** @noinspection NestedPositiveIfStatementsInspection */
if (!empty($oParamValue)) {
return utils::GetAbsoluteUrlModulesRoot() . $oParamValue;
}
}
return $oParamValue;
}
public function GetEditClass()
{
return "Image";

2
setup/compiler.class.inc.php
View File

@@ -2348,7 +2348,7 @@ EOF
break;
case 'default_image':
if (($sDefault = $oField->GetChildText('default_image')) && (strlen($sDefault) > 0)) {
$aParameters['default_image'] = "utils::GetAbsoluteUrlModulesRoot().'$sModuleRelativeDir/$sDefault'";
$aParameters['default_image'] = "'$sModuleRelativeDir/$sDefault'";
} else {
$aParameters['default_image'] = 'null';
}

6
tests/php-unit-tests/unitary-tests/application/utilsTest.php
View File

@@ -248,6 +248,9 @@ class utilsTest extends ItopTestCase
*/
public function testGetAbsoluteUrlAppRootPersistency($bBehindReverseProxy,$bForceTrustProxy1 ,$sExpectedAppRootUrl1,$bForceTrustProxy2 , $sExpectedAppRootUrl2,$bForceTrustProxy3 , $sExpectedAppRootUrl3)
{
// resetting static property for each test pass
$this->SetNonPublicStaticProperty(utils::class, 'sAbsoluteUrlAppRootCache', null);
utils::GetConfig()->Set('behind_reverse_proxy', $bBehindReverseProxy);
utils::GetConfig()->Set('app_root_url', '');
@@ -272,9 +275,6 @@ class utilsTest extends ItopTestCase
$this->assertEquals($sExpectedAppRootUrl2, utils::GetAbsoluteUrlAppRoot($bForceTrustProxy2));
$this->assertEquals($sExpectedAppRootUrl3, utils::GetAbsoluteUrlAppRoot($bForceTrustProxy3));
// Leave the place clean
static::SetNonPublicStaticProperty('utils', 'm_sAppRootUrl', null);
}

43
tests/php-unit-tests/unitary-tests/core/AttributeImageTest.php Normal file
View File

@@ -0,0 +1,43 @@
<?php
namespace Combodo\iTop\Test\UnitTest\Core;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use Config;
use MetaModel;
use Person;
use utils;
class AttributeImageTest extends ItopDataTestCase
{
public function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('core/attributedef.class.inc.php');
}
public function testGet(): void
{
$oConfig = utils::GetConfig();
$oPersonPictureAttDef = MetaModel::GetAttributeDef(Person::class, 'picture');
$sAppRootUrl1 = 'http://localhost/iTop/';
$this->SetNewAppRootUrl($oConfig, $sAppRootUrl1);
$sPersonPictureDefaultImageUrl = $oPersonPictureAttDef->Get('default_image');
$this->assertStringStartsWith($sAppRootUrl1, $sPersonPictureDefaultImageUrl);
$sAppRootUrl2 = 'https://demo.combodo.com/simple/';
$this->SetNewAppRootUrl($oConfig, $sAppRootUrl2);
$oConfig->Set('app_root_url', $sAppRootUrl2);
$sPersonPictureDefaultImageUrl = $oPersonPictureAttDef->Get('default_image');
$this->assertStringStartsWith($sAppRootUrl2, $sPersonPictureDefaultImageUrl);
}
/**
* Note that we need to reset manually the cache in \utils::GetAbsoluteUrlAppRoot, which is called from \AttributeImage::Get
*/
private function SetNewAppRootUrl(Config $oConfig, string $sAppRootUrl):void {
$oConfig->Set('app_root_url', $sAppRootUrl);
$this->SetNonPublicStaticProperty(utils::class, 'sAbsoluteUrlAppRootCache', null);
}
}