ClemensFischer/XAML-Map-Control
1
0
Fork 0
mirror of https://github.com/ClemensFischer/XAML-Map-Control.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Support .NET logging

Browse source
This commit is contained in:
ClemensFischer 2025-03-30 16:35:10 +02:00
parent 1c47b358eb
commit 6f6b45cfbf
5 changed files with 150 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
Caches/FileDbCache/FileDbCache.cs
View file

@ -1,13 +1,23 @@
using FileDbNs; using FileDbNs;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using System; using System;
using System.Diagnostics;
using System.IO; using System.IO;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace MapControl.Caching namespace MapControl.Caching
{ {
public class FileDbCacheOptions : IOptions<FileDbCacheOptions>
{
public FileDbCacheOptions Value => this;
public string Path { get; set; }
public TimeSpan ExpirationScanFrequency { get; set; } = TimeSpan.FromHours(1);
}
/// <summary> /// <summary>
/// IDistributedCache implementation based on FileDb, https://github.com/eztools-software/FileDb. /// IDistributedCache implementation based on FileDb, https://github.com/eztools-software/FileDb.
/// </summary> /// </summary>
@ -19,14 +29,27 @@ namespace MapControl.Caching
private readonly FileDb fileDb = new FileDb { AutoFlush = true }; private readonly FileDb fileDb = new FileDb { AutoFlush = true };
private readonly Timer timer; private readonly Timer timer;
private readonly ILogger logger;
public FileDbCache(string path) public FileDbCache(string path, ILoggerFactory loggerFactory = null)
: this(path, TimeSpan.FromHours(1)) : this(new FileDbCacheOptions { Path = path }, loggerFactory)
{ {
} }
public FileDbCache(string path, TimeSpan expirationScanFrequency) public FileDbCache(IOptions<FileDbCacheOptions> optionsAccessor, ILoggerFactory loggerFactory = null)
: this(optionsAccessor.Value, loggerFactory)
{ {
}
public FileDbCache(FileDbCacheOptions options, ILoggerFactory loggerFactory = null)
{
if (loggerFactory != null)
{
logger = loggerFactory.CreateLogger<FileDbCache>();
}
var path = options.Path;
if (string.IsNullOrEmpty(path) || string.IsNullOrEmpty(Path.GetExtension(path))) if (string.IsNullOrEmpty(path) || string.IsNullOrEmpty(Path.GetExtension(path)))
{ {
path = Path.Combine(path ?? "", "TileCache.fdb"); path = Path.Combine(path ?? "", "TileCache.fdb");
@ -36,7 +59,7 @@ namespace MapControl.Caching
{ {
fileDb.Open(path); fileDb.Open(path);
Debug.WriteLine($"{nameof(FileDbCache)}: Opened database {path}"); logger?.LogInformation("Opened database {path}", path);
} }
catch catch
{ {
@ -56,12 +79,12 @@ namespace MapControl.Caching
new Field(expiresField, DataTypeEnum.DateTime) new Field(expiresField, DataTypeEnum.DateTime)
}); });
Debug.WriteLine($"{nameof(FileDbCache)}: Created database {path}"); logger?.LogInformation("Created database {path}", path);
} }
if (expirationScanFrequency > TimeSpan.Zero) if (options.ExpirationScanFrequency > TimeSpan.Zero)
{ {
timer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, expirationScanFrequency); timer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, options.ExpirationScanFrequency);
} }
} }
@ -88,7 +111,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(FileDbCache)}.Get({key}): {ex.Message}"); logger?.LogError(ex, "Get({key})", key);
} }
} }
@ -128,7 +151,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(FileDbCache)}.Set({key}): {ex.Message}"); logger?.LogError(ex, "Set({key})", key);
} }
} }
} }
@ -159,7 +182,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(FileDbCache)}.Remove({key}): {ex.Message}"); logger?.LogError(ex, "Remove({key})", key);
} }
} }
} }
@ -173,13 +196,13 @@ namespace MapControl.Caching
public void DeleteExpiredItems() public void DeleteExpiredItems()
{ {
var deleted = fileDb.DeleteRecords(new FilterExpression(expiresField, DateTime.UtcNow, ComparisonOperatorEnum.LessThanOrEqual)); var deletedItemsCount = fileDb.DeleteRecords(new FilterExpression(expiresField, DateTime.UtcNow, ComparisonOperatorEnum.LessThanOrEqual));
if (deleted > 0) if (deletedItemsCount > 0)
{ {
fileDb.Clean(); fileDb.Clean();
Debug.WriteLine($"{nameof(FileDbCache)}: Deleted {deleted} expired items"); logger?.LogInformation("Deleted {count} expired items", deletedItemsCount);
} }
} }
} }

4
Caches/FileDbCache/FileDbCache.csproj
View file

@ -11,7 +11,9 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.3" />
<PackageReference Include="FileDb.Standard" Version="7.4.4" /> <PackageReference Include="FileDb.Standard" Version="7.4.4" />
<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.3" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.3" />
<PackageReference Include="Microsoft.Extensions.Options" Version="9.0.3" />
</ItemGroup> </ItemGroup>
</Project> </Project>

57
Caches/SQLiteCache/SQLiteCache.cs
View file

@ -1,13 +1,23 @@
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using System; using System;
using System.Data.SQLite; using System.Data.SQLite;
using System.Diagnostics;
using System.IO; using System.IO;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace MapControl.Caching namespace MapControl.Caching
{ {
public class SQLiteCacheOptions : IOptions<SQLiteCacheOptions>
{
public SQLiteCacheOptions Value => this;
public string Path { get; set; }
public TimeSpan ExpirationScanFrequency { get; set; } = TimeSpan.FromHours(1);
}
/// <summary> /// <summary>
/// IDistributedCache implementation based on System.Data.SQLite, https://system.data.sqlite.org/. /// IDistributedCache implementation based on System.Data.SQLite, https://system.data.sqlite.org/.
/// </summary> /// </summary>
@ -15,14 +25,27 @@ namespace MapControl.Caching
{ {
private readonly SQLiteConnection connection; private readonly SQLiteConnection connection;
private readonly Timer timer; private readonly Timer timer;
private readonly ILogger logger;
public SQLiteCache(string path) public SQLiteCache(string path, ILoggerFactory loggerFactory = null)
: this(path, TimeSpan.FromHours(1)) : this(new SQLiteCacheOptions { Path = path }, loggerFactory)
{ {
} }
public SQLiteCache(string path, TimeSpan expirationScanFrequency) public SQLiteCache(IOptions<SQLiteCacheOptions> optionsAccessor, ILoggerFactory loggerFactory = null)
: this(optionsAccessor.Value, loggerFactory)
{ {
}
public SQLiteCache(SQLiteCacheOptions options, ILoggerFactory loggerFactory = null)
{
if (loggerFactory != null)
{
logger = loggerFactory.CreateLogger<SQLiteCache>();
}
var path = options.Path;
if (string.IsNullOrEmpty(path) || string.IsNullOrEmpty(Path.GetExtension(path))) if (string.IsNullOrEmpty(path) || string.IsNullOrEmpty(Path.GetExtension(path)))
{ {
path = Path.Combine(path ?? "", "TileCache.sqlite"); path = Path.Combine(path ?? "", "TileCache.sqlite");
@ -41,11 +64,11 @@ namespace MapControl.Caching
command.ExecuteNonQuery(); command.ExecuteNonQuery();
} }
Debug.WriteLine($"{nameof(SQLiteCache)}: Opened database {path}"); logger?.LogInformation("Opened database {path}", path);
if (expirationScanFrequency > TimeSpan.Zero) if (options.ExpirationScanFrequency > TimeSpan.Zero)
{ {
timer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, expirationScanFrequency); timer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, options.ExpirationScanFrequency);
} }
} }
@ -70,7 +93,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.Get({key}): {ex.Message}"); logger?.LogError(ex, "Get({key})", key);
} }
} }
@ -92,7 +115,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.GetAsync({key}): {ex.Message}"); logger?.LogError(ex, "GetAsync({key})", key);
} }
} }
@ -112,7 +135,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.Set({key}): {ex.Message}"); logger?.LogError(ex, "Set({key})", key);
} }
} }
} }
@ -130,7 +153,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.SetAsync({key}): {ex.Message}"); logger?.LogError(ex, "SetAsync({key})", key);
} }
} }
} }
@ -157,7 +180,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.Remove({key}): {ex.Message}"); logger?.LogError(ex, "Remove({key})", key);
} }
} }
} }
@ -175,28 +198,28 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(SQLiteCache)}.RemoveAsync({key}): {ex.Message}"); logger?.LogError(ex, "RemoveAsync({key})", key);
} }
} }
} }
public void DeleteExpiredItems() public void DeleteExpiredItems()
{ {
long deleted; long deletedItemsCount;
using (var command = DeleteExpiredItemsCommand()) using (var command = DeleteExpiredItemsCommand())
{ {
deleted = (long)command.ExecuteScalar(); deletedItemsCount = (long)command.ExecuteScalar();
} }
if (deleted > 0) if (deletedItemsCount > 0)
{ {
using (var command = new SQLiteCommand("vacuum", connection)) using (var command = new SQLiteCommand("vacuum", connection))
{ {
command.ExecuteNonQuery(); command.ExecuteNonQuery();
} }
Debug.WriteLine($"{nameof(SQLiteCache)}: Deleted {deleted} expired items"); logger?.LogInformation("Deleted {count} expired items", deletedItemsCount);
} }
} }

2
Caches/SQLiteCache/SQLiteCache.csproj
View file

@ -12,6 +12,8 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.3" /> <PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.3" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.3" />
<PackageReference Include="Microsoft.Extensions.Options" Version="9.0.3" />
<PackageReference Include="System.Data.SQLite.Core" Version="1.0.119" /> <PackageReference Include="System.Data.SQLite.Core" Version="1.0.119" />
</ItemGroup> </ItemGroup>
</Project> </Project>

114
MapControl/Shared/ImageFileCache.cs
View file

@ -1,8 +1,8 @@
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using Microsoft.Extensions.Caching.Memory; using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options; using Microsoft.Extensions.Options;
using System; using System;
using System.Diagnostics;
using System.IO; using System.IO;
using System.Linq; using System.Linq;
using System.Threading; using System.Threading;
@ -10,6 +10,15 @@ using System.Threading.Tasks;
namespace MapControl.Caching namespace MapControl.Caching
{ {
public class ImageFileCacheOptions : IOptions<ImageFileCacheOptions>
{
public ImageFileCacheOptions Value => this;
public string Path { get; set; }
public TimeSpan ExpirationScanFrequency { get; set; } = TimeSpan.FromHours(1);
}
/// <summary> /// <summary>
/// IDistributedCache implementation that creates a single file per cache entry. /// IDistributedCache implementation that creates a single file per cache entry.
/// The cache expiration time is stored in the file's CreationTime property. /// The cache expiration time is stored in the file's CreationTime property.
@ -19,30 +28,43 @@ namespace MapControl.Caching
private readonly MemoryDistributedCache memoryCache; private readonly MemoryDistributedCache memoryCache;
private readonly DirectoryInfo rootDirectory; private readonly DirectoryInfo rootDirectory;
private readonly Timer expirationScanTimer; private readonly Timer expirationScanTimer;
private readonly ILogger logger;
private bool scanningExpiration; private bool scanningExpiration;
public ImageFileCache(string path) public ImageFileCache(string path, ILoggerFactory loggerFactory = null)
: this(path, TimeSpan.FromHours(1)) : this(new ImageFileCacheOptions { Path = path }, loggerFactory)
{ {
} }
public ImageFileCache(string path, TimeSpan expirationScanFrequency) public ImageFileCache(IOptions<ImageFileCacheOptions> optionsAccessor, ILoggerFactory loggerFactory = null)
: this(optionsAccessor.Value, loggerFactory)
{ {
}
public ImageFileCache(ImageFileCacheOptions options, ILoggerFactory loggerFactory = null)
{
if (loggerFactory != null)
{
logger = loggerFactory.CreateLogger<ImageFileCache>();
}
var path = options.Path;
rootDirectory = new DirectoryInfo(!string.IsNullOrEmpty(path) ? path : "TileCache"); rootDirectory = new DirectoryInfo(!string.IsNullOrEmpty(path) ? path : "TileCache");
rootDirectory.Create(); rootDirectory.Create();
Debug.WriteLine($"{nameof(ImageFileCache)}: {rootDirectory.FullName}"); logger?.LogInformation("Started in {name}", rootDirectory.FullName);
var options = new MemoryDistributedCacheOptions(); var memoryCacheOptions = new MemoryDistributedCacheOptions();
if (expirationScanFrequency > TimeSpan.Zero) if (options.ExpirationScanFrequency > TimeSpan.Zero)
{ {
options.ExpirationScanFrequency = expirationScanFrequency; memoryCacheOptions.ExpirationScanFrequency = options.ExpirationScanFrequency;
expirationScanTimer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, expirationScanFrequency); expirationScanTimer = new Timer(_ => DeleteExpiredItems(), null, TimeSpan.Zero, options.ExpirationScanFrequency);
} }
memoryCache = new MemoryDistributedCache(Options.Create(options)); memoryCache = new MemoryDistributedCache(Options.Create(memoryCacheOptions));
} }
public void Dispose() public void Dispose()
@ -75,7 +97,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed reading {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed reading {name}", file.FullName);
} }
} }
} }
@ -108,7 +130,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed reading {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed reading {name}", file.FullName);
} }
} }
} }
@ -140,7 +162,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed writing {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed writing {name}", file.FullName);
} }
} }
} }
@ -169,7 +191,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed writing {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed writing {name}", file.FullName);
} }
} }
} }
@ -207,7 +229,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed deleting {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed deleting {name}", file.FullName);
} }
} }
} }
@ -229,7 +251,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed deleting {file.FullName}: {ex.Message}"); logger?.LogError(ex, "Failed deleting {name}", file.FullName);
} }
} }
} }
@ -246,7 +268,7 @@ namespace MapControl.Caching
if (deletedFileCount > 0) if (deletedFileCount > 0)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Deleted {deletedFileCount} expired items in {directory.Name}."); logger?.LogInformation("Deleted {count} expired items in {name}", deletedFileCount, directory.FullName);
} }
} }
@ -254,6 +276,34 @@ namespace MapControl.Caching
} }
} }
private int ScanDirectory(DirectoryInfo directory)
{
var deletedFileCount = 0;
try
{
deletedFileCount = directory.EnumerateDirectories().Sum(ScanDirectory);
foreach (var file in directory.EnumerateFiles()
.Where(f => f.CreationTime > f.LastWriteTime && f.CreationTime <= DateTime.Now))
{
file.Delete();
deletedFileCount++;
}
if (!directory.EnumerateFileSystemInfos().Any())
{
directory.Delete();
}
}
catch (Exception ex)
{
logger?.LogError(ex, "Failed cleaning {name}", directory.FullName);
}
return deletedFileCount;
}
private FileInfo GetFile(string key) private FileInfo GetFile(string key)
{ {
try try
@ -262,7 +312,7 @@ namespace MapControl.Caching
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.WriteLine($"{nameof(ImageFileCache)}: Invalid key {key}: {ex.Message}"); logger?.LogError(ex, "Invalid key {key}", key);
} }
return null; return null;
@ -306,33 +356,5 @@ namespace MapControl.Caching
? options.AbsoluteExpiration.Value.LocalDateTime ? options.AbsoluteExpiration.Value.LocalDateTime
: DateTime.Now.Add(options.AbsoluteExpirationRelativeToNow ?? options.SlidingExpiration ?? TimeSpan.FromDays(1)); : DateTime.Now.Add(options.AbsoluteExpirationRelativeToNow ?? options.SlidingExpiration ?? TimeSpan.FromDays(1));
} }
private static int ScanDirectory(DirectoryInfo directory)
{
var deletedFileCount = 0;
try
{
deletedFileCount = directory.EnumerateDirectories().Sum(ScanDirectory);
foreach (var file in directory.EnumerateFiles()
.Where(f => f.CreationTime > f.LastWriteTime && f.CreationTime <= DateTime.Now))
{
file.Delete();
deletedFileCount++;
}
if (!directory.EnumerateFileSystemInfos().Any())
{
directory.Delete();
}
}
catch (Exception ex)
{
Debug.WriteLine($"{nameof(ImageFileCache)}: Failed cleaning {directory.FullName}: {ex.Message}");
}
return deletedFileCount;
}
} }
} }