2018-01-04 03:14:53 +00:00
|
|
|
<?php
|
|
|
|
|
2018-01-20 01:58:57 +00:00
|
|
|
namespace Pterodactyl\Http\Controllers\Api\Application\Locations;
|
2018-01-04 03:14:53 +00:00
|
|
|
|
|
|
|
use Illuminate\Http\Response;
|
|
|
|
use Pterodactyl\Models\Location;
|
|
|
|
use Illuminate\Http\JsonResponse;
|
2020-09-13 18:59:52 +00:00
|
|
|
use Spatie\QueryBuilder\QueryBuilder;
|
2018-01-04 03:14:53 +00:00
|
|
|
use Pterodactyl\Services\Locations\LocationUpdateService;
|
|
|
|
use Pterodactyl\Services\Locations\LocationCreationService;
|
|
|
|
use Pterodactyl\Services\Locations\LocationDeletionService;
|
2018-01-20 03:47:06 +00:00
|
|
|
use Pterodactyl\Transformers\Api\Application\LocationTransformer;
|
2022-12-15 00:05:46 +00:00
|
|
|
use Pterodactyl\Exceptions\Http\QueryValueOutOfRangeHttpException;
|
2018-01-27 18:38:56 +00:00
|
|
|
use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
|
2018-09-03 22:59:30 +00:00
|
|
|
use Pterodactyl\Http\Requests\Api\Application\Locations\GetLocationRequest;
|
2018-01-20 01:58:57 +00:00
|
|
|
use Pterodactyl\Http\Requests\Api\Application\Locations\GetLocationsRequest;
|
2018-11-20 05:04:05 +00:00
|
|
|
use Pterodactyl\Http\Requests\Api\Application\Locations\StoreLocationRequest;
|
2019-01-26 23:26:15 +00:00
|
|
|
use Pterodactyl\Http\Requests\Api\Application\Locations\DeleteLocationRequest;
|
2018-01-20 01:58:57 +00:00
|
|
|
use Pterodactyl\Http\Requests\Api\Application\Locations\UpdateLocationRequest;
|
2018-01-04 03:14:53 +00:00
|
|
|
|
2018-01-27 18:38:56 +00:00
|
|
|
class LocationController extends ApplicationApiController
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* LocationController constructor.
|
|
|
|
*/
|
|
|
|
public function __construct(
|
2022-10-14 16:59:20 +00:00
|
|
|
private LocationCreationService $creationService,
|
|
|
|
private LocationDeletionService $deletionService,
|
|
|
|
private LocationUpdateService $updateService
|
2018-01-04 03:14:53 +00:00
|
|
|
) {
|
2018-01-27 18:38:56 +00:00
|
|
|
parent::__construct();
|
2018-01-04 03:14:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-10-14 16:59:20 +00:00
|
|
|
* Return all the locations currently registered on the Panel.
|
2018-01-04 03:14:53 +00:00
|
|
|
*/
|
2018-01-13 02:39:15 +00:00
|
|
|
public function index(GetLocationsRequest $request): array
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
2022-12-15 00:05:46 +00:00
|
|
|
$perPage = (int) $request->query('per_page', '10');
|
|
|
|
if ($perPage < 1 || $perPage > 100) {
|
|
|
|
throw new QueryValueOutOfRangeHttpException('per_page', 1, 100);
|
|
|
|
}
|
|
|
|
|
2020-09-13 18:59:52 +00:00
|
|
|
$locations = QueryBuilder::for(Location::query())
|
|
|
|
->allowedFilters(['short', 'long'])
|
2022-12-15 00:05:46 +00:00
|
|
|
->allowedSorts(['id', 'short', 'long'])
|
|
|
|
->paginate($perPage);
|
2018-01-04 03:14:53 +00:00
|
|
|
|
|
|
|
return $this->fractal->collection($locations)
|
2022-12-15 00:05:46 +00:00
|
|
|
->transformWith(LocationTransformer::class)
|
2018-01-04 03:14:53 +00:00
|
|
|
->toArray();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return a single location.
|
|
|
|
*/
|
2022-05-22 18:10:01 +00:00
|
|
|
public function view(GetLocationRequest $request, Location $location): array
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
2022-05-22 18:10:01 +00:00
|
|
|
return $this->fractal->item($location)
|
2022-12-15 00:05:46 +00:00
|
|
|
->transformWith(LocationTransformer::class)
|
2018-01-04 03:14:53 +00:00
|
|
|
->toArray();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-10-14 16:59:20 +00:00
|
|
|
* Store a new location on the Panel and return an HTTP/201 response code with the
|
2018-01-13 02:39:15 +00:00
|
|
|
* new location attached.
|
|
|
|
*
|
2018-01-04 03:14:53 +00:00
|
|
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
|
|
|
*/
|
2018-01-13 02:39:15 +00:00
|
|
|
public function store(StoreLocationRequest $request): JsonResponse
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
2018-01-13 02:39:15 +00:00
|
|
|
$location = $this->creationService->handle($request->validated());
|
2018-01-04 03:14:53 +00:00
|
|
|
|
|
|
|
return $this->fractal->item($location)
|
2022-12-15 00:05:46 +00:00
|
|
|
->transformWith(LocationTransformer::class)
|
2018-01-04 03:14:53 +00:00
|
|
|
->respond(201);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-01-13 02:39:15 +00:00
|
|
|
* Update a location on the Panel and return the updated record to the user.
|
|
|
|
*
|
2018-01-04 03:14:53 +00:00
|
|
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
|
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
|
|
*/
|
2022-05-22 18:10:01 +00:00
|
|
|
public function update(UpdateLocationRequest $request, Location $location): array
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
2022-05-22 18:10:01 +00:00
|
|
|
$location = $this->updateService->handle($location, $request->validated());
|
2018-01-04 03:14:53 +00:00
|
|
|
|
|
|
|
return $this->fractal->item($location)
|
2022-12-15 00:05:46 +00:00
|
|
|
->transformWith(LocationTransformer::class)
|
2018-01-04 03:14:53 +00:00
|
|
|
->toArray();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-01-13 02:39:15 +00:00
|
|
|
* Delete a location from the Panel.
|
|
|
|
*
|
2018-01-04 03:14:53 +00:00
|
|
|
* @throws \Pterodactyl\Exceptions\Service\Location\HasActiveNodesException
|
|
|
|
*/
|
2022-05-22 18:10:01 +00:00
|
|
|
public function delete(DeleteLocationRequest $request, Location $location): Response
|
2018-01-04 03:14:53 +00:00
|
|
|
{
|
2022-05-22 18:10:01 +00:00
|
|
|
$this->deletionService->handle($location);
|
2018-01-04 03:14:53 +00:00
|
|
|
|
2022-12-15 00:05:46 +00:00
|
|
|
return $this->returnNoContent();
|
2018-01-04 03:14:53 +00:00
|
|
|
}
|
|
|
|
}
|