misc_pterodactyl-panel/app/Http/Controllers/Api/Client/Servers/BackupController.php

228 lines
8.7 KiB
PHP
Raw Normal View History

<?php
namespace Pterodactyl\Http\Controllers\Api\Client\Servers;
use Illuminate\Http\Request;
use Pterodactyl\Models\Backup;
use Pterodactyl\Models\Server;
use Illuminate\Http\JsonResponse;
use Pterodactyl\Facades\Activity;
use Pterodactyl\Models\Permission;
2021-01-31 03:12:22 +00:00
use Illuminate\Auth\Access\AuthorizationException;
use Pterodactyl\Services\Backups\DeleteBackupService;
use Pterodactyl\Services\Backups\DownloadLinkService;
use Pterodactyl\Repositories\Eloquent\BackupRepository;
2021-08-16 00:20:36 +00:00
use Pterodactyl\Services\Backups\InitiateBackupService;
use Pterodactyl\Repositories\Wings\DaemonBackupRepository;
2021-01-26 03:20:51 +00:00
use Pterodactyl\Transformers\Api\Client\BackupTransformer;
use Pterodactyl\Http\Controllers\Api\Client\ClientApiController;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Pterodactyl\Http\Requests\Api\Client\Servers\Backups\StoreBackupRequest;
class BackupController extends ClientApiController
{
/**
* BackupController constructor.
*/
2020-04-10 05:35:38 +00:00
public function __construct(
private DaemonBackupRepository $daemonRepository,
private DeleteBackupService $deleteBackupService,
private InitiateBackupService $initiateBackupService,
private DownloadLinkService $downloadLinkService,
private BackupRepository $repository
2020-04-10 05:35:38 +00:00
) {
parent::__construct();
}
/**
* Returns all the backups for a given server instance in a paginated
* result set.
*
2021-01-31 03:12:22 +00:00
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
2021-01-26 03:25:15 +00:00
public function index(Request $request, Server $server): array
{
2021-01-26 03:20:51 +00:00
if (!$request->user()->can(Permission::ACTION_BACKUP_READ, $server)) {
2021-01-31 03:12:22 +00:00
throw new AuthorizationException();
}
$limit = min($request->query('per_page') ?? 20, 50);
return $this->fractal->collection($server->backups()->paginate($limit))
->transformWith($this->getTransformer(BackupTransformer::class))
->addMeta([
'backup_count' => $this->repository->getNonFailedBackups($server)->count(),
])
->toArray();
}
/**
* Starts the backup process for a server.
*
2021-01-26 03:25:15 +00:00
* @throws \Spatie\Fractalistic\Exceptions\InvalidTransformation
* @throws \Spatie\Fractalistic\Exceptions\NoTransformerSpecified
* @throws \Throwable
*/
2021-01-26 03:25:15 +00:00
public function store(StoreBackupRequest $request, Server $server): array
{
$action = $this->initiateBackupService
->setIgnoredFiles(explode(PHP_EOL, $request->input('ignored') ?? ''));
// Only set the lock status if the user even has permission to delete backups,
// otherwise ignore this status. This gets a little funky since it isn't clear
// how best to allow a user to create a backup that is locked without also preventing
// them from just filling up a server with backups that can never be deleted?
if ($request->user()->can(Permission::ACTION_BACKUP_DELETE, $server)) {
$action->setIsLocked((bool) $request->input('is_locked'));
}
$backup = $action->handle($server, $request->input('name'));
Activity::event('server:backup.start')
->subject($backup)
->property(['name' => $backup->name, 'locked' => (bool) $request->input('is_locked')])
->log();
return $this->fractal->item($backup)
->transformWith($this->getTransformer(BackupTransformer::class))
->toArray();
}
/**
* Toggles the lock status of a given backup for a server.
*
* @throws \Throwable
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function toggleLock(Request $request, Server $server, Backup $backup): array
{
if (!$request->user()->can(Permission::ACTION_BACKUP_DELETE, $server)) {
throw new AuthorizationException();
}
$action = $backup->is_locked ? 'server:backup.unlock' : 'server:backup.lock';
$backup->update(['is_locked' => !$backup->is_locked]);
Activity::event($action)->subject($backup)->property('name', $backup->name)->log();
return $this->fractal->item($backup)
->transformWith($this->getTransformer(BackupTransformer::class))
->toArray();
}
/**
* Returns information about a single backup.
*
2021-01-31 03:12:22 +00:00
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
2021-01-26 03:25:15 +00:00
public function view(Request $request, Server $server, Backup $backup): array
{
2021-01-26 03:20:51 +00:00
if (!$request->user()->can(Permission::ACTION_BACKUP_READ, $server)) {
2021-01-31 03:12:22 +00:00
throw new AuthorizationException();
}
return $this->fractal->item($backup)
->transformWith($this->getTransformer(BackupTransformer::class))
->toArray();
}
/**
* Deletes a backup from the panel as well as the remote source where it is currently
* being stored.
*
* @throws \Throwable
*/
2021-01-26 03:25:15 +00:00
public function delete(Request $request, Server $server, Backup $backup): JsonResponse
{
2021-01-26 03:20:51 +00:00
if (!$request->user()->can(Permission::ACTION_BACKUP_DELETE, $server)) {
2021-01-31 03:12:22 +00:00
throw new AuthorizationException();
}
$this->deleteBackupService->handle($backup);
2021-01-17 23:25:49 +00:00
Activity::event('server:backup.delete')
->subject($backup)
->property(['name' => $backup->name, 'failed' => !$backup->is_successful])
->log();
return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
}
/**
* Download the backup for a given server instance. For daemon local files, the file
* will be streamed back through the Panel. For AWS S3 files, a signed URL will be generated
* which the user is redirected to.
2021-01-31 03:12:22 +00:00
*
* @throws \Throwable
2021-01-31 03:12:22 +00:00
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
2021-01-26 03:25:15 +00:00
public function download(Request $request, Server $server, Backup $backup): JsonResponse
{
2021-01-26 03:20:51 +00:00
if (!$request->user()->can(Permission::ACTION_BACKUP_DOWNLOAD, $server)) {
2021-01-31 03:12:22 +00:00
throw new AuthorizationException();
}
if ($backup->disk !== Backup::ADAPTER_AWS_S3 && $backup->disk !== Backup::ADAPTER_WINGS) {
throw new BadRequestHttpException('The backup requested references an unknown disk driver type and cannot be downloaded.');
}
$url = $this->downloadLinkService->handle($backup, $request->user());
Activity::event('server:backup.download')->subject($backup)->property('name', $backup->name)->log();
return new JsonResponse([
'object' => 'signed_url',
'attributes' => ['url' => $url],
]);
}
/**
* Handles restoring a backup by making a request to the Wings instance telling it
* to begin the process of finding (or downloading) the backup and unpacking it
* over the server files.
*
* If the "truncate" flag is passed through in this request then all the
* files that currently exist on the server will be deleted before restoring.
* Otherwise, the archive will simply be unpacked over the existing files.
*
* @throws \Throwable
*/
2021-01-26 03:25:15 +00:00
public function restore(Request $request, Server $server, Backup $backup): JsonResponse
{
2021-01-26 03:20:51 +00:00
if (!$request->user()->can(Permission::ACTION_BACKUP_RESTORE, $server)) {
2021-01-31 03:12:22 +00:00
throw new AuthorizationException();
}
// Cannot restore a backup unless a server is fully installed and not currently
// processing a different backup restoration request.
2021-01-26 03:20:51 +00:00
if (!is_null($server->status)) {
throw new BadRequestHttpException('This server is not currently in a state that allows for a backup to be restored.');
}
if (!$backup->is_successful && is_null($backup->completed_at)) {
throw new BadRequestHttpException('This backup cannot be restored at this time: not completed or failed.');
}
$log = Activity::event('server:backup.restore')
->subject($backup)
->property(['name' => $backup->name, 'truncate' => $request->input('truncate')]);
$log->transaction(function () use ($backup, $server, $request) {
// If the backup is for an S3 file we need to generate a unique Download link for
// it that will allow Wings to actually access the file.
if ($backup->disk === Backup::ADAPTER_AWS_S3) {
$url = $this->downloadLinkService->handle($backup, $request->user());
}
// Update the status right away for the server so that we know not to allow certain
// actions against it via the Panel API.
$server->update(['status' => Server::STATUS_RESTORING_BACKUP]);
$this->daemonRepository->setServer($server)->restore($backup, $url ?? null, $request->input('truncate'));
});
return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
}
}