Adding basic tagging system

vanguardbackup · Jun 18, 2024 · bdb87cf · bdb87cf
2 parents b12ab37 + 4c7a281
commit bdb87cf
Show file tree

Hide file tree

Showing 42 changed files with 1,136 additions and 6 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -3,3 +3,4 @@ e7bc3b942e1391b53c97663eea56d8eb57119290
 9ea7e0a73de9cc356dbdcc01977492106548a9ae
 80ae05cec1520a13efa53b8d8b007f42de61b5c8
 52445316a5fdb2dfe46a9a147eba5cbd63a914a4
+8260edeec8da22d26ed1f9a7ef120ed468e50184
diff --git a/app/Http/Controllers/Tags/EditController.php b/app/Http/Controllers/Tags/EditController.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Http\Controllers\Tags;
+
+use App\Http\Controllers\Controller;
+use App\Models\Tag;
+use Illuminate\Http\Request;
+use Illuminate\View\View;
+
+class EditController extends Controller
+{
+    public function __invoke(Request $request, Tag $tag): View
+    {
+        return view('tags.edit', [
+            'tag' => $tag,
+        ]);
+    }
+}
diff --git a/app/Livewire/BackupTasks/CreateBackupTaskForm.php b/app/Livewire/BackupTasks/CreateBackupTaskForm.php
@@ -9,6 +9,7 @@
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Redirect;
+use Illuminate\Validation\Rule;
 use Illuminate\View\View;
 use Livewire\Component;
 use Livewire\Features\SupportRedirects\Redirector;
@@ -58,6 +59,9 @@ class CreateBackupTaskForm extends Component
 
     public ?string $excludedDatabaseTables = null;
 
+    public ?Collection $availableTags;
+    public ?array $selectedTags;
+
     public function updatedUseCustomCron(): void
     {
         $this->useCustomCron = (bool) $this->useCustomCron;
@@ -81,6 +85,7 @@ public function updatedBackupType(): void
 
     public function mount(): void
     {
+        $this->availableTags = Auth::user()->tags;
         $this->userTimezone = Auth::user()->timezone ?? 'UTC';
 
         $this->remoteServers = Auth::user()->remoteServers->where('database_password', null);
@@ -107,6 +112,7 @@ public function mount(): void
     public function submit(): RedirectResponse|Redirector
     {
         $messages = [
+            'selectedTags.*.exists' => __('One or more of the selected tags do not exist.'),
             'storePath.regex' => __('The path must be a valid Unix path.'),
             'notifyEmail.email' => __('Please enter a valid email address.'),
             'notifySlackWebhook.url' => __('Please enter a valid URL.'),
@@ -137,6 +143,7 @@ public function submit(): RedirectResponse|Redirector
 
         if ($this->backupType === 'files') {
             $this->validate([
+                'selectedTags' => ['nullable', 'array', Rule::exists('tags', 'id')->where('user_id', Auth::id())],
                 'excludedDatabaseTables' => ['nullable', 'string', 'regex:/^([a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*)$/'],
                 'storePath' => ['nullable', 'string', 'regex:/^(\/[^\/\0]+)+\/?$/'], // Unix path regex
                 'notifyEmail' => ['nullable', 'email'],
@@ -158,6 +165,7 @@ public function submit(): RedirectResponse|Redirector
         }
 
         $this->validate([
+            'selectedTags' => ['nullable', 'array', Rule::exists('tags', 'id')->where('user_id', Auth::id())],
             'excludedDatabaseTables' => ['nullable', 'string', 'regex:/^([a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*)$/'],
             'storePath' => ['nullable', 'string', 'regex:/^(\/[^\/\0]+)+\/?$/'], // Unix path regex
             'notifyEmail' => ['nullable', 'email'],
@@ -189,7 +197,7 @@ public function submit(): RedirectResponse|Redirector
             $this->timeToRun = Carbon::createFromFormat('H:i', $this->timeToRun, $this->userTimezone)?->setTimezone('UTC')->format('H:i');
         }
 
-        BackupTask::create([
+        $backupTask = BackupTask::create([
             'user_id' => Auth::id(),
             'remote_server_id' => $this->remoteServerId,
             'backup_destination_id' => $this->backupDestinationId,
@@ -211,6 +219,8 @@ public function submit(): RedirectResponse|Redirector
             'excluded_database_tables' => $this->excludedDatabaseTables,
         ]);
 
+        $backupTask->tags()->sync($this->selectedTags);
+
         Toaster::success(__('Backup task has been added.'));
 
         return Redirect::route('backup-tasks.index');

diff --git a/app/Livewire/BackupTasks/UpdateBackupTaskForm.php b/app/Livewire/BackupTasks/UpdateBackupTaskForm.php
@@ -9,6 +9,7 @@
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Redirect;
+use Illuminate\Validation\Rule;
 use Illuminate\View\View;
 use Livewire\Component;
 use Livewire\Features\SupportRedirects\Redirector;
@@ -60,6 +61,9 @@ class UpdateBackupTaskForm extends Component
 
     public ?string $excludedDatabaseTables;
 
+    public ?Collection $availableTags;
+    public ?array $selectedTags;
+
     public function updatedUseCustomCron(): void
     {
         $this->useCustomCron = (bool) $this->useCustomCron;
@@ -83,6 +87,9 @@ public function updatedBackupType(): void
 
     public function mount(): void
     {
+        $this->availableTags = Auth::user()->tags;
+        $this->selectedTags = $this->backupTask->tags->pluck('id')->toArray();
+
         $this->backupTimes = collect(range(0, 47))->map(function ($halfHour) {
             $hour = intdiv($halfHour, 2);
             $minute = ($halfHour % 2) * 30;
@@ -128,6 +135,7 @@ public function submit(): RedirectResponse|Redirector
         $this->authorize('update', $this->backupTask);
 
         $messages = [
+            'selectedTags.*.exists' => __('One or more of the selected tags do not exist.'),
             'excludedDatabaseTables.regex' => __('Please enter a valid list of table names separated by commas.'),
             'storePath.regex' => __('The path must be a valid Unix path.'),
             'notifyEmail.email' => __('Please enter a valid email address.'),
@@ -159,6 +167,7 @@ public function submit(): RedirectResponse|Redirector
 
         if ($this->backupType === 'files') {
             $this->validate([
+                'selectedTags' => ['nullable', 'array', Rule::exists('tags', 'id')->where('user_id', Auth::id())],
                 'excludedDatabaseTables' => ['nullable', 'string', 'regex:/^([a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*)$/'],
                 'storePath' => ['nullable', 'string', 'regex:/^(\/[^\/\0]+)+\/?$/'], // Unix path regex
                 'notifyEmail' => ['nullable', 'email'],
@@ -180,6 +189,7 @@ public function submit(): RedirectResponse|Redirector
         }
 
         $this->validate([
+            'selectedTags' => ['nullable', 'array', Rule::exists('tags', 'id')->where('user_id', Auth::id())],
             'excludedDatabaseTables' => ['nullable', 'string', 'regex:/^([a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*)$/'],
             'storePath' => ['nullable', 'string', 'regex:/^(\/[^\/\0]+)+\/?$/'], // Unix path regex
             'notifyEmail' => ['nullable', 'email'],
@@ -232,6 +242,8 @@ public function submit(): RedirectResponse|Redirector
             'store_path' => $this->storePath ?? null,
         ]);
 
+        $this->backupTask->tags()->sync($this->selectedTags);
+
         Toaster::success(__('Backup task details saved.'));
 
         return Redirect::route('backup-tasks.index');

diff --git a/app/Livewire/Tags/CreateForm.php b/app/Livewire/Tags/CreateForm.php
@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Livewire\Tags;
+
+use App\Models\Tag;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Redirect;
+use Illuminate\View\View;
+use Livewire\Component;
+use Livewire\Features\SupportRedirects\Redirector;
+use Masmerise\Toaster\Toaster;
+
+class CreateForm extends Component
+{
+    public string $label;
+    public ?string $description;
+
+    public function submit(): RedirectResponse|Redirector
+    {
+        $this->validate([
+            'label' => ['required', 'string'],
+            'description' => ['nullable', 'string'],
+        ], [
+            'label.required' => __('Please enter a label.'),
+        ]);
+
+        $tag = Tag::create([
+            'user_id' => Auth::id(),
+            'label' => $this->label,
+            'description' => $this->description ?? null,
+        ]);
+
+        Toaster::success(__('The tag :label has been added.', ['label' => $tag->label]));
+
+        return Redirect::route('tags.index');
+    }
+
+    public function render(): View
+    {
+        return view('livewire.tags.create-form');
+    }
+}
diff --git a/app/Livewire/Tags/DeleteTagButton.php b/app/Livewire/Tags/DeleteTagButton.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Livewire\Tags;
+
+use App\Models\Tag;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Support\Facades\Redirect;
+use Illuminate\View\View;
+use Livewire\Component;
+use Livewire\Features\SupportRedirects\Redirector;
+use Masmerise\Toaster\Toaster;
+
+class DeleteTagButton extends Component
+{
+    public Tag $tag;
+
+    public function mount(Tag $tag): void
+    {
+        $this->tag = $tag;
+    }
+
+    public function delete(): RedirectResponse|Redirector
+    {
+        $this->authorize('forceDelete', $this->tag);
+
+        Toaster::success("The tag {$this->tag->label} has been removed.");
+
+        $this->tag->forceDelete();
+
+        return Redirect::route('tags.index');
+    }
+
+    public function render(): View
+    {
+        return view('livewire.tags.delete-tag-button');
+    }
+}
diff --git a/app/Livewire/Tags/IndexItem.php b/app/Livewire/Tags/IndexItem.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Livewire\Tags;
+
+use App\Models\Tag;
+use Illuminate\View\View;
+use Livewire\Component;
+
+class IndexItem extends Component
+{
+    public Tag $tag;
+
+    public function mount(Tag $tag): void
+    {
+        $this->tag = $tag;
+    }
+
+    public function render(): View
+    {
+        return view('livewire.tags.index-item');
+    }
+}
diff --git a/app/Livewire/Tags/IndexTable.php b/app/Livewire/Tags/IndexTable.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Livewire\Tags;
+
+use App\Models\Tag;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\View\View;
+use Livewire\Component;
+use Livewire\WithPagination;
+
+class IndexTable extends Component
+{
+    use withPagination;
+
+    public function render(): View
+    {
+        $tags = Tag::where('user_id', Auth::id())
+            ->orderBy('created_at', 'desc')
+            ->paginate(30, pageName: 'tags');
+
+        return view('livewire.tags.index-table', ['tags' => $tags]);
+    }
+}
diff --git a/app/Livewire/Tags/UpdateForm.php b/app/Livewire/Tags/UpdateForm.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace App\Livewire\Tags;
+
+use App\Models\Tag;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Support\Facades\Redirect;
+use Illuminate\View\View;
+use Livewire\Component;
+use Livewire\Features\SupportRedirects\Redirector;
+use Masmerise\Toaster\Toaster;
+
+class UpdateForm extends Component
+{
+    public string $label;
+    public ?string $description;
+
+    public Tag $tag;
+
+    public function mount(Tag $tag): void
+    {
+        $this->tag = $tag;
+        $this->label = $tag->label;
+        $this->description = $tag->description ?? null;
+    }
+
+    public function submit(): RedirectResponse|Redirector
+    {
+        $this->authorize('update', $this->tag);
+
+        $this->validate([
+            'label' => ['required', 'string'],
+            'description' => ['nullable', 'string'],
+        ], [
+            'label.required' => __('Please enter a label.'),
+        ]);
+
+        $this->tag->update([
+            'label' => $this->label,
+            'description' => $this->description ?? null,
+        ]);
+
+        $this->tag->save();
+
+        Toaster::success(__('The tag :label has been updated.', ['label' => $this->tag->label]));
+
+        return Redirect::route('tags.index');
+    }
+
+    public function render(): View
+    {
+        return view('livewire.tags.update-form');
+    }
+}
diff --git a/app/Models/BackupTask.php b/app/Models/BackupTask.php
@@ -7,6 +7,7 @@
 use App\Jobs\RunDatabaseBackupTaskJob;
 use App\Jobs\RunFileBackupTaskJob;
 use App\Mail\BackupTasks\OutputMail;
+use App\Traits\HasTags;
 use Cron\CronExpression;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -20,7 +21,7 @@
 
 class BackupTask extends Model
 {
-    use HasFactory;
+    use HasFactory, HasTags;
 
     const string STATUS_READY = 'ready';
 
@@ -465,6 +466,15 @@ public function isAnotherTaskRunningOnSameRemoteServer(): bool
             ->exists();
     }
 
+    public function listOfAttachedTagLabels(): ?string
+    {
+        if ($this->tags->isEmpty()) {
+            return null;
+        }
+
+        return $this->tags->pluck('label')->implode(', ');
+    }
+
     private function cronExpression(): CronExpression
     {
         return new CronExpression($this->custom_cron_expression);

diff --git a/app/Models/Tag.php b/app/Models/Tag.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+class Tag extends Model
+{
+    use HasFactory;
+
+    protected $guarded = [];
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+}