Merge branch 'master' into support_base64_linux

Shane32 · web-flow · commit e61e4bf0a47a · 2024-04-24T18:37:05.000-04:00
diff --git a/QRCoder/PayloadGenerator.cs b/QRCoder/PayloadGenerator.cs
@@ -1877,6 +1877,20 @@ public class CalendarEvent : Payload
             private readonly string subject, description, location, start, end;
             private readonly EventEncoding encoding;
 
+            /// <summary>
+            /// Generates a calender entry/event payload.
+            /// </summary>
+            /// <param name="subject">Subject/title of the calender event</param>
+            /// <param name="description">Description of the event</param>
+            /// <param name="location">Location (lat:long or address) of the event</param>
+            /// <param name="start">Start time (incl. UTC offset) of the event</param>
+            /// <param name="end">End time (incl. UTC offset) of the event</param>
+            /// <param name="allDayEvent">Is it a full day event?</param>
+            /// <param name="encoding">Type of encoding (universal or iCal)</param>
+            public CalendarEvent(string subject, string description, string location, DateTimeOffset start, DateTimeOffset end, bool allDayEvent, EventEncoding encoding = EventEncoding.Universal) : this(subject, description, location, start.UtcDateTime, end.UtcDateTime, allDayEvent, encoding)
+            {
+            }
+
             /// <summary>
             /// Generates a calender entry/event payload.
             /// </summary>
@@ -1893,9 +1907,17 @@ public CalendarEvent(string subject, string description, string location, DateTi
                 this.description = description;
                 this.location = location;
                 this.encoding = encoding;
-                string dtFormat = allDayEvent ? "yyyyMMdd" : "yyyyMMddTHHmmss";
-                this.start = start.ToString(dtFormat);
-                this.end = end.ToString(dtFormat);
+                string dtFormatStart = "yyyyMMdd", dtFormatEnd = "yyyyMMdd";
+                if (!allDayEvent)
+                {
+                    dtFormatStart = dtFormatEnd = "yyyyMMddTHHmmss";
+                    if (start.Kind == DateTimeKind.Utc)
+                        dtFormatStart = "yyyyMMddTHHmmssZ";
+                    if (end.Kind == DateTimeKind.Utc)
+                        dtFormatEnd = "yyyyMMddTHHmmssZ";
+                }                
+                this.start = start.ToString(dtFormatStart);
+                this.end = end.ToString(dtFormatEnd);
             }
 
             public override string ToString()
@@ -2512,6 +2534,13 @@ public override string ToString()
 
             public byte[] ToBytes()
             {
+                //Setup byte encoder
+                //Encode return string as byte[] with correct CharacterSet
+#if !NET35_OR_GREATER
+                Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
+#endif
+                var cp = this.characterSet.ToString().Replace("_", "-");
+
                 //Calculate the seperator
                 separator = DetermineSeparator();
 
@@ -2523,21 +2552,19 @@ public byte[] ToBytes()
                     $"{separator}BIC={mFields.BIC}" +
                     $"{separator}CorrespAcc={mFields.CorrespAcc}";
 
+                //Check length of mandatory field block (-8 => Removing service data block bytes from ret length)
+                int bytesMandatoryLen = Encoding.Convert(Encoding.UTF8, Encoding.GetEncoding(cp), Encoding.UTF8.GetBytes(ret)).Length - 8;
+                if (bytesMandatoryLen > 300)
+                    throw new RussiaPaymentOrderException($"Data too long. Mandatory data must not exceed 300 bytes, but actually is {bytesMandatoryLen} bytes long. Remove additional data fields or shorten strings/values.");
+
+
                 //Add optional fields, if filled
                 var optionalFieldsList = GetOptionalFieldsAsList();
                 if (optionalFieldsList.Count > 0)
                     ret += $"|{string.Join("|", optionalFieldsList.ToArray())}";
                 ret += separator;
 
-                //Encode return string as byte[] with correct CharacterSet
-#if !NET35_OR_GREATER
-                Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
-#endif
-                var cp = this.characterSet.ToString().Replace("_", "-");
-                byte[] bytesOut = Encoding.Convert(Encoding.UTF8, Encoding.GetEncoding(cp), Encoding.UTF8.GetBytes(ret));
-                if (bytesOut.Length > 300)
-                    throw new RussiaPaymentOrderException($"Data too long. Payload must not exceed 300 bytes, but actually is {bytesOut.Length} bytes long. Remove additional data fields or shorten strings/values.");
-                return bytesOut;
+                return Encoding.Convert(Encoding.UTF8, Encoding.GetEncoding(cp), Encoding.UTF8.GetBytes(ret));
             }
 
 
diff --git a/QRCoder/SvgQRCode.cs b/QRCoder/SvgQRCode.cs
@@ -126,7 +126,7 @@ public string GetGraphic(Size viewBox, string darkColorHex, string lightColorHex
                 for (int xi = 0; xi < drawableModulesCount; xi += 1)
                 {
                     matrix[yi, xi] = 0;
-                    if (bitArray[xi+offset] && (logo == null || !logo.FillLogoBackground() || !IsBlockedByLogo((xi+offset)*pixelsPerModule, (yi+offset) * pixelsPerModule, logoAttr, pixelsPerModule)))
+                    if (bitArray[xi+offset] && (logo == null || !logo.FillLogoBackground() || !IsBlockedByLogo(xi * pixelsPerModule, yi * pixelsPerModule, logoAttr, pixelsPerModule)))
                     {
                         if(x0 == -1)
                         {
diff --git a/QRCoderTests/PayloadGeneratorTests.cs b/QRCoderTests/PayloadGeneratorTests.cs
@@ -816,7 +816,7 @@ public void calendarevent_should_build_universal()
             var location = "Programmer's paradise, Beachtown, Paradise";
             var alldayEvent = false;
             var begin = new DateTime(2016, 01, 03, 12, 00, 00);
-            var end = new DateTime(2016, 01, 03, 14, 30, 0);
+            var end = new DateTime(2016, 01, 03, 14, 30, 00);
             var encoding = PayloadGenerator.CalendarEvent.EventEncoding.Universal;
 
             var generator = new PayloadGenerator.CalendarEvent(subject, description, location, begin, end, alldayEvent, encoding);
@@ -843,6 +843,42 @@ public void calendarevent_should_build_ical()
         }
 
 
+        [Fact]
+        [Category("PayloadGenerator/CalendarEvent")]
+        public void calendarevent_should_build_with_utc_datetime()
+        {
+            var subject = "Release party";
+            var description = "A small party for the new QRCoder. Bring some beer!";
+            var location = "Programmer's paradise, Beachtown, Paradise";
+            var alldayEvent = false;
+            var begin = new DateTime(2016, 01, 03, 12, 00, 00, DateTimeKind.Utc);
+            var end = new DateTime(2016, 01, 03, 14, 30, 00, DateTimeKind.Utc);
+            var encoding = PayloadGenerator.CalendarEvent.EventEncoding.Universal;
+
+            var generator = new PayloadGenerator.CalendarEvent(subject, description, location, begin, end, alldayEvent, encoding);
+
+            generator.ToString().ShouldBe($"BEGIN:VEVENT{Environment.NewLine}SUMMARY:Release party{Environment.NewLine}DESCRIPTION:A small party for the new QRCoder. Bring some beer!{Environment.NewLine}LOCATION:Programmer's paradise, Beachtown, Paradise{Environment.NewLine}DTSTART:20160103T120000Z{Environment.NewLine}DTEND:20160103T143000Z{Environment.NewLine}END:VEVENT");
+        }
+
+
+        [Fact]
+        [Category("PayloadGenerator/CalendarEvent")]
+        public void calendarevent_should_build_with_utc_offset()
+        {
+            var subject = "Release party";
+            var description = "A small party for the new QRCoder. Bring some beer!";
+            var location = "Programmer's paradise, Beachtown, Paradise";
+            var alldayEvent = false;
+            var begin = new DateTimeOffset(2016, 01, 03, 12, 00, 00, new TimeSpan(3, 0, 0));
+            var end = new DateTimeOffset(2016, 01, 03, 14, 30, 00, new TimeSpan(3, 0, 0));
+            var encoding = PayloadGenerator.CalendarEvent.EventEncoding.Universal;
+
+            var generator = new PayloadGenerator.CalendarEvent(subject, description, location, begin, end, alldayEvent, encoding);
+
+            generator.ToString().ShouldBe($"BEGIN:VEVENT{Environment.NewLine}SUMMARY:Release party{Environment.NewLine}DESCRIPTION:A small party for the new QRCoder. Bring some beer!{Environment.NewLine}LOCATION:Programmer's paradise, Beachtown, Paradise{Environment.NewLine}DTSTART:20160103T090000Z{Environment.NewLine}DTEND:20160103T113000Z{Environment.NewLine}END:VEVENT");
+        }
+
+
         [Fact]
         [Category("PayloadGenerator/CalendarEvent")]
         public void calendarevent_should_build_allday()
@@ -3280,24 +3316,44 @@ public void russiapayment_generator_should_throw_no_separator_exception()
         [Fact]
         [Category("PayloadGenerator/RussiaPaymentOrder")]
         public void russiapayment_generator_should_throw_data_too_long_exception()
+        {
+            var account = "40702810138250123017";
+            var bic = "044525225";
+            var bankName = "A very very very very very long bank name";
+            // We use € symbol for the test case, because it needs 2-bytes. Otherwise we couldn't generate more than 300 bytes
+            // of mandatory data to trigger the test case and stay at the same time within the 160 chars field validation limit
+            var name = "A very €€€€ €€€€ €€€€ €€€€ very very very very very very very very very very very very very very very very very very very very very very very very ver long name";
+            var correspAcc = "30101810400000000225";
+            var generator = new PayloadGenerator.RussiaPaymentOrder(name, account, bankName, bic, correspAcc);
+
+            var exception = Record.Exception(() => generator.ToString());
+            Assert.NotNull(exception);
+            Assert.IsType<PayloadGenerator.RussiaPaymentOrder.RussiaPaymentOrderException>(exception);
+            exception.Message.ShouldStartWith("Data too long");
+        }
+
+        [Fact]
+        [Category("PayloadGenerator/RussiaPaymentOrder")]
+        public void russiapayment_generator_should_throw_no_data_too_long_exception()
         {
             var account = "40702810138250123017";
             var bic = "044525225";
             var bankName = "ОАО | \"БАНК\"";
-            var name = "A very very very very very very very very very very very very very very very very very very very very very very very very very very very very very long name";
+            var name = "A name";
             var correspAcc = "30101810400000000225";
             var optionalFields = new PayloadGenerator.RussiaPaymentOrder.OptionalFields()
             {
                 FirstName = "Another long long long long long long long long long long long long long long firstname",
                 LastName = "Another long long long long long long long long long long long long long long lastname",
+                Category = "A pretty long long long long long long long long long long long long long category",
                 Sum = "125000"
             };
             var generator = new PayloadGenerator.RussiaPaymentOrder(name, account, bankName, bic, correspAcc, optionalFields);
 
+            // Should throw no exception as the 300 byte limit applies only to the mandatory fields
+            // See https://github.com/codebude/QRCoder/issues/392
             var exception = Record.Exception(() => generator.ToString());
-            Assert.NotNull(exception);
-            Assert.IsType<PayloadGenerator.RussiaPaymentOrder.RussiaPaymentOrderException>(exception);
-            exception.Message.ShouldStartWith("Data too long");
+            Assert.Null(exception);
         }
 
         [Fact]
diff --git a/QRCoderTests/SvgQRCodeRendererTests.cs b/QRCoderTests/SvgQRCodeRendererTests.cs
@@ -15,16 +15,6 @@ namespace QRCoderTests
     public class SvgQRCodeRendererTests
     {
 
-        private string GetAssemblyPath()
-        {
-            return
-#if NET5_0
-                AppDomain.CurrentDomain.BaseDirectory;
-#else
-                Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().CodeBase).Replace("file:\\", "");
-#endif
-        }
-
         [Fact]
         [Category("QRRenderer/SvgQRCode")]
         public void can_render_svg_qrcode_simple()
@@ -113,7 +103,7 @@ public void can_render_svg_qrcode_with_png_logo_bitmap()
             var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
 
             //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909346
-            var logoBitmap = (Bitmap)Image.FromFile(GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
+            var logoBitmap = (Bitmap)Image.FromFile(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
             var logoObj = new SvgQRCode.SvgLogo(iconRasterized: logoBitmap, 15);
             logoObj.GetMediaType().ShouldBe<SvgQRCode.SvgLogo.MediaType>(SvgQRCode.SvgLogo.MediaType.PNG);
 
@@ -122,6 +112,44 @@ public void can_render_svg_qrcode_with_png_logo_bitmap()
             var result = HelperFunctions.StringToHash(svg);
             result.ShouldBe("78e02e8ba415f15817d5ed88c4afca31");
         }
+
+        [Fact]
+        [Category("QRRenderer/SvgQRCode")]
+        public void can_render_svg_qrcode_with_png_logo_bitmap_without_background()
+        {
+            //Create QR code
+            var gen = new QRCodeGenerator();
+            var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
+
+            //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909346
+            var logoBitmap = (Bitmap)Image.FromFile(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
+            var logoObj = new SvgQRCode.SvgLogo(iconRasterized: logoBitmap, 15, false);
+            logoObj.GetMediaType().ShouldBe<SvgQRCode.SvgLogo.MediaType>(SvgQRCode.SvgLogo.MediaType.PNG);
+
+            var svg = new SvgQRCode(data).GetGraphic(10, Color.DarkGray, Color.White, logo: logoObj);
+
+            var result = HelperFunctions.StringToHash(svg);
+            result.ShouldBe("f221b2baecc2883f8e8ae54f12ba701b");
+        }
+
+        [Fact]
+        [Category("QRRenderer/SvgQRCode")]
+        public void can_render_svg_qrcode_with_png_logo_bitmap_without_quietzones()
+        {
+            //Create QR code
+            var gen = new QRCodeGenerator();
+            var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
+
+            //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909346
+            var logoBitmap = (Bitmap)Image.FromFile(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
+            var logoObj = new SvgQRCode.SvgLogo(iconRasterized: logoBitmap, 15);
+            logoObj.GetMediaType().ShouldBe<SvgQRCode.SvgLogo.MediaType>(SvgQRCode.SvgLogo.MediaType.PNG);
+
+            var svg = new SvgQRCode(data).GetGraphic(10, Color.Black, Color.White, drawQuietZones: false, logo: logoObj);
+
+            var result = HelperFunctions.StringToHash(svg);
+            result.ShouldBe("8b4d114136c7fd26e0b34e5a15daac3b");
+        }
 #endif
 
         [Fact]
@@ -133,7 +161,7 @@ public void can_render_svg_qrcode_with_png_logo_bytearray()
             var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
 
             //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909346
-            var logoBitmap = System.IO.File.ReadAllBytes(GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
+            var logoBitmap = System.IO.File.ReadAllBytes(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_software engineer_2909346.png");
             var logoObj = new SvgQRCode.SvgLogo(iconRasterized: logoBitmap, 15);
             logoObj.GetMediaType().ShouldBe<SvgQRCode.SvgLogo.MediaType>(SvgQRCode.SvgLogo.MediaType.PNG);
 
@@ -152,7 +180,7 @@ public void can_render_svg_qrcode_with_svg_logo_embedded()
             var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
 
             //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909361
-            var logoSvg = File.ReadAllText(GetAssemblyPath() + "\\assets\\noun_Scientist_2909361.svg");            
+            var logoSvg = File.ReadAllText(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_Scientist_2909361.svg");            
             var logoObj = new SvgQRCode.SvgLogo(logoSvg, 20);
             logoObj.GetMediaType().ShouldBe<SvgQRCode.SvgLogo.MediaType>(SvgQRCode.SvgLogo.MediaType.SVG);
 
@@ -171,7 +199,7 @@ public void can_render_svg_qrcode_with_svg_logo_image_tag()
             var data = gen.CreateQrCode("This is a quick test! 123#?", QRCodeGenerator.ECCLevel.H);
 
             //Used logo is licensed under public domain. Ref.: https://thenounproject.com/Iconathon1/collection/redefining-women/?i=2909361
-            var logoSvg = File.ReadAllText(GetAssemblyPath() + "\\assets\\noun_Scientist_2909361.svg");
+            var logoSvg = File.ReadAllText(HelperFunctions.GetAssemblyPath() + "\\assets\\noun_Scientist_2909361.svg");
             var logoObj = new SvgQRCode.SvgLogo(logoSvg, 20, iconEmbedded: false);
 
             var svg = new SvgQRCode(data).GetGraphic(10, Color.DarkGray, Color.White, logo: logoObj);
diff --git a/readme.md b/readme.md
@@ -35,12 +35,12 @@ PM> Install-Package QRCoder
 
 #### CI builds
 The NuGet feed contains only **major/stable** releases. If you want the latest functions and features, you can use the CI builds [via Github packages](https://github.com/codebude/qrcoder/packages).
-_(More information on how to use Github Packages in Nuget Package Manager can be [found here](http://webcache.googleusercontent.com/search?q=cache:i_gL6oIwpr8J:www.catiawidgets.net/2021/04/20/creating-github-packages-and-accessing-them-in-nuget/+&cd=1&hl=de&ct=clnk&gl=de).)_
+_(More information on how to use Github Packages in Nuget Package Manager can be [found here](https://samlearnsazure.blog/2021/08/08/consuming-a-nuget-package-from-github-packages/).)_
 
 
 ## Usage
 
-You only need four lines of code, to generate and view your first QR code.
+You only need a couple lines of code, to generate your first QR code.
 
 ```csharp
 QRCodeGenerator qrGenerator = new QRCodeGenerator();
@@ -49,29 +49,11 @@ QRCode qrCode = new PngByteQRCode(qrCodeData);
 byte[] qrCodeImage = qrCode.GetGraphic(20);
 ```
 
-### Optional parameters and overloads
-
-The GetGraphics-method has some more overloads. The first two enable you to set the color of the QR code graphic. One uses Color-class-types, the other HTML hex color notation.
-
-```csharp
-//Set color by using Color-class types
-Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.DarkRed, Color.PaleGreen, true);
-
-//Set color by using HTML hex color notation
-Bitmap qrCodeImage = qrCode.GetGraphic(20, "#000ff0", "#0ff000");
-```
-
-The other overload enables you to render a logo/image in the center of the QR code.
-
-```csharp
-Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.Black, Color.White, (Bitmap)Bitmap.FromFile("C:\\myimage.png"));
-```
-
 There are a plenty of other options. So feel free to read more on that in our wiki: [Wiki: How to use QRCoder](https://github.com/codebude/QRCoder/wiki/How-to-use-QRCoder)
 
 ### Special rendering types
 
-Besides the normal QRCode class (which is shown in the example above) for creating QR codes in Bitmap format, there are some more QR code rendering classes, each for another special purpose.
+Besides the normal PngByteQRCode-class (which is shown in the example above) for creating QR codes in Bitmap format, there are some more QR code rendering classes, each for another special purpose.
 
 * [QRCode](https://github.com/codebude/QRCoder/wiki/Advanced-usage---QR-Code-renderers#21-qrcode-renderer-in-detail)
 * [ArtQRCode](https://github.com/codebude/QRCoder/wiki/Advanced-usage---QR-Code-renderers#211-artqrcode-renderer-in-detail)

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public string GetGraphic(Size viewBox, string darkColorHex, string lightColorHex`
`126`	`126`	`for (int xi = 0; xi < drawableModulesCount; xi += 1)`
`127`	`127`	`{`
`128`	`128`	`matrix[yi, xi] = 0;`
`129`		`- if (bitArray[xi+offset] && (logo == null \|\| !logo.FillLogoBackground() \|\| !IsBlockedByLogo((xi+offset)pixelsPerModule, (yi+offset) pixelsPerModule, logoAttr, pixelsPerModule)))`
	`129`	`+ if (bitArray[xi+offset] && (logo == null \|\| !logo.FillLogoBackground() \|\| !IsBlockedByLogo(xi * pixelsPerModule, yi * pixelsPerModule, logoAttr, pixelsPerModule)))`
`130`	`130`	`{`
`131`	`131`	`if(x0 == -1)`
`132`	`132`	`{`