LocalDriver - Code Metrics - Inspection of "updated 4" - phossa2/storage - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f61a47...233e03 )

by Hong

created 2016-08-09 04:32 UTC

LocalDriver A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	220
Duplicated Lines	13.64 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	7
Bugs	0	Features	1

Metric	Value
wmc	27
c	7
b	0
f	1
lcom	2
cbo	4
dl	30
loc	220
rs	10

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	realPath()	0	5	2
A	realExists()	0	4	1
A	openReadStream()	0	13	2
A	readFile()	0	14	2
A	getRealMeta()	0	18	2
A	ensurePath()	0	8	2
A	writeStream()	15	15	3
A	writeFile()	15	15	2
A	setRealMeta()	0	15	3
A	renameFile()	0	6	1
A	copyFile()	0	6	1
A	deleteFile()	0	4	1
A	renameTempFile()	0	13	3

How to fix Duplicated Code

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Storage
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Storage\Driver;

use Phossa2\Storage\Message\Message;
use Phossa2\Storage\Traits\LocalDirTrait;
use Phossa2\Storage\Exception\LogicException;
use Phossa2\Storage\Interfaces\PermissionAwareInterface;

/**
 * LocalDriver
 *
 * @package Phossa2\Storage
 * @author  Hong Zhang <[email protected]>
 * @see     DriverAbstract
 * @version 2.0.0
 * @since   2.0.0 added
 */
class LocalDriver extends DriverAbstract
{
    use LocalDirTrait;

    /**
     * driver root
     *
     * @var    string
     * @access protected
     */
    protected $root;

    /**
     * @param  string $rootDir
     * @throws LogicException
     * @access public
     */
    public function __construct(/*# string */ $rootDir)
    {
        if (!$this->makeDirectory($rootDir)) {
            throw new LogicException(
                $this->getError(), $this->getErrorCode()
            );
        }
        $this->root = rtrim($rootDir, "/\\") . \DIRECTORY_SEPARATOR;
    }

    /**
     * {@inheritDoc}
     */
    protected function realPath(/*# string */ $path)/*# : string */
    {
        return $this->root . ('/' !== \DIRECTORY_SEPARATOR ?
            str_replace('/', \DIRECTORY_SEPARATOR, $path) : $path);
    }

    /**
     * {@inheritDoc}
     */
    protected function realExists(/*# string */ $realPath)/*# : bool */
    {
        return file_exists($realPath);
    }

    /**
     * {@inheritDoc}
     */
    protected function openReadStream(/*# string */ $realPath)
    {
        $stream = fopen($realPath, 'r');
        if (is_resource($stream)) {
            return $stream;
        } else {
            $this->setError(
                Message::get(Message::STR_OPENSTREAM_FAIL, $realPath),
                Message::STR_OPENSTREAM_FAIL
            );
            return null;
        }
    }

    /**
     * {@inheritDoc}
     */
    protected function readFile(/*# string */ $realPath)
    {
        $str = file_get_contents($realPath);

        if (false === $str) {
            $this->setError(
                Message::get(Message::STR_OPENSTREAM_FAIL, $realPath),
                Message::STR_OPENSTREAM_FAIL
            );
            return null;
        }

        return $str;
    }

    /**
     * {@inheritDoc}
     */
    protected function getRealMeta(/*# string */ $realPath)/*# : array */
    {
        try {
            $info = new \SplFileInfo($realPath);
            return [
                'size'  => $info->getSize(),
                'perm'  => $info->getPerms() & PermissionAwareInterface::PERM_ALL,
                'ctime' => $info->getCTime(),
                'mtime' => $info->getMTime(),
            ];
        } catch (\Exception $e) {
            $this->setError(
                Message::get(Message::STR_GETMETA_FAIL, $realPath),
                Message::STR_GETMETA_FAIL
            );
            return [];
        }
    }

    /**
     * {@inheritDoc}
     */
    protected function ensurePath(/*# string */ $realPath)/*# : bool */
    {
        $parent = dirname($realPath);
        if (!$this->makeDirectory($parent)) {
            return false;
        }
        return true;
    }

    /**
     * {@inheritDoc}
     */
    protected function writeStream(
        /*# string */ $realPath,
        $resource
    )/*# : bool */ {
        $tmpfname = tempnam(dirname($realPath), 'FOO');
        if (false !== $tmpfname) {
            $stream = fopen($tmpfname, 'w+b');
            if (is_resource($stream)) {
                stream_copy_to_stream($resource, $stream);
                fclose($stream);
                return $this->renameTempFile($tmpfname, $realPath);
            }
        }
        return false;
    }

    /**
     * {@inheritDoc}
     */
    protected function writeFile(
        /*# string */ $realPath,
        /*# string */ $content
    )/*# : bool */ {
        // write to a temp file
        $tmpfname = tempnam(dirname($realPath), 'FOO');
        if (false !== $tmpfname) {
            $handle = fopen($tmpfname, 'w');
            fwrite($handle, $content);
            fclose($handle);

            return $this->renameTempFile($tmpfname, $realPath);
        }
        return false;
    }

    /**
     * {@inheritDoc}
     */
    protected function setRealMeta(
        /*# string */ $realPath,
        array $meta
    )/*# : bool */ {
        clearstatcache(true, $realPath);

        if (isset($meta['mtime'])) {
            touch($realPath, $meta['mtime']);
        }

        if (isset($meta['perm'])) {
            chmod($realPath, (int) $meta['perm']);
        }
        return true;
    }

    /**
     * {@inheritDoc}
     */
    protected function renameFile(
        /*# string */ $from,
        /*# string */ $to
    )/*# : bool */ {
        return @rename($from, $to);
    }

    /**
     * {@inheritDoc}
     */
    protected function copyFile(
        /*# string */ $from,
        /*# string */ $to
    )/*# : bool */ {
        return @copy($from, $to);
    }

    /**
     * {@inheritDoc}
     */
    protected function deleteFile(/*# string */ $realPath)/*# : bool */
    {
        return unlink($realPath);
    }

    /**
     * Rename tmpfile
     *
     * @param  string $tmpFile
     * @param  string $realPath
     * @return bool
     * @access protected
     */
    protected function renameTempFile(
        /*# string */ $tmpFile,
        /*# string */ $realPath
    )/*# : bool */ {
        if (@rename($tmpFile, $realPath) &&
            @chmod($realPath, PermissionAwareInterface::PERM_ALL)) {
            return true;
        }
        $err = error_get_last();
        $this->setError($err['message'], Message::STR_WRITEFILE_FAIL);
        @unlink($tmpFile);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        return false;
    }
}


1		<?php
2		/**
3		* Phossa Project
4		*
5		* PHP version 5.4
6		*
7		* @category Library
8		* @package Phossa2\Storage
9		* @copyright Copyright (c) 2016 phossa.com
10		* @license http://mit-license.org/ MIT License
11		* @link http://www.phossa.com/
12		*/
13		/# declare(strict_types=1); /
14
15		namespace Phossa2\Storage\Driver;
16
17		use Phossa2\Storage\Message\Message;
18		use Phossa2\Storage\Traits\LocalDirTrait;
19		use Phossa2\Storage\Exception\LogicException;
20		use Phossa2\Storage\Interfaces\PermissionAwareInterface;
21
22		/**
23		* LocalDriver
24		*
25		* @package Phossa2\Storage
26		* @author Hong Zhang <[email protected]>
27		* @see DriverAbstract
28		* @version 2.0.0
29		* @since 2.0.0 added
30		*/
31		class LocalDriver extends DriverAbstract
32		{
33		use LocalDirTrait;
34
35		/**
36		* driver root
37		*
38		* @var string
39		* @access protected
40		*/
41		protected $root;
42
43		/**
44		* @param string $rootDir
45		* @throws LogicException
46		* @access public
47		*/
48		public function __construct(/# string / $rootDir)
49		{
50		if (!$this->makeDirectory($rootDir)) {
51		throw new LogicException(
52		$this->getError(), $this->getErrorCode()
53		);
54		}
55		$this->root = rtrim($rootDir, "/\\") . \DIRECTORY_SEPARATOR;
56		}
57
58		/**
59		* {@inheritDoc}
60		*/
61		protected function realPath(/# string / $path)/# : string /
62		{
63		return $this->root . ('/' !== \DIRECTORY_SEPARATOR ?
64		str_replace('/', \DIRECTORY_SEPARATOR, $path) : $path);
65		}
66
67		/**
68		* {@inheritDoc}
69		*/
70		protected function realExists(/# string / $realPath)/# : bool /
71		{
72		return file_exists($realPath);
73		}
74
75		/**
76		* {@inheritDoc}
77		*/
78		protected function openReadStream(/# string / $realPath)
79		{
80		$stream = fopen($realPath, 'r');
81		if (is_resource($stream)) {
82		return $stream;
83		} else {
84		$this->setError(
85		Message::get(Message::STR_OPENSTREAM_FAIL, $realPath),
86		Message::STR_OPENSTREAM_FAIL
87		);
88		return null;
89		}
90		}
91
92		/**
93		* {@inheritDoc}
94		*/
95		protected function readFile(/# string / $realPath)
96		{
97		$str = file_get_contents($realPath);
98
99		if (false === $str) {
100		$this->setError(
101		Message::get(Message::STR_OPENSTREAM_FAIL, $realPath),
102		Message::STR_OPENSTREAM_FAIL
103		);
104		return null;
105		}
106
107		return $str;
108		}
109
110		/**
111		* {@inheritDoc}
112		*/
113		protected function getRealMeta(/# string / $realPath)/# : array /
114		{
115		try {
116		$info = new \SplFileInfo($realPath);
117		return [
118		'size' => $info->getSize(),
119		'perm' => $info->getPerms() & PermissionAwareInterface::PERM_ALL,
120		'ctime' => $info->getCTime(),
121		'mtime' => $info->getMTime(),
122		];
123		} catch (\Exception $e) {
124		$this->setError(
125		Message::get(Message::STR_GETMETA_FAIL, $realPath),
126		Message::STR_GETMETA_FAIL
127		);
128		return [];
129		}
130		}
131
132		/**
133		* {@inheritDoc}
134		*/
135		protected function ensurePath(/# string / $realPath)/# : bool /
136		{
137		$parent = dirname($realPath);
138		if (!$this->makeDirectory($parent)) {
139		return false;
140		}
141		return true;
142		}
143
144		/**
145		* {@inheritDoc}
146		*/
147	View Code Duplication	protected function writeStream(
148		/# string / $realPath,
149		$resource
150		)/# : bool / {
151		$tmpfname = tempnam(dirname($realPath), 'FOO');
152		if (false !== $tmpfname) {
153		$stream = fopen($tmpfname, 'w+b');
154		if (is_resource($stream)) {
155		stream_copy_to_stream($resource, $stream);
156		fclose($stream);
157		return $this->renameTempFile($tmpfname, $realPath);
158		}
159		}
160		return false;
161		}
162
163		/**
164		* {@inheritDoc}
165		*/
166	View Code Duplication	protected function writeFile(
167		/# string / $realPath,
168		/# string / $content
169		)/# : bool / {
170		// write to a temp file
171		$tmpfname = tempnam(dirname($realPath), 'FOO');
172		if (false !== $tmpfname) {
173		$handle = fopen($tmpfname, 'w');
174		fwrite($handle, $content);
175		fclose($handle);
176
177		return $this->renameTempFile($tmpfname, $realPath);
178		}
179		return false;
180		}
181
182		/**
183		* {@inheritDoc}
184		*/
185		protected function setRealMeta(
186		/# string / $realPath,
187		array $meta
188		)/# : bool / {
189		clearstatcache(true, $realPath);
190
191		if (isset($meta['mtime'])) {
192		touch($realPath, $meta['mtime']);
193		}
194
195		if (isset($meta['perm'])) {
196		chmod($realPath, (int) $meta['perm']);
197		}
198		return true;
199		}
200
201		/**
202		* {@inheritDoc}
203		*/
204		protected function renameFile(
205		/# string / $from,
206		/# string / $to
207		)/# : bool / {
208		return @rename($from, $to);
209		}
210
211		/**
212		* {@inheritDoc}
213		*/
214		protected function copyFile(
215		/# string / $from,
216		/# string / $to
217		)/# : bool / {
218		return @copy($from, $to);
219		}
220
221		/**
222		* {@inheritDoc}
223		*/
224		protected function deleteFile(/# string / $realPath)/# : bool /
225		{
226		return unlink($realPath);
227		}
228
229		/**
230		* Rename tmpfile
231		*
232		* @param string $tmpFile
233		* @param string $realPath
234		* @return bool
235		* @access protected
236		*/
237		protected function renameTempFile(
238		/# string / $tmpFile,
239		/# string / $realPath
240		)/# : bool / {
241		if (@rename($tmpFile, $realPath) &&
242		@chmod($realPath, PermissionAwareInterface::PERM_ALL)) {
243		return true;
244		}
245		$err = error_get_last();
246		$this->setError($err['message'], Message::STR_WRITEFILE_FAIL);
247		@unlink($tmpFile);
		1 ignored issue – show Security Best Practice introduced 2016-08-09 04:35 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
248		return false;
249		}
250		}
251

phossa2 / storage

Push — master ( f61a47...233e03 )

LocalDriver A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like