FOUR-18130: UX case detail

ProcessMaker/Http/Controllers/Api/ProcessRequestController.php

@@ -839,4 +839,43 @@ public function endEventDestination(ProcessRequest $request)
 
         return response()->json(['message' => __('End event found'), 'data' => $data]);
     }
+
+    /**
+     * This endpoint returns requests by case number
+     *  
+     * @param Request $request
+     *
+     * @return ApiCollection
+     */
+    public function getRequestsByCase(Request $request, User $user = null)
+    {
+        if (!$user) {
+            $user = Auth::user();
+        }
+
+        // Validate the inputs, including optional ones
+        $request->validate([
+            'case_number' => 'required|integer',
+            'order_by' => 'nullable|string|in:id,name,status,user_id,initiated_at,participants',
+            'order_direction' => 'nullable|string|in:asc,desc',
+            'page' => 'nullable|integer|min:1',
+            'per_page' => 'nullable|integer',
+        ]);
+
+        $query = ProcessRequest::forUser($user);
+
+        // Filter by case_number
+        $query->filterByCaseNumber($request);
+
+        // Apply ordering only if a valid order_by field is provided
+        $query->applyOrdering($request);
+        $response = $query->applyPagination($request);
+
+        // Get activeTasks and participants
+        $response = $response->map(function ($processRequest) use ($request) {
+            return new ProcessRequestResource($processRequest);
+        });
+
+        return new ApiCollection($response);
+    }
 }

ProcessMaker/Http/Controllers/Api/TaskController.php

@@ -53,6 +53,15 @@ class TaskController extends Controller
         'Completed' => 'CLOSED',
     ];
 
+    protected $defaultCase = [
+        'id', // Task #
+        'element_name', // Task Name
+        'user_id', // Participant
+        'process_id', // Process
+        'due_at', // Due At
+        'process_request_id', // Request Id #
+    ];
+
     /**
      * Display a listing of the resource.
      *
@@ -149,6 +158,55 @@ public function index(Request $request, $getTotal = false, User $user = null)
         return new TaskCollection($response);
     }
 
+    /**
+     * Get the task list related to the case
+     * @param Request $request
+     * @param User $user used by Saved Search package to return accurate counts
+     * @return array
+     */
+    public function indexCase(Request $request, User $user = null)
+    {
+        if (!$user) {
+            $user = Auth::user();
+        }
+
+        // Validate the inputs, including optional ones
+        $request->validate([
+            'case_number' => 'required|integer',
+            'status' => 'nullable|string|in:ACTIVE,CLOSED',
+            'order_by' => 'nullable|string|in:id,element_name,due_at,user.lastname,process.name',
+            'order_direction' => 'nullable|string|in:asc,desc',
+            'page' => 'nullable|integer|min:1',
+            'per_page' => 'nullable|integer',
+        ]);
+
+        // Get only the columns defined
+        $query = ProcessRequestToken::select($this->defaultCase);
+        // Filter by case_number
+        $query->filterByCaseNumber($request);
+        // Filter by status
+        $query->filterByStatus($request);
+        // Return the process information
+        $query->getProcess();
+        // Return the user information
+        $query->getUser();
+        // Filter only the task related to the user
+        $this->applyForCurrentUser($query, $user);
+        // Exclude non visible task
+        $this->excludeNonVisibleTasks($query, $request);
+        // Apply ordering only if a valid order_by field is provided
+        $query->applyOrdering($request);
+
+        try {
+            $response = $query->applyPagination($request);
+            $response->inOverdue = 0;
+        } catch (QueryException $e) {
+            return $this->handleQueryException($e);
+        }
+
+        return new TaskCollection($response);
+    }
+
     /**
      * Display the specified resource.
      * @TODO remove this method,view and route this is not a used file

ProcessMaker/Http/Controllers/CasesController.php

@@ -0,0 +1,199 @@
+<?php
+
+namespace ProcessMaker\Http\Controllers;
+
+use Facades\ProcessMaker\RollbackProcessRequest;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Route;
+use ProcessMaker\Cache\CacheRemember;
+use ProcessMaker\Events\FilesDownloaded;
+use ProcessMaker\Events\ScreenBuilderStarting;
+use ProcessMaker\Filters\SaveSession;
+use ProcessMaker\Helpers\DefaultColumns;
+use ProcessMaker\Helpers\MobileHelper;
+use ProcessMaker\Http\Controllers\Controller;
+use ProcessMaker\Managers\DataManager;
+use ProcessMaker\Managers\ScreenBuilderManager;
+use ProcessMaker\Models\Comment;
+use ProcessMaker\Models\Process;
+use ProcessMaker\Models\ProcessRequest;
+use ProcessMaker\Models\ProcessRequestToken;
+use ProcessMaker\Models\Screen;
+use ProcessMaker\Models\ScreenVersion;
+use ProcessMaker\Models\UserResourceView;
+use ProcessMaker\Package\PackageComments\PackageServiceProvider;
+use ProcessMaker\ProcessTranslations\ProcessTranslation;
+use ProcessMaker\RetryProcessRequest;
+use ProcessMaker\Traits\HasControllerAddons;
+use ProcessMaker\Traits\SearchAutocompleteTrait;
+use Spatie\MediaLibrary\MediaCollections\Models\Media;
+
+class CasesController extends Controller
+{
+    /**
+     * Get the list of requests.
+     *
+     * @return \Illuminate\View\View|\Illuminate\Contracts\View
+     */
+    public function index($type = null)
+    {
+       // This is a temporary API the engine team will provide the new
+        return view('cases.casesMain');
+    }
+    /**
+     * Cases Detail
+     *
+     * @param ProcessRequest $request
+     *
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
+     */
+    public function edit(ProcessRequest $request)
+    {
+        if (!request()->input('skipInterstitial') && $request->status === 'ACTIVE') {
+            $startEvent = $request->tokens()->orderBy('id')->first();
+            if ($startEvent) {
+                $definition = $startEvent->getDefinition();
+                $allowInterstitial = false;
+                if (isset($definition['allowInterstitial'])) {
+                    $allowInterstitial = filter_var(
+                        $definition['allowInterstitial'],
+                        FILTER_VALIDATE_BOOLEAN,
+                        FILTER_NULL_ON_FAILURE
+                    );
+                }
+                if ($allowInterstitial && $request->user_id == Auth::id() && request()->has('fromTriggerStartEvent')) {
+                    $active = $request->tokens()
+                        ->where('user_id', Auth::id())
+                        ->where('element_type', 'task')
+                        ->where('status', 'ACTIVE')
+                        ->orderBy('id')->first();
+
+                    // If the interstitial is enabled on the start event, then use it as the task
+                    if ($active) {
+                        $task = $allowInterstitial ? $startEvent : $active;
+                    } else {
+                        $task = $startEvent;
+                    }
+
+                    return redirect(route('tasks.edit', [
+                        'task' => $task->getKey(),
+                    ]));
+                }
+            }
+        }
+
+        $userHasCommentsForRequest = Comment::where('commentable_type', ProcessRequest::class)
+                ->where('commentable_id', $request->id)
+                ->where('body', 'like', '%{{' . \Auth::user()->id . '}}%')
+                ->count() > 0;
+
+        $requestMedia = $request->media()->get()->pluck('id');
+
+        $userHasCommentsForMedia = Comment::where('commentable_type', \ProcessMaker\Models\Media::class)
+                ->whereIn('commentable_id', $requestMedia)
+                ->where('body', 'like', '%{{' . \Auth::user()->id . '}}%')
+                ->count() > 0;
+
+        if (!$userHasCommentsForMedia && !$userHasCommentsForRequest) {
+            $this->authorize('view', $request);
+        }
+
+        $request->participants;
+        $request->user;
+        $request->summary = $request->summary();
+
+        if ($request->status === 'CANCELED' && $request->process->cancel_screen_id) {
+            $request->summary_screen = $request->process->cancelScreen;
+        } else {
+            $request->summary_screen = $request->getSummaryScreen();
+        }
+        $request->request_detail_screen = Screen::find($request->process->request_detail_screen_id);
+
+        $canCancel = Auth::user()->can('cancel', $request->processVersion);
+        $canViewComments = (Auth::user()->hasPermissionsFor('comments')->count() > 0) || class_exists(PackageServiceProvider::class);
+        $canManuallyComplete = Auth::user()->is_administrator && $request->status === 'ERROR';
+        $canRetry = false;
+
+        if ($canManuallyComplete) {
+            $retry = RetryProcessRequest::for($request);
+
+            $canRetry = $retry->hasRetriableTasks() &&
+                !$retry->hasNonRetriableTasks() &&
+                !$retry->isChildRequest();
+        }
+
+        $files = \ProcessMaker\Models\Media::getFilesRequest($request);
+
+        $canPrintScreens = $this->canUserPrintScreen($request);
+
+        $manager = app(ScreenBuilderManager::class);
+        event(new ScreenBuilderStarting($manager, ($request->summary_screen) ? $request->summary_screen->type : 'FORM'));
+
+        $addons = [];
+        $dataActionsAddons = [];
+
+        $isProcessManager = $request->process?->manager_id === Auth::user()->id;
+
+        $eligibleRollbackTask = null;
+        $errorTask = RollbackProcessRequest::getErrorTask($request);
+        if ($errorTask) {
+            $eligibleRollbackTask = RollbackProcessRequest::eligibleRollbackTask($errorTask);
+        }
+        $this->summaryScreenTranslation($request);
+        return view('cases.edit', compact(
+            'request',
+            'files',
+            'canCancel',
+            'canViewComments',
+            'canManuallyComplete',
+            'canRetry',
+            'manager',
+            'canPrintScreens',
+            'addons',
+            'isProcessManager',
+            'eligibleRollbackTask',
+            'errorTask',
+        ));
+    }
+
+    /**
+     * the user may or may not print forms
+     *
+     * @param ProcessRequest $request
+     * @return bool
+     */
+    private function canUserPrintScreen(ProcessRequest $request)
+    {
+        //validate user is administrator
+        if (Auth::user()->is_administrator) {
+            return true;
+        }
+
+        //validate user is participant or requester
+        if (in_array(Auth::user()->id, $request->participants()->get()->pluck('id')->toArray())) {
+            return true;
+        }
+
+        // Any user with permissions Edit Request Data, Edit Task Data and view All Requests
+        if (Auth::user()->can('view-all_requests') && Auth::user()->can('edit-request_data') && Auth::user()->can('edit-task_data')) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Translates the summary screen strings
+     * @param ProcessRequest $request
+     * @return void
+     */
+    public function summaryScreenTranslation(ProcessRequest $request): void
+    {
+        if ($request->summary_screen) {
+            $processTranslation = new ProcessTranslation($request->process);
+            $translatedConf = $processTranslation->applyTranslations($request->summary_screen);
+            $request->summary_screen['config'] = $translatedConf;
+        }
+    }
+}

ProcessMaker/Http/Controllers/RequestController.php

@@ -45,7 +45,7 @@ public function index($type = null)
             $this->authorize('view-all_requests');
         }
 
-        $title = 'My Cases';
+        $title = 'My Request';
 
         $types = ['all'=>'All Requests', 'in_progress'=>'Requests In Progress', 'completed'=>'Completed Requests'];
 

ProcessMaker/Http/Middleware/GenerateMenus.php

@@ -36,10 +36,10 @@ public function handle(Request $request, Closure $next)
                     ['route' => 'process.browser.index', 'id' => 'process-browser']
                 )->active('process-browser/*');
             });
-            $menu->group(['prefix' => 'requests'], function ($request_items) {
+            $menu->group(['prefix' => 'cases'], function ($request_items) {
                 $request_items->add(
                     __('Cases'),
-                    ['route' => 'cases.index', 'id' => 'requests']
+                    ['route' => 'cases-main.index', 'id' => 'cases']
                 )->active('cases/*');
             });
             //@TODO change the index to the correct blade
@@ -140,25 +140,53 @@ public function handle(Request $request, Closure $next)
             $submenu = $menu->add(__('Processes'));
         });
         Menu::make('sidebar_request', function ($menu) {
-            $submenu = $menu->add(__('Cases'));
-            $submenu->add(__('My Cases'), [
-                'route' => ['cases_by_type', ''],
+            $submenu = $menu->add(__('Requests'));
+            $submenu->add(__('My Requests'), [
+                'route' => ['requests_by_type', ''],
                 'icon' => 'fa-id-badge',
             ]);
             $submenu->add(__('In Progress'), [
-                'route' => ['cases_by_type', 'in_progress'],
+                'route' => ['requests_by_type', 'in_progress'],
                 'icon' => 'fa-clipboard-list',
             ]);
             $submenu->add(__('Completed'), [
-                'route' => ['cases_by_type', 'completed'],
+                'route' => ['requests_by_type', 'completed'],
                 'icon' => 'fa-clipboard-check',
             ]);
             if (\Auth::check() && \Auth::user()->can('view-all_requests')) {
+                $submenu->add(__('All Requests'), [
+                    'route' => ['requests_by_type', 'all'],
+                    'icon' => 'fa-clipboard',
+                ]);
+            }
+        });
+
+        Menu::make('sidebar_cases', function ($menu) {
+            $submenu = $menu->add(__('Cases'));
+            $submenu->add(__('My Cases'), [
+                'route' => ['cases-main.index', ''],
+                'icon' => 'fa-user',
+            ]);
+            $submenu->add(__('In Progress'), [
+                'route' => ['cases-main.index', 'in_progress'],
+                'icon' => 'fa-list',
+            ]);
+            $submenu->add(__('Completed'), [
+                'route' => ['cases-main.index', 'completed'],
+                'icon' => 'fa-check-circle',
+            ]);
+            if (\Auth::check() && \Auth::user()->can('view-all_cases')) {
                 $submenu->add(__('All Cases'), [
-                    'route' => ['cases_by_type', 'all'],
+                    'route' => ['cases-main.index', 'all'],
                     'icon' => 'fa-clipboard',
                 ]);
             }
+            if (\Auth::check() && \Auth::user()->can('view-my_requests')) {
+                $submenu->add(__('My Requests'), [
+                    'route' => ['requests_by_type', ''],
+                    'icon' => 'fa-play',
+                ]);
+            }
         });
 
         Menu::make('sidebar_processes', function ($menu) {