Skynet/misc_pterodactyl-panel
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'develop' into matthewpi/security-keys-backport

Browse source
This commit is contained in:
Matthew Penner 2023-01-17 15:33:53 -07:00
commit f631ac1946
No known key found for this signature in database
1153 changed files with 25099 additions and 37002 deletions
Download patch file Download diff file Expand all files Collapse all files

5
app/Transformers/Api/Client/AccountTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\User;
use Pterodactyl\Transformers\Api\Transformer;
class AccountTransformer extends BaseClientTransformer
class AccountTransformer extends Transformer
{
/**
* Return the resource name for the JSONAPI output.
@ -24,8 +25,6 @@ class AccountTransformer extends BaseClientTransformer
'admin' => $model->root_admin,
'username' => $model->username,
'email' => $model->email,
'first_name' => $model->name_first,
'last_name' => $model->name_last,
'language' => $model->language,
];
}

15
app/Transformers/Api/Client/ActivityLogTransformer.php
View file

@ -4,10 +4,13 @@ namespace Pterodactyl\Transformers\Api\Client;
use Illuminate\Support\Str;
use Pterodactyl\Models\User;
use League\Fractal\Resource\Item;
use Pterodactyl\Models\ActivityLog;
use Illuminate\Database\Eloquent\Model;
use League\Fractal\Resource\NullResource;
use Pterodactyl\Transformers\Api\Transformer;
class ActivityLogTransformer extends BaseClientTransformer
class ActivityLogTransformer extends Transformer
{
protected array $availableIncludes = ['actor'];
@ -34,23 +37,23 @@ class ActivityLogTransformer extends BaseClientTransformer
];
}
public function includeActor(ActivityLog $model)
public function includeActor(ActivityLog $model): Item|NullResource
{
if (!$model->actor instanceof User) {
return $this->null();
}
return $this->item($model->actor, $this->makeTransformer(UserTransformer::class), User::RESOURCE_NAME);
return $this->item($model->actor, new UserTransformer());
}
/**
* Transforms any array values in the properties into a countable field for easier
* use within the translation outputs.
*/
protected function properties(ActivityLog $model): array
protected function properties(ActivityLog $model): object
{
if (!$model->properties || $model->properties->isEmpty()) {
return [];
return (object) [];
}
$properties = $model->properties
@ -76,7 +79,7 @@ class ActivityLogTransformer extends BaseClientTransformer
$properties = $properties->merge(['count' => $properties->get($keys[0])])->except($keys[0]);
}
return $properties->toArray();
return (object) $properties->toArray();
}
/**

3
app/Transformers/Api/Client/AllocationTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Allocation;
use Pterodactyl\Transformers\Api\Transformer;
class AllocationTransformer extends BaseClientTransformer
class AllocationTransformer extends Transformer
{
/**
* Return the resource name for the JSONAPI output.

3
app/Transformers/Api/Client/ApiKeyTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\ApiKey;
use Pterodactyl\Transformers\Api\Transformer;
class ApiKeyTransformer extends BaseClientTransformer
class ApiKeyTransformer extends Transformer
{
/**
* {@inheritdoc}

23
app/Transformers/Api/Client/BackupTransformer.php
View file

@ -3,26 +3,27 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Backup;
use Pterodactyl\Transformers\Api\Transformer;
class BackupTransformer extends BaseClientTransformer
class BackupTransformer extends Transformer
{
public function getResourceName(): string
{
return Backup::RESOURCE_NAME;
}
public function transform(Backup $backup): array
public function transform(Backup $model): array
{
return [
'uuid' => $backup->uuid,
'is_successful' => $backup->is_successful,
'is_locked' => $backup->is_locked,
'name' => $backup->name,
'ignored_files' => $backup->ignored_files,
'checksum' => $backup->checksum,
'bytes' => $backup->bytes,
'created_at' => $backup->created_at->toAtomString(),
'completed_at' => $backup->completed_at ? $backup->completed_at->toAtomString() : null,
'uuid' => $model->uuid,
'is_successful' => $model->is_successful,
'is_locked' => $model->is_locked,
'name' => $model->name,
'ignored_files' => $model->ignored_files,
'checksum' => $model->checksum,
'bytes' => $model->bytes,
'created_at' => self::formatTimestamp($model->created_at),
'completed_at' => self::formatTimestamp($model->completed_at),
];
}
}

43
app/Transformers/Api/Client/BaseClientTransformer.php
View file

@ -1,43 +0,0 @@
<?php
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\User;
use Webmozart\Assert\Assert;
use Pterodactyl\Models\Server;
use Pterodactyl\Transformers\Api\Application\BaseTransformer as BaseApplicationTransformer;
abstract class BaseClientTransformer extends BaseApplicationTransformer
{
/**
* Return the user model of the user requesting this transformation.
*/
public function getUser(): User
{
return $this->request->user();
}
/**
* Determine if the API key loaded onto the transformer has permission
* to access a different resource. This is used when including other
* models on a transformation request.
*
* @noinspection PhpParameterNameChangedDuringInheritanceInspection
*/
protected function authorize(string $ability, Server $server = null): bool
{
Assert::isInstanceOf($server, Server::class);
return $this->request->user()->can($ability, [$server]);
}
/**
* {@inheritDoc}
*/
protected function makeTransformer(string $abstract)
{
Assert::subclassOf($abstract, self::class);
return parent::makeTransformer($abstract);
}
}

10
app/Transformers/Api/Client/DatabaseTransformer.php
View file

@ -6,15 +6,15 @@ use Pterodactyl\Models\Database;
use League\Fractal\Resource\Item;
use Pterodactyl\Models\Permission;
use League\Fractal\Resource\NullResource;
use Pterodactyl\Transformers\Api\Transformer;
use Illuminate\Contracts\Encryption\Encrypter;
use Pterodactyl\Contracts\Extensions\HashidsInterface;
class DatabaseTransformer extends BaseClientTransformer
class DatabaseTransformer extends Transformer
{
protected array $availableIncludes = ['password'];
private Encrypter $encrypter;
private HashidsInterface $hashids;
/**
@ -38,8 +38,8 @@ class DatabaseTransformer extends BaseClientTransformer
return [
'id' => $this->hashids->encode($model->id),
'host' => [
'address' => $model->getRelation('host')->host,
'port' => $model->getRelation('host')->port,
'address' => $model->host->host,
'port' => $model->host->port,
],
'name' => $model->database,
'username' => $model->username,
@ -53,7 +53,7 @@ class DatabaseTransformer extends BaseClientTransformer
*/
public function includePassword(Database $database): Item|NullResource
{
if (!$this->request->user()->can(Permission::ACTION_DATABASE_VIEW_PASSWORD, $database->server)) {
if ($this->user()->cannot(Permission::ACTION_DATABASE_VIEW_PASSWORD, $database->server)) {
return $this->null();
}

9
app/Transformers/Api/Client/EggTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Egg;
use Pterodactyl\Transformers\Api\Transformer;
class EggTransformer extends BaseClientTransformer
class EggTransformer extends Transformer
{
/**
* Return the resource name for the JSONAPI output.
@ -14,11 +15,11 @@ class EggTransformer extends BaseClientTransformer
return Egg::RESOURCE_NAME;
}
public function transform(Egg $egg): array
public function transform(Egg $model): array
{
return [
'uuid' => $egg->uuid,
'name' => $egg->name,
'uuid' => $model->uuid,
'name' => $model->name,
];
}
}

24
app/Transformers/Api/Client/EggVariableTransformer.php
View file

@ -2,33 +2,33 @@
namespace Pterodactyl\Transformers\Api\Client;
use BadMethodCallException;
use Pterodactyl\Models\EggVariable;
use Pterodactyl\Transformers\Api\Transformer;
class EggVariableTransformer extends BaseClientTransformer
class EggVariableTransformer extends Transformer
{
public function getResourceName(): string
{
return EggVariable::RESOURCE_NAME;
}
public function transform(EggVariable $variable): array
public function transform(EggVariable $model): array
{
// This guards against someone incorrectly retrieving variables (haha, me) and then passing
// them into the transformer and along to the user. Just throw an exception and break the entire
// pathway since you should never be exposing these types of variables to a client.
if (!$variable->user_viewable) {
throw new BadMethodCallException('Cannot transform a hidden egg variable in a client transformer.');
if (!$model->user_viewable) {
throw new \BadMethodCallException('Cannot transform a hidden egg variable in a client transformer.');
}
return [
'name' => $variable->name,
'description' => $variable->description,
'env_variable' => $variable->env_variable,
'default_value' => $variable->default_value,
'server_value' => $variable->server_value,
'is_editable' => $variable->user_editable,
'rules' => $variable->rules,
'name' => $model->name,
'description' => $model->description,
'env_variable' => $model->env_variable,
'default_value' => $model->default_value,
'server_value' => $model->server_value,
'is_editable' => $model->user_editable,
'rules' => $model->rules,
];
}
}

39
app/Transformers/Api/Client/FileObjectTransformer.php
View file

@ -4,29 +4,30 @@ namespace Pterodactyl\Transformers\Api\Client;
use Carbon\Carbon;
use Illuminate\Support\Arr;
use Pterodactyl\Transformers\Api\Transformer;
class FileObjectTransformer extends BaseClientTransformer
class FileObjectTransformer extends Transformer
{
/**
* Transform a file object response from the daemon into a standardized response.
*/
public function transform(array $item): array
{
return [
'name' => Arr::get($item, 'name'),
'mode' => Arr::get($item, 'mode'),
'mode_bits' => Arr::get($item, 'mode_bits'),
'size' => Arr::get($item, 'size'),
'is_file' => Arr::get($item, 'file', true),
'is_symlink' => Arr::get($item, 'symlink', false),
'mimetype' => Arr::get($item, 'mime', 'application/octet-stream'),
'created_at' => Carbon::parse(Arr::get($item, 'created', ''))->toAtomString(),
'modified_at' => Carbon::parse(Arr::get($item, 'modified', ''))->toAtomString(),
];
}
public function getResourceName(): string
{
return 'file_object';
}
/**
* Transform a file object response from the daemon into a standardized response.
*/
public function transform(array $model): array
{
return [
'name' => Arr::get($model, 'name'),
'mode' => Arr::get($model, 'mode'),
'mode_bits' => Arr::get($model, 'mode_bits'),
'size' => Arr::get($model, 'size'),
'is_file' => Arr::get($model, 'file', true),
'is_symlink' => Arr::get($model, 'symlink', false),
'mimetype' => Arr::get($model, 'mime', 'application/octet-stream'),
'created_at' => Carbon::parse(Arr::get($model, 'created', ''))->toAtomString(),
'modified_at' => Carbon::parse(Arr::get($model, 'modified', ''))->toAtomString(),
];
}
}

20
app/Transformers/Api/Client/ScheduleTransformer.php
View file

@ -2,11 +2,11 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Task;
use Pterodactyl\Models\Schedule;
use League\Fractal\Resource\Collection;
use Pterodactyl\Transformers\Api\Transformer;
class ScheduleTransformer extends BaseClientTransformer
class ScheduleTransformer extends Transformer
{
protected array $availableIncludes = ['tasks'];
@ -38,24 +38,18 @@ class ScheduleTransformer extends BaseClientTransformer
'is_active' => $model->is_active,
'is_processing' => $model->is_processing,
'only_when_online' => $model->only_when_online,
'last_run_at' => $model->last_run_at?->toAtomString(),
'next_run_at' => $model->next_run_at?->toAtomString(),
'created_at' => $model->created_at->toAtomString(),
'updated_at' => $model->updated_at->toAtomString(),
'last_run_at' => self::formatTimestamp($model->last_run_at),
'next_run_at' => self::formatTimestamp($model->next_run_at),
'created_at' => self::formatTimestamp($model->created_at),
'updated_at' => self::formatTimestamp($model->updated_at),
];
}
/**
* Allows attaching the tasks specific to the schedule in the response.
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeTasks(Schedule $model): Collection
{
return $this->collection(
$model->tasks,
$this->makeTransformer(TaskTransformer::class),
Task::RESOURCE_NAME
);
return $this->collection($model->tasks, new TaskTransformer());
}
}

39
app/Transformers/Api/Client/ServerTransformer.php
View file

@ -4,17 +4,16 @@ namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Egg;
use Pterodactyl\Models\Server;
use Pterodactyl\Models\Subuser;
use League\Fractal\Resource\Item;
use Pterodactyl\Models\Allocation;
use Pterodactyl\Models\Permission;
use Illuminate\Container\Container;
use Pterodactyl\Models\EggVariable;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\NullResource;
use Pterodactyl\Transformers\Api\Transformer;
use Pterodactyl\Services\Servers\StartupCommandService;
class ServerTransformer extends BaseClientTransformer
class ServerTransformer extends Transformer
{
protected array $defaultIncludes = ['allocations', 'variables'];
@ -43,9 +42,10 @@ class ServerTransformer extends BaseClientTransformer
'uuid' => $server->uuid,
'name' => $server->name,
'node' => $server->node->name,
'is_node_under_maintenance' => $server->node->isUnderMaintenance(),
'sftp_details' => [
'ip' => $server->node->fqdn,
'port' => $server->node->daemonSFTP,
'port' => $server->node->public_port_sftp,
],
'description' => $server->description,
'limits' => [
@ -55,7 +55,7 @@ class ServerTransformer extends BaseClientTransformer
'io' => $server->io,
'cpu' => $server->cpu,
'threads' => $server->threads,
'oom_disabled' => $server->oom_disabled,
'oom_killer' => $server->oom_killer,
],
'invocation' => $service->handle($server, !$user->can(Permission::ACTION_STARTUP_READ, $server)),
'docker_image' => $server->image,
@ -66,22 +66,16 @@ class ServerTransformer extends BaseClientTransformer
'backups' => $server->backup_limit,
],
'status' => $server->status,
// This field is deprecated, please use "status".
'is_suspended' => $server->isSuspended(),
// This field is deprecated, please use "status".
'is_installing' => !$server->isInstalled(),
'is_transferring' => !is_null($server->transfer),
];
}
/**
* Returns the allocations associated with this server.
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeAllocations(Server $server): Collection
{
$transformer = $this->makeTransformer(AllocationTransformer::class);
$transformer = new AllocationTransformer();
$user = $this->request->user();
// While we include this permission, we do need to actually handle it slightly different here
@ -95,42 +89,31 @@ class ServerTransformer extends BaseClientTransformer
$primary = clone $server->allocation;
$primary->notes = null;
return $this->collection([$primary], $transformer, Allocation::RESOURCE_NAME);
return $this->collection([$primary], $transformer);
}
return $this->collection($server->allocations, $transformer, Allocation::RESOURCE_NAME);
return $this->collection($server->allocations, $transformer);
}
/**
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeVariables(Server $server): Collection|NullResource
{
if (!$this->request->user()->can(Permission::ACTION_STARTUP_READ, $server)) {
return $this->null();
}
return $this->collection(
$server->variables->where('user_viewable', true),
$this->makeTransformer(EggVariableTransformer::class),
EggVariable::RESOURCE_NAME
);
return $this->collection($server->variables->where('user_viewable', true), new EggVariableTransformer());
}
/**
* Returns the egg associated with this server.
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeEgg(Server $server): Item
{
return $this->item($server->egg, $this->makeTransformer(EggTransformer::class), Egg::RESOURCE_NAME);
return $this->item($server->egg, new EggTransformer());
}
/**
* Returns the subusers associated with this server.
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeSubusers(Server $server): Collection|NullResource
{
@ -138,6 +121,6 @@ class ServerTransformer extends BaseClientTransformer
return $this->null();
}
return $this->collection($server->subusers, $this->makeTransformer(SubuserTransformer::class), Subuser::RESOURCE_NAME);
return $this->collection($server->subusers, new SubuserTransformer());
}
}

21
app/Transformers/Api/Client/StatsTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Illuminate\Support\Arr;
use Pterodactyl\Transformers\Api\Transformer;
class StatsTransformer extends BaseClientTransformer
class StatsTransformer extends Transformer
{
public function getResourceName(): string
{
@ -15,18 +16,18 @@ class StatsTransformer extends BaseClientTransformer
* Transform stats from the daemon into a result set that can be used in
* the client API.
*/
public function transform(array $data): array
public function transform(array $model): array
{
return [
'current_state' => Arr::get($data, 'state', 'stopped'),
'is_suspended' => Arr::get($data, 'is_suspended', false),
'current_state' => Arr::get($model, 'state', 'stopped'),
'is_suspended' => Arr::get($model, 'is_suspended', false),
'resources' => [
'memory_bytes' => Arr::get($data, 'utilization.memory_bytes', 0),
'cpu_absolute' => Arr::get($data, 'utilization.cpu_absolute', 0),
'disk_bytes' => Arr::get($data, 'utilization.disk_bytes', 0),
'network_rx_bytes' => Arr::get($data, 'utilization.network.rx_bytes', 0),
'network_tx_bytes' => Arr::get($data, 'utilization.network.tx_bytes', 0),
'uptime' => Arr::get($data, 'utilization.uptime', 0),
'memory_bytes' => Arr::get($model, 'utilization.memory_bytes', 0),
'cpu_absolute' => Arr::get($model, 'utilization.cpu_absolute', 0),
'disk_bytes' => Arr::get($model, 'utilization.disk_bytes', 0),
'network_rx_bytes' => Arr::get($model, 'utilization.network.rx_bytes', 0),
'network_tx_bytes' => Arr::get($model, 'utilization.network.tx_bytes', 0),
'uptime' => Arr::get($model, 'utilization.uptime', 0),
],
];
}

7
app/Transformers/Api/Client/SubuserTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Subuser;
use Pterodactyl\Transformers\Api\Transformer;
class SubuserTransformer extends BaseClientTransformer
class SubuserTransformer extends Transformer
{
/**
* Return the resource name for the JSONAPI output.
@ -16,13 +17,11 @@ class SubuserTransformer extends BaseClientTransformer
/**
* Transforms a subuser into a model that can be shown to a front-end user.
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function transform(Subuser $model): array
{
return array_merge(
$this->makeTransformer(UserTransformer::class)->transform($model->user),
(new UserTransformer())->transform($model->user),
['permissions' => $model->permissions]
);
}

7
app/Transformers/Api/Client/TaskTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\Task;
use Pterodactyl\Transformers\Api\Transformer;
class TaskTransformer extends BaseClientTransformer
class TaskTransformer extends Transformer
{
/**
* {@inheritdoc}
@ -27,8 +28,8 @@ class TaskTransformer extends BaseClientTransformer
'time_offset' => $model->time_offset,
'is_queued' => $model->is_queued,
'continue_on_failure' => $model->continue_on_failure,
'created_at' => $model->created_at->toAtomString(),
'updated_at' => $model->updated_at->toAtomString(),
'created_at' => self::formatTimestamp($model->created_at),
'updated_at' => self::formatTimestamp($model->updated_at),
];
}
}

5
app/Transformers/Api/Client/UserSSHKeyTransformer.php
View file

@ -3,8 +3,9 @@
namespace Pterodactyl\Transformers\Api\Client;
use Pterodactyl\Models\UserSSHKey;
use Pterodactyl\Transformers\Api\Transformer;
class UserSSHKeyTransformer extends BaseClientTransformer
class UserSSHKeyTransformer extends Transformer
{
public function getResourceName(): string
{
@ -20,7 +21,7 @@ class UserSSHKeyTransformer extends BaseClientTransformer
'name' => $model->name,
'fingerprint' => $model->fingerprint,
'public_key' => $model->public_key,
'created_at' => $model->created_at->toAtomString(),
'created_at' => self::formatTimestamp($model->created_at),
];
}
}

8
app/Transformers/Api/Client/UserTransformer.php
View file

@ -2,10 +2,10 @@
namespace Pterodactyl\Transformers\Api\Client;
use Illuminate\Support\Str;
use Pterodactyl\Models\User;
use Pterodactyl\Transformers\Api\Transformer;
class UserTransformer extends BaseClientTransformer
class UserTransformer extends Transformer
{
/**
* Return the resource name for the JSONAPI output.
@ -25,9 +25,9 @@ class UserTransformer extends BaseClientTransformer
'uuid' => $model->uuid,
'username' => $model->username,
'email' => $model->email,
'image' => 'https://gravatar.com/avatar/' . md5(Str::lower($model->email)),
'image' => $model->avatar_url,
'2fa_enabled' => $model->use_totp,
'created_at' => $model->created_at->toAtomString(),
'created_at' => self::formatTimestamp($model->created_at),
];
}
}