mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-07 11:46:30 +02:00
[PT Run] Uri/Web search plugin crash fix (#15472)
* [PT Run] Browser path bug fix * [PT Run][URI/Web Search] Refactoring * [PT Run][URI] Small change * [PT Run] Small modifications * [PT Run] Refactoring: moved common files to Plugins\Common and added references to plugins that use them * Fixed spelling * [PT Run][URI] Small adjustment * [PT Run] Fixed refactoring error * [PT Run] Reversed refactoring NativeMethods.cs into single file * Fixed PR changed files list (unchanged files appeared modified because of different encodings) * [PT Run] Moved BrowserInfo.cs to Wox.Plugin/SharedCommands and removed Plugins/Common * [PT Run] Renamed BrowserInfo to DefaultBrowserInfo and made it static * Minor modifications * [PT Run] Fixed refactoring error * Minor modifications * [PT Run] Renamed Wox.Plugin.SharedCommands to Wox.Plugin.Common + small change
This commit is contained in:
cyberrex5
@@ -5,23 +5,21 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using System.IO.Abstractions;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.Windows.Controls;
|
||||
using ManagedCommon;
|
||||
using Microsoft.PowerToys.Settings.UI.Library;
|
||||
using Wox.Infrastructure;
|
||||
using Wox.Plugin;
|
||||
using Wox.Plugin.Logger;
|
||||
using BrowserInfo = Wox.Plugin.Common.DefaultBrowserInfo;
|
||||
|
||||
namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
{
|
||||
public class Main : IPlugin, IPluginI18n, IContextMenu, ISettingProvider, IDisposable
|
||||
public class Main : IPlugin, IPluginI18n, IContextMenu, ISettingProvider, IReloadable, IDisposable
|
||||
{
|
||||
private static readonly IFileSystem FileSystem = new FileSystem();
|
||||
private static readonly IPath Path = FileSystem.Path;
|
||||
private static readonly IFile File = FileSystem.File;
|
||||
// Should only be set in Init()
|
||||
private Action onPluginError;
|
||||
|
||||
private const string NotGlobalIfUri = nameof(NotGlobalIfUri);
|
||||
|
||||
@@ -30,12 +28,7 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
|
||||
private PluginInitContext _context;
|
||||
|
||||
private string _searchEngineUrl;
|
||||
|
||||
private string _browserName = Properties.Resources.plugin_browser;
|
||||
private string _browserIconPath;
|
||||
private string _browserPath;
|
||||
private string _defaultIconPath;
|
||||
private string _iconPath;
|
||||
|
||||
private bool _disposed;
|
||||
|
||||
@@ -67,28 +60,22 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
|
||||
var results = new List<Result>();
|
||||
|
||||
if (!AreResultsGlobal()
|
||||
&& query.ActionKeyword == query.RawQuery
|
||||
&& IsDefaultBrowserSet())
|
||||
// empty non-global query:
|
||||
if (!AreResultsGlobal() && query.ActionKeyword == query.RawQuery)
|
||||
{
|
||||
string arguments = "\"? \"";
|
||||
results.Add(new Result
|
||||
{
|
||||
Title = Properties.Resources.plugin_description.Remove(Description.Length - 1, 1),
|
||||
SubTitle = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_in_browser_name, _browserName),
|
||||
SubTitle = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_in_browser_name, BrowserInfo.Name ?? BrowserInfo.MSEdgeName),
|
||||
QueryTextDisplay = string.Empty,
|
||||
IcoPath = _defaultIconPath,
|
||||
IcoPath = _iconPath,
|
||||
ProgramArguments = arguments,
|
||||
Action = action =>
|
||||
{
|
||||
if (!Helper.OpenInShell(_browserPath, arguments))
|
||||
if (!Helper.OpenInShell(BrowserInfo.Path ?? BrowserInfo.MSEdgePath, arguments))
|
||||
{
|
||||
string errorMsgString = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_search_failed, _browserName);
|
||||
|
||||
Log.Error(errorMsgString, GetType());
|
||||
_context.API.ShowMsg(
|
||||
$"Plugin: {Properties.Resources.plugin_name}",
|
||||
errorMsgString);
|
||||
onPluginError();
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -113,26 +100,21 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
var result = new Result
|
||||
{
|
||||
Title = searchTerm,
|
||||
SubTitle = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_open, _browserName),
|
||||
SubTitle = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_open, BrowserInfo.Name ?? BrowserInfo.MSEdgeName),
|
||||
QueryTextDisplay = searchTerm,
|
||||
IcoPath = _defaultIconPath,
|
||||
IcoPath = _iconPath,
|
||||
};
|
||||
|
||||
if (_searchEngineUrl is null)
|
||||
if (BrowserInfo.SupportsWebSearchByCmdLineArgument)
|
||||
{
|
||||
string arguments = $"\"? {searchTerm}\"";
|
||||
|
||||
result.ProgramArguments = arguments;
|
||||
result.Action = action =>
|
||||
{
|
||||
if (!Helper.OpenInShell(_browserPath, arguments))
|
||||
if (!Helper.OpenInShell(BrowserInfo.Path ?? BrowserInfo.MSEdgePath, arguments))
|
||||
{
|
||||
string errorMsgString = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_search_failed, _browserName);
|
||||
|
||||
Log.Error(errorMsgString, GetType());
|
||||
_context.API.ShowMsg(
|
||||
$"Plugin: {Properties.Resources.plugin_name}",
|
||||
errorMsgString);
|
||||
onPluginError();
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -141,18 +123,13 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
}
|
||||
else
|
||||
{
|
||||
string url = string.Format(CultureInfo.InvariantCulture, _searchEngineUrl, searchTerm);
|
||||
string url = string.Format(CultureInfo.InvariantCulture, BrowserInfo.SearchEngineUrl, searchTerm);
|
||||
|
||||
result.Action = action =>
|
||||
{
|
||||
if (!Helper.OpenInShell(url))
|
||||
{
|
||||
string errorMsgString = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_search_failed, _browserName);
|
||||
|
||||
Log.Error(errorMsgString, GetType());
|
||||
_context.API.ShowMsg(
|
||||
$"Plugin: {Properties.Resources.plugin_name}",
|
||||
errorMsgString);
|
||||
onPluginError();
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -176,7 +153,8 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
if (input.EndsWith(":", StringComparison.OrdinalIgnoreCase)
|
||||
&& !input.StartsWith("http", StringComparison.OrdinalIgnoreCase)
|
||||
&& !input.Contains("/", StringComparison.OrdinalIgnoreCase)
|
||||
&& !input.All(char.IsDigit))
|
||||
&& !input.All(char.IsDigit)
|
||||
&& System.Text.RegularExpressions.Regex.IsMatch(input, @"^([a-z][a-z0-9+\-.]*):"))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
@@ -203,17 +181,22 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
}
|
||||
}
|
||||
|
||||
private bool IsDefaultBrowserSet()
|
||||
{
|
||||
return !string.IsNullOrEmpty(_browserPath);
|
||||
}
|
||||
|
||||
public void Init(PluginInitContext context)
|
||||
{
|
||||
_context = context ?? throw new ArgumentNullException(nameof(context));
|
||||
_context.API.ThemeChanged += OnThemeChanged;
|
||||
UpdateIconPath(_context.API.GetCurrentTheme());
|
||||
UpdateBrowserIconPath(_context.API.GetCurrentTheme());
|
||||
BrowserInfo.UpdateIfTimePassed();
|
||||
|
||||
onPluginError = () =>
|
||||
{
|
||||
string errorMsgString = string.Format(CultureInfo.CurrentCulture, Properties.Resources.plugin_search_failed, BrowserInfo.Name ?? BrowserInfo.MSEdgeName);
|
||||
|
||||
Log.Error(errorMsgString, this.GetType());
|
||||
_context.API.ShowMsg(
|
||||
$"Plugin: {Properties.Resources.plugin_name}",
|
||||
errorMsgString);
|
||||
};
|
||||
}
|
||||
|
||||
public string GetTranslatedPluginTitle()
|
||||
@@ -229,185 +212,41 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
private void OnThemeChanged(Theme oldtheme, Theme newTheme)
|
||||
{
|
||||
UpdateIconPath(newTheme);
|
||||
UpdateBrowserIconPath(newTheme);
|
||||
}
|
||||
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage(
|
||||
"Design",
|
||||
"CA1031:Do not catch general exception types",
|
||||
Justification = "We want to keep the process alive but will log the exception")]
|
||||
private void UpdateBrowserIconPath(Theme newTheme)
|
||||
{
|
||||
try
|
||||
{
|
||||
string progId = GetRegistryValue(
|
||||
"HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\Shell\\Associations\\UrlAssociations\\http\\UserChoice",
|
||||
"ProgId");
|
||||
|
||||
// The `?` argument doesn't work on opera, so we get the user's default search engine:
|
||||
if (progId.StartsWith("Opera", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
// Opera user preferences file:
|
||||
string prefFile;
|
||||
|
||||
if (progId.Contains("GX", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
_browserName = "Opera GX";
|
||||
prefFile = System.IO.File.ReadAllText($"{Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData)}\\Opera Software\\Opera GX Stable\\Preferences");
|
||||
}
|
||||
else
|
||||
{
|
||||
_browserName = "Opera";
|
||||
prefFile = System.IO.File.ReadAllText($"{Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData)}\\Opera Software\\Opera Stable\\Preferences");
|
||||
}
|
||||
|
||||
// "default_search_provider_data" doesn't exist if the user hasn't searched for the first time,
|
||||
// therefore we set `url` to opera's default search engine:
|
||||
string url = "https://www.google.com/search?client=opera&q={0}&sourceid=opera";
|
||||
|
||||
using (System.Text.Json.JsonDocument doc = System.Text.Json.JsonDocument.Parse(prefFile))
|
||||
{
|
||||
if (doc.RootElement.TryGetProperty("default_search_provider_data", out var element))
|
||||
{
|
||||
if (element.TryGetProperty("template_url_data", out element))
|
||||
{
|
||||
if (element.TryGetProperty("url", out element))
|
||||
{
|
||||
url = element.GetString();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
url = url
|
||||
.Replace("{searchTerms}", "{0}", StringComparison.Ordinal)
|
||||
.Replace("{inputEncoding}", "UTF-8", StringComparison.Ordinal)
|
||||
.Replace("{outputEncoding}", "UTF-8", StringComparison.Ordinal);
|
||||
|
||||
int startIndex = url.IndexOf('}', StringComparison.Ordinal) + 1;
|
||||
|
||||
// In case there are other url parameters (e.g. `&foo={bar}`), remove them:
|
||||
for (int i = url.IndexOf("}", startIndex, StringComparison.Ordinal);
|
||||
i != -1;
|
||||
i = url.IndexOf("}", startIndex, StringComparison.Ordinal))
|
||||
{
|
||||
for (int j = i - 1; j > 0; --j)
|
||||
{
|
||||
if (url[j] == '&')
|
||||
{
|
||||
url = url.Remove(j, i - j + 1);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_searchEngineUrl = url;
|
||||
}
|
||||
else
|
||||
{
|
||||
string appName = GetRegistryValue($"HKEY_CLASSES_ROOT\\{progId}\\Application", "ApplicationName")
|
||||
?? GetRegistryValue($"HKEY_CLASSES_ROOT\\{progId}", "FriendlyTypeName");
|
||||
|
||||
if (appName is null)
|
||||
{
|
||||
appName = Properties.Resources.plugin_browser;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Handle indirect strings:
|
||||
if (appName.StartsWith("@", StringComparison.Ordinal))
|
||||
{
|
||||
appName = GetIndirectString(appName);
|
||||
}
|
||||
|
||||
appName = appName
|
||||
.Replace("URL", null, StringComparison.OrdinalIgnoreCase)
|
||||
.Replace("HTML", null, StringComparison.OrdinalIgnoreCase)
|
||||
.Replace("Document", null, StringComparison.OrdinalIgnoreCase)
|
||||
.TrimEnd();
|
||||
}
|
||||
|
||||
_browserName = appName;
|
||||
|
||||
_searchEngineUrl = null;
|
||||
}
|
||||
|
||||
var programLocation =
|
||||
|
||||
// Resolve App Icon (UWP)
|
||||
GetRegistryValue(
|
||||
"HKEY_CLASSES_ROOT\\" + progId + "\\Application",
|
||||
"ApplicationIcon")
|
||||
|
||||
// Resolves default file association icon (UWP + Normal)
|
||||
?? GetRegistryValue("HKEY_CLASSES_ROOT\\" + progId + "\\DefaultIcon", null);
|
||||
|
||||
// "Handles 'Indirect Strings' (UWP programs)"
|
||||
// Using Ordinal since this is internal and used with a symbol
|
||||
if (programLocation.StartsWith("@", StringComparison.Ordinal))
|
||||
{
|
||||
// Check if there's a postfix with contract-white/contrast-black icon is available and use that instead
|
||||
string directProgramLocation = GetIndirectString(programLocation);
|
||||
var themeIcon = newTheme == Theme.Light || newTheme == Theme.HighContrastWhite
|
||||
? "contrast-white"
|
||||
: "contrast-black";
|
||||
var extension = Path.GetExtension(directProgramLocation);
|
||||
var themedProgLocation =
|
||||
$"{directProgramLocation.Substring(0, directProgramLocation.Length - extension.Length)}_{themeIcon}{extension}";
|
||||
_browserIconPath = File.Exists(themedProgLocation)
|
||||
? themedProgLocation
|
||||
: directProgramLocation;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Using Ordinal since this is internal and used with a symbol
|
||||
var indexOfComma = programLocation.IndexOf(',', StringComparison.Ordinal);
|
||||
_browserIconPath = indexOfComma > 0
|
||||
? programLocation.Substring(0, indexOfComma)
|
||||
: programLocation;
|
||||
_browserPath = _browserIconPath;
|
||||
}
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
_browserIconPath = _defaultIconPath;
|
||||
Log.Exception("Exception when retrieving icon", e, GetType());
|
||||
}
|
||||
|
||||
string GetRegistryValue(string registryLocation, string valueName)
|
||||
{
|
||||
return Microsoft.Win32.Registry.GetValue(registryLocation, valueName, null) as string;
|
||||
}
|
||||
|
||||
string GetIndirectString(string str)
|
||||
{
|
||||
var stringBuilder = new StringBuilder(128);
|
||||
if (NativeMethods.SHLoadIndirectString(
|
||||
str,
|
||||
stringBuilder,
|
||||
(uint)stringBuilder.Capacity,
|
||||
IntPtr.Zero)
|
||||
== NativeMethods.Hresult.Ok)
|
||||
{
|
||||
return stringBuilder.ToString();
|
||||
}
|
||||
|
||||
throw new Exception("Could not load indirect string.");
|
||||
}
|
||||
}
|
||||
|
||||
private void UpdateIconPath(Theme theme)
|
||||
{
|
||||
if (theme == Theme.Light || theme == Theme.HighContrastWhite)
|
||||
{
|
||||
_defaultIconPath = "Images/WebSearch.light.png";
|
||||
_iconPath = "Images/WebSearch.light.png";
|
||||
}
|
||||
else
|
||||
{
|
||||
_defaultIconPath = "Images/WebSearch.dark.png";
|
||||
_iconPath = "Images/WebSearch.dark.png";
|
||||
}
|
||||
}
|
||||
|
||||
public Control CreateSettingPanel()
|
||||
{
|
||||
throw new NotImplementedException();
|
||||
}
|
||||
|
||||
public void UpdateSettings(PowerLauncherPluginSettings settings)
|
||||
{
|
||||
_notGlobalIfUri = settings?.AdditionalOptions?.FirstOrDefault(x => x.Key == NotGlobalIfUri)?.Value ?? false;
|
||||
}
|
||||
|
||||
public void ReloadData()
|
||||
{
|
||||
if (_context is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
UpdateIconPath(_context.API.GetCurrentTheme());
|
||||
BrowserInfo.UpdateIfTimePassed();
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
Dispose(true);
|
||||
@@ -426,15 +265,5 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
_disposed = true;
|
||||
}
|
||||
}
|
||||
|
||||
public Control CreateSettingPanel()
|
||||
{
|
||||
throw new NotImplementedException();
|
||||
}
|
||||
|
||||
public void UpdateSettings(PowerLauncherPluginSettings settings)
|
||||
{
|
||||
_notGlobalIfUri = settings?.AdditionalOptions?.FirstOrDefault(x => x.Key == NotGlobalIfUri)?.Value ?? false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
// 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.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
|
||||
namespace Community.PowerToys.Run.Plugin.WebSearch
|
||||
{
|
||||
internal static class NativeMethods
|
||||
{
|
||||
internal enum Hresult : uint
|
||||
{
|
||||
Ok = 0x0000,
|
||||
}
|
||||
|
||||
[DllImport("shlwapi.dll", CharSet = CharSet.Unicode)]
|
||||
internal static extern Hresult SHLoadIndirectString(string pszSource, StringBuilder pszOutBuf, uint cchOutBuf, IntPtr ppvReserved);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user