Filesystem.php

<?php

namespace Codesleeve\Stapler\Storage;

use Codesleeve\Stapler\Interfaces\Storage as StorageInterface;
use Codesleeve\Stapler\Exceptions;
use Codesleeve\Stapler\Attachment;

class Filesystem implements StorageInterface
{
    /**
     * The current attachedFile object being processed.
     *
     * @var \Codesleeve\Stapler\Attachment
     */
    public $attachedFile;

    /**
     * Constructor method.
     *
     * @param Attachment $attachedFile
     */
    public function __construct(Attachment $attachedFile)
    {
        $this->attachedFile = $attachedFile;
    }

    /**
     * Return the url for a file upload.
     *
     * @param string $styleName
     * @param string $expires
     *
     * @return string
     */
    public function url($styleName, $expires = null)
    {
        return $this->attachedFile->getInterpolator()->interpolate($this->attachedFile->url, $this->attachedFile, $styleName);
    }

    /**
     * Return the path (on disk) of a file upload.
     *
     * @param string $styleName
     *
     * @return string
     */
    public function path($styleName)
    {
        return $this->attachedFile->getInterpolator()->interpolate($this->attachedFile->path, $this->attachedFile, $styleName);
    }

    /**
     * Remove an attached file.
     *
     * @param array $filePaths
     */
    public function remove(array $filePaths)
    {
        foreach ($filePaths as $filePath) {
            $directory = dirname($filePath);
            $this->emptyDirectory($directory, true);
        }
    }

    /**
     * Move an uploaded file to it's intended destination.
     * The file can be an actual uploaded file object or the path to
     * a resized image file on disk.
     *
     * @param string $file
     * @param string $filePath
     */
    public function move($file, $filePath)
    {
        $this->buildDirectory($filePath);
        $this->moveFile($file, $filePath);
        $this->setPermissions($filePath, $this->attachedFile->override_file_permissions);
    }

    /**
     * Determine if a style directory needs to be built and if so create it.
     *
     * @param string $filePath
     */
    protected function buildDirectory($filePath)
    {
        $directory = dirname($filePath);

        if (!is_dir($directory)) {
            mkdir($directory, 0777, true);
        }
    }

    /**
     * Set the file permissions of a file upload
     * Does not ignore umask.
     *
     * @param string $filePath
     * @param int    $overrideFilePermissions
     */
    protected function setPermissions($filePath, $overrideFilePermissions)
    {
        if ($overrideFilePermissions) {
            chmod($filePath, $overrideFilePermissions & ~umask());
        } elseif (is_null($overrideFilePermissions)) {
            chmod($filePath, 0666 & ~umask());
        }
    }

    /**
     * Attempt to move and uploaded file to it's intended location on disk.
     *
     * @param string $file
     * @param string $filePath
     *
     * @throws Exceptions\FileException
     */
    protected function moveFile($file, $filePath)
    {
        if (!@rename($file, $filePath)) {
            $error = error_get_last();
            throw new Exceptions\FileException(sprintf('Could not move the file "%s" to "%s" (%s)', $file, $filePath, strip_tags($error['message'])));
        }
    }

    /**
     * Recursively delete the files in a directory.
     *
     * @desc Recursively loops through each file in the directory and deletes it.
     *
     * @param string $directory
     * @param bool   $deleteDirectory
     */
    protected function emptyDirectory($directory, $deleteDirectory = false)
    {
        if (!is_dir($directory) || !($directoryHandle = opendir($directory))) {
            return;
        }

        while (false !== ($object = readdir($directoryHandle))) {
            if ($object == '.' || $object == '..') {
                continue;
            }

            if (!is_dir($directory.'/'.$object)) {
                unlink($directory.'/'.$object);
            } else {
                $this->emptyDirectory($directory.'/'.$object, true);    // The object is a folder, recurse through it.
            }
        }

        if ($deleteDirectory) {
            closedir($directoryHandle);
            rmdir($directory);
        }
    }
}