mirror of
https://github.com/pelican-dev/panel.git
synced 2025-05-20 00:34:44 +02:00
e1308cb04d
* update scramble * cleanup application api endpoints * cleanup client api endpoints * fix security schema and make docs homepage nicer * remove duplicate myclabs/deep-copy * style(api-docs): use Blade template and Tailwind for styling * Publish scramble view * Use localStorage theme instead of config * Update routes/docs.php Co-authored-by: Lance Pioch <git@lance.sh> --------- Co-authored-by: Quinten <67589015+QuintenQVD0@users.noreply.github.com> Co-authored-by: RMartinOscar <40749467+RMartinOscar@users.noreply.github.com> Co-authored-by: Lance Pioch <git@lance.sh>
88 lines
3.1 KiB
PHP
88 lines
3.1 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api\Client;
|
|
|
|
use App\Models\Server;
|
|
use App\Models\Permission;
|
|
use Spatie\QueryBuilder\QueryBuilder;
|
|
use Spatie\QueryBuilder\AllowedFilter;
|
|
use App\Models\Filters\MultiFieldServerFilter;
|
|
use App\Transformers\Api\Client\ServerTransformer;
|
|
use App\Http\Requests\Api\Client\GetServersRequest;
|
|
use Dedoc\Scramble\Attributes\Group;
|
|
|
|
#[Group('Base')]
|
|
class ClientController extends ClientApiController
|
|
{
|
|
/**
|
|
* ClientController constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* List servers
|
|
*
|
|
* Return all the servers available to the client making the API
|
|
* request, including servers the user has access to as a subuser.
|
|
*/
|
|
public function index(GetServersRequest $request): array
|
|
{
|
|
$user = $request->user();
|
|
$transformer = $this->getTransformer(ServerTransformer::class);
|
|
|
|
// Start the query builder and ensure we eager load any requested relationships from the request.
|
|
$builder = QueryBuilder::for(
|
|
Server::query()->with($this->getIncludesForTransformer($transformer, ['node']))
|
|
)->allowedFilters([
|
|
'uuid',
|
|
'name',
|
|
'description',
|
|
'external_id',
|
|
AllowedFilter::custom('*', new MultiFieldServerFilter()),
|
|
]);
|
|
|
|
$type = $request->input('type');
|
|
// Either return all the servers the user has access to because they are an admin `?type=admin` or
|
|
// just return all the servers the user has access to because they are the owner or a subuser of the
|
|
// server. If ?type=admin-all is passed all servers on the system will be returned to the user, rather
|
|
// than only servers they can see because they are an admin.
|
|
if (in_array($type, ['admin', 'admin-all'])) {
|
|
// If they aren't an admin but want all the admin servers don't fail the request, just
|
|
// make it a query that will never return any results back.
|
|
if (!$user->isRootAdmin()) {
|
|
$builder->whereRaw('1 = 2');
|
|
} else {
|
|
$builder = $type === 'admin-all'
|
|
? $builder
|
|
: $builder->whereNotIn('servers.id', $user->directAccessibleServers()->pluck('id')->all());
|
|
}
|
|
} elseif ($type === 'owner') {
|
|
$builder = $builder->where('servers.owner_id', $user->id);
|
|
} else {
|
|
$builder = $builder->whereIn('servers.id', $user->directAccessibleServers()->pluck('id')->all());
|
|
}
|
|
|
|
$servers = $builder->paginate(min($request->query('per_page', '50'), 100))->appends($request->query());
|
|
|
|
return $this->fractal->transformWith($transformer)->collection($servers)->toArray();
|
|
}
|
|
|
|
/**
|
|
* List subuser permissions
|
|
*
|
|
* Returns all the subuser permissions available on the system.
|
|
*/
|
|
public function permissions(): array
|
|
{
|
|
return [
|
|
'object' => 'system_permissions',
|
|
'attributes' => [
|
|
'permissions' => Permission::permissions(),
|
|
],
|
|
];
|
|
}
|
|
}
|