[TASK] Use TYPO3 IpAnonymizationUtility

Related #3262
TYPO3-Solr · Oct 4, 2022 · dd95174 · dd95174
1 parent fbf456d
commit dd95174
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 59 deletions.
diff --git a/Classes/Domain/Search/Statistics/StatisticsWriterProcessor.php b/Classes/Domain/Search/Statistics/StatisticsWriterProcessor.php
@@ -31,6 +31,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
 use ApacheSolrForTypo3\Solr\Util;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\IpAnonymizationUtility;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
 /**
@@ -100,7 +101,7 @@ public function process(SearchResultSet $resultSet) {
             'time_processing' => isset($response->debug->timing->process->time) ? $response->debug->timing->process->time : 0,
             'feuser_id' => (int)$TSFE->fe_user->user['uid'],
             'cookie' => $TSFE->fe_user->id ?? '',
-            'ip' => $this->applyIpMask((string)$this->getUserIp(), $ipMaskLength),
+            'ip' => IpAnonymizationUtility::anonymizeIp($this->getUserIp(), $ipMaskLength),
             'page' => (int)$page,
             'keywords' => $keywords,
             'filters' => serialize($filters),
@@ -148,62 +149,6 @@ protected function sanitizeString($string)
         return $string;
     }
 
-    /**
-     * Internal function to mask portions of the visitor IP address
-     *
-     * @param string $ip IP address in network address format
-     * @param int $maskLength Number of octets to reset
-     * @return string
-     */
-    protected function applyIpMask(string $ip, int $maskLength): string
-    {
-        if (empty($ip) || $maskLength === 0) {
-            return $ip;
-        }
-
-        // IPv4 or mapped IPv4 in IPv6
-        if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
-            return $this->applyIpV4Mask($ip, $maskLength);
-        }
-
-        return $this->applyIpV6Mask($ip, $maskLength);
-    }
-
-    /**
-     * Apply a mask filter on the ip v4 address.
-     *
-     * @param string $ip
-     * @param int $maskLength
-     * @return string
-     */
-    protected function applyIpV4Mask($ip, $maskLength)
-    {
-        $i = strlen($ip);
-        if ($maskLength > $i) {
-            $maskLength = $i;
-        }
-
-        while ($maskLength-- > 0) {
-            $ip[--$i] = chr(0);
-        }
-        return (string)$ip;
-    }
-
-    /**
-     * Apply a mask filter on the ip v6 address.
-     *
-     * @param string $ip
-     * @param int $maskLength
-     * @return string
-     */
-    protected function applyIpV6Mask($ip, $maskLength):string
-    {
-        $masks = ['ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', 'ffff:ffff:ffff:ffff::', 'ffff:ffff:ffff:0000::', 'ffff:ff00:0000:0000::'];
-        $packedAddress = inet_pton($masks[$maskLength]);
-        $binaryString = pack('a16', $packedAddress);
-        return (string)($ip & $binaryString);
-    }
-
     /**
      * @return TypoScriptFrontendController
      */

diff --git a/Documentation/Configuration/Reference/TxSolrStatistics.rst b/Documentation/Configuration/Reference/TxSolrStatistics.rst
@@ -29,7 +29,7 @@ statistics.anonymizeIP
 :Since: 2.0
 :Default: 0
 
-Defines the number of octets of the IP address to anonymize in the statistics log records.
+Allowed values are 0 (masking disabled), 1 (mask host), 2 (mask host and subnet).
 
 statistics.addDebugData
 -----------------------

diff --git a/Tests/Integration/Controller/AbstractFrontendControllerTest.php b/Tests/Integration/Controller/AbstractFrontendControllerTest.php
@@ -23,7 +23,8 @@
 use TYPO3\CMS\Extbase\Mvc\Web\Response;
 use TYPO3\CMS\Frontend\Http\RequestHandler;
 
-abstract class AbstractFrontendControllerTest  extends IntegrationTest {
+abstract class AbstractFrontendControllerTest  extends IntegrationTest
+{
 
     /**
      * @return void

diff --git a/Tests/Integration/Controller/SearchControllerTest.php b/Tests/Integration/Controller/SearchControllerTest.php
@@ -75,6 +75,7 @@ public function setUp()
         $this->searchRequest = $this->getPreparedRequest();
         $this->searchResponse = $this->getPreparedResponse();
         $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['Indexer']['indexPageSubstitutePageDocument'][PageFieldMappingIndexer::class] = PageFieldMappingIndexer::class;
+        $_SERVER['REMOTE_ADDR'] = '192.168.1.1';
     }
 
     /**
@@ -83,6 +84,7 @@ public function setUp()
     public function tearDown()
     {
         $this->cleanUpSolrServerAndAssertEmpty();
+        unset($_SERVER['REMOTE_ADDR']);
         parent::tearDown();
     }
 

diff --git a/Tests/Integration/Controller/SuggestControllerTest.php b/Tests/Integration/Controller/SuggestControllerTest.php
@@ -65,8 +65,14 @@ public function setUp()
         $this->suggestResponse = $this->getPreparedResponse();
 
         $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['Indexer']['indexPageSubstitutePageDocument'][PageFieldMappingIndexer::class] = PageFieldMappingIndexer::class;
+        $_SERVER['REMOTE_ADDR'] = '192.168.1.1';
     }
 
+    public function tearDown()
+    {
+        unset($_SERVER['REMOTE_ADDR']);
+        parent::tearDown();
+    }
     /**
      * @test
      */