Phossa2\Storage\Driver\LocalDriver

Complexity

Total Complexity

26

Size/Duplication

Total Lines	201
Duplicated Lines	16.42 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	6
Bugs	0	Features	1

13 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()	16	16	4
A	writeFile()	17	17	3
A	setRealMeta()	0	15	3
A	renameFile()	0	6	1
A	copyFile()	0	6	1
A	deleteFile()	0	4	1

<?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 <phossa@126.com>
 * @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 rename($tmpfname, $realPath) &&
                    chmod($realPath, PermissionAwareInterface::PERM_ALL);
            }
        }
        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);

            // rename to $realPath
            return rename($tmpfname, $realPath) &&
                chmod($realPath, PermissionAwareInterface::PERM_ALL);
        }
        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);
    }
}