App\Http\Controllers\FileLinks\FileLinksController

Complexity

Total Complexity

31

Size/Duplication

Total Lines	294
Duplicated Lines	9.52 %

Coupling/Cohesion

Components	2
Dependencies	17

Test Coverage

Coverage

93.62%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	10	10	1
A	index()	0	5	1
A	find()	0	23	3
A	create()	0	5	1
B	store()	0	85	8
A	createLink()	0	24	4
A	saveFile()	0	24	2
A	details()	0	23	2
A	show()	7	7	1
A	update()	0	24	4
A	disableLink()	11	11	1
A	destroy()	0	25	3

<?php

namespace App\Http\Controllers\FileLinks;

use App\Files;
use Carbon\Carbon;
use App\FileLinks;
use App\FileLinkFiles;
use App\CustomerFileTypes;
use Illuminate\Support\Str;
use Illuminate\Http\Request;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use App\Http\Resources\FileLinksCollection;
use App\Http\Resources\CustomerFileTypesCollection;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
// use Pion\Laravel\ChunkUpload\Handler\AbstractHandler;
use App\Http\Resources\FileLinks as FileLinksResource;
use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;

class FileLinksController extends Controller
{
    private $user;

    //  Only authorized users have access
    public function __construct()

This method seems to be duplicated in your project.

    {
        //  Verify the user is logged in and has permissions for this page
        $this->middleware('auth');
        $this->middleware(function($request, $next) {
            $this->user = auth()->user();

The method user does only exist in Illuminate\Contracts\Auth\Guard, but not in Illuminate\Contracts\Auth\Factory.

            $this->authorize('hasAccess', 'use_file_links');
            return $next($request);
        });
    }

    //  Landing page shows all links that the user owns
    public function index()
    {
        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return view('links.index');
    }

    //  Ajax call to show the links for a specific user
    public function find($id)
    {
        Log::debug(Auth::user()->user_id.' - '.$id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        //  Verify if the user is trying to pull their own links
        if($id == 0)
        {
            $id = Auth::user()->user_id;

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

Consider using a different name than the parameter $id. This often makes code more readable.

        }
        //  If the user is trying to pull someone elses links, they must be able to manage users
        else if ($id != Auth::user()->user_id)

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        {
            $this->authorize('hasAccess', 'manage_users');
        }

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        $links = new FileLinksCollection(
            FileLinks::where('user_id', $id)
                ->withCount('FileLinkFiles')
                ->orderBy('expire', 'desc')->get()
        );

        return $links;
    }

    //  Create a new file link form
    public function create()
    {
        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return view('links.newLink');
    }

    //  Submit the new file link form
    public function store(Request $request)
    {
        $request->validate([
            'name'       => 'required',
            'expire'     => 'required',
            'customerID' => 'exists:customers,cust_id|nullable'
        ]);

        if(!empty($request->file))
        {
            $receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));

            //  Verify that the upload is valid and being processed
            if($receiver->isUploaded() === false)
            {
                Log::error('Upload File Missing - ' .
                /** @scrutinizer ignore-type */
                $request->toArray());
                throw new UploadMissingFileException();
            }

            //  Recieve and process the file
            $save = $receiver->receive();

            //  See if the uploade has finished
            if($save->isFinished())
            {
                $this->saveFile($save->getFile());

                return 'uploaded successfully';
            }

            //  Get the current progress
            $handler = $save->handler();

            Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
            return response()->json([

The method json does only exist in Illuminate\Contracts\Routing\ResponseFactory, but not in Illuminate\Http\Response.

                'done'   => $handler->getPercentageDone(),
                'status' => true
            ]);
        }

        //  If there are no files being uploaded or the file uploade process is done
        if(isset($request->_completed) && $request->_completed)
        {
            Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            Log::debug('Link data submitted.  Data - ',
            /** @scrutinizer ignore-type */
            $request->toArray());
            $linkID = $this->createLink($request);
            if($request->session()->has('newLinkFile'))
            {
                //  If there were files uploaded to the link, process them
                $files = session('newLinkFile');
                $path = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$linkID;

                foreach($files as $file)
                {
                    $data = Files::find($file);
                    //  Move the file to the proper folder
                    Storage::move($data->file_link.$data->file_name, $path.DIRECTORY_SEPARATOR.$data->file_name);
                    //  Update file link in DB
                    $data->update([
                        'file_link' => $path.DIRECTORY_SEPARATOR
                    ]);
                    //  Attach file to the link
                    FileLinkFiles::create([
                        'link_id' => $linkID,
                        'file_id' => $data->file_id,
                        'user_id' => Auth::user()->user_id,

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

                        'upload' => 0
                    ]);

                    Log::debug('File Added for link ID-'.$linkID.'.  File ID-'.$data->file_id);
                }

                $request->session()->forget('newLinkFile');

The method forget() does not seem to exist on object<Symfony\Component\HttpFoundation\Session\SessionInterface>.

            }

            return response()->json(['link' => $linkID, 'name' => Str::slug($request->name)]);
        }

        return response()->json(['complete' => false]);
    }

    //  Create the new file link
    private function createLink($data)
    {
        //  Generate a random hash to use as the file link and make sure it is not already in use
        do
        {
            $hash = strtolower(Str::random(15));
            $dup  = FileLinks::where('link_hash', $hash)->get()->count();
        } while($dup != 0);

        //  Create the new file link
        $link = FileLinks::create([
            'user_id'      => Auth::user()->user_id,

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            'cust_id'      => $data->customerID,
            'link_hash'    => $hash,
            'link_name'    => $data->name,
            'expire'       => $data->expire,
            'allow_upload' => isset($data->allowUp) && $data->allowUp ? true : false,
            'note'         => $data->note
        ]);

        Log::info('File Link Created for User ID-'.Auth::user()->user_id.'.  Link ID-'.$link->link_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return $link->link_id;
    }

    //  Save a file attached to the link
    private function saveFile(UploadedFile $file)
    {
        $filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.'_tmp';

        //  Clean the file and store it
        $fileName = Files::cleanFilename($filePath, $file->getClientOriginalName());
        $file->storeAs($filePath, $fileName);

        //  Place file in Files table of DB
        $newFile = Files::create([
            'file_name' => $fileName,
            'file_link' => $filePath.DIRECTORY_SEPARATOR
        ]);
        $fileID = $newFile->file_id;

        //  Save the file ID in the session array
        $fileArr = session('newLinkFile') != null ? session('newLinkFile') : [];
        $fileArr[] = $fileID;
        session(['newLinkFile' => $fileArr]);

        //  Log stored file
        Log::info('File Stored', ['file_id' => $fileID, 'file_path' => $filePath.DIRECTORY_SEPARATOR.$fileName]);
        return $fileID;
    }

    //  Show details about a file link
    public function details($id, /** @scrutinizer ignore-unused */ $name)

The parameter $name is not used and could be removed.

    {
        //  Verify that the link is a valid link
        $linkData = FileLinks::find($id);
        $fileTypes = new CustomerFileTypesCollection(CustomerFileTypes::all());

        //  If the link is invalid, return an error page
        if(empty($linkData))
        {
            Log::warning('User tried to view bad file link', ['user_id' => Auth::user()->user_id, 'link_id' => $id]);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            return view('links.badLink');
        }

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        Log::debug('Link Detials - ',
        /** @scrutinizer ignore-type */
        $linkData->toArray());
        return view('links.details', [
            'link_id'    => $linkData->link_id,
            'cust_id'    => $linkData->cust_id,
            'file_types' => $fileTypes
        ]);
    }

    //  Ajax call te get JSON details of the link
    public function show($id)

This method seems to be duplicated in your project.

    {
        $linkData = new FileLinksResource(FileLinks::find($id));

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return $linkData;
    }

    //  Update the link's details
    public function update(Request $request, $id)
    {
        $request->validate([
            'name'       => 'required',
            'expire'     => 'required',
            'customerTag' => 'exists:customers,cust_id|nullable'
        ]);

        FileLinks::find($id)->update([
            'link_name'    => $request->name,
            'expire'       => $request->expire,
            'allow_upload' => isset($request->allowUpload) && $request->allowUpload ? true : false,
            'cust_id'      => $request->customerTag,
            'note'         => $request->hasInstructions ? $request->instructions : null
        ]);

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        Log::debug('Updated Link Data for link ID-'.$id,
        /** @scrutinizer ignore-type */
        $request->toArray());
        Log::info('File Link Updated', ['link_id' => $id]);

        return response()->json(['success' => true]);

The method json does only exist in Illuminate\Contracts\Routing\ResponseFactory, but not in Illuminate\Http\Response.

    }

    //  Disable a file linke, but do not remove it (set the expire date to a previous date)
    public function disableLink($id)

This method seems to be duplicated in your project.

    {
        //  update the expire date for the link
        FileLinks::find($id)->update([
            'expire' => Carbon::yesterday()
        ]);

        Log::info('User ID '.Auth::user()->user_id.' disabled link ID - '.$id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return response()->json(['success' => true]);

The method json does only exist in Illuminate\Contracts\Routing\ResponseFactory, but not in Illuminate\Http\Response.

    }

    //  Delete a file link
    public function destroy($id)
    {
        //  Remove the file from database
        $data = FileLinkFiles::where('link_id', $id)->get();
        if(!$data->isEmpty())
        {
            foreach($data as $file)
            {
                $fileID = $file->file_id;
                $file->delete();

                //  Delete the file if it is no longer in use
                Files::deleteFile($fileID);
            }
        }

        FileLinks::find($id)->delete();

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        Log::info('File link deleted', ['link_id' => $id, 'user_id' => Auth::user()->user_id]);

Accessing user_id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        return response()->json([

The method json does only exist in Illuminate\Contracts\Routing\ResponseFactory, but not in Illuminate\Http\Response.

            'success' => true
        ]);
    }
}