feat: add audit log for user fields changes

Change-Id: I2db7f2a919b200fee11792f05977884e059d2366

Author: smarcet

app/Jobs/AddUserAction.php

@@ -0,0 +1,74 @@
+<?php namespace App\Jobs;
+/*
+ * Copyright 2024 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Log;
+use Services\IUserActionService;
+
+/**
+ * Class AddUserAction
+ * @package App\Jobs
+ */
+final class AddUserAction implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+    public $tries = 1;
+
+    public $timeout = 0;
+
+    /**
+     * @var int
+     */
+    private $user_id;
+
+    /**
+     * @var string
+     */
+    private $action;
+
+    /**
+     * @var string
+     */
+    private $ip;
+
+    /**
+     * @param int $user_id
+     * @param string $ip
+     * @param string $action
+     */
+    public function __construct(int $user_id, string $ip, string $action){
+        Log::debug(sprintf("AddUserAction::constructor user %s action %s ip %s", $user_id, $action, $ip));
+        $this->user_id = $user_id;
+        $this->action = $action;
+        $this->ip = $ip;
+    }
+
+    public function handle(IUserActionService $service){
+        Log::debug(sprintf("AddUserAction::handle"));
+        try{
+            $service->addUserAction($this->user_id, $this->ip, $this->action);
+        }
+        catch (\Exception $ex) {
+            Log::error($ex);
+        }
+    }
+
+    public function failed(\Throwable $exception)
+    {
+        Log::error(sprintf( "AddUserAction::failed %s", $exception->getMessage()));
+    }
+}

app/libs/Auth/Models/User.php

@@ -11,9 +11,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **/
+
 use App\Events\UserCreated;
 use App\Events\UserLocked;
 use App\Events\UserSpamStateUpdated;
+use App\Jobs\AddUserAction;
 use App\libs\Auth\Models\IGroupSlugs;
 use App\libs\Auth\Models\UserRegistrationRequest;
 use App\libs\Utils\PunnyCodeHelper;
@@ -44,6 +46,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use App\Models\Utils\BaseEntity;
 use Doctrine\ORM\Mapping AS ORM;
+use Utils\IPHelper;
 
 /**
  * @ORM\Entity(repositoryClass="App\Repositories\DoctrineUserRepository")
@@ -2003,4 +2006,76 @@ public function createdByOTP():bool{
         return !is_null($this->created_by_otp);
     }
 
+    /**
+     * @ORM\PostUpdate:
+     */
+    public function updated($args)
+    {
+
+    }
+
+    private function formatFieldValue(string $field, $value):string{
+        if($field === 'password') $value = "********";
+        if($value instanceof \DateTime)
+            $value = $value->format('Y-m-d H:i:s');
+        return sprintf("%s: %s", $field, $value);
+    }
+    /**
+     * @ORM\PreUpdate:
+     */
+    public function updating(PreUpdateEventArgs $args)
+    {
+        $fields_2_check = [
+            'identifier',
+            'public_profile_show_photo',
+            'public_profile_show_fullname',
+            'public_profile_show_email',
+            'public_profile_allow_chat_with_me',
+            'active',
+            'first_name',
+            'last_name',
+            'email',
+            'address1',
+            'address2',
+            'state',
+            'city',
+            'post_code',
+            'country_iso_code',
+            'second_email',
+            'third_email',
+            'gender',
+            'gender_specify',
+            'statement_of_interest',
+            'bio',
+            'irc',
+            'linked_in_profile',
+            'twitter_name',
+            'github_user',
+            'wechat_user',
+            'password',
+            'email_verified',
+            'language',
+            'birthday',
+            'company',
+            'job_title',
+            'phone_number',
+        ];
+        $old_fields_changed = [];
+        $new_fields_changed = [];
+
+        foreach($fields_2_check as $field){
+            if($args->hasChangedField($field)){
+                $old_fields_changed[] = sprintf("%s: %s", $field, self::formatFieldValue($field, $args->getOldValue($field)));
+                $new_fields_changed[] = sprintf("%s: %s", $field, self::formatFieldValue($field, $args->getNewValue($field)));
+            }
+        }
+
+        $action = sprintf
+        (
+            "User %s updated from %s to %s", $this->email, implode(", ", $old_fields_changed), implode(", ", $new_fields_changed)
+        );
+
+        Event::dispatch(new AddUserAction($this->id, IPHelper::getUserIp(), $action));
+    }
+
 }