GuestLinksController::getFiles() - 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

GuestLinksController::getFiles() A

↳ Parent: GuestLinksController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	9
cts	9
cp	1
rs	9.7998
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

namespace App\Http\Controllers\FileLinks;

use App\User;
use App\Files;
use App\FileLinks;
use App\FileLinkFiles;
use Illuminate\Http\Request;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Log;
use App\Notifications\NewFileUpload;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Notification;
use App\Http\Resources\FileLinkFilesCollection;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;

class GuestLinksController extends Controller
{
    //  Landing page if no link is sent
    public function index()
    {
        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
        return view('links.guestIndex');
    }

    //  Show the link details for the user
    public function show($id)
    {
        $details = FileLinks::where('link_hash', $id)->first();

        //  Verify that the link is valid
        if(empty($details))
        {
            Log::warning('Visitor '.\Request::ip().' visited bad link Hash - '.$id);
            return view('links.guestBadLink');
        }
        //  Verify that the link has not expired
        else if($details->expire <= date('Y-m-d'))

        {
            Log::warning('Visitor '.\Request::ip().' visited expired link Hash - '.$id);
            return view('links.guestExpiredLink');
        }

        //  Link is valid - determine if the link has files that can be downloaded
        $files = FileLinkFiles::where('link_id', $details->link_id)
            ->where('upload', false)
            ->count();

        if($files == 0 && $details->allow_upload === 'No')

        {
            Log::warning('Visitor ' . \Request::ip() . ' visited a link that they cannot do anything with.  Hash - ' . $id);
            return view('links.guestDeadLink');
        }

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
        Log::debug('Link Hash-'.$id);
        return view('links.guestDetails', [
            'hash'    => $id,
            'details' => $details,
            'hasFiles' => $files > 0 ? true : false,
            'allowUp' => $details->allow_upload === 'Yes' ? true : false,
        ]);
    }

    //  Get the guest available files for the link
    public function getFiles($id)
    {
        $linkID = FileLinks::where('link_hash', $id)->first()->link_id;

        $files = new FileLinkFilesCollection(
            FileLinkFiles::where('link_id', $linkID)
                ->where('upload', 0)
                ->orderBy('created_at', 'ASC')
                ->with('Files')
                ->get()
        );

        return $files;
    }

    //  Upload new file
    public function update(Request $request, $id)
    {
        $request->validate(['name' => 'required', 'file' => 'required']);

        $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 - '.$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(), $id, $request);

            return 'uploaded successfully';
        }

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

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
        Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
        return response()->json([
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.
}
            'done'   => $handler->getPercentageDone(),
            'status' => true
        ]);
    }

    //  Save the file in the database
    private function saveFile(UploadedFile $file, $id, $request)
    {
        $details = FileLinks::where('link_hash', $id)->first();
        $filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$details->link_id;

        $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'  => $details->link_id,
            'file_id'  => $fileID,
            'added_by' => $request->name,
            'upload'   => 1,
            'note'     => $request->note
        ]);

        Log::info('File uploaded by guest '.\Request::ip().' for file link -'.$details->link_id);
        Log::debug('File Data -', $request->toArray());

        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.
}
    }

    //  Notify the owner of the link that files were uploaded
    public function notify(Request $request, $id)
    {
        $request->validate([
            '_complete' => 'required',
            'count'     => 'required|integer'
        ]);

        $details = FileLinks::where('link_hash', $id)->first();

        $user = User::find($details->user_id);
        Notification::send($user, new NewFileUpload($details));

        Log::debug('Notification of file upload sent to User ID - '.$user->user_id);
    }
}


1			<?php
2
3			namespace App\Http\Controllers\FileLinks;
4
5			use App\User;
6			use App\Files;
7			use App\FileLinks;
8			use App\FileLinkFiles;
9			use Illuminate\Http\Request;
10			use Illuminate\Http\UploadedFile;
11			use Illuminate\Support\Facades\Log;
12			use App\Notifications\NewFileUpload;
13			use App\Http\Controllers\Controller;
14			use Illuminate\Support\Facades\Route;
15			use Illuminate\Support\Facades\Notification;
16			use App\Http\Resources\FileLinkFilesCollection;
17			use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
18			use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
19			use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;
20
21			class GuestLinksController extends Controller
22			{
23			// Landing page if no link is sent
24	2		public function index()
25			{
26	2		Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
27	2		return view('links.guestIndex');
28			}
29
30			// Show the link details for the user
31	12		public function show($id)
32			{
33	12		$details = FileLinks::where('link_hash', $id)->first();
34
35			// Verify that the link is valid
36	12		if(empty($details))
37			{
38	2		Log::warning('Visitor '.\Request::ip().' visited bad link Hash - '.$id);
39	2		return view('links.guestBadLink');
40			}
41			// Verify that the link has not expired
42	10	View Code Duplication	else if($details->expire <= date('Y-m-d'))
			0 ignored issues – show Duplication introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
43			{
44	2		Log::warning('Visitor '.\Request::ip().' visited expired link Hash - '.$id);
45	2		return view('links.guestExpiredLink');
46			}
47
48			// Link is valid - determine if the link has files that can be downloaded
49	8		$files = FileLinkFiles::where('link_id', $details->link_id)
50	8		->where('upload', false)
51	8		->count();
52
53	8	View Code Duplication	if($files == 0 && $details->allow_upload === 'No')
			0 ignored issues – show Duplication introduced 2019-11-09 04:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
54			{
55	2		Log::warning('Visitor ' . \Request::ip() . ' visited a link that they cannot do anything with. Hash - ' . $id);
56	2		return view('links.guestDeadLink');
57			}
58
59	6		Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
60	6		Log::debug('Link Hash-'.$id);
61	6		return view('links.guestDetails', [
62	6		'hash' => $id,
63	6		'details' => $details,
64	6		'hasFiles' => $files > 0 ? true : false,
65	6		'allowUp' => $details->allow_upload === 'Yes' ? true : false,
66			]);
67			}
68
69			// Get the guest available files for the link
70	6		public function getFiles($id)
71			{
72	6		$linkID = FileLinks::where('link_hash', $id)->first()->link_id;
73
74	6		$files = new FileLinkFilesCollection(
75	6		FileLinkFiles::where('link_id', $linkID)
76	6		->where('upload', 0)
77	6		->orderBy('created_at', 'ASC')
78	6		->with('Files')
79	6		->get()
80			);
81
82	6		return $files;
83			}
84
85			// Upload new file
86	6		public function update(Request $request, $id)
87			{
88	6		$request->validate(['name' => 'required', 'file' => 'required']);
89
90	6		$receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));
91
92			// Verify that the upload is valid and being processed
93	6		if($receiver->isUploaded() === false)
94			{
95			Log::error('Upload File Missing - '.$request->toArray());
96			throw new UploadMissingFileException();
97			}
98
99			// Recieve and process the file
100	6		$save = $receiver->receive();
101
102			// See if the uploade has finished
103	6		if($save->isFinished())
104			{
105	6		$this->saveFile($save->getFile(), $id, $request);
106
107	6		return 'uploaded successfully';
108			}
109
110			// Get the current progress
111			$handler = $save->handler();
112
113			Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.\Request::ip());
114			Log::debug('File being uploaded. Percentage done - '.$handler->getPercentageDone());
115			return response()->json([
			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...
116			'done' => $handler->getPercentageDone(),
117			'status' => true
118			]);
119			}
120
121			// Save the file in the database
122	6		private function saveFile(UploadedFile $file, $id, $request)
123			{
124	6		$details = FileLinks::where('link_hash', $id)->first();
125	6		$filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$details->link_id;
126
127	6		$fileName = Files::cleanFilename($filePath, $file->getClientOriginalName());
128	6		$file->storeAs($filePath, $fileName);
129
130			// Place file in Files table of DB
131	6		$newFile = Files::create([
132	6		'file_name' => $fileName,
133	6		'file_link' => $filePath.DIRECTORY_SEPARATOR
134			]);
135	6		$fileID = $newFile->file_id;
136
137			// Place the file in the file link files table of DB
138	6		FileLinkFiles::create([
139	6		'link_id' => $details->link_id,
140	6		'file_id' => $fileID,
141	6		'added_by' => $request->name,
142	6		'upload' => 1,
143	6		'note' => $request->note
144			]);
145
146	6		Log::info('File uploaded by guest '.\Request::ip().' for file link -'.$details->link_id);
147	6		Log::debug('File Data -', $request->toArray());
148
149	6		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...
150			}
151
152			// Notify the owner of the link that files were uploaded
153	2		public function notify(Request $request, $id)
154			{
155	2		$request->validate([
156	2		'_complete' => 'required',
157			'count' => 'required\|integer'
158			]);
159
160	2		$details = FileLinks::where('link_hash', $id)->first();
161
162	2		$user = User::find($details->user_id);
163	2		Notification::send($user, new NewFileUpload($details));
164
165	2		Log::debug('Notification of file upload sent to User ID - '.$user->user_id);
166	2		}
167			}
168

butcherman / Tech_Bench

Push — dev5 ( b08d9a...c43caf )

GuestLinksController::getFiles() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like