Changeset 2020 for trunk/eraser

Timestamp:

5/3/2010 1:01:55 PM (3 years ago)

Author:

lowjoel

Message:

Rearchitect the API for the ErasureTarget? class to be simpler.

Location:

trunk/eraser

Files:

• Eraser.Manager/Eraser.Manager.csproj (modified) (1 diff)
• Eraser.Manager/ErasureTarget.cs (modified) (9 diffs)
• Eraser/TaskDataSelectionForm.cs (modified) (1 diff)
• Eraser/TaskPropertiesForm.cs (modified) (3 diffs)

trunk/eraser/Eraser.Manager/Eraser.Manager.csproj

@@ -67 +67 @@
     <Compile Include="DirectExecutor.cs" />
     <Compile Include="EntropySource.cs" />
+    <Compile Include="ErasureTarget.cs" />
     <Compile Include="Exception.cs" />
     <Compile Include="Executor.cs" />

trunk/eraser/Eraser.Manager/ErasureTarget.cs

@@ -46 +46 @@
             Guid methodGuid = (Guid)info.GetValue("Method", typeof(Guid));
             if (methodGuid == Guid.Empty)
-                method = ErasureMethodRegistrar.Default;
+                Method = ErasureMethodRegistrar.Default;
             else
-                method = ManagerLibrary.Instance.ErasureMethodRegistrar[methodGuid];
+                Method = ManagerLibrary.Instance.ErasureMethodRegistrar[methodGuid];
         }
 
@@ -54 +54 @@
         public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
         {
-            info.AddValue("Method", method.Guid);
+            info.AddValue("Method", Method.Guid);
         }
         #endregion
@@ -63 +63 @@
         protected ErasureTarget()
         {
-        }
-
-        /// <summary>
-        /// The method used for erasing the file. If the variable is equal to
-        /// ErasureMethodManager.Default then the default is queried for the
-        /// task type. Check the <see cref="MethodDefined"/> property to see if
-        /// this variable was set on deliberately or if the result of the get
-        /// call is from the inferred default.
-        /// </summary>
-        public virtual ErasureMethod Method
-        {
-            get
-            {
-                return method;
-            }
-            set
-            {
-                method = value;
-                MethodDefined = method != ErasureMethodRegistrar.Default;
-            }
-        }
-
-        /// <summary>
-        /// Checks whether a method has been selected for this target. This is
-        /// because the Method property will return non-default erasure methods
-        /// only.
-        /// </summary>
-        public bool MethodDefined { get; private set; }
+            Method = ErasureMethodRegistrar.Default;
+        }
+
+        /// <summary>
+        /// The method used for erasing the file.
+        /// </summary>
+        public ErasureMethod Method
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// Gets the effective erasure method for the current target (i.e., returns
+        /// the correct erasure method for cases where the <see cref="Method"/>
+        /// property is <see cref="ErasureMethodRegistrar.Default"/>
+        /// </summary>
+        /// <returns>The Erasure method which the target should be erased with.
+        /// This function will never return <see cref="ErasureMethodRegistrar.Default"/></returns>
+        public virtual ErasureMethod EffectiveMethod
+        {
+            get
+            {
+                if (Method != ErasureMethodRegistrar.Default)
+                    return Method;
+
+                throw new InvalidOperationException("The effective method of the erasure " +
+                    "target cannot be ErasureMethodRegistrar.Default");
+            }
+        }
 
         /// <summary>
@@ -104 +106 @@
             get;
         }
-
-        /// <summary>
-        /// Retrieves the amount of data that needs to be written in order to
-        /// complete the erasure.
-        /// </summary>
-        public abstract long TotalData
-        {
-            get;
-        }
-
-        /// <summary>
-        /// Erasure method to use for the target.
-        /// </summary>
-        private ErasureMethod method;
 
         /// <summary>
@@ -156 +144 @@
             : base()
         {
-            Method = ErasureMethodRegistrar.Default;
         }
 
@@ -219 +206 @@
         public string Path { get; set; }
 
-        public sealed override ErasureMethod Method
-        {
-            get
-            {
-                if (base.MethodDefined)
-                    return base.Method;
+        public sealed override ErasureMethod EffectiveMethod
+        {
+            get
+            {
+                if (Method == ErasureMethodRegistrar.Default)
+                    return base.EffectiveMethod;
+
                 return ManagerLibrary.Instance.ErasureMethodRegistrar[
                     ManagerLibrary.Settings.DefaultFileErasureMethod];
-            }
-            set
-            {
-                base.Method = value;
             }
         }
@@ -243 +227 @@
                         (string.IsNullOrEmpty(directoryName) ? Path : directoryName)
                     : fileName;
-            }
-        }
-
-        public override long TotalData
-        {
-            get
-            {
-                long totalSize = 0;
-                List<string> paths = GetPaths(out totalSize);
-                return Method.CalculateEraseDataSize(paths, totalSize);
             }
         }
@@ -286 +260 @@
             : base()
         {
-            Method = ErasureMethodRegistrar.Default;
-        }
-
-        public override sealed ErasureMethod Method
-        {
-            get
-            {
-                if (base.MethodDefined)
-                    return base.Method;
+        }
+
+        public sealed override ErasureMethod EffectiveMethod
+        {
+            get
+            {
+                if (Method == ErasureMethodRegistrar.Default)
+                    return base.EffectiveMethod;
+
                 return ManagerLibrary.Instance.ErasureMethodRegistrar[
                     ManagerLibrary.Settings.DefaultUnusedSpaceErasureMethod];
             }
-            set
-            {
-                base.Method = value;
-            }
         }
 
@@ -307 +277 @@
         {
             get { return S._("Unused disk space ({0})", Drive); }
-        }
-
-        public override long TotalData
-        {
-            get
-            {
-                VolumeInfo info = VolumeInfo.FromMountPoint(Drive);
-                return Method.CalculateEraseDataSize(null, info.AvailableFreeSpace);
-            }
         }
 

trunk/eraser/Eraser/TaskDataSelectionForm.cs

@@ -138 +138 @@
             {
                 //Set the erasure method.
-                if (value.MethodDefined)
-                {
-                    foreach (object item in method.Items)
-                        if (((ErasureMethod)item).Guid == value.Method.Guid)
-                            method.SelectedItem = item;
-                }
-                else
-                    method.SelectedIndex = 0;
+                foreach (object item in method.Items)
+                    if (((ErasureMethod)item).Guid == value.Method.Guid)
+                        method.SelectedItem = item;
 
                 //Then the data to be erased.

trunk/eraser/Eraser/TaskPropertiesForm.cs

@@ -141 +141 @@
             {
                 ListViewItem item = data.Items.Add(target.UIText);
-                item.SubItems.Add(target.MethodDefined ? target.Method.Name : S._("(default)"));
+                item.SubItems.Add(target.Method == ErasureMethodRegistrar.Default ?
+                    S._("(default)") : target.Method.Name);
                 item.Tag = target;
             }
@@ -215 +216 @@
                     ErasureTarget target = form.Target;
                     ListViewItem item = data.Items.Add(target.UIText);
-                    item.SubItems.Add(target.MethodDefined ? target.Method.Name : S._("(default)"));
+                    item.SubItems.Add(target.Method == ErasureMethodRegistrar.Default ?
+                        S._("(default)") : target.Method.Name);
                     item.Tag = target;
 
@@ -244 +246 @@
                     item.Tag = target;
                     item.Text = target.UIText;
-                    item.SubItems[1].Text = target.MethodDefined ? target.Method.Name : S._("(default)");
+                    item.SubItems[1].Text = target.Method == ErasureMethodRegistrar.Default ?
+                        S._("(default)") : target.Method.Name;
                 }
             }