Enable fingers crossed handler via INI config and show backtrace in logs/archive api output (#13923)

* Add config to use FringersCrossedHandler (untested)

* Get to work in different contexts.

* Add changelog note.

* Make sure more exceptions make it to the logs, make backtrace include previous exceptions, do not use screen writer if in cli mode, always print backtrace if in CLI mode and archivephp triggered.

* Add log capturing handler.

* Remove options from global.ini.php sibnce they may be temporary.

* Add UI test triggering an error w/ the screen handler.

* Add some more log statements, ignore logs in screen writer, replace part of message in ExceptionToTextProcessor instead of whole message.

* Add missing license.

* Update changelog, move new item to 3.9

* Fixing some integration tests.

* Fix another unit test.

* One more test fix.

* Try to get rid of xss testing warning.

* Try again to get rid of warning.

* Try again to get rid of warning.

* Try again to get rid of warning.

4 files changed, 131 insertions, 9 deletions

diff --git a/plugins/Monolog/Handler/LogCaptureHandler.php b/plugins/Monolog/Handler/LogCaptureHandler.php
new file mode 100644
index 0000000000..fbe4acad29
--- /dev/null
+++ b/plugins/Monolog/Handler/LogCaptureHandler.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\Monolog\Handler;
+
+use Monolog\Handler\AbstractHandler;
+
+class LogCaptureHandler extends AbstractHandler
+{
+    /**
+     * @var array
+     */
+    private $allLogs;
+
+    public function handle(array $record)
+    {
+        $this->allLogs[] = $record;
+    }
+
+    /**
+     * Returns all records. The records should be processed, so one could just use $record['message'].
+     *
+     * @return array[]
+     */
+    public function getAllRecords()
+    {
+        return $this->allLogs;
+    }
+}
\ No newline at end of file
diff --git a/plugins/Monolog/Handler/WebNotificationHandler.php b/plugins/Monolog/Handler/WebNotificationHandler.php
index 5f0de1bb8c..9ff76958aa 100644
--- a/plugins/Monolog/Handler/WebNotificationHandler.php
+++ b/plugins/Monolog/Handler/WebNotificationHandler.php
@@ -20,6 +20,15 @@ use Zend_Session_Exception;
  */
 class WebNotificationHandler extends AbstractProcessingHandler
 {
+    public function isHandling(array $record)
+    {
+        if (!empty($record['context']['ignoreInScreenWriter'])) {
+            return false;
+        }
+
+        return parent::isHandling($record);
+    }
+
     protected function write(array $record)
     {
         switch ($record['level']) {
diff --git a/plugins/Monolog/Processor/ExceptionToTextProcessor.php b/plugins/Monolog/Processor/ExceptionToTextProcessor.php
index daaaee479e..0a947a9f23 100644
--- a/plugins/Monolog/Processor/ExceptionToTextProcessor.php
+++ b/plugins/Monolog/Processor/ExceptionToTextProcessor.php
@@ -25,34 +25,75 @@ class ExceptionToTextProcessor
         /** @var \Exception $exception */
         $exception = $record['context']['exception'];
 
-        $record['message'] = sprintf(
+        $exceptionStr = sprintf(
             "%s(%d): %s\n%s",
-            $exception->getFile(),
-            $exception->getLine(),
+            $exception instanceof \Exception ? $exception->getFile() : $exception['file'],
+            $exception instanceof \Exception ? $exception->getLine() : $exception['line'],
             $this->getMessage($exception),
             $this->getStackTrace($exception)
         );
 
+        if (!isset($record['message'])
+            || strpos($record['message'], '{exception}') === false
+        ) {
+            $record['message'] = $exceptionStr;
+        } else {
+            $record['message'] = str_replace('{exception}', $exceptionStr, $record['message']);
+        }
+
         return $record;
     }
 
     private function contextContainsException($record)
     {
         return isset($record['context']['exception'])
-            && $record['context']['exception'] instanceof \Exception;
+            && ($record['context']['exception'] instanceof \Exception
+                || $this->isLooksLikeFatalErrorArray($record['context']['exception']));
+    }
+
+    private function isLooksLikeFatalErrorArray($exception)
+    {
+        return is_array($exception) && isset($exception['message']) && isset($exception['file']) && isset($exception['line']);
     }
 
-    private function getMessage(\Exception $exception)
+    private function getMessage($exception)
     {
         if ($exception instanceof \ErrorException) {
             return ErrorHandler::getErrNoString($exception->getSeverity()) . ' - ' . $exception->getMessage();
         }
 
+        if (is_array($exception) && isset($exception['message'])) {
+            return $exception['message'];
+        }
+
         return $exception->getMessage();
     }
 
-    private function getStackTrace(\Exception $exception)
+    private function getStackTrace($exception)
     {
-        return Log::$debugBacktraceForTests ?: $exception->getTraceAsString();
+        if (is_array($exception) && isset($exception['backtrace'])) {
+            return $exception['backtrace'];
+        }
+
+        return Log::$debugBacktraceForTests ?: self::getWholeBacktrace($exception);
+    }
+
+    public static function getWholeBacktrace(\Exception $exception, $shouldPrintBacktrace = true)
+    {
+        $message = "";
+
+        $e = $exception;
+        do {
+            if ($e !== $exception) {
+                $message .= ",\ncaused by: ";
+            }
+
+            $message .= $e->getMessage();
+            if ($shouldPrintBacktrace) {
+                $message .= "\n" . $e->getTraceAsString();
+            }
+        } while ($e = $e->getPrevious());
+
+        return $message;
     }
 }
diff --git a/plugins/Monolog/config/config.php b/plugins/Monolog/config/config.php
index 19e7752479..b9e9e0c62f 100644
--- a/plugins/Monolog/config/config.php
+++ b/plugins/Monolog/config/config.php
@@ -4,6 +4,7 @@ use Interop\Container\ContainerInterface;
 use Monolog\Logger;
 use Piwik\Log;
 use Piwik\Plugins\Monolog\Handler\FileHandler;
+use Piwik\Plugins\Monolog\Handler\LogCaptureHandler;
 
 return array(
 
@@ -17,7 +18,7 @@ return array(
         'screen'   => 'Piwik\Plugins\Monolog\Handler\WebNotificationHandler',
         'database' => 'Piwik\Plugins\Monolog\Handler\DatabaseHandler',
     ),
-    'log.handlers' => DI\factory(function (ContainerInterface $c) {
+    'log.handlers' => DI\factory(function (\DI\Container $c) {
         if ($c->has('ini.log.log_writers')) {
             $writerNames = $c->get('ini.log.log_writers');
         } else {
@@ -26,13 +27,50 @@ return array(
 
         $classes = $c->get('log.handler.classes');
 
+        $logConfig = $c->get(\Piwik\Config::class)->log;
+        $enableFingersCrossed = isset($logConfig['enable_fingers_crossed_handler']) && $logConfig['enable_fingers_crossed_handler'] == 1;
+        $fingersCrossedStopBuffering = isset($logConfig['fingers_crossed_stop_buffering_on_activation']) && $logConfig['fingers_crossed_stop_buffering_on_activation'] == 1;
+        $enableLogCaptureHandler = isset($logConfig['enable_log_capture_handler']) && $logConfig['enable_log_capture_handler'] == 1;
+
+        $isLogBufferingAllowed = !\Piwik\Common::isPhpCliMode()
+            || \Piwik\SettingsServer::isArchivePhpTriggered()
+            || \Piwik\CliMulti::isCliMultiRequest();
+
         $writerNames = array_map('trim', $writerNames);
         $writers = array();
         foreach ($writerNames as $writerName) {
+            if ($writerName === 'screen' && \Piwik\Common::isPhpCliMode()) {
+                continue; // screen writer is only valid for web requests
+            }
+
             if (isset($classes[$writerName])) {
-                $writers[$writerName] = $c->get($classes[$writerName]);
+                // wrap the handler in FingersCrossedHandler if we can and this isn't the screen handler
+
+                /** @var \Monolog\Handler\HandlerInterface $handler */
+                $handler = $c->make($classes[$writerName]);
+                if ($enableFingersCrossed
+                    && $writerName !== 'screen'
+                    && $handler instanceof \Monolog\Handler\AbstractHandler
+                    && $isLogBufferingAllowed
+                ) {
+                    $passthruLevel = $handler->getLevel();
+
+                    $handler->setLevel(Logger::DEBUG);
+
+                    $handler = new \Monolog\Handler\FingersCrossedHandler($handler, $activationStrategy = null, $bufferSize = 0,
+                        $bubble = true, $fingersCrossedStopBuffering, $passthruLevel);
+                }
+
+                $writers[$writerName] = $handler;
             }
         }
+
+        if ($enableLogCaptureHandler
+            && $isLogBufferingAllowed
+        ) {
+            $writers[] = $c->get(LogCaptureHandler::class);
+        }
+
         return array_values($writers);
     }),