App\Jobs\ApplicationBackupJob

Complexity

Total Complexity

9

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	backupFiles()	0	13	2
A	__construct()	0	6	1
A	closeArchive()	0	3	1
A	backupDatabase()	0	9	2
A	openArchive()	0	14	1
A	handle()	0	14	1
A	cleanup()	0	5	1

<?php

namespace App\Jobs;

use Zip;
use Carbon\Carbon;
use Nwidart\Modules\Facades\Module;
use PragmaRX\Version\Package\Version;

use Illuminate\Bus\Queueable;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Contracts\Queue\ShouldQueue;

class ApplicationBackupJob implements ShouldQueue
{
    use Queueable;
    use Dispatchable;
    use SerializesModels;
    use InteractsWithQueue;

    protected $files;
    protected $archive;
    protected $database;
    protected $diskLocal;
    protected $backupName;

    /**
     * Create a new job instance
     */
    public function __construct($database = true, $files = true)
    {
        $this->database   = $database;
        $this->files      = $files;
        $this->backupName = 'TB_Backup_'.Carbon::now()->format('Ymd_his').'.zip';
        $this->diskLocal  = config('filesystems.disks.backups.root').DIRECTORY_SEPARATOR;
    }

    /**
     * Execute the job
     */
    public function handle()
    {
        Log::notice('Starting Application Backup', [
            'Backup Database' => $this->database,
            'Backup Files'    => $this->files
        ]);

        $this->openArchive();
        $this->backupFiles();
        $this->backupDatabase();
        $this->closeArchive();
        $this->cleanup();

        Log::notice('Backup Completed Successfully - file located at '.$this->diskLocal.$this->backupName);
    }

    /**
     * Create and open up the Archive Zip file
     */
    protected function openArchive()
    {
        //  Create a file that holds the current version of the Tech Bench application
        Storage::disk('backups')->put('version.txt', (new Version)->version_only());
        //  Create a file that holds all enabled modules
        Storage::disk('backups')->put('modules.txt', Module::all());

        //  Create the backup Zip file
        $this->archive = Zip::create($this->diskLocal.$this->backupName);
        //  Add the version and module files
        $this->archive->add($this->diskLocal.'version.txt');
        $this->archive->add($this->diskLocal.'modules.txt');
        //  Add the .env file that holds local global config
        $this->archive->add(base_path().DIRECTORY_SEPARATOR.'.env');
    }

    /**
     * Close and finish the Archive Zip File
     */
    protected function closeArchive()
    {
        $this->archive->close();
    }

    /**
     * Backup all of the Application Disks
     */
    protected function backupFiles()
    {
        if(!$this->files)
        {
            return false;
        }

        //  All uploaded files
        $this->archive->add(config('filesystems.disks.local.root'));
        //  All public uploaded files (images for Tech Tips and Logos)
        $this->archive->add(config('filesystems.disks.public.root'));
        //  All application logs
        $this->archive->add(config('filesystems.disks.logs.root'));
    }

    /**
     * Backup the MySQL Database
     */
    protected function backupDatabase()
    {
        if(!$this->database)
        {
            return false;
        }

        Artisan::call('db:masked-dump', ['output' => $this->diskLocal.'backup.sql']);
        $this->archive->add($this->diskLocal.'backup.sql');
    }

    /**
     * Remove any temporary files
     */
    protected function cleanup()
    {
        Storage::disk('backups')->delete('version.txt');
        Storage::disk('backups')->delete('backup.sql');
        Storage::disk('backups')->delete('modules.txt');
    }
}