LaravelLogViewer::all() - Code Metrics - Inspection of "Check that file is readable (#243)" - rap2hpoutre/laravel-log-viewer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 27392d...1a11c7 )

by raphael

created 2020-10-01 15:52 UTC

LaravelLogViewer::all() F

↳ Parent: LaravelLogViewer

Complexity

Conditions	18
Paths	187

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	89
rs	3.5533
c	0
b	0
f	0
cc	18
nc	187
nop	0

How to fix Long Method Complexity

<?php

namespace Rap2hpoutre\LaravelLogViewer;

/**
 * Class LaravelLogViewer
 * @package Rap2hpoutre\LaravelLogViewer
 */
class LaravelLogViewer
{
    /**
     * @var string file
     */
    private $file;

    /**
     * @var string folder
     */
    private $folder;

    /**
     * @var string storage_path
     */
    private $storage_path;

    /**
     * Why? Uh... Sorry
     */
    const MAX_FILE_SIZE = 52428800;

    /**
     * @var Level level
     */
    private $level;

    /**
     * @var Pattern pattern
     */
    private $pattern;

    /**
     * LaravelLogViewer constructor.
     */
    public function __construct()
    {
        $this->level = new Level();
        $this->pattern = new Pattern();
        $this->storage_path = function_exists('config') ? config('logviewer.storage_path', storage_path('logs')) : storage_path('logs');

    }

    /**
     * @param string $folder
     */
    public function setFolder($folder)
    {
        if (app('files')->exists($folder)) {
            $this->folder = $folder;
        }
        if(is_array($this->storage_path)) {
            foreach ($this->storage_path as $value) {

                $logsPath = $value . '/' . $folder;
                if (app('files')->exists($logsPath)) {
                    $this->folder = $folder;
                    break;
                }
            }
        } else {
            if ($this->storage_path) {
                $logsPath = $this->storage_path . '/' . $folder;
                if (app('files')->exists($logsPath)) {
                    $this->folder = $folder;
                }
            }
        }
    }

    /**
     * @param string $file
     * @throws \Exception
     */
    public function setFile($file)
    {
        $file = $this->pathToLogFile($file);

        if (app('files')->exists($file)) {
            $this->file = $file;
        }
    }

    /**
     * @param string $file
     * @return string
     * @throws \Exception
     */
    public function pathToLogFile($file)
    {

        if (app('files')->exists($file)) { // try the absolute path
            return $file;
        }
        if (is_array($this->storage_path)) {
            foreach ($this->storage_path as $folder) {

                if (app('files')->exists($folder . '/' . $file)) { // try the absolute path
                    $file = $folder . '/' . $file;
                    break;
                }
            }
            return $file;
        }

        $logsPath = $this->storage_path;
        $logsPath .= ($this->folder) ? '/' . $this->folder : '';
        $file = $logsPath . '/' . $file;
        // check if requested file is really in the logs directory
        if (dirname($file) !== $logsPath) {
            throw new \Exception('No such log file');
        }
        return $file;
    }

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

    /**
     * @return string
     */
    public function getFileName()
    {
        return basename($this->file);
    }

    /**
     * @return array
     */
    public function all()
    {
        $log = array();

        if (!$this->file) {
            $log_file = (!$this->folder) ? $this->getFiles() : $this->getFolderFiles();
            if (!count($log_file)) {
                return [];
            }
            $this->file = $log_file[0];
        }

        $max_file_size = function_exists('config') ? config('logviewer.max_file_size', self::MAX_FILE_SIZE) : self::MAX_FILE_SIZE;
        if (app('files')->size($this->file) > $max_file_size) {
            return null;
        }

        if (!is_readable($this->file)) {
            return [[
                'context' => '',
                'level' => '',
                'date' => null,
                'text' => 'Log file "' . $this->file . '" not readable',
                'stack' => '',
            ]];
        }

        $file = app('files')->get($this->file);

        preg_match_all($this->pattern->getPattern('logs'), $file, $headings);

        if (!is_array($headings)) {
            return $log;
        }

        $log_data = preg_split($this->pattern->getPattern('logs'), $file);

        if ($log_data[0] < 1) {
            array_shift($log_data);
        }

        foreach ($headings as $h) {
            for ($i = 0, $j = count($h); $i < $j; $i++) {
                foreach ($this->level->all() as $level) {
                    if (strpos(strtolower($h[$i]), '.' . $level) || strpos(strtolower($h[$i]), $level . ':')) {

                        preg_match($this->pattern->getPattern('current_log', 0) . $level . $this->pattern->getPattern('current_log', 1), $h[$i], $current);
                        if (!isset($current[4])) {
                            continue;
                        }

                        $log[] = array(
                            'context' => $current[3],
                            'level' => $level,
                            'folder' => $this->folder,
                            'level_class' => $this->level->cssClass($level),
                            'level_img' => $this->level->img($level),
                            'date' => $current[1],
                            'text' => $current[4],
                            'in_file' => isset($current[5]) ? $current[5] : null,
                            'stack' => preg_replace("/^\n*/", '', $log_data[$i])
                        );
                    }
                }
            }
        }

        if (empty($log)) {

            $lines = explode(PHP_EOL, $file);
            $log = [];

            foreach ($lines as $key => $line) {
                $log[] = [
                    'context' => '',
                    'level' => '',
                    'folder' => '',
                    'level_class' => '',
                    'level_img' => '',
                    'date' => $key + 1,
                    'text' => $line,
                    'in_file' => null,
                    'stack' => '',
                ];
            }
        }

        return array_reverse($log);
    }

    /**
     * @return array
     */
    public function getFolders()
    {
        $folders = glob($this->storage_path . '/*', GLOB_ONLYDIR);
        if (is_array($this->storage_path)) {
            foreach ($this->storage_path as $value) {
                $folders = array_merge(
                    $folders,
                    glob($value . '/*', GLOB_ONLYDIR)
                );
            }
        }

        if (is_array($folders)) {
            foreach ($folders as $k => $folder) {
                $folders[$k] = basename($folder);
            }
        }
        return array_values($folders);
    }

    /**
     * @param bool $basename
     * @return array
     */
    public function getFolderFiles($basename = false)
    {
        return $this->getFiles($basename, $this->folder);
    }

    /**
     * @param bool $basename
     * @param string $folder
     * @return array
     */
    public function getFiles($basename = false, $folder = '')
    {
        $pattern = function_exists('config') ? config('logviewer.pattern', '*.log') : '*.log';
        $files = glob(
            $this->storage_path . '/' . $folder . '/' . $pattern,
            preg_match($this->pattern->getPattern('files'), $pattern) ? GLOB_BRACE : 0
        );
        if (is_array($this->storage_path)) {
            foreach ($this->storage_path as $value) {
                $files = array_merge(
                  $files,
                  glob(
                      $value . '/' . $folder . '/' . $pattern,
                      preg_match($this->pattern->getPattern('files'), $pattern) ? GLOB_BRACE : 0
                  )
                );
            }
        }

        $files = array_reverse($files);
        $files = array_filter($files, 'is_file');
        if ($basename && is_array($files)) {
            foreach ($files as $k => $file) {
                $files[$k] = basename($file);
            }
        }
        return array_values($files);
    }
}


1		<?php
2
3		namespace Rap2hpoutre\LaravelLogViewer;
4
5		/**
6		* Class LaravelLogViewer
7		* @package Rap2hpoutre\LaravelLogViewer
8		*/
9		class LaravelLogViewer
10		{
11		/**
12		* @var string file
13		*/
14		private $file;
15
16		/**
17		* @var string folder
18		*/
19		private $folder;
20
21		/**
22		* @var string storage_path
23		*/
24		private $storage_path;
25
26		/**
27		* Why? Uh... Sorry
28		*/
29		const MAX_FILE_SIZE = 52428800;
30
31		/**
32		* @var Level level
33		*/
34		private $level;
35
36		/**
37		* @var Pattern pattern
38		*/
39		private $pattern;
40
41		/**
42		* LaravelLogViewer constructor.
43		*/
44		public function __construct()
45		{
46		$this->level = new Level();
47		$this->pattern = new Pattern();
48		$this->storage_path = function_exists('config') ? config('logviewer.storage_path', storage_path('logs')) : storage_path('logs');
49
50		}
51
52		/**
53		* @param string $folder
54		*/
55		public function setFolder($folder)
56		{
57		if (app('files')->exists($folder)) {
58		$this->folder = $folder;
59		}
60		if(is_array($this->storage_path)) {
61	View Code Duplication	foreach ($this->storage_path as $value) {
		0 ignored issues – show Duplication introduced 2018-10-03 02:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
62		$logsPath = $value . '/' . $folder;
63		if (app('files')->exists($logsPath)) {
64		$this->folder = $folder;
65		break;
66		}
67		}
68		} else {
69		if ($this->storage_path) {
70		$logsPath = $this->storage_path . '/' . $folder;
71		if (app('files')->exists($logsPath)) {
72		$this->folder = $folder;
73		}
74		}
75		}
76		}
77
78		/**
79		* @param string $file
80		* @throws \Exception
81		*/
82		public function setFile($file)
83		{
84		$file = $this->pathToLogFile($file);
85
86		if (app('files')->exists($file)) {
87		$this->file = $file;
88		}
89		}
90
91		/**
92		* @param string $file
93		* @return string
94		* @throws \Exception
95		*/
96		public function pathToLogFile($file)
97		{
98
99		if (app('files')->exists($file)) { // try the absolute path
100		return $file;
101		}
102		if (is_array($this->storage_path)) {
103	View Code Duplication	foreach ($this->storage_path as $folder) {
		0 ignored issues – show Duplication introduced 2018-10-03 02:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		if (app('files')->exists($folder . '/' . $file)) { // try the absolute path
105		$file = $folder . '/' . $file;
106		break;
107		}
108		}
109		return $file;
110		}
111
112		$logsPath = $this->storage_path;
113		$logsPath .= ($this->folder) ? '/' . $this->folder : '';
114		$file = $logsPath . '/' . $file;
115		// check if requested file is really in the logs directory
116		if (dirname($file) !== $logsPath) {
117		throw new \Exception('No such log file');
118		}
119		return $file;
120		}
121
122		/**
123		* @return string
124		*/
125		public function getFolderName()
126		{
127		return $this->folder;
128		}
129
130		/**
131		* @return string
132		*/
133		public function getFileName()
134		{
135		return basename($this->file);
136		}
137
138		/**
139		* @return array
140		*/
141		public function all()
142		{
143		$log = array();
144
145		if (!$this->file) {
146		$log_file = (!$this->folder) ? $this->getFiles() : $this->getFolderFiles();
147		if (!count($log_file)) {
148		return [];
149		}
150		$this->file = $log_file[0];
151		}
152
153		$max_file_size = function_exists('config') ? config('logviewer.max_file_size', self::MAX_FILE_SIZE) : self::MAX_FILE_SIZE;
154		if (app('files')->size($this->file) > $max_file_size) {
155		return null;
156		}
157
158		if (!is_readable($this->file)) {
159		return [[
160		'context' => '',
161		'level' => '',
162		'date' => null,
163		'text' => 'Log file "' . $this->file . '" not readable',
164		'stack' => '',
165		]];
166		}
167
168		$file = app('files')->get($this->file);
169
170		preg_match_all($this->pattern->getPattern('logs'), $file, $headings);
171
172		if (!is_array($headings)) {
173		return $log;
174		}
175
176		$log_data = preg_split($this->pattern->getPattern('logs'), $file);
177
178		if ($log_data[0] < 1) {
179		array_shift($log_data);
180		}
181
182		foreach ($headings as $h) {
183		for ($i = 0, $j = count($h); $i < $j; $i++) {
184		foreach ($this->level->all() as $level) {
185		if (strpos(strtolower($h[$i]), '.' . $level) \|\| strpos(strtolower($h[$i]), $level . ':')) {
186
187		preg_match($this->pattern->getPattern('current_log', 0) . $level . $this->pattern->getPattern('current_log', 1), $h[$i], $current);
188		if (!isset($current[4])) {
189		continue;
190		}
191
192		$log[] = array(
193		'context' => $current[3],
194		'level' => $level,
195		'folder' => $this->folder,
196		'level_class' => $this->level->cssClass($level),
197		'level_img' => $this->level->img($level),
198		'date' => $current[1],
199		'text' => $current[4],
200		'in_file' => isset($current[5]) ? $current[5] : null,
201		'stack' => preg_replace("/^\n*/", '', $log_data[$i])
202		);
203		}
204		}
205		}
206		}
207
208		if (empty($log)) {
209
210		$lines = explode(PHP_EOL, $file);
211		$log = [];
212
213		foreach ($lines as $key => $line) {
214		$log[] = [
215		'context' => '',
216		'level' => '',
217		'folder' => '',
218		'level_class' => '',
219		'level_img' => '',
220		'date' => $key + 1,
221		'text' => $line,
222		'in_file' => null,
223		'stack' => '',
224		];
225		}
226		}
227
228		return array_reverse($log);
229		}
230
231		/**
232		* @return array
233		*/
234		public function getFolders()
235		{
236		$folders = glob($this->storage_path . '/*', GLOB_ONLYDIR);
237		if (is_array($this->storage_path)) {
238		foreach ($this->storage_path as $value) {
239		$folders = array_merge(
240		$folders,
241		glob($value . '/*', GLOB_ONLYDIR)
242		);
243		}
244		}
245
246		if (is_array($folders)) {
247		foreach ($folders as $k => $folder) {
248		$folders[$k] = basename($folder);
249		}
250		}
251		return array_values($folders);
252		}
253
254		/**
255		* @param bool $basename
256		* @return array
257		*/
258		public function getFolderFiles($basename = false)
259		{
260		return $this->getFiles($basename, $this->folder);
261		}
262
263		/**
264		* @param bool $basename
265		* @param string $folder
266		* @return array
267		*/
268		public function getFiles($basename = false, $folder = '')
269		{
270		$pattern = function_exists('config') ? config('logviewer.pattern', '.log') : '.log';
271		$files = glob(
272		$this->storage_path . '/' . $folder . '/' . $pattern,
273		preg_match($this->pattern->getPattern('files'), $pattern) ? GLOB_BRACE : 0
274		);
275		if (is_array($this->storage_path)) {
276		foreach ($this->storage_path as $value) {
277		$files = array_merge(
278		$files,
279		glob(
280		$value . '/' . $folder . '/' . $pattern,
281		preg_match($this->pattern->getPattern('files'), $pattern) ? GLOB_BRACE : 0
282		)
283		);
284		}
285		}
286
287		$files = array_reverse($files);
288		$files = array_filter($files, 'is_file');
289		if ($basename && is_array($files)) {
290		foreach ($files as $k => $file) {
291		$files[$k] = basename($file);
292		}
293		}
294		return array_values($files);
295		}
296		}
297

rap2hpoutre / laravel-log-viewer

Push — master ( 27392d...1a11c7 )

LaravelLogViewer::all() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like