Addition of a Filter to ORMConfig to enable users access to the Ref Sql Statement (#615)

* Added in the ability to Filter/Adjust the Ref Sql Queries before being executed, a use case is being able to append a AND clause to the end allow for the filteration of "soft deleted" records

* removed unused operators

* - Removed redundant Invoke Methods
- Added Tests to demonstration the usage of the SqlSelectRefFilter

Author: mitch-tofi

src/ServiceStack.OrmLite/OrmLiteConfig.cs

@@ -176,6 +176,8 @@ public static IOrmLiteExecFilter ExecFilter
         public static Action<IDbCommand, object> InsertFilter { get; set; }
         public static Action<IDbCommand, object> UpdateFilter { get; set; }
         public static Action<IUntypedSqlExpression> SqlExpressionSelectFilter { get; set; }
+        public static Func<Type, string, string> SqlSelectRefFilter { get; set; }
+
 
         public static Func<string, string> StringFilter { get; set; }
 

src/ServiceStack.OrmLite/Support/LoadList.cs

@@ -54,6 +54,9 @@ protected string GetRefListSql(ModelDefinition refModelDef, FieldDefinition refF
                          $"WHERE {dialectProvider.GetQuotedColumnName(refField)} " +
                          $"IN ({subSql})";
 
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sqlRef = OrmLiteConfig.SqlSelectRefFilter(refModelDef.ModelType, sqlRef);
+
             return sqlRef;
         }
 
@@ -98,6 +101,9 @@ protected string GetRefSelfSql(ModelDefinition modelDef, FieldDefinition refSelf
                          $"WHERE {dialectProvider.GetQuotedColumnName(refModelDef.PrimaryKey)} " +
                          $"IN ({subSqlRef})";
 
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sqlRef = OrmLiteConfig.SqlSelectRefFilter(refModelDef.ModelType, sqlRef);
+
             return sqlRef;
         }
 
@@ -107,6 +113,10 @@ protected string GetRefFieldSql(ModelDefinition refModelDef, FieldDefinition ref
                          $"FROM {dialectProvider.GetQuotedTableName(refModelDef)} " +
                          $"WHERE {dialectProvider.GetQuotedColumnName(refField)} " +
                          $"IN ({subSql})";
+
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sqlRef = OrmLiteConfig.SqlSelectRefFilter(refModelDef.ModelType, sqlRef);
+
             return sqlRef;
         }
 

src/ServiceStack.OrmLite/Support/LoadReferences.cs

@@ -38,13 +38,20 @@ protected string GetRefListSql(Type refType)
             var sqlFilter = dialectProvider.GetQuotedColumnName(refField.FieldName) + "={0}";
             var sql = dialectProvider.ToSelectStatement(refType, sqlFilter, pkValue);
 
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sql = OrmLiteConfig.SqlSelectRefFilter(refType, sql);
+
             return sql;
         }
 
         protected string GetRefFieldSql(Type refType, FieldDefinition refField)
         {
             var sqlFilter = dialectProvider.GetQuotedColumnName(refField.FieldName) + "={0}";
             var sql = dialectProvider.ToSelectStatement(refType, sqlFilter, pkValue);
+
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sql = OrmLiteConfig.SqlSelectRefFilter(refType, sql);
+
             return sql;
         }
 
@@ -57,6 +64,10 @@ protected string GetRefSelfSql(Type refType, FieldDefinition refSelf, ModelDefin
 
             var sqlFilter = dialectProvider.GetQuotedColumnName(refModelDef.PrimaryKey.FieldName) + "={0}";
             var sql = dialectProvider.ToSelectStatement(refType, sqlFilter, refPkValue);
+
+            if (OrmLiteConfig.SqlSelectRefFilter != null)
+                sql = OrmLiteConfig.SqlSelectRefFilter(refType, sql);
+
             return sql;
         }
     }

tests/ServiceStack.OrmLite.Tests/SoftDeleteTests.cs

@@ -119,5 +119,70 @@ public void Can_get_active_products_using_SoftDelete_SqlExpression()
 
             OrmLiteConfig.SqlExpressionSelectFilter = null;
         }
+
+        [Test]
+        public void Can_get_active_vendor_and_active_references_using_SoftDelete_ref_filter()
+        {
+            OrmLiteConfig.SqlExpressionSelectFilter = q =>
+            {
+                if (q.ModelDef.ModelType.HasInterface(typeof(ISoftDelete)))
+                {
+                    q.Where<ISoftDelete>(x => !x.IsDeleted);
+                }
+            };
+
+            OrmLiteConfig.SqlSelectRefFilter = (type, sql) =>
+            {
+                var meta = type.GetModelMetadata();
+                if (type.HasInterface(typeof(ISoftDelete)))
+                {
+                    sql += $" AND (\"{meta.ModelName}\".\"IsDeleted\" = 0)";
+                }
+
+                return sql;
+            };
+
+            using (var db = OpenDbConnection())
+            {
+                InitData(db);
+
+                var vendors = db.LoadSelect<Vendor>();
+
+                Assert.That(vendors.Count, Is.EqualTo(1));
+                Assert.That(vendors[0].Name, Is.EqualTo("Active Vendor"));
+                Assert.That(vendors[0].Products.Count, Is.EqualTo(1));
+            }
+
+            OrmLiteConfig.SqlExpressionSelectFilter = null;
+            OrmLiteConfig.SqlSelectRefFilter = null;
+        }
+
+        [Test]
+        public void Can_get_single_vendor_and__load_active_references_using_soft_delete_ref_filter()
+        {
+            OrmLiteConfig.SqlSelectRefFilter = (type, sql) =>
+            {
+                var meta = type.GetModelMetadata();
+                if (type.HasInterface(typeof(ISoftDelete)))
+                {
+                    sql += $" AND (\"{meta.ModelName}\".\"IsDeleted\" = 0)";
+                }
+
+                return sql;
+            };
+
+            using (var db = OpenDbConnection())
+            {
+                InitData(db);
+
+                var vendor = db.Single<Vendor>(v=>v.Name == "Active Vendor");
+                db.LoadReferences(vendor);
+
+                Assert.That(vendor.Name, Is.EqualTo("Active Vendor"));
+                Assert.That(vendor.Products.Count, Is.EqualTo(1));
+            }
+
+            OrmLiteConfig.SqlSelectRefFilter = null;
+        }
     }
 }