Changeset 887 for trunk/Modules/User/UserModel.php

Timestamp:

Nov 20, 2020, 12:08:12 AM (3 years ago)

Author:

chronos

Message:

• Added: Static types added to almost all classes, methods and function. Supported by PHP 7.4.
• Fixed: Various found code issues.

File:

• trunk/Modules/User/UserModel.php (modified) (19 diffs)

trunk/Modules/User/UserModel.php

@@ -28 +28 @@
 class PasswordHash
 {
-  function Hash($Password, $Salt)
+  function Hash(string $Password, string $Salt): string
   {
     return sha1(sha1($Password).$Salt);
   }
 
-  function Verify($Password, $Salt, $StoredHash)
+  function Verify(string $Password, string $Salt, string $StoredHash): bool
   {
     return $this->Hash($Password, $Salt) == $StoredHash;
   }
 
-  function GetSalt()
+  function GetSalt(): string
   {
     mt_srand(microtime(true) * 100000 + memory_get_usage(true));
@@ -49 +49 @@
 class User extends Model
 {
-  var $Roles = array();
-  var $User = array();
-  var $OnlineStateTimeout;
-  var $PermissionCache = array();
-  var $PermissionGroupCache = array();
-  var $PermissionGroupCacheOp = array();
-  /** @var Password */
-  var $PasswordHash;
-
-  function __construct($System)
+  public array $Roles = array();
+  public array $User = array();
+  public int $OnlineStateTimeout;
+  public array $PermissionCache = array();
+  public array $PermissionGroupCache = array();
+  public array $PermissionGroupCacheOp = array();
+  public PasswordHash $PasswordHash;
+
+  function __construct(System $System)
   {
     parent::__construct($System);
@@ -66 +65 @@
   }
 
-  function Check()
+  function Check(): void
   {
     $SID = session_id();
@@ -117 +116 @@
     {
       $this->Database->delete('UserOnline', 'Id='.$DbRow['Id']);
-      if ($DbRow['User'] != null) $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'Logout');
+      if ($DbRow['User'] != null) ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'Logout');
     }
     //$this->LoadPermission($this->User['Role']);
@@ -125 +124 @@
   }
 
-  function Register($Login, $Password, $Password2, $Email, $Name)
+  function Register(string $Login, string $Password, string $Password2, string $Email, string $Name): string
   {
     if (($Email == '') || ($Login == '') || ($Password == '') || ($Password2 == '')  || ($Name == '')) $Result = DATA_MISSING;
@@ -172 +171 @@
 
             $Result = USER_REGISTRATED;
-            $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'NewRegistration', $Login);
+            ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'NewRegistration', $Login);
           }
         }
@@ -180 +179 @@
   }
 
-  function RegisterConfirm($Id, $Hash)
+  function RegisterConfirm(string $Id, string $Hash): string
   {
     $DbResult = $this->Database->select('User', 'Id, Login, Password', 'Id = '.$Id);
@@ -191 +190 @@
         $this->Database->update('User', 'Id='.$Row['Id'], array('Locked' => 0));
         $Output = USER_REGISTRATION_CONFIRMED;
-        $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'RegisterConfirm', 'Login='.
+        ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'RegisterConfirm', 'Login='.
           $Row['Login'].', Id='.$Row['Id']);
       } else $Output = PASSWORDS_UNMATCHED;
@@ -198 +197 @@
   }
 
-  function Login($Login, $Password, $StayLogged = false)
+  function Login(string $Login, string $Password, bool $StayLogged = false): string
   {
     if ($StayLogged) $StayLogged = 1; else $StayLogged = 0;
@@ -228 +227 @@
         $Result = USER_LOGGED_IN;
         $this->Check();
-        $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'Login', 'Login='.$Login.',Host='.gethostbyaddr(GetRemoteAddress()));
+        ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'Login', 'Login='.$Login.',Host='.gethostbyaddr(GetRemoteAddress()));
       }
     } else $Result = USER_NOT_REGISTRED;
@@ -234 +233 @@
   }
 
-  function Logout()
+  function Logout(): string
   {
     $SID = session_id();
     $this->Database->update('UserOnline', 'SessionId="'.$SID.'"', array('User' => null));
-    $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'Logout', $this->User['Login']);
+    ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'Logout', $this->User['Login']);
     $this->Check();
     return USER_LOGGED_OUT;
@@ -248 +247 @@
     $DbResult = $this->Database->select('UserRole', '*');
     while ($DbRow = $DbResult->fetch_array())
+    {
       $this->Roles[] = $DbRow;
+    }
   }
 
@@ -257 +258 @@
     if ($DbResult->num_rows > 0)
     while ($DbRow = $DbResult->fetch_array())
+    {
       $this->User['Permission'][$DbRow['Operation']] = $DbRow;
-  }
-
-  function PermissionMatrix()
+    }
+  }
+
+  function PermissionMatrix(): array
   {
     $Result = array();
@@ -274 +277 @@
   }
 
-  function CheckGroupPermission($GroupId, $OperationId)
+  function CheckGroupPermission(string $GroupId, string $OperationId): bool
   {
     $PermissionExists = false;
@@ -322 +325 @@
   }
 
-  function CheckPermission($Module, $Operation, $ItemType = '', $ItemIndex = 0)
+  function CheckPermission(string $Module, string $Operation, string $ItemType = '', int $ItemIndex = 0): bool
   {
     // Get module id
@@ -373 +376 @@
   }
 
-  function PasswordRecoveryRequest($Login, $Email)
+  function PasswordRecoveryRequest(string $Login, string $Email): string
   {
     $DbResult = $this->Database->select('User', 'Login, Name, Id, Email, Password', '`Login`="'.$Login.'" AND `Email`="'.$Email.'"');
@@ -395 +398 @@
 
       $Output = USER_PASSWORD_RECOVERY_SUCCESS;
-      $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'PasswordRecoveryRequest', 'Login='.$Login.',Email='.$Email);
+      ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'PasswordRecoveryRequest', 'Login='.$Login.',Email='.$Email);
     } else $Output = USER_PASSWORD_RECOVERY_FAIL;
     return $Output;
   }
 
-  function PasswordRecoveryConfirm($Id, $Hash, $NewPassword)
+  function PasswordRecoveryConfirm(string $Id, string $Hash, string $NewPassword): string
   {
     $DbResult = $this->Database->select('User', 'Id, Login, Password', 'Id = '.$Id);
@@ -414 +417 @@
           'Salt' => $Salt, 'Locked' => 0));
         $Output = USER_PASSWORD_RECOVERY_CONFIRMED;
-        $this->System->ModuleManager->Modules['Log']->NewRecord('User', 'PasswordRecoveryConfirm', 'Login='.$Row['Login']);
+        ModuleLog::Cast($this->System->GetModule('Log'))->NewRecord('User', 'PasswordRecoveryConfirm', 'Login='.$Row['Login']);
       } else $Output = PASSWORDS_UNMATCHED;
     } else $Output = USER_NOT_FOUND;
@@ -420 +423 @@
   }
 
-  function CheckToken($Module, $Operation, $Token)
+  function CheckToken(string $Module, string $Operation, string $Token): bool
   {
     $DbResult = $this->Database->select('APIToken', 'User', '`Token`="'.$Token.'"');