LDAP: Added TLS support

[bookstack] / app / Auth / User.php

diff --git a/app/Auth/User.php b/app/Auth/User.php
index 05e77e13d0e4a84e45f0f1f0fd90bdd22bb8e683..f65ef5316f67bfe3c68f40a6e2f7925ac7aa8f27 100644 (file)
--- a/app/Auth/User.php
+++ b/app/Auth/User.php
@@ -1,15 +1,32 @@
 <?php namespace BookStack\Auth;
 
 <?php namespace BookStack\Auth;
 

+use BookStack\Api\ApiToken;

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

+use Carbon\Carbon;

 use Illuminate\Auth\Authenticatable;
 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\Auth\Authenticatable;
 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\Database\Eloquent\Relations\HasMany;

 use Illuminate\Notifications\Notifiable;
 
 use Illuminate\Notifications\Notifiable;
 

+/**
+ * Class User
+ * @package BookStack\Auth
+ * @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 extends Model implements AuthenticatableContract, CanResetPasswordContract
 {
     use Authenticatable, CanResetPassword, Notifiable;
 class User extends Model implements AuthenticatableContract, CanResetPasswordContract
 {
     use Authenticatable, CanResetPassword, Notifiable;


@@ -24,13 +41,16 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      * The attributes that are mass assignable.
      * @var array
      */
      * The attributes that are mass assignable.
      * @var array
      */

-    protected $fillable = ['name', 'email', 'image_id'];
+    protected $fillable = ['name', 'email'];

 
     /**
      * 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.


@@ -38,13 +58,24 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     protected $permissions;
 
      */
     protected $permissions;
 

+    /**
+     * This holds the default user when loaded.
+     * @var null|User
+     */
+    protected static $defaultUser = null;
+

     /**
      * Returns the default public user.
      * @return User
      */
     public static function getDefault()
     {
     /**
      * Returns the default public user.
      * @return User
      */
     public static function getDefault()
     {

-        return static::where('system_name', '=', 'public')->first();
+        if (!is_null(static::$defaultUser)) {
+            return static::$defaultUser;
+        }
+        
+        static::$defaultUser = static::where('system_name', '=', 'public')->first();
+        return static::$defaultUser;

     }
 
     /**
     }
 
     /**


@@ -70,12 +101,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);

     }
 
     /**
     }
 
     /**


@@ -88,6 +117,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


@@ -121,20 +161,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);

     }
 
     /**
     }
 
     /**


@@ -168,14 +198,14 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     public function getAvatar($size = 50)
     {
      */
     public function getAvatar($size = 50)
     {

-        $default = baseUrl('/user_avatar.png');
+        $default = url('/user_avatar.png');

         $imageId = $this->image_id;
         if ($imageId === 0 || $imageId === '0' || $imageId === null) {
             return $default;
         }
 
         try {
         $imageId = $this->image_id;
         if ($imageId === 0 || $imageId === '0' || $imageId === null) {
             return $default;
         }
 
         try {

-            $avatar = $this->avatar ? baseUrl($this->avatar->getThumb($size, $size, false)) : $default;
+            $avatar = $this->avatar ? url($this->avatar->getThumb($size, $size, false)) : $default;

         } catch (\Exception $err) {
             $avatar = $default;
         }
         } catch (\Exception $err) {
             $avatar = $default;
         }


@@ -191,22 +221,29 @@ 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 url for editing this user.
     /**
      * Get the url for editing this user.

-     * @return string

      */
      */

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

     {
     {

-        return baseUrl('/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 baseUrl('/user/' . $this->id);
+        return url('/user/' . $this->id);

     }
 
     /**
     }
 
     /**


@@ -216,12 +253,12 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     public function getShortName($chars = 8)
     {
      */
     public function getShortName($chars = 8)
     {

-        if (strlen($this->name) <= $chars) {
+        if (mb_strlen($this->name) <= $chars) {

             return $this->name;
         }
 
         $splitName = explode(' ', $this->name);
             return $this->name;
         }
 
         $splitName = explode(' ', $this->name);

-        if (strlen($splitName[0]) <= $chars) {
+        if (mb_strlen($splitName[0]) <= $chars) {

             return $splitName[0];
         }
 
             return $splitName[0];
         }