big refactor, move most zugferd processing into Modules.Interfaces

Modules.Interfaces/ZUGFeRDInterface.vb

@@ -1,9 +1,11 @@
-Imports System.Xml
+Imports System.IO
+Imports System.Xml
 Imports System.Xml.Serialization
 Imports System.Xml.XPath
 Imports System.Xml.Xsl
 Imports DigitalData.Modules.Interfaces.Exceptions
 Imports DigitalData.Modules.Logging
+Imports GdPicture14
 
 Public Class ZUGFeRDInterface
     Private _logConfig As LogConfig
@@ -21,13 +23,23 @@ Public Class ZUGFeRDInterface
     Public ReadOnly Property FileGroup As FileGroups
     Public ReadOnly Property PropertyValues As PropertyValues
 
-    Public Sub New(LogConfig As LogConfig)
+    Public Sub New(LogConfig As LogConfig, GDPictureKey As String)
         _logConfig = LogConfig
         _logger = _logConfig.GetLogger()
+
         FileGroup = New FileGroups(_logConfig)
         PropertyValues = New PropertyValues(_logConfig)
+
+        Try
+            Dim oLicenseManager As New LicenseManager
+            oLicenseManager.RegisterKEY(GDPictureKey)
+        Catch ex As Exception
+            _logger.Warn("GDPicture License could not be registered!")
+            _logger.Error(ex)
+        End Try
     End Sub
 
+
     ''' <summary>
     ''' Validates a ZUGFeRD File and extracts the XML Document from it
     ''' </summary>
@@ -35,7 +47,6 @@ Public Class ZUGFeRDInterface
     ''' <exception cref="ZUGFeRDExecption"></exception>
     ''' <returns></returns>
     Public Function ExtractZUGFeRDFile(Path As String) As CrossIndustryDocumentType
-        Dim oException As New Exception
         Dim oXmlDocument = ValidateZUGFeRDFile(Path)
 
         If IsNothing(oXmlDocument) Then
@@ -45,6 +56,15 @@ Public Class ZUGFeRDInterface
         Return SerializeZUGFeRDDocument(oXmlDocument)
     End Function
 
+    Public Function ExtractZUGFeRDFileWithGDPicture(Path As String) As CrossIndustryDocumentType
+        Dim oXmlDocument = ValidateZUGFeRDFileWithGDPicture(Path)
+
+        If IsNothing(oXmlDocument) Then
+            Throw New ZUGFeRDExecption(ErrorType.NoZugferd, "Datei ist keine ZUGFeRD Datei.")
+        End If
+
+        Return SerializeZUGFeRDDocument(oXmlDocument)
+    End Function
 
     Public Function ValidateZUGFeRDFile(Path As String) As XPathDocument
         Dim oProcessOutput, oProcessError As String
@@ -90,6 +110,52 @@ Public Class ZUGFeRDInterface
         Return oXmlDocument
     End Function
 
+    Public Function ValidateZUGFeRDFileWithGDPicture(Path As String) As XPathDocument
+        Dim oAttachmentExtractor = New PDFAttachments(_logConfig)
+        Dim oAllowedExtensions = New List(Of String) From {"xml"}
+        Dim oXmlDocument As XPathDocument
+
+        Try
+            Dim oResults = oAttachmentExtractor.Extract(Path, oAllowedExtensions)
+
+            If oResults Is Nothing Then
+                Throw New ZUGFeRDExecption(ErrorType.NoZugferd, "Datei ist keine ZUGFeRD Datei.")
+            End If
+
+            If oResults.Count = 0 Then
+                Throw New ZUGFeRDExecption(ErrorType.NoZugferd, "Datei ist keine ZUGFeRD Datei.")
+            End If
+
+            Dim oFound As Boolean = False
+            Dim oFoundResult As PDFAttachments.AttachmentResult = Nothing
+
+            For Each oResult In oResults
+                If oResult.FileName = PDFAttachments.ZUGFERD_XML_FILENAME Then
+                    oFound = True
+                    oFoundResult = oResult
+                End If
+            Next
+
+            If Not oFound Then
+                Throw New ZUGFeRDExecption(ErrorType.NoZugferd, "Datei ist keine ZUGFeRD Datei.")
+            End If
+
+            Try
+                Using oStream As New MemoryStream(oFoundResult.FileContents)
+                    oXmlDocument = New XPathDocument(oStream)
+                End Using
+
+                Return oXmlDocument
+            Catch ex As Exception
+                _logger.Error(ex)
+                Throw ex
+            End Try
+        Catch ex As Exception
+            _logger.Error(ex)
+            Throw ex
+        End Try
+    End Function
+
     Public Function SerializeZUGFeRDDocument(Document As XPathDocument) As CrossIndustryDocumentType
         Try
             Dim oNavigator As XPathNavigator = Document.CreateNavigator()

Modules.Interfaces/ZUGFeRDInterface/PDFAttachments.vb

@@ -4,9 +4,9 @@ Imports DigitalData.Modules.Logging
 Imports GdPicture14
 
 Public Class PDFAttachments
-    Private Logger As Logger
+    Private ReadOnly Logger As Logger
 
-    Private Const ZUGFERD_XML_FILENAME = "ZUGFeRD-invoice.xml"
+    Public Const ZUGFERD_XML_FILENAME = "ZUGFeRD-invoice.xml"
 
     Public Class AttachmentResult
         Public FileName As String
@@ -17,61 +17,50 @@ Public Class PDFAttachments
         Logger = LogConfig.GetLogger
     End Sub
 
+    ''' <summary>
+    ''' Extracts all embedded files from a PDF file.
+    ''' Note: This does NOT filter out `ZUGFeRD-invoice.xml` anymore to allow for a more generic use.
+    ''' </summary>
+    ''' <param name="FileName"></param>
+    ''' <param name="AllowedExtensions"></param>
+    ''' <returns></returns>
     Public Function Extract(FileName As String, AllowedExtensions As List(Of String)) As List(Of AttachmentResult)
         Dim oResults As New List(Of AttachmentResult)
-        Dim oExtensions = AllowedExtensions.ConvertAll(Of String)(New Converter(Of String, String)(Function(ext) ext.ToUpper))
+        Dim oExtensions = AllowedExtensions.ConvertAll(New Converter(Of String, String)(Function(ext) ext.ToUpper))
 
         Try
             Using oGDPicturePDF As New GdPicturePDF()
                 If oGDPicturePDF.LoadFromFile(FileName, False) = GdPictureStatus.OK Then
                     Dim oEmbeddedFileCount As Integer = oGDPicturePDF.GetEmbeddedFileCount()
                     If oGDPicturePDF.GetStat() = GdPictureStatus.OK Then
-                        If oEmbeddedFileCount > 1 Then
+                        If oEmbeddedFileCount > 0 Then
                             For index = 0 To oEmbeddedFileCount - 1
                                 Dim oFileName As String = oGDPicturePDF.GetEmbeddedFileName(index)
 
                                 If oGDPicturePDF.GetStat() = GdPictureStatus.OK Then
                                     Dim oExtension = New FileInfo(oFileName).Extension.ToUpper.Substring(1)
-                                    If oFileName.ToUpper <> ZUGFERD_XML_FILENAME.ToUpper Then
-                                        If oExtensions.Contains(oExtension) Then
-                                            Dim FileSize As Integer = oGDPicturePDF.GetEmbeddedFileSize(index)
+                                    If oExtensions.Contains(oExtension) Then
+                                        Dim FileSize As Integer = oGDPicturePDF.GetEmbeddedFileSize(index)
 
-                                            If oGDPicturePDF.GetStat() = GdPictureStatus.OK Then
-                                                Dim oFileData As Byte() = New Byte(FileSize) {}
-                                                Dim status As GdPictureStatus = oGDPicturePDF.ExtractEmbeddedFile(index, oFileData)
+                                        If oGDPicturePDF.GetStat() = GdPictureStatus.OK Then
+                                            Dim oFileData As Byte() = New Byte(FileSize) {}
+                                            Dim status As GdPictureStatus = oGDPicturePDF.ExtractEmbeddedFile(index, oFileData)
 
-                                                If status = GdPictureStatus.OK Then
-                                                    oResults.Add(New AttachmentResult() With {
-                                                                    .FileContents = oFileData,
-                                                                    .FileName = oFileName
-                                                                 })
-                                                Else
-                                                    Logger.Error("The embedded file [{0}] has failed to extract. Status: {1}", oFileName, oGDPicturePDF.GetStat().ToString())
-                                                    Continue For
-                                                End If
-
-                                                'If status = GdPictureStatus.OK Then
-                                                '    Dim oVersionedName = Filesystem.GetVersionedFilename(oFileName)
-                                                '    Dim oTempName As String = Path.Combine(Path.GetTempPath(), oVersionedName)
-                                                '    Using oFileStream As New FileStream(oTempName, FileMode.OpenOrCreate)
-                                                '        oFileStream.Write(oFileData, 0, oFileData.Length)
-                                                '    End Using
-
-                                                '    oResults.Add(New FileInfo(oTempName))
-                                                'Else
-                                                '    Logger.Error("The embedded file [{0}] has failed to extract. Status: {1}", oFileName, oGDPicturePDF.GetStat().ToString())
-                                                '    Continue For
-                                                'End If
+                                            If status = GdPictureStatus.OK Then
+                                                oResults.Add(New AttachmentResult() With {
+                                                                .FileContents = oFileData,
+                                                                .FileName = oFileName
+                                                             })
                                             Else
-                                                Logger.Error("An error occurred getting the file size for [{0}]. Status: {1}", oFileName, oGDPicturePDF.GetStat().ToString())
+                                                Logger.Error("The embedded file [{0}] has failed to extract. Status: {1}", oFileName, oGDPicturePDF.GetStat().ToString())
                                                 Continue For
                                             End If
                                         Else
-                                            Logger.Warn("File [{0}] was skipped because its extension [{1}] is not allowed.", oFileName, oExtension)
+                                            Logger.Error("An error occurred getting the file size for [{0}]. Status: {1}", oFileName, oGDPicturePDF.GetStat().ToString())
                                             Continue For
                                         End If
                                     Else
-                                        Logger.Debug("File [{0}] was skipped because its name indicates the invoice data file.", oFileName)
+                                        Logger.Warn("File [{0}] was skipped because its extension [{1}] is not allowed.", oFileName, oExtension)
                                         Continue For
                                     End If
                                 Else
@@ -81,12 +70,12 @@ Public Class PDFAttachments
                             Next
                         End If
                     Else
-                        Logger.Error("An error occurred getting the number of embedded files. Status: {0}", oGDPicturePDF.GetStat().ToString())
-                        Return Nothing
+                        Dim oMessage = String.Format("An error occurred getting the number of embedded files. Status: {0}", oGDPicturePDF.GetStat().ToString())
+                        Throw New ApplicationException(oMessage)
                     End If
                 Else
-                    Logger.Error("The file [{0}] can't be loaded.", FileName)
-                    Return Nothing
+                    Dim oMessage = String.Format("The file [{0}] can't be loaded. Status: [{1}]", FileName, oGDPicturePDF.GetStat().ToString())
+                    Throw New ApplicationException(oMessage)
                 End If
             End Using
 

Modules.Interfaces/ZUGFeRDInterface/PropertyValues.vb

@@ -16,7 +16,7 @@ Public Class PropertyValues
 
     Public Class CheckPropertyValuesResult
         Public MissingProperties As New List(Of String)
-        Public ValidProperties As List(Of ValidProperty)
+        Public ValidProperties As New List(Of ValidProperty)
     End Class
 
     Public Class ValidProperty
@@ -36,7 +36,7 @@ Public Class PropertyValues
 
         ' PropertyMap items with `IsGrouped = False` are handled normally
         Dim oDefaultProperties As Dictionary(Of String, XmlItemProperty) = PropertyMap.
-            Where(Function(Item) Item.Value.IsGrouped = True).
+            Where(Function(Item) Item.Value.IsGrouped = False).
             ToDictionary(Function(Item) Item.Key,
                          Function(Item) Item.Value)