...

4 files changed, 354 insertions, 0 deletions

diff --git a/BackEnd/Timeline/Services/Imaging/ImageException.cs b/BackEnd/Timeline/Services/Imaging/ImageException.cs
new file mode 100644
index 00000000..926ecc0a
--- /dev/null
+++ b/BackEnd/Timeline/Services/Imaging/ImageException.cs
@@ -0,0 +1,58 @@
+using System;

+using System.Globalization;

+

+namespace Timeline.Services.Imaging

+{

+    [Serializable]

+    public class ImageException : Exception

+    {

+        public enum ErrorReason

+        {

+            /// <summary>

+            /// Decoding image failed.

+            /// </summary>

+            CantDecode,

+            /// <summary>

+            /// Decoding succeeded but the real type is not the specified type.

+            /// </summary>

+            UnmatchedFormat,

+            /// <summary>

+            /// Image is not of required size.

+            /// </summary>

+            NotSquare,

+            /// <summary>

+            /// Other unknown errer.

+            /// </summary>

+            Unknown

+        }

+

+        public ImageException() : this(null) { }

+        public ImageException(string? message) : this(message, null) { }

+        public ImageException(string? message, Exception? inner) : this(ErrorReason.Unknown, null, null, null, message, inner) { }

+

+        public ImageException(ErrorReason error, byte[]? data, string? requestType, string? realType, Exception? inner) : this(error, data, requestType, realType, null, inner) { }

+        public ImageException(ErrorReason error, byte[]? data, string? requestType = null, string? realType = null, string? message = null, Exception? inner = null) : base(message ?? MakeMessage(error), inner) { Error = error; ImageData = data; RequestType = requestType; RealType = realType; }

+

+        protected ImageException(

+          System.Runtime.Serialization.SerializationInfo info,

+          System.Runtime.Serialization.StreamingContext context) : base(info, context) { }

+

+        private static string MakeMessage(ErrorReason? reason) =>

+            string.Format(CultureInfo.InvariantCulture, Resource.ExceptionImage, reason switch

+            {

+                ErrorReason.CantDecode => Resource.ExceptionImageReasonCantDecode,

+                ErrorReason.UnmatchedFormat => Resource.ExceptionImageReasonUnmatchedFormat,

+                ErrorReason.NotSquare => Resource.ExceptionImageReasonBadSize,

+                _ => Resource.ExceptionImageReasonUnknownError

+            });

+

+        public ErrorReason Error { get; }

+#pragma warning disable CA1819 // Properties should not return arrays

+        public byte[]? ImageData { get; }

+#pragma warning restore CA1819 // Properties should not return arrays

+        public string? RequestType { get; }

+

+        // This field will be null if decoding failed.

+        public string? RealType { get; }

+    }

+}

diff --git a/BackEnd/Timeline/Services/Imaging/ImageValidator.cs b/BackEnd/Timeline/Services/Imaging/ImageValidator.cs
new file mode 100644
index 00000000..b4ae68dc
--- /dev/null
+++ b/BackEnd/Timeline/Services/Imaging/ImageValidator.cs
@@ -0,0 +1,53 @@
+using SixLabors.ImageSharp;

+using SixLabors.ImageSharp.Formats;

+using System;

+using System.Linq;

+using System.Threading.Tasks;

+

+namespace Timeline.Services.Imaging

+{

+    public interface IImageValidator

+    {

+        /// <summary>

+        /// Validate a image data.

+        /// </summary>

+        /// <param name="data">The data of the image. Can't be null.</param>

+        /// <param name="requestType">If not null, the real image format will be check against the requested format and throw if not match. If null, then do not check.</param>

+        /// <param name="square">If true, image must be square.</param>

+        /// <returns>The format.</returns>

+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="data"/> is null.</exception>

+        /// <exception cref="ImageException">Thrown when image data can't be decoded or real type does not match request type or image is not square when required.</exception>

+        Task<IImageFormat> Validate(byte[] data, string? requestType = null, bool square = false);

+    }

+

+    public class ImageValidator : IImageValidator

+    {

+        public ImageValidator()

+        {

+        }

+

+        public async Task<IImageFormat> Validate(byte[] data, string? requestType = null, bool square = false)

+        {

+            if (data == null)

+                throw new ArgumentNullException(nameof(data));

+

+            var format = await Task.Run(() =>

+            {

+                try

+                {

+                    using var image = Image.Load(data, out IImageFormat format);

+                    if (requestType != null && !format.MimeTypes.Contains(requestType))

+                        throw new ImageException(ImageException.ErrorReason.UnmatchedFormat, data, requestType, format.DefaultMimeType);

+                    if (square && image.Width != image.Height)

+                        throw new ImageException(ImageException.ErrorReason.NotSquare, data, requestType, format.DefaultMimeType);

+                    return format;

+                }

+                catch (UnknownImageFormatException e)

+                {

+                    throw new ImageException(ImageException.ErrorReason.CantDecode, data, requestType, null, null, e);

+                }

+            });

+            return format;

+        }

+    }

+}

diff --git a/BackEnd/Timeline/Services/Imaging/Resource.Designer.cs b/BackEnd/Timeline/Services/Imaging/Resource.Designer.cs
new file mode 100644
index 00000000..e9218208
--- /dev/null
+++ b/BackEnd/Timeline/Services/Imaging/Resource.Designer.cs
@@ -0,0 +1,108 @@
+//------------------------------------------------------------------------------

+// <auto-generated>

+//     This code was generated by a tool.

+//     Runtime Version:4.0.30319.42000

+//

+//     Changes to this file may cause incorrect behavior and will be lost if

+//     the code is regenerated.

+// </auto-generated>

+//------------------------------------------------------------------------------

+

+namespace Timeline.Services.Imaging {

+    using System;

+    

+    

+    /// <summary>

+    ///   A strongly-typed resource class, for looking up localized strings, etc.

+    /// </summary>

+    // This class was auto-generated by the StronglyTypedResourceBuilder

+    // class via a tool like ResGen or Visual Studio.

+    // To add or remove a member, edit your .ResX file then rerun ResGen

+    // with the /str option, or rebuild your VS project.

+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")]

+    [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]

+    [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]

+    internal class Resource {

+        

+        private static global::System.Resources.ResourceManager resourceMan;

+        

+        private static global::System.Globalization.CultureInfo resourceCulture;

+        

+        [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]

+        internal Resource() {

+        }

+        

+        /// <summary>

+        ///   Returns the cached ResourceManager instance used by this class.

+        /// </summary>

+        [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]

+        internal static global::System.Resources.ResourceManager ResourceManager {

+            get {

+                if (object.ReferenceEquals(resourceMan, null)) {

+                    global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Services.Imaging.Resource", typeof(Resource).Assembly);

+                    resourceMan = temp;

+                }

+                return resourceMan;

+            }

+        }

+        

+        /// <summary>

+        ///   Overrides the current thread's CurrentUICulture property for all

+        ///   resource lookups using this strongly typed resource class.

+        /// </summary>

+        [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]

+        internal static global::System.Globalization.CultureInfo Culture {

+            get {

+                return resourceCulture;

+            }

+            set {

+                resourceCulture = value;

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to Image is in valid because {0}..

+        /// </summary>

+        internal static string ExceptionImage {

+            get {

+                return ResourceManager.GetString("ExceptionImage", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to image is not of required size.

+        /// </summary>

+        internal static string ExceptionImageReasonBadSize {

+            get {

+                return ResourceManager.GetString("ExceptionImageReasonBadSize", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to failed to decode image, see inner exception.

+        /// </summary>

+        internal static string ExceptionImageReasonCantDecode {

+            get {

+                return ResourceManager.GetString("ExceptionImageReasonCantDecode", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to unknown error.

+        /// </summary>

+        internal static string ExceptionImageReasonUnknownError {

+            get {

+                return ResourceManager.GetString("ExceptionImageReasonUnknownError", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to image&apos;s actual mime type is not the specified one.

+        /// </summary>

+        internal static string ExceptionImageReasonUnmatchedFormat {

+            get {

+                return ResourceManager.GetString("ExceptionImageReasonUnmatchedFormat", resourceCulture);

+            }

+        }

+    }

+}

diff --git a/BackEnd/Timeline/Services/Imaging/Resource.resx b/BackEnd/Timeline/Services/Imaging/Resource.resx
new file mode 100644
index 00000000..060e2a91
--- /dev/null
+++ b/BackEnd/Timeline/Services/Imaging/Resource.resx
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>

+<root>

+  <!-- 

+    Microsoft ResX Schema 

+    

+    Version 2.0

+    

+    The primary goals of this format is to allow a simple XML format 

+    that is mostly human readable. The generation and parsing of the 

+    various data types are done through the TypeConverter classes 

+    associated with the data types.

+    

+    Example:

+    

+    ... ado.net/XML headers & schema ...

+    <resheader name="resmimetype">text/microsoft-resx</resheader>

+    <resheader name="version">2.0</resheader>

+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>

+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>

+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>

+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>

+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">

+        <value>[base64 mime encoded serialized .NET Framework object]</value>

+    </data>

+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">

+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>

+        <comment>This is a comment</comment>

+    </data>

+                

+    There are any number of "resheader" rows that contain simple 

+    name/value pairs.

+    

+    Each data row contains a name, and value. The row also contains a 

+    type or mimetype. Type corresponds to a .NET class that support 

+    text/value conversion through the TypeConverter architecture. 

+    Classes that don't support this are serialized and stored with the 

+    mimetype set.

+    

+    The mimetype is used for serialized objects, and tells the 

+    ResXResourceReader how to depersist the object. This is currently not 

+    extensible. For a given mimetype the value must be set accordingly:

+    

+    Note - application/x-microsoft.net.object.binary.base64 is the format 

+    that the ResXResourceWriter will generate, however the reader can 

+    read any of the formats listed below.

+    

+    mimetype: application/x-microsoft.net.object.binary.base64

+    value   : The object must be serialized with 

+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter

+            : and then encoded with base64 encoding.

+    

+    mimetype: application/x-microsoft.net.object.soap.base64

+    value   : The object must be serialized with 

+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter

+            : and then encoded with base64 encoding.

+

+    mimetype: application/x-microsoft.net.object.bytearray.base64

+    value   : The object must be serialized into a byte array 

+            : using a System.ComponentModel.TypeConverter

+            : and then encoded with base64 encoding.

+    -->

+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />

+    <xsd:element name="root" msdata:IsDataSet="true">

+      <xsd:complexType>

+        <xsd:choice maxOccurs="unbounded">

+          <xsd:element name="metadata">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" />

+              </xsd:sequence>

+              <xsd:attribute name="name" use="required" type="xsd:string" />

+              <xsd:attribute name="type" type="xsd:string" />

+              <xsd:attribute name="mimetype" type="xsd:string" />

+              <xsd:attribute ref="xml:space" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="assembly">

+            <xsd:complexType>

+              <xsd:attribute name="alias" type="xsd:string" />

+              <xsd:attribute name="name" type="xsd:string" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="data">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />

+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />

+              </xsd:sequence>

+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />

+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />

+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />

+              <xsd:attribute ref="xml:space" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="resheader">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />

+              </xsd:sequence>

+              <xsd:attribute name="name" type="xsd:string" use="required" />

+            </xsd:complexType>

+          </xsd:element>

+        </xsd:choice>

+      </xsd:complexType>

+    </xsd:element>

+  </xsd:schema>

+  <resheader name="resmimetype">

+    <value>text/microsoft-resx</value>

+  </resheader>

+  <resheader name="version">

+    <value>2.0</value>

+  </resheader>

+  <resheader name="reader">

+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>

+  </resheader>

+  <resheader name="writer">

+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>

+  </resheader>

+  <data name="ExceptionImage" xml:space="preserve">

+    <value>Image is in valid because {0}.</value>

+  </data>

+  <data name="ExceptionImageReasonBadSize" xml:space="preserve">

+    <value>image is not of required size</value>

+  </data>

+  <data name="ExceptionImageReasonCantDecode" xml:space="preserve">

+    <value>failed to decode image, see inner exception</value>

+  </data>

+  <data name="ExceptionImageReasonUnknownError" xml:space="preserve">

+    <value>unknown error</value>

+  </data>

+  <data name="ExceptionImageReasonUnmatchedFormat" xml:space="preserve">

+    <value>image's actual mime type is not the specified one</value>

+  </data>

+</root>
\ No newline at end of file