GuestLinksController::index() - Code Metrics - Inspection of "Updated CustomerAdminController.php" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( 1140b1...da16e0 )

by Ron

created 2020-04-09 02:26 UTC

GuestLinksController::index() A

↳ Parent: GuestLinksController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
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;

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

    //  Show the link details for the user
    public function show($id)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by IP Address ' . \Request::ip());

        $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');
        }

        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)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by IP Address '.\Request::ip());
        $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()
        );

        Log::debug('Files gathered for link ID '.$linkID, array($files));
        return $files;
    }

    //  Upload new file
    public function update(Request $request, $id)
    {
        Log::debug('Route '.Route::currentRouteName().' visited by IP Address '.\Request::ip().'. Submitted Data - ', $request->toArray());
        $request->validate([

            'name' => 'required',
            'file' => 'required'
        ]);

        $receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));

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

        //  See if the uploade has finished
        if($save->isFinished())
        {
            $this->saveFile($save->getFile(), $id, $request);
            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('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
        return response()->json([
            '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->comments
        ]);

        Log::info('File uploaded by guest '.\Request::ip().' for file link -'.$details->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.
}
    }

    //  Notify the owner of the link that files were uploaded
    public function notify(Request $request, $id)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by IP Address ' . \Request::ip() . '. Submitted Data - ', $request->toArray());

        $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::info('Notification of file upload sent to '.$user->full_name);
    }
}


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
20			class GuestLinksController extends Controller
21			{
22			// Landing page if no link is sent
23	2		public function index()
24			{
25	2		Log::debug('Route '.Route::currentRouteName().' visited by IP Address '.\Request::ip());
26	2		return view('links.guestIndex');
27			}
28
29			// Show the link details for the user
30	12		public function show($id)
31			{
32	12		Log::debug('Route ' . Route::currentRouteName() . ' visited by IP Address ' . \Request::ip());
33
34	12		$details = FileLinks::where('link_hash', $id)->first();
35
36			// Verify that the link is valid
37	12		if(empty($details))
38			{
39	2		Log::warning('Visitor '.\Request::ip().' visited bad link Hash - '.$id);
40	2		return view('links.guestBadLink');
41			}
42			// Verify that the link has not expired
43	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...
44			{
45	2		Log::warning('Visitor '.\Request::ip().' visited expired link Hash - '.$id);
46	2		return view('links.guestExpiredLink');
47			}
48
49			// Link is valid - determine if the link has files that can be downloaded
50	8		$files = FileLinkFiles::where('link_id', $details->link_id)
51	8		->where('upload', false)
52	8		->count();
53
54	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...
55			{
56	2		Log::warning('Visitor '.\Request::ip().' visited a link that they cannot do anything with. Hash - '.$id);
57	2		return view('links.guestDeadLink');
58			}
59
60	6		return view('links.guestDetails', [
61	6		'hash' => $id,
62	6		'details' => $details,
63	6		'hasFiles' => $files > 0 ? true : false,
64	6		'allowUp' => $details->allow_upload === 'Yes' ? true : false,
65			]);
66			}
67
68			// Get the guest available files for the link
69	6		public function getFiles($id)
70			{
71	6		Log::debug('Route '.Route::currentRouteName().' visited by IP Address '.\Request::ip());
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		Log::debug('Files gathered for link ID '.$linkID, array($files));
83	6		return $files;
84			}
85
86			// Upload new file
87	6		public function update(Request $request, $id)
88			{
89	6		Log::debug('Route '.Route::currentRouteName().' visited by IP Address '.\Request::ip().'. Submitted Data - ', $request->toArray());
90	6		$request->validate([
			0 ignored issues – show Bug introduced 2020-04-09 02:35 UTC by Report Bug Copy Issue Report The call to `validate()` misses a required argument `$...$params`. This check looks for function calls that miss required arguments. Loading history...
91	6		'name' => 'required',
92			'file' => 'required'
93			]);
94
95	6		$receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));
96
97			// Recieve and process the file
98	6		$save = $receiver->receive();
99
100			// See if the uploade has finished
101	6		if($save->isFinished())
102			{
103	6		$this->saveFile($save->getFile(), $id, $request);
104	6		return response()->json(['success' => true]);
			0 ignored issues – show Bug introduced 2020-04-09 02:35 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...
105			}
106
107			// Get the current progress
108			$handler = $save->handler();
109
110			Log::debug('File being uploaded. Percentage done - '.$handler->getPercentageDone());
111			return response()->json([
112			'done' => $handler->getPercentageDone(),
113			'status' => true
114			]);
115			}
116
117			// Save the file in the database
118	6		private function saveFile(UploadedFile $file, $id, $request)
119			{
120	6		$details = FileLinks::where('link_hash', $id)->first();
121	6		$filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$details->link_id;
122
123	6		$fileName = Files::cleanFilename($filePath, $file->getClientOriginalName());
124	6		$file->storeAs($filePath, $fileName);
125
126			// Place file in Files table of DB
127	6		$newFile = Files::create([
			0 ignored issues – show Bug introduced 2020-04-09 02:35 UTC by Report Bug Copy Issue Report The method `create()` does not exist on `App\Files`. Did you maybe mean `created()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
128	6		'file_name' => $fileName,
129	6		'file_link' => $filePath.DIRECTORY_SEPARATOR
130			]);
131	6		$fileID = $newFile->file_id;
132
133			// Place the file in the file link files table of DB
134	6		FileLinkFiles::create([
			0 ignored issues – show Bug introduced 2020-04-09 02:35 UTC by Report Bug Copy Issue Report The method `create()` does not exist on `App\FileLinkFiles`. Did you maybe mean `created()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
135	6		'link_id' => $details->link_id,
136	6		'file_id' => $fileID,
137	6		'added_by' => $request->name,
138	6		'upload' => 1,
139	6		'note' => $request->comments
140			]);
141
142	6		Log::info('File uploaded by guest '.\Request::ip().' for file link -'.$details->link_id);
143	6		return response()->json(['success' => true]);
			0 ignored issues – show Bug introduced 2020-04-09 02:35 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...
144			}
145
146			// Notify the owner of the link that files were uploaded
147	2		public function notify(Request $request, $id)
148			{
149	2		Log::debug('Route ' . Route::currentRouteName() . ' visited by IP Address ' . \Request::ip() . '. Submitted Data - ', $request->toArray());
150
151	2		$request->validate([
			0 ignored issues – show Bug introduced 2020-04-09 02:35 UTC by Report Bug Copy Issue Report The call to `validate()` misses a required argument `$...$params`. This check looks for function calls that miss required arguments. Loading history...
152	2		'_complete' => 'required',
153			'count' => 'required\|integer'
154			]);
155
156	2		$details = FileLinks::where('link_hash', $id)->first();
157	2		$user = User::find($details->user_id);
158	2		Notification::send($user, new NewFileUpload($details));
159
160	2		Log::info('Notification of file upload sent to '.$user->full_name);
161	2		}
162			}
163

butcherman / Tech_Bench

Push — dev5 ( 1140b1...da16e0 )

GuestLinksController::index() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like