fix: image renderer should work for header and footer document part

Author: cyril-iselin

DocxTemplater.Markdown/MarkdownToOpenXmlRenderer.cs

@@ -1,5 +1,4 @@
-
-using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
 using DocumentFormat.OpenXml.Wordprocessing;
 using DocxTemplater.Markdown.Renderer;
@@ -33,7 +32,8 @@ public MarkdownToOpenXmlRenderer(Paragraph parentElement,
             IImageService imageService)
         {
             // extract style from target run element
-            m_targetRunProperties = ((Run)target.Parent).RunProperties;
+            TargetText = target;
+            m_targetRunProperties = ((Run)TargetText?.Parent)?.RunProperties;
             m_formatStack.Push(new Format(false, false, null, false));
             m_containingParagraphFromTemplate = parentElement;
             CurrentParagraph = parentElement;
@@ -48,7 +48,7 @@ public MarkdownToOpenXmlRenderer(Paragraph parentElement,
             ObjectRenderers.Add(new HtmlBlockRenderer());
             if (imageService != null)
             {
-                ObjectRenderers.Add(new ImageInlineRenderer(mainDocumentPart, imageService));
+                ObjectRenderers.Add(new ImageInlineRenderer(imageService));
             }
 
 
@@ -60,6 +60,8 @@ public MarkdownToOpenXmlRenderer(Paragraph parentElement,
 
         public Paragraph CurrentParagraph { get; private set; }
 
+        public Text TargetText { get; }
+
         public bool CurrentParagraphWasCreatedByMarkdown => CurrentParagraph != m_containingParagraphFromTemplate;
 
 #if DEBUG

DocxTemplater.Markdown/Renderer/Inlines/ImageInlineRenderer.cs

@@ -1,5 +1,4 @@
-using DocumentFormat.OpenXml.Packaging;
-using Markdig.Syntax.Inlines;
+using Markdig.Syntax.Inlines;
 using System;
 using System.Linq;
 using DocumentFormat.OpenXml;
@@ -12,12 +11,10 @@ namespace DocxTemplater.Markdown.Renderer.Inlines
 {
     internal sealed class ImageInlineRenderer : OpenXmlObjectRenderer<LinkInline>
     {
-        private readonly MainDocumentPart m_mainDocumentPart;
         private readonly IImageService m_imageService;
 
-        public ImageInlineRenderer(MainDocumentPart mainDocumentPart, IImageService imageService)
+        public ImageInlineRenderer(IImageService imageService)
         {
-            m_mainDocumentPart = mainDocumentPart;
             m_imageService = imageService;
         }
 
@@ -28,7 +25,7 @@ protected override void Write(MarkdownToOpenXmlRenderer renderer, LinkInline obj
                 return;
             }
 
-            var root = m_mainDocumentPart.RootElement;
+            var root = renderer.TargetText.GetRoot();
             byte[] imageBytes;
 
             try

DocxTemplater.Test/MarkdownRendererTest.cs

@@ -275,7 +275,9 @@ public void MarkdownWithBase64ImageWithoutImageFormatter()
             {
                 { "MyMarkdown", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
                 { "MyOtherMarkdown", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
-                { "MyNextMarkdown", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) }
+                { "MyNextMarkdown", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
+                { "Header", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
+                { "Footer", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) }
             });
 
             var result = docTemplate.Process();
@@ -284,7 +286,7 @@ public void MarkdownWithBase64ImageWithoutImageFormatter()
             result.SaveAsFileAndOpenInWord();
             result.Position = 0;
             var document = WordprocessingDocument.Open(result, false);
-            Assert.That(TestHelper.ComputeSha256Hash(document.MainDocumentPart.Document.Body.InnerXml), Is.EqualTo("80cefc6cbda5140f0196de9df6812c9db046bf7a59cee756e34348f4fba1b8d4"));
+            Assert.That(TestHelper.ComputeSha256Hash(document.MainDocumentPart.Document.Body.InnerXml), Is.EqualTo("f53a467b63e86c7f766b1697a44e9a2965351d52dfb1c02bdc0b1b3118b20658"));
         }
 
         [Test]
@@ -316,7 +318,9 @@ public void MarkdownWithBase64ImageShouldRenderPicture()
             {
                 { "MyMarkdown", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
                 { "MyOtherMarkdown", new ValueWithMetadata(markdownPicOnly, new ValueMetadata("md")) },
-                { "MyNextMarkdown", new ValueWithMetadata(markdownTableAndPic, new ValueMetadata("md")) }
+                { "MyNextMarkdown", new ValueWithMetadata(markdownTableAndPic, new ValueMetadata("md")) },
+                { "Header", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) },
+                { "Footer", new ValueWithMetadata(markdownTextAndPic, new ValueMetadata("md")) }
             });
 
             var result = docTemplate.Process();
@@ -325,12 +329,24 @@ public void MarkdownWithBase64ImageShouldRenderPicture()
             result.SaveAsFileAndOpenInWord();
             result.Position = 0;
             var document = WordprocessingDocument.Open(result, false);
-            var drawings = document.MainDocumentPart.Document.Body.Descendants<Drawing>();
-            int imageCount = drawings
+            var mainDrawings = document.MainDocumentPart.Document.Body.Descendants<Drawing>();
+            int mainImageCount = mainDrawings
                 .Select(d => d.Descendants<GraphicData>()
                     .Any(gd => gd.Uri == "http://schemas.openxmlformats.org/drawingml/2006/picture"))
                 .Count(b => b);
-            Assert.That(imageCount, Is.EqualTo(10), "Expected 10 images in the document, but found a different number.");
+            var headerDrawings = document.MainDocumentPart.HeaderParts.Single().Header.Descendants<Drawing>();
+            int headerImageCount = headerDrawings
+                .Select(d => d.Descendants<GraphicData>()
+                    .Any(gd => gd.Uri == "http://schemas.openxmlformats.org/drawingml/2006/picture"))
+                .Count(b => b);
+            var footerDrawings = document.MainDocumentPart.FooterParts.Single().Footer.Descendants<Drawing>();
+            int footerImageCount = footerDrawings
+                .Select(d => d.Descendants<GraphicData>()
+                    .Any(gd => gd.Uri == "http://schemas.openxmlformats.org/drawingml/2006/picture"))
+                .Count(b => b);
+            Assert.That(mainImageCount, Is.EqualTo(10), "Expected 10 images in the document, but found a different number.");
+            Assert.That(headerImageCount, Is.EqualTo(1), "Expected 10 images in the document, but found a different number.");
+            Assert.That(footerImageCount, Is.EqualTo(1), "Expected 10 images in the document, but found a different number.");
         }
 
         [Test]

DocxTemplater.Test/Resources/MarkdownBase64Image.docx

@@ -99,12 +99,12 @@ public Stream Process()
                 return m_stream;
             }
             Processed = true;
-            foreach (var header in m_wpDocument.MainDocumentPart.HeaderParts)
+            foreach (var header in m_wpDocument.MainDocumentPart.HeaderParts.ToList())
             {
                 ProcessNode(header.Header);
             }
             ProcessNode(m_wpDocument.MainDocumentPart.RootElement);
-            foreach (var footer in m_wpDocument.MainDocumentPart.FooterParts)
+            foreach (var footer in m_wpDocument.MainDocumentPart.FooterParts.ToList())
             {
                 ProcessNode(footer.Footer);
             }