mirror of
https://github.com/ClemensFischer/XAML-Map-Control.git
synced 2026-04-05 22:46:58 +00:00
Use IDistributedCache on all platforms
This commit is contained in:
ClemensFischer
parent
16115413d8
commit
c12e929fcc
39 changed files with 773 additions and 1686 deletions
|
|
@ -1,21 +1,22 @@
|
|||
// XAML Map Control - https://github.com/ClemensFischer/XAML-Map-Control
|
||||
// Copyright © 2023 Clemens Fischer
|
||||
// Copyright © 2024 Clemens Fischer
|
||||
// Licensed under the Microsoft Public License (Ms-PL)
|
||||
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using System;
|
||||
using System.Diagnostics;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace MapControl.Caching
|
||||
{
|
||||
/// <summary>
|
||||
/// Image Cache implementation based on local image files.
|
||||
/// The only valid data type for cached values is Tuple<byte[], DateTime>.
|
||||
/// IDistributedCache implementation based on local image files.
|
||||
/// </summary>
|
||||
public partial class ImageFileCache
|
||||
public class ImageFileCache : IDistributedCache
|
||||
{
|
||||
private const string expiresTag = "EXPIRES:";
|
||||
|
||||
|
|
@ -38,6 +39,155 @@ namespace MapControl.Caching
|
|||
return Task.Factory.StartNew(CleanRootDirectory, TaskCreationOptions.LongRunning);
|
||||
}
|
||||
|
||||
public byte[] Get(string key)
|
||||
{
|
||||
byte[] buffer = null;
|
||||
var path = GetPath(key);
|
||||
|
||||
try
|
||||
{
|
||||
if (path != null && File.Exists(path))
|
||||
{
|
||||
buffer = File.ReadAllBytes(path);
|
||||
|
||||
CheckExpiration(path, ref buffer);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"ImageFileCache: Failed reading {path}: {ex.Message}");
|
||||
}
|
||||
|
||||
return buffer;
|
||||
}
|
||||
|
||||
public async Task<byte[]> GetAsync(string key, CancellationToken token = default)
|
||||
{
|
||||
byte[] buffer = null;
|
||||
var path = GetPath(key);
|
||||
|
||||
try
|
||||
{
|
||||
if (path != null && File.Exists(path))
|
||||
{
|
||||
#if NETFRAMEWORK
|
||||
using (var stream = File.OpenRead(path))
|
||||
{
|
||||
buffer = new byte[stream.Length];
|
||||
var offset = 0;
|
||||
while (offset < buffer.Length)
|
||||
{
|
||||
offset += await stream.ReadAsync(buffer, offset, buffer.Length - offset, token).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
#else
|
||||
buffer = await File.ReadAllBytesAsync(path, token).ConfigureAwait(false);
|
||||
#endif
|
||||
CheckExpiration(path, ref buffer);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"ImageFileCache: Failed reading {path}: {ex.Message}");
|
||||
}
|
||||
|
||||
return buffer;
|
||||
}
|
||||
|
||||
public void Set(string key, byte[] buffer, DistributedCacheEntryOptions options)
|
||||
{
|
||||
var path = GetPath(key);
|
||||
|
||||
if (path != null && buffer != null && buffer.Length > 0)
|
||||
{
|
||||
try
|
||||
{
|
||||
Directory.CreateDirectory(Path.GetDirectoryName(path));
|
||||
|
||||
using (var stream = File.Create(path))
|
||||
{
|
||||
stream.Write(buffer, 0, buffer.Length);
|
||||
|
||||
var expiration = GetExpiration(options);
|
||||
|
||||
if (expiration.HasValue)
|
||||
{
|
||||
stream.Write(Encoding.ASCII.GetBytes(expiresTag), 0, 8);
|
||||
stream.Write(BitConverter.GetBytes(expiration.Value.Ticks), 0, 8);
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"ImageFileCache: Failed writing {path}: {ex.Message}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public async Task SetAsync(string key, byte[] buffer, DistributedCacheEntryOptions options, CancellationToken token = default)
|
||||
{
|
||||
var path = GetPath(key);
|
||||
|
||||
if (path != null && buffer != null && buffer.Length > 0)
|
||||
{
|
||||
try
|
||||
{
|
||||
Directory.CreateDirectory(Path.GetDirectoryName(path));
|
||||
|
||||
using (var stream = File.Create(path))
|
||||
{
|
||||
await stream.WriteAsync(buffer, 0, buffer.Length).ConfigureAwait(false);
|
||||
|
||||
var expiration = GetExpiration(options);
|
||||
|
||||
if (expiration.HasValue)
|
||||
{
|
||||
await stream.WriteAsync(Encoding.ASCII.GetBytes(expiresTag), 0, 8).ConfigureAwait(false);
|
||||
await stream.WriteAsync(BitConverter.GetBytes(expiration.Value.Ticks), 0, 8).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"ImageFileCache: Failed writing {path}: {ex.Message}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void Refresh(string key)
|
||||
{
|
||||
throw new NotSupportedException();
|
||||
}
|
||||
|
||||
public Task RefreshAsync(string key, CancellationToken token = default)
|
||||
{
|
||||
throw new NotSupportedException();
|
||||
}
|
||||
|
||||
public void Remove(string key)
|
||||
{
|
||||
var path = GetPath(key);
|
||||
|
||||
try
|
||||
{
|
||||
if (path != null && File.Exists(path))
|
||||
{
|
||||
File.Delete(path);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"ImageFileCache: Failed deleting {path}: {ex.Message}");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public Task RemoveAsync(string key, CancellationToken token = default)
|
||||
{
|
||||
Remove(key);
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
private string GetPath(string key)
|
||||
{
|
||||
try
|
||||
|
|
@ -101,7 +251,9 @@ namespace MapControl.Caching
|
|||
|
||||
try
|
||||
{
|
||||
if (ReadExpiration(file) < DateTime.UtcNow)
|
||||
var expiration = ReadExpiration(file);
|
||||
|
||||
if (expiration.HasValue && expiration.Value <= DateTimeOffset.UtcNow)
|
||||
{
|
||||
file.Delete();
|
||||
deletedFileCount = 1;
|
||||
|
|
@ -115,9 +267,40 @@ namespace MapControl.Caching
|
|||
return deletedFileCount;
|
||||
}
|
||||
|
||||
private static DateTime ReadExpiration(FileInfo file)
|
||||
private static DateTimeOffset? GetExpiration(DistributedCacheEntryOptions options)
|
||||
{
|
||||
DateTime? expiration = null;
|
||||
DateTimeOffset? expiration = null;
|
||||
|
||||
if (options.AbsoluteExpiration.HasValue)
|
||||
{
|
||||
expiration = options.AbsoluteExpiration.Value;
|
||||
}
|
||||
else if (options.AbsoluteExpirationRelativeToNow.HasValue)
|
||||
{
|
||||
expiration = DateTimeOffset.UtcNow.Add(options.AbsoluteExpirationRelativeToNow.Value);
|
||||
}
|
||||
else if (options.SlidingExpiration.HasValue)
|
||||
{
|
||||
expiration = DateTimeOffset.UtcNow.Add(options.SlidingExpiration.Value);
|
||||
}
|
||||
|
||||
return expiration;
|
||||
}
|
||||
|
||||
private static void CheckExpiration(string path, ref byte[] buffer)
|
||||
{
|
||||
var expiration = ReadExpiration(ref buffer);
|
||||
|
||||
if (expiration.HasValue && expiration.Value <= DateTimeOffset.UtcNow)
|
||||
{
|
||||
File.Delete(path);
|
||||
buffer = null;
|
||||
}
|
||||
}
|
||||
|
||||
private static DateTimeOffset? ReadExpiration(FileInfo file)
|
||||
{
|
||||
DateTimeOffset? expiration = null;
|
||||
|
||||
if (file.Length > 16)
|
||||
{
|
||||
|
|
@ -134,46 +317,32 @@ namespace MapControl.Caching
|
|||
}
|
||||
}
|
||||
|
||||
return expiration ?? DateTime.Today;
|
||||
return expiration;
|
||||
}
|
||||
|
||||
private static DateTime ReadExpiration(ref byte[] buffer)
|
||||
private static DateTimeOffset? ReadExpiration(ref byte[] buffer)
|
||||
{
|
||||
DateTime? expiration = ReadExpiration(buffer);
|
||||
var expiration = ReadExpiration(buffer);
|
||||
|
||||
if (expiration.HasValue)
|
||||
{
|
||||
Array.Resize(ref buffer, buffer.Length - 16);
|
||||
|
||||
return expiration.Value;
|
||||
}
|
||||
|
||||
return DateTime.Today;
|
||||
}
|
||||
|
||||
private static DateTime? ReadExpiration(byte[] buffer)
|
||||
{
|
||||
DateTime? expiration = null;
|
||||
|
||||
if (buffer.Length >= 16 &&
|
||||
Encoding.ASCII.GetString(buffer, buffer.Length - 16, 8) == expiresTag)
|
||||
{
|
||||
expiration = new DateTime(BitConverter.ToInt64(buffer, buffer.Length - 8), DateTimeKind.Utc);
|
||||
}
|
||||
|
||||
return expiration;
|
||||
}
|
||||
|
||||
private static void WriteExpiration(Stream stream, DateTime expiration)
|
||||
private static DateTimeOffset? ReadExpiration(byte[] buffer)
|
||||
{
|
||||
stream.Write(Encoding.ASCII.GetBytes(expiresTag), 0, 8);
|
||||
stream.Write(BitConverter.GetBytes(expiration.Ticks), 0, 8);
|
||||
}
|
||||
DateTimeOffset? expiration = null;
|
||||
|
||||
private static async Task WriteExpirationAsync(Stream stream, DateTime expiration)
|
||||
{
|
||||
await stream.WriteAsync(Encoding.ASCII.GetBytes(expiresTag), 0, 8);
|
||||
await stream.WriteAsync(BitConverter.GetBytes(expiration.Ticks), 0, 8);
|
||||
if (buffer.Length >= 16 &&
|
||||
Encoding.ASCII.GetString(buffer, buffer.Length - 16, 8) == expiresTag)
|
||||
{
|
||||
expiration = new DateTimeOffset(BitConverter.ToInt64(buffer, buffer.Length - 8), TimeSpan.Zero);
|
||||
}
|
||||
|
||||
return expiration;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
// Copyright © 2023 Clemens Fischer
|
||||
// Licensed under the Microsoft Public License (Ms-PL)
|
||||
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using System;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Collections.Generic;
|
||||
|
|
@ -39,9 +40,9 @@ namespace MapControl
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maximum number of parallel tile loading tasks. The default value is 4.
|
||||
/// An IDistributedCache implementation used to cache tile images.
|
||||
/// </summary>
|
||||
public static int MaxLoadTasks { get; set; } = 4;
|
||||
public static IDistributedCache Cache { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Default expiration time for cached tile images. Used when no expiration time
|
||||
|
|
@ -55,6 +56,12 @@ namespace MapControl
|
|||
/// </summary>
|
||||
public static TimeSpan MaxCacheExpiration { get; set; } = TimeSpan.FromDays(10);
|
||||
|
||||
/// <summary>
|
||||
/// Maximum number of parallel tile loading tasks. The default value is 4.
|
||||
/// </summary>
|
||||
public static int MaxLoadTasks { get; set; } = 4;
|
||||
|
||||
|
||||
private TileQueue pendingTiles;
|
||||
|
||||
/// <summary>
|
||||
|
|
@ -125,34 +132,55 @@ namespace MapControl
|
|||
|
||||
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 LoadCachedTileAsync(tile, uri, cacheKey);
|
||||
return LoadCachedTileAsync(tile, uri, cacheName);
|
||||
}
|
||||
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
private static DateTime GetExpiration(TimeSpan? maxAge)
|
||||
private static async Task LoadCachedTileAsync(Tile tile, Uri uri, string cacheName)
|
||||
{
|
||||
if (!maxAge.HasValue)
|
||||
var extension = Path.GetExtension(uri.LocalPath);
|
||||
|
||||
if (string.IsNullOrEmpty(extension) || extension == ".jpeg")
|
||||
{
|
||||
maxAge = DefaultCacheExpiration;
|
||||
}
|
||||
else if (maxAge.Value > MaxCacheExpiration)
|
||||
{
|
||||
maxAge = MaxCacheExpiration;
|
||||
extension = ".jpg";
|
||||
}
|
||||
|
||||
return DateTime.UtcNow.Add(maxAge.Value);
|
||||
var cacheKey = string.Format(CultureInfo.InvariantCulture,
|
||||
"{0}/{1}/{2}/{3}{4}", cacheName, tile.ZoomLevel, tile.Column, tile.Row, extension);
|
||||
|
||||
var buffer = await Cache.GetAsync(cacheKey).ConfigureAwait(false);
|
||||
|
||||
if (buffer == null)
|
||||
{
|
||||
var response = await ImageLoader.GetHttpResponseAsync(uri).ConfigureAwait(false);
|
||||
|
||||
if (response != null) // download succeeded
|
||||
{
|
||||
buffer = response.Buffer ?? Array.Empty<byte>(); // may be empty when no tile available, but still be cached
|
||||
|
||||
var maxAge = response.MaxAge ?? DefaultCacheExpiration;
|
||||
|
||||
if (maxAge > MaxCacheExpiration)
|
||||
{
|
||||
maxAge = MaxCacheExpiration;
|
||||
}
|
||||
|
||||
var cacheOptions = new DistributedCacheEntryOptions
|
||||
{
|
||||
AbsoluteExpiration = DateTimeOffset.UtcNow.Add(maxAge)
|
||||
};
|
||||
|
||||
await Cache.SetAsync(cacheKey, buffer, cacheOptions).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
//else System.Diagnostics.Debug.WriteLine($"Cached: {cacheKey}");
|
||||
|
||||
if (buffer != null && buffer.Length > 0)
|
||||
{
|
||||
await LoadTileAsync(tile, () => ImageLoader.LoadImageAsync(buffer)).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue