Laravel 10 + Cachet Core

app/Models/User.php

@@ -1,212 +1,45 @@
 <?php
 
-/*
- * This file is part of Cachet.
- *
- * (c) Alt Three Services Limited
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
+namespace App\Models;
 
-namespace CachetHQ\Cachet\Models;
-
-use AltThree\Validator\ValidatingTrait;
-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Model;
+// use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
-use Illuminate\Support\Facades\Hash;
-use Illuminate\Support\Str;
+use Laravel\Sanctum\HasApiTokens;
 
-/**
- * This is the user model.
- *
- * @author James Brooks <james@alt-three.com>
- */
 class User extends Authenticatable
 {
-    use Notifiable;
-    use ValidatingTrait;
-    /**
-     * The admin level of user.
-     *
-     * @var int
-     */
-    const LEVEL_ADMIN = 1;
+    use HasApiTokens, HasFactory, Notifiable;
 
     /**
-     * The general level of user.
+     * The attributes that are mass assignable.
      *
-     * @var int
-     */
-    const LEVEL_USER = 2;
-
-    /**
-     * The model's attributes.
-     *
-     * @var string[]
-     */
-    protected $attributes = [
-        'welcomed' => false,
-    ];
-
-    /**
-     * The attributes that should be casted to native types.
-     *
-     * @var string[]
-     */
-    protected $casts = [
-        'username'          => 'string',
-        'email'             => 'string',
-        'google_2fa_secret' => 'string',
-        'api_key'           => 'string',
-        'active'            => 'bool',
-        'level'             => 'int',
-        'welcomed'          => 'bool',
-    ];
-
-    /**
-     * The fillable properties.
-     *
-     * @var string[]
+     * @var array<int, string>
      */
     protected $fillable = [
-        'username',
-        'password',
-        'google_2fa_secret',
+        'name',
         'email',
-        'api_key',
-        'active',
-        'level',
-        'welcomed',
+        'password',
     ];
 
     /**
-     * The properties that cannot be mass assigned.
+     * The attributes that should be hidden for serialization.
      *
-     * @var string[]
+     * @var array<int, string>
      */
-    protected $guarded = [];
-
-    /**
-     * The hidden properties.
-     *
-     * These are excluded when we are serializing the model.
-     *
-     * @var string[]
-     */
-    protected $hidden = ['password', 'remember_token', 'google_2fa_secret'];
-
-    /**
-     * The validation rules.
-     *
-     * @var string[]
-     */
-    public $rules = [
-        'username' => ['required', 'regex:/\A(?!.*[:;]-\))[ -~]+\z/'],
-        'email'    => 'required|email',
-        'password' => 'required',
+    protected $hidden = [
+        'password',
+        'remember_token',
     ];
 
     /**
-     * Overrides the models boot method.
+     * The attributes that should be cast.
      *
-     * @return void
+     * @var array<string, string>
      */
-    public static function boot()
-    {
-        parent::boot();
-
-        self::creating(function ($user) {
-            if (!$user->api_key) {
-                $user->api_key = self::generateApiKey();
-            }
-        });
-    }
-
-    /**
-     * Scope all admin users.
-     *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     *
-     * @return \Illuminate\Database\Eloquent\Builder
-     */
-    public function scopeAdmins(Builder $query)
-    {
-        return $query->where('level', '=', self::LEVEL_ADMIN);
-    }
-
-    /**
-     * Scope all active users.
-     *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     *
-     * @return \Illuminate\Database\Eloquent\Builder
-     */
-    public function scopeActive(Builder $query)
-    {
-        return $query->where('active', '=', true);
-    }
-
-    /**
-     * Hash any password being inserted by default.
-     *
-     * @param string $password
-     *
-     * @return \CachetHQ\Cachet\Models\User
-     */
-    public function setPasswordAttribute($password)
-    {
-        $this->attributes['password'] = Hash::make($password);
-
-        return $this;
-    }
-
-    /**
-     * Find by api_key, or throw an exception.
-     *
-     * @param string   $token
-     * @param string[] $columns
-     *
-     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
-     *
-     * @return \CachetHQ\Cachet\Models\User
-     */
-    public static function findByApiToken($token, $columns = ['*'])
-    {
-        $user = static::where('api_key', $token)->firstOrFail($columns);
-
-        return $user;
-    }
-
-    /**
-     * Returns an API key.
-     *
-     * @return string
-     */
-    public static function generateApiKey()
-    {
-        return Str::random(20);
-    }
-
-    /**
-     * Returns whether a user is at admin level.
-     *
-     * @return bool
-     */
-    public function getIsAdminAttribute()
-    {
-        return $this->level == self::LEVEL_ADMIN;
-    }
-
-    /**
-     * Returns if a user has enabled two factor authentication.
-     *
-     * @return bool
-     */
-    public function getHasTwoFactorAttribute()
-    {
-        return trim($this->google_2fa_secret) !== '';
-    }
+    protected $casts = [
+        'email_verified_at' => 'datetime',
+        'password' => 'hashed',
+    ];
 }