Platine\Upload\Util\Helper

Complexity

Total Complexity

15

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	moveUploadedFileToTempDirectory()	0	6	2
A	formatSize()	0	14	3
A	sizeInBytes()	0	16	3
B	normalizeFiles()	0	52	7

<?php

/**
 * Platine Upload
 *
 * Platine Upload provides a flexible file uploads with extensible
 * validation and storage strategies.
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Upload
 *
 * @author      Josh Lockhart <info@joshlockhart.com>
 * @copyright   2012 Josh Lockhart
 * @link        http://www.joshlockhart.com
 * @version     2.0.0
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Helper.php
 *
 *  The Upload Helper class
 *
 *  @package    Platine\Upload\Util
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Upload\Util;

use Platine\Http\UploadedFile;
use Platine\Upload\File\File;

/**
 * @class Helper
 * @package Platine\Upload\Util
 */
class Helper
{
    /**
     * Normalize the uploaded files to fit our format
     *
     * @param array<mixed> $files the normalized
     * format of UploadedFile::createFromGlobals()
     *
     * @return array<string, File>|array<string, array<int, File>>
     */
    public static function normalizeFiles(array $files): array
    {
        /** @var array<mixed> $result */
        $result = [];

        /**
         * TODO
         * Only support for :
         * <input type = 'file' name ='my_file' /><br />
         * <input type = 'file' name ='files[]' /><br />
         *
         * Not support currently:
         *  <input type = 'file' name ='files[my_name]' />
         *  <input type = 'file' name ='files[][foo]' />
         *  <input type = 'file' name ='files[][bar][]' />
         *  <input type = 'file' name ='files[file1][file2][file3][file_n]' />
         *  <input type = 'file' name ='files[file_name][]' />
         */
        foreach ($files as $name => $file) {
            if ($file instanceof UploadedFile) {
                $tempName = (string) tempnam(sys_get_temp_dir(), uniqid());
                static::moveUploadedFileToTempDirectory($file, $tempName);

                $result[$name] = File::create(
                    $tempName,
                    (string) $file->getClientFilename(),
                    $file->getClientFilename(),
                    $file->getError()
                );
                continue;
            }

            if (is_array($file)) {
                $result[$name] = [];

                foreach ($file as $index => $file2) {
                    if (is_int($index) && $file2 instanceof UploadedFile) {
                        $tempName = (string) tempnam(sys_get_temp_dir(), uniqid());
                        static::moveUploadedFileToTempDirectory($file2, $tempName);

                        $result[$name][$index] = File::create(
                            $tempName,
                            (string) $file2->getClientFilename(),
                            $file2->getClientFilename(),
                            $file2->getError()
                        );
                    }
                }
            }
        }

        return $result;
    }

    /**
     * Convert the size like 4G, 7T, 19B to byte
     * @param string $size
     * @return int
     */
    public static function sizeInBytes(string $size): int
    {
        $value = 1.0;
        $unit = 'B';
        $units = ['B' => 0, 'K' => 1, 'M' => 2, 'G' => 3, 'T' => 4];
        $matches = [];
        preg_match('/(?<size>[\d\.]+)\s*(?<unit>b|k|m|g|t)?/i', $size, $matches);
        if (array_key_exists('unit', $matches)) {
            $unit = strtoupper($matches['unit']);
        }

        if (array_key_exists('size', $matches)) {
            $value = floatval($matches['size']);
        }

        return (int)($value * pow(1024, $units[$unit]));
    }

    /**
     * Format to human readable size
     * @param int $size
     * @param int $precision
     * @return string
     */
    public static function formatSize(int $size, int $precision = 2): string
    {
        if ($size > 0) {
            $base = log($size) / log(1024);
            $suffixes = ['B', 'K', 'M', 'G', 'T'];
            $suffix = '';
            if (isset($suffixes[floor($base)])) {
                $suffix = $suffixes[floor($base)];
            }

            return round(pow(1024, $base - floor($base)), $precision) . $suffix;
        }

        return '';
    }

    /**
     * Move uploadedFile to temporary directory
     * @param UploadedFile $file
     * @param string $tempDir
     * @return void
     */
    protected static function moveUploadedFileToTempDirectory(
        UploadedFile $file,
        string $tempDir
    ): void {
        if (in_array($file->getError(), [UPLOAD_ERR_OK])) {
            $file->moveTo($tempDir);
        }
    }
}