Core item disposability

SacsStandardAccounts/Accounts/QuickBooks/App/SaQuickBooksConsole.cs

@@ -13,7 +13,7 @@ using Sarand.Net.Standard.Base.Utils;
 namespace Sarand.Net.Standard.Accounts.QuickBooks.App
 {
 	//=======================================================================
-	public class SaQuickBooksConsole : SaErrorStateItem
+	public class SaQuickBooksConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardAccounts/Accounts/QuickBooks/Base/SaQuickBooksApiConsole.cs

@@ -8,7 +8,7 @@ using System.Text;
 namespace Sarand.Net.Standard.Accounts.QuickBooks.Base
 {
 	//=======================================================================
-	public abstract class SaQuickBooksApiConsole : SaErrorStateItem
+	public abstract class SaQuickBooksApiConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardAccounts/Accounts/QuickBooks/Base/SaQuickBooksDataItem.cs

@@ -107,7 +107,7 @@ namespace Sarand.Net.Standard.Accounts.QuickBooks.Base
 		//-------------------------------------------------------------------
 		//                          I t e r a t o r
 		//-------------------------------------------------------------------
-		public abstract class Iterator : SaErrorStateItem
+		public abstract class Iterator : SacsDisposableStateItem
 		{
 			//---------------------------------------------------------------
 			// Data members.
@@ -119,13 +119,6 @@ namespace Sarand.Net.Standard.Accounts.QuickBooks.Base
 			{
 				EntityType = entityType;
 			}
-			protected override void Dispose(bool disposing)
-			{
-				if (disposing)
-				{
-				}
-				base.Dispose(disposing);
-			}
 			//---------------------------------------------------------------
 			// Properties.
 			public Qbk.EntityType EntityType { get; }

SacsStandardAccounts/Accounts/QuickBooks/Internal/SaQuickBooksDataItem.cs

@@ -42,13 +42,6 @@ namespace Sarand.Net.Standard.Accounts.QuickBooks.Internal
 			protected Iterator (Qbk.EntityType entityType) : base(entityType)
 			{
 			}
-			protected override void Dispose (bool disposing)
-			{
-				if (disposing)
-				{
-				}
-				base.Dispose(disposing);
-			}
 			//---------------------------------------------------------------
 			// Properties.
 			//---------------------------------------------------------------

SacsStandardAccounts/Accounts/QuickBooks/Online/SaQuickBooksDataItem_Online.cs

@@ -68,7 +68,7 @@ namespace Sarand.Net.Standard.Accounts.QuickBooks.Online
 			{
 				if (disposing)
 				{
-					qbkConsole = null;
+					qbkConsole.Dispose(); qbkConsole = null;
 				}
 				base.Dispose(disposing);
 			}

SacsStandardAccounts/Accounts/QuickBooks/Online/SaQuickBooksRequest_Online.cs

@@ -10,7 +10,7 @@ using System.Xml.Linq;
 namespace Sarand.Net.Standard.Accounts.QuickBooks.Online
 {
 	//=======================================================================
-	internal class SaQuickBooksRequest_Online : SaErrorStateItem
+	internal class SaQuickBooksRequest_Online : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardBase/Base/Bus/SacsDisposableStateItem.cs

@@ -0,0 +1,50 @@
+using System;
+using Sarand.Net.Standard.Base.Core;
+using Sarand.Net.Standard.Base.Utils;
+
+namespace Sarand.Net.Standard.Base.Bus
+{
+	//=======================================================================
+	public abstract class SacsDisposableStateItem : SacsStateItem, ISacsDisposable
+	{
+		//-------------------------------------------------------------------
+		// Definitions.
+
+		//-------------------------------------------------------------------
+		// Data members.
+		private bool disposed = false;
+
+		//-------------------------------------------------------------------
+		// Construction.
+		protected SacsDisposableStateItem()
+		{
+		}
+
+		//-------------------------------------------------------------------
+		// Disposal.
+		~SacsDisposableStateItem()
+		{
+			Dispose(!disposed);
+		}
+		public void Dispose()
+		{
+			if (disposed) return;
+			Dispose(true);
+			disposed = true;
+			GC.SuppressFinalize(this);
+		}
+		protected virtual void Dispose(bool disposing)
+		{
+			if (disposing)
+			{
+			}
+		}
+
+		//-------------------------------------------------------------------
+		// Properties.
+		public bool Disposed { get { return disposed; } }
+
+		//-------------------------------------------------------------------
+	}
+	//=======================================================================
+}

SacsStandardBase/Base/Bus/SacsHierarchyItem.cs

@@ -32,7 +32,7 @@ namespace Sarand.Net.Standard.Base.Bus
 		}
 	}
 	//=======================================================================
-	public class SacsHierarchyItem : SaErrorStateItem
+	public class SacsHierarchyItem : SacsStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.
@@ -333,15 +333,6 @@ namespace Sarand.Net.Standard.Base.Bus
 			data.Id = id;
 		}
 
-		//-------------------------------------------------------------------
-		// Disposal.
-		protected override void Dispose(bool disposing)
-		{
-			if (disposing)
-			{
-			}
-		}
-
 		//-------------------------------------------------------------------
 		// Properties.
 		/// <summary>By default, all hierarchy itrems have an Id.<br/>Override and return false where this is not the case.</summary>

SacsStandardBase/Base/Bus/SacsItemMgr.cs

@@ -9,7 +9,7 @@ using Sarand.Net.Standard.Base.Utils;
 namespace Sarand.Net.Standard.Base.Bus
 {
 	//=======================================================================
-	public abstract class SacsItemMgr : SaErrorStateItem
+	public abstract class SacsItemMgr : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/Bus/SacsStateItem.cs

@@ -5,7 +5,10 @@ using Sarand.Net.Standard.Base.Utils;
 namespace Sarand.Net.Standard.Base.Bus
 {
 	//=======================================================================
-	public abstract class SaErrorStateItem : SacsDisposable, ISacsStateItem
+	/// <summary>
+	/// State Item - allows business component to record and report error message.
+	/// </summary>
+	public abstract class SacsStateItem : ISacsStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.
@@ -32,21 +35,15 @@ namespace Sarand.Net.Standard.Base.Bus
 
 		//-------------------------------------------------------------------
 		// Static initialisation.
-		static SaErrorStateItem()
+		static SacsStateItem()
 		{
 		}
 
 		//-------------------------------------------------------------------
 		// Construction.
-		protected SaErrorStateItem()
+		protected SacsStateItem()
 		{
 		}
-		protected override void Dispose(bool disposing)
-		{
-			if (disposing)
-			{
-			}
-		}
 
 		//-------------------------------------------------------------------
 		// Properties.
@@ -79,7 +76,8 @@ namespace Sarand.Net.Standard.Base.Bus
 		/// </summary>
 		public bool SetErrorState(String message)
 		{
-			if (StringUtil.IsEmpty(message)) return true;
+			if (StringUtil.IsBlank(message))
+				return false;
 			this.errorState = new SacsErrorState(message);
 			return false;
 		}

SacsStandardBase/Base/CodeTypes/SaCodeTypeConsole.cs

@@ -9,7 +9,7 @@ using System.Threading.Tasks;
 namespace Sarand.Net.Standard.Base.CodeTypes
 {
 	//=======================================================================
-	public abstract class SaCodeTypeConsole : SaErrorStateItem
+	public abstract class SaCodeTypeConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardBase/Base/Core/ISacsStateItem.cs

@@ -0,0 +1,18 @@
+using Sarand.Net.Standard.Base.Utils;
+using System;
+
+namespace Sarand.Net.Standard.Base.Core
+{
+	//=======================================================================
+	/// <summary>State Item interface.</summary>
+	public interface ISacsStateItem
+	{
+		bool HasErrorState();
+		SacsErrorState ErrorState { get; }
+		String ErrorStateMessage { get; }
+		bool SetErrorState(String message);
+		void ClearErrorState();
+	}
+
+	//=======================================================================
+}

SacsStandardBase/Base/Core/SacsDisposable.cs

@@ -3,7 +3,18 @@
 namespace Sarand.Net.Standard.Base.Core
 {
 	//=======================================================================
-	public abstract class SacsDisposable : IDisposable
+	/// <summary>
+	/// Disposable class.
+	/// <br/>- Override 'protecetd void Dispose(bool disposing)' to dispose resources when flag is true.
+	/// </summary>
+	public interface ISacsDisposable : IDisposable
+	{
+		/// <summary>Returns flag to indicate whether object has been disposed.</summary>
+		bool Disposed { get; }
+	}
+
+	//=======================================================================
+	public abstract class SacsDisposable : ISacsDisposable
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardBase/Base/Core/SacsStateItem.cs

@@ -1,63 +0,0 @@
-using Sarand.Net.Standard.Base.Utils;
-using System;
-
-namespace Sarand.Net.Standard.Base.Core
-{
-	//=======================================================================
-	/// <summary>State Item interface.</summary>
-	public interface ISacsStateItem
-	{
-		bool HasErrorState();
-		SacsErrorState ErrorState { get; }
-		String ErrorStateMessage { get; }
-		bool SetErrorState(String message);
-		void ClearErrorState();
-	}
-
-	//=======================================================================
-	/// <summary>
-	/// State Item - allows business component to record and report error message.
-	/// </summary>
-	public class SacsStateItem : ISacsStateItem
-	{
-		//-------------------------------------------------------------------
-		// Data items.
-
-		//-------------------------------------------------------------------
-		// Protected construction - use derived classes.
-		protected SacsStateItem() { }
-
-		//-------------------------------------------------------------------
-		// Poperties.
-
-		/// <summary>OK - No error state message.</summary>
-		public bool OK { get { return !HasErrorState(); } }
-
-		// Error state.
-		public SacsErrorState ErrorState { get; private set; }
-		public bool HasErrorState()
-		{
-			return ErrorState != null;
-		}
-		public String ErrorStateMessage
-		{
-			get { return (ErrorState != null ? ErrorState.Message : String.Empty); }
-		}
-		// Update properties.
-		public virtual bool SetErrorState(String message)
-		{
-			if (StringUtil.IsEmpty(StringUtil.EmptyOnNull(message).Trim()))
-				throw new NotSupportedException($"{SysUtil.Fn} Blank error message.");
-			this.ErrorState = new SacsErrorState(message);
-			return false;
-		}
-		public void ClearErrorState()
-		{
-			ErrorState = null;
-		}
-
-		//-------------------------------------------------------------------
-	}
-
-	//=======================================================================
-}

SacsStandardBase/Base/Dbas/DbResultSet.cs

@@ -6,7 +6,7 @@ using Sarand.Net.Standard.Base.App;
 namespace Sarand.Net.Standard.Base.Dbas
 {
 	//=======================================================================
-	public abstract class DbResultSet : SaErrorStateItem, IDbResultSet
+	public abstract class DbResultSet : SacsDisposableStateItem, IDbResultSet
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardBase/Base/Dbas/IDbResultSet.cs

@@ -4,7 +4,7 @@ using Sarand.Net.Standard.Base.Core;
 namespace Sarand.Net.Standard.Base.Dbas
 {
 	//=======================================================================
-	interface IDbResultSet : IDisposable
+	interface IDbResultSet : ISacsDisposable
 	{
 		//-------------------------------------------------------------------
 		// Navigation.

SacsStandardBase/Base/Diary/SaDiaryConsole.cs

@@ -6,7 +6,7 @@ using System.Text;
 namespace Sarand.Net.Standard.Base.Diary
 {
 	//=======================================================================
-	public abstract class SaDiaryConsole : SaErrorStateItem
+	public abstract class SaDiaryConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/Interfaces/SaInterfaceConsole.cs

@@ -10,7 +10,7 @@ using System.Collections.Generic;
 namespace Sarand.Net.Standard.Base.Interfaces
 {
 	//=======================================================================
-	public abstract class SaInterfaceConsole : SaErrorStateItem
+	public abstract class SaInterfaceConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Interface definition.

SacsStandardBase/Base/ItemData/SaItemDataConsole.cs

@@ -8,7 +8,7 @@ using System.Text;
 namespace Sarand.Net.Standard.Base.ItemData
 {
 	//=======================================================================
-	public abstract class SaItemDataConsole : SaErrorStateItem
+	public abstract class SaItemDataConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/ItemDocs/SaItemDocConsole.cs

@@ -8,7 +8,7 @@ using System.Text;
 namespace Sarand.Net.Standard.Base.ItemDocs
 {
 	//=======================================================================
-	public abstract class SaItemDocConsole : SaErrorStateItem
+	public abstract class SaItemDocConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/ItemOptions/SaItemOptionConsole.cs

@@ -9,7 +9,7 @@ using Sarand.Net.Standard.Base.UpdateLog;
 namespace Sarand.Net.Standard.Base.ItemOptions
 {
 	//=======================================================================
-	public abstract class SaItemOptionConsole : SaErrorStateItem
+	public abstract class SaItemOptionConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/Procs/SaReport_Base.cs

@@ -5,7 +5,7 @@ using Sarand.Net.Standard.Base.Bus;
 namespace Sarand.Net.Standard.Base.Procs
 {
 	//=======================================================================
-	public abstract class SaReport_Base : SaErrorStateItem
+	public abstract class SaReport_Base : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/ReferenceData/SaReferenceDataConsole.cs

@@ -129,7 +129,7 @@ namespace Sarand.Net.Standard.Base.ReferenceData
 	};
 
 	//=======================================================================
-	public abstract partial class SaReferenceDataConsole : SaErrorStateItem
+	public abstract partial class SaReferenceDataConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/Security/SaSecurityConsole.cs

@@ -38,7 +38,7 @@ namespace Sarand.Net.Standard.Base.Security
 	}
 
 	//=======================================================================
-	public abstract class SaSecurityConsole : SaErrorStateItem
+	public abstract class SaSecurityConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/Base/UpdateLog/SaUpdateLogConsole.cs

@@ -9,7 +9,7 @@ namespace Sarand.Net.Standard.Base.UpdateLog
 	// Definitions.
 
 	//=======================================================================
-	public abstract class SaUpdateLogConsole : SaErrorStateItem
+	public abstract class SaUpdateLogConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardBase/SacsStandardBase.csproj

@@ -7,11 +7,11 @@
 
 	<ItemGroup>
 		<PackageReference Include="CsvHelper" Version="19.0.0" />
-		<PackageReference Include="MailKit" Version="4.11.0" />
+		<PackageReference Include="MailKit" Version="4.13.0" />
 		<PackageReference Include="Microsoft.AspNetCore.Http" Version="2.3.0" />
 		<PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="2.3.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-		<PackageReference Include="SixLabors.ImageSharp" Version="3.1.7" />
+		<PackageReference Include="SixLabors.ImageSharp" Version="3.1.11" />
 		<PackageReference Include="ZstdNet" Version="1.4.5" />
 	</ItemGroup>
 

SacsStandardDbas/Dbas/Base/SacsDatabaseConsole.cs

@@ -12,7 +12,7 @@ using System.Text.RegularExpressions;
 namespace Sarand.Net.Standard.Dbas.Base
 {
 	//=======================================================================
-	public class SacsDatabaseConsole : SaErrorStateItem
+	public class SacsDatabaseConsole : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Database configuration

SacsStandardDbas/Dbas/Security/SaSecurityConsole_Dbas.cs

@@ -223,8 +223,7 @@ namespace Sarand.Net.Standard.Dbas.Security
 		public override bool LoginUser(SysId userId, bool recordLastLogin = true)
 		{
 			ClearErrorState();
-			using (SaSecurityItem secItemUser = securityMgr.GetSecurityItemById(userId))
+			SaSecurityItem secItemUser = securityMgr.GetSecurityItemById(userId);
-			{
 				if (secItemUser == null || secItemUser.ItemType != SaSecurity.ItemType.User || !secItemUser.IsStatusEnabled)
 				{
 					SaLogger.Error($"{SysUtil.Fn}Failed to retrieve user for login. Id: {SysId.ToString(userId)} - {securityMgr.ErrorStateMessage}", true);
@@ -237,7 +236,6 @@ namespace Sarand.Net.Standard.Dbas.Security
 						SaLogger.Error($"{SysUtil.Fn}Failed to update user on login. Id: {SysId.ToString(userId)}' - {securityMgr.ErrorStateMessage}", true);
 				}
 				OnLogin(secItemUser != null ? secItemUser.Id : null);
-			}
 			return true;
 		}
 		public override bool LoginAuthenticatedUser()

SacsStandardProc/Proc/Excel/SaMsSpreadsheet.cs

@@ -248,7 +248,7 @@ namespace Sarand.Net.Standard.Proc.Excel
 		}
 	}
 	//=======================================================================
-	public abstract class SaMsSpreadsheet : SaErrorStateItem
+	public abstract class SaMsSpreadsheet : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Definitions.

SacsStandardProc/Proc/Excel/SaMsSpreadsheet_POI.cs

@@ -845,7 +845,11 @@ namespace Sarand.Net.Standard.Proc.Excel
 			try
 			{
 				if (IsCellDate(cell))
-					return new DataValue((DateTime)(cell.DateCellValue ?? DateTime.MinValue));
+				{
+					// Ref. https://stackoverflow.com/questions/23280533/apache-poi-getting-a-null-pointer-while-reading-a-cell-with-value
+					// recommends using DateTime.FromOADate(cell.NumericCellValue) rather than cell.DateCellValue
+					return new DataValue(cell.DateCellValue);
+				}
 				if (IsCellNumeric(cell))
 				{
 					double value = cell.NumericCellValue;

SacsStandardProc/Proc/Xml/SaMsXmlDocument.cs

@@ -9,7 +9,7 @@ using Sarand.Net.Standard.Base.Utils;
 namespace Sarand.Net.Standard.Proc.Xml
 {
 	//=======================================================================
-	public class SaMsXmlDocument : SaErrorStateItem
+	public class SaMsXmlDocument : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardProc/Proc/Xml/SaMsXmlNode.cs

@@ -11,7 +11,7 @@ using Sarand.Net.Standard.Base.Utils;
 namespace Sarand.Net.Standard.Proc.Xml
 {
 	//=======================================================================
-	public class SaMsXmlNode : SaErrorStateItem
+	public class SaMsXmlNode : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardProc/Proc/Zip/SaMsZipArchive.cs

@@ -12,7 +12,7 @@ using System.Text;
 namespace Sarand.Net.Standard.Proc.Zip
 {
 	//=======================================================================
-	public class SaMsZipArchive : SaErrorStateItem
+	public class SaMsZipArchive : SacsDisposableStateItem
 	{
 		//-------------------------------------------------------------------
 		// Data members.

SacsStandardProc/SacsStandardProc.csproj

@@ -11,7 +11,7 @@
 
   <ItemGroup>
     <PackageReference Include="DocumentFormat.OpenXml" Version="3.3.0" />
-    <PackageReference Include="NPOI" Version="2.7.3" />
+    <PackageReference Include="NPOI" Version="2.6.2" />
   </ItemGroup>
 
   <ItemGroup>