misc_pterodactyl-panel/app/Repositories/Eloquent/ServerRepository.php

184 lines
5.8 KiB
PHP
Raw Normal View History

<?php
2017-07-15 16:52:34 +00:00
namespace Pterodactyl\Repositories\Eloquent;
2017-07-15 16:52:34 +00:00
use Pterodactyl\Models\Server;
use Illuminate\Support\Collection;
2019-12-17 05:02:30 +00:00
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
2017-07-15 16:52:34 +00:00
use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
class ServerRepository extends EloquentRepository implements ServerRepositoryInterface
{
/**
* Return the model backing this repository.
*
* @return string
2017-07-15 16:52:34 +00:00
*/
public function model()
{
return Server::class;
}
2017-11-05 21:36:37 +00:00
/**
* Load the egg relations onto the server model.
*/
public function loadEggRelations(Server $server, bool $refresh = false): Server
{
2021-01-23 20:33:34 +00:00
if (!$server->relationLoaded('egg') || $refresh) {
2017-11-05 21:36:37 +00:00
$server->load('egg.scriptFrom');
}
return $server;
}
/**
* Return a collection of servers with their associated data for rebuild operations.
*/
public function getDataForRebuild(int $server = null, int $node = null): Collection
{
$instance = $this->getBuilder()->with(['allocation', 'allocations', 'egg', 'node']);
2021-01-23 20:33:34 +00:00
if (!is_null($server) && is_null($node)) {
2018-12-03 07:39:40 +00:00
$instance = $instance->where('id', '=', $server);
2021-01-23 20:33:34 +00:00
} elseif (is_null($server) && !is_null($node)) {
2018-12-03 07:39:40 +00:00
$instance = $instance->where('node_id', '=', $node);
}
return $instance->get($this->getColumns());
}
/**
* Return a collection of servers with their associated data for reinstall operations.
*/
public function getDataForReinstall(int $server = null, int $node = null): Collection
{
$instance = $this->getBuilder()->with(['allocation', 'allocations', 'egg', 'node']);
2018-12-03 07:39:40 +00:00
2021-01-23 20:33:34 +00:00
if (!is_null($server) && is_null($node)) {
$instance = $instance->where('id', '=', $server);
2021-01-23 20:33:34 +00:00
} elseif (is_null($server) && !is_null($node)) {
$instance = $instance->where('node_id', '=', $node);
2017-07-15 16:52:34 +00:00
}
return $instance->get($this->getColumns());
2017-07-15 16:52:34 +00:00
}
/**
* Return a server model and all variables associated with the server.
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
public function findWithVariables(int $id): Server
{
try {
/* @noinspection PhpIncompatibleReturnTypeInspection */
// @phpstan-ignore-next-line
return $this->getBuilder()->with('egg.variables', 'variables')
->where($this->getModel()->getKeyName(), '=', $id)
->firstOrFail($this->getColumns());
} catch (ModelNotFoundException $exception) {
2021-01-23 20:33:34 +00:00
throw new RecordNotFoundException();
}
}
/**
* Get the primary allocation for a given server. If a model is passed into
* the function, load the allocation relationship onto it. Otherwise, find and
* return the server from the database.
*/
public function getPrimaryAllocation(Server $server, bool $refresh = false): Server
{
2021-01-23 20:33:34 +00:00
if (!$server->relationLoaded('allocation') || $refresh) {
$server->load('allocation');
}
return $server;
}
/**
* Return enough data to be used for the creation of a server via the daemon.
*/
public function getDataForCreation(Server $server, bool $refresh = false): Server
{
foreach (['allocation', 'allocations', 'egg'] as $relation) {
2021-01-23 20:33:34 +00:00
if (!$server->relationLoaded($relation) || $refresh) {
$server->load($relation);
}
}
return $server;
}
/**
* Load associated databases onto the server model.
*/
public function loadDatabaseRelations(Server $server, bool $refresh = false): Server
{
2021-01-23 20:33:34 +00:00
if (!$server->relationLoaded('databases') || $refresh) {
$server->load('databases.host');
}
return $server;
}
/**
* Get data for use when updating a server on the Daemon. Returns an array of
* the egg which is used for build and rebuild. Only loads relations
* if they are missing, or refresh is set to true.
*/
public function getDaemonServiceData(Server $server, bool $refresh = false): array
{
2021-01-23 20:33:34 +00:00
if (!$server->relationLoaded('egg') || $refresh) {
$server->load('egg');
}
return [
'egg' => $server->getRelation('egg')->uuid,
];
}
/**
* Return a server by UUID.
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
public function getByUuid(string $uuid): Server
{
try {
2019-12-17 05:02:30 +00:00
/** @var \Pterodactyl\Models\Server $model */
$model = $this->getBuilder()
->with('nest', 'node')
->where(function (Builder $query) use ($uuid) {
$query->where('uuidShort', $uuid)->orWhere('uuid', $uuid);
})
->firstOrFail($this->getColumns());
return $model;
} catch (ModelNotFoundException $exception) {
2021-01-23 20:33:34 +00:00
throw new RecordNotFoundException();
}
}
/**
* Check if a given UUID and UUID-Short string are unique to a server.
*/
public function isUniqueUuidCombo(string $uuid, string $short): bool
{
2021-01-23 20:33:34 +00:00
return !$this->getBuilder()->where('uuid', '=', $uuid)->orWhere('uuidShort', '=', $short)->exists();
}
/**
* Returns all of the servers that exist for a given node in a paginated response.
*/
public function loadAllServersForNode(int $node, int $limit): LengthAwarePaginator
{
return $this->getBuilder()
->with(['user', 'nest', 'egg'])
->where('node_id', '=', $node)
->paginate($limit);
}
}