feature escalation

mooxphp · Dec 5, 2024 · 221f7b0 · 221f7b0
1 parent 76dd371
commit 221f7b0
Show file tree

Hide file tree

Showing 15 changed files with 314 additions and 66 deletions.
diff --git a/.env.example b/.env.example
@@ -53,6 +53,12 @@ WP_SECURE_AUTH_SALT="ThisIsASecretKey!DoNotUseItInProduction!ChangeIt!"
 WP_LOGGED_IN_SALT="ThisIsASecretKey!DoNotUseItInProduction!ChangeIt!"
 WP_NONCE_SALT="ThisIsASecretKey!DoNotUseItInProduction!ChangeIt!"
 
+EXPIRY_SEND_ESCALATION=false
+EXPIRY_SEND_ESCALATION_DAYS_BEFORE=7
+EXPIRY_SEND_ESCALATION_COPY=[email protected]
+EXPIRY_PANEL_PATH=moox
+LOGO_URL="https://moox.org/img/logo.png"
+
 APP_LOCALE=en
 APP_FALLBACK_LOCALE=en
 APP_FAKER_LOCALE=en_US

diff --git a/config/expiry.php b/config/expiry.php
@@ -192,6 +192,21 @@
     'user_model' => \Moox\Press\Models\WpUser::class,
     'default_notified_to' => 1,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Escalation Settings
+    |--------------------------------------------------------------------------
+    | Configure notifications for escalations.
+    | Define timing and recipients.
+    | Set the dashboard path.
+    */
+
+    'send-escalation' => env('EXPIRY_SEND_ESCALATION', true),
+    'send-escalation-days-before' => env('EXPIRY_SEND_ESCALATION_DAYS_BEFORE', 7),
+    'send-escalation-copy' => env('EXPIRY_SEND_ESCALATION_COPY', '[email protected]'),
+    'panel_path' => env('EXPIRY_PANEL_PATH', 'press'),
+    'logo_url' => env('LOGO_URL', 'https://moox.org/img/logo.png'),
+
     /*
     |--------------------------------------------------------------------------
     | Disable actions

diff --git a/packages/core/resources/lang/de/expiry.php b/packages/core/resources/lang/de/expiry.php
@@ -21,6 +21,12 @@
     'notifyUser' => 'Verantwortlicher',
     'expiry_job' => 'Typ',
 
+    'escalated_entries_in_expiry_dashboard' => 'Eskalierte Einträge im Expiry Dashboard',
+    'following_escalated_entries' => 'Folgende Einträge sind eskaliert:',
+    'will_expire_at' => 'Läuft ab am',
+    'review_entreis' => 'Bitte überprüfen Sie diese Einträge so bald wie möglich im ',
+    'expiry_dashboard' => 'Ablaufdaten Dashboard',
+
     'set_date_based_on_cycle' => 'Neues Ablaufdatum setzen basierend auf dem Turnus',
     'date_updated' => 'Ablaufdatum erfolgreich aktualisiert',
     'set_new_expiry_date' => 'Neues Ablaufdatum setzen',

diff --git a/packages/core/resources/lang/en/expiry.php b/packages/core/resources/lang/en/expiry.php
@@ -22,9 +22,15 @@
     'escalated_at' => 'Escalated at',
     'escalated_to' => 'Escalated to',
     'cycle' => 'Cycle',
-    'notifyUser' => 'Verantwortlicher',
+    'notifyUser' => 'Assignee',
     'expiry_job' => 'Type',
 
+    'escalated_entries_in_expiry_dashboard' => 'Escalated entries in the expiry dashboard',
+    'following_escalated_entries' => 'The following entries have been escalated:',
+    'will_expire_at' => 'Will expire at',
+    'review_entreis' => 'Please review these entries as soon as possible in the ',
+    'expiry_dashboard' => 'Expiry Dashboard',
+
     'set_date_based_on_cycle' => 'Set date based on cycle',
     'date_updated' => 'Expiry date successfully updated',
     'set_new_expiry_date' => 'Set New Expiry Date',

diff --git a/packages/expiry/config/expiry.php b/packages/expiry/config/expiry.php
@@ -189,6 +189,21 @@
     'user_model' => \Moox\Press\Models\WpUser::class,
     'default_notified_to' => 1,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Escalation Settings
+    |--------------------------------------------------------------------------
+    | Configure notifications for escalations.
+    | Define timing and recipients.
+    | Set the dashboard path.
+    */
+
+    'send-escalation' => env('EXPIRY_SEND_ESCALATION', false),
+    'send-escalation-days-before' => env('EXPIRY_SEND_ESCALATION_DAYS_BEFORE', 7),
+    'send-escalation-copy' => env('EXPIRY_SEND_ESCALATION_COPY', '[email protected]'),
+    'panel_path' => env('EXPIRY_PANEL_PATH', 'moox'),
+    'logo_url' => env('LOGO_URL', 'https://moox.org/img/logo.png'),
+
     /*
     |--------------------------------------------------------------------------
     | Disable actions

diff --git a/packages/expiry/resources/views/emails/escalated_expiries.blade.php b/packages/expiry/resources/views/emails/escalated_expiries.blade.php
@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+<html lang="de">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Escalated Entries</title>
+    <style>
+        body {
+            font-family: 'Arial', sans-serif;
+            margin: 0;
+            padding: 0;
+            background-color: #f9fafb;
+        }
+
+        .container {
+            width: 100%;
+            max-width: 800px;
+            margin: 20px auto;
+            padding: 20px;
+            background-color: #ffffff;
+            border-radius: 8px;
+            box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
+        }
+
+        h1,
+        h3 {
+            font-size: 1.25rem;
+            color: #333333;
+            margin-bottom: 20px;
+        }
+
+        p {
+            font-size: 1rem;
+            color: #555555;
+        }
+
+        .table {
+            width: 100%;
+            border-collapse: collapse;
+            margin-top: 20px;
+        }
+
+        .table th,
+        .table td {
+            padding: 12px;
+            text-align: left;
+            border-bottom: 1px solid #e0e0e0;
+        }
+
+        .table th {
+            background-color: #f4f4f4;
+            font-weight: 600;
+            color: #333333;
+        }
+
+        .table tr:nth-child(even) {
+            background-color: #f9f9f9;
+        }
+
+        .table tr:hover {
+            background-color: #f1f1f1;
+        }
+
+        .table .title {
+            font-weight: bold;
+            color: #1a202c;
+        }
+
+        .table .escalation {
+            color: #e53e3e;
+            font-weight: bold;
+        }
+
+
+        .footer {
+            margin-top: 20px;
+            font-size: 0.875rem;
+            color: #777777;
+        }
+
+        .footer a {
+            color: #3182ce;
+            text-decoration: none;
+        }
+
+        .footer a:hover {
+            text-decoration: underline;
+        }
+
+        .logo {
+            display: block;
+            margin-bottom: 20px;
+        }
+    </style>
+</head>
+
+<body>
+    <div class="container">
+        <!-- Header with Logo -->
+        <div class="logo">
+            <img src="{{ config('expiry.logo_url') }}" alt="Company Logo" class="w-24 h-auto">
+        </div>
+        <h1>{{ __('core::expiry.escalated_entries_in_expiry_dashboard') }}</h1>
+        <h4>{{ __('core::expiry.following_escalated_entries') }}</h4>
+
+        <!-- Escalated Entries -->
+        <table class="table">
+            <thead>
+                <tr>
+                    <th>{{ __('core::core.title') }}</th>
+                    <th>{{ __('core::expiry.notifyUser') }}</th>
+                    <th>{{ __('core::expiry.will_expire_at') }}</th>
+                    <th>{{ __('core::expiry.processing_deadline') }}</th>
+                    <th>{{ __('core::expiry.escalated_at') }}</th>
+                </tr>
+            </thead>
+            <tbody>
+                @foreach ($escalatedEntries as $entry)
+                    <tr>
+                        <td class="title">{{ $entry['title'] }}</td>
+                        <td>{{ $entry['notified_to'] }}</td>
+                        <td>{{ $entry['expired_at'] }}</td>
+                        <td>{{ $entry['processing_deadline'] }}</td>
+                        <td class="escalation">{{ $entry['escalated_at'] }}</td>
+                    </tr>
+                @endforeach
+            </tbody>
+        </table>
+
+        <br>
+
+        <!-- Footer -->
+        <p class="footer">{{ __('core::expiry.review_entreis') }}<a
+                href="{{ url($panelPath . '/expiries') }}">{{ __('core::expiry.expiry_dashboard') }}</a>.</p>
+    </div>
+</body>
+
+</html>
diff --git a/packages/expiry/resources/views/emails/expirySummary.blade.php b/packages/expiry/resources/views/emails/expirySummary.blade.php
diff --git a/packages/expiry/src/Commands/EscalatedExpiriesCommand.php b/packages/expiry/src/Commands/EscalatedExpiriesCommand.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Moox\Expiry\Commands;
+
+use Illuminate\Console\Command;
+use Moox\Expiry\Jobs\SendEscalatedExpiriesJob;
+
+class EscalatedExpiriesCommand extends Command
+{
+    protected $signature = 'mooxexpiry:escalated';
+
+    protected $description = 'Dispatch the job to send notifications for escalated expiries';
+
+    public function handle()
+    {
+        SendEscalatedExpiriesJob::dispatch();
+        $this->info('Escalated Expiries Notification Dispatched');
+    }
+}
diff --git a/packages/expiry/src/ExpiryServiceProvider.php b/packages/expiry/src/ExpiryServiceProvider.php
@@ -4,6 +4,7 @@
 
 namespace Moox\Expiry;
 
+use Moox\Expiry\Commands\EscalatedExpiriesCommand;
 use Moox\Expiry\Commands\InstallCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -15,10 +16,10 @@ public function configurePackage(Package $package): void
         $package
             ->name('expiry')
             ->hasConfigFile()
-            ->hasViews()
+            ->hasViews('escalated_expiries')
             ->hasMigration('create_expiries_table')
             ->hasRoutes('api')
-            ->hasCommands(InstallCommand::class);
+            ->hasCommands(InstallCommand::class, EscalatedExpiriesCommand::class);
     }
 
     public function boot()

diff --git a/packages/expiry/src/Jobs/CollectExpiries.php b/packages/expiry/src/Jobs/CollectExpiries.php
@@ -60,7 +60,8 @@ public function handle()
                 'expired_at' => Carbon::now()->addDays(60),
                 'processing_deadline' => Carbon::now()->addDays(30),
                 'notified_to' => 2,
-                'escalated_to' => 3,
+                'escalated_at' => Carbon::now()->addDays(-10),
+                'escalated_to' => null,
                 'handled_by' => 1,
                 'done_at' => Carbon::now()->addDays(10),
             ],
@@ -99,10 +100,10 @@ public function handle()
                     'escalated_to' => $data['escalated_to'],
                     'handled_by' => $data['handled_by'],
                     'done_at' => $data['done_at'],
-                    'cycle' => array_rand($cycleOptions), // Random cycle
+                    'cycle' => array_rand($cycleOptions),
                     'meta_id' => null,
                     'notified_at' => Carbon::now(),
-                    'escalated_at' => Carbon::now()->addDays(2),
+                    'escalated_at' => $data['escalated_at'] ?? null,
                 ]
             );
         }

diff --git a/packages/expiry/src/Jobs/SendEscalatedExpiriesJob.php b/packages/expiry/src/Jobs/SendEscalatedExpiriesJob.php
@@ -0,0 +1,66 @@
+<?php
+
+namespace Moox\Expiry\Jobs;
+
+use Carbon\Carbon;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Mail;
+use Moox\Expiry\Mail\EscalatedExpiriesMail;
+use Moox\Expiry\Models\Expiry;
+
+class SendEscalatedExpiriesJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function handle()
+    {
+        if (! config('expiry.send-escalation')) {
+            return;
+        }
+
+        $adminEmail = config('expiry.send-escalation-copy');
+        $panelPath = config('expiry.panel_path');
+
+        $escalatedExpiries = Expiry::query()
+            ->where(function ($query) {
+                $query->whereNull('escalated_to')
+                    ->whereNotNull('escalated_at');
+            })
+            ->get();
+
+        if ($escalatedExpiries->isEmpty()) {
+            return;
+        }
+
+        $escalatedEntries = $escalatedExpiries->filter(fn ($entry) => $entry->escalated_at !== null);
+
+        $escalatedEntries->each(function ($entry) {
+            $responsibleId = $entry->notified_to;
+            $entry->escalated_to = $responsibleId;
+            $entry->save();
+        });
+
+        $data = [
+            'escalatedEntries' => $escalatedEntries->map(function ($entry) {
+                return [
+                    'title' => $entry->title,
+                    'expired_at' => Carbon::parse($entry->expired_at)->format('d.m.Y'),
+                    'processing_deadline' => Carbon::parse($entry->processing_deadline)->format('d.m.Y'),
+                    'escalated_at' => Carbon::parse($entry->escalated_at)->format('d.m.Y'),
+                    'notified_to' => config('expiry.user_model')::where('ID', $entry->notified_to)->first()?->display_name,
+                    'user_email' => config('expiry.user_model')::where('ID', $entry->notified_to)->first()?->email,
+                ];
+            }),
+        ];
+
+        $responsibleEmail = config('expiry.user_model')::where('ID', $escalatedExpiries->first()->notified_to)->first()?->email;
+
+        Mail::to($responsibleEmail)
+            ->cc($adminEmail)
+            ->send(new EscalatedExpiriesMail($data, $panelPath));
+    }
+}