Version 4.13.1 Cache "no tile" responses.

This commit is contained in:
ClemensF 2019-07-22 19:47:57 +02:00
parent 576dd8e8e7
commit 219171381f
27 changed files with 200 additions and 338 deletions

View file

@ -58,6 +58,18 @@ namespace MapControl
return image;
}
internal class HttpResponse
{
public byte[] Buffer { get; }
public TimeSpan? MaxAge { get; }
public HttpResponse(byte[] buffer, TimeSpan? maxAge)
{
Buffer = buffer;
MaxAge = maxAge;
}
}
internal static async Task<HttpResponse> GetHttpResponseAsync(Uri uri, bool continueOnCapturedContext = true)
{
HttpResponse response = null;
@ -65,24 +77,20 @@ namespace MapControl
try
{
using (var responseMessage = await HttpClient
.GetAsync(uri, HttpCompletionOption.ResponseHeadersRead)
.ConfigureAwait(continueOnCapturedContext))
.GetAsync(uri, HttpCompletionOption.ResponseHeadersRead).ConfigureAwait(continueOnCapturedContext))
{
if (responseMessage.IsSuccessStatusCode)
{
IEnumerable<string> tileInfo;
byte[] buffer = null;
if (responseMessage.Headers.TryGetValues("X-VE-Tile-Info", out tileInfo) &&
tileInfo.Contains("no-tile"))
if (!responseMessage.Headers.TryGetValues("X-VE-Tile-Info", out tileInfo) ||
!tileInfo.Contains("no-tile"))
{
response = new HttpResponse(null, null); // no tile image
}
else
{
response = new HttpResponse(
await responseMessage.Content.ReadAsByteArrayAsync().ConfigureAwait(continueOnCapturedContext),
responseMessage.Headers.CacheControl?.MaxAge);
buffer = await responseMessage.Content.ReadAsByteArrayAsync().ConfigureAwait(continueOnCapturedContext);
}
response = new HttpResponse(buffer, responseMessage.Headers.CacheControl?.MaxAge);
}
else
{
@ -97,17 +105,5 @@ namespace MapControl
return response;
}
internal class HttpResponse
{
public byte[] Buffer { get; }
public TimeSpan? MaxAge { get; }
public HttpResponse(byte[] buffer, TimeSpan? maxAge)
{
Buffer = buffer;
MaxAge = maxAge;
}
}
}
}

View file

@ -13,23 +13,23 @@ namespace MapControl.Caching
{
public class ImageFileCache : IImageCache
{
private StorageFolder rootFolder;
private readonly StorageFolder folder;
public ImageFileCache(StorageFolder rootFolder)
public ImageFileCache(StorageFolder folder)
{
if (rootFolder == null)
if (folder == null)
{
throw new ArgumentNullException("The parameter rootFolder must not be null.");
}
this.rootFolder = rootFolder;
this.folder = folder;
Debug.WriteLine("Created ImageFileCache in " + rootFolder.Path);
Debug.WriteLine("Created ImageFileCache in " + folder.Path);
}
public async Task<ImageCacheItem> GetAsync(string key)
{
string path = null;
string path;
try
{
@ -38,29 +38,27 @@ namespace MapControl.Caching
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Invalid key {0}: {1}", key, ex.Message);
return null;
}
if (path != null)
var item = await folder.TryGetItemAsync(path);
if (item != null && item.IsOfType(StorageItemTypes.File))
{
var item = await rootFolder.TryGetItemAsync(path);
var file = (StorageFile)item;
//Debug.WriteLine("ImageFileCache: Reading " + file.Path);
if (item != null && item.IsOfType(StorageItemTypes.File))
try
{
var file = (StorageFile)item;
//Debug.WriteLine("ImageFileCache: Reading " + file.Path);
try
return new ImageCacheItem
{
return new ImageCacheItem
{
Buffer = await FileIO.ReadBufferAsync(file),
Expiration = (await file.Properties.GetImagePropertiesAsync()).DateTaken.UtcDateTime
};
}
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Reading {0}: {1}", file.Path, ex.Message);
}
Buffer = await FileIO.ReadBufferAsync(file),
Expiration = (await file.Properties.GetImagePropertiesAsync()).DateTaken.UtcDateTime
};
}
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Reading {0}: {1}", file.Path, ex.Message);
}
}
@ -69,31 +67,34 @@ namespace MapControl.Caching
public async Task SetAsync(string key, IBuffer buffer, DateTime expiration)
{
var folders = GetPathElements(key);
try
if (buffer != null && buffer.Length > 0) // do not cache a no-tile entry
{
var folder = rootFolder;
var folders = GetPathElements(key);
for (int i = 0; i < folders.Length - 1; i++)
try
{
folder = await folder.CreateFolderAsync(folders[i], CreationCollisionOption.OpenIfExists);
var folder = this.folder;
for (int i = 0; i < folders.Length - 1; i++)
{
folder = await folder.CreateFolderAsync(folders[i], CreationCollisionOption.OpenIfExists);
}
var file = await folder.CreateFileAsync(folders[folders.Length - 1], CreationCollisionOption.ReplaceExisting);
//Debug.WriteLine("ImageFileCache: Writing {0}, Expires {1}", file.Path, expiration.ToLocalTime());
await FileIO.WriteBufferAsync(file, buffer);
// Store expiration date in ImageProperties.DateTaken
var properties = await file.Properties.GetImagePropertiesAsync();
properties.DateTaken = expiration;
await properties.SavePropertiesAsync();
}
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Writing {0}: {1}", Path.Combine(folder.Path, Path.Combine(folders)), ex.Message);
}
var file = await folder.CreateFileAsync(folders[folders.Length - 1], CreationCollisionOption.ReplaceExisting);
//Debug.WriteLine("ImageFileCache: Writing {0}, Expires {1}", file.Path, expiration.ToLocalTime());
await FileIO.WriteBufferAsync(file, buffer);
// Store expiration date in ImageProperties.DateTaken
var properties = await file.Properties.GetImagePropertiesAsync();
properties.DateTaken = expiration;
await properties.SavePropertiesAsync();
}
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Writing {0}: {1}", Path.Combine(rootFolder.Path, Path.Combine(folders)), ex.Message);
}
}

View file

@ -7,8 +7,8 @@ using System.Runtime.InteropServices;
[assembly: AssemblyCompany("Clemens Fischer")]
[assembly: AssemblyCopyright("Copyright © 2019 Clemens Fischer")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyVersion("4.13.0")]
[assembly: AssemblyFileVersion("4.13.0")]
[assembly: AssemblyVersion("4.13.1")]
[assembly: AssemblyFileVersion("4.13.1")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCulture("")]
[assembly: ComVisible(false)]

View file

@ -33,22 +33,19 @@ namespace MapControl
var cacheItem = await Cache.GetAsync(cacheKey).ConfigureAwait(false);
var buffer = cacheItem?.Buffer;
if (buffer == null || cacheItem.Expiration < DateTime.UtcNow)
if (cacheItem == null || cacheItem.Expiration < DateTime.UtcNow)
{
var response = await ImageLoader.GetHttpResponseAsync(uri, false).ConfigureAwait(false);
if (response != null) // download succeeded
{
buffer = response.Buffer.AsBuffer();
buffer = response.Buffer?.AsBuffer(); // may be null or empty when no tile available, but still be cached
if (buffer != null) // tile image available
{
await Cache.SetAsync(cacheKey, buffer, GetExpiration(response.MaxAge)).ConfigureAwait(false);
}
await Cache.SetAsync(cacheKey, buffer, GetExpiration(response.MaxAge)).ConfigureAwait(false);
}
}
if (buffer != null)
if (buffer != null && buffer.Length > 0)
{
await SetTileImageAsync(tile, () => ImageLoader.LoadImageAsync(buffer)).ConfigureAwait(false);
}

View file

@ -25,18 +25,18 @@ namespace MapControl.Caching
FileSystemRights.FullControl, AccessControlType.Allow);
private readonly MemoryCache memoryCache = MemoryCache.Default;
private readonly string rootFolder;
private readonly string folder;
public ImageFileCache(string rootFolder)
public ImageFileCache(string folder)
{
if (string.IsNullOrEmpty(rootFolder))
if (string.IsNullOrEmpty(folder))
{
throw new ArgumentException("The parameter rootFolder must not be null or empty.");
throw new ArgumentException("The parameter folder must not be null or empty.");
}
this.rootFolder = rootFolder;
this.folder = folder;
Debug.WriteLine("Created ImageFileCache in " + rootFolder);
Debug.WriteLine("Created ImageFileCache in " + folder);
}
public override string Name
@ -162,16 +162,16 @@ namespace MapControl.Caching
var imageCacheItem = value as ImageCacheItem;
if (imageCacheItem == null || imageCacheItem.Buffer == null || imageCacheItem.Buffer.Length == 0)
if (imageCacheItem == null)
{
throw new ArgumentException("The parameter value must be an ImageCacheItem with a non-empty Buffer.");
throw new ArgumentException("The parameter value must be a MapControl.Caching.ImageCacheItem instance.");
}
memoryCache.Set(key, imageCacheItem, policy);
var path = GetPath(key);
string path;
if (path != null)
if (imageCacheItem.Buffer != null && imageCacheItem.Buffer.Length > 0 && (path = GetPath(key)) != null)
{
try
{
@ -284,11 +284,11 @@ namespace MapControl.Caching
{
try
{
return Path.Combine(rootFolder, Path.Combine(key.Split('\\', '/', ',', ':', ';')));
return Path.Combine(folder, Path.Combine(key.Split('\\', '/', ',', ':', ';')));
}
catch (Exception ex)
{
Debug.WriteLine("ImageFileCache: Invalid key {0}/{1}: {2}", rootFolder, key, ex.Message);
Debug.WriteLine("ImageFileCache: Invalid key {0}/{1}: {2}", folder, key, ex.Message);
}
return null;

View file

@ -8,8 +8,8 @@ using System.Windows;
[assembly: AssemblyCompany("Clemens Fischer")]
[assembly: AssemblyCopyright("Copyright © 2019 Clemens Fischer")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyVersion("4.13.0")]
[assembly: AssemblyFileVersion("4.13.0")]
[assembly: AssemblyVersion("4.13.1")]
[assembly: AssemblyFileVersion("4.13.1")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCulture("")]
[assembly: ComVisible(false)]

View file

@ -7,13 +7,17 @@ using System.IO;
using System.Runtime.Caching;
using System.Threading.Tasks;
using System.Windows.Media;
using MapControl.Caching;
namespace MapControl
{
public class ImageCacheItem
namespace Caching
{
public byte[] Buffer { get; set; }
public DateTime Expiration { get; set; }
public class ImageCacheItem
{
public byte[] Buffer { get; set; }
public DateTime Expiration { get; set; }
}
}
public partial class TileImageLoader
@ -38,22 +42,19 @@ namespace MapControl
var cacheItem = await GetCacheAsync(cacheKey).ConfigureAwait(false);
var buffer = cacheItem?.Buffer;
if (buffer == null || cacheItem.Expiration < DateTime.UtcNow)
if (cacheItem == null || cacheItem.Expiration < DateTime.UtcNow)
{
var response = await ImageLoader.GetHttpResponseAsync(uri, false).ConfigureAwait(false);
if (response != null) // download succeeded
{
buffer = response.Buffer;
buffer = response.Buffer; // may be null or empty when no tile available, but still be cached
if (buffer != null) // tile image available
{
await SetCacheAsync(cacheKey, buffer, GetExpiration(response.MaxAge)).ConfigureAwait(false);
}
await SetCacheAsync(cacheKey, buffer, GetExpiration(response.MaxAge)).ConfigureAwait(false);
}
}
if (buffer != null)
if (buffer != null && buffer.Length > 0)
{
SetTileImageAsync(tile, await ImageLoader.LoadImageAsync(buffer).ConfigureAwait(false));
}