-
+
fields as $field): ?>
parse() ?>
From b1439333f318f721e096baee4547c544ce7e95ae Mon Sep 17 00:00:00 2001
From: Sebastian Zoglowek
Date: Thu, 1 Jun 2023 12:21:45 +0200
Subject: [PATCH 14/19] Update permission handling for USER_CAN_EDIT_ARCHIVE
---
contao/dca/tl_module.php | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/contao/dca/tl_module.php b/contao/dca/tl_module.php
index cbc5f86..131df1b 100644
--- a/contao/dca/tl_module.php
+++ b/contao/dca/tl_module.php
@@ -6,8 +6,11 @@
* (c) https://www.oveleon.de/
*/
+use Contao\Backend;
+use Contao\BackendUser;
use Contao\System;
use Contao\Controller;
+use Oveleon\ContaoRecommendationBundle\Security\ContaoRecommendationPermissions;
System::loadLanguageFile('tl_recommendation');
System::loadLanguageFile('tl_recommendation_notification');
@@ -175,7 +178,7 @@
'sql' => "varchar(64) NOT NULL default ''"
];
-class tl_module_recommendation extends Contao\Backend
+class tl_module_recommendation extends Backend
{
/**
* Import the back end user object
@@ -183,7 +186,7 @@ class tl_module_recommendation extends Contao\Backend
public function __construct()
{
parent::__construct();
- $this->import('Contao\BackendUser', 'User');
+ $this->import(BackendUser::class, 'User');
}
/**
@@ -198,10 +201,11 @@ public function getRecommendationArchives(): array
$arrArchives = [];
$objArchives = $this->Database->execute("SELECT id, title FROM tl_recommendation_archive ORDER BY title");
+ $security = System::getContainer()->get('security.helper');
while ($objArchives->next())
{
- if ($this->User->hasAccess($objArchives->id, 'recommendations'))
+ if ($security->isGranted(ContaoRecommendationPermissions::USER_CAN_EDIT_ARCHIVE, $objArchives->id))
{
$arrArchives[$objArchives->id] = $objArchives->title;
}
From 4df2e5f76aee283dad8cf55d94e5af4b541830ce Mon Sep 17 00:00:00 2001
From: Sebastian Zoglowek
Date: Thu, 1 Jun 2023 12:23:06 +0200
Subject: [PATCH 15/19] Change image-processing to figure builder and replace
insert tags via service
---
contao/modules/ModuleRecommendation.php | 52 +++++++++++--------
contao/modules/ModuleRecommendationList.php | 6 +--
contao/modules/ModuleRecommendationReader.php | 4 +-
3 files changed, 34 insertions(+), 28 deletions(-)
diff --git a/contao/modules/ModuleRecommendation.php b/contao/modules/ModuleRecommendation.php
index 160f0bc..e7a8b55 100644
--- a/contao/modules/ModuleRecommendation.php
+++ b/contao/modules/ModuleRecommendation.php
@@ -9,7 +9,6 @@
namespace Oveleon\ContaoRecommendationBundle;
use Contao\Config;
-use Contao\Controller;
use Contao\CoreBundle\Security\ContaoCorePermissions;
use Contao\Date;
use Contao\FilesModel;
@@ -22,6 +21,7 @@
use Exception;
use Oveleon\ContaoRecommendationBundle\Model\RecommendationModel;
use Oveleon\ContaoRecommendationBundle\Model\RecommendationArchiveModel;
+use Symfony\Component\Filesystem\Path;
/**
* Parent class for recommendation modules.
@@ -120,29 +120,34 @@ protected function parseRecommendation(RecommendationModel $objRecommendation, R
// Parsing image meta field to template for backwards compatibility // Works for recommendation_default.html5
$objTemplate->addRecommendationImage = array_key_exists('image', $arrMeta);
+ $container = System::getContainer();
+
// Add an image
if ($objRecommendation->imageUrl != '')
{
- $objRecommendation->imageUrl = Controller::replaceInsertTags($objRecommendation->imageUrl);
+ $objRecommendation->imageUrl = $container->get('contao.insert_tag.parser')->replace($objRecommendation->imageUrl);
+
+ // Insert tag parser on contao ^5 returns a leading slash whilst contao 4.13 does not
+ if (Path::isAbsolute($objRecommendation->imageUrl))
+ {
+ $objRecommendation->imageUrl = substr($objRecommendation->imageUrl,1);
+ }
if ($this->isExternal($objRecommendation->imageUrl))
{
$objTemplate->addExternalImage = true;
-
$objTemplate->imageUrl = $objRecommendation->imageUrl;
}
else
{
$objModel = FilesModel::findByPath($objRecommendation->imageUrl);
-
- $this->addInternalImage($objModel, $objRecommendation, $objTemplate);
+ $this->addInternalImage($objModel, $objTemplate);
}
}
elseif (Config::get('recommendationDefaultImage'))
{
$objModel = FilesModel::findByUuid(Config::get('recommendationDefaultImage'));
-
- $this->addInternalImage($objModel, $objRecommendation, $objTemplate);
+ $this->addInternalImage($objModel, $objTemplate);
}
// HOOK: add custom logic
@@ -156,9 +161,9 @@ protected function parseRecommendation(RecommendationModel $objRecommendation, R
}
// Tag recommendations
- if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
+ if ($container->has('fos_http_cache.http.symfony_response_tagger'))
{
- $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
+ $responseTagger = $container->get('fos_http_cache.http.symfony_response_tagger');
$responseTagger->addTags(['contao.db.tl_recommendation.' . $objRecommendation->id]);
}
@@ -268,34 +273,35 @@ protected function isExternal(string $strPath): bool
/**
* Add an internal image to template
- *
- * @param FilesModel $objModel The files model
- * @param RecommendationModel $objRecommendation The recommendation model
- * @param FrontendTemplate $objTemplate The frontend template
*/
- protected function addInternalImage($objModel, $objRecommendation, &$objTemplate): void
+ protected function addInternalImage($objModel, &$objTemplate): void
{
- // ToDo: Contao 5.x compatibility
- if ($objModel !== null && is_file(System::getContainer()->getParameter('kernel.project_dir') . '/' . $objModel->path))
+ if (null !== $objModel)
{
+ $imgSize = $this->imgSize ?: null;
$objTemplate->addInternalImage = true;
- // Do not override the field now that we have a model registry (see #6303)
- $arrRecommendation = $objRecommendation->row();
-
// Override the default image size
- if ($this->imgSize != '')
+ if ($this->imgSize)
{
$size = StringUtil::deserialize($this->imgSize);
if ($size[0] > 0 || $size[1] > 0 || is_numeric($size[2]) || ($size[2][0] ?? null) === '_')
{
- $arrRecommendation['size'] = $this->imgSize;
+ $imgSize = $this->imgSize;
}
}
- $arrRecommendation['singleSRC'] = $objModel->path;
- $this->addImageToTemplate($objTemplate, $arrRecommendation, null, null, $objModel);
+ $figureBuilder = System::getContainer()
+ ->get('contao.image.studio')
+ ->createFigureBuilder()
+ ->from($objModel->path)
+ ->setSize($imgSize);
+
+ if (null !== ($figure = $figureBuilder->buildIfResourceExists()))
+ {
+ $figure->applyLegacyTemplateData($objTemplate);
+ }
}
}
diff --git a/contao/modules/ModuleRecommendationList.php b/contao/modules/ModuleRecommendationList.php
index 4bb7264..d74745a 100644
--- a/contao/modules/ModuleRecommendationList.php
+++ b/contao/modules/ModuleRecommendationList.php
@@ -46,11 +46,11 @@ public function generate(): string
if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
{
$objTemplate = new BackendTemplate('be_wildcard');
- $objTemplate->wildcard = '### ' . mb_strtoupper($GLOBALS['TL_LANG']['FMD']['recommendationlist'][0], 'UTF-8') . ' ###';
+ $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['recommendationlist'][0] . ' ###';
$objTemplate->title = $this->headline;
$objTemplate->id = $this->id;
$objTemplate->link = $this->name;
- $objTemplate->href = 'contao/main.php?do=themes&table=tl_module&act=edit&id=' . $this->id;
+ $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
return $objTemplate->parse();
}
@@ -135,7 +135,7 @@ protected function compile()
}
// Get the current page
- $id = 'page_n' . $this->id;
+ $id = 'page_r' . $this->id;
$page = Input::get($id) ?? 1;
// Do not index or cache the page if the page number is outside the range
diff --git a/contao/modules/ModuleRecommendationReader.php b/contao/modules/ModuleRecommendationReader.php
index 1e5aca5..afe756f 100644
--- a/contao/modules/ModuleRecommendationReader.php
+++ b/contao/modules/ModuleRecommendationReader.php
@@ -45,11 +45,11 @@ public function generate()
if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
{
$objTemplate = new BackendTemplate('be_wildcard');
- $objTemplate->wildcard = '### ' . mb_strtoupper($GLOBALS['TL_LANG']['FMD']['recommendationreader'][0], 'UTF-8') . ' ###';
+ $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['recommendationreader'][0] . ' ###';
$objTemplate->title = $this->headline;
$objTemplate->id = $this->id;
$objTemplate->link = $this->name;
- $objTemplate->href = 'contao/main.php?do=themes&table=tl_module&act=edit&id=' . $this->id;
+ $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
return $objTemplate->parse();
}
From e86e2fc8f63428ba4795004de9d6475db58c14b4 Mon Sep 17 00:00:00 2001
From: Sebastian Zoglowek
Date: Thu, 1 Jun 2023 12:23:28 +0200
Subject: [PATCH 16/19] Update readme and add comments
---
README.md | 2 +-
composer.json | 5 ++++-
src/Cron/PurgeRecommendationsCron.php | 6 ++++++
src/DependencyInjection/ContaoRecommendationExtension.php | 6 ++++++
.../DataContainer/RecommendationArchiveListener.php | 6 ++++++
src/EventListener/DataContainer/RecommendationListener.php | 6 ++++++
src/EventListener/SitemapListener.php | 6 ++++++
src/Security/ContaoRecommendationPermissions.php | 6 ++++++
8 files changed, 41 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 00b1d7e..28a834a 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
---
-> Working with **Contao 4.9** and up to **Contao 4.13** (PHP ^7.4 and PHP 8)
+> Working with **Contao 4.13** and **Contao 5.1** (PHP ^8.1)
---
diff --git a/composer.json b/composer.json
index 0f5a244..93ff511 100644
--- a/composer.json
+++ b/composer.json
@@ -1,7 +1,7 @@
{
"name": "oveleon/contao-recommendation-bundle",
"type": "contao-bundle",
- "description": "Recommendation integration for Contao 4 Open Source CMS",
+ "description": "Recommendation integration for Contao Open Source CMS",
"keywords": [
"contao",
"recommendation-bundle",
@@ -38,6 +38,9 @@
"contao/core": "*",
"contao/manager-plugin": "<2.0 || >=3.0"
},
+ "suggest": {
+ "oveleon/contao-google-recommendation-bundle": "This bundle imports Google reviews into the contao-recommendation-bundle"
+ },
"autoload": {
"psr-4": {
"Oveleon\\ContaoRecommendationBundle\\": "src/"
diff --git a/src/Cron/PurgeRecommendationsCron.php b/src/Cron/PurgeRecommendationsCron.php
index aebb7e8..14e3665 100644
--- a/src/Cron/PurgeRecommendationsCron.php
+++ b/src/Cron/PurgeRecommendationsCron.php
@@ -2,6 +2,12 @@
declare(strict_types=1);
+/*
+ * This file is part of Oveleon Recommendation Bundle.
+ *
+ * (c) https://www.oveleon.de/
+ */
+
namespace Oveleon\ContaoRecommendationBundle\Cron;
use Contao\CoreBundle\DependencyInjection\Attribute\AsCronJob;
diff --git a/src/DependencyInjection/ContaoRecommendationExtension.php b/src/DependencyInjection/ContaoRecommendationExtension.php
index 947e245..16e0e07 100644
--- a/src/DependencyInjection/ContaoRecommendationExtension.php
+++ b/src/DependencyInjection/ContaoRecommendationExtension.php
@@ -1,5 +1,11 @@
Date: Thu, 1 Jun 2023 14:19:42 +0200
Subject: [PATCH 17/19] Convert recommendationActiveColor into a serialized
string in contao ^5.1.7
---
contao/dca/tl_recommendation_settings.php | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/contao/dca/tl_recommendation_settings.php b/contao/dca/tl_recommendation_settings.php
index 5772b6f..ebb78ff 100644
--- a/contao/dca/tl_recommendation_settings.php
+++ b/contao/dca/tl_recommendation_settings.php
@@ -8,6 +8,7 @@
use Contao\Config;
use Contao\DC_File;
+use Contao\StringUtil;
$GLOBALS['TL_DCA']['tl_recommendation_settings'] = [
@@ -31,6 +32,18 @@
'recommendationActiveColor' => [
'inputType' => 'text',
'eval' => ['maxlength'=>6, 'multiple'=>true, 'size'=>1, 'colorpicker'=>true, 'isHexColor'=>true, 'decodeEntities'=>true, 'tl_class'=>'w50 wizard'],
+ 'save_callback' => [
+ // See contao/issues (#6105)
+ static function ($value)
+ {
+ if (!\is_array($value))
+ {
+ return StringUtil::restoreBasicEntities($value);
+ }
+
+ return serialize(array_map('\Contao\StringUtil::restoreBasicEntities', $value));
+ }
+ ]
]
]
];
From c5e686a69ac639a63df18bb4232da63324ef9e35 Mon Sep 17 00:00:00 2001
From: Sebastian Zoglowek
Date: Thu, 1 Jun 2023 17:00:27 +0200
Subject: [PATCH 18/19] Change branch alias
---
composer.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/composer.json b/composer.json
index 93ff511..95b36ac 100644
--- a/composer.json
+++ b/composer.json
@@ -57,7 +57,7 @@
},
"extra": {
"branch-alias": {
- "dev-master": "1.3.x-dev"
+ "dev-main": "1.3.x-dev"
},
"contao-manager-plugin": "Oveleon\\ContaoRecommendationBundle\\ContaoManager\\Plugin"
}
From 73d6ff1c89e8fe22e8f9a1bc35a55d40debdc67d Mon Sep 17 00:00:00 2001
From: Sebastian Zoglowek <55794780+zoglo@users.noreply.github.com>
Date: Thu, 1 Jun 2023 19:13:03 +0200
Subject: [PATCH 19/19] Add tests
- Plugin
- Cron
- Sitemap
---
.gitignore | 10 ++
composer.json | 12 ++-
phpunit.xml.dist | 21 ++++
tests/ContaoManager/PluginTest.php | 28 ++++++
tests/Cron/PurgeRecommendationsCronTest.php | 33 +++++++
tests/EventListener/SitemapListenerTest.php | 102 ++++++++++++++++++++
6 files changed, 205 insertions(+), 1 deletion(-)
create mode 100644 .gitignore
create mode 100644 phpunit.xml.dist
create mode 100644 tests/ContaoManager/PluginTest.php
create mode 100644 tests/Cron/PurgeRecommendationsCronTest.php
create mode 100644 tests/EventListener/SitemapListenerTest.php
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a01604a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+# Composer
+/composer.lock
+/vendor/
+
+# PhpUnit
+/.phpunit.result.cache
+/phpunit.xml
+
+# IDE
+/.idea
diff --git a/composer.json b/composer.json
index 95b36ac..0788d4e 100644
--- a/composer.json
+++ b/composer.json
@@ -32,7 +32,11 @@
"contao/core-bundle": "^4.13 || ^5.1"
},
"require-dev": {
- "contao/manager-plugin": "^2.0"
+ "contao/manager-plugin": "^2.3.1",
+ "contao/test-case": "^5.1",
+ "phpunit/phpunit": "^9.5",
+ "symfony/http-client": "^5.4 || ^6.0",
+ "symfony/phpunit-bridge": "^5.4 || ^6.0"
},
"conflict": {
"contao/core": "*",
@@ -60,5 +64,11 @@
"dev-main": "1.3.x-dev"
},
"contao-manager-plugin": "Oveleon\\ContaoRecommendationBundle\\ContaoManager\\Plugin"
+ },
+ "config": {
+ "allow-plugins": {
+ "php-http/discovery": true,
+ "contao/manager-plugin": true
+ }
}
}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..b64057e
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,21 @@
+
+
+
+
+ ./src
+
+
+
+
+
+
+
+
+
+ ./tests
+
+
+
+
+
+
diff --git a/tests/ContaoManager/PluginTest.php b/tests/ContaoManager/PluginTest.php
new file mode 100644
index 0000000..3f16e4a
--- /dev/null
+++ b/tests/ContaoManager/PluginTest.php
@@ -0,0 +1,28 @@
+createMock(ParserInterface::class);
+
+ /** @var BundleConfig $config */
+ $config = (new Plugin())->getBundles($parser)[0];
+
+ $this->assertInstanceOf(BundleConfig::class, $config);
+ $this->assertSame(ContaoRecommendationBundle::class, $config->getName());
+ $this->assertSame([ContaoCoreBundle::class], $config->getLoadAfter());
+ $this->assertSame(['recommendation'], $config->getReplace());
+ }
+}
diff --git a/tests/Cron/PurgeRecommendationsCronTest.php b/tests/Cron/PurgeRecommendationsCronTest.php
new file mode 100644
index 0000000..2a49a6d
--- /dev/null
+++ b/tests/Cron/PurgeRecommendationsCronTest.php
@@ -0,0 +1,33 @@
+createMock(RecommendationModel::class);
+ $recommendationModel
+ ->expects($this->once())
+ ->method('delete')
+ ;
+
+ $recommendationModelAdapter = $this->mockAdapter(['findExpiredRecommendations']);
+ $recommendationModelAdapter
+ ->expects($this->once())
+ ->method('findExpiredRecommendations')
+ ->willReturn(new Collection([$recommendationModel], RecommendationModel::getTable()))
+ ;
+
+ $framework = $this->mockContaoFramework([RecommendationModel::class => $recommendationModelAdapter]);
+
+ (new PurgeRecommendationsCron($framework, null))();
+ }
+}
diff --git a/tests/EventListener/SitemapListenerTest.php b/tests/EventListener/SitemapListenerTest.php
new file mode 100644
index 0000000..2b09e04
--- /dev/null
+++ b/tests/EventListener/SitemapListenerTest.php
@@ -0,0 +1,102 @@
+ $this->mockConfiguredAdapter(['findByProtected' => null]),
+ ];
+
+ $sitemapEvent = $this->createSitemapEvent([]);
+ $listener = $this->createListener([], $adapters);
+ $listener($sitemapEvent);
+
+ $this->assertStringNotContainsString('', (string) $sitemapEvent->getDocument()->saveXML());
+ }
+
+ public function testRecommendationIsAdded(): void
+ {
+ $jumpToPage = $this->mockClassWithProperties(PageModel::class, [
+ 'published' => 1,
+ 'protected' => 0,
+ ]);
+
+ $jumpToPage
+ ->method('getAbsoluteUrl')
+ ->willReturn('https://www.oveleon.de')
+ ;
+
+ $adapters = [
+ RecommendationArchiveModel::class => $this->mockConfiguredAdapter([
+ 'findByProtected' => [
+ $this->mockClassWithProperties(RecommendationArchiveModel::class, [
+ 'jumpTo' => 21,
+ ]),
+ ],
+ ]),
+ PageModel::class => $this->mockConfiguredAdapter([
+ 'findWithDetails' => $jumpToPage,
+ ]),
+ RecommendationModel::class => $this->mockConfiguredAdapter([
+ 'findPublishedByPid' => [
+ $this->mockClassWithProperties(RecommendationModel::class, [
+ 'jumpTo' => 21,
+ ]),
+ ],
+ ]),
+ ];
+
+ $sitemapEvent = $this->createSitemapEvent([1]);
+ $listener = $this->createListener([1, 21], $adapters);
+ $listener($sitemapEvent);
+
+ $this->assertStringContainsString('https://www.oveleon.de', (string) $sitemapEvent->getDocument()->saveXML());
+ }
+
+ private function createListener(array $allPages, array $adapters): SitemapListener
+ {
+ $database = $this->createMock(Database::class);
+ $database
+ ->method('getChildRecords')
+ ->willReturn($allPages)
+ ;
+
+ $instances = [
+ Database::class => $database,
+ ];
+
+ $framework = $this->mockContaoFramework($adapters, $instances);
+
+ return new SitemapListener($framework);
+ }
+
+ private function createSitemapEvent(array $rootPages): SitemapEvent
+ {
+ $sitemap = new \DOMDocument('1.0', 'UTF-8');
+ $urlSet = $sitemap->createElementNS('https://www.sitemaps.org/schemas/sitemap/0.9', 'urlset');
+ $sitemap->appendChild($urlSet);
+
+ return new SitemapEvent($sitemap, new Request(), $rootPages);
+ }
+}