// XAML Map Control - https://github.com/ClemensFischer/XAML-Map-Control // Copyright © 2023 Clemens Fischer // Licensed under the Microsoft Public License (Ms-PL) using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Diagnostics; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace MapControl { /// /// Loads and optionally caches map tile images for a MapTileLayer. /// public partial class TileImageLoader : ITileImageLoader { private class TileQueue : ConcurrentStack { public TileQueue(IEnumerable tiles) : base(tiles.Where(tile => tile.IsPending).Reverse()) { } public bool IsCanceled { get; private set; } public bool TryDequeue(out Tile tile) { if (IsCanceled || !TryPop(out tile)) { tile = null; return false; } tile.IsPending = false; return true; } public void Cancel() { IsCanceled = true; Clear(); } } /// /// Maximum number of parallel tile loading tasks. The default value is 4. /// public static int MaxLoadTasks { get; set; } = 4; /// /// Default expiration time for cached tile images. Used when no expiration time /// was transmitted on download. The default value is one day. /// public static TimeSpan DefaultCacheExpiration { get; set; } = TimeSpan.FromDays(1); /// /// Maximum expiration time for cached tile images. A transmitted expiration time /// that exceeds this value is ignored. The default value is ten days. /// public static TimeSpan MaxCacheExpiration { get; set; } = TimeSpan.FromDays(10); private TileQueue pendingTiles; /// /// Loads all unloaded tiles from the tiles collection. /// If tileSource.UriFormat starts with "http" and cacheName is a non-empty string, /// tile images will be cached in the TileImageLoader's Cache - if that is not null. /// public Task LoadTiles(IEnumerable tiles, TileSource tileSource, string cacheName, IProgress progress) { pendingTiles?.Cancel(); if (tiles != null && tileSource != null) { pendingTiles = new TileQueue(tiles); var numTasks = Math.Min(pendingTiles.Count, MaxLoadTasks); if (numTasks > 0) { if (Cache == null || tileSource.UriTemplate == null || !tileSource.UriTemplate.StartsWith("http")) { cacheName = null; // no tile caching } var progressLoaded = 0; var progressTotal = 0; if (progress != null) { progressTotal = pendingTiles.Count; progress.Report(0d); } async Task LoadPendingTiles() { while (pendingTiles.TryDequeue(out var tile)) { try { await LoadTile(tile, tileSource, cacheName).ConfigureAwait(false); } catch (Exception ex) { Debug.WriteLine($"TileImageLoader: {tile.ZoomLevel}/{tile.Column}/{tile.Row}: {ex.Message}"); } if (progress != null && !pendingTiles.IsCanceled) { Interlocked.Increment(ref progressLoaded); progress.Report((double)progressLoaded / progressTotal); } } } return Task.WhenAll(Enumerable.Range(0, numTasks).Select(_ => Task.Run(LoadPendingTiles))); } } return Task.CompletedTask; } private static Task LoadTile(Tile tile, TileSource tileSource, string cacheName) { if (string.IsNullOrEmpty(cacheName)) { return LoadTile(tile, () => tileSource.LoadImageAsync(tile.Column, tile.Row, tile.ZoomLevel)); } var uri = tileSource.GetUri(tile.Column, tile.Row, tile.ZoomLevel); if (uri != null) { var extension = Path.GetExtension(uri.LocalPath); if (string.IsNullOrEmpty(extension) || extension == ".jpeg") { extension = ".jpg"; } var cacheKey = string.Format(CultureInfo.InvariantCulture, "{0}/{1}/{2}/{3}{4}", cacheName, tile.ZoomLevel, tile.Column, tile.Row, extension); return LoadCachedTile(tile, uri, cacheKey); } return Task.CompletedTask; } private static DateTime GetExpiration(TimeSpan? maxAge) { if (!maxAge.HasValue) { maxAge = DefaultCacheExpiration; } else if (maxAge.Value > MaxCacheExpiration) { maxAge = MaxCacheExpiration; } return DateTime.UtcNow.Add(maxAge.Value); } } }