add simple api for query

Author: Boy132

player-counter/routes/api-client.php

@@ -0,0 +1,16 @@
+<?php
+
+use App\Http\Middleware\Activity\ServerSubject;
+use App\Http\Middleware\Api\Client\Server\AuthenticateServerAccess;
+use App\Http\Middleware\Api\Client\Server\ResourceBelongsToServer;
+use Boy132\PlayerCounter\Http\Controllers\Api\Client\Servers\PlayerCounterController;
+use Boy132\PlayerCounter\Providers\PlayerCounterRoutesProvider;
+use Illuminate\Routing\Middleware\ThrottleRequests;
+use Illuminate\Support\Facades\Route;
+
+Route::prefix('/servers/{server:uuid}')->middleware([ServerSubject::class, AuthenticateServerAccess::class, ResourceBelongsToServer::class])->group(function () {
+    Route::prefix('/query')->middleware(ThrottleRequests::using(PlayerCounterRoutesProvider::QUERY_THROTTLE_KEY))->group(function () {
+        Route::get('/', [PlayerCounterController::class, 'query']);
+        Route::get('/players', [PlayerCounterController::class, 'players']);
+    });
+});

player-counter/src/Http/Controllers/Api/Client/Servers/PlayerCounterController.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Boy132\PlayerCounter\Http\Controllers\Api\Client\Servers;
+
+use App\Http\Controllers\Api\Client\ClientApiController;
+use App\Models\Server;
+use Boy132\PlayerCounter\Models\GameQuery;
+use Dedoc\Scramble\Attributes\Group;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Response;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+#[Group('Server - Players')]
+class PlayerCounterController extends ClientApiController
+{
+    /**
+     * Get query
+     *
+     * Returns query information.
+     *
+     * @throws HttpException
+     */
+    public function query(Server $server): JsonResponse
+    {
+        $data = $this->runQuery($server);
+
+        return response()->json([
+            'hostname' => (string) $data['gq_hostname'],
+            'current_players' => (int) $data['gq_numplayers'],
+            'max_players' => (int) $data['gq_maxplayers'],
+            'map' => (string) $data['gq_mapname'],
+        ]);
+    }
+
+    /**
+     * Get players
+     *
+     * Returns the names of the current players.
+     *
+     * @throws HttpException
+     */
+    public function players(Server $server): JsonResponse
+    {
+        $data = $this->runQuery($server);
+
+        /** @var string[] $players */
+        $players = array_map(fn ($player) => $player['gq_name'], $data['players']);
+
+        return response()->json($players);
+    }
+
+    /** @return array<mixed> */
+    private function runQuery(Server $server): array
+    {
+        if (!$server->allocation || $server->allocation->ip === '0.0.0.0' || $server->allocation->ip === '::') {
+            abort(Response::HTTP_NOT_ACCEPTABLE, 'Server has invalid allocation');
+        }
+
+        if ($server->retrieveStatus()->isOffline()) {
+            abort(Response::HTTP_NOT_ACCEPTABLE, 'Server is offline');
+        }
+
+        /** @var ?GameQuery $gameQuery */
+        $gameQuery = $server->egg->gameQuery; // @phpstan-ignore property.notFound
+
+        if (!$gameQuery) {
+            abort(Response::HTTP_NOT_ACCEPTABLE, 'Server has no query');
+        }
+
+        return $gameQuery->runQuery($server->allocation);
+    }
+}

player-counter/src/Providers/PlayerCounterRoutesProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Boy132\PlayerCounter\Providers;
+
+use App\Models\Server;
+use Illuminate\Cache\RateLimiting\Limit;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\RateLimiter;
+use Illuminate\Support\Facades\Route;
+use Webmozart\Assert\Assert;
+
+class PlayerCounterRoutesProvider extends RouteServiceProvider
+{
+    const QUERY_THROTTLE_KEY = 'api.client:server-resource:query';
+
+    public function boot(): void
+    {
+        $this->routes(function () {
+            Route::middleware(['api', 'client-api', 'throttle:api.client'])
+                ->prefix('/api/client')
+                ->scopeBindings()
+                ->group(plugin_path('player-counter', 'routes/api-client.php'));
+        });
+
+        RateLimiter::for(self::QUERY_THROTTLE_KEY, function (Request $request) {
+            Assert::isInstanceOf($server = $request->route()->parameter('server'), Server::class);
+
+            return Limit::perMinute(2)->by($server->uuid);
+        });
+    }
+}