Toggle variable dumping

Author: Slamdunk

lib/ErrorHandler.php

@@ -14,6 +14,7 @@ final class ErrorHandler
     private $errorOutputStream;
     private $hasColorSupport = false;
     private $logErrors;
+    private $logVariables = true;
     private $emailCallback;
 
     private static $colors = array(
@@ -123,6 +124,16 @@ public function logErrors() : bool
         return $this->logErrors;
     }
 
+    public function setLogVariables(bool $logVariables)
+    {
+        $this->logVariables = $logVariables;
+    }
+
+    public function logVariables() : bool
+    {
+        return $this->logVariables;
+    }
+
     public function register()
     {
         set_error_handler(array($this, 'errorHandler'), error_reporting());
@@ -301,18 +312,21 @@ public function emailException(\Throwable $exception)
             $bodyText .= 'Stack trace:' . "\n\n" . $this->purgeTrace($currentEx->getTraceAsString()) . "\n\n";
         } while ($currentEx = $currentEx->getPrevious());
 
-        if (isset($_POST) and ! empty($_POST)) {
-            $bodyText .= '$_POST = ' . print_r($_POST, true) . PHP_EOL;
-        }
         $username = null;
-        if (isset($_SESSION) and ! empty($_SESSION)) {
-            $sessionText = print_r(class_exists(DoctrineDebug::class) ? DoctrineDebug::export($_SESSION, 4) : $_SESSION, true);
-            $bodyText .= '$_SESSION = ' . $sessionText . PHP_EOL;
-
-            $count = 0;
-            $username = preg_replace('/.+\[([^\]]+)?username([^\]]+)?\] => ([\w\-\.]+).+/s', '\3', $sessionText, -1, $count);
-            if (! isset($username[0]) or isset($username[255]) or $count !== 1) {
-                $username = null;
+
+        if ($this->logVariables()) {
+            if (isset($_POST) and ! empty($_POST)) {
+                $bodyText .= '$_POST = ' . print_r($_POST, true) . PHP_EOL;
+            }
+            if (isset($_SESSION) and ! empty($_SESSION)) {
+                $sessionText = print_r(class_exists(DoctrineDebug::class) ? DoctrineDebug::export($_SESSION, 4) : $_SESSION, true);
+                $bodyText .= '$_SESSION = ' . $sessionText . PHP_EOL;
+
+                $count = 0;
+                $username = preg_replace('/.+\[([^\]]+)?username([^\]]+)?\] => ([\w\-\.]+).+/s', '\3', $sessionText, -1, $count);
+                if (! isset($username[0]) or isset($username[255]) or $count !== 1) {
+                    $username = null;
+                }
             }
         }
 

tests/ErrorHandlerTest.php

@@ -170,6 +170,30 @@ public function testEmailException()
         $this->assertContains($_POST[$key], $messageText);
     }
 
+    public function testCanHideVariablesFromEmail()
+    {
+        $this->assertTrue($this->errorHandler->logVariables());
+        $this->errorHandler->setLogVariables(false);
+        $this->assertFalse($this->errorHandler->logVariables());
+
+        $this->errorHandler->setLogErrors(true);
+
+        $key = uniqid(__FUNCTION__);
+        $_SESSION = array($key => uniqid());
+        $_POST = array($key => uniqid());
+
+        $this->errorHandler->emailException($this->exception);
+
+        $this->assertNotEmpty($this->emailsSent);
+        $message = current($this->emailsSent);
+        $this->assertNotEmpty($message);
+
+        $messageText = $message['body'];
+        $this->assertContains($this->exception->getMessage(), $messageText);
+        $this->assertNotContains($_SESSION[$key], $messageText);
+        $this->assertNotContains($_POST[$key], $messageText);
+    }
+
     public function testErroriNellInvioDellaMailVengonoComunqueLoggati()
     {
         $mailError = uniqid('mail_not_sent_');