/* * Copyright 2022 James Lyne * * Some portions of this file were taken from https://github.com/webbukkit/dynmap. * These portions are Copyright 2020 Dynmap Contributors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { LiveAtlasMarker, LiveAtlasMarkerSet, LiveAtlasPlayer, LiveAtlasWorldDefinition } from "@/index"; import ChatError from "@/errors/ChatError"; import {MutationTypes} from "@/store/mutation-types"; import MapProvider from "@/providers/MapProvider"; import {ActionTypes} from "@/store/action-types"; import { buildAreas, buildCircles, buildComponents, buildLines, buildMarkers, buildMarkerSet, buildMessagesConfig, buildServerConfig, buildUpdates, buildWorlds } from "@/util/dynmap"; import {MarkerSet} from "dynmap"; import {DynmapUrlConfig} from "@/dynmap"; import ConfigurationError from "@/errors/ConfigurationError"; import {DynmapTileLayer} from "@/leaflet/tileLayer/DynmapTileLayer"; import {LiveAtlasTileLayer, LiveAtlasTileLayerOptions} from "@/leaflet/tileLayer/LiveAtlasTileLayer"; export default class DynmapMapProvider extends MapProvider { private configurationAbort?: AbortController = undefined; private markersAbort?: AbortController = undefined; private updateAbort?: AbortController = undefined; private updatesEnabled = false; private updateTimeout: null | ReturnType = null; private updateTimestamp: Date = new Date(); private updateInterval: number = 3000; private markerSets: Map = new Map(); private markers = new Map>(); constructor(config: DynmapUrlConfig) { super(config); this.validateConfig(); } private validateConfig() { if(typeof this.config !== 'undefined') { if (!this.config || this.config.constructor !== Object) { throw new ConfigurationError(`Dynmap configuration object missing`); } if (!this.config.configuration) { throw new ConfigurationError(`Dynmap configuration URL missing`); } if (!this.config.update) { throw new ConfigurationError(`Dynmap update URL missing`); } if (!this.config.markers) { throw new ConfigurationError(`Dynmap markers URL missing`); } if (!this.config.tiles) { throw new ConfigurationError(`Dynmap tiles URL missing`); } if (!this.config.sendmessage) { throw new ConfigurationError(`Dynmap sendmessage URL missing`); } } } private async getMarkerSets(world: LiveAtlasWorldDefinition): Promise { const url = `${this.config.markers}_markers_/marker_${world.name}.json`; if(this.markersAbort) { this.markersAbort.abort(); } this.markersAbort = new AbortController(); const response = await this.getJSON(url, this.markersAbort.signal); response.sets = response.sets || {}; for (const key in response.sets) { if (!Object.prototype.hasOwnProperty.call(response.sets, key)) { continue; } const set: MarkerSet = response.sets[key], markerSet = buildMarkerSet(key, set), markers = new Map(); buildMarkers(set.markers || {}, markers, this.config); buildAreas(set.areas || {}, markers); buildLines(set.lines || {}, markers); buildCircles(set.circles || {}, markers); this.markerSets.set(key, markerSet); this.markers.set(key, markers); } } async loadServerConfiguration(): Promise { if(this.configurationAbort) { this.configurationAbort.abort(); } this.configurationAbort = new AbortController(); const response = await this.getJSON(this.config.configuration, this.configurationAbort.signal); if (response.error) { throw new Error(response.error); } const config = buildServerConfig(response); this.updateInterval = response.updaterate || 3000; this.store.commit(MutationTypes.SET_SERVER_CONFIGURATION, config); this.store.commit(MutationTypes.SET_SERVER_CONFIGURATION_HASH, response.confighash || 0); this.store.commit(MutationTypes.SET_MAX_PLAYERS, response.maxcount || 0); this.store.commit(MutationTypes.SET_SERVER_MESSAGES, buildMessagesConfig(response)); this.store.commit(MutationTypes.SET_WORLDS, buildWorlds(response, this.config)); this.store.commit(MutationTypes.SET_COMPONENTS, buildComponents(response, this.config)); this.store.commit(MutationTypes.SET_LOGGED_IN, response.loggedin || false); } async populateWorld(world: LiveAtlasWorldDefinition): Promise { await this.getMarkerSets(world); this.store.commit(MutationTypes.SET_MARKER_SETS, this.markerSets); this.store.commit(MutationTypes.SET_MARKERS, this.markers); this.markerSets.clear(); this.markers.clear(); } createTileLayer(options: LiveAtlasTileLayerOptions): LiveAtlasTileLayer { return new DynmapTileLayer(options); } private async getUpdate(): Promise { let url = this.config.update; url = url.replace('{world}', this.store.state.currentWorld!.name); url = url.replace('{timestamp}', this.updateTimestamp.getTime().toString()); if(this.updateAbort) { this.updateAbort.abort(); } this.updateAbort = new AbortController(); const response = await this.getJSON(url, this.updateAbort.signal); const players: Set = new Set(), updates = buildUpdates(response.updates || [], this.updateTimestamp, this.config), worldState = { timeOfDay: response.servertime || 0, thundering: response.isThundering || false, raining: response.hasStorm || false, }; (response.players || []).forEach((player: any) => { const world = player.world && player.world !== '-some-other-bogus-world-' ? player.world : undefined; players.add({ name: player.account || "", displayName: player.name || "", health: player.health || 0, armor: player.armor || 0, sort: player.sort || 0, hidden: !world, location: { //Add 0.5 to position in the middle of a block x: !isNaN(player.x) ? player.x + 0.5 : 0, y: !isNaN(player.y) ? player.y : 0, z: !isNaN(player.z) ? player.z + 0.5 : 0, world: world, } }); }); //Extra fake players for testing // for(let i = 0; i < 450; i++) { // players.add({ // account: "VIDEO GAMES " + i, // health: Math.round(Math.random() * 10), // armor: Math.round(Math.random() * 10), // name: "VIDEO GAMES " + i, // sort: Math.round(Math.random() * 10), // hidden: false, // location: { // x: Math.round(Math.random() * 1000) - 500, // y: 64, // z: Math.round(Math.random() * 1000) - 500, // world: "world", // } // }); // } this.updateTimestamp = new Date(response.timestamp || 0); this.store.commit(MutationTypes.SET_WORLD_STATE, worldState); this.store.commit(MutationTypes.ADD_MARKER_SET_UPDATES, updates.markerSets); this.store.commit(MutationTypes.ADD_MARKER_UPDATES, updates.markers); this.store.commit(MutationTypes.ADD_TILE_UPDATES, updates.tiles); this.store.commit(MutationTypes.ADD_CHAT, updates.chat); if(response.confighash) { this.store.commit(MutationTypes.SET_SERVER_CONFIGURATION_HASH, response.confighash); } await this.store.dispatch(ActionTypes.SET_PLAYERS, players); } sendChatMessage(message: string) { if (!this.store.state.components.chatSending) { return Promise.reject(this.store.state.messages.chatErrorDisabled); } return fetch(this.config.sendmessage, { method: 'POST', credentials: 'include', body: JSON.stringify({ name: null, message: message, }) }).then((response) => { if (response.status === 403) { //Rate limited throw new ChatError(this.store.state.messages.chatErrorCooldown .replace('%interval%', this.store.state.components.chatSending!.cooldown.toString())); } if (!response.ok) { throw new Error('Network request failed'); } return response.json(); }).then(response => { if (response.error !== 'none') { throw new ChatError(this.store.state.messages.chatErrorNotAllowed); } }).catch(e => { if (!(e instanceof ChatError)) { console.error(this.store.state.messages.chatErrorUnknown); console.trace(e); } throw e; }); } startUpdates() { this.updatesEnabled = true; this.update(); } private async update() { try { await this.getUpdate(); } finally { if(this.updatesEnabled) { if(this.updateTimeout) { clearTimeout(this.updateTimeout); } this.updateTimeout = setTimeout(() => this.update(), this.updateInterval); } } } stopUpdates() { this.updatesEnabled = false; if (this.updateTimeout) { clearTimeout(this.updateTimeout); } this.updateTimeout = null; if(this.configurationAbort) { this.configurationAbort.abort(); } if(this.updateAbort) { this.updateAbort.abort(); } if(this.markersAbort) { this.markersAbort.abort(); } } async login(data: any) { if (!this.store.getters.loginEnabled) { return Promise.reject(this.store.state.messages.loginErrorDisabled); } this.store.commit(MutationTypes.SET_LOGGED_IN, false); try { const body = new URLSearchParams(); body.append('j_username', data.username || ''); body.append('j_password', data.password || ''); const response = await DynmapMapProvider.fetchJSON(this.config.login, { method: 'POST', body, }); switch(response.result) { case 'success': this.store.commit(MutationTypes.SET_LOGGED_IN, true); return; case 'loginfailed': return Promise.reject(this.store.state.messages.loginErrorIncorrect); default: return Promise.reject(this.store.state.messages.loginErrorUnknown); } } catch(e) { console.error(this.store.state.messages.loginErrorUnknown); console.trace(e); return Promise.reject(this.store.state.messages.loginErrorUnknown); } } async logout() { if (!this.store.getters.loginEnabled) { return Promise.reject(this.store.state.messages.loginErrorDisabled); } try { await DynmapMapProvider.fetchJSON(this.config.login, { method: 'POST', }); this.store.commit(MutationTypes.SET_LOGGED_IN, false); } catch(e) { return Promise.reject(this.store.state.messages.logoutErrorUnknown); } } async register(data: any) { if (!this.store.getters.loginEnabled) { return Promise.reject(this.store.state.messages.loginErrorDisabled); } this.store.commit(MutationTypes.SET_LOGGED_IN, false); try { const body = new URLSearchParams(); body.append('j_username', data.username || ''); body.append('j_password', data.password || ''); body.append('j_verify_password', data.password || ''); body.append('j_passcode', data.code || ''); const response = await DynmapMapProvider.fetchJSON(this.config.register, { method: 'POST', body, }); switch(response.result) { case 'success': this.store.commit(MutationTypes.SET_LOGGED_IN, true); return; case 'verifyfailed': return Promise.reject(this.store.state.messages.registerErrorVerifyFailed); case 'registerfailed': return Promise.reject(this.store.state.messages.registerErrorIncorrect); default: return Promise.reject(this.store.state.messages.registerErrorUnknown); } } catch(e) { console.error(this.store.state.messages.registerErrorUnknown); console.trace(e); return Promise.reject(this.store.state.messages.registerErrorUnknown); } } protected async getJSON(url: string, signal: AbortSignal) { return MapProvider.fetchJSON(url, {signal, credentials: 'include'}).then(response => { if(response.error === 'login-required') { this.store.commit(MutationTypes.SET_LOGIN_REQUIRED, true); throw new Error("Login required"); } return response; }); } }