Changeset 905 for branches/eraser6/Manager/DirectExecutor.cs

Timestamp:

4/28/2009 12:13:51 PM (4 years ago)

Author:

lowjoel

Message:

Ran static code analysis on Manager.

-Do not initialise class members to default values (runtime will handle that)
-Deserialisation constructors should be marked protected for unsealed classes
-Classes implementing ICollection should end with Collection (Mainly fixed here is ErasureTargetsCollection?)
-ISerializable.GetObjectData? should be marked virtual
-Use proper camel casing (Prng, Guid, FileName? etc)
-Enumeration values should be Camel casing
-Bitfields should be marked with the [Flags] attribute
-Implement the proper IDisposable pattern - one Dispose() and one Dispose(bool) - the latter doing the clean ups for both Dispose and finalisers
-public variables should instead be properties
-Abstract classes should have protected constructors
-Renamed Schedule.Type to Schedule.ScheduleType? to prevent ambiguity with GetType?()
-There shouldn't be a need to pass reference variables by reference

File:

• branches/eraser6/Manager/DirectExecutor.cs (modified) (30 diffs)

branches/eraser6/Manager/DirectExecutor.cs

@@ -46 +46 @@
         }
 
-        public override void Dispose()
+        protected override void Dispose(bool disposing)
         {
             thread.Abort();
             schedulerInterrupt.Set();
+            schedulerInterrupt.Close();
+            base.Dispose(disposing);
         }
 
@@ -58 +60 @@
         }
 
-        public override void AddTask(ref Task task)
+        public override void AddTask(Task task)
         {
             lock (unusedIdsLock)
@@ -186 +188 @@
                 if (currentTask == task)
                 {
-                    currentTask.Cancelled = true;
+                    currentTask.Canceled = true;
                     return;
                 }
@@ -213 +215 @@
         }
 
-        public override List<Task> GetTasks()
+        public override ICollection<Task> GetTasks()
         {
             lock (tasksLock)
@@ -246 +248 @@
                     foreach (uint id in tasks.Keys)
                     {
-                        Task currentTask = tasks[id];
-                        currentTask.Executor = this;
+                        Task task = tasks[id];
+                        task.Executor = this;
                         while (id > nextId)
                             unusedIds.Add(nextId++);
@@ -253 +255 @@
 
                         //Check if the task is recurring. If it is, check if we missed it.
-                        if (currentTask.Schedule is RecurringSchedule)
-                            ScheduleTask(currentTask);
+                        if (task.Schedule is RecurringSchedule)
+                            ScheduleTask(task);
                     }
 
@@ -301 +303 @@
                         //Broadcast the task started event.
                         task.Queued = false;
-                        task.Cancelled = false;
+                        task.Canceled = false;
                         task.OnTaskStarted(new TaskEventArgs(task));
                         OnTaskProcessing(task);
@@ -329 +331 @@
                             catch (Exception e)
                             {
-                                task.Log.Add(new LogEntry(e.Message, LogLevel.ERROR));
+                                task.Log.Add(new LogEntry(e.Message, LogLevel.Error));
                             }
                     }
                     catch (FatalException e)
                     {
-                        task.Log.Add(new LogEntry(e.Message, LogLevel.FATAL));
+                        task.Log.Add(new LogEntry(e.Message, LogLevel.Fatal));
                     }
                     catch (Exception e)
                     {
-                        task.Log.Add(new LogEntry(e.Message, LogLevel.ERROR));
+                        task.Log.Add(new LogEntry(e.Message, LogLevel.Error));
                     }
                     finally
@@ -540 +542 @@
                     Environment.OSVersion.Version >= new Version(6, 0))
                 {
-                    throw new Exception(S._("The program does not have the required permissions " +
-                        "to erase the unused space on disk. Run the program as an administrator " +
+                    throw new UnauthorizedAccessException(S._("The program does not have the required " +
+                        "permissions to erase the unused space on disk. Run the program as an administrator " +
                         "and retry the operation."));
                 }
                 else
-                    throw new Exception(S._("The program does not have the required permissions " +
+                    throw new UnauthorizedAccessException(S._("The program does not have the required permissions " +
                         "to erase the unused space on disk"));
             }
@@ -553 +555 @@
                 task.Log.Add(new LogEntry(S._("The drive which is having its unused space erased " +
                     "has disk quotas active. This will prevent the complete erasure of unused " +
-                    "space and will pose a security concern"), LogLevel.WARNING));
+                    "space and will pose a security concern"), LogLevel.Warning));
 
             //Get the erasure method if the user specified he wants the default.
@@ -581 +583 @@
 
                         lock (currentTask)
-                            if (currentTask.Cancelled)
+                            if (currentTask.Canceled)
                                 throw new FatalException(S._("The task was cancelled."));
                     }
@@ -599 +601 @@
                 if (Eraser.Util.File.IsCompressed(info.FullName))
                     Eraser.Util.File.SetCompression(info.FullName, false);
-
-                //Determine the total amount of data that needs to be written.
-                long totalSize = method.CalculateEraseDataSize(null, volInfo.TotalFreeSpace);
 
                 //Continue creating files while there is free space.
@@ -638 +637 @@
                         //Then run the erase task
                         method.Erase(stream, long.MaxValue,
-                            PRNGManager.GetInstance(ManagerLibrary.Instance.Settings.ActivePRNG),
+                            PrngManager.GetInstance(ManagerLibrary.Instance.Settings.ActivePrng),
                             delegate(long lastWritten, int currentPass)
                             {
@@ -654 +653 @@
 
                                 lock (currentTask)
-                                    if (currentTask.Cancelled)
+                                    if (currentTask.Canceled)
                                         throw new FatalException(S._("The task was cancelled."));
                             }
@@ -664 +663 @@
                 progress.Event.CurrentItemName = S._("Old resident file system table files");
                 task.OnProgressChanged(progress.Event);
-                fsManager.EraseOldFilesystemResidentFiles(volInfo, method, null);
+                fsManager.EraseOldFileSystemResidentFiles(volInfo, method, null);
             }
             finally
@@ -682 +681 @@
                 {
                     lock (currentTask)
-                        if (currentTask.Cancelled)
+                        if (currentTask.Canceled)
                             throw new FatalException(S._("The task was cancelled."));
 
@@ -713 +712 @@
             {
                 //Check if we've been cancelled
-                if (task.Cancelled)
+                if (task.Canceled)
                     throw new FatalException(S._("The task was cancelled."));
 
@@ -723 +722 @@
                         task.Log.Add(new LogEntry(S._("Files in {0} did not have their cluster " +
                             "tips erased because it is a hard link or a symbolic link.",
-                            info.FullName), LogLevel.INFORMATION));
+                            info.FullName), LogLevel.Information));
                         return;
                     }
@@ -731 +730 @@
                             task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips " +
                                 "erased, because it is a system file", file.FullName),
-                                LogLevel.INFORMATION));
+                                LogLevel.Information));
                         else if ((file.Attributes & FileAttributes.ReparsePoint) != 0)
                             task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips " +
                                 "erased because it is a hard link or a symbolic link.",
-                                file.FullName), LogLevel.INFORMATION));
+                                file.FullName), LogLevel.Information));
                         else if ((file.Attributes & FileAttributes.Compressed) != 0 ||
                             (file.Attributes & FileAttributes.Encrypted) != 0 ||
@@ -742 +741 @@
                             task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips " +
                                 "erased because it is compressed, encrypted or a sparse file.",
-                                file.FullName), LogLevel.INFORMATION));
+                                file.FullName), LogLevel.Information));
                         }
                         else
@@ -757 +756 @@
                                 task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips erased " +
                                     "because of the following error: {1}", info.FullName, e.Message),
-                                    LogLevel.ERROR));
+                                    LogLevel.Error));
                             }
                         }
@@ -768 +767 @@
                     task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips erased " +
                         "because of the following error: {1}", info.FullName, e.Message),
-                        LogLevel.ERROR));
+                        LogLevel.Error));
                 }
                 catch (IOException e)
@@ -774 +773 @@
                     task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips erased " +
                         "because of the following error: {1}", info.FullName, e.Message),
-                        LogLevel.ERROR));
+                        LogLevel.Error));
                 }
             };
@@ -796 +795 @@
                 {
                     task.Log.Add(new LogEntry(S._("{0} did not have its cluster tips erased. " +
-                        "The error returned was: {1}", files[i], e.Message), LogLevel.ERROR));
+                        "The error returned was: {1}", files[i], e.Message), LogLevel.Error));
                 }
                 finally
@@ -841 +840 @@
 
                     //Erase the file
-                    method.Erase(stream, long.MaxValue, PRNGManager.GetInstance(
-                        ManagerLibrary.Instance.Settings.ActivePRNG), null);
+                    method.Erase(stream, long.MaxValue, PrngManager.GetInstance(
+                        ManagerLibrary.Instance.Settings.ActivePrng), null);
                 }
                 finally
@@ -913 +912 @@
                         task.Log.Add(new LogEntry(S._("The file {0} could not be erased " +
                             "because the file was either compressed, encrypted or a sparse file.",
-                            info.FullName), LogLevel.ERROR));
+                            info.FullName), LogLevel.Error));
                     }
 
@@ -932 +931 @@
                                  itemTotal = method.CalculateEraseDataSize(null, strm.Length);
                             method.Erase(strm, long.MaxValue,
-                                PRNGManager.GetInstance(ManagerLibrary.Instance.Settings.ActivePRNG),
+                                PrngManager.GetInstance(ManagerLibrary.Instance.Settings.ActivePrng),
                                 delegate(long lastWritten, int currentPass)
                                 {
@@ -947 +946 @@
 
                                     lock (currentTask)
-                                        if (currentTask.Cancelled)
+                                        if (currentTask.Canceled)
                                             throw new FatalException(S._("The task was cancelled."));
                                 }
@@ -967 +966 @@
                     task.Log.Add(new LogEntry(S._("The file {0} could not be erased because the " +
                         "file's permissions prevent access to the file.", info.FullName),
-                        LogLevel.ERROR));
+                        LogLevel.Error));
                 }
                 catch (FileLoadException)
                 {
                     task.Log.Add(new LogEntry(S._("The file {0} could not be erased because the " +
-                        "file is currently in use.", info.FullName), LogLevel.ERROR));
+                        "file is currently in use.", info.FullName), LogLevel.Error));
                 }
                 finally
@@ -1066 +1065 @@
         /// is required by no unused IDs remain.
         /// </summary>
-        private uint nextId = 0;
+        private uint nextId;
 
         /// <summary>