Close cleanup; only try to run power actions against non-suspended & installed servers; closes #2760

This commit is contained in:
Dane Everitt 2020-11-29 12:50:22 -08:00
parent 26d409c29c
commit 16f49f8dc1
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
5 changed files with 40 additions and 107 deletions

View file

@ -3,6 +3,10 @@ This file is a running track of new features and fixes to each version of the pa
This project follows [Semantic Versioning](http://semver.org) guidelines. This project follows [Semantic Versioning](http://semver.org) guidelines.
## v1.1.3
### Fixed
* Server bulk power actions command will no longer attempt to run commands against installing or suspended servers.
## v1.1.2 ## v1.1.2
### Fixed ### Fixed
* Fixes an exception thrown while trying to validate IP access for the client API. * Fixes an exception thrown while trying to validate IP access for the client API.

View file

@ -2,30 +2,15 @@
namespace Pterodactyl\Console\Commands\Server; namespace Pterodactyl\Console\Commands\Server;
use Pterodactyl\Models\Server;
use Illuminate\Console\Command; use Illuminate\Console\Command;
use GuzzleHttp\Exception\RequestException;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
use Illuminate\Validation\Factory as ValidatorFactory; use Illuminate\Validation\Factory as ValidatorFactory;
use Pterodactyl\Repositories\Wings\DaemonPowerRepository; use Pterodactyl\Repositories\Wings\DaemonPowerRepository;
use Pterodactyl\Contracts\Repository\ServerRepositoryInterface; use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
class BulkPowerActionCommand extends Command class BulkPowerActionCommand extends Command
{ {
/**
* @var \Pterodactyl\Repositories\Wings\DaemonPowerRepository
*/
private $powerRepository;
/**
* @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
*/
private $repository;
/**
* @var \Illuminate\Validation\Factory
*/
private $validator;
/** /**
* @var string * @var string
*/ */
@ -39,37 +24,20 @@ class BulkPowerActionCommand extends Command
*/ */
protected $description = 'Perform bulk power management on large groupings of servers or nodes at once.'; protected $description = 'Perform bulk power management on large groupings of servers or nodes at once.';
/**
* BulkPowerActionCommand constructor.
*
* @param \Pterodactyl\Repositories\Wings\DaemonPowerRepository $powerRepository
* @param \Pterodactyl\Contracts\Repository\ServerRepositoryInterface $repository
* @param \Illuminate\Validation\Factory $validator
*/
public function __construct(
DaemonPowerRepository $powerRepository,
ServerRepositoryInterface $repository,
ValidatorFactory $validator
) {
parent::__construct();
$this->repository = $repository;
$this->validator = $validator;
$this->powerRepository = $powerRepository;
}
/** /**
* Handle the bulk power request. * Handle the bulk power request.
* *
* @param \Pterodactyl\Repositories\Wings\DaemonPowerRepository $powerRepository
* @param \Illuminate\Validation\Factory $validator
* @throws \Illuminate\Validation\ValidationException * @throws \Illuminate\Validation\ValidationException
*/ */
public function handle() public function handle(DaemonPowerRepository $powerRepository, ValidatorFactory $validator)
{ {
$action = $this->argument('action'); $action = $this->argument('action');
$nodes = empty($this->option('nodes')) ? [] : explode(',', $this->option('nodes')); $nodes = empty($this->option('nodes')) ? [] : explode(',', $this->option('nodes'));
$servers = empty($this->option('servers')) ? [] : explode(',', $this->option('servers')); $servers = empty($this->option('servers')) ? [] : explode(',', $this->option('servers'));
$validator = $this->validator->make([ $validator = $validator->make([
'action' => $action, 'action' => $action,
'nodes' => $nodes, 'nodes' => $nodes,
'servers' => $servers, 'servers' => $servers,
@ -89,23 +57,18 @@ class BulkPowerActionCommand extends Command
throw new ValidationException($validator); throw new ValidationException($validator);
} }
$count = $this->repository->getServersForPowerActionCount($servers, $nodes); $count = $this->getQueryBuilder($servers, $nodes)->count();
if (! $this->confirm(trans('command/messages.server.power.confirm', ['action' => $action, 'count' => $count])) && $this->input->isInteractive()) { if (! $this->confirm(trans('command/messages.server.power.confirm', ['action' => $action, 'count' => $count])) && $this->input->isInteractive()) {
return; return;
} }
$bar = $this->output->createProgressBar($count); $bar = $this->output->createProgressBar($count);
$servers = $this->repository->getServersForPowerAction($servers, $nodes); $this->getQueryBuilder($servers, $nodes)->each(function (Server $server) use ($action, $powerRepository, &$bar) {
$servers->each(function ($server) use ($action, &$bar) {
$bar->clear(); $bar->clear();
try { try {
$this->powerRepository $powerRepository->setServer($server)->send($action);
->setNode($server->node) } catch (DaemonConnectionException $exception) {
->setServer($server)
->send($action);
} catch (RequestException $exception) {
$this->output->error(trans('command/messages.server.power.action_failed', [ $this->output->error(trans('command/messages.server.power.action_failed', [
'name' => $server->name, 'name' => $server->name,
'id' => $server->id, 'id' => $server->id,
@ -120,4 +83,28 @@ class BulkPowerActionCommand extends Command
$this->line(''); $this->line('');
} }
/**
* Returns the query builder instance that will return the servers that should be affected.
*
* @param array $servers
* @param array $nodes
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function getQueryBuilder(array $servers, array $nodes)
{
$instance = Server::query()
->where('suspended', false)
->where('installed', Server::STATUS_INSTALLED);
if (! empty($nodes) && ! empty($servers)) {
$instance->whereIn('id', $servers)->orWhereIn('node_id', $nodes);
} else if (empty($nodes) && ! empty($servers)) {
$instance->whereIn('id', $servers);
} else if (! empty($nodes) && empty($servers)) {
$instance->whereIn('node_id', $nodes);
}
return $instance->with('node');
}
} }

View file

@ -95,25 +95,6 @@ interface ServerRepositoryInterface extends RepositoryInterface
*/ */
public function getByUuid(string $uuid): Server; public function getByUuid(string $uuid): Server;
/**
* Return all of the servers that should have a power action performed against them.
*
* @param int[] $servers
* @param int[] $nodes
* @param bool $returnCount
* @return int|\Illuminate\Support\LazyCollection
*/
public function getServersForPowerAction(array $servers = [], array $nodes = [], bool $returnCount = false);
/**
* Return the total number of servers that will be affected by the query.
*
* @param int[] $servers
* @param int[] $nodes
* @return int
*/
public function getServersForPowerActionCount(array $servers = [], array $nodes = []): int;
/** /**
* Check if a given UUID and UUID-Short string are unique to a server. * Check if a given UUID and UUID-Short string are unique to a server.
* *

View file

@ -194,45 +194,6 @@ class ServerRepository extends EloquentRepository implements ServerRepositoryInt
} }
} }
/**
* Return all of the servers that should have a power action performed against them.
*
* @param int[] $servers
* @param int[] $nodes
* @param bool $returnCount
* @return int|\Illuminate\Support\LazyCollection
*/
public function getServersForPowerAction(array $servers = [], array $nodes = [], bool $returnCount = false)
{
$instance = $this->getBuilder();
if (! empty($nodes) && ! empty($servers)) {
$instance->whereIn('id', $servers)->orWhereIn('node_id', $nodes);
} else if (empty($nodes) && ! empty($servers)) {
$instance->whereIn('id', $servers);
} else if (! empty($nodes) && empty($servers)) {
$instance->whereIn('node_id', $nodes);
}
if ($returnCount) {
return $instance->count();
}
return $instance->with('node')->cursor();
}
/**
* Return the total number of servers that will be affected by the query.
*
* @param int[] $servers
* @param int[] $nodes
* @return int
*/
public function getServersForPowerActionCount(array $servers = [], array $nodes = []): int
{
return $this->getServersForPowerAction($servers, $nodes, true);
}
/** /**
* Check if a given UUID and UUID-Short string are unique to a server. * Check if a given UUID and UUID-Short string are unique to a server.
* *

View file

@ -53,7 +53,7 @@ class BulkPowerActionCommandTest extends CommandTestCase
$this->repository->expects('getServersForPowerAction')->with([], [])->andReturn($servers); $this->repository->expects('getServersForPowerAction')->with([], [])->andReturn($servers);
for ($i = 0; $i < count($servers); $i++) { for ($i = 0; $i < count($servers); $i++) {
$this->powerRepository->expects('setNode->setServer->send')->with('kill')->andReturnNull(); $this->powerRepository->expects('setServer->send')->with('kill')->andReturnNull();
} }
$display = $this->runCommand($this->getCommand(), ['action' => 'kill'], ['yes']); $display = $this->runCommand($this->getCommand(), ['action' => 'kill'], ['yes']);
@ -107,7 +107,7 @@ class BulkPowerActionCommandTest extends CommandTestCase
->andReturn(1); ->andReturn(1);
$this->repository->expects('getServersForPowerAction')->with([], [])->andReturn(Collection::make([$server])); $this->repository->expects('getServersForPowerAction')->with([], [])->andReturn(Collection::make([$server]));
$this->powerRepository->expects('setNode->setServer->send')->with('kill')->andReturnNull(); $this->powerRepository->expects('setServer->send')->with('kill')->andReturnNull();
$display = $this->runCommand($this->getCommand(), [ $display = $this->runCommand($this->getCommand(), [
'action' => 'kill', 'action' => 'kill',