Merge pull request #101 from Flow-Launcher/dev

Release 1.1.0 | Plugin 1.1.0 | Explorer Plugin 1.1.0

Author: jjw24

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,32 @@
+---
+name: "\U0001F41E Bug report"
+about: Create a bug report to help us improve Flow Launcher
+title: "[Describe Your Bug]"
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug/issue**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. ...
+2. ...
+3. ...
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Your System**
+```
+Windows build number: (run "ver" at a command prompt)
+Flow Launcher version: (Settings => About) 
+```
+**Flow Launcher Error Log**
+<!-- 
+     The latest log file can be found here: %AppData%\FlowLauncher\Logs\<version>\<date>.txt
+     or for portable mode: %LocalAppData%\FlowLauncher\<App-Version>\UserData\Logs\<version>\<date>.txt
+     Drag and drop the log file below this comment.
+-->

.github/ISSUE_TEMPLATE/code-review.md

@@ -0,0 +1,21 @@
+---
+name: "\U0001F50E Code Review"
+about: Describe (bad) code that needs to be improved
+title: "[Describe Problematic Code]"
+labels: 'code review'
+assignees: ''
+
+---
+
+**Point to the corresponding file and line number(s) which could be improved.**
+
+Click on the line number in GitHub to create an anchored link to the corresponding code section. For example:
+
+
+https://github.com/Flow-Launcher/Flow.Launcher/blob/master/Flow.Launcher/Storage/TopMostRecord.cs#L8
+
+Provide your alternative implementation idea:
+
+```
+Code
+```

.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,14 @@
+---
+name: "⁉️ Question/Discussion"
+about: Create a report to help us improve
+title: "[Ask a question or propose a change]"
+labels: 'question/discussion'
+assignees: ''
+
+---
+
+**Question**
+Describe your question.
+
+**Discussion**
+Discuss a topic.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,24 @@
+---
+name: "⭐ Feature request"
+about: Suggest a new idea or a feature enhacement
+title: "[Describe Your Feature]"
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

Flow.Launcher.Core/Configuration/Portable.cs

@@ -32,10 +32,9 @@ public void DisablePortableMode()
             try
             {
                 MoveUserDataFolder(DataLocation.PortableDataPath, DataLocation.RoamingDataPath);
-#if DEBUG
+#if !DEBUG
                 // Create shortcuts and uninstaller are not required in debug mode, 
                 // otherwise will repoint the path of the actual installed production version to the debug version
-#else
                 CreateShortcuts();
                 CreateUninstallerEntry();
 #endif
@@ -48,10 +47,7 @@ public void DisablePortableMode()
             }
             catch (Exception e)
             {
-#if !DEBUG
-                Log.Exception("Portable", "Error occured while disabling portable mode", e);
-#endif
-                throw;
+                Log.Exception("|Portable.DisablePortableMode|Error occured while disabling portable mode", e);
             }
         }
 
@@ -60,10 +56,9 @@ public void EnablePortableMode()
             try
             {
                 MoveUserDataFolder(DataLocation.RoamingDataPath, DataLocation.PortableDataPath);
-#if DEBUG
+#if !DEBUG
                 // Remove shortcuts and uninstaller are not required in debug mode, 
                 // otherwise will delete the actual installed production version
-#else
                 RemoveShortcuts();
                 RemoveUninstallerEntry();
 #endif
@@ -76,10 +71,7 @@ public void EnablePortableMode()
             }
             catch (Exception e)
             {
-#if !DEBUG
-                Log.Exception("Portable", "Error occured while enabling portable mode", e);
-#endif
-                throw;
+                Log.Exception("|Portable.EnablePortableMode|Error occured while enabling portable mode", e);
             }
         }
 
@@ -125,14 +117,13 @@ public void CreateShortcuts()
         public void CreateUninstallerEntry()
         {
             var uninstallRegSubKey = @"Software\Microsoft\Windows\CurrentVersion\Uninstall";
-            // NB: Sometimes the Uninstall key doesn't exist
-            using (var parentKey =
-                RegistryKey.OpenBaseKey(RegistryHive.CurrentUser, RegistryView.Default)
-                    .CreateSubKey("Uninstall", RegistryKeyPermissionCheck.ReadWriteSubTree)) {; }
 
-            var key = RegistryKey.OpenBaseKey(RegistryHive.CurrentUser, RegistryView.Default)
-                .CreateSubKey(uninstallRegSubKey + "\\" + Constant.FlowLauncher, RegistryKeyPermissionCheck.ReadWriteSubTree);
-            key.SetValue("DisplayIcon", Constant.ApplicationDirectory + "\\app.ico", RegistryValueKind.String);
+            using (var baseKey = RegistryKey.OpenBaseKey(RegistryHive.CurrentUser, RegistryView.Default))
+            using (var subKey1 = baseKey.CreateSubKey(uninstallRegSubKey, RegistryKeyPermissionCheck.ReadWriteSubTree))
+            using (var subKey2 = subKey1.CreateSubKey(Constant.FlowLauncher, RegistryKeyPermissionCheck.ReadWriteSubTree))
+            {
+                subKey2.SetValue("DisplayIcon", Path.Combine(Constant.ApplicationDirectory, "app.ico"), RegistryValueKind.String);
+            }
 
             using (var portabilityUpdater = NewUpdateManager())
             {
@@ -142,7 +133,10 @@ public void CreateUninstallerEntry()
 
         internal void IndicateDeletion(string filePathTodelete)
         {
-            using (StreamWriter sw = File.CreateText(filePathTodelete + "\\" + DataLocation.DeletionIndicatorFile)){}
+            var deleteFilePath = Path.Combine(filePathTodelete, DataLocation.DeletionIndicatorFile);
+            using (var _ = File.CreateText(deleteFilePath))
+            {
+            }
         }
 
         ///<summary>
@@ -152,21 +146,18 @@ internal void IndicateDeletion(string filePathTodelete)
         public void PreStartCleanUpAfterPortabilityUpdate()
         {
             // Specify here so this method does not rely on other environment variables to initialise
-            var portableDataPath = Path.Combine(Directory.GetParent(Assembly.GetExecutingAssembly().Location.NonNull()).ToString(), "UserData");
-            var roamingDataPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "FlowLauncher");
-
-            bool DataLocationPortableDeleteRequired = false;
-            bool DataLocationRoamingDeleteRequired = false;
-
-            if ((roamingDataPath + "\\" + DataLocation.DeletionIndicatorFile).FileExits())
-                DataLocationRoamingDeleteRequired = true;
+            var portableDataDir = Path.Combine(Directory.GetParent(Assembly.GetExecutingAssembly().Location.NonNull()).ToString(), "UserData");
+            var roamingDataDir = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "FlowLauncher");
 
-            if ((portableDataPath + "\\" + DataLocation.DeletionIndicatorFile).FileExits())
-                DataLocationPortableDeleteRequired = true;
+            // Get full path to the .dead files for each case
+            var portableDataDeleteFilePath = Path.Combine(portableDataDir, DataLocation.DeletionIndicatorFile);
+            var roamingDataDeleteFilePath = Path.Combine(roamingDataDir, DataLocation.DeletionIndicatorFile);
 
-            if (DataLocationRoamingDeleteRequired)
+            // If the data folder in %appdata% is marked for deletion,
+            // delete it and prompt the user to pick the portable data location
+            if (File.Exists(roamingDataDeleteFilePath))
             {
-                FilesFolders.RemoveFolderIfExists(roamingDataPath);
+                FilesFolders.RemoveFolderIfExists(roamingDataDir);
 
                 if (MessageBox.Show("Flow Launcher has detected you enabled portable mode, " +
                                     "would you like to move it to a different location?", string.Empty,
@@ -176,18 +167,15 @@ public void PreStartCleanUpAfterPortabilityUpdate()
 
                     Environment.Exit(0);
                 }
-
-                return;
             }
-
-            if(DataLocationPortableDeleteRequired)
+            // Otherwise, if the portable data folder is marked for deletion,
+            // delete it and notify the user about it.
+            else if (File.Exists(portableDataDeleteFilePath))
             {
-                FilesFolders.RemoveFolderIfExists(portableDataPath);
+                FilesFolders.RemoveFolderIfExists(portableDataDir);
 
                 MessageBox.Show("Flow Launcher has detected you disabled portable mode, " +
                                     "the relevant shortcuts and uninstaller entry have been created");
-
-                return;
             }
         }
 
@@ -196,7 +184,7 @@ public bool CanUpdatePortability()
             var roamingLocationExists = DataLocation.RoamingDataPath.LocationExists();
             var portableLocationExists = DataLocation.PortableDataPath.LocationExists();
 
-            if(roamingLocationExists && portableLocationExists)
+            if (roamingLocationExists && portableLocationExists)
             {
                 MessageBox.Show(string.Format("Flow Launcher detected your user data exists both in {0} and " +
                                     "{1}. {2}{2}Please delete {1} in order to proceed. No changes have occured.", 

Flow.Launcher.Core/Plugin/PluginConfig.cs

@@ -2,9 +2,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.IO;
-using System.Threading.Tasks;
 using Newtonsoft.Json;
-using Flow.Launcher.Infrastructure.Exception;
+using Flow.Launcher.Infrastructure;
 using Flow.Launcher.Infrastructure.Logger;
 using Flow.Launcher.Plugin;
 
@@ -13,24 +12,16 @@ namespace Flow.Launcher.Core.Plugin
 
     internal abstract class PluginConfig
     {
-        private const string PluginConfigName = "plugin.json";
-        private static readonly List<PluginMetadata> PluginMetadatas = new List<PluginMetadata>();
-
         /// <summary>
-        /// Parse plugin metadata in giving directories
+        /// Parse plugin metadata in the given directories
         /// </summary>
         /// <param name="pluginDirectories"></param>
         /// <returns></returns>
         public static List<PluginMetadata> Parse(string[] pluginDirectories)
         {
-            PluginMetadatas.Clear();
+            var allPluginMetadata = new List<PluginMetadata>();
             var directories = pluginDirectories.SelectMany(Directory.GetDirectories);
-            ParsePluginConfigs(directories);
-            return PluginMetadatas;
-        }
 
-        private static void ParsePluginConfigs(IEnumerable<string> directories)
-        {
             // todo use linq when diable plugin is implmented since parallel.foreach + list is not thread saft
             foreach (var directory in directories)
             {
@@ -50,15 +41,17 @@ private static void ParsePluginConfigs(IEnumerable<string> directories)
                     PluginMetadata metadata = GetPluginMetadata(directory);
                     if (metadata != null)
                     {
-                        PluginMetadatas.Add(metadata);
+                        allPluginMetadata.Add(metadata);
                     }
                 }
             }
+ 
+            return allPluginMetadata;
         }
 
         private static PluginMetadata GetPluginMetadata(string pluginDirectory)
         {
-            string configPath = Path.Combine(pluginDirectory, PluginConfigName);
+            string configPath = Path.Combine(pluginDirectory, Constant.PluginMetadataFileName);
             if (!File.Exists(configPath))
             {
                 Log.Error($"|PluginConfig.GetPluginMetadata|Didn't find config file <{configPath}>");
@@ -81,7 +74,6 @@ private static PluginMetadata GetPluginMetadata(string pluginDirectory)
                 return null;
             }
 
-
             if (!AllowedLanguage.IsAllowed(metadata.Language))
             {
                 Log.Error($"|PluginConfig.GetPluginMetadata|Invalid language <{metadata.Language}> for config <{configPath}>");