[FxCop] Svg preview handler (#6647)

* Adjusting namespace

* Getting FxCop working e2e

installer/PowerToysSetup/Product.wxs

@@ -421,18 +421,18 @@
         <!-- Added a separate component for Per-User registry changes -->
         <!-- Registry Key for Class Registration of Svg Preview Handler -->
         <RegistryKey Root="HKCR" Key="CLSID\{ddee2b8a-6807-48a6-bb20-2338174ff779}">
-          <RegistryValue Type="string" Value="SvgPreviewHandler.SvgPreviewHandler" />
+          <RegistryValue Type="string" Value="Microsoft.PowerToys.PreviewHandler.Svg.SvgPreviewHandler" />
           <RegistryValue Type="string" Name="DisplayName" Value="Svg Preview Handler" />
           <RegistryValue Type="string" Name="AppID" Value="{CF142243-F059-45AF-8842-DBBE9783DB14}" />
           <RegistryValue Type="string" Key="Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value=""/>
           <RegistryValue Type="string" Key="InprocServer32" Value="mscoree.dll" />
           <RegistryValue Type="string" Key="InprocServer32" Name="Assembly" Value="SvgPreviewHandler, Version=$(var.Version).0, Culture=neutral" />
-          <RegistryValue Type="string" Key="InprocServer32" Name="Class" Value="SvgPreviewHandler.SvgPreviewHandler" />
+          <RegistryValue Type="string" Key="InprocServer32" Name="Class" Value="Microsoft.PowerToys.PreviewHandler.Svg.SvgPreviewHandler" />
           <RegistryValue Type="string" Key="InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" />
           <RegistryValue Type="string" Key="InprocServer32" Name="ThreadingModel" Value="Both" />
           <RegistryValue Type="string" Key="InprocServer32" Name="CodeBase" Value="file:///[FileExplorerPreviewInstallFolder]SvgPreviewHandler.dll" />
           <RegistryValue Type="string" Key="InprocServer32\$(var.Version).0" Name="Assembly" Value="SvgPreviewHandler, Version=$(var.Version).0, Culture=neutral" />
-          <RegistryValue Type="string" Key="InprocServer32\$(var.Version).0" Name="Class" Value="SvgPreviewHandler.SvgPreviewHandler" />
+          <RegistryValue Type="string" Key="InprocServer32\$(var.Version).0" Name="Class" Value="Microsoft.PowerToys.PreviewHandler.Svg.SvgPreviewHandler" />
           <RegistryValue Type="string" Key="InprocServer32\$(var.Version).0" Name="RuntimeVersion" Value="v4.0.30319" />
           <RegistryValue Type="string" Key="InprocServer32\$(var.Version).0" Name="CodeBase" Value="file:///[FileExplorerPreviewInstallFolder]SvgPreviewHandler.dll" />
         </RegistryKey>

src/modules/previewpane/SvgPreviewHandler/SvgPreviewControl.cs

@@ -3,22 +3,18 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Collections.Generic;
 using System.Drawing;
 using System.IO;
-using System.Linq;
 using System.Runtime.InteropServices.ComTypes;
-using System.Runtime.Versioning;
 using System.Windows.Forms;
-using System.Xml;
-using System.Xml.Linq;
 using Common;
 using Common.Utilities;
+using Microsoft.PowerToys.PreviewHandler.Svg.Telemetry.Events;
+using Microsoft.PowerToys.PreviewHandler.Svg.Utilities;
 using Microsoft.PowerToys.Telemetry;
 using PreviewHandlerCommon;
-using SvgPreviewHandler.Telemetry.Events;
 
-namespace SvgPreviewHandler
+namespace Microsoft.PowerToys.PreviewHandler.Svg
 {
     /// <summary>
     /// Implementation of Control for Svg Preview Handler.
@@ -28,29 +24,29 @@ public class SvgPreviewControl : FormHandlerControl
         /// <summary>
         /// Extended Browser Control to display Svg.
         /// </summary>
-        private WebBrowserExt browser;
+        private WebBrowserExt _browser;
 
         /// <summary>
         /// Text box to display the information about blocked elements from Svg.
         /// </summary>
-        private RichTextBox textBox;
+        private RichTextBox _textBox;
 
         /// <summary>
         /// Represent if an text box info bar is added for showing message.
         /// </summary>
-        private bool infoBarAdded = false;
+        private bool _infoBarAdded;
 
         /// <summary>
         /// Start the preview on the Control.
         /// </summary>
         /// <param name="dataSource">Stream reference to access source file.</param>
         public override void DoPreview<T>(T dataSource)
         {
-            this.InvokeOnControlThread(() =>
+            InvokeOnControlThread(() =>
             {
                 try
                 {
-                    this.infoBarAdded = false;
+                    _infoBarAdded = false;
                     string svgData = null;
                     using (var stream = new StreamWrapper(dataSource as IStream))
                     {
@@ -63,21 +59,23 @@ public override void DoPreview<T>(T dataSource)
                     // Add a info bar on top of the Preview if any blocked element is present.
                     if (SvgPreviewHandlerHelper.CheckBlockedElements(svgData))
                     {
-                        this.infoBarAdded = true;
-                        this.AddTextBoxControl(Resource.BlockedElementInfoText);
+                        _infoBarAdded = true;
+                        AddTextBoxControl(Resource.BlockedElementInfoText);
                     }
 
-                    this.AddBrowserControl(svgData);
-                    this.Resize += this.FormResized;
+                    AddBrowserControl(svgData);
+                    Resize += FormResized;
                     base.DoPreview(dataSource);
                     PowerToysTelemetry.Log.WriteEvent(new SvgFilePreviewed());
                 }
+#pragma warning disable CA1031 // Do not catch general exception types
                 catch (Exception ex)
+#pragma warning restore CA1031 // Do not catch general exception types
                 {
                     PowerToysTelemetry.Log.WriteEvent(new SvgFilePreviewError { Message = ex.Message });
-                    this.Controls.Clear();
-                    this.infoBarAdded = true;
-                    this.AddTextBoxControl(Resource.SvgNotPreviewedError);
+                    Controls.Clear();
+                    _infoBarAdded = true;
+                    AddTextBoxControl(Resource.SvgNotPreviewedError);
                     base.DoPreview(dataSource);
                 }
             });
@@ -101,9 +99,9 @@ private void RTBContentsResized(object sender, ContentsResizedEventArgs e)
         /// <param name="e">Provides data for the resize event.</param>
         private void FormResized(object sender, EventArgs e)
         {
-            if (this.infoBarAdded)
+            if (_infoBarAdded)
             {
-                this.textBox.Width = this.Width;
+                _textBox.Width = Width;
             }
         }
 
@@ -113,14 +111,14 @@ private void FormResized(object sender, EventArgs e)
         /// <param name="svgData">Svg to display on Browser Control.</param>
         private void AddBrowserControl(string svgData)
         {
-            this.browser = new WebBrowserExt();
-            this.browser.DocumentText = svgData;
-            this.browser.Dock = DockStyle.Fill;
-            this.browser.IsWebBrowserContextMenuEnabled = false;
-            this.browser.ScriptErrorsSuppressed = true;
-            this.browser.ScrollBarsEnabled = true;
-            this.browser.AllowNavigation = false;
-            this.Controls.Add(this.browser);
+            _browser = new WebBrowserExt();
+            _browser.DocumentText = svgData;
+            _browser.Dock = DockStyle.Fill;
+            _browser.IsWebBrowserContextMenuEnabled = false;
+            _browser.ScriptErrorsSuppressed = true;
+            _browser.ScrollBarsEnabled = true;
+            _browser.AllowNavigation = false;
+            Controls.Add(_browser);
         }
 
         /// <summary>
@@ -129,16 +127,16 @@ private void AddBrowserControl(string svgData)
         /// <param name="message">Message to be displayed in textbox.</param>
         private void AddTextBoxControl(string message)
         {
-            this.textBox = new RichTextBox();
-            this.textBox.Text = message;
-            this.textBox.BackColor = Color.LightYellow;
-            this.textBox.Multiline = true;
-            this.textBox.Dock = DockStyle.Top;
-            this.textBox.ReadOnly = true;
-            this.textBox.ContentsResized += this.RTBContentsResized;
-            this.textBox.ScrollBars = RichTextBoxScrollBars.None;
-            this.textBox.BorderStyle = BorderStyle.None;
-            this.Controls.Add(this.textBox);
+            _textBox = new RichTextBox();
+            _textBox.Text = message;
+            _textBox.BackColor = Color.LightYellow;
+            _textBox.Multiline = true;
+            _textBox.Dock = DockStyle.Top;
+            _textBox.ReadOnly = true;
+            _textBox.ContentsResized += RTBContentsResized;
+            _textBox.ScrollBars = RichTextBoxScrollBars.None;
+            _textBox.BorderStyle = BorderStyle.None;
+            Controls.Add(_textBox);
         }
     }
 }

src/modules/previewpane/SvgPreviewHandler/SvgPreviewHandler.cs

@@ -7,30 +7,59 @@
 using Common;
 using Microsoft.PowerToys.Telemetry;
 
-namespace SvgPreviewHandler
+namespace Microsoft.PowerToys.PreviewHandler.Svg
 {
     /// <summary>
     /// Extends <see cref="StreamBasedPreviewHandler"/> for Svg Preview Handler.
     /// </summary>
     [Guid("ddee2b8a-6807-48a6-bb20-2338174ff779")]
     [ClassInterface(ClassInterfaceType.None)]
     [ComVisible(true)]
-    public class SvgPreviewHandler : StreamBasedPreviewHandler
+    public class SvgPreviewHandler : StreamBasedPreviewHandler, IDisposable
     {
-        private SvgPreviewControl svgPreviewControl;
+        private SvgPreviewControl _svgPreviewControl;
+        private bool disposedValue;
 
         /// <inheritdoc/>
         public override void DoPreview()
         {
-            this.svgPreviewControl.DoPreview(this.Stream);
+            _svgPreviewControl.DoPreview(Stream);
         }
 
         /// <inheritdoc/>
         protected override IPreviewHandlerControl CreatePreviewHandlerControl()
         {
             PowerToysTelemetry.Log.WriteEvent(new Telemetry.Events.SvgFileHandlerLoaded());
-            this.svgPreviewControl = new SvgPreviewControl();
-            return this.svgPreviewControl;
+            _svgPreviewControl = new SvgPreviewControl();
+
+            return _svgPreviewControl;
+        }
+
+        /// <summary>
+        /// Disposes objects
+        /// </summary>
+        /// <param name="disposing">Is Disposing</param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    _svgPreviewControl.Dispose();
+                }
+
+                // TODO: free unmanaged resources (unmanaged objects) and override finalizer
+                // TODO: set large fields to null
+                disposedValue = true;
+            }
+        }
+
+        /// <inheritdoc/>
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
         }
     }
 }

src/modules/previewpane/SvgPreviewHandler/SvgPreviewHandler.csproj

@@ -44,7 +44,7 @@
     <ProjectGuid>{DA425894-6E13-404F-8DCB-78584EC0557A}</ProjectGuid>
     <OutputType>Library</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
-    <RootNamespace>SvgPreviewHandler</RootNamespace>
+    <RootNamespace>Microsoft.PowerToys.PreviewHandler.Svg</RootNamespace>
     <AssemblyName>SvgPreviewHandler</AssemblyName>
     <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
@@ -115,6 +115,7 @@
     <Compile Include="Telemetry\Events\SvgFileHandlerLoaded.cs" />
     <Compile Include="Telemetry\Events\SvgFilePreviewed.cs" />
     <Compile Include="Telemetry\Events\SvgFilePreviewError.cs" />
+    <Compile Include="Utilities\SvgPreviewHandlerHelper.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\..\common\ManagedTelemetry\Telemetry\Telemetry.csproj">
@@ -132,6 +133,11 @@
     </AdditionalFiles>
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers">
+      <Version>3.3.0</Version>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="StyleCop.Analyzers">
       <Version>1.1.118</Version>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

src/modules/previewpane/SvgPreviewHandler/Telemetry/Events/SvgFileHandlerLoaded.cs

@@ -6,7 +6,7 @@
 using Microsoft.PowerToys.Telemetry;
 using Microsoft.PowerToys.Telemetry.Events;
 
-namespace SvgPreviewHandler.Telemetry.Events
+namespace Microsoft.PowerToys.PreviewHandler.Svg.Telemetry.Events
 {
     /// <summary>
     /// A telemetry event to be raised when a svg file has been viewed in the preview pane.

src/modules/previewpane/SvgPreviewHandler/Telemetry/Events/SvgFilePreviewError.cs

@@ -6,7 +6,7 @@
 using Microsoft.PowerToys.Telemetry;
 using Microsoft.PowerToys.Telemetry.Events;
 
-namespace SvgPreviewHandler.Telemetry.Events
+namespace Microsoft.PowerToys.PreviewHandler.Svg.Telemetry.Events
 {
     /// <summary>
     /// A telemetry event to be raised when an error has occurred in the preview pane.

src/modules/previewpane/SvgPreviewHandler/Telemetry/Events/SvgFilePreviewed.cs

@@ -6,7 +6,7 @@
 using Microsoft.PowerToys.Telemetry;
 using Microsoft.PowerToys.Telemetry.Events;
 
-namespace SvgPreviewHandler.Telemetry.Events
+namespace Microsoft.PowerToys.PreviewHandler.Svg.Telemetry.Events
 {
     /// <summary>
     /// A telemetry event to be raised when a svg file has been viewed in the preview pane.

src/modules/previewpane/common/Utilities/SvgPreviewHandlerHelper.cs → src/modules/previewpane/SvgPreviewHandler/Utilities/SvgPreviewHandlerHelper.cs

@@ -4,15 +4,16 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using System.Xml.Linq;
 
-namespace Common.Utilities
+namespace Microsoft.PowerToys.PreviewHandler.Svg.Utilities
 {
     /// <summary>
     /// Helper utilities for Svg Preview Handler.
     /// </summary>
-    public class SvgPreviewHandlerHelper
+    public static class SvgPreviewHandlerHelper
     {
         /// <summary>
         /// Dictionary of elements in lower case that are blocked from Svg for preview pane.
@@ -46,7 +47,7 @@ public static bool CheckBlockedElements(string svgData)
                 var elements = doc.Descendants().ToList();
                 foreach (XElement element in elements)
                 {
-                    var elementName = element?.Name?.LocalName?.ToLower();
+                    var elementName = element?.Name?.LocalName?.ToLower(CultureInfo.CurrentCulture);
                     if (elementName != null && blockedElementsName.ContainsKey(elementName))
                     {
                         foundBlockedElement = true;
@@ -56,7 +57,9 @@ public static bool CheckBlockedElements(string svgData)
                     }
                 }
             }
+#pragma warning disable CA1031 // Do not catch general exception types
             catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception types
             {
             }
 

src/modules/previewpane/UnitTests-SvgPreviewHandler/SvgPreviewControlTests.cs

@@ -4,15 +4,14 @@
 
 using System;
 using System.Drawing;
-using System.IO;
 using System.Runtime.InteropServices;
 using System.Runtime.InteropServices.ComTypes;
 using System.Text;
 using System.Windows.Forms;
+using Microsoft.PowerToys.PreviewHandler.Svg;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;
 using PreviewHandlerCommon;
-using SvgPreviewHandler;
 
 namespace SvgPreviewHandlerUnitTests
 {

src/modules/previewpane/UnitTests-SvgPreviewHandler/SvgPreviewHandlerHelperTests.cs

@@ -3,7 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Text;
-using Common.Utilities;
+using Microsoft.PowerToys.PreviewHandler.Svg.Utilities;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace SvgPreviewHandlerUnitTests

src/modules/previewpane/common/PreviewHandlerCommon.csproj

@@ -130,7 +130,6 @@
     <Compile Include="handlers\StreamBasedPreviewHandler.cs" />
     <Compile Include="examplehandler\TestCustomHandler.cs" />
     <Compile Include="Utilities\StreamWrapper.cs" />
-    <Compile Include="Utilities\SvgPreviewHandlerHelper.cs" />
   </ItemGroup>
   <ItemGroup>
     <AdditionalFiles Include="..\..\..\codeAnalysis\StyleCop.json">