420 lines
15 KiB
PHP
420 lines
15 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Models;
|
|
|
|
use Illuminate\Notifications\Notifiable;
|
|
use Illuminate\Database\Query\JoinClause;
|
|
use Znck\Eloquent\Traits\BelongsToThrough;
|
|
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
|
use Pterodactyl\Exceptions\Http\Server\ServerStateConflictException;
|
|
|
|
/**
|
|
* \Pterodactyl\Models\Server.
|
|
*
|
|
* @property int $id
|
|
* @property string|null $external_id
|
|
* @property string $uuid
|
|
* @property string $uuidShort
|
|
* @property int $node_id
|
|
* @property string $name
|
|
* @property string $description
|
|
* @property string|null $status
|
|
* @property bool $skip_scripts
|
|
* @property int $owner_id
|
|
* @property int $memory
|
|
* @property int $swap
|
|
* @property int $disk
|
|
* @property int $io
|
|
* @property int $cpu
|
|
* @property string|null $threads
|
|
* @property bool $oom_disabled
|
|
* @property int $allocation_id
|
|
* @property int $nest_id
|
|
* @property int $egg_id
|
|
* @property string $startup
|
|
* @property string $image
|
|
* @property int|null $allocation_limit
|
|
* @property int|null $database_limit
|
|
* @property int $backup_limit
|
|
* @property \Illuminate\Support\Carbon|null $created_at
|
|
* @property \Illuminate\Support\Carbon|null $updated_at
|
|
* @property \Illuminate\Support\Carbon|null $installed_at
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\ActivityLog[] $activity
|
|
* @property int|null $activity_count
|
|
* @property \Pterodactyl\Models\Allocation|null $allocation
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Allocation[] $allocations
|
|
* @property int|null $allocations_count
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Backup[] $backups
|
|
* @property int|null $backups_count
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Database[] $databases
|
|
* @property int|null $databases_count
|
|
* @property \Pterodactyl\Models\Egg|null $egg
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Mount[] $mounts
|
|
* @property int|null $mounts_count
|
|
* @property \Pterodactyl\Models\Nest $nest
|
|
* @property \Pterodactyl\Models\Node $node
|
|
* @property \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications
|
|
* @property int|null $notifications_count
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Schedule[] $schedules
|
|
* @property int|null $schedules_count
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Subuser[] $subusers
|
|
* @property int|null $subusers_count
|
|
* @property \Pterodactyl\Models\ServerTransfer|null $transfer
|
|
* @property \Pterodactyl\Models\User $user
|
|
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\EggVariable[] $variables
|
|
* @property int|null $variables_count
|
|
*
|
|
* @method static \Database\Factories\ServerFactory factory(...$parameters)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server newModelQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server newQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server query()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereAllocationId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereAllocationLimit($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereBackupLimit($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereCpu($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereCreatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereDatabaseLimit($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereDescription($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereDisk($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereEggId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereExternalId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereImage($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereIo($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereMemory($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereName($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereNestId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereNodeId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereOomDisabled($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereOwnerId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereSkipScripts($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereStartup($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereStatus($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereSwap($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereThreads($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereUpdatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereUuid($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Server whereUuidShort($value)
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Server extends Model
|
|
{
|
|
use BelongsToThrough;
|
|
use Notifiable;
|
|
|
|
/**
|
|
* The resource name for this model when it is transformed into an
|
|
* API representation using fractal.
|
|
*/
|
|
public const RESOURCE_NAME = 'server';
|
|
|
|
public const STATUS_INSTALLING = 'installing';
|
|
public const STATUS_INSTALL_FAILED = 'install_failed';
|
|
public const STATUS_SUSPENDED = 'suspended';
|
|
public const STATUS_RESTORING_BACKUP = 'restoring_backup';
|
|
|
|
/**
|
|
* The table associated with the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $table = 'servers';
|
|
|
|
/**
|
|
* Default values when creating the model. We want to switch to disabling OOM killer
|
|
* on server instances unless the user specifies otherwise in the request.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $attributes = [
|
|
'status' => self::STATUS_INSTALLING,
|
|
'oom_disabled' => true,
|
|
'installed_at' => null,
|
|
];
|
|
|
|
/**
|
|
* The default relationships to load for all server models.
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected $with = ['allocation'];
|
|
|
|
/**
|
|
* The attributes that should be mutated to dates.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $dates = [self::CREATED_AT, self::UPDATED_AT, 'deleted_at', 'installed_at'];
|
|
|
|
/**
|
|
* Fields that are not mass assignable.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $guarded = ['id', self::CREATED_AT, self::UPDATED_AT, 'deleted_at', 'installed_at'];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
public static $validationRules = [
|
|
'external_id' => 'sometimes|nullable|string|between:1,191|unique:servers',
|
|
'owner_id' => 'required|integer|exists:users,id',
|
|
'name' => 'required|string|min:1|max:191',
|
|
'node_id' => 'required|exists:nodes,id',
|
|
'description' => 'string',
|
|
'status' => 'nullable|string',
|
|
'memory' => 'required|numeric|min:0',
|
|
'swap' => 'required|numeric|min:-1',
|
|
'io' => 'required|numeric|between:10,1000',
|
|
'cpu' => 'required|numeric|min:0',
|
|
'threads' => 'nullable|regex:/^[0-9-,]+$/',
|
|
'oom_disabled' => 'sometimes|boolean',
|
|
'disk' => 'required|numeric|min:0',
|
|
'allocation_id' => 'required|bail|unique:servers|exists:allocations,id',
|
|
'nest_id' => 'required|exists:nests,id',
|
|
'egg_id' => 'required|exists:eggs,id',
|
|
'startup' => 'required|string',
|
|
'skip_scripts' => 'sometimes|boolean',
|
|
'image' => 'required|string|max:191',
|
|
'database_limit' => 'present|nullable|integer|min:0',
|
|
'allocation_limit' => 'sometimes|nullable|integer|min:0',
|
|
'backup_limit' => 'present|nullable|integer|min:0',
|
|
];
|
|
|
|
/**
|
|
* Cast values to correct type.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $casts = [
|
|
'node_id' => 'integer',
|
|
'skip_scripts' => 'boolean',
|
|
'owner_id' => 'integer',
|
|
'memory' => 'integer',
|
|
'swap' => 'integer',
|
|
'disk' => 'integer',
|
|
'io' => 'integer',
|
|
'cpu' => 'integer',
|
|
'oom_disabled' => 'boolean',
|
|
'allocation_id' => 'integer',
|
|
'nest_id' => 'integer',
|
|
'egg_id' => 'integer',
|
|
'database_limit' => 'integer',
|
|
'allocation_limit' => 'integer',
|
|
'backup_limit' => 'integer',
|
|
];
|
|
|
|
/**
|
|
* Returns the format for server allocations when communicating with the Daemon.
|
|
*/
|
|
public function getAllocationMappings(): array
|
|
{
|
|
return $this->allocations->where('node_id', $this->node_id)->groupBy('ip')->map(function ($item) {
|
|
return $item->pluck('port');
|
|
})->toArray();
|
|
}
|
|
|
|
public function isInstalled(): bool
|
|
{
|
|
return $this->status !== self::STATUS_INSTALLING && $this->status !== self::STATUS_INSTALL_FAILED;
|
|
}
|
|
|
|
public function isSuspended(): bool
|
|
{
|
|
return $this->status === self::STATUS_SUSPENDED;
|
|
}
|
|
|
|
/**
|
|
* Gets the user who owns the server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function user()
|
|
{
|
|
return $this->belongsTo(User::class, 'owner_id');
|
|
}
|
|
|
|
/**
|
|
* Gets the subusers associated with a server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function subusers()
|
|
{
|
|
return $this->hasMany(Subuser::class, 'server_id', 'id');
|
|
}
|
|
|
|
/**
|
|
* Gets the default allocation for a server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasOne
|
|
*/
|
|
public function allocation()
|
|
{
|
|
return $this->hasOne(Allocation::class, 'id', 'allocation_id');
|
|
}
|
|
|
|
/**
|
|
* Gets all allocations associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function allocations()
|
|
{
|
|
return $this->hasMany(Allocation::class, 'server_id');
|
|
}
|
|
|
|
/**
|
|
* Gets information for the nest associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function nest()
|
|
{
|
|
return $this->belongsTo(Nest::class);
|
|
}
|
|
|
|
/**
|
|
* Gets information for the egg associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasOne
|
|
*/
|
|
public function egg()
|
|
{
|
|
return $this->hasOne(Egg::class, 'id', 'egg_id');
|
|
}
|
|
|
|
/**
|
|
* Gets information for the service variables associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function variables()
|
|
{
|
|
return $this->hasMany(EggVariable::class, 'egg_id', 'egg_id')
|
|
->select(['egg_variables.*', 'server_variables.variable_value as server_value'])
|
|
->leftJoin('server_variables', function (JoinClause $join) {
|
|
// Don't forget to join against the server ID as well since the way we're using this relationship
|
|
// would actually return all of the variables and their values for _all_ servers using that egg,\
|
|
// rather than only the server for this model.
|
|
//
|
|
// @see https://github.com/pterodactyl/panel/issues/2250
|
|
$join->on('server_variables.variable_id', 'egg_variables.id')
|
|
->where('server_variables.server_id', $this->id);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Gets information for the node associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function node()
|
|
{
|
|
return $this->belongsTo(Node::class);
|
|
}
|
|
|
|
/**
|
|
* Gets information for the tasks associated with this server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function schedules()
|
|
{
|
|
return $this->hasMany(Schedule::class);
|
|
}
|
|
|
|
/**
|
|
* Gets all databases associated with a server.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function databases()
|
|
{
|
|
return $this->hasMany(Database::class);
|
|
}
|
|
|
|
/**
|
|
* Returns the location that a server belongs to.
|
|
*
|
|
* @return \Znck\Eloquent\Relations\BelongsToThrough
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function location()
|
|
{
|
|
return $this->belongsToThrough(Location::class, Node::class);
|
|
}
|
|
|
|
/**
|
|
* Returns the associated server transfer.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasOne
|
|
*/
|
|
public function transfer()
|
|
{
|
|
return $this->hasOne(ServerTransfer::class)->whereNull('successful')->orderByDesc('id');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function backups()
|
|
{
|
|
return $this->hasMany(Backup::class);
|
|
}
|
|
|
|
/**
|
|
* Returns all mounts that have this server has mounted.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
|
|
*/
|
|
public function mounts()
|
|
{
|
|
return $this->hasManyThrough(Mount::class, MountServer::class, 'server_id', 'id', 'id', 'mount_id');
|
|
}
|
|
|
|
/**
|
|
* Returns all of the activity log entries where the server is the subject.
|
|
*/
|
|
public function activity(): MorphToMany
|
|
{
|
|
return $this->morphToMany(ActivityLog::class, 'subject', 'activity_log_subjects');
|
|
}
|
|
|
|
/**
|
|
* Checks if the server is currently in a user-accessible state. If not, an
|
|
* exception is raised. This should be called whenever something needs to make
|
|
* sure the server is not in a weird state that should block user access.
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Http\Server\ServerStateConflictException
|
|
*/
|
|
public function validateCurrentState()
|
|
{
|
|
if (
|
|
$this->isSuspended() ||
|
|
!$this->isInstalled() ||
|
|
$this->status === self::STATUS_RESTORING_BACKUP ||
|
|
!is_null($this->transfer)
|
|
) {
|
|
throw new ServerStateConflictException($this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if the server is currently in a transferable state. If not, an
|
|
* exception is raised. This should be called whenever something needs to make
|
|
* sure the server is able to be transferred and is not currently being transferred
|
|
* or installed.
|
|
*/
|
|
public function validateTransferState()
|
|
{
|
|
if (
|
|
!$this->isInstalled() ||
|
|
$this->status === self::STATUS_RESTORING_BACKUP ||
|
|
!is_null($this->transfer)
|
|
) {
|
|
throw new ServerStateConflictException($this);
|
|
}
|
|
}
|
|
}
|