Code cleanup, bug squashing

[bookstack] / app / Auth / User.php

diff --git a/app/Auth/User.php b/app/Auth/User.php
index bce418a7421fb40ddeb34b0e0dacd192d7048e2a..32179a1fbb8d1e97300d4a5445975014705a4631 100644 (file)
--- a/app/Auth/User.php
+++ b/app/Auth/User.php
@@ -1,5 +1,8 @@
 <?php namespace BookStack\Auth;
 
 <?php namespace BookStack\Auth;
 

+use BookStack\Actions\Activity;
+use BookStack\Api\ApiToken;
+use BookStack\Interfaces\Loggable;

 use BookStack\Model;
 use BookStack\Notifications\ResetPassword;
 use BookStack\Uploads\Image;
 use BookStack\Model;
 use BookStack\Notifications\ResetPassword;
 use BookStack\Uploads\Image;


@@ -9,11 +12,12 @@ use Illuminate\Auth\Passwords\CanResetPassword;
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;

+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;

 use Illuminate\Notifications\Notifiable;
 
 /**
  * Class User
 use Illuminate\Notifications\Notifiable;
 
 /**
  * Class User

- * @package BookStack\Auth

  * @property string $id
  * @property string $name
  * @property string $email
  * @property string $id
  * @property string $name
  * @property string $email


@@ -25,7 +29,7 @@ use Illuminate\Notifications\Notifiable;
  * @property string $external_auth_id
  * @property string $system_name
  */
  * @property string $external_auth_id
  * @property string $system_name
  */

-class User extends Model implements AuthenticatableContract, CanResetPasswordContract
+class User extends Model implements AuthenticatableContract, CanResetPasswordContract, Loggable

 {
     use Authenticatable, CanResetPassword, Notifiable;
 
 {
     use Authenticatable, CanResetPassword, Notifiable;
 


@@ -45,7 +49,10 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      * The attributes excluded from the model's JSON form.
      * @var array
      */
      * The attributes excluded from the model's JSON form.
      * @var array
      */

-    protected $hidden = ['password', 'remember_token'];
+    protected $hidden = [
+        'password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',
+        'created_at', 'updated_at', 'image_id',
+    ];

 
     /**
      * This holds the user's permissions when loaded.
 
     /**
      * This holds the user's permissions when loaded.


@@ -96,12 +103,10 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
 
     /**
      * Check if the user has a role.
 
     /**
      * Check if the user has a role.

-     * @param $role
-     * @return mixed

      */
      */

-    public function hasRole($role)
+    public function hasRole($roleId): bool

     {
     {

-        return $this->roles->pluck('name')->contains($role);
+        return $this->roles->pluck('id')->contains($roleId);

     }
 
     /**
     }
 
     /**


@@ -114,6 +119,17 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
         return $this->roles->pluck('system_name')->contains($role);
     }
 
         return $this->roles->pluck('system_name')->contains($role);
     }
 

+    /**
+     * Attach the default system role to this user.
+     */
+    public function attachDefaultRole(): void
+    {
+        $roleId = setting('registration-role');
+        if ($roleId && $this->roles()->where('id', '=', $roleId)->count() === 0) {
+            $this->roles()->attach($roleId);
+        }
+    }
+

     /**
      * Get all permissions belonging to a the current user.
      * @param bool $cache
     /**
      * Get all permissions belonging to a the current user.
      * @param bool $cache


@@ -147,20 +163,10 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
 
     /**
      * Attach a role to this user.
 
     /**
      * Attach a role to this user.

-     * @param Role $role

      */
     public function attachRole(Role $role)
     {
      */
     public function attachRole(Role $role)
     {

-        $this->attachRoleId($role->id);
-    }
-
-    /**
-     * Attach a role id to this user.
-     * @param $id
-     */
-    public function attachRoleId($id)
-    {
-        $this->roles()->attach($id);
+        $this->roles()->attach($role->id);

     }
 
     /**
     }
 
     /**


@@ -217,20 +223,35 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
         return $this->belongsTo(Image::class, 'image_id');
     }
 
         return $this->belongsTo(Image::class, 'image_id');
     }
 

+    /**
+     * Get the API tokens assigned to this user.
+     */
+    public function apiTokens(): HasMany
+    {
+        return $this->hasMany(ApiToken::class);
+    }
+
+    /**
+     * Get the latest activity instance for this user.
+     */
+    public function latestActivity(): HasOne
+    {
+        return $this->hasOne(Activity::class)->latest();
+    }
+

     /**
      * Get the url for editing this user.
     /**
      * Get the url for editing this user.

-     * @return string

      */
      */

-    public function getEditUrl()
+    public function getEditUrl(string $path = ''): string

     {
     {

-        return url('/settings/users/' . $this->id);
+        $uri = '/settings/users/' . $this->id . '/' . trim($path, '/');
+        return url(rtrim($uri, '/'));

     }
 
     /**
      * Get the url that links to this user's profile.
     }
 
     /**
      * Get the url that links to this user's profile.

-     * @return mixed

      */
      */

-    public function getProfileUrl()
+    public function getProfileUrl(): string

     {
         return url('/user/' . $this->id);
     }
     {
         return url('/user/' . $this->id);
     }


@@ -263,4 +284,12 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     {
         $this->notify(new ResetPassword($token));
     }
     {
         $this->notify(new ResetPassword($token));
     }

+
+    /**
+     * @inheritdoc
+     */
+    public function logDescriptor(): string
+    {
+        return "({$this->id}) {$this->name}";
+    }

 }
 }