From 0055762d6a76194f4ec28616c4fed3f474c4e9e5 Mon Sep 17 00:00:00 2001
From: Emmanuel Lampe <mail@emmanuel-lampe.de>
Date: Wed, 18 Nov 2020 13:16:43 +0100
Subject: [PATCH] Implemented ticket reference

---
 config/config.php                             | 14 ++++-
 ...6_00004_create_ticket_references_table.php | 38 +++++++++++++
 resources/views/tickets/create.blade.php      | 27 +++++++++
 resources/views/tickets/show.blade.php        |  8 +++
 src/Controllers/TicketController.php          | 20 +++++++
 src/Interfaces/TicketReference.php            | 24 ++++++++
 src/Models/Ticket.php                         |  5 ++
 src/Models/TicketReference.php                | 30 ++++++++++
 src/Rule/TicketReferenceRule.php              | 55 +++++++++++++++++++
 src/Traits/HasTicketReference.php             | 16 ++++++
 10 files changed, 235 insertions(+), 2 deletions(-)
 create mode 100644 database/migrations/2020_11_16_00004_create_ticket_references_table.php
 create mode 100644 src/Interfaces/TicketReference.php
 create mode 100644 src/Models/TicketReference.php
 create mode 100644 src/Rule/TicketReferenceRule.php
 create mode 100644 src/Traits/HasTicketReference.php

diff --git a/config/config.php b/config/config.php
index 18ba13e..92ebc4d 100644
--- a/config/config.php
+++ b/config/config.php
@@ -50,7 +50,8 @@
         'tickets-table' => 'tickets',
         'ticket-messages-table' => 'ticket_messages',
         'ticket-uploads-table' => 'ticket_uploads',
-        'ticket-categories-table' => 'ticket_categories'
+        'ticket-categories-table' => 'ticket_categories',
+        'ticket-references-table' => 'ticket_references'
     ],
 
     /*
@@ -117,5 +118,14 @@
     /*
      * Enable categories for tickets
      */
-    'category' => true
+    'category' => true,
+    /*
+     * Enable references for tickets
+     */
+    'references' => true,
+    'references-nullable' => true,
+    /*
+     * Ether you define your models for references or customize the view.
+     */
+    'reference-models' => []
 ];
diff --git a/database/migrations/2020_11_16_00004_create_ticket_references_table.php b/database/migrations/2020_11_16_00004_create_ticket_references_table.php
new file mode 100644
index 0000000..44d48ba
--- /dev/null
+++ b/database/migrations/2020_11_16_00004_create_ticket_references_table.php
@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateTicketReferencesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create(config('laravel-tickets.database.ticket-references-table'), function (Blueprint $table) {
+            $table->id();
+            $table->unsignedBigInteger('ticket_id');
+            $table->morphs('referenceable');
+            $table->timestamps();
+
+            if (! config('laravel-tickets.models.uuid')) {
+                $table->foreign('ticket_id')
+                    ->on(config('laravel-tickets.database.tickets-table'))->references('id');
+            }
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists(config('laravel-tickets.database.ticket-references-table'));
+    }
+}
diff --git a/resources/views/tickets/create.blade.php b/resources/views/tickets/create.blade.php
index 4558996..f2573db 100644
--- a/resources/views/tickets/create.blade.php
+++ b/resources/views/tickets/create.blade.php
@@ -33,6 +33,33 @@
                             </div>
                         </div>
                     @endif
+                    @if (config('laravel-tickets.references'))
+                        <div class="col-12">
+                            <div class="form-group">
+                                <label>@lang('Reference')</label>
+                                <select class="form-control @error('reference') is-invalid @enderror"
+                                        name="reference">
+                                    @if (config('laravel-tickets.references-nullable'))
+                                        <option value="">@lang('No reference')</option>
+                                    @endif
+                                    @foreach (config('laravel-tickets.reference-models') as $modelClass)
+                                        @foreach (resolve($modelClass)->all() as $model)
+                                            @if (!$model->hasReferenceAccess())
+                                                @continue
+                                            @endif
+                                            <option value="{{ $model->toReference() }}"
+                                                    @if (old('reference') === $model->toReference())
+                                                    selected
+                                                @endif>@lang(basename(get_class($model))) #{{$model->id}}</option>
+                                        @endforeach
+                                    @endforeach
+                                </select>
+                                @error('reference')
+                                <div class="invalid-feedback">{{ $message }}</div>
+                                @enderror
+                            </div>
+                        </div>
+                    @endif
                     <div class="col-4">
                         <div class="form-group">
                             <label>@lang('Priority')</label>
diff --git a/resources/views/tickets/show.blade.php b/resources/views/tickets/show.blade.php
index 2b4774d..71b5cf4 100644
--- a/resources/views/tickets/show.blade.php
+++ b/resources/views/tickets/show.blade.php
@@ -91,6 +91,14 @@ class="custom-file-input @error('files') is-invalid @enderror" id="files">
                                    value="{{ $ticket->category()->first()->translation }}" disabled>
                         </div>
                     @endif
+                    @if (config('laravel-tickets.references') && $ticket->reference()->exists())
+                        <div class="form-group">
+                            <label>@lang('Reference'):</label>
+                            @php($referenceable = $ticket->reference->referenceable)
+                            <input class="form-control" type="text"
+                                   value="@lang(basename(get_class($referenceable))) #{{$referenceable->id}}" disabled>
+                        </div>
+                    @endif
                     <div class="form-group">
                         <label>@lang('Subject'):</label>
                         <input class="form-control" type="text" value="{{ $ticket->subject }}" disabled>
diff --git a/src/Controllers/TicketController.php b/src/Controllers/TicketController.php
index 954cfbf..241e75f 100644
--- a/src/Controllers/TicketController.php
+++ b/src/Controllers/TicketController.php
@@ -4,6 +4,7 @@
 namespace RexlManu\LaravelTickets\Controllers;
 
 
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
@@ -15,7 +16,9 @@
 use RexlManu\LaravelTickets\Events\TicketOpenEvent;
 use RexlManu\LaravelTickets\Models\Ticket;
 use RexlManu\LaravelTickets\Models\TicketMessage;
+use RexlManu\LaravelTickets\Models\TicketReference;
 use RexlManu\LaravelTickets\Models\TicketUpload;
+use RexlManu\LaravelTickets\Rule\TicketReferenceRule;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
 /**
@@ -103,6 +106,12 @@ public function store(Request $request)
                 Rule::exists(config('laravel-tickets.database.ticket-categories-table'), 'id'),
             ];
         }
+        if (config('laravel-tickets.references')) {
+            $rules[ 'reference' ] = [
+                config('laravel-tickets.references-nullable') ? 'nullable' : 'required',
+                new TicketReferenceRule(),
+            ];
+        }
         $data = $request->validate($rules);
         if ($request->user()->tickets()->where('state', '!=', 'CLOSED')->count() >= config('laravel-tickets.maximal-open-tickets')) {
             $message = trans('You have reached the limit of open tickets');
@@ -116,6 +125,17 @@ public function store(Request $request)
         $ticket = $request->user()->tickets()->create(
             $data
         );
+
+        if (array_key_exists('reference', $data)) {
+            $reference = explode(',', $data[ 'reference' ]);
+            $ticketReference = new TicketReference();
+            $ticketReference->ticket()->associate($ticket);
+            $ticketReference->referenceable()->associate(
+                resolve($reference[ 0 ])->find($reference[ 1 ])
+            );
+            $ticketReference->save();
+        }
+
         $ticketMessage = new TicketMessage($data);
         $ticketMessage->user()->associate($request->user());
         $ticketMessage->ticket()->associate($ticket);
diff --git a/src/Interfaces/TicketReference.php b/src/Interfaces/TicketReference.php
new file mode 100644
index 0000000..93b3eee
--- /dev/null
+++ b/src/Interfaces/TicketReference.php
@@ -0,0 +1,24 @@
+<?php
+
+
+namespace RexlManu\LaravelTickets\Interfaces;
+
+
+interface TicketReference
+{
+
+    /**
+     * Check if a user has access to this reference
+     *
+     * @return boolean
+     */
+    function hasReferenceAccess() : bool;
+
+    /**
+     * Combine type and id to a string for forms
+     *
+     * @return string
+     */
+    function toReference() : string;
+
+}
diff --git a/src/Models/Ticket.php b/src/Models/Ticket.php
index ccc2819..1b1dd72 100644
--- a/src/Models/Ticket.php
+++ b/src/Models/Ticket.php
@@ -38,6 +38,11 @@ public function category()
         return $this->belongsTo(TicketCategory::class);
     }
 
+    public function reference()
+    {
+        return $this->hasOne(TicketReference::class);
+    }
+
     public function scopeState($query, $state)
     {
         return $query->where('state', $state);
diff --git a/src/Models/TicketReference.php b/src/Models/TicketReference.php
new file mode 100644
index 0000000..8a06160
--- /dev/null
+++ b/src/Models/TicketReference.php
@@ -0,0 +1,30 @@
+<?php
+
+
+namespace RexlManu\LaravelTickets\Models;
+
+
+use Illuminate\Database\Eloquent\Model;
+use RexlManu\LaravelTickets\Traits\HasConfigModel;
+
+class TicketReference extends Model
+{
+
+    use HasConfigModel;
+
+    public function getTable()
+    {
+        return config('laravel-tickets.database.ticket-references-table');
+    }
+
+    public function ticket()
+    {
+        return $this->belongsTo(Ticket::class);
+    }
+
+    public function referenceable()
+    {
+        return $this->morphTo();
+    }
+
+}
diff --git a/src/Rule/TicketReferenceRule.php b/src/Rule/TicketReferenceRule.php
new file mode 100644
index 0000000..764704d
--- /dev/null
+++ b/src/Rule/TicketReferenceRule.php
@@ -0,0 +1,55 @@
+<?php
+
+
+namespace RexlManu\LaravelTickets\Rule;
+
+
+use Illuminate\Contracts\Validation\Rule;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use RexlManu\LaravelTickets\Interfaces\TicketReference;
+
+class TicketReferenceRule implements Rule
+{
+
+    /**
+     * Determine if the ticket reference is valid
+     * Checks
+     * if value contains type and id
+     * if the model exists
+     * if the model is a instance of @param string $attribute
+     *
+     * @param mixed $value
+     *
+     * @return bool if the value is valid
+     * @link TicketReference
+     * if the user has rights to the model
+     *
+     */
+    public function passes($attribute, $value)
+    {
+        if (! str_contains($value, ',')) return false;
+
+        $values = explode(',', $value);
+        if (count($values) !== 2) return false;
+
+        $type = $values[ 0 ];
+        if (! class_exists($type)) return false;
+        $model = resolve($type)->find($values[ 1 ]);
+        if (empty($model)
+            || ! $model instanceof TicketReference
+            || ! $model->hasReferenceAccess()) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return trans('The reference is not valid');
+    }
+}
diff --git a/src/Traits/HasTicketReference.php b/src/Traits/HasTicketReference.php
new file mode 100644
index 0000000..696baee
--- /dev/null
+++ b/src/Traits/HasTicketReference.php
@@ -0,0 +1,16 @@
+<?php
+
+
+namespace RexlManu\LaravelTickets\Traits;
+
+
+trait HasTicketReference
+{
+
+    public function toReference() : string
+    {
+        $type = get_class($this);
+        return "$type,$this->id";
+    }
+
+}