Bugfix PHPOffice#548: variables edited in word get messed with invisible XML

Author: d-damien

src/PhpWord/TemplateProcessor.php

@@ -135,6 +135,43 @@ public function applyXslStyleSheet($xslDOMDocument, $xslOptions = array(), $xslO
         $this->tempDocumentMainPart = $xmlTransformed;
     }
 
+    /**
+     * Clean all template parts of hidden XML within variables/placeholders.
+     *
+     * @return void
+     */
+    public function fixBrokenVariables()
+    {
+        $this->tempDocumentMainPart = $this->fixBrokenVariablesForPart($this->tempDocumentMainPart);
+
+        foreach ($this->tempDocumentHeaders as &$headerXML) {
+            $headerXML = $this->fixBrokenVariablesForPart($headerXML);
+        }
+
+        foreach ($this->tempDocumentFooters as &$footerXML) {
+            $headerXML = $this->fixBrokenVariablesForPart($footerXML);
+        }
+    }
+
+    /**
+     * Fix dirty hidden XML within variables in document part.
+     *
+     * @param string $documentPartXML said document part
+     *
+     * @return string
+     */
+    protected function fixBrokenVariablesForPart(string $documentPartXML)
+    {
+        return
+            preg_replace_callback(
+                '|\$([^{]*)(\{.*})|U',
+                function ($match) {
+                    return '$'.strip_tags($match[2]);
+                },
+                $documentPartXML
+            );
+    }
+
     /**
      * @param mixed $macro
      * @param mixed $replace

tests/PhpWord/TemplateProcessorTest.php

@@ -141,6 +141,30 @@ final public function testXslStyleSheetCanNotBeAppliedOnFailureOfLoadingXmlFromT
         @$templateProcessor->applyXslStyleSheet($xslDOMDocument);
     }
 
+    /**
+     * @covers ::fixBrokenVariablesForPart
+     * @test
+     */
+    public function testFixBrokenVariablesForPart()
+    {
+        // accessing protected method via closure binding
+        $template = new TemplateProcessor();
+        $closure = function ($arg) {
+            return $this->fixBrokenVariablesForPart($arg);
+        };
+        $method = $closure->bindTo($template, $template);
+
+        // example XML found in actual word document
+        $actualDirtyXml = ''
+        .'<w:szCs w:val="18"/>${</w:rPr>sps_telephone}<w:t>'
+        .'$</w:t></w:r><w:r w:rsidR="00 C3064E" w:rsidRPr="00C3064E"><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/><w:noProof/><w:sz w:val="20"/><w:szCs w:val="18"/></w:rPr><w:t>'
+        .'{sps</w:t></w:r><w:r w:rsidR="00243 BDA"><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/><w:noProof/><w:sz w:val="20"/><w:szCs w:val="18"/></w:rPr><w:t>'
+        .'_</w:t></w:r><w:r w:rsidR="00C3064E" w:rsidRPr="00C3064E"><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/><w:noProof/><w:sz w:val="20"/><w:szCs w:val="18"/></w:rPr><w:t>nom}'.'${sps_mail}';
+
+        $expectedCleanXml = '<w:szCs w:val="18"/>${sps_telephone}<w:t>${sps_nom}${sps_mail}';
+        $this->assertEquals($method($actualDirtyXml), $expectedCleanXml);
+    }
+
     /**
      * @civers ::setValue
      * @covers ::cloneRow