TechTipsController::saveNewTipFile() - Code Metrics - Inspection of "Dev4" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#67)

by Ron
created 2019-04-16 04:46 UTC
TechTipsController::saveNewTipFile() A

↳ Parent: TechTipsController
Complexity

Conditions	1
Paths	1
Size

Total Lines	14
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	7
nc	1
nop	2
dl	0
loc	14
rs	10
c	0
b	0
f	0
<?php

namespace App\Http\Controllers;

use PDF;
use Exception;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Mail;
use App\SystemTypes;
use App\SystemCategories;
use App\User;
use App\UserSettings;
use App\Files;
use App\TechTips;
use App\TechTipFiles;
use App\TechTipSystems;
use App\TechTipComments;
use App\TechTipFavs;
use App\Mail\NewTechtip;


use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;
use Pion\Laravel\ChunkUpload\Handler\AbstractHandler;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Illuminate\Http\UploadedFile;

class TechTipsController extends Controller
{
    //  Only authorized users have access
    public function __construct()
    {
        $this->middleware('auth');
    }

    //  Landing page brings up the tech tip search form
    public function index()
    {
        $systems = SystemCategories::with('SystemTypes')
            ->orderBy('cat_id', 'asc')
            ->get();

        $sysArr = [];
        foreach($systems as $sys)
        {
            foreach($sys->SystemTypes as $s)
            {
                $sysArr[$sys->name][$s->sys_id] = $s->name;
            }
        }

        return view('tip.index', [
            'systems' => $sysArr
        ]);
    }

    //  Search for a tech tip
    public function search(Request $request)
    {
        //  Run different request based on if system field is filled out or not
        if(!empty($request->system))
        {
            $tipData = TechTips::where('subject', 'like', '%'.$request->tipSearch.'%')
                ->whereHas('TechTipSystems', function($q) use($request)
                {
                   $q->where('sys_id', $request->system);
                })
                ->get();
        }
        else
        {
            $tipData = TechTips::where('subject', 'like', '%'.$request->tipSearch.'%')
                ->get();
        }

        return view('tip.searchResults', [
            'results' => $tipData
        ]);
    }

    //  Create a new Tech Tip
    public function create()
    {
        //  Get system types for tip tagging
        $systems = SystemCategories::with('SystemTypes')
            ->orderBy('cat_id', 'asc')
            ->get();

        $sysArr = [];
        foreach($systems as $sys)
        {
            foreach($sys->SystemTypes as $s)
            {
                $sysArr[$sys->name][$s->sys_id] = $s->name;
            }
        }

        return view('tip.form.newTip', [
            'systems' => $sysArr
        ]);
    }

    //  Submit the new tech tip
    public function store(Request $request)
    {
        $request->validate([
            'subject' => 'required',
            'details' => 'required',
            'sysTags' => 'required'
        ]);

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

            // check if the upload is success, throw exception or return response you need
            if ($receiver->isUploaded() === false) {
                throw new UploadMissingFileException();
            }

            // receive the file
            $save = $receiver->receive();
            
            if ($save->isFinished()) 
            {
                $tipID = $this->createNewTechTip($request);
                $filePath = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
                $fileID = $this->saveNewTipFile($save->getFile(), $filePath);
                
                //  Place the file in the tech tip files table of DB
                TechTipFiles::create([
                    'tip_id'  => $tipID,
                    'file_id' => $fileID
                ]);
                
                //  Email the techs of the new tip
                $tipData = TechTips::find($tipID);
                $userList = UserSettings::where('em_tech_tip', 1)->join('users', 'user_settings.user_id', '=', 'users.user_id')->where('active', 1)->get();
                try
                {
                    Mail::to($userList)->send(new newTechtip($tipData));
                }
                catch(Exception $e)
                {
                    report($e);
                }

                Log::info('Tech Tip ID-'.$tipID.' Created by Customer ID-'.Auth::user()->user_id);
                
                return $tipID;
            }
            
            
            $handler = $save->handler();

            return response()->json([
                "done" => $handler->getPercentageDone(),
                'status' => true
            ]);
        }
        else
        {
            $tipID = $this->createNewTechTip($request);
            
            //  Email the techs of the new tip
            $tipData = TechTips::find($tipID);
            $userList = UserSettings::where('em_tech_tip', 1)->join('users', 'user_settings.user_id', '=', 'users.user_id')->where('active', 1)->get();
            try
            {
                Mail::to($userList)->send(new newTechtip($tipData));
            }
            catch(Exception $e)
            {
                report($e);
            }

            Log::info('Tech Tip ID-'.$tipID.' Created by Customer ID-'.Auth::user()->user_id);
            
            return $tipID;
        }
        

//        //  If there are any files, process them
//        if(!empty($request->file))
//        {
//            $filePath = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
//            foreach($request->file as $file)
//            {
//                //  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 tech tip files table of DB
//                TechTipFiles::create([
//                    'tip_id'  => $tipID,
//                    'file_id' => $fileID
//                ]);
//            }
//        }
//
//        //  Email the techs of the new tip
//        $tipData = TechTips::find($tipID);
//        $userList = UserSettings::where('em_tech_tip', 1)->join('users', 'user_settings.user_id', '=', 'users.user_id')->where('active', 1)->get();
//        try
//        {
//            Mail::to($userList)->send(new newTechtip($tipData));
//        }
//        catch(Exception $e)
//        {
//            report($e);
//        }
//
//        Log::info('Tech Tip ID-'.$tipID.' Created by Customer ID-'.Auth::user()->user_id);
//
//        return $tipID;
    }
    
    private function saveNewTipFile(UploadedFile $file, $filePath)
    {
        //  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;
        
        return $fileID;
    }
    
    private function createNewTechTip($tipData)
    {
        //  Remove any forward slash (/) from the Subject field
        $tipData->merge(['subject' => str_replace('/', '-', $tipData->subject)]);

        //  Enter the tip details and get the tip ID
        $tip = TechTips::create([
            'subject'     => $tipData->subject,
            'description' => $tipData->details,
            'user_id'     => Auth::user()->user_id
        ]);
        $tipID = $tip->tip_id;

        //  Enter all system tags associated with the tip
        if(is_array($tipData->sysTags))
        {
            foreach($tipData->sysTags as $tag)
            {
                TechTipSystems::create([
                    'tip_id' => $tipID,
                    'sys_id' => $tag
                ]);
            }
        }
        else
        {
            TechTipSystems::create([
                'tip_id' => $tipID,
                'sys_id' => $tipData->sysTags
            ]);
        }
        
        return $tipID;
    }

    //  Process an uploaded image to the Tech Tip body
    public function processImage(Request $request)
    {
        $request->validate([
            'image' => 'mimes:jpeg,bmp,png'
        ]);

        $file = $request->file;
        $fileName = $file->getClientOriginalName();
        $file->storeAs('img/tip_img', $fileName, 'public');

        return json_encode(['location' => '/storage/img/tip_img/'.$fileName]);
    }

    //  Show the Tech Tip details
    public function details($id, $name)
    {
        $tipData = TechTips::where('tip_id', $id)->with('user')->first();
        if(empty($tipData))
        {
            Log::warning('User ID-'.Auth::user()->user_id.' tried to access invlaid Tech Tip ID-'.$id.' Name-'.$name);
            return view('errors.tipNotFound');
        }

        $tipFiles = TechTipFiles::where('tip_id', $id)
            ->join('files', 'tech_tip_files.file_id', '=', 'files.file_id')
            ->get();
        $tipCmts  = TechTipComments::where('tip_id', $id)
            ->get();
        $tipSys   = TechTipSystems::where('tip_id', $id)
            ->join('system_types', 'tech_tip_systems.sys_id', '=', 'system_types.sys_id')
            ->get();
        $tipFav   = TechTipFavs::where('user_id', Auth::user()->user_id)
            ->where('tip_id', $id)
            ->first();

        return view('tip.details', [
            'data'     => $tipData,
            'files'    => $tipFiles,
            'systems'  => $tipSys,
            'comments' => $tipCmts,
            'isFav'    => $tipFav
        ]);
    }

    //  Download a note as a PDF file
    public function generatePDF($id)
    {
        $tipData  = TechTips::where('tip_id', $id)->with('user')->first();
        $tipCmts  = TechTipComments::where('tip_id', $id)
            ->join('users', 'tech_tip_comments.user_id', '=', 'users.user_id')
            ->get();
        $tipSys   = TechTipSystems::where('tip_id', $id)
            ->join('system_types', 'tech_tip_systems.sys_id', '=', 'system_types.sys_id')
            ->get();

        $pdf = PDF::loadView('pdf.techTip', [
            'data'     => $tipData,
            'systems'  => $tipSys,
            'comments' => $tipCmts,
        ]);

        return $pdf->download('Tech Tip - '.$tipData->subject.'.pdf');
    }

    //  Toggle whether or not the customer is listed as a user favorite
    public function toggleFav($action, $tipID)
    {
        switch ($action)
        {
            case 'add':
                TechTipFavs::create([
                    'user_id' => Auth::user()->user_id,
                    'tip_id'  => $tipID
                ]);
                break;
            case 'remove':
                $tipFav = TechTipFavs::where('user_id', Auth::user()->user_id)->where('tip_id', $tipID)->first();
                $tipFav->delete();
                break;
        }
    }

    //  Edit a Tech Tip
    public function edit($id)
    {
        $tipData = TechTips::find($id);
        if(empty($tipData))
        {
            return 'tip not found';
        }

        $tipFiles = TechTipFiles::where('tip_id', $id)
            ->join('files', 'tech_tip_files.file_id', '=', 'files.file_id')
            ->get();
        $tipCmts  = TechTipComments::where('tip_id', $id)
            ->get();
        $tipSys   = TechTipSystems::where('tip_id', $id)
            ->join('system_types', 'tech_tip_systems.sys_id', '=', 'system_types.sys_id')
            ->get();
        $tipFav   = TechTipFavs::where('user_id', Auth::user()->user_id)
            ->where('tip_id', $id)
            ->first();
        
        $tipS = [];
        foreach($tipSys as $s)
        {
            $tipS[] = $s->sys_id;
        }

        //  Get system types for tip tagging
        $systems = SystemCategories::with('SystemTypes')
            ->orderBy('cat_id', 'asc')
            ->get();

        $sysArr = [];
        foreach($systems as $sys)
        {
            foreach($sys->SystemTypes as $s)
            {
                $sysArr[$sys->name][$s->sys_id] = $s->name;
            }
        }

        return view('tip.form.editTip', [
            'data'     => $tipData,
            'files'    => $tipFiles,
            'systems'  => $tipS,
            'comments' => $tipCmts,
            'isFav'    => $tipFav,
            'sysToTag' => $sysArr
        ]);
    }

    //  Update the tech tip
    public function update(Request $request, $id)
    {
        $request->validate([
            'subject'     => 'required',
            'description' => 'required',
            'sysTags'     => 'required'
        ]);

        //  Remove any forward slash (/) from the Subject field
        $request->merge(['subject' => str_replace('/', '-', $request->subject)]);

        //  update tip details
        TechTips::find($id)->update([
            'subject'     => $request->subject,
            'description' => $request->description
        ]);

        //  Enter all system tags associated with the tip after destroying the existing systems
        TechTipSystems::where('tip_id', $id)->delete();
        if(is_array($request->sysTags))
        {
            foreach($request->sysTags as $tag)
            {
                TechTipSystems::create([
                    'tip_id' => $id,
                    'sys_id' => $tag
                ]);
            }
        }
        else
        {
            TechTipSystems::create([
                'tip_id' => $id,
                'sys_id' => $request->sysTags
            ]);
        }

        //  Determine if any files were removed
        $tipFiles = TechTipFiles::where('tip_id', $id)->get();
        if(!$tipFiles->isEmpty())
        {
            if(!empty($request->existingFile))
            {
                foreach($tipFiles as $file)
                {
                    if(!in_array($file->file_id, $request->existingFile))
                    {
                        TechTipFiles::where('file_id', $file->file_id)->delete();
                        Files::deleteFile($file->file_id);
                    }
                }
            }
            else
            {
                TechTipFiles::where('tip_id', $id)->delete();
            }
        }

        //  Process any new files
        if(!empty($request->file))
        {
            $filePath = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$id;
            foreach($request->file as $file)
            {
                //  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 tech tip files table of DB
                TechTipFiles::create([
                    'tip_id'  => $id,
                    'file_id' => $fileID
                ]);
            }
        }

        Log::info('Tech Tip ID-'.$id.' Updated by User ID-'.Auth::user()->user_id);

        return $id;
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function destroy($id)
    public function destroy(/** @scrutinizer ignore-unused */ $id)
    {
        //
    }
}

butcherman / Tech_Bench

Pull Request — master (#67)

TechTipsController::saveNewTipFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
