[HttpKernel] Added a way to configure an expression in order to disable HTMLDumper

lyrixx · lyrixx · commit 33c12dd31aac · 2015-03-17T14:36:19.000+01:00
diff --git a/src/Symfony/Bundle/DebugBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/DebugBundle/DependencyInjection/Configuration.php
@@ -41,6 +41,11 @@ public function getConfigTreeBuilder()
                     ->min(-1)
                     ->defaultValue(-1)
                 ->end()
+                ->scalarNode('disable_html_for')
+                    ->info('Disable HTMLdumper in favor of CliDumper based on an expression')
+                    ->example("0 === strpos(request.headers.get('user-agent'), 'curl/')")
+                    ->defaultNull()
+                ->end()
             ->end()
         ;
 
diff --git a/src/Symfony/Bundle/DebugBundle/DependencyInjection/DebugExtension.php b/src/Symfony/Bundle/DebugBundle/DependencyInjection/DebugExtension.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
@@ -37,6 +38,13 @@ public function load(array $configs, ContainerBuilder $container)
         $container->getDefinition('var_dumper.cloner')
             ->addMethodCall('setMaxItems',  array($config['max_items']))
             ->addMethodCall('setMaxString', array($config['max_string_length']));
+
+        if ($config['disable_html_for']) {
+            $container->getDefinition('debug.dump_listener')
+                ->replaceArgument(2, new Definition('Symfony\Bundle\DebugBundle\ExpressionLanguage'))
+                ->replaceArgument(3, $config['disable_html_for'])
+            ;
+        }
     }
 
     /**
diff --git a/src/Symfony/Bundle/DebugBundle/ExpressionLanguage.php b/src/Symfony/Bundle/DebugBundle/ExpressionLanguage.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\DebugBundle;
+
+use Symfony\Component\Security\Core\Authorization\ExpressionLanguage as BaseExpressionLanguage;
+
+/**
+ * Adds some functions to the default Symfony Debug ExpressionLanguage.
+ *
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+class ExpressionLanguage extends BaseExpressionLanguage
+{
+    protected function registerFunctions()
+    {
+        parent::registerFunctions();
+        $this->register('strpos', function ($haystack, $needle) {
+            return sprintf('strpos(%s, %s)', $haystack, $needle);
+        }, function (array $variables, $haystack, $needle) {
+            return strpos($haystack, $needle);
+        });
+    }
+}
diff --git a/src/Symfony/Bundle/DebugBundle/Resources/config/services.xml b/src/Symfony/Bundle/DebugBundle/Resources/config/services.xml
@@ -21,6 +21,8 @@
             <tag name="kernel.event_subscriber" />
             <argument type="service" id="var_dumper.cloner" />
             <argument type="service" id="data_collector.dump" />
+            <argument>null</argument><!-- Expression language -->
+            <argument>null</argument><!-- Expression -->
         </service>
 
         <service id="var_dumper.cloner" class="Symfony\Component\VarDumper\Cloner\VarCloner" />
diff --git a/src/Symfony/Component/HttpKernel/EventListener/DumpListener.php b/src/Symfony/Component/HttpKernel/EventListener/DumpListener.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\HttpKernel\EventListener;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+use Symfony\Component\ExpressionLanguage\SyntaxError;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\VarDumper\Cloner\ClonerInterface;
@@ -28,21 +30,36 @@ class DumpListener implements EventSubscriberInterface
 {
     private $cloner;
     private $dumper;
+    private $expressionLanguage;
+    private $expression;
 
     /**
-     * @param ClonerInterface     $cloner Cloner service.
-     * @param DataDumperInterface $dumper Dumper service.
+     * @param ClonerInterface         $cloner             Cloner service.
+     * @param DataDumperInterface     $dumper             Dumper service.
+     * @param ExpressionLanguage|null $expressionLanguage Expression Language service.
+     * @param string|null             $expression         The expression.
      */
-    public function __construct(ClonerInterface $cloner, DataDumperInterface $dumper)
+    public function __construct(ClonerInterface $cloner, DataDumperInterface $dumper, ExpressionLanguage $expressionLanguage = null, $expression = null)
     {
+        if (null !== $expression && null === $expressionLanguage) {
+            throw new \RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
+        }
+
         $this->cloner = $cloner;
         $this->dumper = $dumper;
+        $this->expressionLanguage = $expressionLanguage;
+        $this->expression = $expression;
     }
 
     public function configure(GetResponseEvent $event)
     {
-        // if the request is issued by curl, we do not enable HTML dumper;
-        if (0 === strpos($event->getRequest()->headers->get('user-agent'), 'curl/')) {
+        try {
+            $result = $this->expressionLanguage->evaluate($this->expression, array('request' => $event->getRequest()));
+        } catch (SyntaxError $e) {
+            throw new \LogicException(sprintf('The expression "%s" to configure the DumpListener is not valid.', $this->expression), 0, $e);
+        }
+
+        if (isset($result) && $result) {
             CliDumper::$defaultColors = true;
             CliDumper::$defaultOutput = 'php://output';
 
