WebServCo\Framework\Files\Upload\AbstractUpload

Complexity

Total Complexity

14

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	checkAllowedExtensions()	0	8	3
A	setAllowedExtensions()	0	4	1
A	getFileName()	0	3	1
A	do()	0	32	6
A	setFormFieldName()	0	4	1
A	__construct()	0	5	1
A	getFileMimeType()	0	3	1

<?php

declare(strict_types=1);

namespace WebServCo\Framework\Files\Upload;

use WebServCo\Framework\Exceptions\UploadException;

/**
 * Initial functionality: simple upload.
 */
abstract class AbstractUpload
{
    /**
    * Allowed extensions.
    * mime / extension
    *
    * @var array<string,string>
    */
    protected array $allowedExtensions;
    protected string $fileName;
    protected string $fileMimeType;
    protected string $formFieldName;
    protected string $uploadDirectory;

    abstract protected function generateUploadedFileName(string $uploadFileName, string $uploadFileMimeType): string;

    public function __construct(string $uploadDirectory)
    {
        $this->allowedExtensions = []; // default all
        $this->formFieldName = 'upload';
        $this->uploadDirectory = $uploadDirectory;
    }

    public function getFileName(): string
    {
        return $this->fileName;
    }

    public function getFileMimeType(): string
    {
        return $this->fileMimeType;
    }

    final public function do(): bool
    {
        if (!$_FILES) {
            return false;
        }

        if (!isset($_FILES[$this->formFieldName]['error'])) {
            throw new UploadException(Codes::NO_FILE);
        }

        if (Codes::OK !== $_FILES[$this->formFieldName]['error']) {
            throw new UploadException($_FILES[$this->formFieldName]['error']);
        }
        $this->checkAllowedExtensions();
        $this->fileName = $this->generateUploadedFileName(
            $_FILES[$this->formFieldName]['name'],
            $_FILES[$this->formFieldName]['type'],
        );

        $this->fileMimeType = $_FILES[$this->formFieldName]['type'];

        if (!\move_uploaded_file($_FILES[$this->formFieldName]['tmp_name'], $this->uploadDirectory . $this->fileName)) {
            throw new UploadException(Codes::CANT_WRITE);
        }

        try {
            \chmod($this->uploadDirectory . $this->fileName, 0664);
        } catch (\Throwable $e) {
            // Operation not permitted
        }

        return true;
    }

    /**
    * @param array<string,string> $allowedExtensions
    */
    final public function setAllowedExtensions(array $allowedExtensions): bool
    {
        $this->allowedExtensions = $allowedExtensions;
        return true;
    }

    final public function setFormFieldName(string $formFieldName): bool
    {
        $this->formFieldName = $formFieldName;
        return true;
    }

    final protected function checkAllowedExtensions(): bool
    {
        if ($this->allowedExtensions) {

The expression $this->allowedExtensions of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            if (!\array_key_exists($_FILES[$this->formFieldName]['type'], $this->allowedExtensions)) {
                throw new UploadException(Codes::TYPE_NOT_ALLOWED);
            }
        }
        return true;
    }
}