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

N°7315 - Introduce WebPage::LinkStylesheetXXX() methods to replace WebPage::add_linked_stylesheet()

Browse Source
This commit is contained in:
Molkobain
2024-03-05 22:58:13 +01:00
parent 33ba754277
commit 655539c289
2 changed files with 277 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

242
sources/Application/WebPage/WebPage.php
View File

@@ -76,6 +76,17 @@ class WebPage implements Page
*/
public const ENUM_SESSION_MESSAGE_SEVERITY_ERROR = 'error';
/**
* @var string
* @since 3.2.0
*/
protected const ENUM_RESOURCE_TYPE_JS = "js";
/**
* @var string
* @since 3.2.0
*/
protected const ENUM_RESOURCE_TYPE_CSS = "css";
/**
* @var string
* @since 3.0.0
@@ -515,6 +526,109 @@ class WebPage implements Page
return $oBlock;
}
/**
* Internal helper to link a resource from the iTop package (e.g. `<ITOP/`)
*
* @param string $sFileRelPath Rel. path from iTop app. root of the resource to link (e.g. `css/login.css`)
* @param string $sResourceType {@see static::ENUM_RESOURCE_TYPE_JS}, {@see static::ENUM_RESOURCE_TYPE_CSS}
*
* @return void
* @throws \Exception
* @internal
* @since 3.2.0 N°7315
*/
private function LinkResourceFromAppRoot(string $sFileRelPath, string $sResourceType): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileRelPath))) {
return;
}
if (false === utils::RealPath(APPROOT . $sFileRelPath, APPROOT)) {
IssueLog::Warning("Linked resource added to page with a path from outside app directory, it will be ignored.", LogChannels::CONSOLE, [
"linked_resource_uri" => $sFileRelPath,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
$sAppRootUrl = utils::GetAbsoluteUrlAppRoot();
// Ensure app root url ends with a slash as it is not guaranteed by the API
if (strcmp(substr($sFileRelPath, -1), '/') !== 0) {
$sAppRootUrl .= '/';
}
$this->LinkResourceFromURI($sAppRootUrl . $sFileRelPath, $sResourceType);
}
/**
* Internal helper to link a resource from any module
*
* @param string $sFileRelPath Rel. path from current environment (e.g. `<ITOP>/env-production/`) of the resource to link (e.g. `some-module/asset/css/some-file.css`)
* @param string $sResourceType {@see static::ENUM_RESOURCE_TYPE_JS}, {@see static::ENUM_RESOURCE_TYPE_CSS}
*
* @return void
* @throws \Exception
* @internal
* @since 3.2.0 N°7315
*/
private function LinkResourceFromModule(string $sFileRelPath, string $sResourceType): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileRelPath))) {
return;
}
if (false === utils::RealPath(MODULESROOT . $sFileRelPath, MODULESROOT)) {
IssueLog::Warning("Linked resource added to page with a path from outside current env. directory, it will be ignored.", LogChannels::CONSOLE, [
"linked_resource_url" => $sFileRelPath,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
$this->LinkResourceFromURI(utils::GetAbsoluteUrlModulesRoot() . $sFileRelPath, $sResourceType);
}
/**
* Internal helper to link a resource from any URI, may it be on iTop server or an external one
*
* @param string $sFileAbsURI Abs. URI of the resource to link (e.g. `https://external.server.com/some-file.css`)
* @param string $sResourceType {@see static::ENUM_RESOURCE_TYPE_JS}, {@see static::ENUM_RESOURCE_TYPE_CSS}
*
* @return void
* @throws \Exception
* @internal
* @since 3.2.0 N°7315
*/
private function LinkResourceFromURI(string $sFileAbsURI, string $sResourceType): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileAbsURI))) {
return;
}
// Check if URI is absolute ("://" do allow any protocol), otherwise ignore the file
if (false === stripos($sFileAbsURI, "://")) {
IssueLog::Warning("Linked resource added to page with a non absolute URI, it will be ignored.", LogChannels::CONSOLE, [
"linked_resource_url" => $sFileAbsURI,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
switch ($sResourceType) {
case static::ENUM_RESOURCE_TYPE_JS:
$this->a_linked_scripts[$sFileAbsURI] = $sFileAbsURI;
break;
case static::ENUM_RESOURCE_TYPE_CSS:
$this->a_linked_stylesheets[$sFileAbsURI] = $sFileAbsURI;
break;
}
}
/**
* Empty all base JS in the page's header
*
@@ -758,7 +872,7 @@ class WebPage implements Page
if (false === stripos($sLinkedScriptAbsUrl, "://")) {
IssueLog::Warning("Linked script added to page via deprecated API with a non absolute URL, it may lead to it not being loaded and causing javascript errors.", null, [
"linked_script_url" => $sLinkedScriptAbsUrl,
"request_uri" => $_SERVER['REQUEST_URI'],
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
}
@@ -777,28 +891,7 @@ class WebPage implements Page
*/
public function LinkScriptFromAppRoot(string $sFileRelPath): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileRelPath))) {
return;
}
if (false === utils::RealPath(APPROOT . $sFileRelPath, APPROOT)) {
IssueLog::Warning("Linked script added to page with a path from outside app directory, it will be ignored.", LogChannels::CONSOLE, [
"linked_script_url" => $sFileRelPath,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
$sAppRootUrl = utils::GetAbsoluteUrlAppRoot();
// Ensure app root url ends with a slash as it is not guaranteed by the API
if (strcmp(substr($sFileRelPath, -1), '/') !== 0) {
$sAppRootUrl .= '/';
}
$sFileAbsURI = $sAppRootUrl . $sFileRelPath;
$this->a_linked_scripts[$sFileAbsURI] = $sFileAbsURI;
$this->LinkResourceFromAppRoot($sFileRelPath, static::ENUM_RESOURCE_TYPE_JS);
}
/**
@@ -813,21 +906,7 @@ class WebPage implements Page
*/
public function LinkScriptFromModule(string $sFileRelPath): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileRelPath))) {
return;
}
if (false === utils::RealPath(MODULESROOT . $sFileRelPath, MODULESROOT)) {
IssueLog::Warning("Linked script added to page with a path from outside current env. directory, it will be ignored.", LogChannels::CONSOLE, [
"linked_script_url" => $sFileRelPath,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
$sFileAbsURI = utils::GetAbsoluteUrlModulesRoot() . $sFileRelPath;
$this->a_linked_scripts[$sFileAbsURI] = $sFileAbsURI;
$this->LinkResourceFromModule($sFileRelPath, static::ENUM_RESOURCE_TYPE_JS);
}
/**
@@ -843,21 +922,7 @@ class WebPage implements Page
*/
public function LinkScriptFromURI(string $sFileAbsURI): void
{
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sFileAbsURI))) {
return;
}
// Check if URI is absolute ("://" do allow any protocol), otherwise ignore the file
if (false === stripos($sFileAbsURI, "://")) {
IssueLog::Warning("Linked script added to page with a non absolute URI, it will be ignored.", LogChannels::CONSOLE, [
"linked_script_url" => $sFileAbsURI,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
return;
}
$this->a_linked_scripts[$sFileAbsURI] = $sFileAbsURI;
$this->LinkResourceFromURI($sFileAbsURI, static::ENUM_RESOURCE_TYPE_JS);
}
/**
@@ -1039,13 +1104,76 @@ JS;
* Add a CSS stylesheet (as an include, i.e. link) to the header of the page
* Handles duplicates since 3.0.0 : calling twig with the same stylesheet will add the stylesheet only once
*
* @param string $s_linked_stylesheet
* @param string $s_condition
* @param string $sLinkedStylesheet
* @param string $sCondition
* @return void
* @since 3.2.0 N°6935 $sLinkedStylesheet MUST be an absolute URL
* @deprecated 3.2.0 N°7315 Use {@see static::LinkStylesheetFromXXX()} instead
*/
public function add_linked_stylesheet($s_linked_stylesheet, $s_condition = "")
public function add_linked_stylesheet($sLinkedStylesheet, $sCondition = "")
{
$this->a_linked_stylesheets[$s_linked_stylesheet] = array('link' => $s_linked_stylesheet, 'condition' => $s_condition);
DeprecatedCallsLog::NotifyDeprecatedPhpMethod();
// Ensure there is actually a URI
if (utils::IsNullOrEmptyString(trim($sLinkedStylesheet))) {
return;
}
// Check if URI is absolute ("://" do allow any protocol), otherwise warn that it's a deprecated behavior
if (false === stripos($sLinkedStylesheet, "://")) {
IssueLog::Warning("Linked stylesheet added to page via deprecated API with a non absolute URL, it may lead to it not being loaded and causing visual glitches.", null, [
"linked_stylesheet_url" => $sLinkedStylesheet,
"request_uri" => $_SERVER['REQUEST_URI'] ?? '' /* CLI */,
]);
}
$this->a_linked_stylesheets[$sLinkedStylesheet] = array('link' => $sLinkedStylesheet, 'condition' => $sCondition);
}
/**
* Use to link CSS files from the iTop package (e.g. `<ITOP>/css/*`)
*
* @param string $sFileRelPath Rel. path from iTop app. root of the CSS file to link (e.g. `css/login.css`)
*
* @return void
* @throws \Exception
* @since 3.2.0 N°7315
* @api
*/
public function LinkStylesheetFromAppRoot(string $sFileRelPath): void
{
$this->LinkResourceFromAppRoot($sFileRelPath, static::ENUM_RESOURCE_TYPE_CSS);
}
/**
* Use to link CSS files from any module
*
* @param string $sFileRelPath Rel. path from current environment (e.g. `<ITOP>/env-production/`) of the CSS file to link (e.g. `some-module/asset/css/some-file.css`)
*
* @return void
* @throws \Exception
* @since 3.2.0 N°7315
* @api
*/
public function LinkStylesheetFromModule(string $sFileRelPath): void
{
$this->LinkResourceFromModule($sFileRelPath, static::ENUM_RESOURCE_TYPE_CSS);
}
/**
* Use to link CSS files from any URI, typically an external server
*
* @param string $sFileAbsURI Abs. URI of the CSS file to link (e.g. `https://external.server.com/some-file.css`)
* Note: Any non-absolute URI will be ignored.
*
* @return void
* @throws \Exception
* @since 3.2.0 N°7315
* @api
*/
public function LinkStylesheetFromURI(string $sFileAbsURI): void
{
$this->LinkResourceFromURI($sFileAbsURI, static::ENUM_RESOURCE_TYPE_CSS);
}
/**

95
tests/php-unit-tests/unitary-tests/sources/Application/WebPage/WebPageTest.php
View File

@@ -22,7 +22,6 @@ class WebPageTest extends ItopDataTestCase
/**
* @dataProvider LinkScriptMethodsProvider
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkScript()
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkScriptFromAppRoot()
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkScriptFromModule()
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkScriptFromURI()
@@ -41,8 +40,8 @@ class WebPageTest extends ItopDataTestCase
$this->InvokeNonPublicMethod(WebPage::class, "EmptyLinkedScripts", $oPage);
$this->InvokeNonPublicMethod(WebPage::class, $sMethodName, $oPage, [$sInputURI]);
$aLinkedScript = $this->GetNonPublicProperty($oPage, "a_linked_scripts");
$this->assertEquals($iExpectedCount, count($aLinkedScript), "Linked scripts count should be $iExpectedCount");
$aLinkedScripts = $this->GetNonPublicProperty($oPage, "a_linked_scripts");
$this->assertEquals($iExpectedCount, count($aLinkedScripts), "Linked scripts count should be $iExpectedCount");
}
public function LinkScriptMethodsProvider(): array
@@ -110,4 +109,94 @@ class WebPageTest extends ItopDataTestCase
],
];
}
/**
* @dataProvider LinkStylesheetMethodsProvider
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkStylesheetFromAppRoot()
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkStylesheetFromModule()
* @covers \Combodo\iTop\Application\WebPage\WebPage::LinkStylesheetFromURI()
*
* @param string $sMethodName
* @param string $sInputURI
* @param int $iExpectedCount
*
* @return void
* @throws \ReflectionException
*/
public function testLinkStylesheetMethods(string $sMethodName, string $sInputURI, int $iExpectedCount): void
{
$oPage = new WebPageMock('');
$this->InvokeNonPublicMethod(WebPage::class, "EmptyLinkedStylesheets", $oPage);
$this->InvokeNonPublicMethod(WebPage::class, $sMethodName, $oPage, [$sInputURI]);
$aLinkedStylesheets = $this->GetNonPublicProperty($oPage, "a_linked_stylesheets");
$this->assertEquals($iExpectedCount, count($aLinkedStylesheets), "Linked stylesheets count should be $iExpectedCount");
}
public function LinkStylesheetMethodsProvider(): array
{
return [
// LinkStylesheetFromAppRoot
"LinkStylesheetFromAppRoot: Empty URI should be ignored" => [
"LinkStylesheetFromAppRoot",
"",
0,
],
"LinkStylesheetFromAppRoot: Relative URI of existing file should be completed / added" => [
"LinkStylesheetFromAppRoot",
"css/login.css",
1,
],
"LinkStylesheetFromAppRoot: Relative URI of NON existing file should be ignored" => [
"LinkStylesheetFromAppRoot",
"css/some-file.css",
0,
],
"LinkStylesheetFromAppRoot: Absolute URI should be ignored" => [
"LinkStylesheetFromAppRoot",
"https://external.server/file.css",
0,
],
// LinkStylesheetFromModule
"LinkStylesheetFromModule: Empty URI should be ignored" => [
"LinkStylesheetFromModule",
"",
0,
],
"LinkStylesheetFromModule: Relative URI of existing file should be completed / added" => [
"LinkStylesheetFromModule",
"itop-portal-base/portal/public/css/portal.css",
1,
],
"LinkStylesheetFromModule: Relative URI of NON existing file should be completed / added" => [
"LinkStylesheetFromModule",
"some-module/asset/js/some-file.js",
0,
],
"LinkStylesheetFromModule: Absolute URI should be ignored" => [
"LinkStylesheetFromModule",
"https://external.server/file.js",
0,
],
// LinkStylesheetFromURI
"LinkStylesheetFromURI: Empty URI should be ignored" => [
"LinkStylesheetFromURI",
"",
0,
],
"LinkStylesheetFromURI: Relative URI should be ignored" => [
"LinkStylesheetFromURI",
"js/login.css",
0,
],
"LinkStylesheetFromURI: Absolute URI should be added" => [
"LinkStylesheetFromURI",
"https://external.server/file.css",
1,
],
];
}
}