Separated Notifications and Emails: Check ins and Check outs

app/Http/Controllers/Account/AcceptanceController.php

@@ -338,4 +338,5 @@ public function store(Request $request, $id) : RedirectResponse
         return redirect()->to('account/accept')->with('success', $return_msg);
 
     }
+
 }

app/Listeners/CheckoutableListener.php

@@ -3,13 +3,19 @@
 namespace App\Listeners;
 
 use App\Events\CheckoutableCheckedOut;
+use App\Mail\CheckinAccessoryMail;
+use App\Mail\CheckinLicenseMail;
+use App\Mail\CheckoutAccessoryMail;
+use App\Mail\CheckoutAssetMail;
+use App\Mail\CheckinAssetMail;
+use App\Mail\CheckoutConsumableMail;
+use App\Mail\CheckoutLicenseMail;
 use App\Models\Accessory;
 use App\Models\Asset;
 use App\Models\CheckoutAcceptance;
 use App\Models\Component;
 use App\Models\Consumable;
 use App\Models\LicenseSeat;
-use App\Models\Recipients\AdminRecipient;
 use App\Models\Setting;
 use App\Models\User;
 use App\Notifications\CheckinAccessoryNotification;
@@ -20,6 +26,7 @@
 use App\Notifications\CheckoutConsumableNotification;
 use App\Notifications\CheckoutLicenseSeatNotification;
 use GuzzleHttp\Exception\ClientException;
+use Illuminate\Support\Facades\Mail;
 use Illuminate\Support\Facades\Notification;
 use Exception;
 use Illuminate\Support\Facades\Log;
@@ -43,33 +50,42 @@ public function onCheckedOut($event)
         /**
          * Make a checkout acceptance and attach it in the notification
          */
+        $settings = Setting::getSettings();
         $acceptance = $this->getCheckoutAcceptance($event);
-        $notifiables = $this->getNotifiables($event);
+        $adminCcEmailsArray = [];
 
+        if($settings->admin_cc_email !== '') {
+            $adminCcEmail = $settings->admin_cc_email;
+            $adminCcEmailsArray = array_map('trim', explode(',', $adminCcEmail));
+        }
+        $ccEmails = array_filter($adminCcEmailsArray);
+        $notifiable = $event->checkedOutTo;
+        $mailable = $this->getCheckoutMailType($event, $acceptance);
         // Send email notifications
         try {
-            foreach ($notifiables as $notifiable) {
-                if ($notifiable instanceof User && $notifiable->email != '') {
-                    if (! $event->checkedOutTo->locale){
-                        Notification::locale(Setting::getSettings()->locale)->send($notifiable, $this->getCheckoutNotification($event, $acceptance));
-                    }
-                    else {
-                        Notification::send($notifiable, $this->getCheckoutNotification($event, $acceptance));
-                    }
+                if  (!$event->checkedOutTo->locale){
+                    $mailable->locale($event->checkedOutTo->locale);
                 }
+
+            /**
+             * Send an email if any of the following conditions are met:
+             * 1. The asset requires acceptance
+             * 2. The item has a EULA
+             * 3. The item should send an email at check-in/check-out
+             */
+            if ($notifiable instanceof User && $notifiable->email != '') {
+                if ($event->checkoutable->requireAcceptance() || $event->checkoutable->getEula() ||
+                    (method_exists($event->checkoutable, 'checkin_email') && $event->checkoutable->checkin_email())) {
+                Mail::to($notifiable)->cc($ccEmails)->send($mailable);
+                Log::info('Sending email, Locale: ' . ($event->checkedOutTo->locale ?? 'default'));
             }
+        }
 
-            // Send Webhook notification
-            if ($this->shouldSendWebhookNotification()) {
-                // Slack doesn't include the URL in its messaging format, so this is needed to hit the endpoint
-                if (Setting::getSettings()->webhook_selected === 'slack' || Setting::getSettings()->webhook_selected === 'general') {
-                    Notification::route('slack', Setting::getSettings()->webhook_endpoint)
-                        ->notify($this->getCheckoutNotification($event, $acceptance));
-                } else {
+//                 Send Webhook notification
+                if ($this->shouldSendWebhookNotification()) {
                     Notification::route(Setting::getSettings()->webhook_selected, Setting::getSettings()->webhook_endpoint)
                         ->notify($this->getCheckoutNotification($event, $acceptance));
                 }
-            }
         } catch (ClientException $e) {
             Log::debug("Exception caught during checkout notification: " . $e->getMessage());
         } catch (Exception $e) {
@@ -103,32 +119,41 @@ public function onCheckedIn($event)
                 }
             }
         }
+        $settings = Setting::getSettings();
+        $adminCcEmailsArray = [];
+
+        if($settings->admin_cc_email !== '') {
+            $adminCcEmail = $settings->admin_cc_email;
+            $adminCcEmailsArray = array_map('trim', explode(',', $adminCcEmail));
+        }
+        $ccEmails = array_filter($adminCcEmailsArray);
+        $notifiable = $event->checkedOutTo;
+        $mailable =  $this->getCheckinMailType($event);
 
-        $notifiables = $this->getNotifiables($event);
         // Send email notifications
         try {
-            foreach ($notifiables as $notifiable) {
-                if ($notifiable instanceof User && $notifiable->email != '') {
-                    if (! $event->checkedOutTo->locale){
-                        Notification::locale(Setting::getSettings()->locale)->send($notifiable, $this->getCheckoutNotification($event, $acceptance));
-                    }
-                    else {
-                        Notification::send($notifiable, $this->getCheckinNotification($event));
-                    }
+            if  (!$event->checkedOutTo->locale){
+                $mailable->locale($event->checkedOutTo->locale);
+            }
+            /**
+             * Send an email if any of the following conditions are met:
+             * 1. The asset requires acceptance
+             * 2. The item has a EULA
+             * 3. The item should send an email at check-in/check-out
+             */
+
+            if ($notifiable instanceof User && $notifiable->email != '') {
+                if ($event->checkoutable->requireAcceptance() || $event->checkoutable->getEula() ||
+                    (method_exists($event->checkoutable, 'checkin_email') && $event->checkoutable->checkin_email())) {
+                    Mail::to($notifiable)->cc($ccEmails)->send($mailable);
+                    Log::info('Sending email, Locale: ' . $event->checkedOutTo->locale);
                 }
             }
             // Send Webhook notification
             if ($this->shouldSendWebhookNotification()) {
-                // Slack doesn't include the URL in its messaging format, so this is needed to hit the endpoint
-                if (Setting::getSettings()->webhook_selected === 'slack' || Setting::getSettings()->webhook_selected === 'general') {
-                    Notification::route('slack', Setting::getSettings()->webhook_endpoint)
-                        ->notify($this->getCheckinNotification($event));
-                } else {
                     Notification::route(Setting::getSettings()->webhook_selected, Setting::getSettings()->webhook_endpoint)
                         ->notify($this->getCheckinNotification($event));
                 }
-            }
-
         } catch (ClientException $e) {
             Log::warning("Exception caught during checkout notification: " . $e->getMessage());
         } catch (Exception $e) {
@@ -159,33 +184,6 @@ private function getCheckoutAcceptance($event)
         return $acceptance;      
     }
 
-    /**
-     * Gets the entities to be notified of the passed event
-     * 
-     * @param  Event $event
-     * @return Collection
-     */
-    private function getNotifiables($event)
-    {
-        $notifiables = collect();
-
-        /**
-         * Notify who checked out the item as long as the model can route notifications
-         */
-        if (method_exists($event->checkedOutTo, 'routeNotificationFor')) {
-            $notifiables->push($event->checkedOutTo);
-        }
-
-        /**
-         * Notify Admin users if the settings is activated
-         */
-        if ((Setting::getSettings()) && (Setting::getSettings()->admin_cc_email != '')) {
-            $notifiables->push(new AdminRecipient());
-        }
-
-        return $notifiables;       
-    }
-
     /**
      * Get the appropriate notification for the event
      * 
@@ -234,7 +232,7 @@ private function getCheckoutNotification($event, $acceptance = null)
                 break;
             case Consumable::class:
                 $notificationClass = CheckoutConsumableNotification::class;
-                break;    
+                break;
             case LicenseSeat::class:
                 $notificationClass = CheckoutLicenseSeatNotification::class;
                 break;
@@ -243,6 +241,30 @@ private function getCheckoutNotification($event, $acceptance = null)
 
         return new $notificationClass($event->checkoutable, $event->checkedOutTo, $event->checkedOutBy, $acceptance, $event->note);
     }
+    private function getCheckoutMailType($event, $acceptance){
+        $lookup = [
+            Accessory::class => CheckoutAccessoryMail::class,
+            Asset::class => CheckoutAssetMail::class,
+            LicenseSeat::class => CheckoutLicenseMail::class,
+            Consumable::class => CheckoutConsumableMail::class,
+        ];
+        $mailable= $lookup[get_class($event->checkoutable)];
+
+        return new $mailable($event->checkoutable, $event->checkedOutTo, $event->checkedOutBy, $event->note, $acceptance);
+
+    }
+    private function getCheckinMailType($event){
+        $lookup = [
+            Accessory::class => CheckinAccessoryMail::class,
+            Asset::class => CheckinAssetMail::class,
+            LicenseSeat::class => CheckinLicenseMail::class,
+        ];
+
+        $mailable= $lookup[get_class($event->checkoutable)];
+
+        return new $mailable($event->checkoutable, $event->checkedOutTo, $event->checkedInBy, $event->note);
+
+    }
 
     /**
      * Register the listeners for the subscriber.

app/Mail/CheckinAccessoryMail.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace App\Mail;
+
+use App\Models\Accessory;
+use App\Models\Setting;
+use App\Models\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Address;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+
+class CheckinAccessoryMail extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    /**
+     * Create a new message instance.
+     */
+    public function __construct(Accessory $accessory, $checkedOutTo, User $checkedInby, $note)
+    {
+        $this->item = $accessory;
+        $this->target = $checkedOutTo;
+        $this->admin = $checkedInby;
+        $this->note = $note;
+        $this->settings = Setting::getSettings();
+    }
+
+    /**
+     * Get the message envelope.
+     */
+    public function envelope(): Envelope
+    {
+        $from = new Address(env('MAIL_FROM_ADDR','[email protected]'));
+
+        return new Envelope(
+            from: $from,
+            subject: trans('mail.Accessory_Checkin_Notification'),
+        );
+    }
+
+    /**
+     * Get the message content definition.
+     */
+    public function content(): Content
+    {
+        return new Content(
+            markdown: 'mail.markdown.checkin-accessory',
+            with:   [
+                'item'          => $this->item,
+                'admin'         => $this->admin,
+                'note'          => $this->note,
+                'target'        => $this->target,
+            ]
+        );
+    }
+
+    /**
+     * Get the attachments for the message.
+     *
+     * @return array<int, \Illuminate\Mail\Mailables\Attachment>
+     */
+    public function attachments(): array
+    {
+        return [];
+    }
+}

app/Mail/CheckinAssetMail.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace App\Mail;
+
+use App\Helpers\Helper;
+use App\Models\Asset;
+use App\Models\Setting;
+use App\Models\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Address;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Queue\SerializesModels;
+
+class CheckinAssetMail extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    /**
+     * Create a new message instance.
+     */
+    public function __construct(Asset $asset, $checkedOutTo, User $checkedInBy, $note)
+    {
+        $this->target = $checkedOutTo;
+        $this->item = $asset;
+        $this->admin = $checkedInBy;
+        $this->note = $note;
+
+        $this->settings = Setting::getSettings();
+        $this->expected_checkin = '';
+
+        if ($this->item->expected_checkin) {
+            $this->expected_checkin = Helper::getFormattedDateObject($this->item->expected_checkin, 'date',
+                false);
+        }
+    }
+
+    /**
+     * Get the message envelope.
+     */
+    public function envelope(): Envelope
+    {
+        $from = new Address(env('MAIL_FROM_ADDR','[email protected]'));
+
+        return new Envelope(
+            from: $from,
+            subject: trans('mail.Asset_Checkin_Notification'),
+        );
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return Content
+     */
+    public function content(): Content
+    {
+        $this->item->load('assetstatus');
+        $fields = [];
+
+        // Check if the item has custom fields associated with it
+        if (($this->item->model) && ($this->item->model->fieldset)) {
+            $fields = $this->item->model->fieldset->fields;
+        }
+
+        return new Content(
+            markdown: 'mail.markdown.checkin-asset',
+            with:  [
+                'item'          => $this->item,
+                'status'        => $this->item->assetstatus?->name,
+                'admin'         => $this->admin,
+                'note'          => $this->note,
+                'target'        => $this->target,
+                'fields'        => $fields,
+                'expected_checkin'  => $this->expected_checkin,
+            ],
+        );
+    }
+
+    /**
+     * Get the attachments for the message.
+     *
+     * @return array<int, \Illuminate\Mail\Mailables\Attachment>
+     */
+    public function attachments(): array
+    {
+        return [];
+    }
+}