Skip to content

Commit 5f13531

Browse files
DaneEverittDaneEveritt
committed
Fix up subuser API response for clients
1 parent 51defae commit 5f13531

File tree

11 files changed

+86
-41
lines changed

11 files changed

+86
-41
lines changed

‎app/Http/Controllers/Api/Client/Servers/SubuserController.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ public function __construct(SubuserRepository $repository)
3636
*/
3737
public function index(GetSubuserRequest $request, Server $server)
3838
{
39-
$users = $this->repository->getSubusersForServer($server->id);
39+
$server->subusers->load('user');
4040

41-
return $this->fractal->collection($users)
41+
return $this->fractal->collection($server->subusers)
4242
->transformWith($this->getTransformer(SubuserTransformer::class))
4343
->toArray();
4444
}

‎app/Models/Egg.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@
3333
* @property string|null $inherit_config_stop
3434
*
3535
* @property \Pterodactyl\Models\Nest $nest
36-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\Server[] $servers
37-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\EggVariable[] $variables
38-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\Pack[] $packs
36+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Server[] $servers
37+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\EggVariable[] $variables
38+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Pack[] $packs
3939
* @property \Pterodactyl\Models\Egg|null $scriptFrom
4040
* @property \Pterodactyl\Models\Egg|null $configFrom
4141
*/

‎app/Models/Nest.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
* @property \Carbon\Carbon $created_at
1212
* @property \Carbon\Carbon $updated_at
1313
*
14-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\Server[] $servers
15-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\Egg[] $eggs
16-
* @property \Illuminate\Support\Collection|\Pterodactyl\Models\Pack[] $packs
14+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Server[] $servers
15+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Egg[] $eggs
16+
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Pack[] $packs
1717
*/
1818
class Nest extends Validable
1919
{

‎app/Models/Node.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
* @property \Carbon\Carbon $updated_at
3030
*
3131
* @property \Pterodactyl\Models\Location $location
32-
* @property \Pterodactyl\Models\Server[]|\Illuminate\Support\Collection $servers
33-
* @property \Pterodactyl\Models\Allocation[]|\Illuminate\Support\Collection $allocations
32+
* @property \Pterodactyl\Models\Server[]|\Illuminate\Database\Eloquent\Collection $servers
33+
* @property \Pterodactyl\Models\Allocation[]|\Illuminate\Database\Eloquent\Collection $allocations
3434
*/
3535
class Node extends Validable
3636
{

‎app/Models/Permission.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ class Permission extends Validable
160160
* Returns all of the permissions available on the system for a user to
161161
* have when controlling a server.
162162
*
163-
* @return \Illuminate\Support\Collection
163+
* @return \Illuminate\Database\Eloquent\Collection
164164
*/
165165
public static function permissions(): Collection
166166
{
@@ -229,7 +229,7 @@ public static function permissions(): Collection
229229
* Return a collection of permissions available.
230230
*
231231
* @param bool $array
232-
* @return array|\Illuminate\Support\Collection
232+
* @return array|\Illuminate\Database\Eloquent\Collection
233233
* @deprecated
234234
*/
235235
public static function getPermissions($array = false)

‎app/Models/Server.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,19 @@
3737
* @property \Carbon\Carbon $updated_at
3838
*
3939
* @property \Pterodactyl\Models\User $user
40-
* @property \Pterodactyl\Models\User[]|\Illuminate\Support\Collection $subusers
40+
* @property \Pterodactyl\Models\User[]|\Illuminate\Database\Eloquent\Collection $subusers
4141
* @property \Pterodactyl\Models\Allocation $allocation
42-
* @property \Pterodactyl\Models\Allocation[]|\Illuminate\Support\Collection $allocations
42+
* @property \Pterodactyl\Models\Allocation[]|\Illuminate\Database\Eloquent\Collection $allocations
4343
* @property \Pterodactyl\Models\Pack|null $pack
4444
* @property \Pterodactyl\Models\Node $node
4545
* @property \Pterodactyl\Models\Nest $nest
4646
* @property \Pterodactyl\Models\Egg $egg
47-
* @property \Pterodactyl\Models\ServerVariable[]|\Illuminate\Support\Collection $variables
48-
* @property \Pterodactyl\Models\Schedule[]|\Illuminate\Support\Collection $schedule
49-
* @property \Pterodactyl\Models\Database[]|\Illuminate\Support\Collection $databases
47+
* @property \Pterodactyl\Models\ServerVariable[]|\Illuminate\Database\Eloquent\Collection $variables
48+
* @property \Pterodactyl\Models\Schedule[]|\Illuminate\Database\Eloquent\Collection $schedule
49+
* @property \Pterodactyl\Models\Database[]|\Illuminate\Database\Eloquent\Collection $databases
5050
* @property \Pterodactyl\Models\Location $location
5151
* @property \Pterodactyl\Models\DaemonKey $key
52-
* @property \Pterodactyl\Models\DaemonKey[]|\Illuminate\Support\Collection $keys
52+
* @property \Pterodactyl\Models\DaemonKey[]|\Illuminate\Database\Eloquent\Collection $keys
5353
*/
5454
class Server extends Validable
5555
{

‎app/Models/Subuser.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*
1414
* @property \Pterodactyl\Models\User $user
1515
* @property \Pterodactyl\Models\Server $server
16-
* @property \Pterodactyl\Models\Permission[]|\Illuminate\Support\Collection $permissions
16+
* @property \Pterodactyl\Models\Permission[]|\Illuminate\Database\Eloquent\Collection $permissions
1717
*/
1818
class Subuser extends Validable
1919
{

‎app/Models/User.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@
3636
* @property \Carbon\Carbon $updated_at
3737
*
3838
* @property string $name
39-
* @property \Pterodactyl\Models\Permission[]|\Illuminate\Support\Collection $permissions
40-
* @property \Pterodactyl\Models\Server[]|\Illuminate\Support\Collection $servers
41-
* @property \Pterodactyl\Models\Subuser[]|\Illuminate\Support\Collection $subuserOf
42-
* @property \Pterodactyl\Models\DaemonKey[]|\Illuminate\Support\Collection $keys
39+
* @property \Pterodactyl\Models\Permission[]|\Illuminate\Database\Eloquent\Collection $permissions
40+
* @property \Pterodactyl\Models\Server[]|\Illuminate\Database\Eloquent\Collection $servers
41+
* @property \Pterodactyl\Models\Subuser[]|\Illuminate\Database\Eloquent\Collection $subuserOf
42+
* @property \Pterodactyl\Models\DaemonKey[]|\Illuminate\Database\Eloquent\Collection $keys
4343
*/
4444
class User extends Validable implements
4545
AuthenticatableContract,

‎app/Transformers/Api/Client/ServerTransformer.php‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44

55
use Pterodactyl\Models\Egg;
66
use Pterodactyl\Models\Server;
7+
use Pterodactyl\Models\Subuser;
78

89
class ServerTransformer extends BaseClientTransformer
910
{
1011
/**
1112
* @var array
1213
*/
13-
protected $availableIncludes = ['egg'];
14+
protected $availableIncludes = ['egg', 'subusers'];
1415

1516
/**
1617
* @return string
@@ -69,4 +70,16 @@ public function includeEgg(Server $server)
6970
{
7071
return $this->item($server->egg, $this->makeTransformer(EggTransformer::class), Egg::RESOURCE_NAME);
7172
}
73+
74+
/**
75+
* Returns the subusers associated with this server.
76+
*
77+
* @param \Pterodactyl\Models\Server $server
78+
* @return \League\Fractal\Resource\Collection
79+
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
80+
*/
81+
public function includeSubusers(Server $server)
82+
{
83+
return $this->collection($server->subusers, $this->makeTransformer(SubuserTransformer::class), Subuser::RESOURCE_NAME);
84+
}
7285
}

‎app/Transformers/Api/Client/SubuserTransformer.php‎

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
namespace Pterodactyl\Transformers\Api\Client;
44

5-
use Illuminate\Support\Str;
5+
use Pterodactyl\Models\User;
66
use Pterodactyl\Models\Subuser;
77

88
class SubuserTransformer extends BaseClientTransformer
99
{
10-
protected $availableIncludes = ['permissions'];
10+
/**
11+
* @var array
12+
*/
13+
protected $defaultIncludes = ['user'];
1114

1215
/**
1316
* Return the resource name for the JSONAPI output.
@@ -20,23 +23,15 @@ public function getResourceName(): string
2023
}
2124

2225
/**
23-
* Transforms a User model into a representation that can be shown to regular
24-
* users of the API.
26+
* Transforms a subuser into a model that can be shown to a front-end user.
2527
*
2628
* @param \Pterodactyl\Models\Subuser $model
27-
* @return array
29+
* @return array|void
2830
*/
2931
public function transform(Subuser $model)
3032
{
31-
$user = $model->user;
32-
3333
return [
34-
'uuid' => $user->uuid,
35-
'username' => $user->username,
36-
'email' => $user->email,
37-
'image' => 'https://gravatar.com/avatar/' . md5(Str::lower($user->email)),
38-
'2fa_enabled' => $user->use_totp,
39-
'created_at' => $model->created_at->toIso8601String(),
34+
'permissions' => $model->permissions->pluck('permission'),
4035
];
4136
}
4237

@@ -45,11 +40,10 @@ public function transform(Subuser $model)
4540
*
4641
* @param \Pterodactyl\Models\Subuser $model
4742
* @return \League\Fractal\Resource\Item
43+
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
4844
*/
49-
public function includePermissions(Subuser $model)
45+
public function includeUser(Subuser $model)
5046
{
51-
return $this->item($model, function (Subuser $model) {
52-
return ['permissions' => $model->permissions->pluck('permission')];
53-
});
47+
return $this->item($model->user, $this->makeTransformer(UserTransformer::class), User::RESOURCE_NAME);
5448
}
5549
}

0 commit comments

Comments
 (0)