Merge pull request #500 from mbabker/actor-provider

Use the new actor provider interface

Author: stof

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.15.0"
+        "gedmo/doctrine-extensions": "^3.19.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^1.10",

src/DependencyInjection/StofDoctrineExtensionsExtension.php

@@ -100,6 +100,7 @@ public function load(array $configs, ContainerBuilder $container)
         $config = $processor->processConfiguration($configuration, $configs);
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('tool.xml');
 
         $loaded = array();
 

src/EventListener/BlameListener.php

@@ -14,6 +14,8 @@
  * Sets the username from the security context by listening on kernel.request
  *
  * @author David Buchmann <[email protected]>
+ *
+ * @deprecated to be removed in 2.0, use the actor provider instead
  */
 class BlameListener implements EventSubscriberInterface
 {

src/EventListener/LoggerListener.php

@@ -16,6 +16,8 @@
  *
  * @author Christophe Coevoet <[email protected]>
  *
+ * @deprecated to be removed in 2.0, use the actor provider instead
+ *
  * @phpstan-template T of Loggable|object
  */
 class LoggerListener implements EventSubscriberInterface

src/Resources/config/blameable.xml

@@ -16,13 +16,16 @@
             <call method="setAnnotationReader">
                 <argument type="service" id=".stof_doctrine_extensions.reader" on-invalid="ignore" />
             </call>
+            <call method="setActorProvider">
+                <argument type="service" id="stof_doctrine_extensions.tool.actor_provider" />
+            </call>
         </service>
 
         <service id="stof_doctrine_extensions.event_listener.blame" class="%stof_doctrine_extensions.event_listener.blame.class%">
+            <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.actor_provider" service should be used to provide the user instead.</deprecated>
             <argument type="service" id="stof_doctrine_extensions.listener.blameable" />
             <argument type="service" id="security.token_storage" on-invalid="null" />
             <argument type="service" id="security.authorization_checker" on-invalid="null" />
-            <tag name="kernel.event_subscriber" />
         </service>
     </services>
 </container>

src/Resources/config/loggable.xml

@@ -16,13 +16,16 @@
             <call method="setAnnotationReader">
                 <argument type="service" id=".stof_doctrine_extensions.reader" on-invalid="ignore" />
             </call>
+            <call method="setActorProvider">
+                <argument type="service" id="stof_doctrine_extensions.tool.actor_provider" />
+            </call>
         </service>
 
         <service id="stof_doctrine_extensions.event_listener.logger" class="%stof_doctrine_extensions.event_listener.logger.class%">
+            <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.actor_provider" service should be used to provide the user instead.</deprecated>
             <argument type="service" id="stof_doctrine_extensions.listener.loggable" />
             <argument type="service" id="security.token_storage" on-invalid="null" />
             <argument type="service" id="security.authorization_checker" on-invalid="null" />
-            <tag name="kernel.event_subscriber" />
         </service>
     </services>
 </container>

src/Resources/config/tool.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="stof_doctrine_extensions.tool.actor_provider" class="Stof\DoctrineExtensionsBundle\Tool\TokenStorageActorProvider" public="false">
+            <argument type="service" id="security.token_storage" on-invalid="null" />
+            <argument type="service" id="security.authorization_checker" on-invalid="null" />
+        </service>
+    </services>
+</container>

src/Tool/TokenStorageActorProvider.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Stof\DoctrineExtensionsBundle\Tool;
+
+use Gedmo\Tool\ActorProviderInterface;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+/**
+ * Provides an actor for the extensions using the token storage.
+ *
+ * @internal
+ */
+final class TokenStorageActorProvider implements ActorProviderInterface
+{
+    private ?TokenStorageInterface $tokenStorage;
+    private ?AuthorizationCheckerInterface $authorizationChecker;
+
+    public function __construct(?TokenStorageInterface $tokenStorage = null, ?AuthorizationCheckerInterface $authorizationChecker = null)
+    {
+        $this->tokenStorage = $tokenStorage;
+        $this->authorizationChecker = $authorizationChecker;
+    }
+
+    public function getActor(): ?UserInterface
+    {
+        if (null === $this->tokenStorage || null === $this->authorizationChecker) {
+            return null;
+        }
+
+        $token = $this->tokenStorage->getToken();
+
+        if (null === $token || !$this->authorizationChecker->isGranted('IS_AUTHENTICATED_REMEMBERED')) {
+            return null;
+        }
+
+        return $token->getUser();
+    }
+}