Translations, better search results, copy to clipboard, cleanup

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeZone/Helper/ContextMenuHelper.cs

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Windows;
+using System.Windows.Input;
+using Microsoft.PowerToys.Run.Plugin.TimeZone.Properties;
+using Wox.Plugin;
+using Wox.Plugin.Logger;
+
+namespace Microsoft.PowerToys.Run.Plugin.TimeZone.Helper
+{
+    /// <summary>
+    /// Helper class to easier work with context menu entries
+    /// </summary>
+    internal static class ContextMenuHelper
+    {
+        /// <summary>
+        /// Return a list with all context menu entries for the given <see cref="Result"/>
+        /// <para>Symbols taken from <see href="https://docs.microsoft.com/en-us/windows/uwp/design/style/segoe-ui-symbol-font"/></para>
+        /// </summary>
+        /// <param name="result">The result for the context menu entires</param>
+        /// <param name="assemblyName">The name of the this assembly</param>
+        /// <returns>A list with context menu entries</returns>
+        internal static List<ContextMenuResult> GetContextMenu(Result result, string assemblyName)
+        {
+            if (!(result?.ContextData is TimeZoneInfo timeZoneInfo))
+            {
+                return new List<ContextMenuResult>(0);
+            }
+
+            var list = new List<ContextMenuResult>
+            {
+                new ContextMenuResult
+                {
+                    AcceleratorKey = Key.C,
+                    AcceleratorModifiers = ModifierKeys.Control,
+                    Action = _ => TryToCopyToClipBoard(GetTimeInTimeZone(timeZoneInfo)),
+                    FontFamily = "Segoe MDL2 Assets",
+                    Glyph = "\xE8C8",                       // E8C8 => Symbol: Copy
+                    PluginName = assemblyName,
+                    Title = $"{Resources.CopyTime} (Ctrl+C)",
+                },
+            };
+
+            return list;
+        }
+
+        /// <summary>
+        /// Return a human readable time of the current time in the given <see cref="TimeZoneInfo"/>.
+        /// </summary>
+        /// <param name="timeZoneInfo">The <see cref="TimeZoneInfo"/> to calculate the current time in it.</param>
+        /// <returns>A human readable time.</returns>
+        private static string GetTimeInTimeZone(TimeZoneInfo timeZoneInfo)
+        {
+            var timeInTimeZone = TimeZoneInfo.ConvertTime(DateTime.UtcNow, timeZoneInfo);
+            var stringToCopy = $"{timeInTimeZone:HH:mm:ss}";
+            return stringToCopy;
+        }
+
+        #pragma warning disable CA1031 // Do not catch general exception types
+
+        /// <summary>
+        /// Copy the given text to the clipboard
+        /// </summary>
+        /// <param name="text">The text to copy to the clipboard</param>
+        /// <returns><see langword="true"/>The text successful copy to the clipboard, otherwise <see langword="false"/></returns>
+        private static bool TryToCopyToClipBoard(in string text)
+        {
+            try
+            {
+                Clipboard.Clear();
+                Clipboard.SetText(text);
+                return true;
+            }
+            catch (Exception exception)
+            {
+                Log.Exception("Can't copy to clipboard", exception, typeof(Main));
+                return false;
+            }
+        }
+
+        #pragma warning restore CA1031 // Do not catch general exception types
+    }
+}

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeZone/Helper/ResultHelper.cs

@@ -0,0 +1,154 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.PowerToys.Run.Plugin.TimeZone.Properties;
+using Mono.Collections.Generic;
+using Wox.Plugin;
+
+namespace Microsoft.PowerToys.Run.Plugin.TimeZone.Helper
+{
+    /// <summary>
+    /// Helper class to easier work with results
+    /// </summary>
+    internal static class ResultHelper
+    {
+        /// <summary>
+        /// Return a list of <see cref="Result"/>s based on the given <see cref="Query"/>.
+        /// </summary>
+        /// <param name="query">The <see cref="Query"/> to filter the <see cref="Results"/>.</param>
+        /// <returns>A list with <see cref="Result"/>s.</returns>
+        internal static IEnumerable<Result> GetResults(Query query, string iconPath)
+        {
+            var searchFor = GetSerchString(query);
+            var timeZoneInfos = TimeZoneInfo.GetSystemTimeZones();
+            var results = new Collection<Result>();
+            var utcNow = DateTime.UtcNow;
+
+            foreach (var timeZoneInfo in timeZoneInfos)
+            {
+                if (TimeZoneInfoMatchQuery(timeZoneInfo, searchFor))
+                {
+                    var result = GetResult(timeZoneInfo, utcNow, iconPath);
+                    results.Add(result);
+                }
+            }
+
+            var orderResults = results.OrderBy(result => result.Title);
+            return orderResults;
+        }
+
+        /// <summary>
+        /// Return the string to search, based on the given <see cref="Query"/>.
+        /// </summary>
+        /// <param name="query">The <see cref="Query"/> that contain the string to search.</param>
+        /// <returns>A string for a search.</returns>
+        private static string GetSerchString(Query query)
+        {
+            var secondChar = query.Search.ElementAtOrDefault(1);
+
+            if (secondChar == '0')
+            {
+                return query.Search;
+            }
+
+            if (!char.IsDigit(secondChar))
+            {
+                return query.Search;
+            }
+
+            // Allow the user to direct search for "+9", instead of "+09".
+            var searchFor = query.Search;
+
+            if (query.Search.StartsWith('+'))
+            {
+                searchFor = "+0" + query.Search.Substring(1);
+            }
+
+            if (query.Search.StartsWith('-'))
+            {
+                searchFor = "-0" + query.Search.Substring(1);
+            }
+
+            return searchFor;
+        }
+
+        /// <summary>
+        /// Check if the given <see cref="TimeZoneInfo"/> contains a value that match the given <see cref="string"/> .
+        /// </summary>
+        /// <param name="timeZoneInfo">The <see cref="TimeZoneInfo"/> to check.</param>
+        /// <param name="searchFor">The <see cref="string"/> that should match.</param>
+        /// <returns><see langword="true"/> if it's match, otherwise <see langword="false"/>.</returns>
+        private static bool TimeZoneInfoMatchQuery(TimeZoneInfo timeZoneInfo, string searchFor)
+        {
+            if (timeZoneInfo.DisplayName.Contains(searchFor, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+
+            if (timeZoneInfo.StandardName.Contains(searchFor, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+
+            if (timeZoneInfo.DaylightName.Contains(searchFor, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Return a <see cref="Result"/> based on the given <see cref="TimeZoneInfo"/>.
+        /// </summary>
+        /// <param name="timeZoneInfo">The <see cref="TimeZoneInfo"/> that contain the information for the <see cref="Result"/>.</param>
+        /// <param name="utcNow">The current time in UTC for the <see cref="Result"/>.</param>
+        /// <returns>A <see cref="Result"/>.</returns>
+        private static Result GetResult(TimeZoneInfo timeZoneInfo, DateTime utcNow, string iconPath)
+        {
+            var title = GetTitle(timeZoneInfo, utcNow);
+            var timeInTimeZone = TimeZoneInfo.ConvertTime(utcNow, timeZoneInfo);
+
+            var toolTip = $"{Resources.StandardName}: {timeZoneInfo.StandardName}"
+                + $"{Environment.NewLine}{Resources.DaylightName}: {timeZoneInfo.DaylightName}"
+                + $"{Environment.NewLine}{Resources.DisplayName}: {timeZoneInfo.DisplayName}"
+                + $"{Environment.NewLine}{Resources.Offset}: {timeZoneInfo.BaseUtcOffset}";
+
+            var result = new Result
+            {
+                ContextData = timeZoneInfo,
+                IcoPath = iconPath,
+                SubTitle = $"{Resources.CurrentTime}: {timeInTimeZone:HH:mm:ss}",
+                Title = title,
+                ToolTipData = new ToolTipData(title, toolTip),
+            };
+
+            return result;
+        }
+
+        /// <summary>
+        /// Return the title for a <see cref="Result"/> and <see cref="ToolTipData"/>
+        /// </summary>
+        /// <param name="timeZoneInfo">The <see cref="TimeZoneInfo"/> for the title.</param>
+        /// <param name="utcNow">The current time in UTC, only need for time zones that support daylight time.</param>
+        /// <returns>A title for a <see cref="Result"/> or <see cref="ToolTipData"/>.</returns>
+        private static string GetTitle(TimeZoneInfo timeZoneInfo, DateTime utcNow)
+        {
+            if (!timeZoneInfo.SupportsDaylightSavingTime)
+            {
+                return timeZoneInfo.StandardName;
+            }
+
+            if (!timeZoneInfo.IsDaylightSavingTime(utcNow))
+            {
+                return timeZoneInfo.StandardName;
+            }
+
+            return timeZoneInfo.DaylightName;
+        }
+    }
+}

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeZone/Main.cs

@@ -7,12 +7,13 @@
 using System.Linq;
 using System.Reflection;
 using ManagedCommon;
+using Microsoft.PowerToys.Run.Plugin.TimeZone.Helper;
 using Microsoft.PowerToys.Run.Plugin.TimeZone.Properties;
 using Wox.Plugin;
 
 namespace Microsoft.PowerToys.Run.Plugin.TimeZone
 {
-    public class Main : IPlugin, IPluginI18n, IDisposable
+    public class Main : IPlugin, IContextMenu, IPluginI18n, IDisposable
     {
         /// <summary>
         /// The name of this assembly
@@ -70,35 +71,18 @@ public List<Result> Query(Query query)
                 return new List<Result>(0);
             }
 
-            var timeZones = TimeZoneInfo.GetSystemTimeZones();
-            var results = new List<Result>(timeZones.Count);
-            var utcNow = DateTime.UtcNow;
-
-            foreach (var timeZone in timeZones)
-            {
-                if (!timeZone.DaylightName.Contains(query.Search, StringComparison.InvariantCultureIgnoreCase)
-                && !timeZone.DaylightName.Contains(query.Search, StringComparison.InvariantCultureIgnoreCase))
-                {
-                    continue;
-                }
-
-                var title = timeZone.SupportsDaylightSavingTime && timeZone.IsDaylightSavingTime(utcNow)
-                    ? timeZone.DaylightName
-                    : timeZone.StandardName;
-
-                var timeInTimeZone = TimeZoneInfo.ConvertTime(utcNow, timeZone);
-
-                var result = new Result
-                {
-                    Title = title,
-                    SubTitle = $"Time: {timeInTimeZone:HH:mm:ss}",
-                    ToolTipData = new ToolTipData(title, $"Offset: {timeZone.BaseUtcOffset}"),
-                };
-
-                results.Add(result);
-            }
+            var results = ResultHelper.GetResults(query, _defaultIconPath).ToList();
+            return results;
+        }
 
-            return results.OrderBy(result => result.Title).ToList();
+        /// <summary>
+        /// Return a list context menu entries for a given <see cref="Result"/> (shown at the right side of the result)
+        /// </summary>
+        /// <param name="selectedResult">The <see cref="Result"/> for the list with context menu entries</param>
+        /// <returns>A list context menu entries</returns>
+        public List<ContextMenuResult> LoadContextMenus(Result selectedResult)
+        {
+            return ContextMenuHelper.GetContextMenu(selectedResult, _assemblyName);
         }
 
         /// <summary>