Added testing for our request method overrides

[bookstack] / app / Auth / User.php

diff --git a/app/Auth/User.php b/app/Auth/User.php
index 9d7eaa72e211a2206a88baa0bcc909bf6eedc9a2..4e21832449d5a6ab1068e82e3b136c151bf72f6f 100644 (file)
--- a/app/Auth/User.php
+++ b/app/Auth/User.php
@@ -1,7 +1,13 @@
-<?php namespace BookStack\Auth;
+<?php

 
 

+namespace BookStack\Auth;
+
+use BookStack\Actions\Favourite;

 use BookStack\Api\ApiToken;
 use BookStack\Api\ApiToken;

+use BookStack\Auth\Access\Mfa\MfaValue;
+use BookStack\Entities\Tools\SlugGenerator;

 use BookStack\Interfaces\Loggable;
 use BookStack\Interfaces\Loggable;

+use BookStack\Interfaces\Sluggable;

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


@@ -12,6 +18,7 @@ use Illuminate\Auth\Passwords\CanResetPassword;
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Builder;

+use Illuminate\Database\Eloquent\Factories\HasFactory;

 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;


@@ -19,30 +26,39 @@ use Illuminate\Notifications\Notifiable;
 use Illuminate\Support\Collection;
 
 /**
 use Illuminate\Support\Collection;
 
 /**

- * Class User
- * @property string $id
- * @property string $name
- * @property string $email
- * @property string $password
- * @property Carbon $created_at
- * @property Carbon $updated_at
- * @property bool $email_confirmed
- * @property int $image_id
- * @property string $external_auth_id
- * @property string $system_name
+ * Class User.
+ *
+ * @property int        $id
+ * @property string     $name
+ * @property string     $slug
+ * @property string     $email
+ * @property string     $password
+ * @property Carbon     $created_at
+ * @property Carbon     $updated_at
+ * @property bool       $email_confirmed
+ * @property int        $image_id
+ * @property string     $external_auth_id
+ * @property string     $system_name
+ * @property Collection $roles
+ * @property Collection $mfaValues

  */
  */

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

 {
 {

-    use Authenticatable, CanResetPassword, Notifiable;
+    use HasFactory;
+    use Authenticatable;
+    use CanResetPassword;
+    use Notifiable;

 
     /**
      * The database table used by the model.
 
     /**
      * The database table used by the model.

+     *

      * @var string
      */
     protected $table = 'users';
 
     /**
      * The attributes that are mass assignable.
      * @var string
      */
     protected $table = 'users';
 
     /**
      * The attributes that are mass assignable.

+     *

      * @var array
      */
     protected $fillable = ['name', 'email'];
      * @var array
      */
     protected $fillable = ['name', 'email'];


@@ -51,57 +67,59 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
 
     /**
      * The attributes excluded from the model's JSON form.
 
     /**
      * The attributes excluded from the model's JSON form.

+     *

      * @var array
      */
     protected $hidden = [
         'password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',
      * @var array
      */
     protected $hidden = [
         'password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',

-        'created_at', 'updated_at', 'image_id',
+        'created_at', 'updated_at', 'image_id', 'roles', 'avatar', 'user_id',

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

-     * @var ?Collection

      */
      */

-    protected $permissions;
+    protected ?Collection $permissions;

 
     /**
      * This holds the default user when loaded.
 
     /**
      * This holds the default user when loaded.

+     *

      * @var null|User
      */
      * @var null|User
      */

-    protected static $defaultUser = null;
+    protected static ?User $defaultUser = null;

 
     /**
      * Returns the default public user.
 
     /**
      * Returns the default public user.

-     * @return User

      */
      */

-    public static function getDefault()
+    public static function getDefault(): self

     {
         if (!is_null(static::$defaultUser)) {
             return static::$defaultUser;
         }
     {
         if (!is_null(static::$defaultUser)) {
             return static::$defaultUser;
         }

-        
-        static::$defaultUser = static::where('system_name', '=', 'public')->first();
+
+        static::$defaultUser = static::query()->where('system_name', '=', 'public')->first();
+

         return static::$defaultUser;
     }
 
     /**
      * Check if the user is the default public user.
         return static::$defaultUser;
     }
 
     /**
      * Check if the user is the default public user.

-     * @return bool

      */
      */

-    public function isDefault()
+    public function isDefault(): bool

     {
         return $this->system_name === 'public';
     }
 
     /**
      * The roles that belong to the user.
     {
         return $this->system_name === 'public';
     }
 
     /**
      * The roles that belong to the user.

+     *

      * @return BelongsToMany
      */
     public function roles()
     {
         if ($this->id === 0) {
      * @return BelongsToMany
      */
     public function roles()
     {
         if ($this->id === 0) {

-            return ;
+            return;

         }
         }

+

         return $this->belongsToMany(Role::class);
     }
 
         return $this->belongsToMany(Role::class);
     }
 


@@ -115,12 +133,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 hasSystemRole($role)
+    public function hasSystemRole(string $roleSystemName): bool

     {
     {

-        return $this->roles->pluck('system_name')->contains($role);
+        return $this->roles->pluck('system_name')->contains($roleSystemName);

     }
 
     /**
     }
 
     /**


@@ -128,7 +144,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     public function attachDefaultRole(): void
     {
      */
     public function attachDefaultRole(): void
     {

-        $roleId = setting('registration-role');
+        $roleId = intval(setting('registration-role'));

         if ($roleId && $this->roles()->where('id', '=', $roleId)->count() === 0) {
             $this->roles()->attach($roleId);
         }
         if ($roleId && $this->roles()->where('id', '=', $roleId)->count() === 0) {
             $this->roles()->attach($roleId);
         }


@@ -160,7 +176,6 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
             ->leftJoin('permission_role', 'ru.role_id', '=', 'permission_role.role_id')
             ->leftJoin('role_permissions', 'permission_role.permission_id', '=', 'role_permissions.id')
             ->where('ru.user_id', '=', $this->id)
             ->leftJoin('permission_role', 'ru.role_id', '=', 'permission_role.role_id')
             ->leftJoin('role_permissions', 'permission_role.permission_id', '=', 'role_permissions.id')
             ->where('ru.user_id', '=', $this->id)

-            ->get()

             ->pluck('name');
 
         return $this->permissions;
             ->pluck('name');
 
         return $this->permissions;


@@ -184,9 +199,8 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
 
     /**
      * Get the social account associated with this user.
 
     /**
      * Get the social account associated with this user.

-     * @return HasMany

      */
      */

-    public function socialAccounts()
+    public function socialAccounts(): HasMany

     {
         return $this->hasMany(SocialAccount::class);
     }
     {
         return $this->hasMany(SocialAccount::class);
     }


@@ -194,7 +208,9 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     /**
      * Check if the user has a social account,
      * If a driver is passed it checks for that single account type.
     /**
      * Check if the user has a social account,
      * If a driver is passed it checks for that single account type.

+     *

      * @param bool|string $socialDriver
      * @param bool|string $socialDriver

+     *

      * @return bool
      */
     public function hasSocialAccount($socialDriver = false)
      * @return bool
      */
     public function hasSocialAccount($socialDriver = false)


@@ -207,11 +223,9 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     }
 
     /**
     }
 
     /**

-     * Returns the user's avatar,
-     * @param int $size
-     * @return string
+     * Returns a URL to the user's avatar.

      */
      */

-    public function getAvatar($size = 50)
+    public function getAvatar(int $size = 50): string

     {
         $default = url('/user_avatar.png');
         $imageId = $this->image_id;
     {
         $default = url('/user_avatar.png');
         $imageId = $this->image_id;


@@ -224,14 +238,14 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
         } catch (Exception $err) {
             $avatar = $default;
         }
         } catch (Exception $err) {
             $avatar = $default;
         }

+

         return $avatar;
     }
 
     /**
      * Get the avatar for the user.
         return $avatar;
     }
 
     /**
      * Get the avatar for the user.

-     * @return BelongsTo

      */
      */

-    public function avatar()
+    public function avatar(): BelongsTo

     {
         return $this->belongsTo(Image::class, 'image_id');
     }
     {
         return $this->belongsTo(Image::class, 'image_id');
     }


@@ -244,6 +258,22 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
         return $this->hasMany(ApiToken::class);
     }
 
         return $this->hasMany(ApiToken::class);
     }
 

+    /**
+     * Get the favourite instances for this user.
+     */
+    public function favourites(): HasMany
+    {
+        return $this->hasMany(Favourite::class);
+    }
+
+    /**
+     * Get the MFA values belonging to this use.
+     */
+    public function mfaValues(): HasMany
+    {
+        return $this->hasMany(MfaValue::class);
+    }
+

     /**
      * Get the last activity time for this user.
      */
     /**
      * Get the last activity time for this user.
      */


@@ -263,6 +293,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     public function getEditUrl(string $path = ''): string
     {
         $uri = '/settings/users/' . $this->id . '/' . trim($path, '/');
     public function getEditUrl(string $path = ''): string
     {
         $uri = '/settings/users/' . $this->id . '/' . trim($path, '/');

+

         return url(rtrim($uri, '/'));
     }
 
         return url(rtrim($uri, '/'));
     }
 


@@ -271,15 +302,13 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     public function getProfileUrl(): string
     {
      */
     public function getProfileUrl(): string
     {

-        return url('/user/' . $this->id);
+        return url('/user/' . $this->slug);

     }
 
     /**
      * Get a shortened version of the user's name.
     }
 
     /**
      * Get a shortened version of the user's name.

-     * @param int $chars
-     * @return string

      */
      */

-    public function getShortName($chars = 8)
+    public function getShortName(int $chars = 8): string

     {
         if (mb_strlen($this->name) <= $chars) {
             return $this->name;
     {
         if (mb_strlen($this->name) <= $chars) {
             return $this->name;


@@ -295,7 +324,9 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
 
     /**
      * Send the password reset notification.
 
     /**
      * Send the password reset notification.

-     * @param  string  $token
+     *
+     * @param string $token
+     *

      * @return void
      */
     public function sendPasswordResetNotification($token)
      * @return void
      */
     public function sendPasswordResetNotification($token)


@@ -304,10 +335,20 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     }
 
     /**
     }
 
     /**

-     * @inheritdoc
+     * {@inheritdoc}

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

+
+    /**
+     * {@inheritdoc}
+     */
+    public function refreshSlug(): string
+    {
+        $this->slug = app(SlugGenerator::class)->generate($this);
+
+        return $this->slug;
+    }

 }
 }