More work on the API utilizing Laravel 5.5 exception rendering

Also corrects API format to maintain JSONAPI spec
This commit is contained in:
Dane Everitt 2017-12-17 14:57:05 -06:00
parent f30f4b45ba
commit 54b6fb5ebd
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
28 changed files with 464 additions and 391 deletions

View file

@ -11,9 +11,12 @@ namespace Pterodactyl\Exceptions;
use Log; use Log;
use Throwable; use Throwable;
use Prologue\Alerts\AlertsMessageBag;
class DisplayException extends PterodactylException class DisplayException extends PterodactylException
{ {
const LEVEL_DEBUG = 'debug';
const LEVEL_INFO = 'info';
const LEVEL_WARNING = 'warning'; const LEVEL_WARNING = 'warning';
const LEVEL_ERROR = 'error'; const LEVEL_ERROR = 'error';
@ -32,13 +35,13 @@ class DisplayException extends PterodactylException
*/ */
public function __construct($message, Throwable $previous = null, $level = self::LEVEL_ERROR, $code = 0) public function __construct($message, Throwable $previous = null, $level = self::LEVEL_ERROR, $code = 0)
{ {
$this->level = $level; parent::__construct($message, $code, $previous);
if (! is_null($previous)) { if (! is_null($previous)) {
Log::{$level}($previous); Log::{$level}($previous);
} }
parent::__construct($message, $code, $previous); $this->level = $level;
} }
/** /**
@ -48,4 +51,25 @@ class DisplayException extends PterodactylException
{ {
return $this->level; return $this->level;
} }
/**
* Render the exception to the user by adding a flashed message to the session
* and then redirecting them back to the page that they came from. If the
* request originated from an API hit, return the error in JSONAPI spec format.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\JsonResponse|\Illuminate\Http\RedirectResponse
*/
public function render($request)
{
if ($request->expectsJson()) {
return response()->json(Handler::convertToArray($this, [
'detail' => $this->getMessage(),
]), 500);
}
app()->make(AlertsMessageBag::class)->danger($this->getMessage())->flash();
return redirect()->back()->withInput();
}
} }

View file

@ -1,14 +0,0 @@
<?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions;
class DisplayValidationException extends DisplayException
{
}

View file

@ -3,13 +3,11 @@
namespace Pterodactyl\Exceptions; namespace Pterodactyl\Exceptions;
use Exception; use Exception;
use Prologue\Alerts\Facades\Alert;
use Illuminate\Auth\AuthenticationException; use Illuminate\Auth\AuthenticationException;
use Illuminate\Session\TokenMismatchException; use Illuminate\Session\TokenMismatchException;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
use Illuminate\Auth\Access\AuthorizationException; use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\ModelNotFoundException; use Illuminate\Database\Eloquent\ModelNotFoundException;
use Pterodactyl\Exceptions\Model\DataValidationException;
use Symfony\Component\HttpKernel\Exception\HttpException; use Symfony\Component\HttpKernel\Exception\HttpException;
use Pterodactyl\Exceptions\Repository\RecordNotFoundException; use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
@ -25,8 +23,6 @@ class Handler extends ExceptionHandler
AuthenticationException::class, AuthenticationException::class,
AuthorizationException::class, AuthorizationException::class,
DisplayException::class, DisplayException::class,
DataValidationException::class,
DisplayValidationException::class,
HttpException::class, HttpException::class,
ModelNotFoundException::class, ModelNotFoundException::class,
RecordNotFoundException::class, RecordNotFoundException::class,
@ -34,6 +30,16 @@ class Handler extends ExceptionHandler
ValidationException::class, ValidationException::class,
]; ];
/**
* A list of the inputs that are never flashed for validation exceptions.
*
* @var array
*/
protected $dontFlash = [
'password',
'password_confirmation',
];
/** /**
* Report or log an exception. * Report or log an exception.
* *
@ -53,41 +59,78 @@ class Handler extends ExceptionHandler
* *
* @param \Illuminate\Http\Request $request * @param \Illuminate\Http\Request $request
* @param \Exception $exception * @param \Exception $exception
* @return \Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response * @return \Symfony\Component\HttpFoundation\Response
* *
* @throws \Exception * @throws \Exception
*/ */
public function render($request, Exception $exception) public function render($request, Exception $exception)
{ {
if ($request->expectsJson() || $request->isJson() || $request->is(...config('pterodactyl.json_routes'))) { return parent::render($request, $exception);
$exception = $this->prepareException($exception); }
if (config('app.debug') || $this->isHttpException($exception) || $exception instanceof DisplayException) { /**
$displayError = $exception->getMessage(); * @param \Illuminate\Http\Request $request
} else { * @param \Illuminate\Validation\ValidationException $exception
$displayError = 'An unhandled exception was encountered with this request.'; * @return \Illuminate\Http\JsonResponse
*/
public function invalidJson($request, ValidationException $exception)
{
$codes = collect($exception->validator->failed())->mapWithKeys(function ($reasons, $field) {
$cleaned = [];
foreach ($reasons as $reason => $attrs) {
$cleaned[] = snake_case($reason);
} }
$response = response()->json( return [$field => $cleaned];
[ })->toArray();
'error' => $displayError,
'type' => (! config('app.debug')) ? null : class_basename($exception), $errors = collect($exception->errors())->map(function ($errors, $field) use ($codes) {
'http_code' => (method_exists($exception, 'getStatusCode')) ? $exception->getStatusCode() : 500, $response = [];
'trace' => (! config('app.debug')) ? null : $exception->getTrace(), foreach ($errors as $key => $error) {
$response[] = [
'code' => array_get($codes, $field . '.' . $key),
'detail' => $error,
'source' => ['field' => $field],
];
}
return $response;
})->flatMap(function ($errors) {
return $errors;
})->toArray();
return response()->json(['errors' => $errors], $exception->status);
}
/**
* Return the exception as a JSONAPI representation for use on API requests.
*
* @param \Exception $exception
* @param array $override
* @return array
*/
public static function convertToArray(Exception $exception, array $override = []): array
{
$error = [
'code' => class_basename($exception),
'status' => method_exists($exception, 'getStatusCode') ? strval($exception->getStatusCode()) : '500',
'detail' => 'An error was encountered while processing this request.',
];
if (config('app.debug')) {
$error = array_merge($error, [
'detail' => $exception->getMessage(),
'source' => [
'line' => $exception->getLine(),
'file' => str_replace(base_path(), '', $exception->getFile()),
], ],
$this->isHttpException($exception) ? $exception->getStatusCode() : 500, 'meta' => [
$this->isHttpException($exception) ? $exception->getHeaders() : [], 'trace' => explode("\n", $exception->getTraceAsString()),
JSON_UNESCAPED_SLASHES ],
); ]);
parent::report($exception);
} elseif ($exception instanceof DisplayException) {
Alert::danger($exception->getMessage())->flash();
return redirect()->back()->withInput();
} }
return (isset($response)) ? $response : parent::render($request, $exception); return ['errors' => [array_merge($error, $override)]];
} }
/** /**
@ -105,4 +148,16 @@ class Handler extends ExceptionHandler
return redirect()->guest(route('auth.login')); return redirect()->guest(route('auth.login'));
} }
/**
* Converts an exception into an array to render in the response. Overrides
* Laravel's built-in converter to output as a JSONAPI spec compliant object.
*
* @param \Exception $exception
* @return array
*/
protected function convertExceptionToArray(Exception $exception)
{
return self::convertToArray($exception);
}
} }

View file

@ -1,20 +1,21 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions\Model; namespace Pterodactyl\Exceptions\Model;
use Illuminate\Contracts\Validation\Validator; use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException; use Pterodactyl\Exceptions\PterodactylException;
use Illuminate\Contracts\Support\MessageProvider; use Illuminate\Contracts\Support\MessageProvider;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
class DataValidationException extends ValidationException implements MessageProvider class DataValidationException extends PterodactylException implements HttpExceptionInterface, MessageProvider
{ {
/**
* The validator instance.
*
* @var \Illuminate\Contracts\Validation\Validator
*/
public $validator;
/** /**
* DataValidationException constructor. * DataValidationException constructor.
* *
@ -22,14 +23,38 @@ class DataValidationException extends ValidationException implements MessageProv
*/ */
public function __construct(Validator $validator) public function __construct(Validator $validator)
{ {
parent::__construct($validator); parent::__construct(
'Data integrity exception encountered while performing database write operation. ' . $validator->errors()->toJson()
);
$this->validator = $validator;
} }
/** /**
* Return the validator message bag.
*
* @return \Illuminate\Support\MessageBag * @return \Illuminate\Support\MessageBag
*/ */
public function getMessageBag() public function getMessageBag()
{ {
return $this->validator->errors(); return $this->validator->errors();
} }
/**
* Return the status code for this request.
*
* @return int
*/
public function getStatusCode()
{
return 500;
}
/**
* @return array
*/
public function getHeaders()
{
return [];
}
} }

View file

@ -1,11 +1,4 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions; namespace Pterodactyl\Exceptions;

View file

@ -1,14 +1,9 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions\Repository\Daemon; namespace Pterodactyl\Exceptions\Repository\Daemon;
class InvalidPowerSignalException extends \Exception use Pterodactyl\Exceptions\Repository\RepositoryException;
class InvalidPowerSignalException extends RepositoryException
{ {
} }

View file

@ -1,11 +1,4 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions\Repository; namespace Pterodactyl\Exceptions\Repository;

View file

@ -1,21 +1,20 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions\Repository; namespace Pterodactyl\Exceptions\Repository;
class RecordNotFoundException extends \Exception class RecordNotFoundException extends RepositoryException
{ {
/** /**
* @return int * Handle request to render this exception to a user. Returns the default
* 404 page view.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/ */
public function getStatusCode() public function render($request)
{ {
return 404; if (! config('app.debug')) {
return response()->view('errors.404', [], 404);
}
} }
} }

View file

@ -1,14 +1,9 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Exceptions\Repository; namespace Pterodactyl\Exceptions\Repository;
class RepositoryException extends \Exception use Pterodactyl\Exceptions\PterodactylException;
class RepositoryException extends PterodactylException
{ {
} }

View file

@ -0,0 +1,70 @@
<?php
namespace Pterodactyl\Http\Controllers\API\Admin\Nodes;
use Spatie\Fractal\Fractal;
use Illuminate\Http\Request;
use Pterodactyl\Models\Node;
use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Transformers\Api\Admin\NodeTransformer;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use Pterodactyl\Contracts\Repository\NodeRepositoryInterface;
class NodeController extends Controller
{
/**
* @var \Spatie\Fractal\Fractal
*/
private $fractal;
/**
* @var \Pterodactyl\Contracts\Repository\NodeRepositoryInterface
*/
private $repository;
/**
* NodeController constructor.
*
* @param \Spatie\Fractal\Fractal $fractal
* @param \Pterodactyl\Contracts\Repository\NodeRepositoryInterface $repository
*/
public function __construct(Fractal $fractal, NodeRepositoryInterface $repository)
{
$this->fractal = $fractal;
$this->repository = $repository;
}
/**
* Return all of the nodes currently available on the Panel.
*
* @param \Illuminate\Http\Request $request
* @return array
*/
public function index(Request $request): array
{
$nodes = $this->repository->all(config('pterodactyl.paginate.api.nodes'));
$fractal = $this->fractal->collection($nodes)
->transformWith(new NodeTransformer($request))
->withResourceName('node')
->paginateWith(new IlluminatePaginatorAdapter($nodes));
return $fractal->toArray();
}
/**
* Return data for a single instance of a node.
*
* @param \Illuminate\Http\Request $request
* @param \Pterodactyl\Models\Node $node
* @return array
*/
public function view(Request $request, Node $node): array
{
$fractal = $this->fractal->item($node)
->transformWith(new NodeTransformer($request))
->withResourceName('node');
return $fractal->toArray();
}
}

View file

@ -11,8 +11,8 @@ use Pterodactyl\Http\Controllers\Controller;
use Pterodactyl\Services\Users\UserUpdateService; use Pterodactyl\Services\Users\UserUpdateService;
use Pterodactyl\Services\Users\UserCreationService; use Pterodactyl\Services\Users\UserCreationService;
use Pterodactyl\Services\Users\UserDeletionService; use Pterodactyl\Services\Users\UserDeletionService;
use Pterodactyl\Transformers\Admin\UserTransformer;
use Pterodactyl\Http\Requests\Admin\UserFormRequest; use Pterodactyl\Http\Requests\Admin\UserFormRequest;
use Pterodactyl\Transformers\Api\Admin\UserTransformer;
use League\Fractal\Pagination\IlluminatePaginatorAdapter; use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use Pterodactyl\Contracts\Repository\UserRepositoryInterface; use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
@ -83,7 +83,7 @@ class UserController extends Controller
->withResourceName('user') ->withResourceName('user')
->paginateWith(new IlluminatePaginatorAdapter($users)); ->paginateWith(new IlluminatePaginatorAdapter($users));
if (config('pterodactyl.api.include_on_list') && $request->has('include')) { if (config('pterodactyl.api.include_on_list') && $request->filled('include')) {
$fractal->parseIncludes(explode(',', $request->input('include'))); $fractal->parseIncludes(explode(',', $request->input('include')));
} }
@ -104,7 +104,7 @@ class UserController extends Controller
->transformWith(new UserTransformer($request)) ->transformWith(new UserTransformer($request))
->withResourceName('user'); ->withResourceName('user');
if ($request->has('include')) { if ($request->filled('include')) {
$fractal->parseIncludes(explode(',', $request->input('include'))); $fractal->parseIncludes(explode(',', $request->input('include')));
} }

View file

@ -1,82 +0,0 @@
<?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Transformers\Admin;
use Illuminate\Http\Request;
use Pterodactyl\Models\Allocation;
use League\Fractal\TransformerAbstract;
class AllocationTransformer extends TransformerAbstract
{
/**
* The filter to be applied to this transformer.
*
* @var bool|string
*/
protected $filter;
/**
* The Illuminate Request object if provided.
*
* @var \Illuminate\Http\Request|bool
*/
protected $request;
/**
* Setup request object for transformer.
*
* @param \Illuminate\Http\Request|bool $request
* @param bool $filter
*/
public function __construct($request = false, $filter = false)
{
if (! $request instanceof Request && $request !== false) {
throw new DisplayException('Request passed to constructor must be of type Request or false.');
}
$this->request = $request;
$this->filter = $filter;
}
/**
* Return a generic transformed allocation array.
*
* @return array
*/
public function transform(Allocation $allocation)
{
return $this->transformWithFilter($allocation);
}
/**
* Determine which transformer filter to apply.
*
* @return array
*/
protected function transformWithFilter(Allocation $allocation)
{
if ($this->filter === 'server') {
return $this->transformForServer($allocation);
}
return $allocation->toArray();
}
/**
* Transform the allocation to only return information not duplicated
* in the server response (discard node_id and server_id).
*
* @return array
*/
protected function transformForServer(Allocation $allocation)
{
return collect($allocation)->only('id', 'ip', 'ip_alias', 'port')->toArray();
}
}

View file

@ -1,86 +0,0 @@
<?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Transformers\Admin;
use Illuminate\Http\Request;
use Pterodactyl\Models\Location;
use League\Fractal\TransformerAbstract;
class LocationTransformer extends TransformerAbstract
{
/**
* List of resources that can be included.
*
* @var array
*/
protected $availableIncludes = [
'nodes',
'servers',
];
/**
* The Illuminate Request object if provided.
*
* @var \Illuminate\Http\Request|bool
*/
protected $request;
/**
* Setup request object for transformer.
*
* @param \Illuminate\Http\Request|bool $request
*/
public function __construct($request = false)
{
if (! $request instanceof Request && $request !== false) {
throw new DisplayException('Request passed to constructor must be of type Request or false.');
}
$this->request = $request;
}
/**
* Return a generic transformed pack array.
*
* @return array
*/
public function transform(Location $location)
{
return $location->toArray();
}
/**
* Return the nodes associated with this location.
*
* @return \Leauge\Fractal\Resource\Collection
*/
public function includeServers(Location $location)
{
if ($this->request && ! $this->request->apiKeyHasPermission('server-list')) {
return;
}
return $this->collection($location->servers, new ServerTransformer($this->request), 'server');
}
/**
* Return the nodes associated with this location.
*
* @return \Leauge\Fractal\Resource\Collection
*/
public function includeNodes(Location $location)
{
if ($this->request && ! $this->request->apiKeyHasPermission('node-list')) {
return;
}
return $this->collection($location->nodes, new NodeTransformer($this->request), 'node');
}
}

View file

@ -1,101 +0,0 @@
<?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Transformers\Admin;
use Illuminate\Http\Request;
use Pterodactyl\Models\Node;
use League\Fractal\TransformerAbstract;
class NodeTransformer extends TransformerAbstract
{
/**
* List of resources that can be included.
*
* @var array
*/
protected $availableIncludes = [
'allocations',
'location',
'servers',
];
/**
* The Illuminate Request object if provided.
*
* @var \Illuminate\Http\Request|bool
*/
protected $request;
/**
* Setup request object for transformer.
*
* @param \Illuminate\Http\Request|bool $request
*/
public function __construct($request = false)
{
if (! $request instanceof Request && $request !== false) {
throw new DisplayException('Request passed to constructor must be of type Request or false.');
}
$this->request = $request;
}
/**
* Return a generic transformed pack array.
*
* @return array
*/
public function transform(Node $node)
{
return $node->toArray();
}
/**
* Return the nodes associated with this location.
*
* @return \Leauge\Fractal\Resource\Collection
*/
public function includeAllocations(Node $node)
{
if ($this->request && ! $this->request->apiKeyHasPermission('node-view')) {
return;
}
return $this->collection($node->allocations, new AllocationTransformer($this->request), 'allocation');
}
/**
* Return the nodes associated with this location.
*
* @return \Leauge\Fractal\Resource\Item
*/
public function includeLocation(Node $node)
{
if ($this->request && ! $this->request->apiKeyHasPermission('location-list')) {
return;
}
return $this->item($node->location, new LocationTransformer($this->request), 'location');
}
/**
* Return the nodes associated with this location.
*
* @return \Leauge\Fractal\Resource\Collection
*/
public function includeServers(Node $node)
{
if ($this->request && ! $this->request->apiKeyHasPermission('server-list')) {
return;
}
return $this->collection($node->servers, new ServerTransformer($this->request), 'server');
}
}

View file

@ -0,0 +1,31 @@
<?php
namespace Pterodactyl\Transformers\Api\Admin;
use Pterodactyl\Models\Allocation;
use Pterodactyl\Transformers\Api\ApiTransformer;
class AllocationTransformer extends ApiTransformer
{
/**
* Return a generic transformed allocation array.
*
* @param \Pterodactyl\Models\Allocation $allocation
* @return array
*/
public function transform(Allocation $allocation)
{
return $this->transformWithFilter($allocation);
}
/**
* Determine which transformer filter to apply.
*
* @param \Pterodactyl\Models\Allocation $allocation
* @return array
*/
protected function transformWithFilter(Allocation $allocation)
{
return $allocation->toArray();
}
}

View file

@ -0,0 +1,69 @@
<?php
namespace Pterodactyl\Transformers\Api\Admin;
use Pterodactyl\Models\Location;
use Pterodactyl\Transformers\Api\ApiTransformer;
class LocationTransformer extends ApiTransformer
{
/**
* List of resources that can be included.
*
* @var array
*/
protected $availableIncludes = ['nodes', 'servers'];
/**
* Return a generic transformed pack array.
*
* @param \Pterodactyl\Models\Location $location
* @return array
*/
public function transform(Location $location): array
{
return $location->toArray();
}
/**
* Return the nodes associated with this location.
*
* @param \Pterodactyl\Models\Location $location
* @return bool|\League\Fractal\Resource\Collection
*
* @throws \Pterodactyl\Exceptions\PterodactylException
*/
public function includeServers(Location $location)
{
if (! $this->authorize('server-list')) {
return false;
}
if (! $location->relationLoaded('servers')) {
$location->load('servers');
}
return $this->collection($location->getRelation('servers'), new ServerTransformer($this->getRequest()), 'server');
}
/**
* Return the nodes associated with this location.
*
* @param \Pterodactyl\Models\Location $location
* @return bool|\League\Fractal\Resource\Collection
*
* @throws \Pterodactyl\Exceptions\PterodactylException
*/
public function includeNodes(Location $location)
{
if (! $this->authorize('node-list')) {
return false;
}
if (! $location->relationLoaded('nodes')) {
$location->load('nodes');
}
return $this->collection($location->getRelation('nodes'), new NodeTransformer($this->getRequest()), 'node');
}
}

View file

@ -0,0 +1,84 @@
<?php
namespace Pterodactyl\Transformers\Api\Admin;
use Pterodactyl\Models\Node;
use Pterodactyl\Transformers\Api\ApiTransformer;
class NodeTransformer extends ApiTransformer
{
/**
* List of resources that can be included.
*
* @var array
*/
protected $availableIncludes = ['allocations', 'location', 'servers'];
/**
* Return a generic transformed pack array.
*
* @param \Pterodactyl\Models\Node $node
* @return array
*/
public function transform(Node $node): array
{
return $node->toArray();
}
/**
* Return the nodes associated with this location.
*
* @param \Pterodactyl\Models\Node $node
* @return \League\Fractal\Resource\Collection
*/
public function includeAllocations(Node $node)
{
if (! $node->relationLoaded('allocations')) {
$node->load('allocations');
}
return $this->collection($node->getRelation('allocations'), new AllocationTransformer($this->getRequest()), 'allocation');
}
/**
* Return the nodes associated with this location.
*
* @param \Pterodactyl\Models\Node $node
* @return bool|\League\Fractal\Resource\Item
*
* @throws \Pterodactyl\Exceptions\PterodactylException
*/
public function includeLocation(Node $node)
{
if (! $this->authorize('location-list')) {
return false;
}
if (! $node->relationLoaded('location')) {
$node->load('location');
}
return $this->item($node->getRelation('location'), new LocationTransformer($this->getRequest()), 'location');
}
/**
* Return the nodes associated with this location.
*
* @param \Pterodactyl\Models\Node $node
* @return bool|\League\Fractal\Resource\Collection
*
* @throws \Pterodactyl\Exceptions\PterodactylException
*/
public function includeServers(Node $node)
{
if (! $this->authorize('server-list')) {
return false;
}
if (! $node->relationLoaded('servers')) {
$node->load('servers');
}
return $this->collection($node->getRelation('servers'), new ServerTransformer($this->getRequest()), 'server');
}
}

View file

@ -1,13 +1,6 @@
<?php <?php
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Transformers\Admin; namespace Pterodactyl\Transformers\Api\Admin;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Pterodactyl\Models\Server; use Pterodactyl\Models\Server;

View file

@ -1,10 +1,9 @@
<?php <?php
namespace Pterodactyl\Transformers\Admin; namespace Pterodactyl\Transformers\Api\Admin;
use Illuminate\Http\Request;
use Pterodactyl\Models\User; use Pterodactyl\Models\User;
use Pterodactyl\Transformers\ApiTransformer; use Pterodactyl\Transformers\Api\ApiTransformer;
class UserTransformer extends ApiTransformer class UserTransformer extends ApiTransformer
{ {
@ -15,16 +14,6 @@ class UserTransformer extends ApiTransformer
*/ */
protected $availableIncludes = ['servers']; protected $availableIncludes = ['servers'];
/**
* Setup request object for transformer.
*
* @param \Illuminate\Http\Request $request
*/
public function __construct(Request $request)
{
$this->request = $request;
}
/** /**
* Return a generic transformed subuser array. * Return a generic transformed subuser array.
* *
@ -54,6 +43,6 @@ class UserTransformer extends ApiTransformer
$user->load('servers'); $user->load('servers');
} }
return $this->collection($user->getRelation('servers'), new ServerTransformer($this->request), 'server'); return $this->collection($user->getRelation('servers'), new ServerTransformer($this->getRequest()), 'server');
} }
} }

View file

@ -1,7 +1,8 @@
<?php <?php
namespace Pterodactyl\Transformers; namespace Pterodactyl\Transformers\Api;
use Illuminate\Http\Request;
use League\Fractal\TransformerAbstract; use League\Fractal\TransformerAbstract;
use Pterodactyl\Exceptions\PterodactylException; use Pterodactyl\Exceptions\PterodactylException;
@ -10,7 +11,27 @@ abstract class ApiTransformer extends TransformerAbstract
/** /**
* @var \Illuminate\Http\Request * @var \Illuminate\Http\Request
*/ */
protected $request; private $request;
/**
* Setup request object for transformer.
*
* @param \Illuminate\Http\Request $request
*/
public function __construct(Request $request)
{
$this->request = $request;
}
/**
* Return the request instance being used for this transformer.
*
* @return \Illuminate\Http\Request
*/
public function getRequest(): Request
{
return $this->request;
}
/** /**
* Determine if an API key from the request has permission to access * Determine if an API key from the request has permission to access

View file

@ -13,4 +13,19 @@ return [
*/ */
'default_serializer' => League\Fractal\Serializer\JsonApiSerializer::class, 'default_serializer' => League\Fractal\Serializer\JsonApiSerializer::class,
/*
|--------------------------------------------------------------------------
| Auto Includes
|--------------------------------------------------------------------------
|
| If enabled Fractal will automatically add the includes who's
| names are present in the `include` request parameter.
|
*/
'auto_includes' => [
'enabled' => true,
'request_key' => 'include',
],
]; ];

View file

@ -17,3 +17,8 @@ Route::group(['prefix' => '/users'], function () {
Route::delete('/{user}', 'Users\UserController@delete')->name('api.admin.user.delete'); Route::delete('/{user}', 'Users\UserController@delete')->name('api.admin.user.delete');
}); });
Route::group(['prefix' => '/nodes'], function () {
Route::get('/', 'Nodes\NodeController@index')->name('api.admin.node.list');
Route::get('/{node}', 'Nodes\NodeController@view')->name('api.admin.node.view');
});