App\Domains\Files\SetFiles

Complexity

Total Complexity

14

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Test Coverage

Coverage

63.46%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	saveFile()	0	10	2
A	getChunk()	0	11	2
A	deleteFile()	0	22	2
A	__construct()	0	4	1
A	cleanFilename()	0	3	1
A	addDatabaseRow()	0	8	1
A	moveFile()	0	13	1
A	checkForDuplicate()	0	16	4

<?php

namespace App\Domains\Files;

use App\Files;

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Storage;

use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;

class SetFiles
{
    protected $path, $disk;

    //  Constructor will set the default path for files to be stored
    public function __construct()
    {
        $this->path = config('filesystems.paths.default');
        $this->disk = 'local';
    }

    //  Process a single chunk of a larger file
    protected function getChunk($request)
    {
        $receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));
        $save = $receiver->receive();

        if($save->isFinished())
        {
            return $this->saveFile($save->getFile());
        }

        return false;
    }

    //  Save the file to the storage system
    protected function saveFile(UploadedFile $file)
    {
        $fileName = $this->cleanFilename($file->getClientOriginalName());
        $fileName = $this->checkForDuplicate($fileName);

        $file->storeAs($this->path, $fileName);
        $user = isset(Auth::user()->full_name) ? Auth::user()->full_name : \Request::ip();
        Log::info('New file '.$fileName.' stored in location - '.$this->path.' by '.$user);

        return $fileName;
    }

    //  Delete a file from the database and file system - note will fail if the file is linked in the database
    protected function deleteFile($fileID)
    {
        $fileData = Files::find($fileID);
        $fileLink = $fileData->file_link.$fileData->file_name;

        try
        {
            //  Try to delete file from database - will throw error if foreign key is in use
            $fileData->delete();
        }
        catch(\Illuminate\Database\QueryException $e)
        {
            //  Unable to remove file from the database
            Log::warning('Attempt to delete file failed.  Reason - '.$e.'. Additional File Data - ', ['file_id' => $fileID, 'file_name' => $fileLink]);
            return false;
        }

        //  Delete the file from the storage system
        Storage::delete($fileLink);

        Log::notice('File deleted. File Information - ', ['file_id' => $fileID, 'file_name' => $fileLink]);
        return true;
    }

    //  Move a file from one folder to another
    protected function moveFile($fileID, $newPath)
    {
        $this->path = $newPath;
        $file    = Files::find($fileID);
        $newName = $this->checkForDuplicate($file->file_name);

        Storage::move($file->file_link.$file->file_name, $newPath.$file->file_name);
        $file->update([
            'file_link' => $newPath,
            'file_name' => $newName,
        ]);

        return true;
    }

    //  Add the new file to the database
    protected function addDatabaseRow($filename, $path)
    {
        $file = Files::create([
            'file_name' => $filename,
            'file_link' => $path.DIRECTORY_SEPARATOR,
        ]);

        return $file->file_id;
    }

    //  Sanitize the filename to remove any illegal characters and spaces
    protected function cleanFilename($name)
    {
        return preg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $name);
    }

    //  Check to see if the file already exists, if so append filename as needed
    protected function checkForDuplicate($name)
    {
        if(Storage::disk($this->disk)->exists($this->path.DIRECTORY_SEPARATOR.$name))
        {
            $parts = pathinfo($name);
            $ext   = isset($parts['extension']) ? ('.'.$parts['extension']) : '';
            $base = $parts['filename'];
             $number = 0;

            do
            {
                $name = $base.'('.++$number.')'.$ext;
            } while(Storage::disk($this->disk)->exists($this->path.DIRECTORY_SEPARATOR.$name));
        }

        return $name;
    }
}