store_username_in_server_variable option added

Stores username of logged user in $_SERVER['SYMFONY_USERNAME'] - helps you to find out which user encountered the error

Author: Jirka Koutny

DependencyInjection/Configuration.php

@@ -28,6 +28,9 @@ public function getConfigTreeBuilder()
                 ->scalarNode('exceptions_directory')
                     ->defaultNull()
                 ->end()
+                ->scalarNode('store_username_in_server_variable')
+                    ->defaultNull()
+                ->end()
             ->end();
 
         return $treeBuilder;

DependencyInjection/KutnyTracyExtension.php

@@ -21,8 +21,16 @@ public function load(array $configs, ContainerBuilder $container)
             $dir = $container->getParameter('kernel.logs_dir') . '/exceptions';
         }
 
+        $storeUsernameInServerVariable = $config['store_username_in_server_variable'];
+
+        if (null === $storeUsernameInServerVariable)
+        {
+            $storeUsernameInServerVariable = false;
+        }
+
         $container->setParameter('kutny_tracy.exceptions_directory', $dir);
         $container->setParameter('kutny_tracy.emails', $config['emails']);
+        $container->setParameter('kutny_tracy.store_username_in_server_variable', $storeUsernameInServerVariable);
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');

KernelExceptionListener.php

@@ -8,16 +8,30 @@
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\Security\Core\SecurityContext;
 use Tracy\Debugger;
 
 class KernelExceptionListener
 {
+    private $storeUsernameInServerVariable;
+    private $securityContext;
+
+    public function __construct($storeUsernameInServerVariable, SecurityContext $securityContext)
+    {
+        $this->storeUsernameInServerVariable = $storeUsernameInServerVariable;
+        $this->securityContext = $securityContext;
+    }
 
     public function onKernelException(GetResponseForExceptionEvent $event)
     {
         $exception = $event->getException();
 
         if (!$this->isNotFoundException($exception) && !$this->isAccessDeniedHttpException($exception)) {
+            if ($this->storeUsernameInServerVariable)
+            {
+                $this->storeUsernameInServerVariable();
+            }
+
             ob_start();
             Debugger::exceptionHandler($exception, true);
             $event->setResponse(new Response(ob_get_contents()));
@@ -41,4 +55,13 @@ private function isAccessDeniedHttpException(Exception $exception)
     {
         return $exception instanceOf AccessDeniedHttpException;
     }
+
+    private function storeUsernameInServerVariable()
+    {
+        $token = $this->securityContext->getToken();
+
+        if ($token) {
+            $_SERVER['SYMFONY_USERNAME'] = $token->getUsername();
+        }
+    }
 }

README.md

@@ -70,6 +70,7 @@ I also recommend you to enable Tracy in a strict mode so it can handle errors of
 kutny_tracy:
     emails: ['[email protected]'] # error notification recipients
     exceptions_directory: <directory> # optional, default directory set to %kernel.logs_dir%/exceptions
+    store_username_in_server_variable: true|false # optional, default value = false; stores username of logged user in $_SERVER['SYMFONY_USERNAME'] - helps you to find out which user encountered the error
 
 ~~~~~
 

Resources/config/services.xml

@@ -6,6 +6,8 @@
 
     <services>
         <service id="kutny_tracy_kernel_exception_listener" class="Kutny\TracyBundle\KernelExceptionListener">
+            <argument>%kutny_tracy.store_username_in_server_variable%</argument>
+            <argument type="service" id="security.context" />
             <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException"/>
             <tag name="kernel.event_listener" event="console.exception" method="onConsoleException"/>
         </service>