#5947 - roll up bulk asset checkout email

app/Events/CheckoutablesCheckedOutInBulk.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+
+class CheckoutablesCheckedOutInBulk
+{
+    use Dispatchable, SerializesModels;
+
+    public function __construct(
+        public Collection $assets,
+        public Model $target,
+        public User $admin,
+        public string $checkout_at,
+        public string $expected_checkin,
+        public string $note,
+    ) {
+    }
+}

app/Http/Controllers/Assets/BulkAssetsController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Assets;
 
+use App\Events\CheckoutablesCheckedOutInBulk;
 use App\Helpers\Helper;
 use App\Http\Controllers\CheckInOutRequest;
 use App\Http\Controllers\Controller;
@@ -12,6 +13,7 @@
 use App\View\Label;
 use Carbon\Carbon;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Context;
 use Illuminate\Support\Facades\Crypt;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Gate;
@@ -631,6 +633,8 @@ public function showCheckout() : View
      */
     public function storeCheckout(AssetCheckoutRequest $request) : RedirectResponse | ModelNotFoundException
     {
+        Context::add('action', 'bulk_asset_checkout');
+
         $this->authorize('checkout', Asset::class);
 
         try {
@@ -717,6 +721,15 @@ public function storeCheckout(AssetCheckoutRequest $request) : RedirectResponse
             });
 
             if (! $errors) {
+                CheckoutablesCheckedOutInBulk::dispatch(
+                    $assets,
+                    $target,
+                    $admin,
+                    $checkout_at,
+                    $expected_checkin,
+                    e($request->get('note')),
+                );
+
                 // Redirect to the new asset page
                 return redirect()->to('hardware')->with('success', trans_choice('admin/hardware/message.multi-checkout.success', $asset_ids));
             }

app/Listeners/CheckoutableListener.php

@@ -33,6 +33,7 @@
 use App\Notifications\CheckoutLicenseSeatNotification;
 use GuzzleHttp\Exception\ClientException;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Context;
 use Illuminate\Support\Facades\Mail;
 use Illuminate\Support\Facades\Notification;
 use Exception;
@@ -427,13 +428,20 @@ private function newMicrosoftTeamsWebhookEnabled(): bool
 
     private function shouldSendCheckoutEmailToUser(Model $checkoutable): bool
     {
+        // @todo: update comment
         /**
-         * Send an email if any of the following conditions are met:
+         * Send an email if we didn't get here from a bulk checkout
+         * and 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 (Context::get('action') === 'bulk_asset_checkout') {
+            // @todo: maybe we should see if there is only one asset being checked out and allow this to proceed if it is?
+            return false;
+        }
+
         if ($checkoutable->requireAcceptance()) {
             return true;
         }
@@ -451,6 +459,10 @@ private function shouldSendCheckoutEmailToUser(Model $checkoutable): bool
 
     private function shouldSendEmailToAlertAddress($acceptance = null): bool
     {
+        if (Context::get('action') === 'bulk_asset_checkout') {
+            return false;
+        }
+
         $setting = Setting::getSettings();
 
         if (!$setting) {

app/Listeners/CheckoutablesCheckedOutInBulkListener.php

@@ -0,0 +1,149 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\CheckoutablesCheckedOutInBulk;
+use App\Mail\BulkAssetCheckoutMail;
+use App\Models\Asset;
+use App\Models\Location;
+use App\Models\Setting;
+use App\Models\User;
+use Exception;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Mail;
+
+class CheckoutablesCheckedOutInBulkListener
+{
+
+    public function subscribe($events)
+    {
+        $events->listen(
+            CheckoutablesCheckedOutInBulk::class,
+            CheckoutablesCheckedOutInBulkListener::class
+        );
+    }
+
+    public function handle(CheckoutablesCheckedOutInBulk $event): void
+    {
+        $notifiableUser = $this->getNotifiableUser($event);
+
+        $shouldSendEmailToUser = $this->shouldSendCheckoutEmailToUser($notifiableUser, $event->assets);
+        $shouldSendEmailToAlertAddress = $this->shouldSendEmailToAlertAddress($event->assets);
+
+        if ($shouldSendEmailToUser && $notifiableUser) {
+            try {
+                Mail::to($notifiableUser)->send(new BulkAssetCheckoutMail(
+                    $event->assets,
+                    $event->target,
+                    $event->admin,
+                    $event->checkout_at,
+                    $event->expected_checkin,
+                    $event->note,
+                ));
+
+                Log::info('BulkAssetCheckoutMail sent to checkout target');
+            } catch (Exception $e) {
+                Log::debug("Exception caught during BulkAssetCheckoutMail to target: " . $e->getMessage());
+            }
+        }
+
+        if ($shouldSendEmailToAlertAddress && Setting::getSettings()->admin_cc_email) {
+            try {
+                Mail::to(Setting::getSettings()->admin_cc_email)->send(new BulkAssetCheckoutMail(
+                    $event->assets,
+                    $event->target,
+                    $event->admin,
+                    $event->checkout_at,
+                    $event->expected_checkin,
+                    $event->note,
+                ));
+
+                Log::info('BulkAssetCheckoutMail sent to admin_cc_email');
+            } catch (Exception $e) {
+                Log::debug("Exception caught during BulkAssetCheckoutMail to admin_cc_email: " . $e->getMessage());
+            }
+        }
+    }
+
+    private function shouldSendCheckoutEmailToUser(?User $user, Collection $assets): bool
+    {
+        if (!$user->email) {
+            return false;
+        }
+
+        if ($this->hasAssetWithEula($assets)) {
+            return true;
+        }
+
+        if ($this->hasAssetWithCategorySettingToSendEmail($assets)) {
+            return true;
+        }
+
+        return $this->requiresAcceptance($assets);
+    }
+
+    private function shouldSendEmailToAlertAddress(Collection $assets): bool
+    {
+        $setting = Setting::getSettings();
+
+        if (!$setting) {
+            return false;
+        }
+
+        if ($setting->admin_cc_always) {
+            return true;
+        }
+
+        if (!$this->requiresAcceptance($assets)) {
+            return false;
+        }
+
+        return (bool) $setting->admin_cc_email;
+    }
+
+    private function hasAssetWithEula(Collection $assets): bool
+    {
+        foreach ($assets as $asset) {
+            if ($asset->getEula()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function hasAssetWithCategorySettingToSendEmail(Collection $assets): bool
+    {
+        foreach ($assets as $asset) {
+            if ($asset->checkin_email()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function requiresAcceptance(Collection $assets): bool
+    {
+        return (bool) $assets->reduce(
+            fn($count, $asset) => $count + $asset->requireAcceptance()
+        );
+    }
+
+    private function getNotifiableUser(CheckoutablesCheckedOutInBulk $event)
+    {
+        $target = $event->target;
+
+        if ($target instanceof Asset) {
+            $target->load('assignedTo');
+            return $target->assignedto;
+        }
+
+        if ($target instanceof Location) {
+            return $target->manager;
+        }
+
+        return $target;
+    }
+}

app/Mail/BulkAssetCheckoutMail.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace App\Mail;
+
+use App\Models\Asset;
+use App\Models\CustomField;
+use App\Models\Location;
+use App\Models\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+
+class BulkAssetCheckoutMail extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    public bool $requires_acceptance;
+
+    public function __construct(
+        public Collection $assets,
+        public Model $target,
+        public User $admin,
+        public string $checkout_at,
+        public string $expected_checkin,
+        public string $note,
+    ) {
+        $this->requires_acceptance = $this->requiresAcceptance();
+
+        $this->loadCustomFieldsOnAssets();
+    }
+
+    public function envelope(): Envelope
+    {
+        return new Envelope(
+            subject: $this->getSubject(),
+        );
+    }
+
+    public function content(): Content
+    {
+        return new Content(
+            markdown: 'mail.markdown.bulk-asset-checkout-mail',
+            with: [
+                'introduction' => $this->getIntroduction(),
+                'requires_acceptance' => $this->requires_acceptance,
+                'requires_acceptance_wording' => $this->getRequiresAcceptanceWording(),
+                'acceptance_url' => $this->acceptanceUrl(),
+            ],
+        );
+    }
+
+    public function attachments(): array
+    {
+        return [];
+    }
+
+    private function getSubject(): string
+    {
+        if ($this->assets->count() > 1) {
+            return ucfirst(trans('general.assets_checked_out_count'));
+        }
+
+        return trans('mail.Asset_Checkout_Notification', ['tag' => $this->assets->first()->asset_tag]);
+    }
+
+    private function getIntroduction(): string
+    {
+        if ($this->target instanceof Location) {
+            return trans_choice('mail.new_item_checked_location', $this->assets->count(), ['location' => $this->target->name]);
+        }
+
+        return trans_choice('mail.new_item_checked', $this->assets->count());
+    }
+
+    private function acceptanceUrl()
+    {
+        if ($this->assets->count() > 1) {
+            return route('account.accept');
+        }
+
+        return route('account.accept.item', $this->assets->first());
+    }
+
+    private function loadCustomFieldsOnAssets(): void
+    {
+        $this->assets = $this->assets->map(function (Asset $asset) {
+            $fields = $asset->model?->fieldset?->fields->filter(function (CustomField $field) {
+                return $field->show_in_email && !$field->field_encrypted;
+            });
+
+            $asset->setRelation('fields', $fields);
+
+            return $asset;
+        });
+    }
+
+    private function requiresAcceptance(): bool
+    {
+        return (bool) $this->assets->reduce(
+            fn($count, $asset) => $count + $asset->requireAcceptance()
+        );
+    }
+
+    private function getRequiresAcceptanceWording(): array
+    {
+        if (!$this->requiresAcceptance()) {
+            return [];
+        }
+
+        if ($this->assets->count() > 1) {
+            return [
+                // todo: translate
+                trans_choice('mail.items_checked_out_require_acceptance', $this->assets->count()),
+                "**[✔ Click here to review the terms of use and accept the items]({$this->acceptanceUrl()})**",
+            ];
+        }
+
+        return [
+            // todo: translate
+            trans_choice('mail.items_checked_out_require_acceptance', $this->assets->count()),
+            "**[✔ Click here to review the terms of use and accept the item]({$this->acceptanceUrl()})**",
+        ];
+    }
+}

app/Mail/CheckoutAssetMail.php

@@ -14,7 +14,6 @@
 use Illuminate\Mail\Mailables\Attachment;
 use Illuminate\Mail\Mailables\Content;
 use Illuminate\Mail\Mailables\Envelope;
-use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Queue\SerializesModels;
 
 class CheckoutAssetMail extends Mailable