Merge pull request #8 from Dukecity/feature/merge-upstream

Feature/merge upstream
Dukecity · Nov 7, 2023 · 336baa9 · 336baa9
2 parents 6b40a7f + c93c209
commit 336baa9
Show file tree

Hide file tree

Showing 17 changed files with 229 additions and 58 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,7 +10,7 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - uses: shivammathur/setup-php@v2
             - name: Validate composer.json
               run: composer validate --strict --no-check-lock
@@ -22,7 +22,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php: [ '8.1', '8.2' ]
+                php: [ '8.1', '8.2', '8.3' ]
                 name_suffix: ['']
                 stability: ['stable']
                 composer_flags: ['']
@@ -31,13 +31,13 @@ jobs:
                       name_suffix: ' (lowest deps)'
                       stability: 'stable'
                       composer_flags: '--prefer-lowest'
-                    - php: '8.2'
+                    - php: '8.3'
                       name_suffix: ' (dev deps)'
                       stability: 'dev'
                       composer_flags: ''
 
         steps:
-            -   uses: actions/checkout@v3
+            -   uses: actions/checkout@v4
 
             -   uses: shivammathur/setup-php@v2
                 with:

diff --git a/composer.json b/composer.json
@@ -17,17 +17,17 @@
     ],
     "require": {
         "php": "^8.1",
-        "symfony/cache": "^5.4 || ^6.2",
-        "symfony/config": "^5.4 || ^6.2",
-        "symfony/dependency-injection": "^5.4 || ^6.2",
-        "symfony/event-dispatcher": "^5.4 || ^6.2",
-        "symfony/http-kernel": "^5.4 || ^6.2",
-        "gedmo/doctrine-extensions": "^3.11.1"
+        "symfony/cache": "^5.4 || ^6.3 || ^7.0",
+        "symfony/config": "^5.4 || ^6.3 || ^7.0",
+        "symfony/dependency-injection": "^5.4 || ^6.3 || ^7.0",
+        "symfony/event-dispatcher": "^5.4 || ^6.3 || ^7.0",
+        "symfony/http-kernel": "^5.4 || ^6.3 || ^7.0",
+        "gedmo/doctrine-extensions": "^3.13"
     },
     "require-dev": {
-        "symfony/mime": "^5.4 || ^6.2",
-        "phpunit/phpunit": "^10.2",
-        "symfony/security-core": "^5.4 || ^6.2"
+        "symfony/mime": "^5.4 || ^6.3 || ^7.0",
+        "phpunit/phpunit": "^10.4",
+        "symfony/security-core": "^5.4 || ^6.3 || ^7.0"
     },
     "suggest": {
         "doctrine/doctrine-bundle": "to use the ORM extensions",

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -38,9 +38,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->booleanNode('translation_fallback')->defaultFalse()->end()
                 ->booleanNode('persist_default_translation')->defaultFalse()->end()
                 ->booleanNode('skip_translation_on_load')->defaultFalse()->end()
-                ->scalarNode('metadata_cache_pool')
-                    ->defaultValue('stof_doctrine_extensions.cache.pool.array')
-                ->end()
+                ->scalarNode('metadata_cache_pool')->defaultNull()->end()
             ->end()
         ;
 
@@ -62,6 +60,7 @@ private function getVendorNode(string $name): ArrayNodeDefinition
                     ->scalarNode('sluggable')->defaultFalse()->end()
                     ->scalarNode('tree')->defaultFalse()->end()
                     ->scalarNode('loggable')->defaultFalse()->end()
+                    ->scalarNode('ip_traceable')->defaultFalse()->end()
                     ->scalarNode('sortable')->defaultFalse()->end()
                     ->scalarNode('softdeleteable')->defaultFalse()->end()
                     ->scalarNode('uploadable')->defaultFalse()->end()

diff --git a/src/DependencyInjection/StofDoctrineExtensionsExtension.php b/src/DependencyInjection/StofDoctrineExtensionsExtension.php
@@ -5,13 +5,82 @@
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
+use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class StofDoctrineExtensionsExtension extends Extension
 {
+    private const LISTENER_EVENTS = [
+        'blameable' => [
+            'prePersist',
+            'onFlush',
+            'loadClassMetadata',
+        ],
+        'ip_traceable' => [
+            'prePersist',
+            'onFlush',
+            'loadClassMetadata',
+        ],
+        'loggable' => [
+            'loadClassMetadata',
+            'onFlush',
+            'postPersist',
+        ],
+        'reference_integrity' => [
+            'loadClassMetadata',
+            'preRemove',
+        ],
+        'sluggable' => [
+            'prePersist',
+            'onFlush',
+            'loadClassMetadata',
+        ],
+        'softdeleteable' => [
+            'loadClassMetadata',
+            'onFlush',
+        ],
+        'sortable' => [
+            'onFlush',
+            'loadClassMetadata',
+            'prePersist',
+            'postPersist',
+            'preUpdate',
+            'postRemove',
+            'postFlush',
+        ],
+        'timestampable' => [
+            'prePersist',
+            'onFlush',
+            'loadClassMetadata',
+        ],
+        'translatable' => [
+            'postLoad',
+            'postPersist',
+            'preFlush',
+            'onFlush',
+            'loadClassMetadata',
+        ],
+        'tree' => [
+            'prePersist',
+            'preRemove',
+            'preUpdate',
+            'onFlush',
+            'loadClassMetadata',
+            'postPersist',
+            'postUpdate',
+            'postRemove',
+        ],
+        'uploadable' => [
+            'loadClassMetadata',
+            'preFlush',
+            'onFlush',
+            'postFlush',
+        ],
+    ];
+
     private array $entityManagers   = [];
     private array $documentManagers = [];
 
@@ -29,8 +98,8 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $loaded = [];
 
-        $this->entityManagers = $this->processObjectManagerConfigurations($config['orm'], $container, $loader, $loaded, 'doctrine.event_subscriber');
-        $this->documentManagers = $this->processObjectManagerConfigurations($config['mongodb'], $container, $loader, $loaded, 'doctrine_mongodb.odm.event_subscriber');
+        $this->entityManagers = $this->processObjectManagerConfigurations($config['orm'], $container, $loader, $loaded, 'doctrine.event_listener');
+        $this->documentManagers = $this->processObjectManagerConfigurations($config['mongodb'], $container, $loader, $loaded, 'doctrine_mongodb.odm.event_listener');
 
         $container->setParameter('stof_doctrine_extensions.default_locale', $config['default_locale']);
         $container->setParameter('stof_doctrine_extensions.translation_fallback', $config['translation_fallback']);
@@ -67,11 +136,15 @@ public function load(array $configs, ContainerBuilder $container): void
             }
         }
 
+        if (isset($config['metadata_cache_pool'])) {
+            $container->setAlias('stof_doctrine_extensions.metadata_cache', new Alias($config['metadata_cache_pool'], false));
+        } else {
+            $container->register('stof_doctrine_extensions.metadata_cache', ArrayAdapter::class)->setPublic(false);
+        }
+
         foreach ($config['class'] as $listener => $class) {
             $container->setParameter(sprintf('stof_doctrine_extensions.listener.%s.class', $listener), $class);
         }
-
-        $this->configureCache($container, $config);
     }
 
     /**
@@ -93,16 +166,16 @@ public function configValidate(ContainerBuilder $container): void
     }
 
     /**
-     * @param array $configs
+     * @param array            $configs
      * @param ContainerBuilder $container
-     * @param LoaderInterface $loader
-     * @param array $loaded
-     * @param string $doctrineSubscriberTag
+     * @param LoaderInterface  $loader
+     * @param array            $loaded
+     * @param string           $doctrineListenerTag
      *
      * @return array
      * @throws \Exception
      */
-    private function processObjectManagerConfigurations(array $configs, ContainerBuilder $container, LoaderInterface $loader, array &$loaded, string $doctrineSubscriberTag): array
+    private function processObjectManagerConfigurations(array $configs, ContainerBuilder $container, LoaderInterface $loader, array &$loaded, string $doctrineListenerTag)
     {
         $usedManagers = [];
 
@@ -130,21 +203,16 @@ private function processObjectManagerConfigurations(array $configs, ContainerBui
                 }
 
                 $definition = $container->getDefinition(sprintf('stof_doctrine_extensions.listener.%s', $ext));
-                $definition->addTag($doctrineSubscriberTag, $attributes);
+
+                foreach (self::LISTENER_EVENTS[$ext] as $event) {
+                    $attributes['event'] = $event;
+                    $definition->addTag($doctrineListenerTag, $attributes);
+                }
 
                 $usedManagers[$name] = true;
             }
         }
 
         return array_keys($usedManagers);
     }
-
-
-    private function configureCache(ContainerBuilder $container, array $config): void
-    {
-        $container
-            ->register('stof_doctrine_extensions.cache.pool.array', ArrayAdapter::class);
-
-        $container->setAlias('stof_doctrine_extensions.cache.pool.default', $config['metadata_cache_pool']);
-    }
 }
diff --git a/src/EventListener/IpTraceListener.php b/src/EventListener/IpTraceListener.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Stof\DoctrineExtensionsBundle\EventListener;
+
+use Gedmo\IpTraceable\IpTraceableListener;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * @internal
+ */
+final class IpTraceListener implements EventSubscriberInterface
+{
+    public function __construct(private readonly IpTraceableListener $ipTraceableListener)
+    {}
+
+    public function onKernelRequest(RequestEvent $event): void
+    {
+        if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
+            return;
+        }
+
+        $ip = $event->getRequest()->getClientIp();
+
+        if (null !== $ip) {
+            $this->ipTraceableListener->setIpValue($ip);
+        }
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::REQUEST => ['onKernelRequest', 500],
+        ];
+    }
+}
diff --git a/src/Resources/config/blameable.php b/src/Resources/config/blameable.php
@@ -15,7 +15,8 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.blameable', '%stof_doctrine_extensions.listener.blameable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
 
         ->set('stof_doctrine_extensions.event_listener.blame', '%stof_doctrine_extensions.event_listener.blame.class%')
             ->tag('kernel.event_subscriber')

diff --git a/src/Resources/config/ip_traceable.php b/src/Resources/config/ip_traceable.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Gedmo\IpTraceable\IpTraceableListener;
+use Stof\DoctrineExtensionsBundle\EventListener\IpTraceListener;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+
+    $containerConfigurator->services()
+        ->set('stof_doctrine_extensions.listener.ip_traceable', IpTraceableListener::class)
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
+
+        ->set('stof_doctrine_extensions.event_listener.ip_trace', IpTraceListener::class)
+            ->tag('kernel.event_subscriber')
+            ->args([
+                new ReferenceConfigurator('stof_doctrine_extensions.listener.ip_traceable'),
+            ])
+    ;
+};
diff --git a/src/Resources/config/loggable.php b/src/Resources/config/loggable.php
@@ -15,7 +15,8 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.loggable', '%stof_doctrine_extensions.listener.loggable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
 
         ->set('stof_doctrine_extensions.event_listener.logger', '%stof_doctrine_extensions.event_listener.logger.class%')
             ->tag('kernel.event_subscriber')

diff --git a/src/Resources/config/reference_integrity.php b/src/Resources/config/reference_integrity.php
@@ -15,6 +15,7 @@
 
     $services
         ->set('stof_doctrine_extensions.listener.reference_integrity', '%stof_doctrine_extensions.listener.reference_integrity.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
     ;
 };
diff --git a/src/Resources/config/sluggable.php b/src/Resources/config/sluggable.php
@@ -13,6 +13,7 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.sluggable', '%stof_doctrine_extensions.listener.sluggable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
     ;
 };
diff --git a/src/Resources/config/softdeleteable.php b/src/Resources/config/softdeleteable.php
@@ -13,5 +13,6 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.softdeleteable', '%stof_doctrine_extensions.listener.softdeleteable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')]);
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()]);
 };
diff --git a/src/Resources/config/sortable.php b/src/Resources/config/sortable.php
@@ -13,6 +13,7 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.sortable', '%stof_doctrine_extensions.listener.sortable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
     ;
 };
diff --git a/src/Resources/config/timestampable.php b/src/Resources/config/timestampable.php
@@ -13,6 +13,7 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.timestampable', '%stof_doctrine_extensions.listener.timestampable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
     ;
 };
diff --git a/src/Resources/config/translatable.php b/src/Resources/config/translatable.php
@@ -15,7 +15,8 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.translatable', '%stof_doctrine_extensions.listener.translatable.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
             ->call('setDefaultLocale', ['%stof_doctrine_extensions.default_locale%'])
             ->call('setTranslatableLocale', ['%stof_doctrine_extensions.default_locale%'])
             ->call('setTranslationFallback', ['%stof_doctrine_extensions.translation_fallback%'])

diff --git a/src/Resources/config/tree.php b/src/Resources/config/tree.php
@@ -13,6 +13,7 @@
 
     $containerConfigurator->services()
         ->set('stof_doctrine_extensions.listener.tree', '%stof_doctrine_extensions.listener.tree.class%')
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
     ;
 };
diff --git a/src/Resources/config/uploadable.php b/src/Resources/config/uploadable.php
@@ -23,9 +23,9 @@
             ->args([
                 new ReferenceConfigurator('stof_doctrine_extensions.uploadable.mime_type_guesser'),
             ])
-            ->call('setAnnotationReader', [new ReferenceConfigurator('annotation_reader')])
+            ->call('setCacheItemPool', [new ReferenceConfigurator('stof_doctrine_extensions.metadata_cache')])
+            ->call('setAnnotationReader', [(new ReferenceConfigurator('annotation_reader'))->ignoreOnInvalid()])
             ->call('setDefaultFileInfoClass', ['%stof_doctrine_extensions.uploadable.default_file_info.class%'])
-            ->factory([new ReferenceConfigurator('stof_doctrine_extensions.uploadable.configurator'), 'configure'])
 
         ->set('stof_doctrine_extensions.uploadable.mime_type_guesser', '%stof_doctrine_extensions.uploadable.mime_type_guesser.class%')