Use the new IP address provider interface

Author: mbabker

composer.json

@@ -18,7 +18,7 @@
         "symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",
         "symfony/event-dispatcher": "^5.4 || ^6.0 || ^7.0",
         "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
-        "gedmo/doctrine-extensions": "^3.19.0"
+        "gedmo/doctrine-extensions": "^3.20.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^1.10",

src/EventListener/IpTraceListener.php

@@ -10,6 +10,8 @@
 
 /**
  * @internal
+ *
+ * @deprecated to be removed in 2.0, use the IP address provider instead
  */
 final class IpTraceListener implements EventSubscriberInterface
 {

src/Resources/config/ip_traceable.xml

@@ -12,11 +12,14 @@
             <call method="setAnnotationReader">
                 <argument type="service" id=".stof_doctrine_extensions.reader" on-invalid="ignore" />
             </call>
+            <call method="setIpAddressProvider">
+                <argument type="service" id="stof_doctrine_extensions.tool.ip_address_provider" />
+            </call>
         </service>
 
         <service id="stof_doctrine_extensions.event_listener.ip_trace" class="Stof\DoctrineExtensionsBundle\EventListener\IpTraceListener" public="false">
+            <deprecated package="stof/doctrine-extensions-bundle" version="1.14">The "%service_id%" service is deprecated and will be removed in 2.0. The "stof_doctrine_extensions.tool.ip_address_provider" service should be used to provide the IP address instead.</deprecated>
             <argument type="service" id="stof_doctrine_extensions.listener.ip_traceable" />
-            <tag name="kernel.event_subscriber" />
         </service>
     </services>
 </container>

src/Resources/config/tool.xml

@@ -9,5 +9,9 @@
             <argument type="service" id="security.token_storage" on-invalid="null" />
             <argument type="service" id="security.authorization_checker" on-invalid="null" />
         </service>
+
+        <service id="stof_doctrine_extensions.tool.ip_address_provider" class="Stof\DoctrineExtensionsBundle\Tool\RequestStackIpAddressProvider" public="false">
+            <argument type="service" id="request_stack" />
+        </service>
     </services>
 </container>

src/Tool/RequestStackIpAddressProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Stof\DoctrineExtensionsBundle\Tool;
+
+use Gedmo\Tool\IpAddressProviderInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Provides an IP address for the extensions using an IP address reference.
+ *
+ * @internal
+ */
+final class RequestStackIpAddressProvider implements IpAddressProviderInterface
+{
+    private RequestStack $requestStack;
+
+    public function __construct(RequestStack $requestStack)
+    {
+        $this->requestStack = $requestStack;
+    }
+
+    public function getAddress(): ?string
+    {
+        $request = $this->requestStack->getCurrentRequest();
+
+        if (null === $request) {
+            return null;
+        }
+
+        return $request->getClientIp();
+    }
+}