Added #17494: Advanced-search and predefined filters

.env.example

@@ -222,4 +222,4 @@ ARGON_TIME=2
 # OPTIONAL: SCIM
 # --------------------------------------------
 SCIM_TRACE=false
-SCIM_STANDARDS_COMPLIANCE=false
+SCIM_STANDARDS_COMPLIANCE=false

.gitignore

@@ -70,4 +70,7 @@ storage/ldap_client_tls.cert
 storage/ldap_client_tls.key
 /storage/framework/testing
 
-/.phpunit.cache
+/.phpunit.cache
+
+#Ignore vscode AI rules
+.github/instructions/codacy.instructions.md

app/Console/Commands/Purge.php

@@ -12,6 +12,7 @@
 use App\Models\License;
 use App\Models\Location;
 use App\Models\Manufacturer;
+use App\Models\PredefinedFilter;
 use App\Models\Statuslabel;
 use App\Models\Supplier;
 use App\Models\User;
@@ -178,6 +179,14 @@ public function handle()
                 $this->info('- Status Label "'.$status_label->name.'" deleted.');
                 $status_label->forceDelete();
             }
+
+            $predefinedFilters = PredefinedFilter::whereNotNull('deleted_at')->withTrashed()->get();
+            $this->info($predefinedFilters->count().' predefined filters purged.');
+            foreach ($predefinedFilters as $predefinedFilter) {
+                $this->info('- Predefined Filter "'.$predefinedFilter->name.'" deleted.');
+                $predefinedFilter->forceDelete();
+            }
+
         } else {
             $this->info('Action canceled. Nothing was purged.');
         }

app/Exceptions/Handler.php

@@ -150,18 +150,20 @@ public function render($request, Throwable $e)
             // Sigh.
             if ($route == 'assets.index') {
                 $route = 'hardware.index';
-            } elseif ($route == 'reporttemplates.index') {
+            } else if ($route == 'reporttemplates.index') {
                 $route = 'reports/custom';
-            } elseif ($route == 'assetmodels.index') {
+            } else if ($route == 'assetmodels.index') {
                 $route = 'models.index';
-            } elseif ($route == 'predefinedkits.index') {
+            } else if ($route == 'predefinedkits.index') {
                 $route = 'kits.index';
-            } elseif ($route == 'assetmaintenances.index') {
+            } else if ($route == 'assetmaintenances.index') {
                 $route = 'maintenances.index';
-            } elseif ($route === 'licenseseats.index') {
+            } else if ($route === 'licenseseats.index') {
                 $route = 'licenses.index';
-            } elseif (($route === 'customfieldsets.index') || ($route === 'customfields.index')) {
+            } else if (($route === 'customfieldsets.index') || ($route === 'customfields.index')) {
                 $route = 'fields.index';
+            } else if ($route === 'predefinedfilters.index') {
+                $route = 'predefined-filters.index';
             }
 
             return redirect()

app/Http/Controllers/Api/AssetsController.php

@@ -23,6 +23,7 @@
 use App\Models\License;
 use App\Models\LicenseSeat;
 use App\Models\Location;
+use App\Models\PredefinedFilter;
 use App\Models\Setting;
 use App\Models\User;
 use App\View\Label;
@@ -57,7 +58,7 @@ class AssetsController extends Controller
      * @param int $assetId
      * @since [v4.0]
      */
-    public function index(FilterRequest $request, $action = null, $upcoming_status = null) : JsonResponse | array
+    public function index(FilterRequest $request, $action = null, $upcoming_status = null):JsonResponse|array
     {
 
 
@@ -134,7 +135,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
             'created_by',
 
         ];
-
+        
         $all_custom_fields = CustomField::all(); //used as a 'cache' of custom fields throughout this page load
 
         foreach ($all_custom_fields as $field) {
@@ -145,13 +146,20 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
 
         if ($request->filled('filter')) {
             $filter = json_decode($request->input('filter'), true);
+        }
 
-            $filter = array_filter($filter, function ($key) use ($allowed_columns) {
+        if (!isset($filter[0]['field'])) {
+            $filter = array_filter($filter, function ($key) use ($allowed_columns){
                 return in_array($key, $allowed_columns);
             }, ARRAY_FILTER_USE_KEY);
+        }
 
+        $all_custom_fields = CustomField::all(); //used as a 'cache' of custom fields throughout this page load
+        foreach ($all_custom_fields as $field) {
+            $allowed_columns[] = $field->db_column_name();
         }
 
+
         $assets = Asset::select('assets.*')
             ->with(
                 'model',
@@ -188,7 +196,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
             }
         }
 
-        if ((! is_null($filter)) && (count($filter)) > 0) {
+        if ((!is_null($filter)) && (count($filter)) > 0) {
             $assets->ByFilter($filter);
         } elseif ($request->filled('search')) {
             $assets->TextSearch($request->input('search'));
@@ -199,7 +207,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
          * Handle due and overdue audits and checkin dates
          */
         switch ($action) {
-                // Audit (singular) is left over from earlier legacy APIs
+            // Audit (singular) is left over from earlier legacy APIs
             case 'audits':
                 switch ($upcoming_status) {
                     case 'due':
@@ -292,7 +300,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
                 break;
             default:
 
-                if ((! $request->filled('status_id')) && ($settings->show_archived_in_list != '1')) {
+                if ((!$request->filled('status_id')) && ($settings->show_archived_in_list != '1')) {
                     // terrible workaround for complex-query Laravel bug in fulltext
                     $assets->join('status_labels AS status_alias', function ($join) {
                         $join->on('status_alias.id', '=', 'assets.status_id')
@@ -324,7 +332,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
         if ($request->input('requestable') == 'true') {
             $assets->where('assets.requestable', '=', '1');
         }
-        
+
         if ($request->filled('model_id')) {
             // If model_id is already an array, just use it as-is
             if (is_array($request->input('model_id'))) {
@@ -409,6 +417,7 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
                 break;
             case 'location':
                 $assets->OrderLocation($order);
+                break;
             case 'rtd_location':
                 $assets->OrderRtdLocation($order);
                 break;
@@ -453,6 +462,18 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
                 break;
         }
 
+        // Filter with predefinedFilter if one is given
+        if (isset($request->predefinedFilter)) {
+            $id = $request->predefinedFilter;
+            $predefinedFilters = PredefinedFilter::where('id', $id)
+                ->where('created_by', auth()->user()->id)
+                ->first();
+
+            if ($predefinedFilters) {
+                $assets = $predefinedFilters->filterAssets($assets);
+            }
+        }
+
 
         // Make sure the offset and limit are actually integers and do not exceed system limits
         $offset = ($request->input('offset') > $assets->count()) ? $assets->count() : app('api_offset_value');
@@ -466,9 +487,11 @@ public function index(FilterRequest $request, $action = null, $upcoming_status =
          * Include additional associated relationships
          */
         if ($request->input('components')) {
-            $assets->loadMissing(['components' => function ($query) {
-                $query->orderBy('created_at', 'desc');
-            }]);
+            $assets->loadMissing([
+                'components' => function ($query) {
+                    $query->orderBy('created_at', 'desc');
+                }
+            ]);
         }
 
         return (new $transformer)->transformAssets($assets, $total, $request);
@@ -561,11 +584,18 @@ public function showBySerial(Request $request, $serial): JsonResponse | array
      * @since [v4.0]
      * @return \Illuminate\Http\JsonResponse
      */
-    public function show(Request $request, $id): JsonResponse | array
+    public function show(Request $request, $id): JsonResponse|array
     {
-        if ($asset = Asset::with('assetstatus')
-            ->with('assignedTo')->withTrashed()
-            ->withCount('checkins as checkins_count', 'checkouts as checkouts_count', 'userRequests as user_requests_count')->find($id)
+        if (
+            $asset = Asset::with('assetstatus')
+                ->with('assignedTo')
+                ->withTrashed()
+                ->withCount(
+                    'checkins as checkins_count', 
+                    'checkouts as checkouts_count', 
+                    'userRequests as user_requests_count'
+                )
+                ->find($id)
         ) {
             $this->authorize('view', $asset);
 
@@ -606,7 +636,7 @@ public function selectlist(Request $request): array
         ])->with('model', 'assetstatus', 'assignedTo')
             ->NotArchived();
 
-        if ((Setting::getSettings()->full_multiple_companies_support=='1') &&  ($request->filled('companyId'))) {
+        if ((Setting::getSettings()->full_multiple_companies_support=='1') && ($request->filled('companyId'))) {
             $assets->where('assets.company_id', $request->input('companyId'));
         }
 
@@ -657,7 +687,7 @@ public function store(StoreAssetRequest $request): JsonResponse
         $asset->model()->associate(AssetModel::find((int) $request->get('model_id')));
 
         $asset->fill($request->validated());
-        $asset->created_by    = auth()->id();
+        $asset->created_by = auth()->id();
 
         /**
          * this is here just legacy reasons. Api\AssetController
@@ -1101,7 +1131,6 @@ public function checkinByTag(Request $request, $tag = null): JsonResponse
      * @since [v4.0]
      */
     public function audit(Request $request, Asset $asset): JsonResponse
-
     {
         $this->authorize('audit', Asset::class);
 
@@ -1144,7 +1173,7 @@ public function audit(Request $request, Asset $asset): JsonResponse
              * Update custom fields in the database.
              * Validation for these fields is handled through the AssetRequest form request
              * $model = AssetModel::find($request->get('model_id'));
-            */
+             */
             if (($asset->model) && ($asset->model->fieldset)) {
                 $payload['custom_fields'] = [];
                 foreach ($asset->model->fieldset->fields as $field) {
@@ -1164,7 +1193,7 @@ public function audit(Request $request, Asset $asset): JsonResponse
                                 $asset->{$field->db_column} = $request->input($field->db_column);
                             }
                         }
-                        $payload['custom_fields'][$field->db_column] =  $request->input($field->db_column);
+                        $payload['custom_fields'][$field->db_column] = $request->input($field->db_column);
                     }
 
                 }
@@ -1175,7 +1204,7 @@ public function audit(Request $request, Asset $asset): JsonResponse
 
             // Validate the rest of the data before we turn off the event dispatcher
             if ($asset->isInvalid()) {
-                return response()->json(Helper::formatStandardApiResponse('error', ['asset_tag' => $asset->asset_tag],  $asset->getErrors()));
+                return response()->json(Helper::formatStandardApiResponse('error', ['asset_tag' => $asset->asset_tag], $asset->getErrors()));
             }
 
 
@@ -1196,7 +1225,7 @@ public function audit(Request $request, Asset $asset): JsonResponse
              * @see \App\Models\Asset::save()
              */
 
-             $asset->unsetEventDispatcher();
+            $asset->unsetEventDispatcher();
 
 
             /**
@@ -1212,7 +1241,7 @@ public function audit(Request $request, Asset $asset): JsonResponse
 
 
         // No matching asset for the asset tag that was passed.
-        return response()->json(Helper::formatStandardApiResponse('error', null,  trans('admin/hardware/message.does_not_exist')), 200);
+        return response()->json(Helper::formatStandardApiResponse('error', null, trans('admin/hardware/message.does_not_exist')), 200);
 
     }
 
@@ -1367,20 +1396,26 @@ public function getLabels(Request $request): JsonResponse
         try {
             $this->authorize('view', Asset::class);
 
-             // Validate that asset tags were provided in the request
+            // Validate that asset tags were provided in the request
             if (!$request->filled('asset_tags')) {
-                return response()->json(Helper::formatStandardApiResponse('error', null, 
-                    trans('admin/hardware/message.no_assets_selected')), 400);
+                return response()->json(Helper::formatStandardApiResponse(
+                    'error',
+                    null,
+                    trans('admin/hardware/message.no_assets_selected')
+                ), 400);
             }
 
-             // Convert asset tags from request into collection and fetch matching assets
+            // Convert asset tags from request into collection and fetch matching assets
             $asset_tags = collect($request->input('asset_tags'));
             $assets = Asset::whereIn('asset_tag', $asset_tags)->get();
 
-             // Return error if no assets were found for the provided tags
+            // Return error if no assets were found for the provided tags
             if ($assets->isEmpty()) {
-                return response()->json(Helper::formatStandardApiResponse('error', null,
-                    trans('admin/hardware/message.does_not_exist')), 404);
+                return response()->json(Helper::formatStandardApiResponse(
+                    'error',
+                    null,
+                    trans('admin/hardware/message.does_not_exist')
+                ), 404);
             }
 
             try {
@@ -1392,17 +1427,17 @@ public function getLabels(Request $request): JsonResponse
 
 
                 $label = new Label();
-                
+
                 if (!$label) {
                     throw new \Exception('Label object could not be created');
                 }
 
                 // Configure label with assets and settings
                 // bulkedit=false and count=0 are default values for label generation
                 $label = $label->with('assets', $assets)
-                              ->with('settings', $settings)
-                              ->with('bulkedit', false)
-                              ->with('count', 0);
+                    ->with('settings', $settings)
+                    ->with('bulkedit', false)
+                    ->with('count', 0);
 
                 // Generate PDF using callback function
                 // The callback captures the PDF content in $pdf_content variable