Merge pull request #1842 from gettakaro/map-api

Add map API support
gettakaro · Dec 15, 2024 · fc99f56 · fc99f56
2 parents b4af5fe + 31cbc2b
commit fc99f56
Show file tree

Hide file tree

Showing 8 changed files with 157 additions and 2 deletions.
diff --git a/packages/app-api/src/controllers/GameServerController.ts b/packages/app-api/src/controllers/GameServerController.ts
@@ -30,7 +30,19 @@ import {
   ModuleInstallDTO,
 } from '../service/GameServerService.js';
 import { AuthenticatedRequest, AuthService, checkPermissions } from '../service/AuthService.js';
-import { Body, Get, Post, Delete, JsonController, UseBefore, Req, Put, Params, Res } from 'routing-controllers';
+import {
+  Body,
+  Get,
+  Post,
+  Delete,
+  JsonController,
+  UseBefore,
+  Req,
+  Put,
+  Params,
+  Res,
+  ContentType,
+} from 'routing-controllers';
 import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
 import { Type } from 'class-transformer';
 import { ParamId, PogParam } from '../lib/validators.js';
@@ -233,6 +245,17 @@ class ImportOutputDTO extends TakaroDTO<ImportOutputDTO> {
   id!: string;
 }
 
+class MapTileInputDTO extends TakaroDTO<MapTileInputDTO> {
+  @IsUUID('4')
+  id: string;
+  @IsNumber()
+  z: number;
+  @IsNumber()
+  x: number;
+  @IsNumber()
+  y: number;
+}
+
 class ImportOutputDTOAPI extends APIOutput<ImportOutputDTO> {
   @Type(() => ImportOutputDTO)
   @ValidateNested()
@@ -588,4 +611,26 @@ export class GameServerController {
     const result = await service.import(parsedImportData, validatedOptions);
     return apiResponse(result);
   }
+
+  @Get('/gameserver/:id/map/info')
+  @UseBefore(AuthService.getAuthMiddleware([]))
+  @OpenAPI({
+    description: 'Get map metadata for Leaflet',
+  })
+  async getMapInfo(@Req() req: AuthenticatedRequest, @Params() params: ParamId) {
+    const service = new GameServerService(req.domainId);
+    return apiResponse(await service.getMapInfo(params.id));
+  }
+
+  @Get('/gameserver/:id/map/tile/:x/:y/:z')
+  @UseBefore(AuthService.getAuthMiddleware([]))
+  @ContentType('image/png')
+  @OpenAPI({
+    description: 'Get a map tile for Leaflet',
+  })
+  async getMapTile(@Req() req: AuthenticatedRequest, @Params() params: MapTileInputDTO) {
+    const service = new GameServerService(req.domainId);
+    const result = await service.getMapTile(params.id, params.x, params.y, params.z);
+    return result;
+  }
 }
diff --git a/packages/app-api/src/service/GameServerService.ts b/packages/app-api/src/service/GameServerService.ts
@@ -589,4 +589,14 @@ export class GameServerService extends TakaroService<
       id: job.id,
     };
   }
+
+  async getMapInfo(gameServerId: string) {
+    const gameInstance = await this.getGame(gameServerId);
+    return gameInstance.getMapInfo();
+  }
+
+  async getMapTile(gameServerId: string, x: number, y: number, z: number) {
+    const gameInstance = await this.getGame(gameServerId);
+    return gameInstance.getMapTile(x, y, z);
+  }
 }
diff --git a/packages/app-mock-gameserver/src/lib/gameserver/index.ts b/packages/app-mock-gameserver/src/lib/gameserver/index.ts
@@ -2,7 +2,15 @@ import { errors, logger } from '@takaro/util';
 import { Redis } from '@takaro/db';
 
 import { getSocketServer } from '../socket/index.js';
-import { IPlayerReferenceDTO, IGameServer, IMessageOptsDTO, CommandOutput, BanDTO, IItemDTO } from '@takaro/gameserver';
+import {
+  IPlayerReferenceDTO,
+  IGameServer,
+  IMessageOptsDTO,
+  CommandOutput,
+  BanDTO,
+  IItemDTO,
+  MapInfoDTO,
+} from '@takaro/gameserver';
 import {
   EventLogLine,
   GameEvents,
@@ -394,6 +402,21 @@ export class MockGameserver implements IMockGameServer {
   async shutdown() {
     await this.sendLog('Shutting down');
   }
+
+  async getMapInfo() {
+    return new MapInfoDTO({
+      enabled: false,
+      mapBlockSize: 100,
+      maxZoom: 5,
+      mapSizeX: 1000,
+      mapSizeY: 1000,
+      mapSizeZ: 1000,
+    });
+  }
+
+  async getMapTile(_x: number, _y: number, _z: number) {
+    return Buffer.from('mock-tile');
+  }
 }
 
 const cachedMockServer: Map<string, MockGameserver> = new Map();

diff --git a/packages/lib-gameserver/src/gameservers/7d2d/index.ts b/packages/lib-gameserver/src/gameservers/7d2d/index.ts
@@ -340,4 +340,12 @@ export class SevenDaysToDie implements IGameServer {
       await this.executeConsoleCommand('shutdown');
     }
   }
+
+  async getMapInfo() {
+    return this.apiClient.getMapInfo();
+  }
+
+  async getMapTile(x: number, y: number, z: number) {
+    return this.apiClient.getMapTile(x, y, z);
+  }
 }
diff --git a/packages/lib-gameserver/src/gameservers/7d2d/sdtdAPIClient.ts b/packages/lib-gameserver/src/gameservers/7d2d/sdtdAPIClient.ts
@@ -8,6 +8,7 @@ import {
   StatsResponse,
 } from './apiResponses.js';
 import { addCounterToAxios, errors } from '@takaro/util';
+import { MapInfoDTO } from '../../main.js';
 
 export class SdtdApiClient {
   private client: Axios;
@@ -77,4 +78,22 @@ export class SdtdApiClient {
   async getPlayerInventory(id: string): Promise<AxiosResponse<InventoryResponse>> {
     return this.client.get(`/api/getplayerinventory?userid=${id}`);
   }
+
+  async getMapInfo(): Promise<MapInfoDTO> {
+    const res = await this.client.get('/api/map/config');
+
+    return new MapInfoDTO({
+      enabled: res.data.data.enabled,
+      mapBlockSize: res.data.data.mapBlockSize,
+      maxZoom: res.data.data.maxZoom,
+      mapSizeX: res.data.data.mapSize.x,
+      mapSizeY: res.data.data.mapSize.y,
+      mapSizeZ: res.data.data.mapSize.z,
+    });
+  }
+
+  async getMapTile(x: number, y: number, z: number): Promise<Buffer> {
+    const res = await this.client.get(`/map/${z}/${x}/${y}.png?t=${Date.now() / 1000}`);
+    return res.data;
+  }
 }
diff --git a/packages/lib-gameserver/src/gameservers/mock/index.ts b/packages/lib-gameserver/src/gameservers/mock/index.ts
@@ -7,6 +7,7 @@ import {
   IItemDTO,
   IMessageOptsDTO,
   IPlayerReferenceDTO,
+  MapInfoDTO,
   TestReachabilityOutputDTO,
 } from '../../interfaces/GameServer.js';
 import { MockEmitter } from './emitter.js';
@@ -163,4 +164,19 @@ export class Mock implements IGameServer {
   async shutdown(): Promise<void> {
     return this.requestFromServer('shutdown');
   }
+
+  async getMapInfo(): Promise<MapInfoDTO> {
+    return new MapInfoDTO({
+      enabled: false,
+      mapBlockSize: 0,
+      maxZoom: 0,
+      mapSizeX: 0,
+      mapSizeY: 0,
+      mapSizeZ: 0,
+    });
+  }
+
+  async getMapTile(_x: number, _y: number, _z: number): Promise<Buffer> {
+    throw new Error('Not implemented');
+  }
 }
diff --git a/packages/lib-gameserver/src/gameservers/rust/index.ts b/packages/lib-gameserver/src/gameservers/rust/index.ts
@@ -7,6 +7,7 @@ import {
   IGameServer,
   IItemDTO,
   IPlayerReferenceDTO,
+  MapInfoDTO,
   TestReachabilityOutputDTO,
 } from '../../interfaces/GameServer.js';
 import { RustConnectionInfo } from './connectionInfo.js';
@@ -237,4 +238,19 @@ export class Rust implements IGameServer {
   async shutdown(): Promise<void> {
     await this.executeConsoleCommand('quit');
   }
+
+  async getMapInfo(): Promise<MapInfoDTO> {
+    return new MapInfoDTO({
+      enabled: false,
+      mapBlockSize: 0,
+      maxZoom: 0,
+      mapSizeX: 0,
+      mapSizeY: 0,
+      mapSizeZ: 0,
+    });
+  }
+
+  async getMapTile(_x: number, _y: number, _z: number): Promise<Buffer> {
+    throw new Error('Not implemented');
+  }
 }
diff --git a/packages/lib-gameserver/src/interfaces/GameServer.ts b/packages/lib-gameserver/src/interfaces/GameServer.ts
@@ -72,6 +72,21 @@ export class BanDTO extends TakaroDTO<BanDTO> {
   expiresAt: string | null;
 }
 
+export class MapInfoDTO extends TakaroDTO<MapInfoDTO> {
+  @IsBoolean()
+  enabled: boolean;
+  @IsNumber()
+  mapBlockSize: number;
+  @IsNumber()
+  maxZoom: number;
+  @IsNumber()
+  mapSizeX: number;
+  @IsNumber()
+  mapSizeY: number;
+  @IsNumber()
+  mapSizeZ: number;
+}
+
 export interface IGameServer {
   connectionInfo: unknown;
   getEventEmitter(): TakaroEmitter;
@@ -100,4 +115,7 @@ export interface IGameServer {
   unbanPlayer(player: IPlayerReferenceDTO): Promise<void>;
   listBans(): Promise<BanDTO[]>;
   shutdown(): Promise<void>;
+
+  getMapInfo(): Promise<MapInfoDTO>;
+  getMapTile(x: number, y: number, z: number): Promise<Buffer>;
 }