Merge branch 'develop' into fix_non_auto_line_spacing

troosan · web-flow · commit 1a9ed022acbc · 2018-12-01T22:23:41.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,7 @@ vendor
 /.settings
 phpword.ini
 /.buildpath
+/.scannerwork
 /.project
 /nbproject
 /.php_cs.cache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,14 +3,18 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-v0.16.0 (xx xxx 2018)
+v0.16.0 (xx dec 2018)
 ----------------------
 ### Added
 
 ### Fixed
 - Fix regex in `cloneBlock` function @nicoder #1269
 - HTML Title Writer loses text when Title contains a TextRun instead a string. @begnini #1436
 - 240 twips are being added to line spacing, should not happen when using lineRule fixed @troosan #1509 #1505
+- Adding table layout to the generated HTML @aarangara #1441
+- Fix loading of Sharepoint document @Garrcomm #1498
+- RTF writer: Round getPageSizeW and getPageSizeH to avoid decimals @Patrick64 #1493
+- Fix parsing of Office 365 documents @Timanx #1485
 
 v0.15.0 (14 Jul 2018)
 ----------------------
diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
@@ -8,4 +8,4 @@ Fixes # (issue)
 
 - [ ] I have run `composer run-script check --timeout=0` and no errors were reported
 - [ ] The new code is covered by unit tests (check build/coverage for coverage report)
-- [ ] I have update the documentation to describe the changes
+- [ ] I have updated the documentation to describe the changes
diff --git a/docs/styles.rst b/docs/styles.rst
@@ -29,6 +29,7 @@ Available Section style options:
 - ``marginRight``. Page margin right in *twip*.
 - ``marginBottom``. Page margin bottom in *twip*.
 - ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``).
+   See ``\PhpOffice\PhpWord\Style\Section::ORIENTATION_...`` class constants for possible values
 - ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
 - ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
 
@@ -45,7 +46,7 @@ Available Font style options:
 - ``color``. Font color, e.g. *FF0000*.
 - ``doubleStrikethrough``. Double strikethrough, *true* or *false*.
 - ``fgColor``. Font highlight color, e.g. *yellow*, *green*, *blue*.
-   See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` constants for more values
+   See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` class constants for possible values
 - ``hint``. Font content type, *default*, *eastAsia*, or *cs*.
 - ``italic``. Italic, *true* or *false*.
 - ``name``. Font name, e.g. *Arial*.
@@ -56,7 +57,7 @@ Available Font style options:
 - ``subScript``. Subscript, *true* or *false*.
 - ``superScript``. Superscript, *true* or *false*.
 - ``underline``. Underline, *single*, *dash*, *dotted*, etc.
-   See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` constants for more values
+   See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` class constants for possible values
 - ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages
    See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes.
 - ``position``. The text position, raised or lowered, in half points
@@ -69,7 +70,7 @@ Paragraph
 Available Paragraph style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
 - ``basedOn``. Parent style.
 - ``hanging``. Hanging in *twip*.
 - ``indent``. Indent in *twip*.
@@ -82,14 +83,15 @@ Available Paragraph style options:
 - ``spaceAfter``. Space after paragraph in *twip*.
 - ``spacing``. Space between lines in *twip*. If spacingLineRule is auto, 240 (height of 1 line) will be added, so if you want a double line height, set this to 240.
 - ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast*
+   See ``\PhpOffice\PhpWord\SimpleType\LineSpacingRule`` class constants for possible values.
 - ``suppressAutoHyphens``. Hyphenation for paragraph, *true* or *false*.
 - ``tabs``. Set of custom tab stops.
 - ``widowControl``. Allow first/last line to display on a separate page, *true* or *false*.
 - ``contextualSpacing``. Ignore Spacing Above and Below When Using Identical Styles, *true* or *false*.
 - ``bidi``. Right to Left Paragraph Layout, *true* or *false*.
 - ``shading``. Paragraph Shading.
 - ``textAlignment``. Vertical Character Alignment on Line.
-   See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class for possible values.
+   See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class constants for possible values.
 
 .. _table-style:
 
@@ -99,7 +101,7 @@ Table
 Available Table style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-   See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
 - ``bgColor``. Background color, e.g. '9966CC'.
 - ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
 - ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
@@ -168,7 +170,7 @@ Numbering level
 Available NumberingLevel style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
 - ``font``. Font name.
 - ``format``. Numbering format bullet\|decimal\|upperRoman\|lowerRoman\|upperLetter\|lowerLetter.
 - ``hanging``. See paragraph style.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -23,5 +23,6 @@
     <logging>
         <log type="coverage-html" target="./build/coverage" />
         <log type="coverage-clover" target="./build/logs/clover.xml" />
+        <log type="junit" target="./build/logs/logfile.xml"/>
     </logging>
 </phpunit>
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -0,0 +1,17 @@
+# must be unique in a given SonarQube instance
+sonar.projectKey=phpoffice:phpword
+# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
+sonar.projectName=PHPWord
+sonar.projectVersion=0.16
+ 
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+# This property is optional if sonar.modules is set. 
+sonar.sources=src
+sonar.tests=tests
+sonar.php.coverage.reportPaths=build/logs/clover.xml
+sonar.php.tests.reportPath=build/logs/logfile.xml
+
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8
+
+sonar.host.url=http://localhost:9000
diff --git a/src/PhpWord/Reader/MsDoc.php b/src/PhpWord/Reader/MsDoc.php
@@ -2185,6 +2185,8 @@ private function readPrl($data, $pos, $cbNum)
 
                                     $sprmCPicLocation += $embeddedBlipRH['recLen'];
                                     break;
+                                case self::OFFICEARTBLIPPNG:
+                                    break;
                                 default:
                                     // print_r(dechex($embeddedBlipRH['recType']));
                             }
diff --git a/src/PhpWord/Reader/Word2007.php b/src/PhpWord/Reader/Word2007.php
@@ -62,6 +62,9 @@ public function load($docFile)
         foreach ($steps as $step) {
             $stepPart = $step['stepPart'];
             $stepItems = $step['stepItems'];
+            if (!isset($relationships[$stepPart])) {
+                continue;
+            }
             foreach ($relationships[$stepPart] as $relItem) {
                 $relType = $relItem['type'];
                 if (isset($stepItems[$relType])) {
diff --git a/src/PhpWord/Shared/Html.php b/src/PhpWord/Shared/Html.php
@@ -753,8 +753,6 @@ private static function mapAlign($cssAlignment)
             default:
                 return Jc::START;
         }
-
-        return null;
     }
 
     /**
diff --git a/src/PhpWord/TemplateProcessor.php b/src/PhpWord/TemplateProcessor.php
@@ -503,11 +503,19 @@ protected function getHeaderName($index)
     }
 
     /**
+     * Usually, the name of main part document will be 'document.xml'. However, some .docx files (possibly those from Office 365, experienced also on documents from Word Online created from blank templates) have file 'document22.xml' in their zip archive instead of 'document.xml'. This method searches content types file to correctly determine the file name.
+     *
      * @return string
      */
     protected function getMainPartName()
     {
-        return 'word/document.xml';
+        $contentTypes = $this->zipClass->getFromName('[Content_Types].xml');
+
+        $pattern = '~PartName="\/(word\/document.*?\.xml)" ContentType="application\/vnd\.openxmlformats-officedocument\.wordprocessingml\.document\.main\+xml"~';
+
+        preg_match($pattern, $contentTypes, $matches);
+
+        return array_key_exists(1, $matches) ? $matches[1] : 'word/document.xml';
     }
 
     /**
diff --git a/src/PhpWord/Writer/HTML/Element/Table.php b/src/PhpWord/Writer/HTML/Element/Table.php
@@ -39,7 +39,8 @@ public function write()
         $rows = $this->element->getRows();
         $rowCount = count($rows);
         if ($rowCount > 0) {
-            $content .= '<table>' . PHP_EOL;
+            $content .= '<table' . self::getTableStyle($this->element->getStyle()) . '>' . PHP_EOL;
+
             for ($i = 0; $i < $rowCount; $i++) {
                 /** @var $row \PhpOffice\PhpWord\Element\Row Type hint */
                 $rowStyle = $rows[$i]->getStyle();
@@ -102,4 +103,25 @@ public function write()
 
         return $content;
     }
+
+    /**
+     * Translates Table style in CSS equivalent
+     *
+     * @param \PhpOffice\PhpWord\Style\Table|null $tableStyle
+     * @return string
+     */
+    private function getTableStyle(\PhpOffice\PhpWord\Style\Table $tableStyle = null)
+    {
+        if ($tableStyle == null) {
+            return '';
+        }
+        $style = ' style="';
+        if ($tableStyle->getLayout() == \PhpOffice\PhpWord\Style\Table::LAYOUT_FIXED) {
+            $style .= 'table-layout: fixed;';
+        } elseif ($tableStyle->getLayout() == \PhpOffice\PhpWord\Style\Table::LAYOUT_AUTO) {
+            $style .= 'table-layout: auto;';
+        }
+
+        return $style . '"';
+    }
 }
diff --git a/src/PhpWord/Writer/RTF/Style/Section.php b/src/PhpWord/Writer/RTF/Style/Section.php
@@ -43,8 +43,8 @@ public function write()
         $content .= '\sectd ';
 
         // Size & margin
-        $content .= $this->getValueIf($style->getPageSizeW() !== null, '\pgwsxn' . $style->getPageSizeW());
-        $content .= $this->getValueIf($style->getPageSizeH() !== null, '\pghsxn' . $style->getPageSizeH());
+        $content .= $this->getValueIf($style->getPageSizeW() !== null, '\pgwsxn' . round($style->getPageSizeW()));
+        $content .= $this->getValueIf($style->getPageSizeH() !== null, '\pghsxn' . round($style->getPageSizeH()));
         $content .= ' ';
         $content .= $this->getValueIf($style->getMarginTop() !== null, '\margtsxn' . $style->getMarginTop());
         $content .= $this->getValueIf($style->getMarginRight() !== null, '\margrsxn' . $style->getMarginRight());
diff --git a/tests/PhpWord/Shared/HtmlTest.php b/tests/PhpWord/Shared/HtmlTest.php
@@ -86,6 +86,21 @@ public function testParseFullHtml()
         $this->assertCount(2, $section->getElements());
     }
 
+    /**
+     * Test HTML entities
+     */
+    public function testParseHtmlEntities()
+    {
+        \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true);
+        $phpWord = new \PhpOffice\PhpWord\PhpWord();
+        $section = $phpWord->addSection();
+        Html::addHtml($section, 'text with entities &lt;my text&gt;');
+
+        $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007');
+        $this->assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t'));
+        $this->assertEquals('text with entities <my text>', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->nodeValue);
+    }
+
     /**
      * Test underline
      */
diff --git a/tests/PhpWord/TemplateProcessorTest.php b/tests/PhpWord/TemplateProcessorTest.php
@@ -276,4 +276,13 @@ public function cloneBlockCanCloneABlockTwice()
             );
         }
     }
+
+    public function testMainPartNameDetection()
+    {
+        $templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/document22-xml.docx');
+
+        $variables = array('test');
+
+        $this->assertEquals($variables, $templateProcessor->getVariables());
+    }
 }
diff --git a/tests/PhpWord/Writer/HTML/ElementTest.php b/tests/PhpWord/Writer/HTML/ElementTest.php
@@ -73,8 +73,8 @@ public function testWriteTrackChanges()
         $dom = $this->getAsHTML($phpWord);
         $xpath = new \DOMXPath($dom);
 
-        $this->assertTrue($xpath->query('/html/body/p[1]/ins')->length == 1);
-        $this->assertTrue($xpath->query('/html/body/p[2]/del')->length == 1);
+        $this->assertEquals(1, $xpath->query('/html/body/p[1]/ins')->length);
+        $this->assertEquals(1, $xpath->query('/html/body/p[2]/del')->length);
     }
 
     /**
@@ -97,9 +97,9 @@ public function testWriteColSpan()
         $dom = $this->getAsHTML($phpWord);
         $xpath = new \DOMXPath($dom);
 
-        $this->assertTrue($xpath->query('/html/body/table/tr[1]/td')->length == 1);
+        $this->assertEquals(1, $xpath->query('/html/body/table/tr[1]/td')->length);
         $this->assertEquals('2', $xpath->query('/html/body/table/tr/td[1]')->item(0)->attributes->getNamedItem('colspan')->textContent);
-        $this->assertTrue($xpath->query('/html/body/table/tr[2]/td')->length == 2);
+        $this->assertEquals(2, $xpath->query('/html/body/table/tr[2]/td')->length);
     }
 
     /**
@@ -126,9 +126,9 @@ public function testWriteRowSpan()
         $dom = $this->getAsHTML($phpWord);
         $xpath = new \DOMXPath($dom);
 
-        $this->assertTrue($xpath->query('/html/body/table/tr[1]/td')->length == 2);
+        $this->assertEquals(2, $xpath->query('/html/body/table/tr[1]/td')->length);
         $this->assertEquals('3', $xpath->query('/html/body/table/tr[1]/td[1]')->item(0)->attributes->getNamedItem('rowspan')->textContent);
-        $this->assertTrue($xpath->query('/html/body/table/tr[2]/td')->length == 1);
+        $this->assertEquals(1, $xpath->query('/html/body/table/tr[2]/td')->length);
     }
 
     private function getAsHTML(PhpWord $phpWord)
@@ -155,6 +155,30 @@ public function testWriteTitleTextRun()
         $htmlWriter = new HTML($phpWord);
         $content = $htmlWriter->getContent();
 
-        $this->assertTrue(strpos($content, $expected) !== false);
+        $this->assertContains($expected, $content);
+    }
+
+    /**
+     * Tests writing table with layout
+     */
+    public function testWriteTableLayout()
+    {
+        $phpWord = new PhpWord();
+        $section = $phpWord->addSection();
+        $section->addTable();
+
+        $table1 = $section->addTable(array('layout' => \PhpOffice\PhpWord\Style\Table::LAYOUT_FIXED));
+        $row1 = $table1->addRow();
+        $row1->addCell()->addText('fixed layout table');
+
+        $table2 = $section->addTable(array('layout' => \PhpOffice\PhpWord\Style\Table::LAYOUT_AUTO));
+        $row2 = $table2->addRow();
+        $row2->addCell()->addText('auto layout table');
+
+        $dom = $this->getAsHTML($phpWord);
+        $xpath = new \DOMXPath($dom);
+
+        $this->assertEquals('table-layout: fixed;', $xpath->query('/html/body/table[1]')->item(0)->attributes->getNamedItem('style')->textContent);
+        $this->assertEquals('table-layout: auto;', $xpath->query('/html/body/table[2]')->item(0)->attributes->getNamedItem('style')->textContent);
     }
 }
diff --git a/tests/PhpWord/_files/templates/document22-xml.docx b/tests/PhpWord/_files/templates/document22-xml.docx

Original file line number	Diff line number	Diff line change
`@@ -2185,6 +2185,8 @@ private function readPrl($data, $pos, $cbNum)`
`2185`	`2185`
`2186`	`2186`	`$sprmCPicLocation += $embeddedBlipRH['recLen'];`
`2187`	`2187`	`break;`
	`2188`	`+ case self::OFFICEARTBLIPPNG:`
	`2189`	`+ break;`
`2188`	`2190`	`default:`
`2189`	`2191`	`// print_r(dechex($embeddedBlipRH['recType']));`
`2190`	`2192`	`}`
Original file line number	Diff line number	Diff line change
`@@ -753,8 +753,6 @@ private static function mapAlign($cssAlignment)`
`753`	`753`	`default:`
`754`	`754`	`return Jc::START;`
`755`	`755`	`}`
`756`		`-`
`757`		`- return null;`
`758`	`756`	`}`
`759`	`757`
`760`	`758`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -503,11 +503,19 @@ protected function getHeaderName($index)`
`503`	`503`	`}`
`504`	`504`
`505`	`505`	`/**`
	`506`	`+ * Usually, the name of main part document will be 'document.xml'. However, some .docx files (possibly those from Office 365, experienced also on documents from Word Online created from blank templates) have file 'document22.xml' in their zip archive instead of 'document.xml'. This method searches content types file to correctly determine the file name.`
	`507`	`+ *`
`506`	`508`	`* @return string`
`507`	`509`	`*/`
`508`	`510`	`protected function getMainPartName()`
`509`	`511`	`{`
`510`		`- return 'word/document.xml';`
	`512`	`+ $contentTypes = $this->zipClass->getFromName('[Content_Types].xml');`
	`513`	`+`
	`514`	`+ $pattern = '~PartName="\/(word\/document.*?\.xml)" ContentType="application\/vnd\.openxmlformats-officedocument\.wordprocessingml\.document\.main\+xml"~';`
	`515`	`+`
	`516`	`+ preg_match($pattern, $contentTypes, $matches);`
	`517`	`+`
	`518`	`+ return array_key_exists(1, $matches) ? $matches[1] : 'word/document.xml';`
`511`	`519`	`}`
`512`	`520`
`513`	`521`	`/**`