feat: add option to omit the ip address when saving redirections (#20)

Fixes #19

Author: jeboehm

src/Resources/config/config.xml

@@ -4,6 +4,7 @@
     <card>
         <title>Cleanup</title>
         <title lang="de-DE">Aufräumen</title>
+
         <input-field type="int">
             <name>deleteRequestsAfterDays</name>
             <label>Delete requests after x days</label>
@@ -12,5 +13,14 @@
             <helpText lang="de-DE">Dies wird auch zur Berechnung der Anzahl im Listing verwendet</helpText>
             <defaultValue>30</defaultValue>
         </input-field>
+
+        <input-field type="bool">
+            <name>saveIpAddresses</name>
+            <label>Save IP addresses</label>
+            <label lang="de-DE">IP-Adressen speichern</label>
+            <helpText>Save IP addresses of requests</helpText>
+            <helpText lang="de-DE">IP-Adressen von Aufrufen speichern</helpText>
+            <defaultValue>true</defaultValue>
+        </input-field>
     </card>
 </config>

src/Subscriber/ExceptionSubscriber.php

@@ -17,6 +17,7 @@
 use Shopware\Core\System\SalesChannel\Context\SalesChannelContextFactory;
 use Shopware\Core\System\SalesChannel\Context\SalesChannelContextService;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Shopware\Storefront\Framework\Routing\RequestTransformer;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -36,6 +37,7 @@ public function __construct(
         private readonly EntityRepository $tinectRedirectsRedirectRepository,
         private readonly SeoUrlPlaceholderHandlerInterface $seoUrlPlaceholderHandler,
         #[Autowire(service: SalesChannelContextFactory::class)] private readonly AbstractSalesChannelContextFactory $salesChannelContextFactory,
+        private readonly SystemConfigService $systemConfigService,
         private readonly MessageBusInterface $messageBus,
     ) {
     }
@@ -90,7 +92,7 @@ private function handleRequest(Request $request): ?Response
         $message = new TinectRedirectUpdateMessage(
             source: $path,
             salesChannelDomainId:  $salesChannelDomainId,
-            ipAddress: $request->getClientIp() ?? '',
+            ipAddress: $this->getIpAddress($request),
             userAgent: $request->headers->get('User-Agent') ?? '',
         );
 
@@ -162,4 +164,24 @@ private function createSalesChannelContext(string $salesChannelId, string $langu
     {
         return $this->salesChannelContextFactory->create('', $salesChannelId, [SalesChannelContextService::LANGUAGE_ID => $languageId]);
     }
+
+    private function getIpAddress(Request $request): string
+    {
+        $salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
+
+        if (!\is_string($salesChannelId) || empty($salesChannelId)) {
+            $salesChannelId = null;
+        }
+
+        if (!$this->canSaveIpAddress($salesChannelId)) {
+            return '';
+        }
+
+        return $request->getClientIp() ?? '';
+    }
+
+    private function canSaveIpAddress(?string $salesChannelId): bool
+    {
+        return $this->systemConfigService->getBool('TinectRedirects.config.saveIpAddresses', $salesChannelId);
+    }
 }