Merge pull request #34 from Leuchtfeuer/dev-11

Merge updates for version 11
Leuchtfeuer · Apr 26, 2022 · 3dac8cd · 3dac8cd
2 parents 4ad8e52 + 767d81c
commit 3dac8cd
Show file tree

Hide file tree

Showing 19 changed files with 194 additions and 150 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -9,10 +9,10 @@ on:
 jobs:
   integration:
     name: Integration tests
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: [7.2, 7.3, 7.4]
+        php-version: [7.4, 8.0]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -27,24 +27,29 @@ jobs:
   phpunit:
     needs: integration
     name: PHP ${{ matrix.php-version }} - T3 ${{ matrix.typo3-version }}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     continue-on-error: ${{ matrix.experimental }}
     strategy:
       matrix:
-        experimental: [false]
-        php-version: [7.2, 7.3, 7.4]
-        typo3-version: [^10.4]
         include:
           - php-version: 7.4
-            typo3-version: 10.4.x-dev
-            experimental: true
+            typo3-version: ^10.4
+            experimental: false
 
           - php-version: 7.4
-            typo3-version: ^11.0
+            typo3-version: ^11.5
             experimental: false
 
-          - php-version: 7.4
-            typo3-version: dev-master
+          - php-version: 8.0
+            typo3-version: ^11.5
+            experimental: false
+
+          - php-version: 8.0
+            typo3-version: 11.5.x-dev
+            experimental: true
+
+          - php-version: 8.1
+            typo3-version: dev-main
             experimental: true
     env:
       PHP_VERSION: ${{ matrix.php-version }}

diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@
 .phpunit.result.cache
 /composer.lock
 /var
-.idea
+.idea
diff --git a/Classes/Command/UpdateIpDatabaseCommand.php b/Classes/Command/UpdateIpDatabaseCommand.php
@@ -103,7 +103,10 @@ private function validateArguments(): bool
     private function truncateTable(): void
     {
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->table);
-        $connection->executeUpdate($connection->getDatabasePlatform()->getTruncateTableSQL($this->table, true));
+        $databasePlatform = $connection->getDatabasePlatform();
+        if ($databasePlatform) {
+            $connection->executeStatement($databasePlatform->getTruncateTableSQL($this->table, true));
+        }
     }
 
     /**

diff --git a/Classes/Domain/Repository/RegionRepository.php b/Classes/Domain/Repository/RegionRepository.php
@@ -33,7 +33,7 @@ public function getCountriesForPage(int $id): array
             ->join('rmm', 'static_countries', 'c', 'c.uid = rmm.uid_foreign')
             ->where($qb->expr()->eq('pmm.uid_local', $qb->createNamedParameter($id, \PDO::PARAM_INT)))
             ->execute()
-            ->fetchAll();
+            ->fetchAllAssociative();
 
         foreach ($results as $result) {
             $iso2Codes[$result['cn_iso_2']] = true;
@@ -52,7 +52,7 @@ public function shouldApplyWhenNoIpMatches(int $id): bool
             ->where($qb->expr()->eq('uid_local', $qb->createNamedParameter($id, \PDO::PARAM_INT)))
             ->andWhere($qb->expr()->eq('uid_foreign', $qb->createNamedParameter(self::APPLY_WHEN_NO_IP_MATCHES, \PDO::PARAM_INT)))
             ->execute()
-            ->fetchAll();
+            ->fetchAllAssociative();
 
         return !empty($results);
     }

diff --git a/Classes/FactProvider/AbstractFactProvider.php b/Classes/FactProvider/AbstractFactProvider.php
@@ -27,10 +27,12 @@ abstract class AbstractFactProvider
 
     /**
      * @param string $basename The basename for the factsArray. This name comes from configuration.
+     * @param array $configuration TypoScript configuration array for this fact provider
      */
-    public function __construct(string $basename = '')
+    public function __construct(string $basename = '', array $configuration = [])
     {
         $this->basename = $basename;
+        $this->configuration = $configuration;
     }
 
     public function isMultiple(): bool

diff --git a/Classes/FactProvider/IP2Country.php b/Classes/FactProvider/IP2Country.php
@@ -33,7 +33,9 @@ public function getBasename(): string
      */
     public function process(): self
     {
-        $iso2 = GeneralUtility::makeInstance(LocateUtility::class)->getCountryIso2FromIP();
+        $simulateIp = $this->configuration['settings']['simulateIp'] ? : null;
+
+        $iso2 = GeneralUtility::makeInstance(LocateUtility::class)->getCountryIso2FromIP($simulateIp) ?? '';
         LocateUtility::mainstreamValue($iso2);
         $this->facts[$this->getBasename()] = $iso2;
 

diff --git a/Classes/Hook/OverrideIconOverlayHook.php b/Classes/Hook/OverrideIconOverlayHook.php
@@ -52,6 +52,6 @@ private function countRegions(string $table, array $row): int
             ->from($table)
             ->where($qb->expr()->eq('uid', $row['uid']))
             ->execute()
-            ->fetchColumn(0);
+            ->fetchOne();
     }
 }
diff --git a/Classes/Judge/Condition.php b/Classes/Judge/Condition.php
@@ -24,7 +24,7 @@ public function adjudicate(AbstractFactProvider $factProvider, int $priority = A
     {
         $prosecution = $this->configuration['prosecution'] ?? $this->configuration['prosecution.'] ?? null;
 
-        if ($prosecution !== null && $factProvider->isGuilty($prosecution) && isset($this->configuration['verdict'])) {
+        if ($prosecution !== null && isset($this->configuration['verdict']) && $factProvider->isGuilty($prosecution)) {
             $this->decision = (new Decision())->withVerdictName($this->configuration['verdict']);
             $this->decision->setPriority($priority);
 

diff --git a/Classes/Middleware/LanguageRedirectMiddleware.php b/Classes/Middleware/LanguageRedirectMiddleware.php
@@ -43,6 +43,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                     'overrideSessionValue' => (bool)($locateSetup['overrideSessionValue'] ?? 0),
                     'sessionHandling' => (bool)($locateSetup['sessionHandling'] ?? 0),
                     'excludeBots' => (bool)($locateSetup['excludeBots'] ?? 1),
+                    'simulateIp' => $locateSetup['simulateIp'] ? : null,
                 ],
             ];
 

diff --git a/Classes/Processor/Court.php b/Classes/Processor/Court.php
@@ -95,7 +95,7 @@ protected function processFacts(): void
             }
 
             /* @var $factProvider AbstractFactProvider */
-            $factProvider = GeneralUtility::makeInstance($className);
+            $factProvider = GeneralUtility::makeInstance($className, $key, $this->configuration);
 
             if (!$factProvider instanceof AbstractFactProvider) {
                 throw new IllegalFactProviderException(
@@ -141,8 +141,7 @@ protected function callJudges(): ?Decision
             $configuration = $this->configuration['judges'][$key . '.'] ?? [];
 
             if (empty($configuration)) {
-                $this->logger->warning('');
-                // TODO: Do something?
+                $this->logger->warning('No judges are configured.');
             }
 
             $this->logger->info(sprintf('Judge with key "%s" will be called.', $key));

diff --git a/Classes/Utility/LocateUtility.php b/Classes/Utility/LocateUtility.php
@@ -27,7 +27,7 @@ class LocateUtility
     public function getCountryIso2FromIP(?string $ip = null)
     {
         $ip = $this->getNumericIp($ip);
-        $tableName = self::getTableNameForIp($ip);
+        $tableName = $this->getTableNameForIp($ip);
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($tableName);
 
         return $queryBuilder
@@ -36,12 +36,12 @@ public function getCountryIso2FromIP(?string $ip = null)
             ->where($queryBuilder->expr()->lte('ip_from', $queryBuilder->createNamedParameter($ip)))
             ->andWhere($queryBuilder->expr()->gte('ip_to', $queryBuilder->createNamedParameter($ip)))
             ->execute()
-            ->fetchColumn(0);
+            ->fetchOne();
     }
 
     public function getNumericIp(?string $ip = null): string
     {
-        $ip = $ip ?? GeneralUtility::getIndpEnv('REMOTE_ADDR');
+        $ip = $ip ?? (string)GeneralUtility::getIndpEnv('REMOTE_ADDR');
 
         return strpos($ip, '.') !== false ? (string)ip2long($ip) : $this->convertIpv6($ip);
     }
@@ -63,7 +63,8 @@ private function convertIpv6(string $ip): string
                 break;
 
             case function_exists('bcadd'):
-                for ($i = 0; $i < strlen($bin); $i++) {
+                $max = strlen($bin);
+                for ($i = 0; $i < $max; $i++) {
                     $decimalIp = bcmul($decimalIp, '2');
                     $decimalIp = bcadd($decimalIp, $bin[$i]);
                 }
@@ -80,7 +81,7 @@ private function convertIpv6(string $ip): string
         return $decimalIp;
     }
 
-    public static function mainstreamValue(string &$value)
+    public static function mainstreamValue(string &$value): void
     {
         $value = mb_strtolower(str_replace('-', '_', $value));
     }

diff --git a/Classes/Verdict/Redirect.php b/Classes/Verdict/Redirect.php
@@ -28,7 +28,7 @@ class Redirect extends AbstractVerdict
     const SESSION_KEY = 'language';
     const OVERRIDE_PARAMETER = 'setLang';
 
-    private $cookieMode = false;
+    private $sessionMode = false;
 
     private $redirectLanguageUid = 0;
 
@@ -43,9 +43,9 @@ public function execute(): ?ResponseInterface
         $this->redirectLanguageUid = (int)$this->configuration['sys_language'];
         $this->requestedLanguageUid = GeneralUtility::makeInstance(Context::class)->getAspect('language')->getId();
 
-        // Initialize Cookie mode if necessary and prepare everything for possible redirects
-        $this->initializeCookieMode();
-        $this->handleCookieStuff();
+        // Initialize Session mode if necessary and prepare everything for possible redirects
+        $this->initializeSessionMode();
+        $this->handleSessionStuff();
 
         // Skip if no redirect is necessary
         if (!$this->shouldRedirect()) {
@@ -66,60 +66,60 @@ public function execute(): ?ResponseInterface
     }
 
     /**
-     * Set CookeMode Param to true if sessionHandling is enables
+     * Set sessionMode Param to true if sessionHandling is enables
      */
-    private function initializeCookieMode(): void
+    private function initializeSessionMode(): void
     {
         if ((bool)($this->configuration['sessionHandling'] ?? false) === true) {
-            $this->logger->info('Cookie Handling is set.');
-            $this->cookieMode = true;
+            $this->logger->info('Session Handling is set.');
+            $this->sessionMode = true;
         }
     }
 
-    private function handleCookieStuff()
+    private function handleSessionStuff()
     {
         $currentLanguageUid = $this->requestedLanguageUid;
 
-        if ($this->isCookieSet()) {
-            // Cookie is not in current language
-            $this->logger->info('Cookie is set.');
+        if ($this->isSessionValueSet()) {
+            // Session is not in current language
+            $this->logger->info('Session value is set.');
 
-            if ($this->isCookieInCurrentLanguage() === false && $this->shouldOverrideSessionValue() === true) {
-                // Override cookie
-                $this->logger->info('Cookie is not in current language, so we override it.');
+            if ($this->isSessionInCurrentLanguage() === false && $this->shouldOverrideSessionValue() === true) {
+                // Override session
+                $this->logger->info('Session is not in current language, so we override it.');
                 $this->redirectLanguageUid = $currentLanguageUid;
-                $this->setCookie($currentLanguageUid);
-            } elseif ($this->isCookieInCurrentLanguage()) {
-                // Cookie is in current language
-                $this->logger->info('Cookie is in current language.');
+                $this->setSessionValue($currentLanguageUid);
+            } elseif ($this->isSessionInCurrentLanguage()) {
+                // Session is in current language
+                $this->logger->info('Session is in current language.');
                 $this->redirectLanguageUid = $currentLanguageUid;
             } else {
-                // Override config array by cookie value
-                $this->logger->info('Cookie is not in current language and overriding is not allowed.');
-                $this->redirectLanguageUid = $this->getCookieValue();
-                $this->configuration['sys_language'] = $this->getCookieValue();
+                // Override config array by session value
+                $this->logger->info('Session is not in current language and overriding is not allowed.');
+                $this->redirectLanguageUid = $this->getSessionValue();
+                $this->configuration['sys_language'] = $this->getSessionValue();
             }
-        } elseif ($this->cookieMode === true) {
-            $this->logger->info('Cookie is not set, but we are in cookie mode.');
+        } elseif ($this->sessionMode === true) {
+            $this->logger->info('Session is not set, but we are in session mode.');
 
             if ($currentLanguageUid !== $this->redirectLanguageUid) {
-                // Set cookie value to target language
-                $this->setCookie($this->redirectLanguageUid);
+                // Set session value to target language
+                $this->setSessionValue($this->redirectLanguageUid);
             } else {
-                // Set cookie value to current language
-                $this->setCookie($currentLanguageUid);
+                // Set session value to current language
+                $this->setSessionValue($currentLanguageUid);
             }
         }
     }
 
-    private function isCookieSet(): bool
+    private function isSessionValueSet(): bool
     {
-        return $this->getCookieValue() !== null;
+        return $this->getSessionValue() !== null;
     }
 
-    private function isCookieInCurrentLanguage(): bool
+    private function isSessionInCurrentLanguage(): bool
     {
-        return $this->requestedLanguageUid === $this->getCookieValue();
+        return $this->requestedLanguageUid === $this->getSessionValue();
     }
 
     private function shouldOverrideSessionValue(): bool
@@ -131,7 +131,7 @@ private function shouldOverrideSessionValue(): bool
         return false;
     }
 
-    private function setCookie(?int $value)
+    private function setSessionValue(?int $value)
     {
         if ($value === null) {
             $value = (int)$this->configuration['sys_language'];
@@ -140,15 +140,15 @@ private function setCookie(?int $value)
         $this->session->set(self::SESSION_KEY, $value);
     }
 
-    private function getCookieValue(): ?int
+    private function getSessionValue(): ?int
     {
         return $this->session->get(self::SESSION_KEY);
     }
 
     private function shouldRedirect(): bool
     {
-        // Always redirect when we are not in cookie mode
-        if ($this->cookieMode === false) {
+        // Always redirect when we are not in session mode
+        if ($this->sessionMode === false) {
             return true;
         }
 
@@ -162,8 +162,8 @@ private function shouldRedirect(): bool
             }
         }
 
-        // Do not redirect, when cookie is set and cookie value matches given language id
-        if ($this->isCookieInCurrentLanguage()) {
+        // Do not redirect, when session is set and session value matches given language id
+        if ($this->isSessionInCurrentLanguage()) {
             return false;
         }
 

diff --git a/Configuration/Services.yaml b/Configuration/Services.yaml
@@ -8,4 +8,4 @@ services:
     tags:
       - name: console.command
         command: locate:update
-        schedulable: flase
+        schedulable: false
diff --git a/...tion/TypoScript/setup-switch_language.txt → ...ation/TypoScript/example_setup.typoscript b/...tion/TypoScript/setup-switch_language.txt → ...ation/TypoScript/example_setup.typoscript
@@ -16,6 +16,9 @@ config.tx_locate {
     # URL Parameter which has to be true when overrideCookie is allowed within action and cookieHandling is enabled
     overrideQueryParameter = setLang
 
+    # Simulate your IP address for countryByIP fact provider (for test purposes only), 109.10.163.98 is a french IP address
+    simulateIp = 109.10.163.98
+
     verdicts {
         redirectToMainlandChina = Leuchtfeuer\Locate\Verdict\Redirect
         redirectToMainlandChina.url = https://www.example.cn

diff --git a/Configuration/TypoScript/setup.typoscript b/Configuration/TypoScript/setup.typoscript
@@ -16,13 +16,16 @@ config.tx_locate {
     # URL Parameter which has to be true when overrideCookie is allowed within action and cookieHandling is enabled
     overrideQueryParameter = setLang
 
+    # Simulate your IP address for countryByIP fact provider (for test purposes only)
+    simulateIp =
+
     # See example file for configuration
     verdicts {
     }
 
     facts {
-        browserAcceptLanguage = Leuchtfeuer\Locate\FactProvider\BrowserAcceptedLanguage
-        countryByIP = Leuchtfeuer\Locate\FactProvider\IP2Country
+        #browserAcceptLanguage = Leuchtfeuer\Locate\FactProvider\BrowserAcceptedLanguage
+        #countryByIP = Leuchtfeuer\Locate\FactProvider\IP2Country
     }
 
     # See example file for configuration