FileLinksController::store() - Code Metrics - Inspection of "Increased debug logging" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( 1c1697...6a3ae7 )

by Ron

created 2020-03-31 23:37 UTC

FileLinksController::store() B

↳ Parent: FileLinksController

Complexity

Conditions	7
Paths	5

Size

Total Lines	71
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	28
CRAP Score	7.1703

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	35
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	71
ccs	28
cts	33
cp	0.8485
crap	7.1703
rs	8.4266

How to fix Long Method

<?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 App\Http\Resources\FileLinks as FileLinksResource;

class FileLinksController extends Controller
{
    private $user;

    //  Only authorized users have access
    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();
            $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 '.Auth::user()->full_name);
        return view('links.index');
    }

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

        //  Verify if the user is trying to pull their own links
        if($id == 0)
        {
            $id = Auth::user()->user_id;
        }
        //  If the user is trying to pull someone elses links, they must be able to manage users
        else if ($id != Auth::user()->user_id)
        {
            $this->authorize('hasAccess', 'manage_users');
        }

        $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 ' . Auth::user()->full_name);
        return view('links.newLink');
    }

    //  Submit the new file link form
    public function store(Request $request)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $request->toArray());

        $request->validate([
            'name'       => 'required',
            'expire'     => 'required',
            'customerID' => 'exists:customers,cust_id|nullable'
        ]);

        if(!empty($request->file))
        {
            $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());
                return 'uploaded successfully';
            }

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

            Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
            return response()->json([
                '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)
        {
            $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,
                        'upload' => 0
                    ]);

                    Log::info('File Added for link ID - '.$linkID.' by '.Auth::user()->full_name.'.  File ID-'.$data->file_id);
                }

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

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

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

    //  Create the new file link
    private function createLink($data)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $data->toArray());

        //  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,
            '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 '.Auth::user()->full_name.'.  Link ID-'.$link->link_id);

        return $link->link_id;
    }

    //  Save a file attached to the link
    private function saveFile(UploadedFile $file)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);

        $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 by '.Auth::user()->user_id, ['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)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);

        //  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 '.Auth::user()->full_name.' tried to view bad file link', ['user_id' => Auth::user()->user_id, 'link_id' => $id]);
            return view('links.badLink');
        }

        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)
    {
        $linkData = new FileLinksResource(FileLinks::find($id));

        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
        return $linkData;
    }

    //  Update the link's details
    public function update(Request $request, $id)
    {
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $request->toArray());

        $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::info('File Link Updated by '.Auth::user()->full_name, ['link_id' => $id]);

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

    //  Disable a file linke, but do not remove it (set the expire date to a previous date)
    public function disableLink($id)
    {
        //  update the expire date for the link
        FileLinks::find($id)->update([
            'expire' => Carbon::yesterday()
        ]);

        Log::info('User '.Auth::user()->full_name.' disabled link ID - '.$id);
        Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
        return response()->json(['success' => true]);
    }

    //  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 ' . Auth::user()->full_name);
        Log::info('File link deleted by '.Auth::user()->full_name, ['link_id' => $id, 'user_id' => Auth::user()->user_id]);

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


1		<?php
2
3		namespace App\Http\Controllers\FileLinks;
4
5		use App\Files;
6		use Carbon\Carbon;
7		use App\FileLinks;
8		use App\FileLinkFiles;
9		use App\CustomerFileTypes;
10		use Illuminate\Support\Str;
11		use Illuminate\Http\Request;
12		use Illuminate\Http\UploadedFile;
13		use Illuminate\Support\Facades\Log;
14		use Illuminate\Support\Facades\Auth;
15		use App\Http\Controllers\Controller;
16		use Illuminate\Support\Facades\Route;
17		use Illuminate\Support\Facades\Storage;
18		use App\Http\Resources\FileLinksCollection;
19		use App\Http\Resources\CustomerFileTypesCollection;
20		use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
21		use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
22		use App\Http\Resources\FileLinks as FileLinksResource;
23
24		class FileLinksController extends Controller
25		{
26		private $user;
27
28		// Only authorized users have access
29	76	public function __construct()
30		{
31		// Verify the user is logged in and has permissions for this page
32	76	$this->middleware('auth');
33		$this->middleware(function($request, $next) {
34	58	$this->user = auth()->user();
35	58	$this->authorize('hasAccess', 'Use File Links');
36	40	return $next($request);
37	76	});
38	76	}
39
40		// Landing page shows all links that the user owns
41	2	public function index()
42		{
43	2	Log::debug('Route '.Route::currentRouteName().' visited by '.Auth::user()->full_name);
44	2	return view('links.index');
45		}
46
47		// Ajax call to show the links for a specific user
48	8	public function find($id)
49		{
50	8	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
51
52		// Verify if the user is trying to pull their own links
53	8	if($id == 0)
54		{
55	2	$id = Auth::user()->user_id;
56		}
57		// If the user is trying to pull someone elses links, they must be able to manage users
58	6	else if ($id != Auth::user()->user_id)
59		{
60	4	$this->authorize('hasAccess', 'manage_users');
61		}
62
63	6	$links = new FileLinksCollection(
64	6	FileLinks::where('user_id', $id)
65	6	->withCount('FileLinkFiles')
66	6	->orderBy('expire', 'desc')->get()
67		);
68
69	6	return $links;
70		}
71
72		// Create a new file link form
73	2	public function create()
74		{
75	2	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
76	2	return view('links.newLink');
77		}
78
79		// Submit the new file link form
80	12	public function store(Request $request)
81		{
82	12	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $request->toArray());
83
84	12	$request->validate([
85	12	'name' => 'required',
86		'expire' => 'required',
87		'customerID' => 'exists:customers,cust_id\|nullable'
88		]);
89
90	8	if(!empty($request->file))
91		{
92	2	$receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));
93
94		// Recieve and process the file
95	2	$save = $receiver->receive();
96
97		// See if the uploade has finished
98	2	if($save->isFinished())
99		{
100	2	$this->saveFile($save->getFile());
101	2	return 'uploaded successfully';
102		}
103
104		// Get the current progress
105		$handler = $save->handler();
106
107		Log::debug('File being uploaded. Percentage done - '.$handler->getPercentageDone());
108		return response()->json([
109		'done' => $handler->getPercentageDone(),
110		'status' => true
111		]);
112		}
113
114		// If there are no files being uploaded or the file uploade process is done
115	8	if(isset($request->_completed) && $request->_completed)
116		{
117	8	$linkID = $this->createLink($request);
118	8	if($request->session()->has('newLinkFile'))
119		{
120		// If there were files uploaded to the link, process them
121	2	$files = session('newLinkFile');
122	2	$path = config('filesystems.paths.links').DIRECTORY_SEPARATOR.$linkID;
123
124	2	foreach($files as $file)
125		{
126	2	$data = Files::find($file);
127		// Move the file to the proper folder
128	2	Storage::move($data->file_link.$data->file_name, $path.DIRECTORY_SEPARATOR.$data->file_name);
129		// Update file link in DB
130	2	$data->update([
131	2	'file_link' => $path.DIRECTORY_SEPARATOR
132		]);
133		// Attach file to the link
134	2	FileLinkFiles::create([
135	2	'link_id' => $linkID,
136	2	'file_id' => $data->file_id,
137	2	'user_id' => Auth::user()->user_id,
138	2	'upload' => 0
139		]);
140
141	2	Log::info('File Added for link ID - '.$linkID.' by '.Auth::user()->full_name.'. File ID-'.$data->file_id);
142		}
143
144	2	$request->session()->forget('newLinkFile');
145		}
146
147	8	return response()->json(['link' => $linkID, 'name' => Str::slug($request->name)]);
148		}
149
150		return response()->json(['complete' => false]);
151		}
152
153		// Create the new file link
154	8	private function createLink($data)
155		{
156	8	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $data->toArray());
157
158		// Generate a random hash to use as the file link and make sure it is not already in use
159		do
160		{
161	8	$hash = strtolower(Str::random(15));
162	8	$dup = FileLinks::where('link_hash', $hash)->get()->count();
163	8	} while($dup != 0);
164
165		// Create the new file link
166	8	$link = FileLinks::create([
167	8	'user_id' => Auth::user()->user_id,
168	8	'cust_id' => $data->customerID,
169	8	'link_hash' => $hash,
170	8	'link_name' => $data->name,
171	8	'expire' => $data->expire,
172	8	'allow_upload' => isset($data->allowUp) && $data->allowUp ? true : false,
173	8	'note' => $data->note
174		]);
175
176	8	Log::info('File Link Created for '.Auth::user()->full_name.'. Link ID-'.$link->link_id);
177
178	8	return $link->link_id;
179		}
180
181		// Save a file attached to the link
182	2	private function saveFile(UploadedFile $file)
183		{
184	2	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
185
186	2	$filePath = config('filesystems.paths.links').DIRECTORY_SEPARATOR.'_tmp';
187
188		// Clean the file and store it
189	2	$fileName = Files::cleanFilename($filePath, $file->getClientOriginalName());
190	2	$file->storeAs($filePath, $fileName);
191
192		// Place file in Files table of DB
193	2	$newFile = Files::create([
194	2	'file_name' => $fileName,
195	2	'file_link' => $filePath.DIRECTORY_SEPARATOR
196		]);
197	2	$fileID = $newFile->file_id;
198
199		// Save the file ID in the session array
200	2	$fileArr = session('newLinkFile') != null ? session('newLinkFile') : [];
201	2	$fileArr[] = $fileID;
202	2	session(['newLinkFile' => $fileArr]);
203
204		// Log stored file
205	2	Log::info('File Stored by '.Auth::user()->user_id, ['file_id' => $fileID, 'file_path' => $filePath.DIRECTORY_SEPARATOR.$fileName]);
206	2	return $fileID;
207		}
208
209		// Show details about a file link
210	4	public function details($id, /** @scrutinizer ignore-unused */ $name)
211		{
212	4	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
213
214		// Verify that the link is a valid link
215	4	$linkData = FileLinks::find($id);
216	4	$fileTypes = new CustomerFileTypesCollection(CustomerFileTypes::all());
217
218		// If the link is invalid, return an error page
219	4	if(empty($linkData))
220		{
221	2	Log::warning('User '.Auth::user()->full_name.' tried to view bad file link', ['user_id' => Auth::user()->user_id, 'link_id' => $id]);
222	2	return view('links.badLink');
223		}
224
225	2	return view('links.details', [
226	2	'link_id' => $linkData->link_id,
227	2	'cust_id' => $linkData->cust_id,
228	2	'file_types' => $fileTypes
229		]);
230		}
231
232		// Ajax call te get JSON details of the link
233	2	public function show($id)
234		{
235	2	$linkData = new FileLinksResource(FileLinks::find($id));
236
237	2	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
238	2	return $linkData;
239		}
240
241		// Update the link's details
242	6	public function update(Request $request, $id)
243		{
244	6	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name.'. Submitted Data - ', $request->toArray());
245
246	6	$request->validate([
247	6	'name' => 'required',
248		'expire' => 'required',
249		'customerTag' => 'exists:customers,cust_id\|nullable'
250		]);
251
252	2	FileLinks::find($id)->update([
253	2	'link_name' => $request->name,
254	2	'expire' => $request->expire,
255	2	'allow_upload' => isset($request->allowUpload) && $request->allowUpload ? true : false,
256	2	'cust_id' => $request->customerTag,
257	2	'note' => $request->hasInstructions ? $request->instructions : null
258		]);
259
260	2	Log::info('File Link Updated by '.Auth::user()->full_name, ['link_id' => $id]);
261
262	2	return response()->json(['success' => true]);
263		}
264
265		// Disable a file linke, but do not remove it (set the expire date to a previous date)
266	2	public function disableLink($id)
267		{
268		// update the expire date for the link
269	2	FileLinks::find($id)->update([
270	2	'expire' => Carbon::yesterday()
271		]);
272
273	2	Log::info('User '.Auth::user()->full_name.' disabled link ID - '.$id);
274	2	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
275	2	return response()->json(['success' => true]);
276		}
277
278		// Delete a file link
279	2	public function destroy($id)
280		{
281		// Remove the file from database
282	2	$data = FileLinkFiles::where('link_id', $id)->get();
283	2	if(!$data->isEmpty())
284		{
285	2	foreach($data as $file)
286		{
287	2	$fileID = $file->file_id;
288	2	$file->delete();
289
290		// Delete the file if it is no longer in use
291	2	Files::deleteFile($fileID);
292		}
293		}
294
295	2	FileLinks::find($id)->delete();
296
297	2	Log::debug('Route ' . Route::currentRouteName() . ' visited by ' . Auth::user()->full_name);
298	2	Log::info('File link deleted by '.Auth::user()->full_name, ['link_id' => $id, 'user_id' => Auth::user()->user_id]);
299
300	2	return response()->json([
301	2	'success' => true
302		]);
303		}
304		}
305

butcherman / Tech_Bench

Push — dev5 ( 1c1697...6a3ae7 )

FileLinksController::store() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like