Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ExceptionToTextProcessor.php « Processor « Monolog « plugins - github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 686fd926445da2dd44e5166bfc65c7d9da9c3df5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\Monolog\Processor;

use Piwik\Db;
use Piwik\ErrorHandler;
use Piwik\Exception\InvalidRequestParameterException;
use Piwik\Log;
use Piwik\Piwik;
use Piwik\SettingsPiwik;

/**
 * Process a log record containing an exception to generate a textual message.
 */
class ExceptionToTextProcessor
{
    public function __invoke(array $record)
    {
        if (! $this->contextContainsException($record)) {
            return $record;
        }

        /** @var \Exception $exception */
        $exception = $record['context']['exception'];

        if ($exception instanceof InvalidRequestParameterException) {
            return $record;
        }

        $exceptionStr = sprintf(
            "%s(%d): %s\n%s",
            $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
                || $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)
    {
        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)
    {
        return Log::$debugBacktraceForTests ?: self::getMessageAndWholeBacktrace($exception);
    }

    /**
     * @param \Exception|array $exception
     * @param bool|null $shouldPrintBacktrace
     * @return mixed|string
     */
    public static function getMessageAndWholeBacktrace($exception, $shouldPrintBacktrace = null)
    {
        if ($shouldPrintBacktrace === null) {
            $shouldPrintBacktrace = \Piwik_ShouldPrintBackTraceWithMessage();
        }

        if (is_array($exception)) {
            if ($shouldPrintBacktrace && isset($exception['backtrace'])) {
                $trace = $exception['backtrace'];
                $trace = self::replaceSensitiveValues($trace);
                return $trace;
            } else {
                return '';
            }
        }

        if (!$shouldPrintBacktrace) {
            return $exception->getMessage();
        }

        $message = "";

        $e = $exception;
        do {
            if ($e !== $exception) {
                $message .= ",\ncaused by: ";
            }

            $message .= $e->getMessage();
            if ($shouldPrintBacktrace) {
                $message .= "\n" . self::replaceSensitiveValues($e->getTraceAsString());
            }
        } while ($e = $e->getPrevious());

        return $message;
    }

    private static function replaceSensitiveValues($trace)
    {
        $dbConfig = Db::getDatabaseConfig();

        $valuesToReplace = [
            Piwik::getCurrentUserTokenAuth() => 'tokenauth',
            SettingsPiwik::getSalt() => 'generalSalt',
            $dbConfig['username'] => 'dbuser',
            $dbConfig['password'] => 'dbpass',
        ];

        return str_replace(array_keys($valuesToReplace), array_values($valuesToReplace), $trace);
    }
}