Merge pull request #2792 from pterodactyl/matthewpi/backups-patch-1

Handle CompleteMultipartUpload and AbortMultipartUpload on the Panel
This commit is contained in:
Dane Everitt 2020-12-06 15:26:44 -08:00 committed by GitHub
commit 4a3c9040a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 51 additions and 10 deletions

View file

@ -9,6 +9,7 @@ use Illuminate\Support\Str;
use Webmozart\Assert\Assert;
use InvalidArgumentException;
use League\Flysystem\AdapterInterface;
use Illuminate\Foundation\Application;
use League\Flysystem\AwsS3v3\AwsS3Adapter;
use League\Flysystem\Memory\MemoryAdapter;
use Illuminate\Contracts\Config\Repository;
@ -44,7 +45,7 @@ class BackupManager
*
* @param \Illuminate\Foundation\Application $app
*/
public function __construct($app)
public function __construct(Application $app)
{
$this->app = $app;
$this->config = $app->make(Repository::class);

View file

@ -69,7 +69,7 @@ class BackupRemoteUploadController extends Controller
// Ensure we are using the S3 adapter.
$adapter = $this->backupManager->adapter();
if (! $adapter instanceof AwsS3Adapter) {
throw new BadRequestHttpException('The configured backup adapter is not an S3 compatiable adapter.');
throw new BadRequestHttpException('The configured backup adapter is not an S3 compatible adapter.');
}
// The path where backup will be uploaded to
@ -77,7 +77,7 @@ class BackupRemoteUploadController extends Controller
// Get the S3 client
$client = $adapter->getClient();
$expires = CarbonImmutable::now()->addMinutes(30);
$expires = CarbonImmutable::now()->addMinutes(config('backups.presigned_url_lifespan', 60));
// Params for generating the presigned urls
$params = [
@ -102,14 +102,9 @@ class BackupRemoteUploadController extends Controller
}
return new JsonResponse([
'upload_id' => $params['UploadId'],
'parts' => $parts,
'part_size' => self::PART_SIZE,
'complete_multipart_upload' => $client->createPresignedRequest(
$client->getCommand('CompleteMultipartUpload', $params), $expires
)->getUri()->__toString(),
'abort_multipart_upload' => $client->createPresignedRequest(
$client->getCommand('AbortMultipartUpload', $params), $expires->addMinutes(15)
)->getUri()->__toString(),
]);
}
}

View file

@ -3,8 +3,11 @@
namespace Pterodactyl\Http\Controllers\Api\Remote\Backups;
use Carbon\CarbonImmutable;
use Pterodactyl\Models\Backup;
use Illuminate\Http\JsonResponse;
use League\Flysystem\AwsS3v3\AwsS3Adapter;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Extensions\Backups\BackupManager;
use Pterodactyl\Repositories\Eloquent\BackupRepository;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Pterodactyl\Http\Requests\Api\Remote\ReportBackupCompleteRequest;
@ -16,14 +19,21 @@ class BackupStatusController extends Controller
*/
private $repository;
/**
* @var \Pterodactyl\Extensions\Backups\BackupManager
*/
private $backupManager;
/**
* BackupStatusController constructor.
*
* @param \Pterodactyl\Repositories\Eloquent\BackupRepository $repository
* @param \Pterodactyl\Extensions\Backups\BackupManager $backupManager
*/
public function __construct(BackupRepository $repository)
public function __construct(BackupRepository $repository, BackupManager $backupManager)
{
$this->repository = $repository;
$this->backupManager = $backupManager;
}
/**
@ -31,9 +41,11 @@ class BackupStatusController extends Controller
*
* @param \Pterodactyl\Http\Requests\Api\Remote\ReportBackupCompleteRequest $request
* @param string $backup
*
* @return \Illuminate\Http\JsonResponse
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
* @throws \Exception
*/
public function __invoke(ReportBackupCompleteRequest $request, string $backup)
{
@ -47,6 +59,7 @@ class BackupStatusController extends Controller
}
$successful = $request->input('successful') ? true : false;
$model->forceFill([
'is_successful' => $successful,
'checksum' => $successful ? ($request->input('checksum_type') . ':' . $request->input('checksum')) : null,
@ -54,6 +67,32 @@ class BackupStatusController extends Controller
'completed_at' => CarbonImmutable::now(),
])->save();
// Check if we are using the s3 backup adapter.
$adapter = $this->backupManager->adapter();
if ($adapter instanceof AwsS3Adapter) {
/** @var \Pterodactyl\Models\Backup $backup */
$backup = Backup::query()->where('uuid', $backup)->firstOrFail();
$client = $adapter->getClient();
$params = [
'Bucket' => $adapter->getBucket(),
'Key' => sprintf('%s/%s.tar.gz', $backup->server->uuid, $backup->uuid),
'UploadId' => $request->input('upload_id'),
];
// If the backup was not successful, send an AbortMultipartUpload request.
if (! $successful) {
$client->execute($client->getCommand('AbortMultipartUpload', $params));
} else {
// Otherwise send a CompleteMultipartUpload request.
$params['MultipartUpload'] = [
'Parts' => $client->execute($client->getCommand('ListParts', $params))['Parts'],
];
$client->execute($client->getCommand('CompleteMultipartUpload', $params));
}
}
return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
}
}

View file

@ -99,6 +99,8 @@ class InitiateBackupService
*
* @param \Pterodactyl\Models\Server $server
* @param string|null $name
* @param bool $override
*
* @return \Pterodactyl\Models\Backup
*
* @throws \Throwable

View file

@ -8,6 +8,10 @@ return [
// have been made, without losing data.
'default' => env('APP_BACKUP_DRIVER', Backup::ADAPTER_WINGS),
// This value is used to determine the lifespan of UploadPart presigned urls that wings
// uses to upload backups to S3 storage. Value is in minutes, so this would default to an hour.
'presigned_url_lifespan' => env('BACKUP_PRESIGNED_URL_LIFESPAN', 60),
'disks' => [
// There is no configuration for the local disk for Wings. That configuration
// is determined by the Daemon configuration, and not the Panel.