mirror of
https://github.com/pterodactyl/panel.git
synced 2024-11-23 01:22:30 +01:00
277 lines
8.6 KiB
PHP
277 lines
8.6 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Models;
|
|
|
|
use Illuminate\Support\Str;
|
|
use Symfony\Component\Yaml\Yaml;
|
|
use Illuminate\Container\Container;
|
|
use Illuminate\Notifications\Notifiable;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Contracts\Encryption\Encrypter;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasManyThrough;
|
|
|
|
/**
|
|
* @property int $id
|
|
* @property string $uuid
|
|
* @property bool $public
|
|
* @property string $name
|
|
* @property string|null $description
|
|
* @property int $location_id
|
|
* @property int|null $database_host_id
|
|
* @property string $scheme
|
|
* @property string $fqdn
|
|
* @property int $listen_port_http
|
|
* @property int $listen_port_sftp
|
|
* @property int $public_port_http
|
|
* @property int $public_port_sftp
|
|
* @property bool $behind_proxy
|
|
* @property bool $maintenance_mode
|
|
* @property int $memory
|
|
* @property int $memory_overallocate
|
|
* @property int $sum_memory
|
|
* @property int $disk
|
|
* @property int $disk_overallocate
|
|
* @property int $sum_disk
|
|
* @property int $upload_size
|
|
* @property string $daemon_token_id
|
|
* @property string $daemon_token
|
|
* @property string $daemon_base
|
|
* @property int $servers_count
|
|
* @property \Carbon\Carbon $created_at
|
|
* @property \Carbon\Carbon $updated_at
|
|
* @property Allocation[]|Collection $allocations
|
|
* @property \Pterodactyl\Models\DatabaseHost|null $databaseHost
|
|
* @property Location $location
|
|
* @property Mount[]|Collection $mounts
|
|
* @property int[]|\Illuminate\Support\Collection $ports
|
|
* @property Server[]|Collection $servers
|
|
*/
|
|
class Node extends Model
|
|
{
|
|
use Notifiable;
|
|
|
|
/**
|
|
* The resource name for this model when it is transformed into an
|
|
* API representation using fractal.
|
|
*/
|
|
public const RESOURCE_NAME = 'node';
|
|
|
|
/**
|
|
* The default location of server files on the Wings instance.
|
|
*/
|
|
public const DEFAULT_DAEMON_BASE = '/var/lib/pterodactyl/volumes';
|
|
|
|
public const DAEMON_TOKEN_ID_LENGTH = 16;
|
|
public const DAEMON_TOKEN_LENGTH = 64;
|
|
|
|
/**
|
|
* The table associated with the model.
|
|
*/
|
|
protected $table = 'nodes';
|
|
|
|
/**
|
|
* The attributes excluded from the model's JSON form.
|
|
*/
|
|
protected $hidden = ['daemon_token_id', 'daemon_token'];
|
|
|
|
/**
|
|
* Cast values to correct type.
|
|
*/
|
|
protected $casts = [
|
|
'location_id' => 'integer',
|
|
'database_host_id' => 'integer',
|
|
'listen_port_http' => 'integer',
|
|
'listen_port_sftp' => 'integer',
|
|
'public_port_http' => 'integer',
|
|
'public_port_sftp' => 'integer',
|
|
'memory' => 'integer',
|
|
'disk' => 'integer',
|
|
'behind_proxy' => 'boolean',
|
|
'public' => 'boolean',
|
|
'maintenance_mode' => 'boolean',
|
|
];
|
|
|
|
/**
|
|
* Fields that are mass assignable.
|
|
*/
|
|
protected $fillable = [
|
|
'public', 'name', 'location_id', 'database_host_id',
|
|
'listen_port_http', 'listen_port_sftp', 'public_port_http', 'public_port_sftp',
|
|
'fqdn', 'scheme', 'behind_proxy',
|
|
'memory', 'memory_overallocate', 'disk',
|
|
'disk_overallocate', 'upload_size', 'daemon_base',
|
|
'description', 'maintenance_mode',
|
|
];
|
|
|
|
public static array $validationRules = [
|
|
'name' => 'required|regex:/^([\w .-]{1,100})$/',
|
|
'description' => 'string|nullable',
|
|
'location_id' => 'required|exists:locations,id',
|
|
'database_host_id' => 'sometimes|nullable|exists:database_hosts,id',
|
|
'public' => 'boolean',
|
|
'fqdn' => 'required|string',
|
|
'listen_port_http' => 'required|numeric|between:1,65535',
|
|
'listen_port_sftp' => 'required|numeric|between:1,65535',
|
|
'public_port_http' => 'required|numeric|between:1,65535',
|
|
'public_port_sftp' => 'required|numeric|between:1,65535',
|
|
'scheme' => 'required',
|
|
'behind_proxy' => 'boolean',
|
|
'memory' => 'required|numeric|min:1',
|
|
'memory_overallocate' => 'required|numeric|min:-1',
|
|
'disk' => 'required|numeric|min:1',
|
|
'disk_overallocate' => 'required|numeric|min:-1',
|
|
'daemon_base' => 'sometimes|required|regex:/^([\/][\d\w.\-\/]+)$/',
|
|
'maintenance_mode' => 'boolean',
|
|
'upload_size' => 'int|between:1,1024',
|
|
];
|
|
|
|
/**
|
|
* Default values for specific columns that are generally not changed on base installs.
|
|
*/
|
|
protected $attributes = [
|
|
'listen_port_http' => 8080,
|
|
'listen_port_sftp' => 2022,
|
|
'public_port_http' => 8080,
|
|
'public_port_sftp' => 2022,
|
|
'public' => true,
|
|
'behind_proxy' => false,
|
|
'memory_overallocate' => 0,
|
|
'disk_overallocate' => 0,
|
|
'daemon_base' => self::DEFAULT_DAEMON_BASE,
|
|
'maintenance_mode' => false,
|
|
];
|
|
|
|
/**
|
|
* Get the connection address to use when making calls to this node.
|
|
*/
|
|
public function getConnectionAddress(): string
|
|
{
|
|
return sprintf('%s://%s:%s', $this->scheme, $this->fqdn, $this->daemonListen);
|
|
}
|
|
|
|
/**
|
|
* Returns the configuration as an array.
|
|
*/
|
|
public function getConfiguration(): array
|
|
{
|
|
return [
|
|
'debug' => false,
|
|
'uuid' => $this->uuid,
|
|
'token_id' => $this->daemon_token_id,
|
|
'token' => Container::getInstance()->make(Encrypter::class)->decrypt($this->daemon_token),
|
|
'api' => [
|
|
'host' => '0.0.0.0',
|
|
'port' => $this->listen_port_http,
|
|
'ssl' => [
|
|
'enabled' => (!$this->behind_proxy && $this->scheme === 'https'),
|
|
'cert' => '/etc/letsencrypt/live/' . Str::lower($this->fqdn) . '/fullchain.pem',
|
|
'key' => '/etc/letsencrypt/live/' . Str::lower($this->fqdn) . '/privkey.pem',
|
|
],
|
|
'upload_limit' => $this->upload_size,
|
|
],
|
|
'system' => [
|
|
'data' => $this->daemon_base,
|
|
'sftp' => [
|
|
'bind_port' => $this->listen_port_sftp,
|
|
],
|
|
],
|
|
'allowed_mounts' => $this->mounts->pluck('source')->toArray(),
|
|
'remote' => route('index'),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns the configuration in Yaml format.
|
|
*/
|
|
public function getYamlConfiguration(): string
|
|
{
|
|
return Yaml::dump($this->getConfiguration(), 4, 2, Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE);
|
|
}
|
|
|
|
/**
|
|
* Returns the configuration in JSON format.
|
|
*/
|
|
public function getJsonConfiguration(bool $pretty = false): string
|
|
{
|
|
return json_encode($this->getConfiguration(), $pretty ? JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT : JSON_UNESCAPED_SLASHES);
|
|
}
|
|
|
|
/**
|
|
* Helper function to return the decrypted key for a node.
|
|
*/
|
|
public function getDecryptedKey(): string
|
|
{
|
|
return (string) Container::getInstance()->make(Encrypter::class)->decrypt(
|
|
$this->daemon_token
|
|
);
|
|
}
|
|
|
|
public function isUnderMaintenance(): bool
|
|
{
|
|
return $this->maintenance_mode;
|
|
}
|
|
|
|
/**
|
|
* Gets the allocations associated with a node.
|
|
*/
|
|
public function allocations(): HasMany
|
|
{
|
|
return $this->hasMany(Allocation::class);
|
|
}
|
|
|
|
/**
|
|
* Returns the database host associated with a node.
|
|
*/
|
|
public function databaseHost(): BelongsTo
|
|
{
|
|
return $this->belongsTo(DatabaseHost::class);
|
|
}
|
|
|
|
/**
|
|
* Gets the location associated with a node.
|
|
*/
|
|
public function location(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Location::class);
|
|
}
|
|
|
|
/**
|
|
* Returns a HasManyThrough relationship for all the mounts associated with a node.
|
|
*/
|
|
public function mounts(): HasManyThrough
|
|
{
|
|
return $this->hasManyThrough(Mount::class, MountNode::class, 'node_id', 'id', 'id', 'mount_id');
|
|
}
|
|
|
|
/**
|
|
* Gets the servers associated with a node.
|
|
*/
|
|
public function servers(): HasMany
|
|
{
|
|
return $this->hasMany(Server::class);
|
|
}
|
|
|
|
public function loadServerSums(): self
|
|
{
|
|
$this->loadSum('servers as sum_memory', 'memory');
|
|
$this->loadSum('servers as sum_disk', 'disk');
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns a boolean if the node is viable for an additional server to be placed on it.
|
|
*/
|
|
public function isViable(int $memory = 0, int $disk = 0): bool
|
|
{
|
|
$this->loadServerSums();
|
|
|
|
$memoryLimit = $this->memory * (1.0 + ($this->memory_overallocate / 100.0));
|
|
$diskLimit = $this->disk * (1.0 + ($this->disk_overallocate / 100.0));
|
|
|
|
return ($this->sum_memory + $memory) <= $memoryLimit && ($this->sum_disk + $disk) <= $diskLimit;
|
|
}
|
|
}
|