using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using System.Text.RegularExpressions; using System.Threading; using Hjg.Pngcs; using Hjg.Pngcs.Chunks; using Newtonsoft.Json; using Vintagestory.API.Client; using Vintagestory.API.Common; using Vintagestory.API.Config; using Vintagestory.API.Datastructures; using Vintagestory.API.MathTools; using Vintagestory.Common; namespace Automap { public class AutomapSystem { private Thread cartographer_thread; private ICoreClientAPI ClientAPI { get; set; } private ILogger Logger { get; set; } private IChunkRenderer ChunkRenderer { get; set; } private const string _mapPath = @"Maps"; private const string _chunkPath = @"Chunks"; private const string _domain = @"automap"; private const string chunkFile_filter = @"*_*.png"; private static Regex chunkShardRegex = new Regex(@"(?[\d]+)_(?[\d]+).png", RegexOptions.Singleline); private ConcurrentDictionary columnCounter = new ConcurrentDictionary(3, 150); private ColumnsMetadata chunkTopMetadata; private PointsOfInterest POIs = new PointsOfInterest(); private EntitiesOfInterest EOIs = new EntitiesOfInterest(); internal Dictionary BlockID_Designators { get; private set; } internal Dictionary Entity_Designators { get; private set; } internal Dictionary RockIdCodes { get; private set; } internal RunState CurrentState { get; set; } //Run status, Chunks processed, stats, center of map.... private uint nullChunkCount, updatedChunksTotal; private Vec2i startChunkColumn; private readonly int chunkSize; private string path; private IAsset staticMap; public static string AutomapStatusEventKey = @"AutomapStatus"; public static string AutomapCommandEventKey = @"AutomapCommand"; public AutomapSystem(ICoreClientAPI clientAPI, ILogger logger) { this.ClientAPI = clientAPI; this.Logger = logger; chunkSize = ClientAPI.World.BlockAccessor.ChunkSize; ClientAPI.Event.LevelFinalize += EngageAutomap; //TODO:Choose which one from GUI this.ChunkRenderer = new StandardRenderer(clientAPI, logger); //Listen on bus for commands ClientAPI.Event.RegisterEventBusListener(CommandListener, 1.0, AutomapSystem.AutomapCommandEventKey); } #region Internals private void EngageAutomap() { path = ClientAPI.GetOrCreateDataPath(_mapPath); path = ClientAPI.GetOrCreateDataPath(Path.Combine(path, "World_" + ClientAPI.World.Seed));//Add name of World too...'ServerApi.WorldManager.CurrentWorldName' string mapFilename = Path.Combine(path, "automap.html"); StreamWriter outputText = new StreamWriter(File.Open(mapFilename, FileMode.Create, FileAccess.Write, FileShare.ReadWrite)); staticMap = ClientAPI.World.AssetManager.Get(new AssetLocation(_domain, "config/automap.html")); outputText.Write(staticMap.ToText()); outputText.Flush(); Prefill_POI_Designators(); startChunkColumn = new Vec2i((ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.X / chunkSize), (ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.Z / chunkSize)); chunkTopMetadata = new ColumnsMetadata(startChunkColumn); Logger.Notification("AUTOMAP Start {0}", startChunkColumn); Reload_Metadata(); ClientAPI.Event.ChunkDirty += ChunkAChanging; cartographer_thread = new Thread(Cartographer) { Name = "Cartographer", Priority = ThreadPriority.Lowest, IsBackground = true }; ClientAPI.Event.RegisterGameTickListener(AwakenCartographer, 6000); } private void ChunkAChanging(Vec3i chunkCoord, IWorldChunk chunk, EnumChunkDirtyReason reason) { Vec2i topPosition = new Vec2i(chunkCoord.X, chunkCoord.Z); columnCounter.AddOrUpdate(topPosition, 1, (key, colAct) => colAct + 1); } private void AwakenCartographer(float delayed) { if (CurrentState == RunState.Run && (ClientAPI.IsGamePaused != false || ClientAPI.IsShuttingDown != true)) { #if DEBUG Logger.VerboseDebug("Cartographer re-trigger from [{0}]", cartographer_thread.ThreadState); #endif if (cartographer_thread.ThreadState.HasFlag(ThreadState.Unstarted)) { cartographer_thread.Start(); } else if (cartographer_thread.ThreadState.HasFlag(ThreadState.WaitSleepJoin)) { //Time to (re)write chunk shards cartographer_thread.Interrupt(); } //#if DEBUG //ClientAPI.TriggerChatMessage($"Automap {updatedChunksTotal} Updates - MAX (N:{chunkTopMetadata.North_mostChunk},S:{chunkTopMetadata.South_mostChunk},E:{chunkTopMetadata.East_mostChunk}, W:{chunkTopMetadata.West_mostChunk} - TOTAL: {chunkTopMetadata.Count})"); //#endif } else if (CurrentState == RunState.Snapshot) { //TODO: Snapshot generator second thread... } } private void Cartographer() { wake: Logger.VerboseDebug("Cartographer thread awoken"); try { uint ejectedItem = 0; uint updatedChunks = 0; uint updatedPixels = 0; //-- Should dodge enumerator changing underfoot....at a cost. if (!columnCounter.IsEmpty) { var tempSet = columnCounter.ToArray().OrderByDescending(kvp => kvp.Value); foreach (var mostActiveCol in tempSet) { var mapChunk = ClientAPI.World.BlockAccessor.GetMapChunk(mostActiveCol.Key); if (mapChunk == null) { Logger.Warning("SKIP CHUNK: ({0}) - Map Chunk NULL!", mostActiveCol.Key); nullChunkCount++; columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem); continue; } ColumnMeta chunkMeta; if (chunkTopMetadata.Contains(mostActiveCol.Key)) { chunkMeta = chunkTopMetadata[mostActiveCol.Key]; } else { chunkMeta = CreateColumnMetadata(mostActiveCol, mapChunk); } UpdateEntityMetadata(); ProcessChunkBlocks(mostActiveCol.Key, mapChunk, chunkMeta); PngWriter pngWriter = SetupPngImage(mostActiveCol.Key, chunkMeta); ChunkRenderer.GenerateChunkPngShard(mostActiveCol.Key, mapChunk, chunkMeta, pngWriter, out updatedPixels); if (updatedPixels > 0) { #if DEBUG Logger.VerboseDebug("Wrote chunk shard: ({0}) - Edits#:{1}, Pixels#:{2}", mostActiveCol.Key, mostActiveCol.Value, updatedPixels); #endif updatedChunks++; chunkTopMetadata.Update(chunkMeta); columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem); } else { columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem); Logger.VerboseDebug("Un-painted chunk: ({0}) ", mostActiveCol.Key); } } } UpdateStatus(this.updatedChunksTotal, this.nullChunkCount, updatedChunks); if (updatedChunks > 0) { //What about chunk updates themselves; a update bitmap isn't kept... updatedChunksTotal += updatedChunks; GenerateJSONMetadata(); updatedChunks = 0; } //Then sleep until interupted again, and repeat Logger.VerboseDebug("Thread '{0}' about to sleep indefinitely.", Thread.CurrentThread.Name); Thread.Sleep(Timeout.Infinite); } catch (ThreadInterruptedException) { Logger.VerboseDebug("Thread '{0}' interupted [awoken]", Thread.CurrentThread.Name); goto wake; } catch (ThreadAbortException) { Logger.VerboseDebug("Thread '{0}' aborted.", Thread.CurrentThread.Name); } finally { Logger.VerboseDebug("Thread '{0}' executing finally block.", Thread.CurrentThread.Name); } } private void UpdateStatus(uint totalUpdates, uint voidChunks, uint delta) { StatusData updateData = new StatusData(totalUpdates, voidChunks, delta, RunState.Run); this.ClientAPI.Event.PushEvent(AutomapStatusEventKey, updateData); } private void Prefill_POI_Designators() { this.BlockID_Designators = new Dictionary(); this.Entity_Designators = new Dictionary(); this.RockIdCodes = Helpers.ArbitrarytBlockIdHunter(ClientAPI, new AssetLocation(GlobalConstants.DefaultDomain, "rock"), EnumBlockMaterial.Stone); //Add special marker types for BlockID's of "Interest", overwrite colour, and method Install_POI_Designators(DefaultDesignators.DefaultBlockDesignators(), DefaultDesignators.DefaultEntityDesignators()); } private void Install_POI_Designators(ICollection blockDesig, List entDesig) { Logger.VerboseDebug("Connecting {0} standard Block-Designators", blockDesig.Count); foreach (var designator in blockDesig) { var blockIDs = Helpers.ArbitrarytBlockIdHunter(ClientAPI, designator.Pattern, designator.Material); if (blockIDs.Count > 0) { Logger.VerboseDebug("Designator {0} has {1} associated blockIDs", designator.ToString(), blockIDs.Count); } foreach (var entry in blockIDs) { BlockID_Designators.Add(entry.Key, designator); } } this.ChunkRenderer.BlockID_Designators = BlockID_Designators; Logger.VerboseDebug("Connecting {0} standard Entity-Designators", entDesig.Count); foreach (var designator in entDesig) { //Get Variants first, from EntityTypes...better be populated! var matched = ClientAPI.World.EntityTypes.FindAll(entp => entp.Code.BeginsWith(designator.Pattern.Domain, designator.Pattern.Path)); foreach (var match in matched) { Logger.VerboseDebug("Linked Entity: {0} Designator: {1}", match.Code, designator); this.Entity_Designators.Add(match.Code, designator); } //EntityProperties props = ClientAPI.World.GetEntityType(designator.Pattern); } } /// /// Generates the JSON Metadata. (in Map object format ) /// private void GenerateJSONMetadata() { string jsonFilename = Path.Combine(path, "Metadata.js"); StreamWriter jsonWriter = new StreamWriter(jsonFilename, false, Encoding.UTF8); using (jsonWriter) { jsonWriter.Write("ViewFrame.chunks={};"); jsonWriter.Write("ViewFrame.chunks.worldSeedNum={0};", ClientAPI.World.Seed); jsonWriter.Write("ViewFrame.chunks.genTime=new Date('{0}');", DateTimeOffset.UtcNow.ToString("O")); jsonWriter.Write("ViewFrame.chunks.startCoords=[{0},{1}];", startChunkColumn.X, startChunkColumn.Y); jsonWriter.Write("ViewFrame.chunks.chunkSize={0};", chunkSize); jsonWriter.Write("ViewFrame.chunks.northMostChunk={0};", chunkTopMetadata.North_mostChunk); jsonWriter.Write("ViewFrame.chunks.southMostChunk={0};", chunkTopMetadata.South_mostChunk); jsonWriter.Write("ViewFrame.chunks.eastMostChunk={0};", chunkTopMetadata.East_mostChunk); jsonWriter.Write("ViewFrame.chunks.westMostChunk={0};", chunkTopMetadata.West_mostChunk); //MAP object format - [key, value]: key is "x_y" jsonWriter.Write("ViewFrame.chunks.chunkMetadata=new Map(["); foreach (var shard in chunkTopMetadata) { jsonWriter.Write("['{0}_{1}',", shard.Location.X, shard.Location.Y); jsonWriter.Write("{"); jsonWriter.Write("prettyCoord:'{0}',", shard.Location.PrettyCoords(ClientAPI)); jsonWriter.Write("chunkAge:'{0}',", shard.ChunkAge.ToString("g"));//World age - relative? or last edit ?? jsonWriter.Write("temp:'{0}',", shard.Temperature.ToString("F1")); jsonWriter.Write("YMax:'{0}',", shard.YMax); jsonWriter.Write("fert:'{0}',", shard.Fertility.ToString("F1")); jsonWriter.Write("forestDens:'{0}',", shard.ForestDensity.ToString("F1")); jsonWriter.Write("rain:'{0}',", shard.Rainfall.ToString("F1")); jsonWriter.Write("shrubDens:'{0}',", shard.ShrubDensity.ToString("F1")); jsonWriter.Write("airBlocks:'{0}',", shard.AirBlocks); jsonWriter.Write("nonAirBlocks:'{0}',", shard.NonAirBlocks); //TODO: Heightmap //TODO: Rock-ratio, also requires a BlockID => Name lookup table....elsewhere jsonWriter.Write("}],"); } jsonWriter.Write("]);"); jsonWriter.Write("ViewFrame.chunks.pointsOfInterest = new Map(["); foreach (var poi in POIs) { jsonWriter.Write("['{0}_{1}',", poi.Location.X, poi.Location.Z); jsonWriter.Write("{"); jsonWriter.Write("prettyCoord:'{0}',", poi.Location.PrettyCoords(ClientAPI)); jsonWriter.Write("notes:{0},", JsonConvert.ToString(poi.Notes, '\'', StringEscapeHandling.EscapeHtml)); jsonWriter.Write("time:new Date('{0}'),", poi.Timestamp.ToString("O")); jsonWriter.Write("chunkPos:'{0}_{1}',", (poi.Location.X / chunkSize), (poi.Location.Z / chunkSize)); jsonWriter.Write("}],"); } foreach (var poi in EOIs) { jsonWriter.Write("['{0}_{1}',", poi.Location.X, poi.Location.Z); jsonWriter.Write("{"); jsonWriter.Write("prettyCoord:'{0}',", poi.Location.PrettyCoords(ClientAPI)); jsonWriter.Write("notes:{0},", JsonConvert.ToString(poi.Notes, '\'', StringEscapeHandling.EscapeHtml)); jsonWriter.Write("time:new Date('{0}'),", poi.Timestamp.ToString("O")); jsonWriter.Write("chunkPos:'{0}_{1}',", (poi.Location.X / chunkSize), (poi.Location.Z / chunkSize)); jsonWriter.Write("}],"); } jsonWriter.Write("]);"); jsonWriter.Flush(); } } private ColumnMeta CreateColumnMetadata(KeyValuePair mostActiveCol, IMapChunk mapChunk) { ColumnMeta data = new ColumnMeta(mostActiveCol.Key.Copy(), ( byte )chunkSize); BlockPos equivBP = new BlockPos(mostActiveCol.Key.X * chunkSize, mapChunk.YMax, mostActiveCol.Key.Y * chunkSize); var climate = ClientAPI.World.BlockAccessor.GetClimateAt(equivBP); data.UpdateFieldsFrom(climate, mapChunk, TimeSpan.FromHours(ClientAPI.World.Calendar.TotalHours)); return data; } /// /// Reload chunk bounds from chunk shards /// /// The metadata. private void Reload_Metadata() { var worldmapDir = new DirectoryInfo(path); if (worldmapDir.Exists) { var files = worldmapDir.GetFiles(chunkFile_filter); if (files.Length > 0) { #if DEBUG Logger.VerboseDebug("{0} Existing world chunk shards", files.Length); #endif foreach (var shardFile in files) { if (shardFile.Length < 1024) continue; var result = chunkShardRegex.Match(shardFile.Name); if (result.Success) { int X_chunk_pos = int.Parse(result.Groups["X"].Value); int Z_chunk_pos = int.Parse(result.Groups["Z"].Value); try { using (var fileStream = shardFile.OpenRead( )) { PngReader pngRead = new PngReader(fileStream); pngRead.ReadSkippingAllRows( ); pngRead.End( ); //Parse PNG chunks for METADATA in shard PngMetadataChunk metadataFromPng = pngRead.GetChunksList( ).GetById1(PngMetadataChunk.ID) as PngMetadataChunk; chunkTopMetadata.Add(metadataFromPng.ChunkMetadata); } } catch (PngjException someEx) { Logger.Error("PNG Corruption file '{0}' - Reason: {1}", shardFile.Name, someEx); continue; } } } } } else { #if DEBUG Logger.VerboseDebug("Could not open world map directory"); #endif } } private PngWriter SetupPngImage(Vec2i coord, ColumnMeta metadata) { ImageInfo imageInf = new ImageInfo(chunkSize, chunkSize, 8, false); string filename = $"{coord.X}_{coord.Y}.png"; filename = Path.Combine(path, filename); PngWriter pngWriter = FileHelper.CreatePngWriter(filename, imageInf, true); PngMetadata meta = pngWriter.GetMetadata(); meta.SetTimeNow(); meta.SetText("Chunk_X", coord.X.ToString("D")); meta.SetText("Chunk_Y", coord.Y.ToString("D")); //Setup specialized meta-data PNG chunks here... PngMetadataChunk pngChunkMeta = new PngMetadataChunk(pngWriter.ImgInfo) { ChunkMetadata = metadata }; pngWriter.GetChunksList().Queue(pngChunkMeta); pngWriter.CompLevel = 9;// 9 is the maximum compression pngWriter.CompressionStrategy = Hjg.Pngcs.Zlib.EDeflateCompressStrategy.Huffman; return pngWriter; } /// /// Does the heavy lifting of Scanning columns of chunks - scans for BlockEntity, creates Heightmap and stats... /// /// Chunk Coordinate /// Map chunk. /// Chunk metadata private void ProcessChunkBlocks(Vec2i key, IMapChunk mapChunk, ColumnMeta chunkMeta) { int targetChunkY = mapChunk.YMax / chunkSize;//Surface ... for (; targetChunkY > 0; targetChunkY--) { WorldChunk chunkData = ClientAPI.World.BlockAccessor.GetChunk(key.X, targetChunkY, key.Y) as WorldChunk; if (chunkData == null || chunkData.BlockEntities == null) { #if DEBUG Logger.VerboseDebug("Chunk null or empty X{0} Y{1} Z{2}", key.X, targetChunkY, key.Y); #endif continue; } /*************** Chunk Entities Scanning *********************/ if (chunkData.BlockEntities != null && chunkData.BlockEntities.Length > 0) { #if DEBUG Logger.VerboseDebug("Surface@ {0} = BlockEntities: {1}", key, chunkData.BlockEntities.Length); #endif foreach (var blockEnt in chunkData.BlockEntities) { if (blockEnt != null && blockEnt.Block != null && BlockID_Designators.ContainsKey(blockEnt.Block.BlockId)) { var designator = BlockID_Designators[blockEnt.Block.BlockId]; designator.SpecialAction(ClientAPI, POIs, blockEnt.Pos.Copy(), blockEnt.Block); } } } /********************* Chunk/Column BLOCKs scanning ****************/ //Heightmap, Stats, block tally chunkData.Unpack(); int X_index, Y_index, Z_index; X_index = Y_index = Z_index = 0; do { do { do { /* Encode packed indicie (y * chunksize + z) * chunksize + x */ var indicie = Helpers.ChunkBlockIndicie16(X_index, Y_index, Z_index); int aBlockId = chunkData.Blocks[indicie]; if (aBlockId == 0) {//Air chunkMeta.AirBlocks++; continue; } if (RockIdCodes.ContainsKey(aBlockId)) { if (chunkMeta.RockRatio.ContainsKey(aBlockId)) { chunkMeta.RockRatio[aBlockId]++; } else { chunkMeta.RockRatio.Add(aBlockId, 1); } } chunkMeta.NonAirBlocks++; //Heightmap if (chunkMeta.HeightMap[X_index, Z_index] == 0) { chunkMeta.HeightMap[X_index, Z_index] = (ushort) (Y_index + (targetChunkY * chunkSize)); } } while (X_index++ < (chunkSize - 1)); X_index = 0; } while (Z_index++ < (chunkSize - 1)); Z_index = 0; } while (Y_index++ < (chunkSize - 1)); } } private void UpdateEntityMetadata() { Logger.Debug("Presently {0} Entities", ClientAPI.World.LoadedEntities.Count); //Mabey scan only for 'new' entities by tracking ID in set? foreach (var loadedEntity in ClientAPI.World.LoadedEntities.ToList()) { #if DEBUG //Logger.VerboseDebug($"ENTITY: ({loadedEntity.Value.Code}) = #{loadedEntity.Value.EntityId} {loadedEntity.Value.State} {loadedEntity.Value.LocalPos} <<<<<<<<<<<<"); #endif var dMatch = Entity_Designators.SingleOrDefault(se => se.Key.Equals(loadedEntity.Value.Code)); if (dMatch.Value != null) { dMatch.Value.SpecialAction(ClientAPI, this.EOIs, loadedEntity.Value.LocalPos.AsBlockPos.Copy(), loadedEntity.Value); } } } private void AddNote(string notation) { var playerNodePoi = new PointOfInterest() { Location = ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.Copy(), Notes = notation, Timestamp = DateTimeOffset.UtcNow, }; this.POIs.AddReplace(playerNodePoi); } private void CommandListener(string eventName, ref EnumHandling handling, IAttribute data) { Logger.VerboseDebug("MsgBus RX: AutomapCommandMsg: {0}", data.ToJsonToken()); CommandData cmdData = data as CommandData; if (CurrentState != RunState.Snapshot) { switch (cmdData.State) { case RunState.Run: CurrentState = cmdData.State; AwakenCartographer(0.0f); break; case RunState.Stop: CurrentState = cmdData.State; break; case RunState.Snapshot: CurrentState = RunState.Stop; //Snapshot starts a second thread/process... break; case RunState.Notation: //Add to POI list where player location AddNote(cmdData.Notation); break; } } if (CurrentState != cmdData.State) { CurrentState = cmdData.State; AwakenCartographer(0.0f); } #if DEBUG Logger.VerboseDebug($"Automap commanded to: {cmdData.State} "); #endif } #endregion } }