Version 4.13.0

SQLiteCache/Shared/SQLiteCache.cs

@@ -0,0 +1,75 @@
+// XAML Map Control - https://github.com/ClemensFischer/XAML-Map-Control
+// © 2019 Clemens Fischer
+// Licensed under the Microsoft Public License (Ms-PL)
+
+using System;
+using System.Diagnostics;
+#if WINDOWS_UWP
+using SQLiteCommand = Microsoft.Data.Sqlite.SqliteCommand;
+using SQLiteConnection = Microsoft.Data.Sqlite.SqliteConnection;
+#else
+using System.Data.SQLite;
+#endif
+
+namespace MapControl.Caching
+{
+    /// <summary>
+    /// Image cache implementation based on SqLite.
+    /// </summary>
+    public sealed partial class SQLiteCache : IDisposable
+    {
+        private readonly SQLiteConnection connection;
+
+        private static SQLiteConnection Open(string path)
+        {
+            var connection = new SQLiteConnection("Data Source=" + path);
+            connection.Open();
+
+            using (var command = new SQLiteCommand("create table if not exists items (key text primary key, expiration integer, buffer blob)", connection))
+            {
+                command.ExecuteNonQuery();
+            }
+
+            Debug.WriteLine("SQLiteCache: Opened database " + path);
+
+            return connection;
+        }
+
+        public void Dispose()
+        {
+            connection.Dispose();
+        }
+
+        public void Clean()
+        {
+            using (var command = new SQLiteCommand("delete from items where expiration < @exp", connection))
+            {
+                command.Parameters.AddWithValue("@exp", DateTime.UtcNow.Ticks);
+                command.ExecuteNonQuery();
+            }
+        }
+
+        private SQLiteCommand GetItemCommand(string key)
+        {
+            var command = new SQLiteCommand("select expiration, buffer from items where key=@key", connection);
+            command.Parameters.AddWithValue("@key", key);
+            return command;
+        }
+
+        private SQLiteCommand SetItemCommand(string key, DateTime expiration, byte[] buffer)
+        {
+            var command = new SQLiteCommand("insert or replace into items (key, expiration, buffer) values (@key, @exp, @buf)", connection);
+            command.Parameters.AddWithValue("@key", key);
+            command.Parameters.AddWithValue("@exp", expiration.Ticks);
+            command.Parameters.AddWithValue("@buf", buffer);
+            return command;
+        }
+
+        private SQLiteCommand RemoveItemCommand(string key)
+        {
+            var command = new SQLiteCommand("delete from items where key = @key", connection);
+            command.Parameters.AddWithValue("@key", key);
+            return command;
+        }
+    }
+}

SQLiteCache/UWP/SQLiteCache.UWP.cs

@@ -2,7 +2,6 @@
 // © 2019 Clemens Fischer
 // Licensed under the Microsoft Public License (Ms-PL)
 
-using Microsoft.Data.Sqlite;
 using System;
 using System.Diagnostics;
 using System.IO;
@@ -16,10 +15,8 @@ namespace MapControl.Caching
     /// <summary>
     /// IImageCache implementation based on SqLite.
     /// </summary>
-    public sealed class SQLiteCache : IImageCache, IDisposable
+    public partial class SQLiteCache : IImageCache
     {
-        private readonly SqliteConnection connection;
-
         public SQLiteCache(StorageFolder folder, string fileName = "TileCache.sqlite")
         {
             if (folder == null)
@@ -32,33 +29,29 @@ namespace MapControl.Caching
                 throw new ArgumentNullException("The parameter fileName must not be null.");
             }
 
-            connection = new SqliteConnection("Data Source=" + Path.Combine(folder.Path, fileName));
+            connection = Open(Path.Combine(folder.Path, fileName));
 
-            connection.Open();
-
-            using (var command = new SqliteCommand("create table if not exists items (key text, expiration integer, buffer blob)", connection))
-            {
-                command.ExecuteNonQuery();
-            }
-        }
-
-        public void Dispose()
-        {
-            connection.Dispose();
+            Clean();
         }
 
         public async Task<ImageCacheItem> GetAsync(string key)
         {
+            if (key == null)
+            {
+                throw new ArgumentNullException("The parameter key must not be null.");
+            }
+
+            ImageCacheItem imageCacheItem = null;
+
             try
             {
-                using (var command = new SqliteCommand("select expiration, buffer from items where key=@key", connection))
+                using (var command = GetItemCommand(key))
                 {
-                    command.Parameters.AddWithValue("@key", key);
                     var reader = await command.ExecuteReaderAsync();
 
-                    if (reader.Read())
+                    if (await reader.ReadAsync())
                     {
-                        return new ImageCacheItem
+                        imageCacheItem = new ImageCacheItem
                         {
                             Expiration = new DateTime((long)reader["expiration"]),
                             Buffer = ((byte[])reader["buffer"]).AsBuffer()
@@ -68,27 +61,36 @@ namespace MapControl.Caching
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: GetAsync(\"{0}\"): {1}", key, ex.Message);
+                Debug.WriteLine("SQLiteCache.GetAsync(\"{0}\"): {1}", key, ex.Message);
             }
 
-            return null;
+            return imageCacheItem;
         }
 
         public async Task SetAsync(string key, IBuffer buffer, DateTime expiration)
         {
+            if (key == null)
+            {
+                throw new ArgumentNullException("The parameter key must not be null.");
+            }
+
+            if (buffer == null)
+            {
+                throw new ArgumentNullException("The parameter buffer must not be null.");
+            }
+
             try
             {
-                using (var command = new SqliteCommand("insert or replace into items (key, expiration, buffer) values (@key, @exp, @buf)", connection))
+                using (var command = SetItemCommand(key, expiration, buffer.ToArray()))
                 {
-                    command.Parameters.AddWithValue("@key", key);
-                    command.Parameters.AddWithValue("@exp", expiration.Ticks);
-                    command.Parameters.AddWithValue("@buf", buffer.ToArray());
                     await command.ExecuteNonQueryAsync();
                 }
+
+                //Debug.WriteLine("SQLiteCache.SetAsync(\"{0}\"): expires {1}", key, expiration.ToLocalTime());
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: SetAsync(\"{0}\"): {1}", key, ex.Message);
+                Debug.WriteLine("SQLiteCache.SetAsync(\"{0}\"): {1}", key, ex.Message);
             }
         }
     }

SQLiteCache/UWP/SQLiteCache.UWP.csproj

@@ -40,8 +40,11 @@
     <RestoreProjectStyle>PackageReference</RestoreProjectStyle>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="..\Shared\SQLiteCache.cs">
+      <Link>SQLiteCache.cs</Link>
+    </Compile>
     <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="SQLiteCache.cs" />
+    <Compile Include="SQLiteCache.UWP.cs" />
     <EmbeddedResource Include="Properties\SQLiteCache.UWP.rd.xml" />
   </ItemGroup>
   <ItemGroup>

SQLiteCache/WPF/SQLiteCache.WPF.cs

@@ -15,10 +15,8 @@ namespace MapControl.Caching
     /// <summary>
     /// ObjectCache implementation based on SqLite.
     /// </summary>
-    public sealed class SQLiteCache : ObjectCache, IDisposable
+    public partial class SQLiteCache : ObjectCache
     {
-        private readonly SQLiteConnection connection;
-
         public SQLiteCache(string path)
         {
             if (string.IsNullOrEmpty(path))
@@ -31,14 +29,9 @@ namespace MapControl.Caching
                 path = Path.Combine(path, "TileCache.sqlite");
             }
 
-            connection = new SQLiteConnection("Data Source=" + Path.GetFullPath(path));
+            connection = Open(Path.GetFullPath(path));
 
-            connection.Open();
-
-            using (var command = new SQLiteCommand("create table if not exists items (key text, expiration integer, buffer blob)", connection))
-            {
-                command.ExecuteNonQuery();
-            }
+            Clean();
         }
 
         public override string Name
@@ -59,19 +52,19 @@ namespace MapControl.Caching
 
         protected override IEnumerator<KeyValuePair<string, object>> GetEnumerator()
         {
-            throw new NotSupportedException("SqLiteCache does not support the ability to enumerate items.");
+            throw new NotSupportedException("SQLiteCache does not support the ability to enumerate items.");
         }
 
         public override CacheEntryChangeMonitor CreateCacheEntryChangeMonitor(IEnumerable<string> keys, string regionName = null)
         {
-            throw new NotSupportedException("SqLiteCache does not support the ability to create change monitors.");
+            throw new NotSupportedException("SQLiteCache does not support the ability to create change monitors.");
         }
 
         public override long GetCount(string regionName = null)
         {
             if (regionName != null)
             {
-                throw new NotSupportedException("The parameter regionName must be null.");
+                throw new NotSupportedException("SQLiteCache does not support named regions.");
             }
 
             try
@@ -83,7 +76,7 @@ namespace MapControl.Caching
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: GetCount(): {0}", ex.Message);
+                Debug.WriteLine("SQLiteCache.GetCount(): {0}", ex.Message);
             }
 
             return 0;
@@ -91,28 +84,26 @@ namespace MapControl.Caching
 
         public override bool Contains(string key, string regionName = null)
         {
+            if (regionName != null)
+            {
+                throw new NotSupportedException("SQLiteCache does not support named regions.");
+            }
+
             if (key == null)
             {
                 throw new ArgumentNullException("The parameter key must not be null.");
             }
 
-            if (regionName != null)
-            {
-                throw new NotSupportedException("The parameter regionName must be null.");
-            }
-
             try
             {
-                using (var command = new SQLiteCommand("select expiration, buffer from items where key=@key", connection))
+                using (var command = GetItemCommand(key))
                 {
-                    command.Parameters.AddWithValue("@key", key);
-
                     return command.ExecuteReader().Read();
                 }
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: Get(\"{0}\"): {1}", key, ex.Message);
+                Debug.WriteLine("SQLiteCache.Contains(\"{0}\"): {1}", key, ex.Message);
             }
 
             return false;
@@ -120,26 +111,27 @@ namespace MapControl.Caching
 
         public override object Get(string key, string regionName = null)
         {
+            if (regionName != null)
+            {
+                throw new NotSupportedException("SQLiteCache does not support named regions.");
+            }
+
             if (key == null)
             {
                 throw new ArgumentNullException("The parameter key must not be null.");
             }
 
-            if (regionName != null)
-            {
-                throw new NotSupportedException("The parameter regionName must be null.");
-            }
+            ImageCacheItem imageCacheItem = null;
 
             try
             {
-                using (var command = new SQLiteCommand("select expiration, buffer from items where key=@key", connection))
+                using (var command = GetItemCommand(key))
                 {
-                    command.Parameters.AddWithValue("@key", key);
                     var reader = command.ExecuteReader();
 
                     if (reader.Read())
                     {
-                        return new ImageCacheItem
+                        imageCacheItem = new ImageCacheItem
                         {
                             Expiration = new DateTime((long)reader["expiration"]),
                             Buffer = (byte[])reader["buffer"]
@@ -149,10 +141,10 @@ namespace MapControl.Caching
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: Get(\"{0}\"): {1}", key, ex.Message);
+                Debug.WriteLine("SQLiteCache.Get(\"{0}\"): {1}", key, ex.Message);
             }
 
-            return null;
+            return imageCacheItem;
         }
 
         public override CacheItem GetCacheItem(string key, string regionName = null)
@@ -169,36 +161,35 @@ namespace MapControl.Caching
 
         public override void Set(string key, object value, CacheItemPolicy policy, string regionName = null)
         {
+            if (regionName != null)
+            {
+                throw new NotSupportedException("SQLiteCache does not support named regions.");
+            }
+
             if (key == null)
             {
                 throw new ArgumentNullException("The parameter key must not be null.");
             }
 
-            if (regionName != null)
-            {
-                throw new NotSupportedException("The parameter regionName must be null.");
-            }
-
             var imageCacheItem = value as ImageCacheItem;
 
             if (imageCacheItem == null || imageCacheItem.Buffer == null || imageCacheItem.Buffer.Length == 0)
             {
-                throw new NotSupportedException("The parameter value must be an ImageCacheItem with a non-empty Buffer.");
+                throw new ArgumentException("The parameter value must be an ImageCacheItem with a non-empty Buffer.");
             }
 
             try
             {
-                using (var command = new SQLiteCommand("insert or replace into items (key, expiration, buffer) values (@key, @exp, @buf)", connection))
+                using (var command = SetItemCommand(key, imageCacheItem.Expiration, imageCacheItem.Buffer))
                 {
-                    command.Parameters.AddWithValue("@key", key);
-                    command.Parameters.AddWithValue("@exp", imageCacheItem.Expiration.Ticks);
-                    command.Parameters.AddWithValue("@buf", imageCacheItem.Buffer);
                     command.ExecuteNonQuery();
                 }
+
+                //Debug.WriteLine("SQLiteCache.Set(\"{0}\"): expires {1}", key, expiration.ToLocalTime());
             }
             catch (Exception ex)
             {
-                Debug.WriteLine("SqLiteCache: Set(\"{0}\"): {1}", key, ex.Message);
+                Debug.WriteLine("SQLiteCache.Set(\"{0}\"): {1}", key, ex.Message);
             }
         }
 
@@ -237,12 +228,24 @@ namespace MapControl.Caching
 
         public override object Remove(string key, string regionName = null)
         {
-            throw new NotImplementedException();
-        }
+            var oldValue = Get(key, regionName);
 
-        public void Dispose()
-        {
-            connection.Dispose();
+            if (oldValue != null)
+            {
+                try
+                {
+                    using (var command = RemoveItemCommand(key))
+                    {
+                        command.ExecuteNonQuery();
+                    }
+                }
+                catch (Exception ex)
+                {
+                    Debug.WriteLine("SQLiteCache.Remove(\"{0}\"): {1}", key, ex.Message);
+                }
+            }
+
+            return oldValue;
         }
     }
 }

SQLiteCache/WPF/SQLiteCache.WPF.csproj

@@ -49,11 +49,14 @@
     <Reference Include="System.Runtime.Caching" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="..\Shared\SQLiteCache.cs">
+      <Link>SQLiteCache.cs</Link>
+    </Compile>
     <Compile Include="Properties\AssemblyInfo.cs">
       <SubType>Code</SubType>
     </Compile>
     <AppDesigner Include="Properties\" />
-    <Compile Include="SQLiteCache.cs" />
+    <Compile Include="SQLiteCache.WPF.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\MapControl.snk">