Add option to clear fw location cache (#109)

Author: josesimoes

README.md

@@ -313,6 +313,17 @@ nanoff --listboards --platform stm32
 
 If you just use `--listtargets` switch, you'll get the list of all the stable packages for all targets.
 
+## Clear cache location
+
+If needed one can clear the local cache from the firmware packages that are stored there.
+As an additional information the cache location is the directory `-nanoFramework\fw_cache` in the user folder.
+
+When this option is included in the command no other options are processed.
+
+```console
+nanoff --clearcache
+```
+
 ## Exit codes
 
 The exit codes can be checked in [this source file](https://github.com/nanoframework/nanoFirmwareFlasher/blob/develop/nanoFirmwareFlasher/ExitCodes.cs).

nanoFirmwareFlasher/ExitCodes.cs

@@ -273,5 +273,12 @@ public enum ExitCodes
         /// </summary>
         [Display(Name = "Unsupported platform. Valid options are: esp32, stm32, cc13x2")]
         E9013 = 9013,
+
+        /// <summary>
+        /// Error clearing cache location.
+        /// </summary>
+        [Display(Name = "Error occured when clearing the firmware cache location.")]
+        E9014 = 9014,
+
     }
 }

nanoFirmwareFlasher/FirmwarePackage.cs

@@ -37,6 +37,20 @@ internal abstract class FirmwarePackage : IDisposable
 
         private const string _readmeContent = "This folder contains nanoFramework firmware files. Can safely be removed.";
 
+        /// <summary>
+        /// Path with the base location for firmware packages.
+        /// </summary>
+        public static string LocationPathBase
+        {
+            get
+            {
+                return Path.Combine(
+                    Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
+                    ".nanoFramework",
+                    "fw_cache");
+            }
+        }
+
         /// <summary>
         /// Path with the location of the downloaded firmware.
         /// </summary>
@@ -153,26 +167,21 @@ protected async System.Threading.Tasks.Task<ExitCodes> DownloadAndExtractAsync()
 
             // setup download folder
             // set download path
-            LocationPath = Path.Combine(
-                Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
-                ".nanoFramework");
-
             try
             {
-                // create home directory
-                Directory.CreateDirectory(LocationPath);
+                // create "home" directory
+                Directory.CreateDirectory(LocationPathBase);
 
                 // add readme file
                 File.WriteAllText(
                     Path.Combine(
-                        LocationPath,
+                        LocationPathBase,
                         "README.txt"),
                     _readmeContent);
 
                 // set location path to target folder
                 LocationPath = Path.Combine(
-                    Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
-                    ".nanoFramework",
+                    LocationPathBase,
                     _targetName);
 
                 Directory.CreateDirectory(LocationPath);
@@ -531,6 +540,5 @@ void IDisposable.Dispose()
         }
 
         #endregion
-
     }
 }

nanoFirmwareFlasher/Options.cs

@@ -292,6 +292,13 @@ public class Options
             HelpText = "List the all the COM ports on this machine.")]
         public bool ListComPorts { get; set; }
 
+        [Option(
+            "clearcache",
+            Required = false,
+            Default = false,
+            HelpText = "Clear the cache folder with firmware images.")]
+        public bool ClearCache { get; set; }
+
         #endregion
 
 

nanoFirmwareFlasher/Program.cs

@@ -177,6 +177,32 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
 
             Console.ForegroundColor = ConsoleColor.White;
 
+            if (o.ClearCache)
+            {
+                Console.WriteLine();
+
+                if (Directory.Exists(FirmwarePackage.LocationPathBase))
+                {
+                    Console.WriteLine("Clearing firmware cache location.");
+
+                    try
+                    {
+                        Directory.Delete(FirmwarePackage.LocationPathBase);
+                    }
+                    catch (Exception ex)
+                    {
+                        _exitCode = ExitCodes.E9014;
+                        _extraMessage = ex.Message;
+                    }
+                }
+                else
+                {
+                    Console.WriteLine("Firmware cache location does not exist. Nothing to do.");
+                }
+
+                return;
+            }
+
             if (o.ListComPorts)
             {
                 var ports = SerialPort.GetPortNames();
@@ -188,7 +214,7 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                     {
                         Console.WriteLine($"  {p}");
                     }
-                        }
+                }
                 else
                 {
                     Console.ForegroundColor = ConsoleColor.Yellow;