Browse Source

Dual license integration (#545)

* Added library license validation check with a detailed description

* Improved license-related message

* Adjusted license information

* Updated nuget license

* Improved grammar

* License message: added link to license configuration

* Fixed build
Marcin Ziąbek 2 years ago
parent
commit
4d1db6b76e

+ 15 - 0
Source/QuestPDF.Examples/LicenseSetup.cs

@@ -0,0 +1,15 @@
+using NUnit.Framework;
+using QuestPDF.Infrastructure;
+
+namespace QuestPDF.Examples
+{
+    [SetUpFixture]
+    public class LicenseSetup
+    {
+        [OneTimeSetUp]
+        public static void Setup()
+        {
+            QuestPDF.Settings.License = LicenseType.Community;
+        }
+    }
+}

+ 2 - 0
Source/QuestPDF.ReportSample/Tests.cs

@@ -17,6 +17,8 @@ namespace QuestPDF.ReportSample
         [SetUp]
         public void SetUp()
         {
+            QuestPDF.Settings.License = LicenseType.Community;
+            
             var model = DataSource.GetReport();
             Report = new StandardReport(model);
         }

+ 34 - 1
Source/QuestPDF/Drawing/DocumentGenerator.cs

@@ -17,6 +17,7 @@ namespace QuestPDF.Drawing
     {
         internal static void GeneratePdf(Stream stream, IDocument document)
         {
+            ValidateLicense();
             CheckIfStreamIsCompatible(stream);
             
             var metadata = document.GetMetadata();
@@ -26,6 +27,7 @@ namespace QuestPDF.Drawing
         
         internal static void GenerateXps(Stream stream, IDocument document)
         {
+            ValidateLicense();
             CheckIfStreamIsCompatible(stream);
             
             var metadata = document.GetMetadata();
@@ -44,6 +46,8 @@ namespace QuestPDF.Drawing
         
         internal static ICollection<byte[]> GenerateImages(IDocument document)
         {
+            ValidateLicense();
+            
             var metadata = document.GetMetadata();
             var canvas = new ImageCanvas(metadata);
             RenderDocument(canvas, document);
@@ -51,6 +55,35 @@ namespace QuestPDF.Drawing
             return canvas.Images;
         }
 
+        private static void ValidateLicense()
+        {
+            if (Settings.License.HasValue)
+                return;
+            
+            var newParagraph = Environment.NewLine + Environment.NewLine;
+
+            var exceptionMessage = 
+                $"QuestPDF is a modern open-source library. " +
+                $"We identify the importance of the library in your projects and therefore want to make sure you can safely and confidently continue the development. " +
+                $"Being a healthy and growing community is the primary goal that motivates us to pursue professionalism. {newParagraph}" +
+                $"We love and highly appreciate the .NET Community, and therefore the vast majority of users are welcome to use the library completely for free under the QuestPDF Community MIT license. {newParagraph}" +
+                $"However, if you are consuming the QuestPDF library as a Direct Package Dependency for usage in a Closed Source software in the capacity of a for-profit company/individual with more than 1M USD annual gross revenue, you must purchase the QuestPDF Professional or Enterprise License, depending on the number of software developers. {newParagraph}" +
+                $"If you still want to support library development, please consider purchasing the Professional License. {newParagraph}" +
+                $"For evaluation purposes, feel free to use the QuestPDF Community License in a non-production environment. {newParagraph}" +
+                $"Please refer to the QuestPDF License and Pricing webpage for more details. (https://www.questpdf.com/pricing.html) {newParagraph}" +
+                $"If you are an existing QuestPDF user and for any reason cannot update, you can stay with the 2022.12.X release with the extended quality support but without any new features, improvements, or optimizations. That release will always be available under the MIT license, free for commercial usage. {newParagraph}" +
+                $"The library does not require any license key. " +
+                $"We trust our users, and therefore the process is simple. " +
+                $"To disable license validation and turn off this exception, please configure an eligible license using the QuestPDF.Settings.License API, for example: {newParagraph}" +
+                $"\"QuestPDF.Settings.License = LicenseType.Community;\". {newParagraph}" +
+                $"Learn more on: https://www.questpdf.com/license-configuration.html";
+            
+            throw new Exception(exceptionMessage)
+            {
+                HelpLink = "https://www.questpdf.com/pricing.html"
+            };
+        }
+
         internal static ICollection<PreviewerPicture> GeneratePreviewerPictures(IDocument document)
         {
             var canvas = new SkiaPictureCanvas();
@@ -221,4 +254,4 @@ namespace QuestPDF.Drawing
                 ApplyInheritedAndGlobalTexStyle(child, documentDefaultTextStyle);
         }
     }
-}
+}

+ 30 - 0
Source/QuestPDF/Infrastructure/LicenseType.cs

@@ -0,0 +1,30 @@
+namespace QuestPDF.Infrastructure
+{
+    public enum LicenseType
+    {
+        /// <summary>
+        /// <para>We love and highly appreciate the .NET Community and therefore the vast majority of users are welcome to use the library under the QuestPDF Community MIT License, without any limitations, even for commercial usage. Please kindly check if you are eligible to use this license.</para>
+        /// <para>License comparison: http://www.questpdf.com/pricing.html#license</para>
+        /// <para>License link: https://www.questpdf.com/license-community.html</para>
+        /// </summary>
+        Community,
+        
+        /// <summary>
+        /// <para>You must purchase the QuestPDF Professional license, if you are consuming the QuestPDF library as a Direct Package Dependency for usage in a Closed Source software in the capacity of a for-profit company/individual with more than 1M USD annual gross revenue, <c>and there are up to 10 developers</c>.</para>
+        /// <para>If the number of developers is more than 10, you must purchase the QuestPDF Enterprise license.</para>
+        /// <para>Before making a license purchase, please evaluate the library in a non-production environment.</para>
+        /// <para>License comparison: http://www.questpdf.com/pricing.html#license</para>
+        /// <para>License link: https://www.questpdf.com/license-commercial.html</para>
+        /// </summary>
+        Professional,
+        
+        /// <summary>
+        /// <para>You must purchase the QuestPDF Professional license, if you are consuming the QuestPDF library as a Direct Package Dependency for usage in a Closed Source software in the capacity of a for-profit company/individual with more than 1M USD annual gross revenue.</para>
+        /// <para>If there are less than 10 developers, you are eligible to use the cheaper QuestPDF Professional License.</para>
+        /// <para>Before making a license purchase, please evaluate the library in a non-production environment.</para>
+        /// <para>License comparison: http://www.questpdf.com/pricing.html#license</para>
+        /// <para>License link: https://www.questpdf.com/license-commercial.html</para>
+        /// </summary>
+        Enterprise
+    }
+}

+ 39 - 27
Source/QuestPDF/QuestPDF.csproj

@@ -3,7 +3,7 @@
         <Authors>MarcinZiabek</Authors>
         <Company>CodeFlint</Company>
         <PackageId>QuestPDF</PackageId>
-        <Version>2022.12.5</Version>
+        <Version>2023.4.0</Version>
         <PackageDescription>QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API. Easily generate PDF reports, invoices, exports, etc.</PackageDescription>
         <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/Resources/ReleaseNotes.txt"))</PackageReleaseNotes>
         <LangVersion>9</LangVersion>
@@ -12,11 +12,12 @@
         <PackageIconUrl>https://www.questpdf.com/images/package-logo.png</PackageIconUrl>
         <PackageProjectUrl>https://www.questpdf.com/</PackageProjectUrl>
         <PackageReadmeFile>PackageReadme.md</PackageReadmeFile>
+        <PackageLicenseFile>PackageLicense.md</PackageLicenseFile>
+        <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
         <RepositoryUrl>https://github.com/QuestPDF/library.git</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <Copyright>Marcin Ziąbek, QuestPDF contributors</Copyright>
         <PackageTags>pdf report file export generate generation tool create creation render portable document format quest html library converter open source free standard core</PackageTags>
-        <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <Nullable>enable</Nullable>
         <TargetFrameworks>net462;netstandard2.0;netcoreapp2.0;netcoreapp3.0;net6.0</TargetFrameworks>
         <IncludeSymbols>true</IncludeSymbols>
@@ -37,32 +38,43 @@
     </ItemGroup>
 
     <ItemGroup>
-      <EmbeddedResource Include="Resources\ImagePlaceholder.png" />
-      <EmbeddedResource Include="Resources\Logo.png" />
-      <None Remove="ImagePlaceholder.png" />
+        <None Include="Resources\PackageReadme.md" Pack="true" PackagePath="\" />
+        <None Include="Resources\PackageLicense.md" Pack="true" PackagePath="\" />
+
+        <None Include="Resources\Logo.png" Pack="true" PackagePath="\" />
+        <EmbeddedResource Include="Resources\Logo.png" />
+        
+        <None Remove="ImagePlaceholder.png" />
+        <EmbeddedResource Include="Resources\ImagePlaceholder.png" />
+        
+        <None Remove="Resources\DefaultFont\Lato-Black.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Black.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-BlackItalic.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-BlackItalic.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-Bold.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Bold.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-BoldItalic.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-BoldItalic.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-Italic.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Italic.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-Light.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Light.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-LightItalic.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-LightItalic.ttf" />
+        
+        <None Remove="Resources\DefaultFont\Lato-Regular.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Regular.ttf" />
         
-      <None Include="Resources\Logo.png" Pack="true" PackagePath="\" />
-      <None Include="Resources\PackageReadme.md" Pack="true" PackagePath="\" />
+        <None Remove="Resources\DefaultFont\Lato-Thin.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-Thin.ttf" />
         
-      <None Remove="Resources\DefaultFont\Lato-Black.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Black.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-BlackItalic.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-BlackItalic.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-Bold.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Bold.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-BoldItalic.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-BoldItalic.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-Italic.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Italic.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-Light.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Light.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-LightItalic.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-LightItalic.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-Regular.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Regular.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-Thin.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-Thin.ttf" />
-      <None Remove="Resources\DefaultFont\Lato-ThinItalic.ttf" />
-      <EmbeddedResource Include="Resources\DefaultFont\Lato-ThinItalic.ttf" />
+        <None Remove="Resources\DefaultFont\Lato-ThinItalic.ttf" />
+        <EmbeddedResource Include="Resources\DefaultFont\Lato-ThinItalic.ttf" />
     </ItemGroup>
 </Project>

+ 59 - 0
Source/QuestPDF/Resources/PackageLicense.md

@@ -0,0 +1,59 @@
+# QuestPDF License
+
+## What license do you need?
+
+If you are consuming the QuestPDF library as a Direct Package Dependency for usage in a Closed Source software in the capacity of a for-profit company/individual with more than 1M USD annual gross revenue, you must purchase the QuestPDF Professional or Enterprise License, depending on number of software developers.
+
+We love and highly appreciate the .NET Community and therefore the vast majority of users are welcome to use the library completely for free. If you do not meet the criteria described above, you are eligible to use the QuestPDF Community MIT License, without any limitations, even for commercial usage.
+
+If you still want to support library development, please consider purchasing the Professional License.
+
+All details regarding the QuestPDF license can be found on the [official webpage](https://www.questpdf.com/pricing.html). 
+
+Being a healthy and growing community is our primary goal that motivates us to pursue professionalism. Thank you!
+
+
+## QuestPDF Community MIT License
+
+### License Permissions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+### Copyright
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+### Limitation Of Liability
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+## QuestPDF Professional and Enterprise Use License
+
+### Do No Harm
+
+By downloading or using the Software, the Licensee agrees not to utilize the software in a manner which is disparaging to QuestPDF, and not to rent, lease or otherwise transfer rights to the Software.
+
+### License Permissions
+
+Grants the use of the Software by a specified number of developers to create and deploy closed-source software for unlimited end user organizations ("The Organization") in multiple locations. This license covers unlimited applications or projects. The Software may be deployed upon any number of machines for the end-use of The Organization. This license also intrinsically covers for development, staging and production servers for each project.
+
+Grants the right to distribute the Software (without royalty) as part of packaged commercial products.
+
+### License Fees
+
+A. If you wish to use the Software in a production environment, you may download and use the Software for one year upon payment of the appropriate license fee as indicated on the pricing page in accordance with the terms and conditions of this Agreement.
+
+B. If you wish to use the Software in a non-production environment, you may download and access the source and/or binaries at no charge solely for testing and evaluation purposes and in accordance with all license limitations and restrictions set forth in this Agreement.
+
+### Ownership
+
+QuestPDF shall at all times retain ownership of the QuestPDF Software library and all subsequent copies.
+
+### Copyright
+
+Title, ownership rights, and intellectual property rights in and to the Software shall remain with QuestPDF. The Software is protected by the international copyright laws. Title, ownership rights, and intellectual property rights in and to the content accessed through the Software is the property of the applicable content owner and may be protected by applicable copyright or other law. This License gives you no rights to such content.
+
+### Limitation Of Liability
+
+THIS SOFTWARE IS PROVIDED "AS IS," WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. QUESTPDF AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL QUESTPDF OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF QUESTPDF HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

+ 9 - 1
Source/QuestPDF/Settings.cs

@@ -1,7 +1,15 @@
-namespace QuestPDF
+using QuestPDF.Infrastructure;
+
+namespace QuestPDF
 {
     public static class Settings
     {
+        /// <summary>
+        /// <para>Please kindly select license type that applies to your usage of the QuestPDF library.</para>
+        /// <para>For more details, please check the QuestPDF License and Pricing page: https://www.questpdf.com/pricing.html</para>
+        /// </summary>
+        public static LicenseType? License { get; set; }
+        
         /// <summary>
         /// This value represents the maximum number of pages that the library produces.
         /// This is useful when layout constraints are too strong, e.g. one element does not fit in another.