Console::log() - Code Metrics - Inspection of "v4.0.0 release" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ece31d...41b8a6 )

by Paul

created 2019-10-05 17:35 UTC

Console::log() A

↳ Parent: Console

Complexity

Conditions	3
Paths	4

Size

Total Lines	16
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	12
nc	4
nop	4
dl	0
loc	16
ccs	13
cts	13
cp	1
crap	3
rs	9.8666
c	1
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Modules;

use DateTime;
use GeminiLabs\SiteReviews\Helper;
use ReflectionClass;
use Throwable;

class Console
{
    const DEBUG = 0;      // Detailed debug information
    const INFO = 1;       // Interesting events
    const NOTICE = 2;     // Normal but significant events
    const WARNING = 4;    // Exceptional occurrences that are not errors
    const ERROR = 8;      // Runtime errors that do not require immediate action
    const CRITICAL = 16;  // Critical conditions
    const ALERT = 32;     // Action must be taken immediately
    const EMERGENCY = 64; // System is unusable

    protected $file;
    protected $log;
    protected $logOnceKey = 'glsr_log_once';

    public function __construct()
    {
        $this->file = glsr()->path('console.log');
        $this->log = file_exists($this->file)
            ? file_get_contents($this->file)
            : '';
        $this->reset();
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->get();
    }

    /**
     * Action must be taken immediately
     * Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function alert($message, array $context = [])
    {
        return $this->log(static::ALERT, $message, $context);
    }

    /**
     * @return void
     */
    public function clear()
    {
        $this->log = '';
        file_put_contents($this->file, $this->log);
    }

    /**
     * Critical conditions
     * Example: Application component unavailable, unexpected exception.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function critical($message, array $context = [])
    {
        return $this->log(static::CRITICAL, $message, $context);
    }

    /**
     * Detailed debug information.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function debug($message, array $context = [])
    {
        return $this->log(static::DEBUG, $message, $context);
    }

    /**
     * System is unusable.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function emergency($message, array $context = [])
    {
        return $this->log(static::EMERGENCY, $message, $context);
    }

    /**
     * Runtime errors that do not require immediate action but should typically be logged and monitored.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function error($message, array $context = [])
    {
        return $this->log(static::ERROR, $message, $context);
    }

    /**
     * @return string
     */
    public function get()
    {
        return empty($this->log)
            ? __('Console is empty', 'site-reviews')
            : $this->log;
    }

    /**
     * @return int
     */
    public function getLevel()
    {
        return intval(apply_filters('site-reviews/console/level', static::INFO));
    }

    /**
     * @return array
     */
    public function getLevels()
    {
        $constants = (new ReflectionClass(__CLASS__))->getConstants();
        return array_map('strtolower', array_flip($constants));
    }

    /**
     * @return string
     */
    public function humanLevel()
    {
        $level = $this->getLevel();
        return sprintf('%s (%d)', strtoupper(glsr_get($this->getLevels(), $level, 'unknown')), $level);
    }

    /**
     * @param string|null $valueIfEmpty
     * @return string
     */
    public function humanSize($valueIfEmpty = null)
    {
        $bytes = $this->size();
        if (empty($bytes) && is_string($valueIfEmpty)) {
            return $valueIfEmpty;
        }
        $exponent = floor(log(max($bytes, 1), 1024));
        return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent];
    }

    /**
     * Interesting events
     * Example: User logs in, SQL logs.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function info($message, array $context = [])
    {
        return $this->log(static::INFO, $message, $context);
    }

    /**
     * @param int $level
     * @param mixed $message
     * @param array $context
     * @param string $backtraceLine
     * @return static
     */
    public function log($level, $message, $context = [], $backtraceLine = '')
    {
        if (empty($backtraceLine)) {
            $backtraceLine = $this->getBacktraceLine();
        }
        if ($this->canLogEntry($level, $backtraceLine)) {
            $levelName = glsr_get($this->getLevels(), $level);
            $context = glsr(Helper::class)->consolidateArray($context);
            $backtraceLine = $this->normalizeBacktraceLine($backtraceLine);
            $message = $this->interpolate($message, $context);
            $entry = $this->buildLogEntry($levelName, $message, $backtraceLine);
            file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND | LOCK_EX);
            apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed
            $this->reset();
        }
        return $this;
    }

    /**
     * @return void
     */
    public function logOnce()
    {
        $once = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
        $levels = $this->getLevels();
        foreach ($once as $entry) {
            $levelName = glsr_get($entry, 'level');
            if (!in_array($levelName, $levels)) {
                continue;
            }
            $level = glsr_get(array_flip($levels), $levelName);
            $message = glsr_get($entry, 'message');
            $backtraceLine = glsr_get($entry, 'backtrace');
            $this->log($level, $message, [], $backtraceLine);
        }
        glsr()->{$this->logOnceKey} = [];
    }

    /**
     * Normal but significant events.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function notice($message, array $context = [])
    {
        return $this->log(static::NOTICE, $message, $context);
    }

    /**
     * @param string $levelName
     * @param string $handle
     * @param mixed $data
     * @return void
     */
    public function once($levelName, $handle, $data)
    {
        $once = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
        $filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
            return glsr_get($entry, 'level') == $levelName
                && glsr_get($entry, 'handle') == $handle;
        });
        if (!empty($filtered)) {
            return;
        }
        $once[] = [
            'backtrace' => $this->getBacktraceLineFromData($data),
            'handle' => $handle,
            'level' => $levelName,
            'message' => '[RECURRING] '.$this->getMessageFromData($data),
        ];
        glsr()->{$this->logOnceKey} = $once;
    }

    /**
     * @return int
     */
    public function size()
    {
        return file_exists($this->file)
            ? filesize($this->file)
            : 0;
    }

    /**
     * Exceptional occurrences that are not errors
     * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
     * @param mixed $message
     * @param array $context
     * @return static
     */
    public function warning($message, array $context = [])
    {
        return $this->log(static::WARNING, $message, $context);
    }

    /**
     * @param array $backtrace
     * @param int $index
     * @return string
     */
    protected function buildBacktraceLine($backtrace, $index)
    {
        return sprintf('%s:%s',
            glsr_get($backtrace, $index.'.file'), // realpath
            glsr_get($backtrace, $index.'.line')
        );
    }

    /**
     * @param string $levelName
     * @param mixed $message
     * @param string $backtraceLine
     * @return string
     */
    protected function buildLogEntry($levelName, $message, $backtraceLine = '')
    {
        return sprintf('[%s] %s [%s] %s',
            current_time('mysql'),
            strtoupper($levelName),
            $backtraceLine,
            $message
        );
    }

    /**
     * @param int $level
     * @return bool
     */
    protected function canLogEntry($level, $backtraceLine)
    {
        $levelExists = array_key_exists($level, $this->getLevels());
        if (false === strpos($backtraceLine, glsr()->path())) {
            return $levelExists; // ignore level restriction if triggered outside of the plugin
        }
        return $levelExists && $level >= $this->getLevel();
    }

    /**
     * @return void|string
     */
    protected function getBacktraceLine()
    {
        $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
        $search = array_search('log', glsr_array_column($backtrace, 'function'));
        if (false !== $search) {
            $index = '{closure}' == glsr_get($backtrace, ($search + 2).'.function')
                ? $search + 4
                : $search + 1;
            return $this->buildBacktraceLine($backtrace, $index);
        }
        return 'Unknown';
    }

    /**
     * @param mixed $data
     * @return string
     */
    protected function getBacktraceLineFromData($data)
    {
        $backtrace = $data instanceof Throwable
            ? $data->getTrace()
            : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
        return $this->buildBacktraceLine($backtrace, 0);
    }

    /**
     * @param mixed $data
     * @return string
     */
    protected function getMessageFromData($data)
    {
        return $data instanceof Throwable
            ? $this->normalizeThrowableMessage($data->getMessage())
            : print_r($data, 1);
    }

    /**
     * Interpolates context values into the message placeholders.
     * @param mixed $message
     * @param array $context
     * @return string
     */
    protected function interpolate($message, $context = [])
    {
        if ($this->isObjectOrArray($message) || !is_array($context)) {
            return print_r($message, true);
        }
        $replace = [];
        foreach ($context as $key => $value) {
            $replace['{'.$key.'}'] = $this->normalizeValue($value);
        }
        return strtr($message, $replace);
    }

    /**
     * @param mixed $value
     * @return bool
     */
    protected function isObjectOrArray($value)
    {
        return is_object($value) || is_array($value);
    }

    /**
     * @param string $backtraceLine
     * @return string
     */
    protected function normalizeBacktraceLine($backtraceLine)
    {
        $search = [
            glsr()->path('plugin/'),
            glsr()->path('plugin/', false),
            trailingslashit(glsr()->path()),
            trailingslashit(glsr()->path('', false)),
            WP_CONTENT_DIR,
            ABSPATH,
        ];
        return str_replace(array_unique($search), '', $backtraceLine);
    }

    /**
     * @param string $message
     * @return string
     */
    protected function normalizeThrowableMessage($message)
    {
        $calledIn = strpos($message, ', called in');
        return false !== $calledIn
            ? substr($message, 0, $calledIn)
            : $message;
    }

    /**
     * @param mixed $value
     * @return string
     */
    protected function normalizeValue($value)
    {
        if ($value instanceof DateTime) {
            $value = $value->format('Y-m-d H:i:s');
        } elseif ($this->isObjectOrArray($value)) {
            $value = json_encode($value);
        }
        return (string) $value;
    }

    /**
     * @return void
     */
    protected function reset()
    {
        if ($this->size() <= pow(1024, 2) / 8) {
            return;
        }
        $this->clear();
        file_put_contents(
            $this->file,
            $this->buildLogEntry(
                static::NOTICE,
                __('Console was automatically cleared (128 KB maximum size)', 'site-reviews')
            )
        );
    }
}


1		<?php
2
3		namespace GeminiLabs\SiteReviews\Modules;
4
5		use DateTime;
6		use GeminiLabs\SiteReviews\Helper;
7		use ReflectionClass;
8		use Throwable;
9
10		class Console
11		{
12		const DEBUG = 0; // Detailed debug information
13		const INFO = 1; // Interesting events
14		const NOTICE = 2; // Normal but significant events
15		const WARNING = 4; // Exceptional occurrences that are not errors
16		const ERROR = 8; // Runtime errors that do not require immediate action
17		const CRITICAL = 16; // Critical conditions
18		const ALERT = 32; // Action must be taken immediately
19		const EMERGENCY = 64; // System is unusable
20
21		protected $file;
22		protected $log;
23		protected $logOnceKey = 'glsr_log_once';
24
25	1	public function __construct()
26		{
27	1	$this->file = glsr()->path('console.log');
28	1	$this->log = file_exists($this->file)
29		? file_get_contents($this->file)
30	1	: '';
31	1	$this->reset();
32	1	}
33
34		/**
35		* @return string
36		*/
37		public function __toString()
38		{
39		return $this->get();
40		}
41
42		/**
43		* Action must be taken immediately
44		* Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
45		* @param mixed $message
46		* @param array $context
47		* @return static
48		*/
49		public function alert($message, array $context = [])
50		{
51		return $this->log(static::ALERT, $message, $context);
52		}
53
54		/**
55		* @return void
56		*/
57		public function clear()
58		{
59		$this->log = '';
60		file_put_contents($this->file, $this->log);
61		}
62
63		/**
64		* Critical conditions
65		* Example: Application component unavailable, unexpected exception.
66		* @param mixed $message
67		* @param array $context
68		* @return static
69		*/
70		public function critical($message, array $context = [])
71		{
72		return $this->log(static::CRITICAL, $message, $context);
73		}
74
75		/**
76		* Detailed debug information.
77		* @param mixed $message
78		* @param array $context
79		* @return static
80		*/
81		public function debug($message, array $context = [])
82		{
83		return $this->log(static::DEBUG, $message, $context);
84		}
85
86		/**
87		* System is unusable.
88		* @param mixed $message
89		* @param array $context
90		* @return static
91		*/
92		public function emergency($message, array $context = [])
93		{
94		return $this->log(static::EMERGENCY, $message, $context);
95		}
96
97		/**
98		* Runtime errors that do not require immediate action but should typically be logged and monitored.
99		* @param mixed $message
100		* @param array $context
101		* @return static
102		*/
103		public function error($message, array $context = [])
104		{
105		return $this->log(static::ERROR, $message, $context);
106		}
107
108		/**
109		* @return string
110		*/
111		public function get()
112		{
113		return empty($this->log)
114		? __('Console is empty', 'site-reviews')
115		: $this->log;
116		}
117
118		/**
119		* @return int
120		*/
121	1	public function getLevel()
122		{
123	1	return intval(apply_filters('site-reviews/console/level', static::INFO));
124		}
125
126		/**
127		* @return array
128		*/
129	1	public function getLevels()
130		{
131	1	$constants = (new ReflectionClass(__CLASS__))->getConstants();
132	1	return array_map('strtolower', array_flip($constants));
133		}
134
135		/**
136		* @return string
137		*/
138		public function humanLevel()
139		{
140		$level = $this->getLevel();
141		return sprintf('%s (%d)', strtoupper(glsr_get($this->getLevels(), $level, 'unknown')), $level);
142		}
143
144		/**
145		* @param string\|null $valueIfEmpty
146		* @return string
147		*/
148		public function humanSize($valueIfEmpty = null)
149		{
150		$bytes = $this->size();
151		if (empty($bytes) && is_string($valueIfEmpty)) {
152		return $valueIfEmpty;
153		}
154		$exponent = floor(log(max($bytes, 1), 1024));
155		return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent];
156		}
157
158		/**
159		* Interesting events
160		* Example: User logs in, SQL logs.
161		* @param mixed $message
162		* @param array $context
163		* @return static
164		*/
165		public function info($message, array $context = [])
166		{
167		return $this->log(static::INFO, $message, $context);
168		}
169
170		/**
171		* @param int $level
172		* @param mixed $message
173		* @param array $context
174		* @param string $backtraceLine
175		* @return static
176		*/
177	1	public function log($level, $message, $context = [], $backtraceLine = '')
178		{
179	1	if (empty($backtraceLine)) {
180	1	$backtraceLine = $this->getBacktraceLine();
181		}
182	1	if ($this->canLogEntry($level, $backtraceLine)) {
183	1	$levelName = glsr_get($this->getLevels(), $level);
184	1	$context = glsr(Helper::class)->consolidateArray($context);
185	1	$backtraceLine = $this->normalizeBacktraceLine($backtraceLine);
186	1	$message = $this->interpolate($message, $context);
187	1	$entry = $this->buildLogEntry($levelName, $message, $backtraceLine);
188	1	file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND \| LOCK_EX);
189	1	apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed
190	1	$this->reset();
191		}
192	1	return $this;
193		}
194
195		/**
196		* @return void
197		*/
198		public function logOnce()
199		{
200		$once = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
201		$levels = $this->getLevels();
202		foreach ($once as $entry) {
203		$levelName = glsr_get($entry, 'level');
204		if (!in_array($levelName, $levels)) {
205		continue;
206		}
207		$level = glsr_get(array_flip($levels), $levelName);
208		$message = glsr_get($entry, 'message');
209		$backtraceLine = glsr_get($entry, 'backtrace');
210		$this->log($level, $message, [], $backtraceLine);
211		}
212		glsr()->{$this->logOnceKey} = [];
213		}
214
215		/**
216		* Normal but significant events.
217		* @param mixed $message
218		* @param array $context
219		* @return static
220		*/
221	1	public function notice($message, array $context = [])
222		{
223	1	return $this->log(static::NOTICE, $message, $context);
224		}
225
226		/**
227		* @param string $levelName
228		* @param string $handle
229		* @param mixed $data
230		* @return void
231		*/
232		public function once($levelName, $handle, $data)
233		{
234		$once = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
235		$filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
236		return glsr_get($entry, 'level') == $levelName
237		&& glsr_get($entry, 'handle') == $handle;
238		});
239		if (!empty($filtered)) {
240		return;
241		}
242		$once[] = [
243		'backtrace' => $this->getBacktraceLineFromData($data),
244		'handle' => $handle,
245		'level' => $levelName,
246		'message' => '[RECURRING] '.$this->getMessageFromData($data),
247		];
248		glsr()->{$this->logOnceKey} = $once;
249		}
250
251		/**
252		* @return int
253		*/
254	1	public function size()
255		{
256	1	return file_exists($this->file)
257	1	? filesize($this->file)
258	1	: 0;
259		}
260
261		/**
262		* Exceptional occurrences that are not errors
263		* Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
264		* @param mixed $message
265		* @param array $context
266		* @return static
267		*/
268		public function warning($message, array $context = [])
269		{
270		return $this->log(static::WARNING, $message, $context);
271		}
272
273		/**
274		* @param array $backtrace
275		* @param int $index
276		* @return string
277		*/
278	1	protected function buildBacktraceLine($backtrace, $index)
279		{
280	1	return sprintf('%s:%s',
281	1	glsr_get($backtrace, $index.'.file'), // realpath
282	1	glsr_get($backtrace, $index.'.line')
283		);
284		}
285
286		/**
287		* @param string $levelName
288		* @param mixed $message
289		* @param string $backtraceLine
290		* @return string
291		*/
292	1	protected function buildLogEntry($levelName, $message, $backtraceLine = '')
293		{
294	1	return sprintf('[%s] %s [%s] %s',
295	1	current_time('mysql'),
296	1	strtoupper($levelName),
297	1	$backtraceLine,
298	1	$message
299		);
300		}
301
302		/**
303		* @param int $level
304		* @return bool
305		*/
306	1	protected function canLogEntry($level, $backtraceLine)
307		{
308	1	$levelExists = array_key_exists($level, $this->getLevels());
309	1	if (false === strpos($backtraceLine, glsr()->path())) {
310		return $levelExists; // ignore level restriction if triggered outside of the plugin
311		}
312	1	return $levelExists && $level >= $this->getLevel();
313		}
314
315		/**
316		* @return void\|string
317		*/
318	1	protected function getBacktraceLine()
319		{
320	1	$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
321	1	$search = array_search('log', glsr_array_column($backtrace, 'function'));
322	1	if (false !== $search) {
323	1	$index = '{closure}' == glsr_get($backtrace, ($search + 2).'.function')
324		? $search + 4
325	1	: $search + 1;
326	1	return $this->buildBacktraceLine($backtrace, $index);
327		}
328		return 'Unknown';
329		}
330
331		/**
332		* @param mixed $data
333		* @return string
334		*/
335		protected function getBacktraceLineFromData($data)
336		{
337		$backtrace = $data instanceof Throwable
338		? $data->getTrace()
339		: debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
340		return $this->buildBacktraceLine($backtrace, 0);
341		}
342
343		/**
344		* @param mixed $data
345		* @return string
346		*/
347		protected function getMessageFromData($data)
348		{
349		return $data instanceof Throwable
350		? $this->normalizeThrowableMessage($data->getMessage())
351		: print_r($data, 1);
352		}
353
354		/**
355		* Interpolates context values into the message placeholders.
356		* @param mixed $message
357		* @param array $context
358		* @return string
359		*/
360	1	protected function interpolate($message, $context = [])
361		{
362	1	if ($this->isObjectOrArray($message) \|\| !is_array($context)) {
363		return print_r($message, true);
364		}
365	1	$replace = [];
366	1	foreach ($context as $key => $value) {
367		$replace['{'.$key.'}'] = $this->normalizeValue($value);
368		}
369	1	return strtr($message, $replace);
370		}
371
372		/**
373		* @param mixed $value
374		* @return bool
375		*/
376	1	protected function isObjectOrArray($value)
377		{
378	1	return is_object($value) \|\| is_array($value);
379		}
380
381		/**
382		* @param string $backtraceLine
383		* @return string
384		*/
385	1	protected function normalizeBacktraceLine($backtraceLine)
386		{
387		$search = [
388	1	glsr()->path('plugin/'),
389	1	glsr()->path('plugin/', false),
390	1	trailingslashit(glsr()->path()),
391	1	trailingslashit(glsr()->path('', false)),
392	1	WP_CONTENT_DIR,
393	1	ABSPATH,
394		];
395	1	return str_replace(array_unique($search), '', $backtraceLine);
396		}
397
398		/**
399		* @param string $message
400		* @return string
401		*/
402		protected function normalizeThrowableMessage($message)
403		{
404		$calledIn = strpos($message, ', called in');
405		return false !== $calledIn
406		? substr($message, 0, $calledIn)
407		: $message;
408		}
409
410		/**
411		* @param mixed $value
412		* @return string
413		*/
414		protected function normalizeValue($value)
415		{
416		if ($value instanceof DateTime) {
417		$value = $value->format('Y-m-d H:i:s');
418		} elseif ($this->isObjectOrArray($value)) {
419		$value = json_encode($value);
420		}
421		return (string) $value;
422		}
423
424		/**
425		* @return void
426		*/
427	1	protected function reset()
428		{
429	1	if ($this->size() <= pow(1024, 2) / 8) {
430	1	return;
431		}
432		$this->clear();
433		file_put_contents(
434		$this->file,
435		$this->buildLogEntry(
436		static::NOTICE,
437		__('Console was automatically cleared (128 KB maximum size)', 'site-reviews')
438		)
439		);
440		}
441		}
442

pryley / site-reviews

Push — master ( ece31d...41b8a6 )

Console::log() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like