Slince\Upload\Uploader

Complexity

Total Complexity

33

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setOverride()	0	4	1
A	getOverride()	0	4	1
A	setSavePath()	0	10	3
A	getSavePath()	0	4	1
A	setIsRandName()	0	4	1
A	getIsRandName()	0	4	1
A	setFilenameGenerator()	0	4	1
A	getFilenameGenerator()	0	8	3
A	addRule()	0	4	1
A	getRules()	0	4	1
B	process()	0	23	4
A	processUpload()	0	15	3
A	validateUpload()	0	11	3
B	moveUploadedFile()	0	17	5
A	makeDefaultRandFilenameGenerator()	0	6	1
A	makeDefaultOriginFilenameGenerator()	0	6	1
A	generateFilename()	0	6	1

<?php
/**
 * slince upload handler library
 * @author Tao <taosikai@yeah.net>
 */
namespace Slince\Upload;

use Slince\Upload\Exception\UploadException;
use Slince\Upload\Rule\RuleInterface;
use Slince\Upload\Rule\SystemRule;

class Uploader
{
    /**
     * Whether to overwrite if there is a file of the same name
     * @var boolean
     */
    protected $override = false;

    /**
     * save path
     * @var string
     */
    protected $savePath = './';

    /**
     * Whether to enable random file name
     * @var boolean
     */
    protected $isRandName = false;

    /**
     * rules
     * @var RuleInterface[]
     */
    protected $rules = [];

    /**
     * file name generator
     * @var callable
     */
    protected $filenameGenerator;

    public function __construct($path = './')
    {
        $this->setSavePath($path);
        $this->addRule(new SystemRule());
    }

    /**
     * set override mode
     * @param boolean $override
     */
    public function setOverride($override)
    {
        $this->override = $override;
    }

    /**
     * get override mode
     * @return boolean
     */
    public function getOverride()
    {
        return $this->override;
    }

    /**
     * set save path
     * @param string $path
     * @throws UploadException
     */
    public function setSavePath($path)
    {
        if (!file_exists($path)) {
            @mkdir($path, 0777, true);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        }
        if (!is_dir($path)) {
            throw new UploadException(sprintf('Path "%s" is not valid', $path));
        }
        $this->savePath = rtrim($path, '\\/') . DIRECTORY_SEPARATOR;
    }

    /**
     * get save path
     * @return string
     */
    public function getSavePath()
    {
        return $this->savePath;
    }

    /**
     * set rand name mode
     * @param boolean $val
     */
    public function setIsRandName($val)
    {
        $this->isRandName = $val;
    }

    /**
     * get rand name mode
     * @return boolean
     */
    public function getIsRandName()
    {
        return $this->isRandName;
    }

    /**
     * set filename generator
     * @param callable $generator
     */
    public function setFilenameGenerator(callable $generator)
    {
        $this->filenameGenerator = $generator;
    }

    /**
     * get current filename generator
     * @return string
     */
    public function getFilenameGenerator()
    {
        if (is_null($this->filenameGenerator)) {
            $this->filenameGenerator = $this->isRandName ? $this->makeDefaultRandFilenameGenerator()
                : $this->makeDefaultOriginFilenameGenerator();
        }
        return $this->filenameGenerator;
    }

    /**
     * add rule
     * @param RuleInterface $rule
     */
    public function addRule(RuleInterface $rule)
    {
        $this->rules[] = $rule;
    }

    /**
     * gets all rules
     * @return array
     */
    public function getRules()
    {
        return (array)$this->rules;
    }

    /**
     * go, process upload
     * @param array $files
     * @throws UploadException
     * @return FileInfo|FileInfo[];

The doc-type FileInfo|FileInfo[]; could not be parsed: Expected "|" or "end of type", but got ";" at position 19. (view supported doc-types)

     */
    public function process($files)
    {
        if (empty($files)) {
            throw new UploadException('File array is not valid');
        }
        //multi files
        if (is_array($files['name'])) {
            $_files = [];
            foreach ($files['name'] as $key => $fileName) {
                $file = array(
                    'error' => $files['error'][$key],
                    'name' => $fileName,
                    'size' => $files['size'][$key],
                    'tmp_name' => $files['tmp_name'][$key],
                    'type' => $files['type'][$key]
                );
                $_files[] = $this->processUpload($file);
            }
            return $_files;
        } else {
            return $this->processUpload($files);
        }
    }

    /**
     * process
     * @param array $info
     * @return FileInfo;

The doc-type FileInfo; could not be parsed: Expected "|" or "end of type", but got ";" at position 8. (view supported doc-types)

     */
    protected function processUpload(array $info)
    {
        $file = FileInfo::fromArray($info);
        if ($this->validateUpload($file)) {
            $newFilePath = $this->generateFilename($file);
            $result = $this->moveUploadedFile($file, $newFilePath);
            if ($result) {
                $file->setPath($newFilePath);
                $file->setHasError(false);
            } else {
                $file->setHasError(true);
            }
        }
        return $file;
    }

    /**
     * validate rules
     * @param FileInfo $file
     * @return boolean
     */
    protected function validateUpload(FileInfo $file)
    {
        foreach ($this->rules as $rule) {
            if (!$rule->validate($file)) {
                $file->setErrorCode($rule->getErrorCode());
                $file->setErrorMsg($rule->getErrorMsg());
                return false;
            }
        }
        return true;
    }

    /**
     * move file
     * Illegal upload files and other unsolicited causes can not be moved to throw an exception
     * @param FileInfo $file
     * @param string $newFilePath
     * @return boolean
     * @throws UploadException
     */
    protected function moveUploadedFile(FileInfo $file, $newFilePath)
    {
        $tmpName = $file->getTmpName();
        if (is_uploaded_file($tmpName)) {
            if (!file_exists($newFilePath) || $this->override) {
                if (!@move_uploaded_file($tmpName, $newFilePath)) {
                    throw new UploadException('Failed to move file');
                }
                return true;
            } else {
                $file->setErrorCode(ErrorStore::ERROR_SAME_NAME_FILE);
                $file->setErrorMsg(sprintf('File "%s" already exists', $file->getOriginName()));
                return false;
            }
        }
        throw new UploadException('The uploaded file is invalid');
    }

    /**
     * make default rand filename generator
     * @return callable
     */
    protected function makeDefaultRandFilenameGenerator()
    {
        return function (FileInfo $file) {
            return $this->savePath . time() . rand(10, 99) . '.' . $file->getExtension();
        };
    }

    /**
     * make default origin filename generator
     * @return callable
     */
    protected function makeDefaultOriginFilenameGenerator()
    {
        return function (FileInfo $file) {
            return $this->savePath . $file->getOriginName();
        };
    }

    /**
     * make new filepath
     * @param FileInfo $file
     * @return string
     */
    protected function generateFilename(FileInfo $file)
    {
        $generator = $this->getFilenameGenerator();
        $path = call_user_func($generator, $file);
        return $path;
    }
}