BookStack Code Mirror - bookstack/blob - app/Users/Models/User.php

   1 <?php
   2
   3 namespace BookStack\Users\Models;
   4
   5 use BookStack\Access\Mfa\MfaValue;
   6 use BookStack\Access\Notifications\ResetPasswordNotification;
   7 use BookStack\Access\SocialAccount;
   8 use BookStack\Activity\Models\Favourite;
   9 use BookStack\Activity\Models\Loggable;
  10 use BookStack\Activity\Models\Watch;
  11 use BookStack\Api\ApiToken;
  12 use BookStack\App\Model;
  13 use BookStack\App\Sluggable;
  14 use BookStack\Entities\Tools\SlugGenerator;
  15 use BookStack\Translation\LocaleDefinition;
  16 use BookStack\Translation\LocaleManager;
  17 use BookStack\Uploads\Image;
  18 use Carbon\Carbon;
  19 use Exception;
  20 use Illuminate\Auth\Authenticatable;
  21 use Illuminate\Auth\Passwords\CanResetPassword;
  22 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
  23 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
  24 use Illuminate\Database\Eloquent\Builder;
  25 use Illuminate\Database\Eloquent\Factories\HasFactory;
  26 use Illuminate\Database\Eloquent\Relations\BelongsTo;
  27 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
  28 use Illuminate\Database\Eloquent\Relations\HasMany;
  29 use Illuminate\Notifications\Notifiable;
  30 use Illuminate\Support\Collection;
  31
  32 /**
  33  * Class User.
  34  *
  35  * @property int        $id
  36  * @property string     $name
  37  * @property string     $slug
  38  * @property string     $email
  39  * @property string     $password
  40  * @property Carbon     $created_at
  41  * @property Carbon     $updated_at
  42  * @property bool       $email_confirmed
  43  * @property int        $image_id
  44  * @property string     $external_auth_id
  45  * @property string     $system_name
  46  * @property Collection $roles
  47  * @property Collection $mfaValues
  48  */
  49 class User extends Model implements AuthenticatableContract, CanResetPasswordContract, Loggable, Sluggable
  50 {
  51     use HasFactory;
  52     use Authenticatable;
  53     use CanResetPassword;
  54     use Notifiable;
  55
  56     /**
  57      * The database table used by the model.
  58      *
  59      * @var string
  60      */
  61     protected $table = 'users';
  62
  63     /**
  64      * The attributes that are mass assignable.
  65      *
  66      * @var array
  67      */
  68     protected $fillable = ['name', 'email'];
  69
  70     protected $casts = ['last_activity_at' => 'datetime'];
  71
  72     /**
  73      * The attributes excluded from the model's JSON form.
  74      *
  75      * @var array
  76      */
  77     protected $hidden = [
  78         'password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',
  79         'created_at', 'updated_at', 'image_id', 'roles', 'avatar', 'user_id', 'pivot',
  80     ];
  81
  82     /**
  83      * This holds the user's permissions when loaded.
  84      */
  85     protected ?Collection $permissions;
  86
  87     /**
  88      * This holds the user's avatar URL when loaded to prevent re-calculating within the same request.
  89      */
  90     protected string $avatarUrl = '';
  91
  92     /**
  93      * Returns the default public user.
  94      * Fetches from the container as a singleton to effectively cache at an app level.
  95      */
  96     public static function getGuest(): self
  97     {
  98         return app()->make('users.default');
  99     }
 100
 101     /**
 102      * Check if the user is the default public user.
 103      */
 104     public function isGuest(): bool
 105     {
 106         return $this->system_name === 'public';
 107     }
 108
 109     /**
 110      * Check if the user has general access to the application.
 111      */
 112     public function hasAppAccess(): bool
 113     {
 114         return !$this->isGuest() || setting('app-public');
 115     }
 116
 117     /**
 118      * The roles that belong to the user.
 119      *
 120      * @return BelongsToMany
 121      */
 122     public function roles()
 123     {
 124         if ($this->id === 0) {
 125             return;
 126         }
 127
 128         return $this->belongsToMany(Role::class);
 129     }
 130
 131     /**
 132      * Check if the user has a role.
 133      */
 134     public function hasRole($roleId): bool
 135     {
 136         return $this->roles->pluck('id')->contains($roleId);
 137     }
 138
 139     /**
 140      * Check if the user has a role.
 141      */
 142     public function hasSystemRole(string $roleSystemName): bool
 143     {
 144         return $this->roles->pluck('system_name')->contains($roleSystemName);
 145     }
 146
 147     /**
 148      * Attach the default system role to this user.
 149      */
 150     public function attachDefaultRole(): void
 151     {
 152         $roleId = intval(setting('registration-role'));
 153         if ($roleId && $this->roles()->where('id', '=', $roleId)->count() === 0) {
 154             $this->roles()->attach($roleId);
 155         }
 156     }
 157
 158     /**
 159      * Check if the user has a particular permission.
 160      */
 161     public function can(string $permissionName): bool
 162     {
 163         if ($this->email === 'guest') {
 164             return false;
 165         }
 166
 167         return $this->permissions()->contains($permissionName);
 168     }
 169
 170     /**
 171      * Get all permissions belonging to the current user.
 172      */
 173     protected function permissions(): Collection
 174     {
 175         if (isset($this->permissions)) {
 176             return $this->permissions;
 177         }
 178
 179         $this->permissions = $this->newQuery()->getConnection()->table('role_user', 'ru')
 180             ->select('role_permissions.name as name')->distinct()
 181             ->leftJoin('permission_role', 'ru.role_id', '=', 'permission_role.role_id')
 182             ->leftJoin('role_permissions', 'permission_role.permission_id', '=', 'role_permissions.id')
 183             ->where('ru.user_id', '=', $this->id)
 184             ->pluck('name');
 185
 186         return $this->permissions;
 187     }
 188
 189     /**
 190      * Clear any cached permissions on this instance.
 191      */
 192     public function clearPermissionCache()
 193     {
 194         $this->permissions = null;
 195     }
 196
 197     /**
 198      * Attach a role to this user.
 199      */
 200     public function attachRole(Role $role)
 201     {
 202         $this->roles()->attach($role->id);
 203         $this->unsetRelation('roles');
 204     }
 205
 206     /**
 207      * Get the social account associated with this user.
 208      */
 209     public function socialAccounts(): HasMany
 210     {
 211         return $this->hasMany(SocialAccount::class);
 212     }
 213
 214     /**
 215      * Check if the user has a social account,
 216      * If a driver is passed it checks for that single account type.
 217      *
 218      * @param bool|string $socialDriver
 219      *
 220      * @return bool
 221      */
 222     public function hasSocialAccount($socialDriver = false)
 223     {
 224         if ($socialDriver === false) {
 225             return $this->socialAccounts()->count() > 0;
 226         }
 227
 228         return $this->socialAccounts()->where('driver', '=', $socialDriver)->exists();
 229     }
 230
 231     /**
 232      * Returns a URL to the user's avatar.
 233      */
 234     public function getAvatar(int $size = 50): string
 235     {
 236         $default = url('/user_avatar.png');
 237         $imageId = $this->image_id;
 238         if ($imageId === 0 || $imageId === '0' || $imageId === null) {
 239             return $default;
 240         }
 241
 242         if (!empty($this->avatarUrl)) {
 243             return $this->avatarUrl;
 244         }
 245
 246         try {
 247             $avatar = $this->avatar?->getThumb($size, $size, false) ?? $default;
 248         } catch (Exception $err) {
 249             $avatar = $default;
 250         }
 251
 252         $this->avatarUrl = $avatar;
 253
 254         return $avatar;
 255     }
 256
 257     /**
 258      * Get the avatar for the user.
 259      */
 260     public function avatar(): BelongsTo
 261     {
 262         return $this->belongsTo(Image::class, 'image_id');
 263     }
 264
 265     /**
 266      * Get the API tokens assigned to this user.
 267      */
 268     public function apiTokens(): HasMany
 269     {
 270         return $this->hasMany(ApiToken::class);
 271     }
 272
 273     /**
 274      * Get the favourite instances for this user.
 275      */
 276     public function favourites(): HasMany
 277     {
 278         return $this->hasMany(Favourite::class);
 279     }
 280
 281     /**
 282      * Get the MFA values belonging to this use.
 283      */
 284     public function mfaValues(): HasMany
 285     {
 286         return $this->hasMany(MfaValue::class);
 287     }
 288
 289     /**
 290      * Get the tracked entity watches for this user.
 291      */
 292     public function watches(): HasMany
 293     {
 294         return $this->hasMany(Watch::class);
 295     }
 296
 297     /**
 298      * Get the last activity time for this user.
 299      */
 300     public function scopeWithLastActivityAt(Builder $query)
 301     {
 302         $query->addSelect(['activities.created_at as last_activity_at'])
 303             ->leftJoinSub(function (\Illuminate\Database\Query\Builder $query) {
 304                 $query->from('activities')->select('user_id')
 305                     ->selectRaw('max(created_at) as created_at')
 306                     ->groupBy('user_id');
 307             }, 'activities', 'users.id', '=', 'activities.user_id');
 308     }
 309
 310     /**
 311      * Get the url for editing this user.
 312      */
 313     public function getEditUrl(string $path = ''): string
 314     {
 315         $uri = '/settings/users/' . $this->id . '/' . trim($path, '/');
 316
 317         return url(rtrim($uri, '/'));
 318     }
 319
 320     /**
 321      * Get the url that links to this user's profile.
 322      */
 323     public function getProfileUrl(): string
 324     {
 325         return url('/user/' . $this->slug);
 326     }
 327
 328     /**
 329      * Get a shortened version of the user's name.
 330      */
 331     public function getShortName(int $chars = 8): string
 332     {
 333         if (mb_strlen($this->name) <= $chars) {
 334             return $this->name;
 335         }
 336
 337         $splitName = explode(' ', $this->name);
 338         if (mb_strlen($splitName[0]) <= $chars) {
 339             return $splitName[0];
 340         }
 341
 342         return mb_substr($this->name, 0, max($chars - 2, 0)) . '…';
 343     }
 344
 345     /**
 346      * Get the locale for this user.
 347      */
 348     public function getLocale(): LocaleDefinition
 349     {
 350         return app()->make(LocaleManager::class)->getForUser($this);
 351     }
 352
 353     /**
 354      * Send the password reset notification.
 355      *
 356      * @param string $token
 357      *
 358      * @return void
 359      */
 360     public function sendPasswordResetNotification($token)
 361     {
 362         $this->notify(new ResetPasswordNotification($token));
 363     }
 364
 365     /**
 366      * {@inheritdoc}
 367      */
 368     public function logDescriptor(): string
 369     {
 370         return "({$this->id}) {$this->name}";
 371     }
 372
 373     /**
 374      * {@inheritdoc}
 375      */
 376     public function refreshSlug(): string
 377     {
 378         $this->slug = app()->make(SlugGenerator::class)->generate($this);
 379
 380         return $this->slug;
 381     }
 382 }