mirror of
https://github.com/microsoft/PowerToys.git
synced 2025-06-07 17:42:45 +08:00
6ac508fb93
* dotnet sc
* MD preview - C# app
- working self-contained
* Gcode preview - C# app
* DevFiles preview - C# app
* Fix passing path with spaces as cmd arg and monacocpp proj file
* Pdf preview - C# app
* Svg preview - C# app
* Fix comment
* Gcode thumbnail - C# app
TODO:
- installer
- why IThumbnailProvider and IIntializeWithFile doesn't work?
* Pdf thumbnail - C# app
TODO:
- installer
- why IThumbnailProvider and IIntializeWithFile doesn't work?
* Pdf thumbnail - C# app
TODO:
- installer
- why IThumbnailProvider and IIntializeWithFile doesn't work?
* Fix GcodeThumbnailProviderCpp.vcxproj
* Svg thumbnail - C# app
TODO:
- installer
- why IThumbnailProvider and IIntializeWithFile doesn't work?
* Fix Svg tests
* Thumbnail providers - installer
* Self-contained Hosts and FileLocksmith
* Fix hardcoded <RuntimeIdentifier>
* Remove unneeded files
* Try to fix Nuget in PR CI
* Prefix new dlls with PowerToys.
Sign new dlls and exes
* Add new .exe files to ProcessList
* ci: debug by listing all env vars
* ci: try setting variable in the right ci file
* Bring back hardcoded RuntimeIdentifier
* ci: Add comment and remove debug action
* Remove unneeded lib
* [WIP] Platform conditional dotnet files & hardlinks
* Cleanup
* Update expect.txt
* Test fix - ARM installer
* Fix uninstall bug
* Update docs
* Fix failing test
* Add dll details
* Minor cleanup
* Improve resizing
* Add some logs
* Test fix - release build
* Remove InvokeOnControlThread
* Test fix: logger initialization
* Fix arm64 installer
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
Co-authored-by: Dustin L. Howett <dustin@howett.net>
337 lines
18 KiB
C#
337 lines
18 KiB
C#
// 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.Drawing;
|
|
using System.IO;
|
|
using System.IO.Abstractions;
|
|
using System.Reflection;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Text.RegularExpressions;
|
|
using System.Windows.Forms;
|
|
using Common;
|
|
using Markdig;
|
|
using Microsoft.PowerToys.PreviewHandler.Markdown.Properties;
|
|
using Microsoft.PowerToys.PreviewHandler.Markdown.Telemetry.Events;
|
|
using Microsoft.PowerToys.Telemetry;
|
|
using Microsoft.Web.WebView2.Core;
|
|
using Microsoft.Web.WebView2.WinForms;
|
|
using Windows.System;
|
|
|
|
namespace Microsoft.PowerToys.PreviewHandler.Markdown
|
|
{
|
|
/// <summary>
|
|
/// Win Form Implementation for Markdown Preview Handler.
|
|
/// </summary>
|
|
public class MarkdownPreviewHandlerControl : FormHandlerControl
|
|
{
|
|
private static readonly IFileSystem FileSystem = new FileSystem();
|
|
private static readonly IPath Path = FileSystem.Path;
|
|
private static readonly IFile File = FileSystem.File;
|
|
|
|
/// <summary>
|
|
/// Extension to modify markdown AST.
|
|
/// </summary>
|
|
private readonly HTMLParsingExtension _extension;
|
|
|
|
/// <summary>
|
|
/// Markdig Pipeline builder.
|
|
/// </summary>
|
|
private readonly MarkdownPipelineBuilder _pipelineBuilder;
|
|
|
|
/// <summary>
|
|
/// Markdown HTML header for light theme.
|
|
/// </summary>
|
|
private readonly string htmlLightHeader = "<!doctype html><style>body{width:100%;margin:0;font-family:-apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;text-align:left;background-color:#fff}.container{padding:5%}body img{max-width:100%;height:auto}body h1,body h2,body h3,body h4,body h5,body h6{margin-top:24px;margin-bottom:16px;font-weight:600;line-height:1.25}body h1,body h2{padding-bottom:.3em;border-bottom:1px solid #eaecef}body{font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}body h3{font-size:1.25em}body h4{font-size:1em}body h5{font-size:.875em}body h6{font-size:.85em;color:#6a737d}pre{font-family:SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;background-color:#f6f8fa;border-radius:3px;padding:16px;font-size:85%}a{color:#0366d6}strong{font-weight:600}em{font-style:italic}code{padding:.2em .4em;margin:0;font-size:85%;background-color:#f6f8fa;border-radius:3px}hr{border-color:#EEE -moz-use-text-color #FFF;border-style:solid none;border-width:.5px 0;margin:18px 0}table{display:block;width:100%;overflow:auto;border-spacing:0;border-collapse:collapse}tbody{display:table-row-group;vertical-align:middle;border-color:inherit;vertical-align:inherit;border-color:inherit}table tr{background-color:#fff;border-top:1px solid #c6cbd1}tr{display:table-row;vertical-align:inherit;border-color:inherit}table td,table th{padding:6px 13px;border:1px solid #dfe2e5}th{font-weight:600;display:table-cell;vertical-align:inherit;font-weight:bold;text-align:-internal-center}thead{display:table-header-group;vertical-align:middle;border-color:inherit}td{display:table-cell;vertical-align:inherit}code,pre,tt{font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;color:#24292e;overflow-x:auto}pre code{font-size:inherit;color:inherit;word-break:normal}blockquote{background-color:#fff;border-radius:3px;padding:15px;font-size:14px;display:block;margin-block-start:1em;margin-block-end:1em;margin-inline-start:40px;margin-inline-end:40px;padding:0 1em;color:#6a737d;border-left:.25em solid #dfe2e5}</style><body><div class=\"container\">";
|
|
|
|
/// <summary>
|
|
/// Markdown HTML header for dark theme.
|
|
/// </summary>
|
|
private readonly string htmlDarkHeader = "<!doctype html><style>body{width:100%;margin:0;font-family:-apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";font-size:1rem;font-weight:400;line-height:1.5;color:#d4d4d4;text-align:left;background-color:#1e1e1e}.container{padding:5%}body img{max-width:100%;height:auto}body h1,body h2,body h3,body h4,body h5,body h6{margin-top:24px;margin-bottom:16px;font-weight:600;line-height:1.25}body h1,body h2{padding-bottom:.3em;border-bottom:1px solid #474747}body{font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}body h3{font-size:1.25em}body h4{font-size:1em}body h5{font-size:.875em}body h6{font-size:.85em;color:#d4d4d4}pre{font-family:SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;background-color:#161616;border-radius:3px;padding:16px;font-size:85%}a{color:#0366d6}strong{font-weight:600}em{font-style:italic}code{padding:.2em .4em;margin:0;font-size:85%;background-color:#161616;border-radius:3px}hr{border-color:#EEE -moz-use-text-color #FFF;border-style:solid none;border-width:.5px 0;margin:18px 0}table{display:block;width:100%;overflow:auto;border-spacing:0;border-collapse:collapse}tbody{display:table-row-group;vertical-align:middle;border-color:inherit;vertical-align:inherit;border-color:inherit}table tr{background-color:#1e1e1e;border-top:1px solid #c6cbd1}tr{display:table-row;vertical-align:inherit;border-color:inherit}table td,table th{padding:6px 13px;border:1px solid #474747}th{font-weight:600;display:table-cell;vertical-align:inherit;font-weight:bold;text-align:-internal-center}thead{display:table-header-group;vertical-align:middle;border-color:inherit}td{display:table-cell;vertical-align:inherit}code,pre,tt{font-family:SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;color:#d4d4d4;overflow-x:auto}pre code{font-size:inherit;color:inherit;word-break:normal}blockquote{background-color:#282828;border-radius:3px;padding:15px;font-size:14px;display:block;margin-block-start:1em;margin-block-end:1em;margin-inline-start:40px;margin-inline-end:40px;padding:0 1em;color:#d4d4d4;border-left:.25em solid #d4d4d4}</style><body><div class=\"container\">";
|
|
|
|
/// <summary>
|
|
/// Markdown HTML footer.
|
|
/// </summary>
|
|
private readonly string htmlFooter = "</div></body></html>";
|
|
|
|
/// <summary>
|
|
/// RichTextBox control to display if external images are blocked.
|
|
/// </summary>
|
|
private RichTextBox _infoBar;
|
|
|
|
/// <summary>
|
|
/// Extended Browser Control to display markdown html.
|
|
/// </summary>
|
|
private WebView2 _browser;
|
|
|
|
/// <summary>
|
|
/// WebView2 Environment
|
|
/// </summary>
|
|
private CoreWebView2Environment _webView2Environment;
|
|
|
|
/// <summary>
|
|
/// Name of the virtual host
|
|
/// </summary>
|
|
public const string VirtualHostName = "PowerToysLocalMarkdown";
|
|
|
|
/// <summary>
|
|
/// URI of the local file saved with the contents
|
|
/// </summary>
|
|
private Uri _localFileURI;
|
|
|
|
/// <summary>
|
|
/// True if external image is blocked, false otherwise.
|
|
/// </summary>
|
|
private bool _infoBarDisplayed;
|
|
|
|
/// <summary>
|
|
/// Gets the path of the current assembly.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Source: https://stackoverflow.com/a/283917/14774889
|
|
/// </remarks>
|
|
public static string AssemblyDirectory
|
|
{
|
|
get
|
|
{
|
|
string codeBase = Assembly.GetExecutingAssembly().Location;
|
|
UriBuilder uri = new UriBuilder(codeBase);
|
|
string path = Uri.UnescapeDataString(uri.Path);
|
|
return Path.GetDirectoryName(path);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Represent WebView2 user data folder path.
|
|
/// </summary>
|
|
private string _webView2UserDataFolder = System.Environment.GetEnvironmentVariable("USERPROFILE") +
|
|
"\\AppData\\LocalLow\\Microsoft\\PowerToys\\MarkdownPreview-Temp";
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MarkdownPreviewHandlerControl"/> class.
|
|
/// </summary>
|
|
public MarkdownPreviewHandlerControl()
|
|
{
|
|
// if you have a string with double space, some people view it as a new line.
|
|
// while this is against spec, even GH supports this. Technically looks like GH just trims whitespace
|
|
// https://github.com/microsoft/PowerToys/issues/10354
|
|
var softlineBreak = new Markdig.Extensions.Hardlines.SoftlineBreakAsHardlineExtension();
|
|
_extension = new HTMLParsingExtension(ImagesBlockedCallBack);
|
|
|
|
_pipelineBuilder = new MarkdownPipelineBuilder().UseAdvancedExtensions().UseEmojiAndSmiley().UseYamlFrontMatter().UseMathematics();
|
|
_pipelineBuilder.Extensions.Add(_extension);
|
|
_pipelineBuilder.Extensions.Add(softlineBreak);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Start the preview on the Control.
|
|
/// </summary>
|
|
/// <param name="dataSource">Path to the file.</param>
|
|
public override void DoPreview<T>(T dataSource)
|
|
{
|
|
if (global::PowerToys.GPOWrapper.GPOWrapper.GetConfiguredMarkdownPreviewEnabledValue() == global::PowerToys.GPOWrapper.GpoRuleConfigured.Disabled)
|
|
{
|
|
// GPO is disabling this utility. Show an error message instead.
|
|
_infoBarDisplayed = true;
|
|
_infoBar = GetTextBoxControl(Resources.GpoDisabledErrorText);
|
|
Resize += FormResized;
|
|
Controls.Add(_infoBar);
|
|
base.DoPreview(dataSource);
|
|
|
|
return;
|
|
}
|
|
|
|
CleanupWebView2UserDataFolder();
|
|
|
|
_infoBarDisplayed = false;
|
|
|
|
try
|
|
{
|
|
if (!(dataSource is string filePath))
|
|
{
|
|
throw new ArgumentException($"{nameof(dataSource)} for {nameof(MarkdownPreviewHandlerControl)} must be a string but was a '{typeof(T)}'");
|
|
}
|
|
|
|
string fileText = File.ReadAllText(filePath);
|
|
Regex imageTagRegex = new Regex(@"<[ ]*img.*>");
|
|
if (imageTagRegex.IsMatch(fileText))
|
|
{
|
|
_infoBarDisplayed = true;
|
|
}
|
|
|
|
var htmlHeader = Common.UI.ThemeManager.GetWindowsBaseColor().ToLowerInvariant() == "dark" ? htmlDarkHeader : htmlLightHeader;
|
|
_extension.FilePath = Path.GetDirectoryName(filePath);
|
|
MarkdownPipeline pipeline = _pipelineBuilder.Build();
|
|
string parsedMarkdown = Markdig.Markdown.ToHtml(fileText, pipeline);
|
|
string markdownHTML = $"{htmlHeader}{parsedMarkdown}{htmlFooter}";
|
|
|
|
_browser = new WebView2()
|
|
{
|
|
Dock = DockStyle.Fill,
|
|
};
|
|
|
|
var webView2Options = new CoreWebView2EnvironmentOptions("--block-new-web-contents");
|
|
ConfiguredTaskAwaitable<CoreWebView2Environment>.ConfiguredTaskAwaiter
|
|
webView2EnvironmentAwaiter = CoreWebView2Environment
|
|
.CreateAsync(userDataFolder: _webView2UserDataFolder, options: webView2Options)
|
|
.ConfigureAwait(true).GetAwaiter();
|
|
webView2EnvironmentAwaiter.OnCompleted(async () =>
|
|
{
|
|
try
|
|
{
|
|
_webView2Environment = webView2EnvironmentAwaiter.GetResult();
|
|
await _browser.EnsureCoreWebView2Async(_webView2Environment).ConfigureAwait(true);
|
|
_browser.CoreWebView2.SetVirtualHostNameToFolderMapping(VirtualHostName, AssemblyDirectory, CoreWebView2HostResourceAccessKind.Deny);
|
|
_browser.CoreWebView2.Settings.AreDefaultScriptDialogsEnabled = false;
|
|
_browser.CoreWebView2.Settings.AreDefaultContextMenusEnabled = false;
|
|
_browser.CoreWebView2.Settings.AreDevToolsEnabled = false;
|
|
_browser.CoreWebView2.Settings.AreHostObjectsAllowed = false;
|
|
_browser.CoreWebView2.Settings.IsGeneralAutofillEnabled = false;
|
|
_browser.CoreWebView2.Settings.IsPasswordAutosaveEnabled = false;
|
|
_browser.CoreWebView2.Settings.IsScriptEnabled = false;
|
|
_browser.CoreWebView2.Settings.IsWebMessageEnabled = false;
|
|
|
|
// Don't load any resources.
|
|
_browser.CoreWebView2.AddWebResourceRequestedFilter("*", CoreWebView2WebResourceContext.All);
|
|
_browser.CoreWebView2.WebResourceRequested += (object sender, CoreWebView2WebResourceRequestedEventArgs e) =>
|
|
{
|
|
// Show local file we've saved with the markdown contents. Block all else.
|
|
if (new Uri(e.Request.Uri) != _localFileURI)
|
|
{
|
|
e.Response = _browser.CoreWebView2.Environment.CreateWebResourceResponse(null, 403, "Forbidden", null);
|
|
}
|
|
};
|
|
|
|
// WebView2.NavigateToString() limitation
|
|
// See https://learn.microsoft.com/dotnet/api/microsoft.web.webview2.core.corewebview2.navigatetostring?view=webview2-dotnet-1.0.864.35#remarks
|
|
// While testing the limit, it turned out it is ~1.5MB, so to be on a safe side we go for 1.5m bytes
|
|
if (markdownHTML.Length > 1_500_000)
|
|
{
|
|
string filename = _webView2UserDataFolder + "\\" + Guid.NewGuid().ToString() + ".html";
|
|
File.WriteAllText(filename, markdownHTML);
|
|
_localFileURI = new Uri(filename);
|
|
_browser.Source = _localFileURI;
|
|
}
|
|
else
|
|
{
|
|
_browser.NavigateToString(markdownHTML);
|
|
}
|
|
|
|
Controls.Add(_browser);
|
|
|
|
_browser.NavigationStarting += async (object sender, CoreWebView2NavigationStartingEventArgs args) =>
|
|
{
|
|
if (args.Uri != null && args.Uri != _localFileURI?.ToString() && args.IsUserInitiated)
|
|
{
|
|
args.Cancel = true;
|
|
await Launcher.LaunchUriAsync(new Uri(args.Uri));
|
|
}
|
|
};
|
|
|
|
if (_infoBarDisplayed)
|
|
{
|
|
_infoBar = GetTextBoxControl(Resources.BlockedImageInfoText);
|
|
Resize += FormResized;
|
|
Controls.Add(_infoBar);
|
|
}
|
|
}
|
|
catch (NullReferenceException)
|
|
{
|
|
}
|
|
});
|
|
|
|
PowerToysTelemetry.Log.WriteEvent(new MarkdownFilePreviewed());
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
PowerToysTelemetry.Log.WriteEvent(new MarkdownFilePreviewError { Message = ex.Message });
|
|
|
|
Controls.Clear();
|
|
_infoBarDisplayed = true;
|
|
_infoBar = GetTextBoxControl(Resources.MarkdownNotPreviewedError);
|
|
Resize += FormResized;
|
|
Controls.Add(_infoBar);
|
|
}
|
|
finally
|
|
{
|
|
base.DoPreview(dataSource);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a textbox control.
|
|
/// </summary>
|
|
/// <param name="message">Message to be displayed in textbox.</param>
|
|
/// <returns>An object of type <see cref="RichTextBox"/>.</returns>
|
|
private RichTextBox GetTextBoxControl(string message)
|
|
{
|
|
RichTextBox richTextBox = new RichTextBox
|
|
{
|
|
Text = message,
|
|
BackColor = Color.LightYellow,
|
|
Multiline = true,
|
|
Dock = DockStyle.Top,
|
|
ReadOnly = true,
|
|
};
|
|
richTextBox.ContentsResized += RTBContentsResized;
|
|
richTextBox.ScrollBars = RichTextBoxScrollBars.None;
|
|
richTextBox.BorderStyle = BorderStyle.None;
|
|
|
|
return richTextBox;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Callback when RichTextBox is resized.
|
|
/// </summary>
|
|
/// <param name="sender">Reference to resized control.</param>
|
|
/// <param name="e">Provides data for the resize event.</param>
|
|
private void RTBContentsResized(object sender, ContentsResizedEventArgs e)
|
|
{
|
|
RichTextBox richTextBox = (RichTextBox)sender;
|
|
richTextBox.Height = e.NewRectangle.Height + 5;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Callback when form is resized.
|
|
/// </summary>
|
|
/// <param name="sender">Reference to resized control.</param>
|
|
/// <param name="e">Provides data for the event.</param>
|
|
private void FormResized(object sender, EventArgs e)
|
|
{
|
|
if (_infoBarDisplayed)
|
|
{
|
|
_infoBar.Width = Width;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Callback when image is blocked by extension.
|
|
/// </summary>
|
|
private void ImagesBlockedCallBack()
|
|
{
|
|
_infoBarDisplayed = true;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Cleanup the previously created tmp html files from svg files bigger than 2MB.
|
|
/// </summary>
|
|
private void CleanupWebView2UserDataFolder()
|
|
{
|
|
try
|
|
{
|
|
// Cleanup temp dir
|
|
var dir = new DirectoryInfo(_webView2UserDataFolder);
|
|
|
|
foreach (var file in dir.EnumerateFiles("*.html"))
|
|
{
|
|
file.Delete();
|
|
}
|
|
}
|
|
catch (Exception)
|
|
{
|
|
}
|
|
}
|
|
}
|
|
}
|