Refactor logging via "Loggable" trait

app/Enums/ActionType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Enums;
+
+enum ActionType: string {
+    case Restore = 'restore';
+    case TwoFactorReset = '2FA reset';
+    case CheckinFrom = 'checkin from';
+    case RequestCanceled = 'request canceled';
+    case Requested = 'requested';
+    case DeleteSeats = 'delete seats';
+    case AddSeats = 'add seats';
+    case Update = 'update';
+    case Create = 'create';
+    case Delete = 'delete';
+}

app/Http/Controllers/Api/ManufacturersController.php

@@ -218,14 +218,7 @@ public function restore($id) : JsonResponse
             }
 
             if ($manufacturer->restore()) {
-
-                $logaction = new Actionlog();
-                $logaction->item_type = Manufacturer::class;
-                $logaction->item_id = $manufacturer->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
-
+
                 return response()->json(Helper::formatStandardApiResponse('success', trans('admin/manufacturers/message.restore.success')), 200);
             }
 

app/Http/Controllers/Api/UsersController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Api;
 
+use App\Enums\ActionType;
 use App\Helpers\Helper;
 use App\Http\Controllers\Controller;
 use App\Http\Requests\SaveUserRequest;
@@ -701,17 +702,8 @@ public function postTwoFactorReset(Request $request) : JsonResponse
                 $this->authorize('update', $user);
                 $user->two_factor_secret = null;
                 $user->two_factor_enrolled = 0;
-                $user->saveQuietly();
-
-                // Log the reset
-                $logaction = new Actionlog();
-                $logaction->target_type = User::class;
-                $logaction->target_id = $user->id;
-                $logaction->item_type = User::class;
-                $logaction->item_id = $user->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('2FA reset');
+                $user->setLogMessage(ActionType::TwoFactorReset);
+                $user->save();
 
                 return response()->json(['message' => trans('admin/settings/general.two_factor_reset_success')], 200);
             } catch (\Exception $e) {
@@ -756,13 +748,6 @@ public function restore($userId) : JsonResponse
 
             if ($user->restore()) {
 
-                $logaction = new Actionlog();
-                $logaction->item_type = User::class;
-                $logaction->item_id = $user->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
-
                 return response()->json(Helper::formatStandardApiResponse('success', null, trans('admin/users/message.success.restored')), 200);
             }
 

app/Http/Controllers/AssetModelsController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\ActionType;
 use App\Helpers\Helper;
 use App\Http\Requests\ImageUploadRequest;
 use App\Http\Requests\StoreAssetModelRequest;
@@ -225,13 +226,6 @@ public function getRestore($id) : RedirectResponse
             }
 
             if ($model->restore()) {
-                $logaction = new Actionlog();
-                $logaction->item_type = AssetModel::class;
-                $logaction->item_id = $model->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
-
 
                 // Redirect them to the deleted page if there are more, otherwise the section index
                 $deleted_models = AssetModel::onlyTrashed()->count();

app/Http/Controllers/LocationsController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\ActionType;
 use App\Http\Requests\ImageUploadRequest;
 use App\Models\Actionlog;
 use App\Models\Asset;
@@ -266,12 +267,6 @@ public function postRestore($id) : RedirectResponse
             }
 
             if ($location->restore()) {
-                $logaction = new Actionlog();
-                $logaction->item_type = Location::class;
-                $logaction->item_id = $location->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
 
                 return redirect()->route('locations.index')->with('success', trans('admin/locations/message.restore.success'));
             }

app/Http/Controllers/ManufacturersController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\ActionType;
 use App\Http\Requests\ImageUploadRequest;
 use App\Models\Actionlog;
 use App\Models\Manufacturer;
@@ -195,12 +196,6 @@ public function restore($id) : RedirectResponse
             }
 
             if ($manufacturer->restore()) {
-                $logaction = new Actionlog();
-                $logaction->item_type = Manufacturer::class;
-                $logaction->item_id = $manufacturer->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
 
                 // Redirect them to the deleted page if there are more, otherwise the section index
                 $deleted_manufacturers = Manufacturer::onlyTrashed()->count();

app/Http/Controllers/Users/BulkUsersController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Users;
 
+use App\Enums\ActionType;
 use App\Events\UserMerged;
 use App\Helpers\Helper;
 use App\Http\Controllers\Controller;
@@ -334,49 +335,50 @@ public function destroy(Request $request)
     protected function logItemCheckinAndDelete($items, $itemType)
     {
         foreach ($items as $item) {
-            $item_id = $item->id;
-            $logAction = new Actionlog();
-
-            if ($itemType == License::class){
-                $item_id = $item->license_id;
+            if (gettype($item) == 'object' && get_class($item) != 'stdClass') {
+                $real_item = $item;
+            } else {
+                $item_id = $item->id;
+
+                if ($itemType == License::class) {
+                    $item_id = $item->license_id; //FIXME - funkery happening here
+                    $real_item = License::find($item->license_id);
+                } else {
+                    $real_item = (new $itemType())::find($item_id);
+                }
+            }
+            if (property_exists($item, 'assigned_type')) {
+                $assigned_to = (new ($item->assigned_type))::find($item->assigned_to);
+            } else {
+                $assigned_to = User::find($item->assigned_to);
             }
 
-            $logAction->item_id = $item_id;
-            // We can't rely on get_class here because the licenses/accessories fetched above are not eloquent models, but simply arrays.
-            $logAction->item_type = $itemType;
-            $logAction->target_id = $item->assigned_to;
-            $logAction->target_type = User::class;
-            $logAction->created_by = auth()->id();
-            $logAction->note = 'Bulk checkin items';
-            $logAction->logaction('checkin from');
+            $real_item->setLogTarget($assigned_to); // will this work?!!?!?!?
+            //$logAction->target_id = $item->assigned_to;
+            //$logAction->target_type = User::class;
+            $real_item->setLogNote('Bulk checkin items');
+            $real_item->setLogMessage(ActionType::CheckinFrom);
+            $real_item->logWithoutSave(ActionType::CheckinFrom);
         }
     }
 
     private function logAccessoriesCheckin(Collection $accessoryUserRows): void
     {
         foreach ($accessoryUserRows as $accessoryUserRow) {
-            $logAction = new Actionlog();
-            $logAction->item_id = $accessoryUserRow->accessory_id;
-            $logAction->item_type = Accessory::class;
-            $logAction->target_id = $accessoryUserRow->assigned_to;
-            $logAction->target_type = User::class;
-            $logAction->created_at = auth()->id();
-            $logAction->note = 'Bulk checkin items';
-            $logAction->logaction('checkin from');
+            $accessory = Accessory::find($accessoryUserRow->accessory_id);
+            $accessory->setLogTarget(User::find($accessoryUserRow->assigned_to)); //FIXME - what if accessory was checked out to location?
+            $accessory->setLogNote('Bulk checkin items');
+            $accessory->logWithoutSave(ActionType::CheckinFrom);
         }
     }
 
     private function logConsumablesCheckin(Collection $consumableUserRows): void
     {
         foreach ($consumableUserRows as $consumableUserRow) {
-            $logAction = new Actionlog();
-            $logAction->item_id = $consumableUserRow->consumable_id;
-            $logAction->item_type = Consumable::class;
-            $logAction->target_id = $consumableUserRow->assigned_to;
-            $logAction->target_type = User::class;
-            $logAction->created_at = auth()->id();
-            $logAction->note = 'Bulk checkin items';
-            $logAction->logaction('checkin from');
+            $consumable = Consumable::find($consumableUserRow->consumable_id);
+            $consumable->setLogTarget(User::find($consumableUserRow->assigned_to));
+            $consumable->setLogNote('Bulk checkin items');
+            $consumable->logWithoutSave(ActionType::CheckinFrom);
         }
     }
 

app/Http/Controllers/Users/UsersController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Users;
 
+use App\Enums\ActionType;
 use App\Helpers\Helper;
 use App\Http\Controllers\Controller;
 use App\Http\Requests\DeleteUserRequest;
@@ -358,14 +359,8 @@ public function getRestore($id = null)
                 return redirect()->back()->with('error', trans('general.not_deleted', ['item_type' => trans('general.user')]));
             }
 
+            $user->setLogMessage(ActionType::Restore);
             if ($user->restore()) {
-                $logaction = new Actionlog();
-                $logaction->item_type = User::class;
-                $logaction->item_id = $user->id;
-                $logaction->created_at = date('Y-m-d H:i:s');
-                $logaction->created_by = auth()->id();
-                $logaction->logaction('restore');
-
                 // Redirect them to the deleted page if there are more, otherwise the section index
                 $deleted_users = User::onlyTrashed()->count();
                 if ($deleted_users > 0) {

app/Http/Controllers/ViewAssetsController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\ActionType;
 use App\Models\Actionlog;
 use App\Models\Asset;
 use App\Models\AssetModel;
@@ -93,17 +94,18 @@ public function getRequestItem(Request $request, $itemType, $itemId = null, $can
 
         $user = auth()->user();
 
-        $logaction = new Actionlog();
-        $logaction->item_id = $data['asset_id'] = $item->id;
-        $logaction->item_type = $fullItemType;
-        $logaction->created_at = $data['requested_date'] = date('Y-m-d H:i:s');
-
+        //$logaction = new Actionlog();
+        //$logaction->item_id = $data['asset_id'] = $item->id;
+        //$logaction->item_type = $fullItemType;
+        //$logaction->created_at = $data['requested_date'] = date('Y-m-d H:i:s');
+        $data['requested_date'] = date('Y-m-d H:i:s');
         if ($user->location_id) {
-            $logaction->location_id = $user->location_id;
+            $item->setLocation($user->location);
         }
 
-        $logaction->target_id = $data['user_id'] = auth()->id();
-        $logaction->target_type = User::class;
+        $item->setLogTarget($user);
+        //$logaction->target_id = $data['user_id'] = auth()->id();
+        //$logaction->target_type = User::class;
 
         $data['item_quantity'] = $request->has('request-quantity') ? e($request->input('request-quantity')) : 1;
         $data['requested_by'] = $user->present()->fullName();
@@ -122,17 +124,17 @@ public function getRequestItem(Request $request, $itemType, $itemId = null, $can
         if (($item_request = $item->isRequestedBy($user)) || $cancel_by_admin) {
             $item->cancelRequest($requestingUser);
             $data['item_quantity'] = ($item_request) ? $item_request->qty : 1;
-            $logaction->logaction('request_canceled');
+            $item->logWithoutSave(ActionType::RequestCanceled);
 
             if (($settings->alert_email != '') && ($settings->alerts_enabled == '1') && (! config('app.lock_passwords'))) {
                 $settings->notify(new RequestAssetCancelation($data));
             }
 
             return redirect()->back()->with('success')->with('success', trans('admin/hardware/message.requests.canceled'));
         } else {
-            $item->request();
+            $item->request(); //!!!!!!!!!!!!!
             if (($settings->alert_email != '') && ($settings->alerts_enabled == '1') && (! config('app.lock_passwords'))) {
-                $logaction->logaction('requested');
+                $item->logWithoutSave(ActionType::Requested);
                 $settings->notify(new RequestAssetNotification($data));
             }
 
@@ -163,37 +165,35 @@ public function getRequestAsset($assetId = null) : RedirectResponse
         $data['item_quantity'] = 1;
         $settings = Setting::getSettings();
 
-        $logaction = new Actionlog();
-        $logaction->item_id = $data['asset_id'] = $asset->id;
-        $logaction->item_type = $data['item_type'] = Asset::class;
-        $logaction->created_at = $data['requested_date'] = date('Y-m-d H:i:s');
+        //$logaction = new Actionlog();
+        $data['asset_id'] = $asset->id;
+        $data['item_type'] = Asset::class;
+        $data['requested_date'] = date('Y-m-d H:i:s');
 
-        if ($user->location_id) {
-            $logaction->location_id = $user->location_id;
-        }
-        $logaction->target_id = $data['user_id'] = auth()->id();
-        $logaction->target_type = User::class;
+        $asset->setLocation = $user->location;
+        $asset->setLogTarget($user);
+        $data['user_id'] = auth()->id();
 
         // If it's already requested, cancel the request.
         if ($asset->isRequestedBy(auth()->user())) {
-            $asset->cancelRequest();
-            $asset->decrement('requests_counter', 1);
+            $asset->cancelRequest(); //wait, what?
+            $asset->decrement('requests_counter', 1); //this too
 
-            $logaction->logaction('request canceled');
+            $asset->logWithoutSave(ActionType::RequestCanceled);
             try {
-                $settings->notify(new RequestAssetCancelation($data));
+                $settings->notify(new RequestAssetCancelation($data)); //and probably this
             } catch (\Exception $e) {
                 Log::warning($e);
             }
             return redirect()->route('requestable-assets')
                 ->with('success')->with('success', trans('admin/hardware/message.requests.canceled'));
         }
 
-        $logaction->logaction('requested');
-        $asset->request();
-        $asset->increment('requests_counter', 1);
+        $asset->logWithoutSave(ActionType::Requested); //ARGH
+        $asset->request(); //HERE <-
+        $asset->increment('requests_counter', 1); //ARGH
         try {
-            $settings->notify(new RequestAssetNotification($data));
+            $settings->notify(new RequestAssetNotification($data)); // ANd this.
         } catch (\Exception $e) {
             Log::warning($e);
         }

app/Models/Accessory.php

@@ -4,6 +4,7 @@
 
 use App\Helpers\Helper;
 use App\Models\Traits\Acceptable;
+use App\Models\Traits\Loggable;
 use App\Models\Traits\Searchable;
 use App\Presenters\Presentable;
 use Illuminate\Database\Eloquent\Factories\HasFactory;