FOUR-25223: [EPIC] Email Notifications update

ProcessMaker/Http/Controllers/Api/ScreenController.php

@@ -482,6 +482,14 @@ public function duplicate(Screen $screen, Request $request)
      */
     public function destroy(Screen $screen)
     {
+        // Check if the screen is a default screen
+        if ($screen->is_default == 1) {
+            return response([
+                'message' => 'Cannot delete a default screen',
+                'errors' => ['is_default' => 'Default screens cannot be deleted'],
+            ], 422);
+        }
+
         $screen->delete();
         // Call new event to store changes in LOG
         ScreenDeleted::dispatch($screen);

ProcessMaker/Http/Controllers/Process/ModelerController.php

@@ -12,6 +12,7 @@
 use ProcessMaker\Models\ProcessCategory;
 use ProcessMaker\Models\ProcessLaunchpad;
 use ProcessMaker\Models\ProcessRequest;
+use ProcessMaker\Models\Screen;
 use ProcessMaker\Models\ScreenCategory;
 use ProcessMaker\Models\ScreenType;
 use ProcessMaker\Models\ScriptCategory;
@@ -125,6 +126,8 @@ public function prepareModelerData(
             $process->load('alternativeInfo');
         }
 
+        $defaultEmailNotification = $this->getDefaultEmailNotification();
+
         return [
             'process' => $process,
             'manager' => $manager,
@@ -147,6 +150,34 @@ public function prepareModelerData(
             'alternative' => $alternative,
             'abPublish' => PackageHelper::isPackageInstalled('ProcessMaker\Package\PackageABTesting\PackageServiceProvider'),
             'launchpad' => ProcessLaunchpad::getLaunchpad(true, $process->id),
+            'defaultEmailNotification' => $defaultEmailNotification,
+        ];
+    }
+
+    /**
+     * Get the default email notification configuration for tasks
+     *
+     * Returns an array containing the default email notification settings including:
+     * - subject: The default email subject template
+     * - type: The notification type (screen)
+     * - screenRef: The ID of the default email notification screen
+     * - toRecipients: Array of default recipients (assigned user)
+     * @return array{screenRef: mixed, subject: string, toRecipients: array, type: string}
+     */
+    private function getDefaultEmailNotification(): array
+    {
+        $screen = Screen::getScreenByKey('default-email-task-notification');
+
+        return [
+            'subject' => 'RE: {{_user.firstname}} assigned you in "{{_task_name}}"',
+            'type' => 'screen',
+            'screenRef' => $screen->id,
+            'toRecipients' => [
+                [
+                    'type' => 'assignedUser',
+                    'value' => null,
+                ],
+            ],
         ];
     }
 

ProcessMaker/Models/Screen.php

@@ -305,7 +305,17 @@ public static function getScreenByKey(string $key) : ?self
         return $screen;
     }
 
-    private static function createScreenByKey(string $key, bool $isSystem = true, string $path = null): self
+    public static function getScreenByKeyPerDefault(string $key) : ?self
+    {
+        $screen = self::firstWhere('key', $key);
+        if (!$screen) {
+            $screen = self::createScreenByKey($key, false, null, 1);
+        }
+
+        return $screen;
+    }
+
+    private static function createScreenByKey(string $key, bool $isSystem = true, string $path = null, $isDefault = 0): self
     {
         // If no path is provided, use the default path
         if (!$path) {
@@ -339,6 +349,7 @@ private static function createScreenByKey(string $key, bool $isSystem = true, st
         // Create new screen
         unset($screen['categories']);
         $screen['screen_category_id'] = null;
+        $screen['is_default'] = $isDefault;
 
         if ($newScreen) {
             $newScreen->fill($screen);

ProcessMaker/Repositories/TokenRepository.php

@@ -176,10 +176,6 @@ public function persistActivityActivated(ActivityInterface $activity, TokenInter
         if (!is_null($user)) {
             // Review if the task has enable the action by email
             $this->validateAndSendActionByEmail($activity, $token, $user->email);
-            // Review if the user has enable the email notification
-            $isEmailTaskValid = $this->validateEmailUserNotification($token, $user);
-            // Define the flag if the email needs to sent
-            $token->is_emailsent = $isEmailTaskValid ? 1 : 0;
         }
         $this->instanceRepository->persistInstanceUpdated($token->getInstance());
     }
@@ -231,71 +227,6 @@ private function validateAndSendActionByEmail(ActivityInterface $activity, Token
         }
     }
 
-    /**
-     * Validates the user's email notification settings and sends an email if enabled.
-     *
-     * @param TokenInterface $token The token containing task information.
-     * @param User $user The user to whom the email notification will be sent.
-     * @return mixed|null Returns the result of the email sending operation or null if not sent.
-     */
-    private function validateEmailUserNotification(TokenInterface $token, User $user)
-    {
-        try {
-            Log::Info('User isEmailTaskEnable: ' . $user->email_task_notification);
-            // Return if email task notification is not enabled or email is empty
-            if ($user->email_task_notification === 0 || empty($user->email)) {
-                return null;
-            }
-            // Prepare data for the email
-            $data = $this->prepareEmailData($token, $user);
-
-            // Send Email
-            return (new TaskActionByEmail())->sendAbeEmail($data['configEmail'], $user->email, $data['emailData']);
-        } catch (\Exception $e) {
-            // Catch and log the error
-            Log::error('Failed to validate and send email task notification', [
-                'error' => $e->getMessage(),
-            ]);
-        }
-    }
-
-    /**
-     * Prepares the email data and configuration for sending an email notification.
-     *
-     * @param TokenInterface $token The token containing task information.
-     * @param User $user The user for whom the email data is being prepared.
-     * @return array An associative array containing 'emailData' and 'configEmail'.
-     */
-    private function prepareEmailData(TokenInterface $token, User $user)
-    {
-        // Get the case
-        $caseTitle = ProcessRequest::where('id', $token->process_request_id)->value('case_title');
-        // Prepare the email data
-        $taskName = $token->element_name ?? '';
-        $emailData = [
-            'firstname' => $user->firstname ?? '',
-            'assigned_by' => Auth::user()->fullname ?? __('System'),
-            'element_name' => $taskName,
-            'case_title' => $caseTitle, // Populate this if needed
-            'due_date' => $token->due_at ?? '',
-            'link_review_task' => config('app.url') . '/' . 'tasks/' . $token->id . '/edit',
-            'imgHeader' => config('app.url') . '/img/processmaker_login.png',
-        ];
-        // Get the screen by key
-        $screen = Screen::getScreenByKey('default-email-task-notification');
-        // Prepare the email configuration
-        $configEmail = [
-            'emailServer' => 0, // Use the default email server
-            'subject' => "{$user->firstname} assigned you in '{$taskName}'",
-            'screenEmailRef' => $screen->id ?? 0, // Define here the screen to use
-        ];
-
-        return [
-            'emailData' => $emailData,
-            'configEmail' => $configEmail,
-        ];
-    }
-
     /**
      * Get due Variable
      *

database/migrations/2025_07_09_215813_add_is_default_column_for_screens.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('screens', function (Blueprint $table) {
+            $table->boolean('is_default')->default(false);
+        });
+        Schema::table('screen_versions', function (Blueprint $table) {
+            $table->boolean('is_default')->default(false);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('screens', function (Blueprint $table) {
+            $table->dropColumn('is_default');
+        });
+        Schema::table('screen_versions', function (Blueprint $table) {
+            $table->dropColumn('is_default');
+        });
+    }
+};