ExceptionLogger::write() - Code Metrics - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

ExceptionLogger::write() F
last analyzed 2020-10-20 13:08 UTC

↳ Parent: ExceptionLogger

Complexity

Conditions	15
Paths	3456

Size

Total Lines	55
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	15
eloc	30
nc	3456
nop	2
dl	0
loc	55
rs	1.7499
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace Saito\Exception\Logger;

use Cake\Log\Log;
use Cake\Routing\Router;
use Saito\User\CurrentUser\CurrentUserInterface;

class ExceptionLogger
{

    private $__lines = [];

    /**
     * Write
     *
     * @param string $message message
     * @param array $data data
     * - `msgs` array with additional message-lines
     * @return void
     * @throws \InvalidArgumentException
     */
    public function write($message, $data = null)
    {
        //# process message(s)
        $msgs = [$message];
        if (isset($data['msgs'])) {
            $msgs = array_merge($msgs, $data['msgs']);
        }
        // prepend main message in front of metadata added by subclasses
        foreach (array_reverse($msgs) as $key => $msg) {
            $this->_add($msg, $key, true);
        }

        //# add exception data
        if (isset($data['e'])) {
            /* @var $Exception \Exception */
            $Exception = $data['e'];
            unset($data['e']);
            $message = $Exception->getMessage();
            if (!empty($message)) {
                $this->_add($message);
            }
        }

        //# add request data
        $request = (php_sapi_name() !== 'cli') ? Router::getRequest() : false;

        $url = false;
        if (isset($data['URL'])) {
            $url = $data['URL'];
        } elseif ($request) {
            $url = $request->getRequestTarget();
        }

        $requestMethod = $request ? $request->getMethod() : false;
        if ($url && $requestMethod) {
            $url .= ' ' . $requestMethod;
        }
        if ($url) {
            $this->_add($url, 'Request URL');
        }

        if (isset($_SERVER['HTTP_USER_AGENT'])) {
            $this->_add($_SERVER['HTTP_USER_AGENT'], 'User-Agent');
        }

        $this->_addUser($data);

        if ($request) {
            $data = $request->getData();
            if (!empty($data)) {
                $this->_add($this->_filterData($data), 'Data');
            }
        }

        $this->_write();
    }

    /**
     * adds data about current user to log entry
     *
     * @param mixed $data data
     * @return void
     *
     * @throws \InvalidArgumentException
     */
    protected function _addUser($data)
    {
        if (!isset($data['CurrentUser'])) {
            return;
        }
        if (!($data['CurrentUser'] instanceof CurrentUserInterface)) {
            throw new \InvalidArgumentException();
        }
        $CurrentUser = $data['CurrentUser'];
        if ($CurrentUser->isLoggedIn()) {
            $username = $CurrentUser->get('username');
            $userId = $CurrentUser->getId();
            $username = "{$username} (id: {$userId})";
        } else {
            $username = 'anonymous';
        }
        $this->_add($username, 'Current user');
    }

    /**
     * Filters request-data which should not be in server logs
     *
     * esp. cleartext passwords in $_POST data
     *
     * @param mixed $data data
     * @return array
     */
    protected function _filterData($data)
    {
        if (!is_array($data)) {
            return $data;
        }
        foreach ($data as $key => $datum) {
            if (is_array($datum)) {
                $data[$key] = $this->_filterData($datum);
                continue;
            }

            if (stripos($key, 'password') !== false) {
                $data[$key] = '***********';
            }
        }

        return $data;
    }

    /**
     * Write
     *
     * @return void
     */
    protected function _write()
    {
        Log::write('error', $this->_message(), ['scope' => ['saito.error']]);
    }

    /**
     * Message
     *
     * @return string
     */
    protected function _message()
    {
        $message = [];
        $i = 1;
        foreach ($this->__lines as $line) {
            $message[] = sprintf("  #%d %s", $i, $line);
            $i++;
        }

        return "\n" . implode("\n", $message);
    }

    /**
     * Add
     *
     * @param mixed $val value
     * @param mixed $key key
     * @param bool $prepend prepend
     * @return void
     */
    protected function _add($val, $key = null, $prepend = false)
    {
        if (is_array($val)) {
            $val = print_r($this->_filterData($val), true);
        }
        if (is_string($key)) {
            $val = "$key: $val";
        }

        if ($prepend) {
            array_unshift($this->__lines, $val);
        } else {
            $this->__lines[] = $val;
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Saito - The Threaded Web Forum
7			*
8			* @copyright Copyright (c) the Saito Project Developers
9			* @link https://github.com/Schlaefer/Saito
10			* @license http://opensource.org/licenses/MIT
11			*/
12
13			namespace Saito\Exception\Logger;
14
15			use Cake\Log\Log;
16			use Cake\Routing\Router;
17			use Saito\User\CurrentUser\CurrentUserInterface;
18
19			class ExceptionLogger
20			{
21
22			private $__lines = [];
23
24			/**
25			* Write
26			*
27			* @param string $message message
28			* @param array $data data
29			* - `msgs` array with additional message-lines
30			* @return void
31			* @throws \InvalidArgumentException
32			*/
33			public function write($message, $data = null)
34			{
35			//# process message(s)
36			$msgs = [$message];
37			if (isset($data['msgs'])) {
38			$msgs = array_merge($msgs, $data['msgs']);
39			}
40			// prepend main message in front of metadata added by subclasses
41			foreach (array_reverse($msgs) as $key => $msg) {
42			$this->_add($msg, $key, true);
43			}
44
45			//# add exception data
46			if (isset($data['e'])) {
47			/* @var $Exception \Exception */
48			$Exception = $data['e'];
49			unset($data['e']);
50			$message = $Exception->getMessage();
51			if (!empty($message)) {
52			$this->_add($message);
53			}
54			}
55
56			//# add request data
57			$request = (php_sapi_name() !== 'cli') ? Router::getRequest() : false;
58
59			$url = false;
60			if (isset($data['URL'])) {
61			$url = $data['URL'];
62			} elseif ($request) {
63			$url = $request->getRequestTarget();
64			}
65
66			$requestMethod = $request ? $request->getMethod() : false;
67			if ($url && $requestMethod) {
68			$url .= ' ' . $requestMethod;
69			}
70			if ($url) {
71			$this->_add($url, 'Request URL');
72			}
73
74			if (isset($_SERVER['HTTP_USER_AGENT'])) {
75			$this->_add($_SERVER['HTTP_USER_AGENT'], 'User-Agent');
76			}
77
78			$this->_addUser($data);
79
80			if ($request) {
81			$data = $request->getData();
82			if (!empty($data)) {
83			$this->_add($this->_filterData($data), 'Data');
84			}
85			}
86
87			$this->_write();
88			}
89
90			/**
91			* adds data about current user to log entry
92			*
93			* @param mixed $data data
94			* @return void
95			*
96			* @throws \InvalidArgumentException
97			*/
98			protected function _addUser($data)
99			{
100			if (!isset($data['CurrentUser'])) {
101			return;
102			}
103			if (!($data['CurrentUser'] instanceof CurrentUserInterface)) {
104			throw new \InvalidArgumentException();
105			}
106			$CurrentUser = $data['CurrentUser'];
107			if ($CurrentUser->isLoggedIn()) {
108			$username = $CurrentUser->get('username');
109			$userId = $CurrentUser->getId();
110			$username = "{$username} (id: {$userId})";
111			} else {
112			$username = 'anonymous';
113			}
114			$this->_add($username, 'Current user');
115			}
116
117			/**
118			* Filters request-data which should not be in server logs
119			*
120			* esp. cleartext passwords in $_POST data
121			*
122			* @param mixed $data data
123			* @return array
124			*/
125			protected function _filterData($data)
126			{
127			if (!is_array($data)) {
128			return $data;
129			}
130			foreach ($data as $key => $datum) {
131			if (is_array($datum)) {
132			$data[$key] = $this->_filterData($datum);
133			continue;
134			}
135
136			if (stripos($key, 'password') !== false) {
137			$data[$key] = '***********';
138			}
139			}
140
141			return $data;
142			}
143
144			/**
145			* Write
146			*
147			* @return void
148			*/
149			protected function _write()
150			{
151			Log::write('error', $this->_message(), ['scope' => ['saito.error']]);
152			}
153
154			/**
155			* Message
156			*
157			* @return string
158			*/
159			protected function _message()
160			{
161			$message = [];
162			$i = 1;
163			foreach ($this->__lines as $line) {
164			$message[] = sprintf(" #%d %s", $i, $line);
165			$i++;
166			}
167
168			return "\n" . implode("\n", $message);
169			}
170
171			/**
172			* Add
173			*
174			* @param mixed $val value
175			* @param mixed $key key
176			* @param bool $prepend prepend
177			* @return void
178			*/
179			protected function _add($val, $key = null, $prepend = false)
180			{
181			if (is_array($val)) {
182			$val = print_r($this->_filterData($val), true);
183			}
184			if (is_string($key)) {
185			$val = "$key: $val";
186			}
187
188			if ($prepend) {
189			array_unshift($this->__lines, $val);
190			} else {
191			$this->__lines[] = $val;
192			}
193			}
194			}
195

Schlaefer / Saito

ExceptionLogger::write() F last analyzed 2020-10-20 13:08 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

ExceptionLogger::write() F
last analyzed 2020-10-20 13:08 UTC