Merge Dev

Author: taooceros

Flow.Launcher.Core/Plugin/PluginAssemblyLoader.cs

@@ -54,4 +54,4 @@ internal bool ExistsInReferencedPluginPackage(AssemblyName assemblyName)
             return referencedPluginPackageDependencyResolver.ResolveAssemblyToPath(assemblyName) != null;
         }
     }
-}
+}

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -320,4 +320,4 @@ public static void ReplaceActionKeyword(string id, string oldActionKeyword, stri
             }
         }
     }
-}
+}

Flow.Launcher.Core/Plugin/PluginsLoader.cs

@@ -183,4 +183,4 @@ public static IEnumerable<PluginPair> ExecutablePlugins(IEnumerable<PluginMetada
                 });
         }
     }
-}
+}

Flow.Launcher.Core/Updater.cs

@@ -35,7 +35,8 @@ public async Task UpdateApp(IPublicAPI api, bool silentUpdate = true)
                 UpdateInfo newUpdateInfo;
 
                 if (!silentUpdate)
-                    api.ShowMsg("Please wait...", "Checking for new update");
+                    api.ShowMsg(api.GetTranslation("pleaseWait"),
+                                api.GetTranslation("update_flowlauncher_update_check"));
 
                 using var updateManager = await GitHubUpdateManager(GitHubRepository).ConfigureAwait(false);
 
@@ -51,12 +52,13 @@ public async Task UpdateApp(IPublicAPI api, bool silentUpdate = true)
                 if (newReleaseVersion <= currentVersion)
                 {
                     if (!silentUpdate)
-                        MessageBox.Show("You already have the latest Flow Launcher version");
+                        MessageBox.Show(api.GetTranslation("update_flowlauncher_already_on_latest"));
                     return;
                 }
 
                 if (!silentUpdate)
-                    api.ShowMsg("Update found", "Updating...");
+                    api.ShowMsg(api.GetTranslation("update_flowlauncher_update_found"),
+                                api.GetTranslation("update_flowlauncher_updating"));
 
                 await updateManager.DownloadReleases(newUpdateInfo.ReleasesToApply).ConfigureAwait(false);
 
@@ -67,8 +69,9 @@ public async Task UpdateApp(IPublicAPI api, bool silentUpdate = true)
                     var targetDestination = updateManager.RootAppDirectory + $"\\app-{newReleaseVersion.ToString()}\\{DataLocation.PortableFolderName}";
                     FilesFolders.CopyAll(DataLocation.PortableDataPath, targetDestination);
                     if (!FilesFolders.VerifyBothFolderFilesEqual(DataLocation.PortableDataPath, targetDestination))
-                        MessageBox.Show("Flow Launcher was not able to move your user profile data to the new update version. Please manually " +
-                            $"move your profile data folder from {DataLocation.PortableDataPath} to {targetDestination}");
+                        MessageBox.Show(string.Format(api.GetTranslation("update_flowlauncher_fail_moving_portable_user_profile_data"),
+                                                      DataLocation.PortableDataPath,
+                                                      targetDestination));
                 }
                 else
                 {
@@ -79,15 +82,16 @@ public async Task UpdateApp(IPublicAPI api, bool silentUpdate = true)
 
                 Log.Info($"|Updater.UpdateApp|Update success:{newVersionTips}");
 
-                if (MessageBox.Show(newVersionTips, "New Update", MessageBoxButton.YesNo) == MessageBoxResult.Yes)
+                if (MessageBox.Show(newVersionTips, api.GetTranslation("update_flowlauncher_new_update"), MessageBoxButton.YesNo) == MessageBoxResult.Yes)
                 {
                     UpdateManager.RestartApp(Constant.ApplicationFileName);
                 }
             }
             catch (Exception e) when (e is HttpRequestException || e is WebException || e is SocketException)
             {
                 Log.Exception($"|Updater.UpdateApp|Check your connection and proxy settings to github-cloud.s3.amazonaws.com.", e);
-                api.ShowMsg("Update Failed", "Check your connection and try updating proxy settings to github-cloud.s3.amazonaws.com.");
+                api.ShowMsg(api.GetTranslation("update_flowlauncher_fail"),
+                            api.GetTranslation("update_flowlauncher_check_connection"));
                 return;
             }
         }

Flow.Launcher.Infrastructure/Image/ImageLoader.cs

@@ -39,7 +39,6 @@ public static void Initialize()
 
             var usage = LoadStorageToConcurrentDictionary();
 
-
             foreach (var icon in new[] { Constant.DefaultIcon, Constant.MissingImgIcon })
             {
                 ImageSource img = new BitmapImage(new Uri(icon));

Flow.Launcher.Infrastructure/Storage/JsonStorage.cs

@@ -9,7 +9,7 @@ namespace Flow.Launcher.Infrastructure.Storage
     /// <summary>
     /// Serialize object using json format.
     /// </summary>
-    public class JsonStrorage<T>
+    public class JsonStrorage<T> where T : new()
     {
         private readonly JsonSerializerOptions _serializerSettings;
         private T _data;
@@ -76,7 +76,7 @@ private void LoadDefault()
                 BackupOriginFile();
             }
 
-            _data = JsonSerializer.Deserialize<T>("{}", _serializerSettings);
+            _data = new T();
             Save();
         }
 

Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj

@@ -14,10 +14,10 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>1.3.1</Version>
-    <PackageVersion>1.3.1</PackageVersion>
-    <AssemblyVersion>1.3.1</AssemblyVersion>
-    <FileVersion>1.3.1</FileVersion>
+    <Version>1.4.0</Version>
+    <PackageVersion>1.4.0</PackageVersion>
+    <AssemblyVersion>1.4.0</AssemblyVersion>
+    <FileVersion>1.4.0</FileVersion>
     <PackageId>Flow.Launcher.Plugin</PackageId>
     <Authors>Flow-Launcher</Authors>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
@@ -64,4 +64,4 @@
     <PackageReference Include="JetBrains.Annotations" Version="2019.1.3" />
   </ItemGroup>
 
-</Project>
+</Project>

Flow.Launcher.Plugin/IAsyncPlugin.cs

@@ -4,9 +4,28 @@
 
 namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// Asynchronous Plugin Model for Flow Launcher
+    /// </summary>
     public interface IAsyncPlugin
     {
+        /// <summary>
+        /// Asynchronous Querying
+        /// </summary>
+        /// <para>
+        /// If the Querying or Init method requires high IO transmission
+        /// or performing CPU intense jobs (performing better with cancellation), please use this IAsyncPlugin interface
+        /// </para>
+        /// <param name="query">Query to search</param>
+        /// <param name="token">Cancel when querying job is obsolete</param>
+        /// <returns></returns>
         Task<List<Result>> QueryAsync(Query query, CancellationToken token);
+
+        /// <summary>
+        /// Initialize plugin asynchrously (will still wait finish to continue)
+        /// </summary>
+        /// <param name="context"></param>
+        /// <returns></returns>
         Task InitAsync(PluginInitContext context);
     }
-}
+}

Flow.Launcher.Plugin/IPlugin.cs

@@ -2,10 +2,30 @@
 
 namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// Synchronous Plugin Model for Flow Launcher
+    /// <para>
+    /// If the Querying or Init method requires high IO transmission
+    /// or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface
+    /// </para>
+    /// </summary>
     public interface IPlugin
     {
+        /// <summary>
+        /// Querying when user's search changes
+        /// <para>
+        /// This method will be called within a Task.Run,
+        /// so please avoid synchrously wait for long.
+        /// </para>
+        /// </summary>
+        /// <param name="query">Query to search</param>
+        /// <returns></returns>
         List<Result> Query(Query query);
-        
+
+        /// <summary>
+        /// Initialize plugin
+        /// </summary>
+        /// <param name="context"></param>
         void Init(PluginInitContext context);
     }
-}
+}

Flow.Launcher.Plugin/Interfaces/IAsyncReloadable.cs

@@ -2,8 +2,19 @@
 
 namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// This interface is to indicate and allow plugins to asyncronously reload their
+    /// in memory data cache or other mediums when user makes a new change
+    /// that is not immediately captured. For example, for BrowserBookmark and Program
+    /// plugin does not automatically detect when a user added a new bookmark or program,
+    /// so this interface's function is exposed to allow user manually do the reloading after 
+    /// those new additions.
+    /// 
+    /// The command that allows user to manual reload is exposed via Plugin.Sys, and
+    /// it will call the plugins that have implemented this interface.
+    /// </summary>
     public interface IAsyncReloadable
     {
         Task ReloadDataAsync();
     }
-}
+}