LinkFilesController::store() - Code Metrics - Inspection of "Corrected 'use' paths to correct case" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( b08d9a...c43caf )

by Ron

created 2019-11-09 04:12 UTC

LinkFilesController::store() B

↳ Parent: LinkFilesController

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	22
CRAP Score	3.1707

Importance

Changes

Metric	Value
dl	0
loc	61
ccs	22
cts	30
cp	0.7332
rs	8.8509
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3.1707

How to fix Long Method

<?php

namespace App\Http\Controllers\FileLinks;

use App\Files;
use App\FileLinks;
use App\FileLinkFiles;
use App\CustomerFiles;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use App\Http\Resources\FileLinkFilesCollection;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;

class LinkFilesController extends Controller
{
    private $user;

    public function __construct()

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

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $this->authorize('hasAccess', 'use_file_links');
            return $next($request);
        });
    }

    //  Add a file to the file link
    public function store(Request $request)
    {
        $request->validate([
            'linkID' => 'required|exists:file_links,link_id'
        ]);

        $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())
        {
            $filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$request->linkID;
            $file = $save->getFile();

            //  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;

            //  Place the file in the file link files table of DB
            FileLinkFiles::create([
                'link_id'  => $request->linkID,
                'file_id'  => $fileID,
                'user_id'  => Auth::user()->user_id,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                'upload'   => 0
            ]);

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

            return response()->json(['success' => true]); ;
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

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

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
        return response()->json([
            'done'   => $handler->getPercentageDone(),
            'status' => true
        ]);
    }

    //  Show the files attached to a link
    public function show($id)
    {
        $files = new FileLinkFilesCollection(
            FileLinkFiles::where('link_id', $id)
            ->orderBy('user_id', 'ASC')
            ->orderBy('created_at', 'ASC')
            ->with('Files')
            ->with('User')
            ->get()
        );

        return $files;
    }

    //  Move a file to a customer file
    public function update(Request $request, $id)
    {
        $request->validate([
            'fileID'   => 'required',
            'fileName' => 'required',
            'fileType' => 'required'
        ]);

        $linkData = FileLinks::find($id);

        $newPath = config('filesystems.paths.customers').DIRECTORY_SEPARATOR.$linkData->cust_id.DIRECTORY_SEPARATOR;
        $fileData = Files::find($request->fileID);

        //  Verify that the file does not already exist in the customerdata or file
        $dup = CustomerFiles::where('file_id', $request->fileID)->where('cust_id', $linkData->cust_id)->count();
        if($dup || Storage::exists($newPath.$fileData->file_name))
        {
            return response()->json(['success' => 'false', 'reason' => 'This File Already Exists in Customer Files']);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        //  Move the file to the customrs file folder
        try
        {
            Storage::move($fileData->file_link.$fileData->file_name, $newPath.$fileData->file_name);
        }
        catch(\Exception $e)
        {
            report($e);
            return response()->json(['success' => false, 'reason' => 'Cannot Find File']);
        }

        //  Update the file path in the database
        $fileData->update([
            'file_link' => $newPath
        ]);

        //  Place the file in the customer database
        CustomerFiles::create([
            'file_id'      => $request->fileID,
            'file_type_id' => $request->fileType,
            'cust_id'      => $linkData->cust_id,
            'user_id'      => Auth::user()->user_id,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            'name'         => $request->fileName
        ]);

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        Log::debug('File Data - ', $request->toArray());
        Log::info('File ID-'.$request->fileId.' moved to customer ID-'.$linkData->cust_id.' for link ID-'.$id);
        return response()->json(['success' => true]);
    }

    //  Delete a file attached to a link
    public function destroy($id)

    {
        //  Get the necessary file information and delete it from the database
        $fileData = FileLinkFiles::find($id);
        $fileID   = $fileData->file_id;
        $fileData->delete();

        //  Delete the file from the folder (not, will not delete if in use elsewhere)
        Files::deleteFile($fileID);

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        Log::info('File ID-'.$fileData->file_id.' deleted for Link ID-'.$fileData->link_id);
        return response()->json(['success' => true]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }
}


1			<?php
2
3			namespace App\Http\Controllers\FileLinks;
4
5			use App\Files;
6			use App\FileLinks;
7			use App\FileLinkFiles;
8			use App\CustomerFiles;
9			use Illuminate\Http\Request;
10			use Illuminate\Support\Facades\Log;
11			use App\Http\Controllers\Controller;
12			use Illuminate\Support\Facades\Auth;
13			use Illuminate\Support\Facades\Route;
14			use Illuminate\Support\Facades\Storage;
15			use App\Http\Resources\FileLinkFilesCollection;
16			use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
17			use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
18			use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;
19
20			class LinkFilesController extends Controller
21			{
22			private $user;
23
24	22	View Code Duplication	public function __construct()
			0 ignored issues – show Duplication introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
25			{
26			// Verify the user is logged in and has permissions for this page
27	22		$this->middleware('auth');
28			$this->middleware(function($request, $next) {
29	16		$this->user = auth()->user();
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report The method `user` does only exist in `Illuminate\Contracts\Auth\Guard`, but not in `Illuminate\Contracts\Auth\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
30	16		$this->authorize('hasAccess', 'use_file_links');
31	10		return $next($request);
32	22		});
33	22		}
34
35			// Add a file to the file link
36	2		public function store(Request $request)
37			{
38	2		$request->validate([
39	2		'linkID' => 'required\|exists:file_links,link_id'
40			]);
41
42	2		$receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));
43
44			// Verify that the upload is valid and being processed
45	2		if($receiver->isUploaded() === false)
46			{
47			Log::error('Upload File Missing - ' .
48			/** @scrutinizer ignore-type */
49			$request->toArray());
50			throw new UploadMissingFileException();
51			}
52
53			// Recieve and process the file
54	2		$save = $receiver->receive();
55
56			// See if the uploade has finished
57	2		if($save->isFinished())
58			{
59	2		$filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$request->linkID;
60	2		$file = $save->getFile();
61
62			// Clean the file and store it
63	2		$fileName = Files::cleanFilename($filePath, $file->getClientOriginalName());
64	2		$file->storeAs($filePath, $fileName);
65
66			// Place file in Files table of DB
67	2		$newFile = Files::create([
68	2		'file_name' => $fileName,
69	2		'file_link' => $filePath.DIRECTORY_SEPARATOR
70			]);
71	2		$fileID = $newFile->file_id;
72
73			// Place the file in the file link files table of DB
74	2		FileLinkFiles::create([
75	2		'link_id' => $request->linkID,
76	2		'file_id' => $fileID,
77	2		'user_id' => Auth::user()->user_id,
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
78	2		'upload' => 0
79			]);
80
81			// Log stored file
82	2		Log::info('File Stored', ['file_id' => $fileID, 'file_path' => $filePath.DIRECTORY_SEPARATOR.$fileName]);
83
84	2		return response()->json(['success' => true]); ;
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
85			}
86
87			// Get the current progress
88			$handler = $save->handler();
89
90			Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
91			Log::debug('File being uploaded. Percentage done - '.$handler->getPercentageDone());
92			return response()->json([
93			'done' => $handler->getPercentageDone(),
94			'status' => true
95			]);
96			}
97
98			// Show the files attached to a link
99	2		public function show($id)
100			{
101	2		$files = new FileLinkFilesCollection(
102	2		FileLinkFiles::where('link_id', $id)
103	2		->orderBy('user_id', 'ASC')
104	2		->orderBy('created_at', 'ASC')
105	2		->with('Files')
106	2		->with('User')
107	2		->get()
108			);
109
110	2		return $files;
111			}
112
113			// Move a file to a customer file
114	4		public function update(Request $request, $id)
115			{
116	4		$request->validate([
117	4		'fileID' => 'required',
118			'fileName' => 'required',
119			'fileType' => 'required'
120			]);
121
122	4		$linkData = FileLinks::find($id);
123
124	4		$newPath = config('filesystems.paths.customers').DIRECTORY_SEPARATOR.$linkData->cust_id.DIRECTORY_SEPARATOR;
125	4		$fileData = Files::find($request->fileID);
126
127			// Verify that the file does not already exist in the customerdata or file
128	4		$dup = CustomerFiles::where('file_id', $request->fileID)->where('cust_id', $linkData->cust_id)->count();
129	4		if($dup \|\| Storage::exists($newPath.$fileData->file_name))
130			{
131	2		return response()->json(['success' => 'false', 'reason' => 'This File Already Exists in Customer Files']);
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
132			}
133
134			// Move the file to the customrs file folder
135			try
136			{
137	4		Storage::move($fileData->file_link.$fileData->file_name, $newPath.$fileData->file_name);
138			}
139	2		catch(\Exception $e)
140			{
141	2		report($e);
142	2		return response()->json(['success' => false, 'reason' => 'Cannot Find File']);
143			}
144
145			// Update the file path in the database
146	2		$fileData->update([
147	2		'file_link' => $newPath
148			]);
149
150			// Place the file in the customer database
151	2		CustomerFiles::create([
152	2		'file_id' => $request->fileID,
153	2		'file_type_id' => $request->fileType,
154	2		'cust_id' => $linkData->cust_id,
155	2		'user_id' => Auth::user()->user_id,
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
156	2		'name' => $request->fileName
157			]);
158
159	2		Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
160	2		Log::debug('File Data - ', $request->toArray());
161	2		Log::info('File ID-'.$request->fileId.' moved to customer ID-'.$linkData->cust_id.' for link ID-'.$id);
162	2		return response()->json(['success' => true]);
163			}
164
165			// Delete a file attached to a link
166	2	View Code Duplication	public function destroy($id)
			0 ignored issues – show Duplication introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
167			{
168			// Get the necessary file information and delete it from the database
169	2		$fileData = FileLinkFiles::find($id);
170	2		$fileID = $fileData->file_id;
171	2		$fileData->delete();
172
173			// Delete the file from the folder (not, will not delete if in use elsewhere)
174	2		Files::deleteFile($fileID);
175
176	2		Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
177	2		Log::info('File ID-'.$fileData->file_id.' deleted for Link ID-'.$fileData->link_id);
178	2		return response()->json(['success' => true]);
			0 ignored issues – show Bug introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
179			}
180			}
181

butcherman / Tech_Bench

Push — dev5 ( b08d9a...c43caf )

LinkFilesController::store() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like