Add envelope validation to BurnAnnotsToPDF function

Retrieve envelope by ID before burning annotations. Throw an exception if not found, and return the original PDF if the envelope is read-only. This adds validation and early exit logic before processing signatures and annotations.
Add ReadOnly property to Envelope class
2026-01-27 11:49:19 +01:00 · 2026-01-27 11:49:02 +01:00 · 2026-01-26 15:07:58 +01:00 · 2026-01-26 15:02:49 +01:00
5 changed files with 24 additions and 7 deletions
--- a/EnvelopeGenerator.BBTests/EnvelopeGenerator.BBTests.vbproj
+++ b/EnvelopeGenerator.BBTests/EnvelopeGenerator.BBTests.vbproj
@@ -109,9 +109,6 @@
    <Reference Include="EntityFramework.SqlServer, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL">
      <HintPath>..\packages\EntityFramework.6.5.1\lib\net45\EntityFramework.SqlServer.dll</HintPath>
    </Reference>
-    <Reference Include="EnvelopeGenerator.CommonServices">
-      <HintPath>..\EnvelopeGenerator.CommonServices\bin\Debug\EnvelopeGenerator.CommonServices.dll</HintPath>
-    </Reference>
    <Reference Include="FirebirdSql.Data.FirebirdClient, Version=7.5.0.0, Culture=neutral, PublicKeyToken=3750abcc3150b00c, processorArchitecture=MSIL">
      <HintPath>..\packages\FirebirdSql.Data.FirebirdClient.7.5.0\lib\net452\FirebirdSql.Data.FirebirdClient.dll</HintPath>
    </Reference>
@@ -466,8 +463,12 @@
      <Project>{6EA0C51F-C2B1-4462-8198-3DE0B32B74F8}</Project>
      <Name>EnvelopeGenerator.CommonServices</Name>
    </ProjectReference>
+    <ProjectReference Include="..\EnvelopeGenerator.CommonServices\EnvelopeGenerator.CommonServices.vbproj">
+      <Project>{6ea0c51f-c2b1-4462-8198-3de0b32b74f8}</Project>
+      <Name>EnvelopeGenerator.CommonServices</Name>
+    </ProjectReference>
    <ProjectReference Include="..\EnvelopeGenerator.Domain\EnvelopeGenerator.Domain.csproj">
-      <Project>{4F32A98D-E6F0-4A09-BD97-1CF26107E837}</Project>
+      <Project>{4f32a98d-e6f0-4a09-bd97-1cf26107e837}</Project>
      <Name>EnvelopeGenerator.Domain</Name>
    </ProjectReference>
    <ProjectReference Include="..\EnvelopeGenerator.Infrastructure\EnvelopeGenerator.Infrastructure.csproj">
@@ -495,6 +496,9 @@
    <Content Include="MailLicense.xml" />
    <Content Include="README.txt" />
  </ItemGroup>
+  <ItemGroup>
+    <WCFMetadata Include="Connected Services\" />
+  </ItemGroup>
  <Import Project="$(MSBuildToolsPath)\Microsoft.VisualBasic.targets" />
  <Import Project="..\packages\GdPicture.runtimes.windows.14.3.3\build\net462\GdPicture.runtimes.windows.targets" Condition="Exists('..\packages\GdPicture.runtimes.windows.14.3.3\build\net462\GdPicture.runtimes.windows.targets')" />
  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
--- a/EnvelopeGenerator.CommonServices/Jobs/FinalizeDocument/FinalizeDocumentJob.vb
+++ b/EnvelopeGenerator.CommonServices/Jobs/FinalizeDocument/FinalizeDocumentJob.vb
@@ -422,7 +422,7 @@ Namespace Jobs
        End Function

        Private Function GetEnvelopeData(pEnvelopeId As Integer) As EnvelopeData
-            Dim oSql = $"SELECT T.GUID, T.ENVELOPE_UUID,T2.FILEPATH, T2.BYTE_DATA FROM [dbo].[TBSIG_ENVELOPE] T
+            Dim oSql = $"SELECT T.GUID, T.ENVELOPE_UUID, T.ENVELOPE_TYPE, T2.FILEPATH, T2.BYTE_DATA FROM [dbo].[TBSIG_ENVELOPE] T
                JOIN TBSIG_ENVELOPE_DOCUMENT T2 ON T.GUID = T2.ENVELOPE_ID
                WHERE T.GUID = {pEnvelopeId}"
            Dim oTable As DataTable = Database.GetDatatable(oSql)
--- a/EnvelopeGenerator.CommonServices/Jobs/FinalizeDocument/PDFBurner.vb
+++ b/EnvelopeGenerator.CommonServices/Jobs/FinalizeDocument/PDFBurner.vb
@@ -37,6 +37,15 @@ Namespace Jobs.FinalizeDocument
        Public Function BurnAnnotsToPDF(pSourceBuffer As Byte(), pInstantJSONList As List(Of String), envelopeId As Integer) As Byte()
            'read the elements of envelope with their annotations
            Using scope = Factory.Shared.ScopeFactory.CreateScope()
+
+                Dim envRepo = scope.ServiceProvider.Repository(Of Envelope)()
+                Dim envelope = envRepo.Where(Function(env) env.Id = envelopeId).FirstOrDefault()
+                If envelope Is Nothing Then
+                    Throw New BurnAnnotationException($"Envelope with Id {envelopeId} not found.")
+                ElseIf envelope.ReadOnly Then
+                    Return pSourceBuffer
+                End If
+
                Dim sigRepo = scope.ServiceProvider.Repository(Of Signature)()
                Dim elements = sigRepo _
                    .Where(Function(sig) sig.Document.EnvelopeId = envelopeId) _
--- a/EnvelopeGenerator.Domain/Entities/Envelope.cs
+++ b/EnvelopeGenerator.Domain/Entities/Envelope.cs
@@ -108,6 +108,10 @@ public class Envelope
    [Column("ENVELOPE_TYPE")]
    public int? EnvelopeTypeId { get; set; }

+    [JsonIgnore]
+    [NotMapped]
+    public bool ReadOnly => EnvelopeTypeId == 2;
+    
    [Column("CERTIFICATION_TYPE")]
    public int? CertificationType { get; set; }

--- a/EnvelopeGenerator.sln
+++ b/EnvelopeGenerator.sln
@@ -49,8 +49,8 @@ Global
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Release|Any CPU.ActiveCfg = Debug|Any CPU
+		{089D5634-FB6B-42D0-B912-7AA7457044E7}.Release|Any CPU.Build.0 = Debug|Any CPU
 		{6EA0C51F-C2B1-4462-8198-3DE0B32B74F8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{6EA0C51F-C2B1-4462-8198-3DE0B32B74F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6EA0C51F-C2B1-4462-8198-3DE0B32B74F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
Author	SHA1	Message	Date
TekH	d350e2ae48	Add envelope validation to BurnAnnotsToPDF function Retrieve envelope by ID before burning annotations. Throw an exception if not found, and return the original PDF if the envelope is read-only. This adds validation and early exit logic before processing signatures and annotations.	2026-01-27 11:49:19 +01:00
TekH	2779452d72	Add ReadOnly property to Envelope class Added a ReadOnly property to the Envelope class that returns true when EnvelopeTypeId is 2. The property is marked with [JsonIgnore] and [NotMapped] to exclude it from JSON serialization and database mapping.	2026-01-27 11:49:02 +01:00
TekH	5ebc6c6739	Update SQL to include ENVELOPE_TYPE in envelope query The GetEnvelopeData function's SQL query now selects the ENVELOPE_TYPE column from the TBSIG_ENVELOPE table, allowing retrieval of envelope type information along with other envelope data.	2026-01-26 15:07:58 +01:00
TekH	891593755e	Remove DLL ref, update configs, add WCF metadata Removed EnvelopeGenerator.CommonServices DLL reference from BBTests project file, updated project GUIDs to lowercase, added WCFMetadata ItemGroup for connected services, and set BBTests Release config to use Debug in solution file.	2026-01-26 15:02:49 +01:00