From e6181c24124d97f2fbc932b8a68311e625463156 Mon Sep 17 00:00:00 2001 From: uzvkl Date: Tue, 11 Jun 2019 23:05:52 +0200 Subject: Move dsa related stuff to subfolder --- FireBase/Offline/ConcurrentOfflineDatabase.cs | 233 ----------- FireBase/Offline/DatabaseExtensions.cs | 257 ------------ FireBase/Offline/ISetHandler.cs | 10 - FireBase/Offline/InitialPullStrategy.cs | 23 -- FireBase/Offline/Internals/MemberAccessVisitor.cs | 46 --- FireBase/Offline/OfflineCacheAdapter.cs | 152 ------- FireBase/Offline/OfflineDatabase.cs | 228 ---------- FireBase/Offline/OfflineEntry.cs | 99 ----- FireBase/Offline/RealtimeDatabase.cs | 479 ---------------------- FireBase/Offline/SetHandler.cs | 19 - FireBase/Offline/StreamingOptions.cs | 23 -- FireBase/Offline/SyncOptions.cs | 28 -- 12 files changed, 1597 deletions(-) delete mode 100644 FireBase/Offline/ConcurrentOfflineDatabase.cs delete mode 100644 FireBase/Offline/DatabaseExtensions.cs delete mode 100644 FireBase/Offline/ISetHandler.cs delete mode 100644 FireBase/Offline/InitialPullStrategy.cs delete mode 100644 FireBase/Offline/Internals/MemberAccessVisitor.cs delete mode 100644 FireBase/Offline/OfflineCacheAdapter.cs delete mode 100644 FireBase/Offline/OfflineDatabase.cs delete mode 100644 FireBase/Offline/OfflineEntry.cs delete mode 100644 FireBase/Offline/RealtimeDatabase.cs delete mode 100644 FireBase/Offline/SetHandler.cs delete mode 100644 FireBase/Offline/StreamingOptions.cs delete mode 100644 FireBase/Offline/SyncOptions.cs (limited to 'FireBase/Offline') diff --git a/FireBase/Offline/ConcurrentOfflineDatabase.cs b/FireBase/Offline/ConcurrentOfflineDatabase.cs deleted file mode 100644 index 1a9e607..0000000 --- a/FireBase/Offline/ConcurrentOfflineDatabase.cs +++ /dev/null @@ -1,233 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using LiteDB; - -namespace Firebase.Database.Offline -{ - /// - /// The offline database. - /// - public class ConcurrentOfflineDatabase : IDictionary - { - private readonly ConcurrentDictionary ccache; - private readonly LiteRepository db; - - /// - /// Initializes a new instance of the class. - /// - /// The item type which is used to determine the database file name. - /// Custom string which will get appended to the file name. - public ConcurrentOfflineDatabase(Type itemType, string filenameModifier) - { - var fullName = GetFileName(itemType.ToString()); - if (fullName.Length > 100) fullName = fullName.Substring(0, 100); - - var mapper = BsonMapper.Global; - mapper.Entity().Id(o => o.Key); - - var root = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); - var filename = fullName + filenameModifier + ".db"; - var path = Path.Combine(root, filename); - db = new LiteRepository(new LiteDatabase(path, mapper)); - - var cache = db.Database - .GetCollection() - .FindAll() - .ToDictionary(o => o.Key, o => o); - - ccache = new ConcurrentDictionary(cache); - } - - /// - /// Gets the number of elements contained in the . - /// - /// The number of elements contained in the . - public int Count => ccache.Count; - - /// - /// Gets a value indicating whether this is a read-only collection. - /// - public bool IsReadOnly => false; - - /// - /// Gets an containing the keys of the - /// . - /// - /// - /// An containing the keys of the object that - /// implements . - /// - public ICollection Keys => ccache.Keys; - - /// - /// Gets an containing the values in the - /// . - /// - /// - /// An containing the values in the object that - /// implements . - /// - public ICollection Values => ccache.Values; - - /// - /// Gets or sets the element with the specified key. - /// - /// The key of the element to get or set. - /// The element with the specified key. - public OfflineEntry this[string key] - { - get => ccache[key]; - - set - { - ccache.AddOrUpdate(key, value, (k, existing) => value); - db.Upsert(value); - } - } - - /// - /// Returns an enumerator that iterates through the collection. - /// - /// An enumerator that can be used to iterate through the collection. - public IEnumerator> GetEnumerator() - { - return ccache.GetEnumerator(); - } - - IEnumerator IEnumerable.GetEnumerator() - { - return GetEnumerator(); - } - - /// - /// Adds an item to the . - /// - /// The object to add to the . - public void Add(KeyValuePair item) - { - Add(item.Key, item.Value); - } - - /// - /// Removes all items from the . - /// - public void Clear() - { - ccache.Clear(); - db.Delete(LiteDB.Query.All()); - } - - /// - /// Determines whether the contains a specific value. - /// - /// The object to locate in the . - /// - /// True if is found in the ; - /// otherwise, false. - /// - public bool Contains(KeyValuePair item) - { - return ContainsKey(item.Key); - } - - /// - /// Copies the elements of the to an - /// , starting at a particular index. - /// - /// - /// The one-dimensional that is the destination of the elements copied - /// from . The must have - /// zero-based indexing. - /// - /// The zero-based index in at which copying begins. - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - ccache.ToList().CopyTo(array, arrayIndex); - } - - /// - /// Removes the first occurrence of a specific object from the - /// . - /// - /// The object to remove from the . - /// - /// True if was successfully removed from the - /// ; otherwise, false. This method also returns false if - /// is not found in the original . - /// - public bool Remove(KeyValuePair item) - { - return Remove(item.Key); - } - - /// - /// Determines whether the contains an element with the - /// specified key. - /// - /// The key to locate in the . - /// - /// True if the contains an element with the key; - /// otherwise, false. - /// - public bool ContainsKey(string key) - { - return ccache.ContainsKey(key); - } - - /// - /// Adds an element with the provided key and value to the . - /// - /// The object to use as the key of the element to add. - /// The object to use as the value of the element to add. - public void Add(string key, OfflineEntry value) - { - ccache.AddOrUpdate(key, value, (k, existing) => value); - db.Upsert(value); - } - - /// - /// Removes the element with the specified key from the . - /// - /// The key of the element to remove. - /// - /// True if the element is successfully removed; otherwise, false. This method also returns false if - /// was not found in the original . - /// - public bool Remove(string key) - { - ccache.TryRemove(key, out _); - return db.Delete(key); - } - - /// - /// Gets the value associated with the specified key. - /// - /// The key whose value to get. - /// - /// When this method returns, the value associated with the specified key, if the key is found; - /// otherwise, the default value for the type of the parameter. This parameter is passed - /// uninitialized. - /// - /// - /// True if the object that implements contains an - /// element with the specified key; otherwise, false. - /// - public bool TryGetValue(string key, out OfflineEntry value) - { - return ccache.TryGetValue(key, out value); - } - - private string GetFileName(string fileName) - { - var invalidChars = new[] {'`', '[', ',', '='}; - foreach (var c in invalidChars.Concat(Path.GetInvalidFileNameChars()).Distinct()) - fileName = fileName.Replace(c, '_'); - - return fileName; - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/DatabaseExtensions.cs b/FireBase/Offline/DatabaseExtensions.cs deleted file mode 100644 index e7c4074..0000000 --- a/FireBase/Offline/DatabaseExtensions.cs +++ /dev/null @@ -1,257 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq.Expressions; -using System.Reflection; -using Firebase.Database.Query; - -namespace Firebase.Database.Offline -{ - public static class DatabaseExtensions - { - /// - /// Create new instances of the . - /// - /// Type of elements. - /// Custom string which will get appended to the file name. - /// Optional custom root element of received json items. - /// Realtime streaming options. - /// Specifies what strategy should be used for initial pulling of server data. - /// - /// Specifies whether changed items should actually be pushed to the server. It this is false, - /// then Put / Post / Delete will not affect server data. - /// - /// The . - public static RealtimeDatabase AsRealtimeDatabase(this ChildQuery query, string filenameModifier = "", - string elementRoot = "", StreamingOptions streamingOptions = StreamingOptions.LatestOnly, - InitialPullStrategy initialPullStrategy = InitialPullStrategy.MissingOnly, bool pushChanges = true) - where T : class - { - return new RealtimeDatabase(query, elementRoot, query.Client.Options.OfflineDatabaseFactory, - filenameModifier, streamingOptions, initialPullStrategy, pushChanges); - } - - /// - /// Create new instances of the . - /// - /// Type of elements. - /// Type of the custom to use. - /// Custom string which will get appended to the file name. - /// Optional custom root element of received json items. - /// Realtime streaming options. - /// Specifies what strategy should be used for initial pulling of server data. - /// - /// Specifies whether changed items should actually be pushed to the server. It this is false, - /// then Put / Post / Delete will not affect server data. - /// - /// The . - public static RealtimeDatabase AsRealtimeDatabase(this ChildQuery query, - string filenameModifier = "", string elementRoot = "", - StreamingOptions streamingOptions = StreamingOptions.LatestOnly, - InitialPullStrategy initialPullStrategy = InitialPullStrategy.MissingOnly, bool pushChanges = true) - where T : class - where TSetHandler : ISetHandler, new() - { - return new RealtimeDatabase(query, elementRoot, query.Client.Options.OfflineDatabaseFactory, - filenameModifier, streamingOptions, initialPullStrategy, pushChanges, - Activator.CreateInstance()); - } - - /// - /// Overwrites existing object with given key leaving any missing properties intact in firebase. - /// - /// The key. - /// The object to set. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Patch(this RealtimeDatabase db, string key, T obj, bool syncOnline = true, - int priority = 1) - where T : class - { - db.Set(key, obj, syncOnline ? SyncOptions.Patch : SyncOptions.None, priority); - } - - /// - /// Overwrites existing object with given key. - /// - /// The key. - /// The object to set. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Put(this RealtimeDatabase db, string key, T obj, bool syncOnline = true, - int priority = 1) - where T : class - { - db.Set(key, obj, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - - /// - /// Adds a new entity to the Database. - /// - /// The object to add. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - /// The generated key for this object. - public static string Post(this RealtimeDatabase db, T obj, bool syncOnline = true, int priority = 1) - where T : class - { - var key = FirebaseKeyGenerator.Next(); - - db.Set(key, obj, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - - return key; - } - - /// - /// Deletes the entity with the given key. - /// - /// The key. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Delete(this RealtimeDatabase db, string key, bool syncOnline = true, int priority = 1) - where T : class - { - db.Set(key, null, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - - /// - /// Do a Put for a nested property specified by of an object with key - /// . - /// - /// Type of the root elements. - /// Type of the property being modified - /// Database instance. - /// Key of the root element to modify. - /// Expression on the root element leading to target value to modify. - /// Value to put. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Put(this RealtimeDatabase db, string key, - Expression> propertyExpression, TProperty value, bool syncOnline = true, - int priority = 1) - where T : class - { - db.Set(key, propertyExpression, value, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - - /// - /// Do a Patch for a nested property specified by of an object with key - /// . - /// - /// Type of the root elements. - /// Type of the property being modified - /// Database instance. - /// Key of the root element to modify. - /// Expression on the root element leading to target value to modify. - /// Value to patch. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Patch(this RealtimeDatabase db, string key, - Expression> propertyExpression, TProperty value, bool syncOnline = true, - int priority = 1) - where T : class - { - db.Set(key, propertyExpression, value, syncOnline ? SyncOptions.Patch : SyncOptions.None, priority); - } - - /// - /// Delete a nested property specified by of an object with key - /// . This basically does a Put with null value. - /// - /// Type of the root elements. - /// Type of the property being modified - /// Database instance. - /// Key of the root element to modify. - /// Expression on the root element leading to target value to modify. - /// Value to put. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Delete(this RealtimeDatabase db, string key, - Expression> propertyExpression, bool syncOnline = true, int priority = 1) - where T : class - where TProperty : class - { - db.Set(key, propertyExpression, null, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - - /// - /// Post a new entity into the nested dictionary specified by of an object with - /// key . - /// The key of the new entity is automatically generated. - /// - /// Type of the root elements. - /// Type of the dictionary being modified - /// Type of the value within the dictionary being modified - /// Database instance. - /// Key of the root element to modify. - /// Expression on the root element leading to target value to modify. - /// Value to put. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Post(this RealtimeDatabase db, string key, - Expression> propertyExpression, TProperty value, bool syncOnline = true, - int priority = 1) - where T : class - where TSelector : IDictionary - { - var nextKey = FirebaseKeyGenerator.Next(); - var expression = Expression.Lambda>( - Expression.Call(propertyExpression.Body, - typeof(TSelector).GetRuntimeMethod("get_Item", new[] {typeof(string)}), - Expression.Constant(nextKey)), propertyExpression.Parameters); - db.Set(key, expression, value, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - - /// - /// Delete an entity with key in the nested dictionary specified by - /// of an object with key . - /// The key of the new entity is automatically generated. - /// - /// Type of the root elements. - /// Type of the dictionary being modified - /// Type of the value within the dictionary being modified - /// Database instance. - /// Key of the root element to modify. - /// Expression on the root element leading to target value to modify. - /// Key within the nested dictionary to delete. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public static void Delete(this RealtimeDatabase db, string key, - Expression>> propertyExpression, string dictionaryKey, - bool syncOnline = true, int priority = 1) - where T : class - { - var expression = Expression.Lambda>( - Expression.Call(propertyExpression.Body, - typeof(IDictionary).GetRuntimeMethod("get_Item", new[] {typeof(string)}), - Expression.Constant(dictionaryKey)), propertyExpression.Parameters); - db.Set(key, expression, null, syncOnline ? SyncOptions.Put : SyncOptions.None, priority); - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/ISetHandler.cs b/FireBase/Offline/ISetHandler.cs deleted file mode 100644 index c04bd41..0000000 --- a/FireBase/Offline/ISetHandler.cs +++ /dev/null @@ -1,10 +0,0 @@ -using System.Threading.Tasks; -using Firebase.Database.Query; - -namespace Firebase.Database.Offline -{ - public interface ISetHandler - { - Task SetAsync(ChildQuery query, string key, OfflineEntry entry); - } -} \ No newline at end of file diff --git a/FireBase/Offline/InitialPullStrategy.cs b/FireBase/Offline/InitialPullStrategy.cs deleted file mode 100644 index ca2bebf..0000000 --- a/FireBase/Offline/InitialPullStrategy.cs +++ /dev/null @@ -1,23 +0,0 @@ -namespace Firebase.Database.Offline -{ - /// - /// Specifies the strategy for initial pull of server data. - /// - public enum InitialPullStrategy - { - /// - /// Don't pull anything. - /// - None, - - /// - /// Pull only what isn't already stored offline. - /// - MissingOnly, - - /// - /// Pull everything that exists on the server. - /// - Everything - } -} \ No newline at end of file diff --git a/FireBase/Offline/Internals/MemberAccessVisitor.cs b/FireBase/Offline/Internals/MemberAccessVisitor.cs deleted file mode 100644 index 89a77da..0000000 --- a/FireBase/Offline/Internals/MemberAccessVisitor.cs +++ /dev/null @@ -1,46 +0,0 @@ -using System.Collections.Generic; -using System.Linq.Expressions; -using System.Reflection; -using Newtonsoft.Json; - -namespace Firebase.Database.Offline.Internals -{ - public class MemberAccessVisitor : ExpressionVisitor - { - private readonly IList propertyNames = new List(); - - private bool wasDictionaryAccess; - - public IEnumerable PropertyNames => propertyNames; - - public override Expression Visit(Expression expr) - { - if (expr?.NodeType == ExpressionType.MemberAccess) - { - if (wasDictionaryAccess) - { - wasDictionaryAccess = false; - } - else - { - var memberExpr = (MemberExpression) expr; - var jsonAttr = memberExpr.Member.GetCustomAttribute(); - - propertyNames.Add(jsonAttr?.PropertyName ?? memberExpr.Member.Name); - } - } - else if (expr?.NodeType == ExpressionType.Call) - { - var callExpr = (MethodCallExpression) expr; - if (callExpr.Method.Name == "get_Item" && callExpr.Arguments.Count == 1) - { - var e = Expression.Lambda(callExpr.Arguments[0]).Compile(); - propertyNames.Add(e.DynamicInvoke().ToString()); - wasDictionaryAccess = callExpr.Arguments[0].NodeType == ExpressionType.MemberAccess; - } - } - - return base.Visit(expr); - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/OfflineCacheAdapter.cs b/FireBase/Offline/OfflineCacheAdapter.cs deleted file mode 100644 index 3153d1b..0000000 --- a/FireBase/Offline/OfflineCacheAdapter.cs +++ /dev/null @@ -1,152 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Linq; - -namespace Firebase.Database.Offline -{ - internal class OfflineCacheAdapter : IDictionary, IDictionary - { - private readonly IDictionary database; - - public OfflineCacheAdapter(IDictionary database) - { - this.database = database; - } - - public void CopyTo(Array array, int index) - { - throw new NotImplementedException(); - } - - public bool IsSynchronized { get; } - - public object SyncRoot { get; } - - object IDictionary.this[object key] - { - get => database[key.ToString()].Deserialize(); - - set - { - var keyString = key.ToString(); - if (database.ContainsKey(keyString)) - database[keyString] = new OfflineEntry(keyString, value, database[keyString].Priority, - database[keyString].SyncOptions); - else - database[keyString] = new OfflineEntry(keyString, value, 1, SyncOptions.None); - } - } - - ICollection IDictionary.Values { get; } - - ICollection IDictionary.Keys { get; } - - public bool Contains(object key) - { - return ContainsKey(key.ToString()); - } - - IDictionaryEnumerator IDictionary.GetEnumerator() - { - throw new NotImplementedException(); - } - - public void Remove(object key) - { - Remove(key.ToString()); - } - - public bool IsFixedSize => false; - - public void Add(object key, object value) - { - Add(key.ToString(), (T) value); - } - - public int Count => database.Count; - - public bool IsReadOnly => database.IsReadOnly; - - public ICollection Keys => database.Keys; - - public ICollection Values => database.Values.Select(o => o.Deserialize()).ToList(); - - public T this[string key] - { - get => database[key].Deserialize(); - - set - { - if (database.ContainsKey(key)) - database[key] = new OfflineEntry(key, value, database[key].Priority, database[key].SyncOptions); - else - database[key] = new OfflineEntry(key, value, 1, SyncOptions.None); - } - } - - public IEnumerator> GetEnumerator() - { - return database.Select(d => new KeyValuePair(d.Key, d.Value.Deserialize())).GetEnumerator(); - } - - IEnumerator IEnumerable.GetEnumerator() - { - return GetEnumerator(); - } - - public void Add(KeyValuePair item) - { - Add(item.Key, item.Value); - } - - public void Clear() - { - database.Clear(); - } - - public bool Contains(KeyValuePair item) - { - return ContainsKey(item.Key); - } - - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - throw new NotImplementedException(); - } - - public bool Remove(KeyValuePair item) - { - return database.Remove(item.Key); - } - - public void Add(string key, T value) - { - database.Add(key, new OfflineEntry(key, value, 1, SyncOptions.None)); - } - - public bool ContainsKey(string key) - { - return database.ContainsKey(key); - } - - public bool Remove(string key) - { - return database.Remove(key); - } - - public bool TryGetValue(string key, out T value) - { - OfflineEntry val; - - if (database.TryGetValue(key, out val)) - { - value = val.Deserialize(); - return true; - } - - value = default(T); - return false; - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/OfflineDatabase.cs b/FireBase/Offline/OfflineDatabase.cs deleted file mode 100644 index be0380b..0000000 --- a/FireBase/Offline/OfflineDatabase.cs +++ /dev/null @@ -1,228 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using LiteDB; - -namespace Firebase.Database.Offline -{ - /// - /// The offline database. - /// - public class OfflineDatabase : IDictionary - { - private readonly IDictionary cache; - private readonly LiteRepository db; - - /// - /// Initializes a new instance of the class. - /// - /// The item type which is used to determine the database file name. - /// Custom string which will get appended to the file name. - public OfflineDatabase(Type itemType, string filenameModifier) - { - var fullName = GetFileName(itemType.ToString()); - if (fullName.Length > 100) fullName = fullName.Substring(0, 100); - - var mapper = BsonMapper.Global; - mapper.Entity().Id(o => o.Key); - - var root = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); - var filename = fullName + filenameModifier + ".db"; - var path = Path.Combine(root, filename); - db = new LiteRepository(new LiteDatabase(path, mapper)); - - cache = db.Database.GetCollection().FindAll() - .ToDictionary(o => o.Key, o => o); - } - - /// - /// Gets the number of elements contained in the . - /// - /// The number of elements contained in the . - public int Count => cache.Count; - - /// - /// Gets a value indicating whether this is a read-only collection. - /// - public bool IsReadOnly => cache.IsReadOnly; - - /// - /// Gets an containing the keys of the - /// . - /// - /// - /// An containing the keys of the object that - /// implements . - /// - public ICollection Keys => cache.Keys; - - /// - /// Gets an containing the values in the - /// . - /// - /// - /// An containing the values in the object that - /// implements . - /// - public ICollection Values => cache.Values; - - /// - /// Gets or sets the element with the specified key. - /// - /// The key of the element to get or set. - /// The element with the specified key. - public OfflineEntry this[string key] - { - get => cache[key]; - - set - { - cache[key] = value; - db.Upsert(value); - } - } - - /// - /// Returns an enumerator that iterates through the collection. - /// - /// An enumerator that can be used to iterate through the collection. - public IEnumerator> GetEnumerator() - { - return cache.GetEnumerator(); - } - - IEnumerator IEnumerable.GetEnumerator() - { - return GetEnumerator(); - } - - /// - /// Adds an item to the . - /// - /// The object to add to the . - public void Add(KeyValuePair item) - { - Add(item.Key, item.Value); - } - - /// - /// Removes all items from the . - /// - public void Clear() - { - cache.Clear(); - db.Delete(LiteDB.Query.All()); - } - - /// - /// Determines whether the contains a specific value. - /// - /// The object to locate in the . - /// - /// True if is found in the ; - /// otherwise, false. - /// - public bool Contains(KeyValuePair item) - { - return ContainsKey(item.Key); - } - - /// - /// Copies the elements of the to an - /// , starting at a particular index. - /// - /// - /// The one-dimensional that is the destination of the elements copied - /// from . The must have - /// zero-based indexing. - /// - /// The zero-based index in at which copying begins. - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - cache.CopyTo(array, arrayIndex); - } - - /// - /// Removes the first occurrence of a specific object from the - /// . - /// - /// The object to remove from the . - /// - /// True if was successfully removed from the - /// ; otherwise, false. This method also returns false if - /// is not found in the original . - /// - public bool Remove(KeyValuePair item) - { - return Remove(item.Key); - } - - /// - /// Determines whether the contains an element with the - /// specified key. - /// - /// The key to locate in the . - /// - /// True if the contains an element with the key; - /// otherwise, false. - /// - public bool ContainsKey(string key) - { - return cache.ContainsKey(key); - } - - /// - /// Adds an element with the provided key and value to the . - /// - /// The object to use as the key of the element to add. - /// The object to use as the value of the element to add. - public void Add(string key, OfflineEntry value) - { - cache.Add(key, value); - db.Insert(value); - } - - /// - /// Removes the element with the specified key from the . - /// - /// The key of the element to remove. - /// - /// True if the element is successfully removed; otherwise, false. This method also returns false if - /// was not found in the original . - /// - public bool Remove(string key) - { - cache.Remove(key); - return db.Delete(key); - } - - /// - /// Gets the value associated with the specified key. - /// - /// The key whose value to get. - /// - /// When this method returns, the value associated with the specified key, if the key is found; - /// otherwise, the default value for the type of the parameter. This parameter is passed - /// uninitialized. - /// - /// - /// True if the object that implements contains an - /// element with the specified key; otherwise, false. - /// - public bool TryGetValue(string key, out OfflineEntry value) - { - return cache.TryGetValue(key, out value); - } - - private string GetFileName(string fileName) - { - var invalidChars = new[] {'`', '[', ',', '='}; - foreach (var c in invalidChars.Concat(Path.GetInvalidFileNameChars()).Distinct()) - fileName = fileName.Replace(c, '_'); - - return fileName; - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/OfflineEntry.cs b/FireBase/Offline/OfflineEntry.cs deleted file mode 100644 index 9feffa3..0000000 --- a/FireBase/Offline/OfflineEntry.cs +++ /dev/null @@ -1,99 +0,0 @@ -using System; -using Newtonsoft.Json; - -namespace Firebase.Database.Offline -{ - /// - /// Represents an object stored in offline storage. - /// - public class OfflineEntry - { - private object dataInstance; - - /// - /// Initializes a new instance of the class with an already serialized object. - /// - /// The key. - /// The object. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - /// The sync options. - public OfflineEntry(string key, object obj, string data, int priority, SyncOptions syncOptions, - bool isPartial = false) - { - Key = key; - Priority = priority; - Data = data; - Timestamp = DateTime.UtcNow; - SyncOptions = syncOptions; - IsPartial = isPartial; - - dataInstance = obj; - } - - /// - /// Initializes a new instance of the class. - /// - /// The key. - /// The object. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - /// The sync options. - public OfflineEntry(string key, object obj, int priority, SyncOptions syncOptions, bool isPartial = false) - : this(key, obj, JsonConvert.SerializeObject(obj), priority, syncOptions, isPartial) - { - } - - /// - /// Initializes a new instance of the class. - /// - public OfflineEntry() - { - } - - /// - /// Gets or sets the key of this entry. - /// - public string Key { get; set; } - - /// - /// Gets or sets the priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public int Priority { get; set; } - - /// - /// Gets or sets the timestamp when this entry was last touched. - /// - public DateTime Timestamp { get; set; } - - /// - /// Gets or sets the which define what sync state this entry is in. - /// - public SyncOptions SyncOptions { get; set; } - - /// - /// Gets or sets serialized JSON data. - /// - public string Data { get; set; } - - /// - /// Specifies whether this is only a partial object. - /// - public bool IsPartial { get; set; } - - /// - /// Deserializes into . The result is cached. - /// - /// Type of object to deserialize into. - /// Instance of . - public T Deserialize() - { - return (T) (dataInstance ?? (dataInstance = JsonConvert.DeserializeObject(Data))); - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/RealtimeDatabase.cs b/FireBase/Offline/RealtimeDatabase.cs deleted file mode 100644 index 973db46..0000000 --- a/FireBase/Offline/RealtimeDatabase.cs +++ /dev/null @@ -1,479 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Linq.Expressions; -using System.Net; -using System.Reactive.Disposables; -using System.Reactive.Linq; -using System.Reactive.Subjects; -using System.Reactive.Threading.Tasks; -using System.Reflection; -using System.Threading; -using System.Threading.Tasks; -using Firebase.Database.Extensions; -using Firebase.Database.Offline.Internals; -using Firebase.Database.Query; -using Firebase.Database.Streaming; -using Newtonsoft.Json; - -namespace Firebase.Database.Offline -{ - /// - /// The real-time Database which synchronizes online and offline data. - /// - /// Type of entities. - public class RealtimeDatabase : IDisposable where T : class - { - private readonly ChildQuery childQuery; - private readonly string elementRoot; - private readonly FirebaseCache firebaseCache; - private readonly InitialPullStrategy initialPullStrategy; - private readonly bool pushChanges; - private readonly StreamingOptions streamingOptions; - private readonly Subject> subject; - private FirebaseSubscription firebaseSubscription; - - private bool isSyncRunning; - private IObservable> observable; - - /// - /// Initializes a new instance of the class. - /// - /// The child query. - /// The element Root. - /// The offline database factory. - /// Custom string which will get appended to the file name. - /// Specifies whether changes should be streamed from the server. - /// - /// Specifies if everything should be pull from the online storage on start. It only - /// makes sense when is set to true. - /// - /// - /// Specifies whether changed items should actually be pushed to the server. If this is false, - /// then Put / Post / Delete will not affect server data. - /// - public RealtimeDatabase(ChildQuery childQuery, string elementRoot, - Func> offlineDatabaseFactory, string filenameModifier, - StreamingOptions streamingOptions, InitialPullStrategy initialPullStrategy, bool pushChanges, - ISetHandler setHandler = null) - { - this.childQuery = childQuery; - this.elementRoot = elementRoot; - this.streamingOptions = streamingOptions; - this.initialPullStrategy = initialPullStrategy; - this.pushChanges = pushChanges; - Database = offlineDatabaseFactory(typeof(T), filenameModifier); - firebaseCache = new FirebaseCache(new OfflineCacheAdapter(Database)); - subject = new Subject>(); - - PutHandler = setHandler ?? new SetHandler(); - - isSyncRunning = true; - Task.Factory.StartNew(SynchronizeThread, CancellationToken.None, TaskCreationOptions.LongRunning, - TaskScheduler.Default); - } - - /// - /// Gets the backing Database. - /// - public IDictionary Database { get; } - - public ISetHandler PutHandler { private get; set; } - - public void Dispose() - { - subject.OnCompleted(); - firebaseSubscription?.Dispose(); - } - - /// - /// Event raised whenever an exception is thrown in the synchronization thread. Exception thrown in there are - /// swallowed, so this event is the only way to get to them. - /// - public event EventHandler SyncExceptionThrown; - - /// - /// Overwrites existing object with given key. - /// - /// The key. - /// The object to set. - /// Indicates whether the item should be synced online. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public void Set(string key, T obj, SyncOptions syncOptions, int priority = 1) - { - SetAndRaise(key, new OfflineEntry(key, obj, priority, syncOptions)); - } - - public void Set(string key, Expression> propertyExpression, object value, - SyncOptions syncOptions, int priority = 1) - { - var fullKey = GenerateFullKey(key, propertyExpression, syncOptions); - var serializedObject = JsonConvert.SerializeObject(value).Trim('"', '\\'); - - if (fullKey.Item3) - { - if (typeof(TProperty) != typeof(string) || value == null) - // don't escape non-string primitives and null; - serializedObject = $"{{ \"{fullKey.Item2}\" : {serializedObject} }}"; - else - serializedObject = $"{{ \"{fullKey.Item2}\" : \"{serializedObject}\" }}"; - } - - var setObject = firebaseCache.PushData("/" + fullKey.Item1, serializedObject).First(); - - if (!Database.ContainsKey(key) || Database[key].SyncOptions != SyncOptions.Patch && - Database[key].SyncOptions != SyncOptions.Put) - Database[fullKey.Item1] = - new OfflineEntry(fullKey.Item1, value, serializedObject, priority, syncOptions, true); - - subject.OnNext(new FirebaseEvent(key, setObject.Object, - setObject == null ? FirebaseEventType.Delete : FirebaseEventType.InsertOrUpdate, - FirebaseEventSource.Offline)); - } - - /// - /// Fetches an object with the given key and adds it to the Database. - /// - /// The key. - /// - /// The priority. Objects with higher priority will be synced first. Higher number indicates higher - /// priority. - /// - public void Pull(string key, int priority = 1) - { - if (!Database.ContainsKey(key)) - Database[key] = new OfflineEntry(key, null, priority, SyncOptions.Pull); - else if (Database[key].SyncOptions == SyncOptions.None) - // pull only if push isn't pending - Database[key].SyncOptions = SyncOptions.Pull; - } - - /// - /// Fetches everything from the remote database. - /// - public async Task PullAsync() - { - var existingEntries = await childQuery - .OnceAsync() - .ToObservable() - .RetryAfterDelay>, FirebaseException>( - childQuery.Client.Options.SyncPeriod, - ex => ex.StatusCode == - HttpStatusCode - .OK) // OK implies the request couldn't complete due to network error. - .Select(e => ResetDatabaseFromInitial(e, false)) - .SelectMany(e => e) - .Do(e => - { - Database[e.Key] = new OfflineEntry(e.Key, e.Object, 1, SyncOptions.None); - subject.OnNext(new FirebaseEvent(e.Key, e.Object, FirebaseEventType.InsertOrUpdate, - FirebaseEventSource.OnlinePull)); - }) - .ToList(); - - // Remove items not stored online - foreach (var item in Database.Keys.Except(existingEntries.Select(f => f.Key)).ToList()) - { - Database.Remove(item); - subject.OnNext(new FirebaseEvent(item, null, FirebaseEventType.Delete, - FirebaseEventSource.OnlinePull)); - } - } - - /// - /// Retrieves all offline items currently stored in local database. - /// - public IEnumerable> Once() - { - return Database - .Where(kvp => !string.IsNullOrEmpty(kvp.Value.Data) && kvp.Value.Data != "null" && !kvp.Value.IsPartial) - .Select(kvp => new FirebaseObject(kvp.Key, kvp.Value.Deserialize())) - .ToList(); - } - - /// - /// Starts observing the real-time Database. Events will be fired both when change is done locally and remotely. - /// - /// Stream of . - public IObservable> AsObservable() - { - if (!isSyncRunning) - { - isSyncRunning = true; - Task.Factory.StartNew(SynchronizeThread, CancellationToken.None, TaskCreationOptions.LongRunning, - TaskScheduler.Default); - } - - if (observable == null) - { - var initialData = Observable.Return(FirebaseEvent.Empty(FirebaseEventSource.Offline)); - if (Database.TryGetValue(elementRoot, out var oe)) - initialData = Observable.Return(oe) - .Where(offlineEntry => - !string.IsNullOrEmpty(offlineEntry.Data) && offlineEntry.Data != "null" && - !offlineEntry.IsPartial) - .Select(offlineEntry => new FirebaseEvent(offlineEntry.Key, offlineEntry.Deserialize(), - FirebaseEventType.InsertOrUpdate, FirebaseEventSource.Offline)); - else if (Database.Count > 0) - initialData = Database - .Where(kvp => - !string.IsNullOrEmpty(kvp.Value.Data) && kvp.Value.Data != "null" && !kvp.Value.IsPartial) - .Select(kvp => new FirebaseEvent(kvp.Key, kvp.Value.Deserialize(), - FirebaseEventType.InsertOrUpdate, FirebaseEventSource.Offline)) - .ToList() - .ToObservable(); - - observable = initialData - .Merge(subject) - .Merge(GetInitialPullObservable() - .RetryAfterDelay>, FirebaseException>( - childQuery.Client.Options.SyncPeriod, - ex => ex.StatusCode == - HttpStatusCode - .OK) // OK implies the request couldn't complete due to network error. - .Select(e => ResetDatabaseFromInitial(e)) - .SelectMany(e => e) - .Do(SetObjectFromInitialPull) - .Select(e => new FirebaseEvent(e.Key, e.Object, - e.Object == null ? FirebaseEventType.Delete : FirebaseEventType.InsertOrUpdate, - FirebaseEventSource.OnlineInitial)) - .Concat(Observable.Create>(observer => - InitializeStreamingSubscription(observer)))) - .Do(next => { }, e => observable = null, () => observable = null) - .Replay() - .RefCount(); - } - - return observable; - } - - private IReadOnlyCollection> ResetDatabaseFromInitial( - IReadOnlyCollection> collection, bool onlyWhenInitialEverything = true) - { - if (onlyWhenInitialEverything && initialPullStrategy != InitialPullStrategy.Everything) return collection; - - // items which are in local db, but not in the online collection - var extra = Once() - .Select(f => f.Key) - .Except(collection.Select(c => c.Key)) - .Select(k => new FirebaseObject(k, null)); - - return collection.Concat(extra).ToList(); - } - - private void SetObjectFromInitialPull(FirebaseObject e) - { - // set object with no sync only if it doesn't exist yet - // and the InitialPullStrategy != Everything - // this attempts to deal with scenario when you are offline, have local changes and go online - // in this case having the InitialPullStrategy set to everything would basically purge all local changes - if (!Database.ContainsKey(e.Key) || Database[e.Key].SyncOptions == SyncOptions.None || - Database[e.Key].SyncOptions == SyncOptions.Pull || - initialPullStrategy != InitialPullStrategy.Everything) - Database[e.Key] = new OfflineEntry(e.Key, e.Object, 1, SyncOptions.None); - } - - private IObservable>> GetInitialPullObservable() - { - FirebaseQuery query; - switch (initialPullStrategy) - { - case InitialPullStrategy.MissingOnly: - query = childQuery.OrderByKey().StartAt(() => GetLatestKey()); - break; - case InitialPullStrategy.Everything: - query = childQuery; - break; - case InitialPullStrategy.None: - default: - return Observable.Empty>>(); - } - - if (string.IsNullOrWhiteSpace(elementRoot)) - return Observable.Defer(() => query.OnceAsync().ToObservable()); - - // there is an element root, which indicates the target location is not a collection but a single element - return Observable.Defer(async () => - Observable.Return(await query.OnceSingleAsync()) - .Select(e => new[] {new FirebaseObject(elementRoot, e)})); - } - - private IDisposable InitializeStreamingSubscription(IObserver> observer) - { - var completeDisposable = Disposable.Create(() => isSyncRunning = false); - - switch (streamingOptions) - { - case StreamingOptions.LatestOnly: - // stream since the latest key - var queryLatest = childQuery.OrderByKey().StartAt(() => GetLatestKey()); - firebaseSubscription = - new FirebaseSubscription(observer, queryLatest, elementRoot, firebaseCache); - firebaseSubscription.ExceptionThrown += StreamingExceptionThrown; - - return new CompositeDisposable(firebaseSubscription.Run(), completeDisposable); - case StreamingOptions.Everything: - // stream everything - var queryAll = childQuery; - firebaseSubscription = new FirebaseSubscription(observer, queryAll, elementRoot, firebaseCache); - firebaseSubscription.ExceptionThrown += StreamingExceptionThrown; - - return new CompositeDisposable(firebaseSubscription.Run(), completeDisposable); - } - - return completeDisposable; - } - - private void SetAndRaise(string key, OfflineEntry obj, - FirebaseEventSource eventSource = FirebaseEventSource.Offline) - { - Database[key] = obj; - subject.OnNext(new FirebaseEvent(key, obj?.Deserialize(), - string.IsNullOrEmpty(obj?.Data) || obj?.Data == "null" - ? FirebaseEventType.Delete - : FirebaseEventType.InsertOrUpdate, eventSource)); - } - - private async void SynchronizeThread() - { - while (isSyncRunning) - { - try - { - var validEntries = Database.Where(e => e.Value != null); - await PullEntriesAsync(validEntries.Where(kvp => kvp.Value.SyncOptions == SyncOptions.Pull)); - - if (pushChanges) - await PushEntriesAsync(validEntries.Where(kvp => - kvp.Value.SyncOptions == SyncOptions.Put || kvp.Value.SyncOptions == SyncOptions.Patch)); - } - catch (Exception ex) - { - SyncExceptionThrown?.Invoke(this, new ExceptionEventArgs(ex)); - } - - await Task.Delay(childQuery.Client.Options.SyncPeriod); - } - } - - private string GetLatestKey() - { - var key = Database.OrderBy(o => o.Key, StringComparer.Ordinal).LastOrDefault().Key ?? string.Empty; - - if (!string.IsNullOrWhiteSpace(key)) - key = key.Substring(0, key.Length - 1) + (char) (key[key.Length - 1] + 1); - - return key; - } - - private async Task PushEntriesAsync(IEnumerable> pushEntries) - { - var groups = pushEntries.GroupBy(pair => pair.Value.Priority).OrderByDescending(kvp => kvp.Key).ToList(); - - foreach (var group in groups) - { - var tasks = group.OrderBy(kvp => kvp.Value.IsPartial).Select(kvp => - kvp.Value.IsPartial - ? ResetSyncAfterPush(PutHandler.SetAsync(childQuery, kvp.Key, kvp.Value), kvp.Key) - : ResetSyncAfterPush(PutHandler.SetAsync(childQuery, kvp.Key, kvp.Value), kvp.Key, - kvp.Value.Deserialize())); - - try - { - await Task.WhenAll(tasks).WithAggregateException(); - } - catch (Exception ex) - { - SyncExceptionThrown?.Invoke(this, new ExceptionEventArgs(ex)); - } - } - } - - private async Task PullEntriesAsync(IEnumerable> pullEntries) - { - var taskGroups = pullEntries.GroupBy(pair => pair.Value.Priority).OrderByDescending(kvp => kvp.Key); - - foreach (var group in taskGroups) - { - var tasks = group.Select(pair => - ResetAfterPull( - childQuery.Child(pair.Key == elementRoot ? string.Empty : pair.Key).OnceSingleAsync(), - pair.Key, pair.Value)); - - try - { - await Task.WhenAll(tasks).WithAggregateException(); - } - catch (Exception ex) - { - SyncExceptionThrown?.Invoke(this, new ExceptionEventArgs(ex)); - } - } - } - - private async Task ResetAfterPull(Task task, string key, OfflineEntry entry) - { - await task; - SetAndRaise(key, new OfflineEntry(key, task.Result, entry.Priority, SyncOptions.None), - FirebaseEventSource.OnlinePull); - } - - private async Task ResetSyncAfterPush(Task task, string key, T obj) - { - await ResetSyncAfterPush(task, key); - - if (streamingOptions == StreamingOptions.None) - subject.OnNext(new FirebaseEvent(key, obj, - obj == null ? FirebaseEventType.Delete : FirebaseEventType.InsertOrUpdate, - FirebaseEventSource.OnlinePush)); - } - - private async Task ResetSyncAfterPush(Task task, string key) - { - await task; - ResetSyncOptions(key); - } - - private void ResetSyncOptions(string key) - { - var item = Database[key]; - - if (item.IsPartial) - { - Database.Remove(key); - } - else - { - item.SyncOptions = SyncOptions.None; - Database[key] = item; - } - } - - private void StreamingExceptionThrown(object sender, ExceptionEventArgs e) - { - SyncExceptionThrown?.Invoke(this, new ExceptionEventArgs(e.Exception)); - } - - private Tuple GenerateFullKey(string key, - Expression> propertyGetter, SyncOptions syncOptions) - { - var visitor = new MemberAccessVisitor(); - visitor.Visit(propertyGetter); - var propertyType = typeof(TProperty).GetTypeInfo(); - var prefix = key == string.Empty ? string.Empty : key + "/"; - - // primitive types - if (syncOptions == SyncOptions.Patch && (propertyType.IsPrimitive || - Nullable.GetUnderlyingType(typeof(TProperty)) != null || - typeof(TProperty) == typeof(string))) - return Tuple.Create(prefix + string.Join("/", visitor.PropertyNames.Skip(1).Reverse()), - visitor.PropertyNames.First(), true); - - return Tuple.Create(prefix + string.Join("/", visitor.PropertyNames.Reverse()), - visitor.PropertyNames.First(), false); - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/SetHandler.cs b/FireBase/Offline/SetHandler.cs deleted file mode 100644 index 6314c3c..0000000 --- a/FireBase/Offline/SetHandler.cs +++ /dev/null @@ -1,19 +0,0 @@ -using System.Threading.Tasks; -using Firebase.Database.Query; - -namespace Firebase.Database.Offline -{ - public class SetHandler : ISetHandler - { - public virtual async Task SetAsync(ChildQuery query, string key, OfflineEntry entry) - { - using (var child = query.Child(key)) - { - if (entry.SyncOptions == SyncOptions.Put) - await child.PutAsync(entry.Data); - else - await child.PatchAsync(entry.Data); - } - } - } -} \ No newline at end of file diff --git a/FireBase/Offline/StreamingOptions.cs b/FireBase/Offline/StreamingOptions.cs deleted file mode 100644 index a420cbb..0000000 --- a/FireBase/Offline/StreamingOptions.cs +++ /dev/null @@ -1,23 +0,0 @@ -namespace Firebase.Database.Offline -{ - public enum StreamingOptions - { - /// - /// No realtime streaming. - /// - None, - - /// - /// Streaming of only new items - not the existing ones. - /// - LatestOnly, - - /// - /// Streaming of all items. This will also pull all existing items on start, so be mindful about the number of items in - /// your DB. - /// When used, consider not setting the to - /// because you would pointlessly pull everything twice. - /// - Everything - } -} \ No newline at end of file diff --git a/FireBase/Offline/SyncOptions.cs b/FireBase/Offline/SyncOptions.cs deleted file mode 100644 index ca68d0a..0000000 --- a/FireBase/Offline/SyncOptions.cs +++ /dev/null @@ -1,28 +0,0 @@ -namespace Firebase.Database.Offline -{ - /// - /// Specifies type of sync requested for given data. - /// - public enum SyncOptions - { - /// - /// No sync needed for given data. - /// - None, - - /// - /// Data should be pulled from firebase. - /// - Pull, - - /// - /// Data should be put to firebase. - /// - Put, - - /// - /// Data should be patched in firebase. - /// - Patch - } -} \ No newline at end of file -- cgit v1.3.1