2020-07-16 01:23:59 +08:00
|
|
|
|
// 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.Text.RegularExpressions;
|
|
|
|
|
|
using System.Windows.Forms;
|
|
|
|
|
|
using Common;
|
|
|
|
|
|
using Markdig;
|
2020-09-17 02:15:34 +08:00
|
|
|
|
using Microsoft.PowerToys.PreviewHandler.Markdown.Properties;
|
|
|
|
|
|
using Microsoft.PowerToys.PreviewHandler.Markdown.Telemetry.Events;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
using Microsoft.PowerToys.Telemetry;
|
|
|
|
|
|
using PreviewHandlerCommon;
|
|
|
|
|
|
|
2020-09-17 02:15:34 +08:00
|
|
|
|
namespace Microsoft.PowerToys.PreviewHandler.Markdown
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Win Form Implementation for Markdown Preview Handler.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
public class MarkdownPreviewHandlerControl : FormHandlerControl
|
|
|
|
|
|
{
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Extension to modify markdown AST.
|
|
|
|
|
|
/// </summary>
|
2020-09-17 02:15:34 +08:00
|
|
|
|
private readonly HTMLParsingExtension _extension;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Markdig Pipeline builder.
|
|
|
|
|
|
/// </summary>
|
2020-09-17 02:15:34 +08:00
|
|
|
|
private readonly MarkdownPipelineBuilder _pipelineBuilder;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Markdown HTML header.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
private readonly string htmlHeader = "<!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 footer.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
private readonly string htmlFooter = "</div></body></html>";
|
|
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// RichTextBox control to display if external images are blocked.
|
|
|
|
|
|
/// </summary>
|
2020-09-17 02:15:34 +08:00
|
|
|
|
private RichTextBox _infoBar;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Extended Browser Control to display markdown html.
|
|
|
|
|
|
/// </summary>
|
2020-09-17 02:15:34 +08:00
|
|
|
|
private WebBrowserExt _browser;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// True if external image is blocked, false otherwise.
|
|
|
|
|
|
/// </summary>
|
2020-09-17 02:15:34 +08:00
|
|
|
|
private bool _infoBarDisplayed;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Initializes a new instance of the <see cref="MarkdownPreviewHandlerControl"/> class.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
public MarkdownPreviewHandlerControl()
|
|
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_extension = new HTMLParsingExtension(ImagesBlockedCallBack);
|
2020-09-23 00:10:18 +08:00
|
|
|
|
_pipelineBuilder = new MarkdownPipelineBuilder().UseAdvancedExtensions().UseEmojiAndSmiley().UseYamlFrontMatter().UseMathematics();
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_pipelineBuilder.Extensions.Add(_extension);
|
2020-07-16 01:23:59 +08:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Start the preview on the Control.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
/// <param name="dataSource">Path to the file.</param>
|
|
|
|
|
|
public override void DoPreview<T>(T dataSource)
|
|
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_infoBarDisplayed = false;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
|
|
|
|
|
try
|
|
|
|
|
|
{
|
|
|
|
|
|
if (!(dataSource is string filePath))
|
|
|
|
|
|
{
|
|
|
|
|
|
throw new ArgumentException($"{nameof(dataSource)} for {nameof(MarkdownPreviewHandler)} must be a string but was a '{typeof(T)}'");
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
string fileText = File.ReadAllText(filePath);
|
|
|
|
|
|
Regex imageTagRegex = new Regex(@"<[ ]*img.*>");
|
|
|
|
|
|
if (imageTagRegex.IsMatch(fileText))
|
|
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_infoBarDisplayed = true;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
}
|
|
|
|
|
|
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_extension.FilePath = Path.GetDirectoryName(filePath);
|
|
|
|
|
|
MarkdownPipeline pipeline = _pipelineBuilder.Build();
|
|
|
|
|
|
string parsedMarkdown = Markdig.Markdown.ToHtml(fileText, pipeline);
|
|
|
|
|
|
string markdownHTML = $"{htmlHeader}{parsedMarkdown}{htmlFooter}";
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
2020-09-17 02:15:34 +08:00
|
|
|
|
InvokeOnControlThread(() =>
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_browser = new WebBrowserExt
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
|
|
|
|
|
DocumentText = markdownHTML,
|
|
|
|
|
|
Dock = DockStyle.Fill,
|
|
|
|
|
|
IsWebBrowserContextMenuEnabled = false,
|
|
|
|
|
|
ScriptErrorsSuppressed = true,
|
|
|
|
|
|
ScrollBarsEnabled = true,
|
|
|
|
|
|
AllowNavigation = false,
|
|
|
|
|
|
};
|
2020-09-17 02:15:34 +08:00
|
|
|
|
Controls.Add(_browser);
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
2020-09-17 02:15:34 +08:00
|
|
|
|
if (_infoBarDisplayed)
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_infoBar = GetTextBoxControl(Resources.BlockedImageInfoText);
|
|
|
|
|
|
Resize += FormResized;
|
|
|
|
|
|
Controls.Add(_infoBar);
|
2020-07-16 01:23:59 +08:00
|
|
|
|
}
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
PowerToysTelemetry.Log.WriteEvent(new MarkdownFilePreviewed());
|
|
|
|
|
|
}
|
2020-09-17 02:15:34 +08:00
|
|
|
|
#pragma warning disable CA1031 // Do not catch general exception types
|
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
|
#pragma warning restore CA1031 // Do not catch general exception types
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
PowerToysTelemetry.Log.WriteEvent(new MarkdownFilePreviewError { Message = ex.Message });
|
2020-07-16 01:23:59 +08:00
|
|
|
|
|
2020-09-17 02:15:34 +08:00
|
|
|
|
InvokeOnControlThread(() =>
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
Controls.Clear();
|
|
|
|
|
|
_infoBarDisplayed = true;
|
|
|
|
|
|
_infoBar = GetTextBoxControl(Resources.MarkdownNotPreviewedError);
|
|
|
|
|
|
Resize += FormResized;
|
|
|
|
|
|
Controls.Add(_infoBar);
|
2020-07-16 01:23:59 +08:00
|
|
|
|
});
|
|
|
|
|
|
}
|
|
|
|
|
|
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,
|
|
|
|
|
|
};
|
2020-09-17 02:15:34 +08:00
|
|
|
|
richTextBox.ContentsResized += RTBContentsResized;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
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)
|
|
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
if (_infoBarDisplayed)
|
2020-07-16 01:23:59 +08:00
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_infoBar.Width = Width;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
|
/// Callback when image is blocked by extension.
|
|
|
|
|
|
/// </summary>
|
|
|
|
|
|
private void ImagesBlockedCallBack()
|
|
|
|
|
|
{
|
2020-09-17 02:15:34 +08:00
|
|
|
|
_infoBarDisplayed = true;
|
2020-07-16 01:23:59 +08:00
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
