Add an IP address provider for extensions referencing IP addresses

Author: mbabker

CHANGELOG.md

@@ -18,6 +18,8 @@ a release.
 ---
 
 ## [Unreleased]
+### Added
+- IP address provider for use with extensions with IP address references (#2928)
 
 ## [3.19.0] - 2025-02-24
 ### Added

doc/ip_traceable.md

@@ -23,10 +23,13 @@ $listener = new IpTraceableListener();
 $om->getEventManager()->addEventSubscriber($listener);
 ```
 
-Then, once your application has it available, you can set the IP address to be recorded for changes by calling
-the listener's `setIpValue` method.
+Then, once your application has it available, you can set the IP address to be recorded. The IP address can be set through
+either an [IP address provider service](./utils/ip-address-provider.md) or by calling the listener's `setIpValue` method.
 
 ```php
+// The $provider must be an implementation of Gedmo\Tool\IpAddressProviderInterface
+$listener->setIpAddressProvider($provider);
+
 $listener->setIpValue('127.0.0.1');
 ```
 

doc/utils/ip-address-provider.md

@@ -0,0 +1,45 @@
+# IP Address Provider
+
+The Doctrine Extensions package includes support for an "IP address provider" for extensions which use an IP address value, such as
+the IP traceable extension.
+
+## Index
+
+- [Getting Started](#getting-started)
+
+## Getting Started
+
+Out of the box, the library does not provide an implementation for the `Gedmo\Tool\IpAddressProviderInterface`, so you will
+need to create a class in your application. Below is an example of an IP address provider using Symfony's HttpFoundation component:
+
+```php
+namespace App\Utils;
+
+use Gedmo\Tool\IpAddressProviderInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+final class RequestIpAddressProvider implements IpAddressProviderInterface
+{
+    private RequestStack $requestStack;
+
+    public function __construct(RequestStack $requestStack)
+    {
+        $this->requestStack = $requestStack;
+    }
+
+    public function getAddress(): ?string
+    {
+        $request = $this->requestStack->getMainRequest();
+
+        return $request ? $request->getClientIp() : null;
+    }
+}
+```
+
+Once you've created your IP address provider, you can inject it into the listeners for supported extensions by calling
+the `setIpAddressProvider` method.
+
+```php
+/** @var Gedmo\IpTraceable\IpTraceableListener $listener */
+$listener->setIpAddressProvider($provider);
+```

src/IpTraceable/IpTraceableListener.php

@@ -13,6 +13,7 @@
 use Gedmo\AbstractTrackingListener;
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\IpTraceable\Mapping\Event\IpTraceableAdapter;
+use Gedmo\Tool\IpAddressProviderInterface;
 
 /**
  * The IpTraceable listener handles the update of
@@ -26,13 +27,15 @@
  */
 class IpTraceableListener extends AbstractTrackingListener
 {
+    protected ?IpAddressProviderInterface $ipAddressProvider = null;
+
     /**
      * @var string|null
      */
     protected $ip;
 
     /**
-     * Get the ipValue value to set on a ip field
+     * Get the IP address value to set on an IP address field
      *
      * @param ClassMetadata<object> $meta
      * @param string                $field
@@ -42,11 +45,25 @@ class IpTraceableListener extends AbstractTrackingListener
      */
     public function getFieldValue($meta, $field, $eventAdapter)
     {
+        if ($this->ipAddressProvider instanceof IpAddressProviderInterface) {
+            return $this->ipAddressProvider->getAddress();
+        }
+
         return $this->ip;
     }
 
     /**
-     * Set a ip value to return
+     * Set an IP address provider for the IP address value.
+     */
+    public function setIpAddressProvider(IpAddressProviderInterface $ipAddressProvider): void
+    {
+        $this->ipAddressProvider = $ipAddressProvider;
+    }
+
+    /**
+     * Set an IP address value to return.
+     *
+     * If an IP address provider is also provided, it will take precedence over this value.
      *
      * @param string|null $ip
      *

src/Tool/IpAddressProviderInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tool;
+
+/**
+ * Interface for a provider for an IP address for extensions supporting IP references.
+ */
+interface IpAddressProviderInterface
+{
+    public function getAddress(): ?string;
+}

tests/Gedmo/IpTraceable/IpTraceableTest.php

@@ -19,6 +19,7 @@
 use Gedmo\Tests\IpTraceable\Fixture\Article;
 use Gedmo\Tests\IpTraceable\Fixture\Comment;
 use Gedmo\Tests\IpTraceable\Fixture\Type;
+use Gedmo\Tests\TestIpAddressProvider;
 use Gedmo\Tests\Tool\BaseTestCaseORM;
 
 /**
@@ -29,16 +30,19 @@
 final class IpTraceableTest extends BaseTestCaseORM
 {
     private const TEST_IP = '34.234.1.10';
+    private const TEST_PROVIDER_IP = '34.234.2.10';
+
+    private IpTraceableListener $listener;
 
     protected function setUp(): void
     {
         parent::setUp();
 
-        $listener = new IpTraceableListener();
-        $listener->setIpValue(self::TEST_IP);
+        $this->listener = new IpTraceableListener();
+        $this->listener->setIpValue(self::TEST_IP);
 
         $evm = new EventManager();
-        $evm->addEventSubscriber($listener);
+        $evm->addEventSubscriber($this->listener);
 
         $this->getDefaultMockSqliteEntityManager($evm);
     }
@@ -116,6 +120,50 @@ public function testIpTraceable(): void
         static::assertSame(self::TEST_IP, $sport->getPublished());
     }
 
+    public function testIpTraceableWithProvider(): void
+    {
+        $this->listener->setIpAddressProvider(new TestIpAddressProvider(self::TEST_PROVIDER_IP));
+
+        $sport = new Article();
+        $sport->setTitle('Sport');
+
+        $sportComment = new Comment();
+        $sportComment->setMessage('hello');
+        $sportComment->setArticle($sport);
+        $sportComment->setStatus(0);
+
+        $this->em->persist($sport);
+        $this->em->persist($sportComment);
+        $this->em->flush();
+        $this->em->clear();
+
+        $sport = $this->em->getRepository(Article::class)->findOneBy(['title' => 'Sport']);
+        static::assertSame(self::TEST_PROVIDER_IP, $sport->getCreated());
+        static::assertSame(self::TEST_PROVIDER_IP, $sport->getUpdated());
+        static::assertNull($sport->getPublished());
+
+        $sportComment = $this->em->getRepository(Comment::class)->findOneBy(['message' => 'hello']);
+        static::assertSame(self::TEST_PROVIDER_IP, $sportComment->getModified());
+        static::assertNull($sportComment->getClosed());
+
+        $sportComment->setStatus(1);
+        $published = new Type();
+        $published->setTitle('Published');
+
+        $sport->setTitle('Updated');
+        $sport->setType($published);
+        $this->em->persist($sport);
+        $this->em->persist($published);
+        $this->em->persist($sportComment);
+        $this->em->flush();
+        $this->em->clear();
+
+        $sportComment = $this->em->getRepository(Comment::class)->findOneBy(['message' => 'hello']);
+        static::assertSame(self::TEST_PROVIDER_IP, $sportComment->getClosed());
+
+        static::assertSame(self::TEST_PROVIDER_IP, $sport->getPublished());
+    }
+
     public function testForcedValues(): void
     {
         $sport = new Article();

tests/Gedmo/TestIpAddressProvider.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tests;
+
+use Gedmo\Tool\IpAddressProviderInterface;
+
+final class TestIpAddressProvider implements IpAddressProviderInterface
+{
+    private ?string $address;
+
+    public function __construct(?string $address)
+    {
+        $this->address = $address;
+    }
+
+    public function getAddress(): ?string
+    {
+        return $this->address;
+    }
+}