UploadMedia::sanitizeFilesOrderParameter() - Code Metrics - Inspection of "Merge branch '0.3' into fix/localized-img-bug" - thinktomorrow/chief - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 0.3 ( bea7df...6843d6 )

by Ben
created 2019-07-25 14:14 UTC
UploadMedia::sanitizeFilesOrderParameter() A

↳ Parent: UploadMedia
Complexity

Conditions	4
Paths	5
Size

Total Lines	17
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	20
Importance

Changes
Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	17
ccs	0
cts	0
cp	0
rs	10
cc	4
nc	5
nop	1
crap	20
<?php

namespace Thinktomorrow\Chief\Media;

use Illuminate\Http\UploadedFile;
use Spatie\MediaLibrary\HasMedia\HasMedia;
use Thinktomorrow\AssetLibrary\Models\Asset;
use Thinktomorrow\AssetLibrary\Models\AssetUploader;

class UploadMedia
{
    /**
     * Upload from base64encoded files, usually
     * coming from slim upload component
     *
     * @param HasMedia $model
     * @param array $files_by_type
     * @param array $files_order_by_type
     */
    public function fromUploadComponent(HasMedia $model, array $files_by_type, array $files_order_by_type)
    {
        $files_by_type = $this->sanitizeFilesParameter($files_by_type);
        $files_order_by_type = $this->sanitizeFilesOrderParameter($files_order_by_type);
        $this->validateParameters($files_by_type, $files_order_by_type);

        // When no files are uploaded, we still would like to sort our assets duh
        if (empty($files_by_type)) {
            foreach($files_order_by_type as $type => $fileIdsCollection){
                $this->sortFiles($model, $type, $fileIdsCollection);
            }

            return;
        }

        foreach ($files_by_type as $type => $files) {

            foreach($files as $locale => $files)

            {
                $this->validateFileUploads($files);

                $fileIdsCollection = $files_order_by_type[$type] ?? [];

                $this->addFiles($model, $type, $files, $fileIdsCollection, $locale);
                $this->replaceFiles($model, $files);
                $this->removeFiles($model, $files);

                $this->sortFiles($model, $type, $fileIdsCollection);
            }
        }
    }

    private function addFile(HasMedia $model, string $type, array &$files_order, $file, $locale = null)
    {
        if (is_string($file)) {
            $image_name = json_decode($file)->output->name;
            $asset      = $this->addAsset(json_decode($file)->output->image, $type, $locale, $image_name, $model);
        } else {
            $image_name = $file->getClientOriginalName();
            $asset      = $this->addAsset($file, $type, $locale, $image_name, $model);
        }

        // New files are passed with their filename (instead of their id)
        // For new files we will replace the filename with the id.
        if (false !== ($key = array_search($image_name, $files_order))) {
            $files_order[$key] = $asset->id;
        }
    }

    /**
     * Note: this is a replication of the AssetTrait::addFile() with the exception
     * that we want to return the asset in order to retrieve the id. This is
     * currently not available via the AssetTrait.
     */
    private function addAsset($file, $type = '', $locale = null, $filename = null, HasMedia $model)
    {
        $filename = $this->sluggifyFilename($filename);

        if (is_string($file)) {
            $asset = AssetUploader::uploadFromBase64($file, $filename);
        } else {
            $asset = AssetUploader::upload($file, $filename);
        }

        if ($asset instanceof Asset) {
            $asset->attachToModel($model, $type, $locale);
        }

        return $asset;
    }

    private function addFiles(HasMedia $model, string $type, array $files, array &$files_order, string $locale = null)
    {
        $this->handleFiles('new', $model, $type, $files, $files_order, $locale);
    }

    /**
     * @param HasMedia $model
     * @param array $files
     */
    private function replaceFiles(HasMedia $model, array $files)
    {
        $this->handleFiles('replace', $model, null, $files, []);
    }

    /**
     * @param HasMedia $model
     * @param array $files
     */
    private function removeFiles(HasMedia $model, array $files)
    {
        $this->handleFiles('delete', $model, null, $files, []);
    }

    private function handleFiles(string $action, HasMedia $model, string $type = null, array $files, array $files_order = [], string $locale = null)
    {
        if (isset($files[$action]) && is_array($files[$action]) && !empty($files[$action])) {
            if($action == 'delete')
            {
                foreach ($model->assets()->whereIn('id', $files[$action])->get() as $asset) {
                    $asset->delete();
                }
            }

            foreach ($files[$action] as $id => $file) {

                if (!$file) {
                    continue;
                }

                if($action == 'new')
                {
                    $this->addFile($model, $type, $files_order, $file, $locale);
                    $this->addFile($model, /** @scrutinizer ignore-type */ $type, $files_order, $file, $locale);
                }elseif($action == 'replace')
                {
                    $asset = AssetUploader::uploadFromBase64(json_decode($file)->output->image, json_decode($file)->output->name);
                    $model->replaceAsset($id, $asset->id);
                }
            }
        }
    }

    /**
     * @param $filename
     * @return string
     */
    private function sluggifyFilename($filename): string
    {
        $extension = substr($filename, strrpos($filename, '.') + 1);
        $filename  = substr($filename, 0, strrpos($filename, '.'));
        $filename  = str_slug($filename) . '.' . $extension;
        $filename  = /** @scrutinizer ignore-deprecated */ str_slug($filename) . '.' . $extension;

        return $filename;
    }

    /**
     * @param $files
     * @throws FileTooBigException
     */
    private function validateFileUploads($files): void
    {
        foreach ($files as $_files) {
            foreach ($_files as $file) {
                if ($file instanceof UploadedFile && !$file->isValid()) {
                    if ($file->getError() == UPLOAD_ERR_INI_SIZE) {
                        throw new FileTooBigException(
filter:
    dependency_paths: ["lib/*"]
                            'Cannot upload file because it exceeded the allowed upload_max_filesize: upload_max_filesize is smaller than post size. ' .
                            'upload_max_filesize: ' . (int)ini_get('upload_max_filesize') . 'MB, ' .
                            'post_max_size: ' . (int)(ini_get('post_max_size')) . 'MB'
                        );
                    }
                }
            }
        }
    }

    private function validateParameters(array $files_by_type, array $files_order_by_type)
    {
        $actions = ['new', 'replace', 'delete'];

        foreach($files_by_type as $type => $files)
        {
            foreach($files as $locale => $_files){
                if(!in_array($locale, config('translatable.locales'))) {
                    throw new \InvalidArgumentException('Corrupt file payload. key is expected to be a valid locale [' . implode(',', config('translatable.locales', [])). ']. Instead [' . $locale . '] is given.');
                }

                if(!is_array($_files)) {
                    throw new \InvalidArgumentException('A valid files entry should be an array of files, key with either [new, replace or delete]. Instead a ' . gettype($_files) . ' is given.');
                }

                foreach($_files as $action => $file) {
                    if(!in_array($action, $actions)) {
                        throw new \InvalidArgumentException('A valid files entry should have a key of either ['.implode(',', $actions).']. Instead ' . $action . ' is given.');
                    }
                }
            }
        }

        foreach($files_order_by_type as $type => $fileIdsCollection)
        {
            foreach($fileIdsCollection as $locale => $commaSeparatedFileIds){

                if(!in_array($locale, config('translatable.locales'))) {
                    throw new \InvalidArgumentException('Corrupt file payload. key for the file order is expected to be a valid locale [' . implode(',', config('translatable.locales', [])). ']. Instead [' . $locale . '] is given.');
                }
            }
        }
    }

    private function sanitizeFilesParameter(array $files_by_type): array
    {
        $defaultLocale = config('app.fallback_locale');

        foreach($files_by_type as $type => $files)
        {
            foreach($files as $locale => $_files){
                if(!in_array($locale, config('translatable.locales'))) {
                    unset($files_by_type[$type][$locale]);

                    if(!isset($files_by_type[$type][$defaultLocale])) {
                        $files_by_type[$type][$defaultLocale] = [];
                    }

                    $files_by_type[$type][$defaultLocale][$locale] = $_files;
                }
            }
        }

        return $files_by_type;
    }

    private function sanitizeFilesOrderParameter(array $files_order_by_type): array
    {
        $defaultLocale = config('app.fallback_locale');

        foreach($files_order_by_type as $type => $fileIdsCollection)
        {
            if(!is_array($fileIdsCollection)) {
                $fileIdsCollection = [$defaultLocale => $fileIdsCollection];
                $files_order_by_type[$type] = $fileIdsCollection;
            }

            foreach($fileIdsCollection as $locale => $commaSeparatedFileIds){
                $files_order_by_type[$type][$locale] = explode(',', $commaSeparatedFileIds);
            }
        }

        return $files_order_by_type;
    }

    private function sortFiles(HasMedia $model, string $type, array $fileIdsCollection)
    {
        $sortedFileIds = [];

        foreach($fileIdsCollection as $locale => $fileIds) {
            $sortedFileIds = array_merge($sortedFileIds, $fileIds);
        }

        $this->sortingAssetsByType($model, $type, $sortedFileIds);
    }

    private function sortingAssetsByType(HasMedia $model, $type, array $sortedAssetIds)
    {
        $assets = $model->assets()->where('asset_pivots.type', $type)->get();

        foreach($assets as $asset)
        {
            $pivot = $asset->pivot;
            $pivot->order = array_search($asset->id, $sortedAssetIds);

            $pivot->save();
        }
    }
}

thinktomorrow / chief

Push — 0.3 ( bea7df...6843d6 )

UploadMedia::sanitizeFilesOrderParameter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
