refactoring, cleanup and bugfixes (#14)

Author: otuncelli

.gitignore

@@ -244,3 +244,9 @@ ModelManifest.xml
 # FAKE - F# Make
 .fake/
 /SvgFileType/*.bak
+/SvgFileType/Program.cs
+/SVGFileTypePlugin_setup.exe
+/SvgFileTypePlugin.zip
+/setup.nsi
+/CreateZippedRelease.bat
+/header.bmp

COPYING

@@ -1,21 +1,49 @@
-SvgFileType
-===========
+# ![W3C SVG Logo](https://www.w3.org/Icons/SVG/svg-logo-v.png) Scalable Vector Graphics (SVG) Plugin for Paint.NET 
+
 [![](https://img.shields.io/github/release-pre/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET.svg?style=flat)](https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/releases)
 [![](https://img.shields.io/github/downloads/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/total.svg?style=flat)](https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/releases)
 
-**Please check the [Releases](https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/releases) section for binary download.**
-
-**Please note:** The binary forms that you can get from the releases section are under the LGPL terms since they contain code from 
-[Fizzler: .NET CSS Selector Engine](https://github.com/atifaziz/Fizzler) project.
-
 This is a Paint.NET filetype plugin for loading SVG (Scalable Vector Graphics) and its compressed variant SVGZ files. 
 SVG elements can be rendered as a flat image file or each on a separate layer.
 
 The plugin is a tiny wrapper around the [SVG.NET Library](https://github.com/vvvv/SVG) which does the actual SVG reading.
 
-Tested on paint.net 4.2.16 stable & 4.3 alpha (4.300.7881.3082) releases.
+Tested on Paint.NET 4.2.16 & 4.3 Beta Build 7929.
+
+### Download links
+
+Here are the download links for latest release:
+
+<table>
+  <tr>
+    <th>Installer</th>
+    <th>Manual Installation</th>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/releases/latest/download/SvgFileType_setup.exe">SvgFileTypePlugin_setup.exe</a> (399 KiB)</td>
+    <td><a href="https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET/releases/latest/download/SvgFileType.zip">SvgFileTypePlugin.zip</a> (274 KiB)</td>
+  </tr>
+</table>
+
+### How to install
+
+&#x1F534; **Note: Before install make sure you don't have any other file type plugin installed handling the same file types as this plugin.**
 
-To install the plugin perform the following steps:
- * Put the DLL in the `<Paint.NET>\FileTypes` directory (default location is `C:\Program Files\paint.net\FileTypes`)
-   * For the [Windows Store version of Paint.NET](https://www.microsoft.com/store/apps/9NBHCS1LX4R0), put the DLL in the `<Documents>\paint.net App Files\FileTypes` directory
- * Restart Paint.NET if you have it open
+To auto install (recommended) the plugin perform the following steps:
+  * Download and run `SvgFileTypePlugin_setup.exe`
+  * Follow the steps of the setup wizard.
+	
+To manually install the plugin perform the following steps:
+  * Download and extract `SvgFileTypePlugin.zip`
+  * If you're using Paint.NET 4.3 or later:
+    * If you're using Classic version of Paint.NET:
+	    * Create a new folder named `SvgFileTypePlugin` in the `<Paint.NET>\FileTypes` directory (default location is `C:\Program Files\paint.net\FileTypes`).
+    * If you're using [Microsoft Store version of Paint.NET](https://www.microsoft.com/store/apps/9NBHCS1LX4R0):
+	    * Create a new folder named `SvgFileTypePlugin` in the `<Documents>\paint.net App Files\FileTypes` directory.
+    * Put the extracted files in this newly created folder.
+  * If you're using Paint.NET 4.2:
+	  * If you're using Classic version of Paint.NET:
+	    * Put the extracted files in the `<Paint.NET>\FileTypes` directory (default location is `C:\Program Files\paint.net\FileTypes`).
+	  * If you're using [Microsoft Store version of Paint.NET](https://www.microsoft.com/store/apps/9NBHCS1LX4R0):
+	    * Put the extracted files in the `<Documents>\paint.net App Files\FileTypes` directory.
+  * Restart Paint.NET.

README.md

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
-  <ILMerge IncludeAssemblies="Svg|Fizzler" FullImport="true" />
+  <ILMerge IncludeAssemblies="Svg|Fizzler" NamespacePrefix="SvgFileTypePlugin$" FullImport="true" />
 </Weavers>

SvgFileType.ThirdPartyNotices.txt

@@ -1,4 +1,8 @@
-namespace SvgFileTypePlugin
+// Copyright 2021 Osman Tunçelli. All rights reserved.
+// Use of this source code is governed by a LGPL license that can be
+// found in the COPYING file.
+
+namespace SvgFileTypePlugin
 {
     internal enum LayersMode
     {

SvgFileType/FodyWeavers.xml

@@ -8,6 +8,7 @@ namespace SvgFileTypePlugin
 {
     /// <summary>
     /// Parent centered MessageBox dialog in C#
+    /// https://gist.github.com/otuncelli/bd967d63d0151df14fefb1388e944e4e
     /// </summary>
     internal static class MessageBoxEx
     {

SvgFileType/LayersMode.cs

@@ -0,0 +1,31 @@
+// Copyright 2021 Osman Tunçelli. All rights reserved.
+// Use of this source code is governed by a LGPL license that can be
+// found in the COPYING file.
+
+using PaintDotNet;
+using System;
+using System.Reflection;
+
+namespace SvgFileTypePlugin
+{
+    public sealed class MyPluginSupportInfo : IPluginSupportInfo, IPluginSupportInfoProvider
+    {
+        public const string VersionString = "1.0.4.0";
+        public const string Url = "https://github.com/otuncelli/Scalable-Vector-Graphics-Plugin-for-Paint.NET";
+
+        #region IPluginSupportInfo
+        public string Author => "Osman Tunçelli";
+        public string Copyright => ((AssemblyCopyrightAttribute)(typeof(PluginSupportInfo).Assembly.GetCustomAttributes(typeof(AssemblyCopyrightAttribute), false)[0])).Copyright;
+        public string DisplayName => ((AssemblyProductAttribute)GetType().Assembly.GetCustomAttributes(typeof(AssemblyProductAttribute), inherit: false)[0]).Product;
+        public Version Version => typeof(PluginSupportInfo).Assembly.GetName().Version;
+        public Uri WebsiteUri => new Uri(Url);
+        #endregion
+
+        #region IPluginSupportInfoProvider
+        public IPluginSupportInfo GetPluginSupportInfo()
+        {
+            return new MyPluginSupportInfo();
+        }
+        #endregion
+    }
+}

SvgFileType/MessageBoxEx.cs

@@ -1,21 +1,26 @@
-using Svg;
+// Copyright 2021 Osman Tunçelli. All rights reserved.
+// Use of this source code is governed by a LGPL license that can be
+// found in the COPYING file.
+
+using Svg;
 using System;
 using System.Drawing;
 using System.Drawing.Drawing2D;
 
 namespace SvgFileTypePlugin
 {
     // Used to determine boundaries of a group.
-    internal class PaintGroupBoundaries : SvgVisualElement
+    internal sealed class PaintGroupBoundaries : SvgVisualElement
     {
-        public PaintGroupBoundaries(SvgGroup relatedGroup)
+        public PaintGroupBoundaries(SvgGroup relatedGroup, bool isStart)
         {
             RelatedGroup = relatedGroup;
+            IsStart = isStart;
         }
 
         public SvgGroup RelatedGroup { get; }
 
-        public bool IsStart { get; set; }
+        public bool IsStart { get; }
 
         public override RectangleF Bounds => throw new NotImplementedException();
 

SvgFileType/MyPluginSupportInfo.cs

@@ -1,69 +1,72 @@
-using Svg;
+// Copyright 2021 Osman Tunçelli. All rights reserved.
+// Use of this source code is governed by a LGPL license that can be
+// found in the COPYING file.
+
+using Svg;
 using System;
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
 
 namespace SvgFileTypePlugin
 {
-    /// <summary>
-    /// Supports opening compressed variant of svg
-    /// </summary>
-    internal class SvgDocumentOpener : IDisposable
+    internal static class SvgDocumentOpener
     {
-        private static readonly byte[] GZipHeaders = {0x1f, 0x8b, 0x8};
+        public static SvgDocument Open(Stream stream)
+        {
+            if (stream == null) throw new ArgumentNullException(nameof(stream), "Input stream can not be null.");
+            if (!stream.CanRead) throw new IOException("Input stream is not readable.");
 
-        private Stream InnerStream { get; }
+            byte[] first3Bytes = new byte[3];
+            byte[] gzipHeaderBytes = { 0x1f, 0x8b, 0x8 };
+            int read = stream.Read(first3Bytes, 0, 3);
+            if (read < 3) throw new IOException("Input stream does not contain valid svg data.");
 
-        private SvgDocumentOpener(Stream input)
-        {
-            if (input.Length < 3)
+            bool svgz = first3Bytes.SequenceEqual(gzipHeaderBytes);
+            Stream svgStream;
+
+            if (stream.CanSeek)
             {
-                throw new InvalidDataException();
+                stream.Seek(0, SeekOrigin.Begin);
+                svgStream = svgz ? new GZipStream(stream, CompressionMode.Decompress, true) : stream;
+                return FromStream(svgStream, svgz);
             }
-
-            var headerBytes = new byte[3];
-            input.Read(headerBytes, 0, headerBytes.Length);
-            input.Position = 0;
-            
-            // seems like input stream managed by paint.net
-            // so we leave it open and not dispose it
-            InnerStream = headerBytes.SequenceEqual(GZipHeaders)
-                ? new GZipStream(input, CompressionMode.Decompress, true) 
-                : input;
-        }
-
-        public static SvgDocument FromStream(Stream stream)
-        {
-            using (var wrapper = new SvgDocumentOpener(stream))
+            else
             {
-                return SvgDocument.Open<SvgDocument>(wrapper.InnerStream);
+                int length;
+                try
+                {
+                    length = (int)stream.Length;
+                }
+                catch (NotSupportedException)
+                {
+                    length = 3;
+                }
+
+                using (var memory = new MemoryStream(length))
+                {
+                    memory.Write(first3Bytes, 0, 3);
+                    stream.CopyTo(memory);
+                    memory.Seek(0, SeekOrigin.Begin);
+                    svgStream = svgz ? (Stream)new GZipStream(memory, CompressionMode.Decompress, false) : memory;
+                    return FromStream(svgStream, svgz);
+                }
             }
         }
 
-        #region IDisposable
-
-        private bool disposed;
-
-        public void Dispose()
+        private static SvgDocument FromStream(Stream stream, bool svgz)
         {
-            if (disposed)
+            try
             {
-                return;
+                return SvgDocument.Open<SvgDocument>(stream);
             }
-
-            // seems like input stream managed by paint.net
-            // so we leave it open and not dispose it.
-            // we only dispose the GZipStream created by
-            // this object.
-            if (InnerStream is GZipStream)
+            finally
             {
-                InnerStream.Dispose();
+                if (svgz)
+                {
+                    stream.Dispose();
+                }
             }
-
-            disposed = true;
         }
-
-        #endregion
     }
 }

SvgFileType/PaintGroupBoundaries.cs

@@ -1,19 +1,27 @@
-using Svg;
+// Copyright 2021 Osman Tunçelli. All rights reserved.
+// Use of this source code is governed by a LGPL license that can be
+// found in the COPYING file.
+
+using Svg;
 using System.Reflection;
 
 namespace SvgFileTypePlugin
 {
     internal static class SvgElementExtensions
     {
-        private static readonly MethodInfo ElementNameGetter =
-            typeof(SvgElement).GetProperty("ElementName",
-                BindingFlags.NonPublic | BindingFlags.Instance)?.GetGetMethod(true);
+        private static readonly MethodInfo ElementNameGetter = typeof(SvgElement).GetProperty("ElementName", BindingFlags.NonPublic | BindingFlags.Instance)?.GetGetMethod(true);
+        private static readonly MethodInfo AttributesGetter = typeof(SvgElement).GetProperty("Attributes", BindingFlags.NonPublic | BindingFlags.Instance)?.GetGetMethod(true);
 
         public static string GetName(this SvgElement element)
         {
             return element.GetType().GetCustomAttribute<SvgElementAttribute>()?.ElementName ??
-                ElementNameGetter?.Invoke(element, null) as string ??
+                ElementNameGetter.Invoke(element, null) as string ??
                 element.GetType().Name;
         }
+
+        public static SvgAttributeCollection GetAttributes(this SvgElement element)
+        {
+            return (SvgAttributeCollection)AttributesGetter.Invoke(element, null);
+        }
     }
 }