[WIP] EPIC / FOUR-29101: Cases Retention Policy

ProcessMaker/Console/Commands/EvaluateCaseRetention.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace ProcessMaker\Console\Commands;
+
+use Illuminate\Console\Command;
+use ProcessMaker\Jobs\EvaluateProcessRetentionJob;
+use ProcessMaker\Models\Process;
+use ProcessMaker\Models\ProcessCategory;
+
+class EvaluateCaseRetention extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'cases:retention:evaluate';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Evaluate and delete cases past their retention period';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        // Only run if case retention policy is enabled
+        $enabled = config('app.case_retention_policy_enabled', false);
+        if (!$enabled) {
+            $this->info('Case retention policy is disabled');
+            $this->error('Skipping case retention evaluation');
+
+            return;
+        }
+
+        $this->info('Case retention policy is enabled');
+        $this->info('Dispatching retention evaluation jobs for all processes');
+
+        // Get system category IDs to exclude
+        $systemCategoryIds = ProcessCategory::where('is_system', true)->pluck('id');
+
+        // Exclude processes that are templates or in system categories
+        $jobCount = 0;
+        $query = Process::where('is_template', '!=', 1);
+
+        // Exclude processes in system categories
+        if ($systemCategoryIds->isNotEmpty()) {
+            $query->where(function ($q) use ($systemCategoryIds) {
+                $q->where(function ($subQuery) use ($systemCategoryIds) {
+                    $subQuery->whereNotIn('process_category_id', $systemCategoryIds)
+                        ->orWhereNull('process_category_id');
+                });
+            })
+            ->whereDoesntHave('categories', function ($q) use ($systemCategoryIds) {
+                // Exclude processes with any category assignment to system categories
+                $q->whereIn('process_categories.id', $systemCategoryIds);
+            });
+        }
+
+        $query->chunkById(100, function ($processes) use (&$jobCount) {
+            foreach ($processes as $process) {
+                dispatch(new EvaluateProcessRetentionJob($process->id));
+                $jobCount++;
+            }
+        });
+
+        $this->info("Dispatched {$jobCount} retention evaluation job(s) to the queue");
+        $this->info('Jobs will be processed asynchronously by queue workers');
+    }
+}

ProcessMaker/Console/Kernel.php

@@ -90,6 +90,13 @@ protected function schedule(Schedule $schedule)
                 break;
         }
 
+        // evaluate cases retention policy
+        $schedule->command('cases:retention:evaluate')
+            ->daily()
+            ->onOneServer()
+            ->withoutOverlapping()
+            ->runInBackground();
+
         // 5 minutes is recommended in https://laravel.com/docs/12.x/horizon#metrics
         $schedule->command('horizon:snapshot')->everyFiveMinutes();
     }

ProcessMaker/Http/Controllers/Api/Actions/Cases/DeleteCase.php

@@ -99,20 +99,4 @@ private function getTaskDraftIds(array $tokenIds): array
             ->pluck('id')
             ->all();
     }
-
-    private function dispatchSavedSearchRecount(): void
-    {
-        if (!config('savedsearch.count', false)) {
-            return;
-        }
-
-        $jobClass = 'ProcessMaker\\Package\\SavedSearch\\Jobs\\RecountAllSavedSearches';
-        if (!class_exists($jobClass)) {
-            return;
-        }
-
-        DB::afterCommit(static function () use ($jobClass): void {
-            $jobClass::dispatch(['request', 'task']);
-        });
-    }
 }

ProcessMaker/Http/Controllers/Api/Actions/Cases/DeletesCaseRecords.php

@@ -21,18 +21,30 @@
 
 trait DeletesCaseRecords
 {
-    private function deleteCasesStarted(string $caseNumber): void
+    private function deleteCasesStarted(string | array $caseNumbers): void
     {
-        CaseStarted::query()
-            ->where('case_number', $caseNumber)
-            ->delete();
+        if (is_array($caseNumbers) && $caseNumbers !== []) {
+            CaseStarted::query()
+                ->whereIn('case_number', $caseNumbers)
+                ->delete();
+        } else {
+            CaseStarted::query()
+                ->where('case_number', $caseNumbers)
+                ->delete();
+        }
     }
 
-    private function deleteCasesParticipated(string $caseNumber): void
+    private function deleteCasesParticipated(string | array $caseNumbers): void
     {
-        CaseParticipated::query()
-            ->where('case_number', $caseNumber)
-            ->delete();
+        if (is_array($caseNumbers)) {
+            CaseParticipated::query()
+                ->whereIn('case_number', $caseNumbers)
+                ->delete();
+        } else {
+            CaseParticipated::query()
+                ->where('case_number', $caseNumbers)
+                ->delete();
+        }
     }
 
     private function deleteCaseNumbers(array $requestIds): void
@@ -183,11 +195,18 @@ private function deleteRequestMedia(array $requestIds): void
             ->delete();
     }
 
-    private function deleteComments(string $caseNumber, array $requestIds, array $tokenIds): void
+    private function deleteComments(string | array $caseNumbers, array $requestIds, array $tokenIds): void
     {
-        Comment::query()
-            ->where('case_number', $caseNumber)
-            ->orWhere(function ($query) use ($requestIds, $tokenIds) {
+        if (is_array($caseNumbers) && $caseNumbers !== []) {
+            $query = Comment::query()
+                ->whereIn('case_number', $caseNumbers);
+        } else {
+            $query = Comment::query()
+                ->where('case_number', $caseNumbers);
+        }
+
+        if ($requestIds !== [] || $tokenIds !== []) {
+            $query->orWhere(function ($query) use ($requestIds, $tokenIds) {
                 $query->where('commentable_type', ProcessRequest::class)
                     ->whereIn('commentable_id', $requestIds);
 
@@ -197,8 +216,10 @@ private function deleteComments(string $caseNumber, array $requestIds, array $to
                             ->whereIn('commentable_id', $tokenIds);
                     });
                 }
-            })
-            ->delete();
+            });
+        }
+
+        $query->delete();
     }
 
     private function deleteNotifications(array $requestIds): void
@@ -220,4 +241,20 @@ private function deleteNotifications(array $requestIds): void
             ->whereIn('data->type', $notificationTypes)
             ->delete();
     }
+
+    private function dispatchSavedSearchRecount(): void
+    {
+        if (!config('savedsearch.count', false)) {
+            return;
+        }
+
+        $jobClass = 'ProcessMaker\\Package\\SavedSearch\\Jobs\\RecountAllSavedSearches';
+        if (!class_exists($jobClass)) {
+            return;
+        }
+
+        DB::afterCommit(static function () use ($jobClass): void {
+            $jobClass::dispatch(['request', 'task']);
+        });
+    }
 }