misc_pterodactyl-panel/app/Models/User.php

293 lines
9.4 KiB
PHP
Raw Normal View History

<?php
2016-12-07 22:46:38 +00:00
namespace Pterodactyl\Models;
use Pterodactyl\Rules\Username;
use Pterodactyl\Facades\Activity;
use Illuminate\Support\Collection;
use Illuminate\Validation\Rules\In;
use Illuminate\Auth\Authenticatable;
2016-12-07 22:46:38 +00:00
use Illuminate\Notifications\Notifiable;
use Illuminate\Database\Eloquent\Builder;
use Pterodactyl\Models\Traits\HasAccessTokens;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Database\Eloquent\Casts\Attribute;
2022-12-15 00:05:46 +00:00
use Illuminate\Database\Eloquent\Relations\HasOne;
use Pterodactyl\Traits\Helpers\AvailableLanguages;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
2016-12-07 22:46:38 +00:00
use Pterodactyl\Notifications\SendPasswordReset as ResetPasswordNotification;
/**
* Pterodactyl\Models\User.
*
* @property int $id
* @property string|null $external_id
* @property string $uuid
* @property string $username
* @property string $email
* @property string $password
* @property string|null $remember_token
* @property string $language
2022-12-15 00:05:46 +00:00
* @property int|null $admin_role_id
* @property bool $root_admin
* @property bool $use_totp
* @property string|null $totp_secret
* @property \Illuminate\Support\Carbon|null $totp_authenticated_at
* @property bool $gravatar
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
2022-12-15 19:26:34 +00:00
* @property string $avatar_url
* @property string|null $admin_role_name
* @property string $md5
* @property \Pterodactyl\Models\AdminRole|null $adminRole
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\ApiKey[] $apiKeys
* @property int|null $api_keys_count
* @property \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications
* @property int|null $notifications_count
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\RecoveryToken[] $recoveryTokens
* @property int|null $recovery_tokens_count
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Server[] $servers
* @property int|null $servers_count
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\UserSSHKey[] $sshKeys
* @property int|null $ssh_keys_count
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\ApiKey[] $tokens
* @property int|null $tokens_count
*
* @method static \Database\Factories\UserFactory factory(...$parameters)
* @method static Builder|User newModelQuery()
* @method static Builder|User newQuery()
* @method static Builder|User query()
* @method static Builder|User whereCreatedAt($value)
* @method static Builder|User whereEmail($value)
* @method static Builder|User whereExternalId($value)
* @method static Builder|User whereGravatar($value)
* @method static Builder|User whereId($value)
* @method static Builder|User whereLanguage($value)
* @method static Builder|User whereNameFirst($value)
* @method static Builder|User whereNameLast($value)
* @method static Builder|User wherePassword($value)
* @method static Builder|User whereRememberToken($value)
* @method static Builder|User whereRootAdmin($value)
* @method static Builder|User whereTotpAuthenticatedAt($value)
* @method static Builder|User whereTotpSecret($value)
* @method static Builder|User whereUpdatedAt($value)
* @method static Builder|User whereUseTotp($value)
* @method static Builder|User whereUsername($value)
* @method static Builder|User whereUuid($value)
*
* @mixin \Barryvdh\LaravelIdeHelper\Eloquent
* @mixin \Illuminate\Database\Query\Builder
* @mixin \Illuminate\Database\Eloquent\Builder
*/
class User extends Model implements
AuthenticatableContract,
AuthorizableContract,
CanResetPasswordContract
{
use Authenticatable;
use Authorizable;
use AvailableLanguages;
use CanResetPassword;
use HasAccessTokens;
use Notifiable;
2021-01-23 20:33:34 +00:00
public const USER_LEVEL_USER = 0;
public const USER_LEVEL_ADMIN = 1;
/**
* The resource name for this model when it is transformed into an
* API representation using fractal.
*/
2021-01-23 20:33:34 +00:00
public const RESOURCE_NAME = 'user';
/**
* Level of servers to display when using access() on a user.
*/
protected string $accessLevel = 'all';
/**
* The table associated with the model.
*/
protected $table = 'users';
/**
2017-01-12 20:40:24 +00:00
* A list of mass-assignable variables.
*/
protected $fillable = [
2018-02-24 20:47:53 +00:00
'external_id',
'username',
'email',
'password',
'language',
'use_totp',
'totp_secret',
2017-11-18 18:35:33 +00:00
'totp_authenticated_at',
'gravatar',
'root_admin',
];
2017-03-19 23:36:50 +00:00
/**
* Cast values to correct type.
*/
protected $casts = [
'root_admin' => 'boolean',
'use_totp' => 'boolean',
'gravatar' => 'boolean',
2023-02-23 19:30:16 +00:00
'totp_authenticated_at' => 'datetime',
2017-03-19 23:36:50 +00:00
];
2016-01-27 03:17:51 +00:00
/**
* The attributes excluded from the model's JSON form.
*/
2017-11-19 22:30:00 +00:00
protected $hidden = ['password', 'remember_token', 'totp_secret', 'totp_authenticated_at'];
/**
* Default values for specific fields in the database.
*/
protected $attributes = [
'external_id' => null,
'root_admin' => false,
'language' => 'en',
'use_totp' => false,
'totp_secret' => null,
];
/**
* Rules verifying that the data being stored matches the expectations of the database.
*/
public static array $validationRules = [
'uuid' => 'required|string|size:36|unique:users,uuid',
'email' => 'required|email|between:1,191|unique:users,email',
'external_id' => 'sometimes|nullable|string|max:191|unique:users,external_id',
'username' => 'required|between:1,191|unique:users,username',
'password' => 'sometimes|nullable|string',
'root_admin' => 'boolean',
2020-06-26 04:42:21 +00:00
'language' => 'string',
'use_totp' => 'boolean',
'totp_secret' => 'nullable|string',
];
/**
* Implement language verification by overriding Eloquence's gather
* rules function.
*/
public static function getRules(): array
{
2019-12-08 18:44:58 +00:00
$rules = parent::getRules();
2021-01-23 20:33:34 +00:00
$rules['language'][] = new In(array_keys((new self())->getAvailableLanguages()));
$rules['username'][] = new Username();
return $rules;
}
/**
2022-12-15 00:05:46 +00:00
* Return the user model in a format that can be passed over to React templates.
*/
2022-12-15 00:05:46 +00:00
public function toReactObject(): array
{
2022-12-15 19:26:34 +00:00
return Collection::make($this->append(['avatar_url', 'admin_role_name'])->toArray())
->except(['id', 'external_id', 'admin_role', 'admin_role_id'])
->toArray();
}
/**
* Send the password reset notification.
*
2017-08-22 03:10:48 +00:00
* @param string $token
*/
public function sendPasswordResetNotification($token)
{
Activity::event('auth:reset-password')
->withRequestMetadata()
->subject($this)
->log('sending password reset email');
$this->notify(new ResetPasswordNotification($token));
}
/**
2018-05-13 14:50:56 +00:00
* Store the username as a lowercase string.
*/
public function setUsernameAttribute(string $value)
{
$this->attributes['username'] = mb_strtolower($value);
}
2022-12-15 19:26:34 +00:00
public function avatarUrl(): Attribute
2022-12-15 00:05:46 +00:00
{
2022-12-15 19:26:34 +00:00
return Attribute::make(
get: fn () => 'https://www.gravatar.com/avatar/' . $this->md5 . '.jpg',
);
2022-12-15 00:05:46 +00:00
}
2022-12-15 19:26:34 +00:00
public function adminRoleName(): Attribute
2022-12-15 00:05:46 +00:00
{
2022-12-15 19:26:34 +00:00
return Attribute::make(
get: fn () => is_null($this->adminRole) ? ($this->root_admin ? 'None' : null) : $this->adminRole->name,
);
2022-12-15 00:05:46 +00:00
}
2022-12-15 19:26:34 +00:00
public function md5(): Attribute
2022-12-15 00:05:46 +00:00
{
2022-12-15 19:26:34 +00:00
return Attribute::make(
get: fn () => md5(strtolower($this->email)),
);
2022-12-15 00:05:46 +00:00
}
/**
2022-12-15 19:26:34 +00:00
* Returns all the activity logs where this user is the subject not to
* be confused by activity logs where this user is the _actor_.
*/
2022-12-15 19:26:34 +00:00
public function activity(): MorphToMany
{
2022-12-15 19:26:34 +00:00
return $this->morphToMany(ActivityLog::class, 'subject', 'activity_log_subjects');
}
public function adminRole(): HasOne
{
return $this->hasOne(AdminRole::class, 'id', 'admin_role_id');
}
public function apiKeys(): HasMany
{
return $this->hasMany(ApiKey::class)
->where('key_type', ApiKey::TYPE_ACCOUNT);
}
public function recoveryTokens(): HasMany
{
return $this->hasMany(RecoveryToken::class);
}
2022-12-15 19:26:34 +00:00
public function servers(): HasMany
{
2022-12-15 19:26:34 +00:00
return $this->hasMany(Server::class, 'owner_id');
}
2022-12-15 19:26:34 +00:00
public function sshKeys(): HasMany
{
2022-12-15 19:26:34 +00:00
return $this->hasMany(UserSSHKey::class);
}
/**
* Returns all the servers that a user can access by way of being the owner of the
* server, or because they are assigned as a subuser for that server.
*/
public function accessibleServers(): Builder
{
return Server::query()
->select('servers.*')
->leftJoin('subusers', 'subusers.server_id', '=', 'servers.id')
->where(function (Builder $builder) {
$builder->where('servers.owner_id', $this->id)->orWhere('subusers.user_id', $this->id);
})
->groupBy('servers.id');
}
}