misc_pterodactyl-panel/app/Http/Controllers/Api/Remote/Servers/ServerDetailsController.php

132 lines
5.6 KiB
PHP
Raw Normal View History

<?php
namespace Pterodactyl\Http\Controllers\Api\Remote\Servers;
use Illuminate\Http\Request;
2021-03-05 17:03:12 +00:00
use Illuminate\Http\Response;
use Pterodactyl\Models\Server;
use Pterodactyl\Models\AuditLog;
use Illuminate\Http\JsonResponse;
use Illuminate\Database\Query\Builder;
use Illuminate\Database\Query\JoinClause;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Services\Eggs\EggConfigurationService;
use Pterodactyl\Repositories\Eloquent\ServerRepository;
use Pterodactyl\Http\Resources\Wings\ServerConfigurationCollection;
use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
class ServerDetailsController extends Controller
{
2021-03-05 17:03:12 +00:00
private ServerRepository $repository;
private ServerConfigurationStructureService $configurationStructureService;
private EggConfigurationService $eggConfigurationService;
/**
2021-03-05 17:03:12 +00:00
* ServerDetailsController constructor.
*/
public function __construct(
ServerRepository $repository,
ServerConfigurationStructureService $configurationStructureService,
2021-03-05 17:03:12 +00:00
EggConfigurationService $eggConfigurationService
) {
$this->repository = $repository;
$this->configurationStructureService = $configurationStructureService;
2021-03-05 17:03:12 +00:00
$this->eggConfigurationService = $eggConfigurationService;
}
/**
* Returns details about the server that allows Wings to self-recover and ensure
* that the state of the server matches the Panel at all times.
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
2021-03-05 17:03:12 +00:00
public function __invoke(Request $request, string $uuid): JsonResponse
{
$server = $this->repository->getByUuid($uuid);
return new JsonResponse([
'settings' => $this->configurationStructureService->handle($server),
'process_configuration' => $this->eggConfigurationService->handle($server),
]);
}
/**
* Lists all servers with their configurations that are assigned to the requesting node.
*/
2021-03-05 17:03:12 +00:00
public function list(Request $request): ServerConfigurationCollection
{
/** @var \Pterodactyl\Models\Node $node */
$node = $request->attributes->get('node');
// Avoid run-away N+1 SQL queries by pre-loading the relationships that are used
// within each of the services called below.
2020-10-31 18:28:31 +00:00
$servers = Server::query()->with('allocations', 'egg', 'mounts', 'variables', 'location')
->where('node_id', $node->id)
// If you don't cast this to a string you'll end up with a stringified per_page returned in
// the metadata, and then Wings will panic crash as a result.
->paginate((int) $request->input('per_page', 50));
return new ServerConfigurationCollection($servers);
}
/**
* Resets the state of all servers on the node to be normal. This is triggered
* when Wings restarts and is useful for ensuring that any servers on the node
* do not get incorrectly stuck in installing/restoring from backup states since
* a Wings reboot would completely stop those processes.
*
* @throws \Throwable
*/
2021-03-05 17:03:12 +00:00
public function resetState(Request $request): Response
{
$node = $request->attributes->get('node');
// Get all of the servers that are currently marked as restoring from a backup
// on this node that do not have a failed backup tracked in the audit logs table
// as well.
//
// For each of those servers we'll track a new audit log entry to mark them as
// failed and then update them all to be in a valid state.
/** @var \Pterodactyl\Models\Server[] $servers */
$servers = Server::query()
->select('servers.*')
->selectRaw('started.metadata->>"$.backup_uuid" as backup_uuid')
->leftJoinSub(function (Builder $builder) {
$builder->select('*')->from('audit_logs')
->where('action', AuditLog::SERVER__BACKUP_RESTORE_STARTED)
->orderByDesc('created_at')
->limit(1);
}, 'started', 'started.server_id', '=', 'servers.id')
->leftJoin('audit_logs as completed', function (JoinClause $clause) {
$clause->whereColumn('completed.created_at', '>', 'started.created_at')
->whereIn('completed.action', [
AuditLog::SERVER__BACKUP_RESTORE_COMPLETED,
AuditLog::SERVER__BACKUP_RESTORE_FAILED,
]);
})
->whereNotNull('started.id')
->whereNull('completed.id')
->where('servers.node_id', $node->id)
->where('servers.status', Server::STATUS_RESTORING_BACKUP)
->get();
foreach ($servers as $server) {
// Just create a new audit entry for this event and update the server state
// so that power actions, file management, and backups can resume as normal.
$server->audit(AuditLog::SERVER__BACKUP_RESTORE_FAILED, function (AuditLog $audit, Server $server) {
$audit->is_system = true;
$audit->metadata = ['backup_uuid' => $server->getAttribute('backup_uuid')];
$server->update(['status' => null]);
});
}
// Update any server marked as installing or restoring as being in a normal state
// at this point in the process.
Server::query()->where('node_id', $node->id)
->whereIn('status', [Server::STATUS_INSTALLING, Server::STATUS_RESTORING_BACKUP])
->update(['status' => null]);
2021-03-05 17:03:12 +00:00
return new Response('', JsonResponse::HTTP_NO_CONTENT);
}
}