118 lines
3.4 KiB
PHP
118 lines
3.4 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Transformers\Api\Application;
|
|
|
|
use Carbon\CarbonImmutable;
|
|
use Illuminate\Http\Request;
|
|
use Webmozart\Assert\Assert;
|
|
use Pterodactyl\Models\ApiKey;
|
|
use Illuminate\Container\Container;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use League\Fractal\TransformerAbstract;
|
|
use Pterodactyl\Services\Acl\Api\AdminAcl;
|
|
|
|
/**
|
|
* @method array transform(Model $model)
|
|
*/
|
|
abstract class BaseTransformer extends TransformerAbstract
|
|
{
|
|
public const RESPONSE_TIMEZONE = 'UTC';
|
|
|
|
protected Request $request;
|
|
|
|
/**
|
|
* BaseTransformer constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
// Transformers allow for dependency injection on the handle method.
|
|
if (method_exists($this, 'handle')) {
|
|
Container::getInstance()->call([$this, 'handle']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the resource name for the JSONAPI output.
|
|
*/
|
|
abstract public function getResourceName(): string;
|
|
|
|
/**
|
|
* Sets the request on the instance.
|
|
*
|
|
* @return static
|
|
*/
|
|
public function setRequest(Request $request): self
|
|
{
|
|
$this->request = $request;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns a new transformer instance with the request set on the instance.
|
|
*
|
|
* @return \Pterodactyl\Transformers\Api\Application\BaseTransformer
|
|
*/
|
|
public static function fromRequest(Request $request)
|
|
{
|
|
return app(static::class)->setRequest($request);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @deprecated — prefer $user->can/cannot methods
|
|
*/
|
|
protected function authorize(string $resource): bool
|
|
{
|
|
$allowed = [ApiKey::TYPE_ACCOUNT, ApiKey::TYPE_APPLICATION];
|
|
|
|
$token = $this->request->user()->currentAccessToken();
|
|
if (!$token instanceof ApiKey || !in_array($token->key_type, $allowed)) {
|
|
return false;
|
|
}
|
|
|
|
// If this is not a deprecated application token type we can only check that
|
|
// the user is a root admin at the moment. In a future release we'll be rolling
|
|
// out more specific permissions for keys.
|
|
if ($token->key_type === ApiKey::TYPE_ACCOUNT) {
|
|
return $this->request->user()->root_admin;
|
|
}
|
|
|
|
return AdminAcl::check($token, $resource, AdminAcl::READ);
|
|
}
|
|
|
|
/**
|
|
* Create a new instance of the transformer and pass along the currently
|
|
* set API key.
|
|
*
|
|
* @template T of \Pterodactyl\Transformers\Api\Application\BaseTransformer
|
|
*
|
|
* @param class-string<T> $abstract
|
|
*
|
|
* @return T
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
|
*
|
|
* @noinspection PhpUndefinedClassInspection
|
|
* @noinspection PhpDocSignatureInspection
|
|
*/
|
|
protected function makeTransformer(string $abstract)
|
|
{
|
|
Assert::subclassOf($abstract, self::class);
|
|
|
|
return $abstract::fromRequest($this->request);
|
|
}
|
|
|
|
/**
|
|
* Return an ISO-8601 formatted timestamp to use in the API response.
|
|
*/
|
|
protected function formatTimestamp(string $timestamp): string
|
|
{
|
|
return CarbonImmutable::createFromFormat(CarbonImmutable::DEFAULT_TO_STRING_FORMAT, $timestamp)
|
|
->setTimezone(self::RESPONSE_TIMEZONE)
|
|
->toIso8601String();
|
|
}
|
|
}
|