Merge branch 'master' into wordunimplemented2

oleibman · web-flow · commit e0e98dd5f7a0 · 2024-08-09T00:54:08.000-07:00
diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml
@@ -0,0 +1,65 @@
+name: 🐛 Bug Report
+description: Create a report to help improve PHPWord
+labels: [ "Bug Report" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+         ### ❗️ Read this before submitting your bug report:
+         - **Write in English/French.** Reports in all other languages will be closed.
+         - **Provide as much detail as possible** 
+           - Attachments : Error logs, Screenshots, Document files (generated and expected).
+           - If the issue cannot be reproduced, it cannot be fixed.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug and add attachments
+      description: What went wrong? If possible, add screenshots, error logs, document files (generated and expected) or screen recordings to help explain your problem.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: steps-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Please provide a code sample that reproduces the issue.
+      placeholder: |
+        ```php
+        <?php
+        require __DIR__ . '/vendor/autoload.php';
+
+        $phpWord = new \PhpOffice\PhpWord\PhpWord();
+        $section = $phpWord->addSection();
+        $section->...
+        ```
+    validations:
+      required: true
+  - type: input
+    id: phpword-version
+    attributes:
+      label: PHPWord version(s) where the bug happened
+      placeholder: "e.g., 1.2.0 or master"
+    validations:
+      required: true
+  - type: input
+    id: php-version
+    attributes:
+      label: PHP version(s) where the bug happened
+      placeholder: "e.g., 7.1 or 8.2"
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Priority
+      description: Funded tickets have a higher priority.
+      options:
+        - label: I want to crowdfund the bug fix (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
+          required: false
+        - label: I want to pay the bug fix and fund a maintainer for that. (Contact @Progi1984)
+          required: false
diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml
@@ -0,0 +1,35 @@
+name: 💡 Feature request
+description: Suggest an idea for this project
+labels: [ "Change Request" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+         ### ❗️ Read this before submitting your bug report:
+         - **Write in English/French.** Reports in all other languages will be closed.
+         - **Provide as much detail as possible** 
+           - Attachments : Error logs, Screenshots, Document files (generated and expected).
+           - If the issue cannot be reproduced, it cannot be fixed.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the problem
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Describe the expected behavior
+      description: A clear and concise description of what you expected to happen. If possible, add screenshots, document files (expected).
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Priority
+      description: Funded tickets have a higher priority.
+      options:
+        - label: I want to crowdfund the feature (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
+          required: false
+        - label: I want to pay the feature and fund a maintainer for that. (Contact @Progi1984)
+          required: false
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/how-to-use.md b/.github/ISSUE_TEMPLATE/how-to-use.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,6 +6,7 @@ Fixes # (issue)
 
 ### Checklist:
 
-- [ ] 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 updated the documentation to describe the changes
+- [ ] My CI is :green_circle:
+- [ ] I have covered by unit tests my new code (check build/coverage for coverage report)
+- [ ] I have updated the [documentation](https://github.com/PHPOffice/PHPWord/tree/master/docs) to describe the changes
+- [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/2.x/2.0.0.md)
diff --git a/docs/changes/2.x/2.0.0.md b/docs/changes/2.x/2.0.0.md
@@ -5,14 +5,19 @@
 ## Enhancements
 
 - IOFactory : Added extractVariables method to extract variables from a document [@sibalonat](https://github.com/sibalonat) in [#2515](https://github.com/PHPOffice/PHPWord/pull/2515)
+- PDF Writer : Documented how to specify a PDF renderer, when working with the PDF writer, as well as the three available choices by [@settermjd](https://github.com/settermjd) in [#2642](https://github.com/PHPOffice/PHPWord/pull/2642)
 
 ### Bug fixes
 
 - MsDoc Reader : Correct Font Size Calculation by [@oleibman](https://github.com/oleibman) fixing [#2526](https://github.com/PHPOffice/PHPWord/issues/2526) in [#2531](https://github.com/PHPOffice/PHPWord/pull/2531)
+- Html Reader : Process Titles as Headings not Paragraphs [@0b10011](https://github.com/0b10011) and [@oleibman](https://github.com/oleibman) Issue [#1692](https://github.com/PHPOffice/PHPWord/issues/1692) PR [#2533](https://github.com/PHPOffice/PHPWord/pull/2533)
+- Generate Table Cell if Row Doesn't Have Any [@oleibman](https://github.com/oleibman) fixing [#2505](https://github.com/PHPOffice/PHPWord/issues/2505) in [#2516](https://github.com/PHPOffice/PHPWord/pull/2516)
 - TemplateProcessor Persist File After Destruct [@oleibman](https://github.com/oleibman) fixing [#2539](https://github.com/PHPOffice/PHPWord/issues/2539) in [#2545](https://github.com/PHPOffice/PHPWord/pull/2545)
+- TemplateProcessor Destructor Problem with Php7 [@oleibman](https://github.com/oleibman) fixing [#2548](https://github.com/PHPOffice/PHPWord/issues/2548) in [#2554](https://github.com/PHPOffice/PHPWord/pull/2554)
 - bug: TemplateProcessor fix multiline values [@gimler](https://github.com/gimler) fixing [#268](https://github.com/PHPOffice/PHPWord/issues/268), [#2323](https://github.com/PHPOffice/PHPWord/issues/2323) and [#2486](https://github.com/PHPOffice/PHPWord/issues/2486) in [#2522](https://github.com/PHPOffice/PHPWord/pull/2522)
-
 - 32-bit Problem in PasswordEncoder [@oleibman](https://github.com/oleibman) fixing [#2550](https://github.com/PHPOffice/PHPWord/issues/2550) in [#2551](https://github.com/PHPOffice/PHPWord/pull/2551)
+- Typo : Fix hardcoded macro chars in TemplateProcessor method [@glafarge](https://github.com/glafarge) in [#2618](https://github.com/PHPOffice/PHPWord/pull/2618)
+- XML Reader : Prevent fatal errors when opening corrupt files or "doc" files [@mmcev106](https://github.com/mmcev106) in [#2626](https://github.com/PHPOffice/PHPWord/pull/2626)
 
 ### Miscellaneous
 
@@ -22,6 +27,7 @@
 - Bump phpmd/phpmd from 2.14.1 to 2.15.0 by [@dependabot](https://github.com/dependabot) in [#2538](https://github.com/PHPOffice/PHPWord/pull/2538)
 - Bump phpunit/phpunit from 9.6.14 to 9.6.15 by [@dependabot](https://github.com/dependabot) in [#2537](https://github.com/PHPOffice/PHPWord/pull/2537)
 - Bump symfony/process from 5.4.28 to 5.4.34 by [@dependabot](https://github.com/dependabot) in [#2536](https://github.com/PHPOffice/PHPWord/pull/2536)
-- Allow rgb() when converting Html [@oleibman](https://github.com/oleibman) fixing [#2508](https://github.com/PHPOffice/PHPWord/issues/2508) in [#2512](https://github.com/PHPOffice/PHPWord/pull/2512)
+- Allow rgb() when converting Html by [@oleibman](https://github.com/oleibman) fixing [#2508](https://github.com/PHPOffice/PHPWord/issues/2508) in [#2512](https://github.com/PHPOffice/PHPWord/pull/2512)
+- Improved Issue Template by [@Progi1984](https://github.com/Progi1984) in [#2609](https://github.com/PHPOffice/PHPWord/pull/2609)
 
 ### BC Breaks
diff --git a/docs/usage/writers.md b/docs/usage/writers.md
@@ -87,6 +87,29 @@ $writer = IOFactory::createWriter($oPhpWord, 'PDF');
 $writer->save(__DIR__ . '/sample.pdf');
 ```
 
+#### Specify the PDF Renderer
+
+Before PHPWord can write a PDF, you **must** specify the renderer to use and the path to it.
+Currently, three renderers are supported: 
+
+- [DomPDF](https://github.com/dompdf/dompdf)
+- [MPDF](https://mpdf.github.io/)
+- [TCPDF](https://tcpdf.org/)
+
+To specify the renderer you use two static `Settings` functions:
+
+- `setPdfRendererName`: This sets the name of the renderer library to use.
+  Provide one of [`Settings`' three `PDF_` constants](https://github.com/PHPOffice/PHPWord/blob/master/src/PhpWord/Settings.php#L39-L41) to the function call.
+- `setPdfRendererPath`: This sets the path to the renderer library. 
+  This directory is the renderer's package directory within Composer's _vendor_ directory.
+
+In the code below, you can see an example of setting MPDF as the desired PDF renderer.
+
+```php
+Settings::setPdfRendererName(Settings::PDF_RENDERER_MPDF);
+Settings::setPdfRendererPath(__DIR__ . '/../vendor/mpdf/mpdf');
+```
+
 ## RTF
 The name of the writer is `RTF`.
 
diff --git a/src/PhpWord/Shared/XMLReader.php b/src/PhpWord/Shared/XMLReader.php
@@ -61,7 +61,15 @@ public function getDomFromZip($zipFile, $xmlFile)
         }
 
         $zip = new ZipArchive();
-        $zip->open($zipFile);
+        $openStatus = $zip->open($zipFile);
+        if ($openStatus !== true) {
+            /**
+             * Throw an exception since making further calls on the ZipArchive would cause a fatal error.
+             * This prevents fatal errors on corrupt archives and attempts to open old "doc" files.
+             */
+            throw new Exception("The archive failed to load with the following error code: $openStatus");
+        }
+
         $content = $zip->getFromName(ltrim($xmlFile, '/'));
         $zip->close();
 
diff --git a/src/PhpWord/TemplateProcessor.php b/src/PhpWord/TemplateProcessor.php
@@ -815,8 +815,8 @@ public function cloneRow($search, $numberOfClones): void
      */
     public function deleteRow(string $search): void
     {
-        if ('${' !== substr($search, 0, 2) && '}' !== substr($search, -1)) {
-            $search = '${' . $search . '}';
+        if (self::$macroOpeningChars !== substr($search, 0, 2) && self::$macroClosingChars !== substr($search, -1)) {
+            $search = self::$macroOpeningChars . $search . self::$macroClosingChars;
         }
 
         $tagPos = strpos($this->tempDocumentMainPart, $search);
diff --git a/tests/PhpWordTests/Shared/XMLReaderTest.php b/tests/PhpWordTests/Shared/XMLReaderTest.php
@@ -85,6 +85,33 @@ public function testThrowsExceptionOnNonExistingArchive(): void
         $reader->getDomFromZip($archiveFile, 'test.xml');
     }
 
+    /**
+     * Test that read from invalid archive throws exception.
+     */
+    public function testThrowsExceptionOnZipArchiveOpenErrors(): void
+    {
+        /**
+         * @var string
+         */
+        $tempPath = tempnam(sys_get_temp_dir(), 'PhpWord');
+
+        // Simulate a corrupt archive
+        file_put_contents($tempPath, mt_rand());
+
+        $exceptionMessage = null;
+
+        try {
+            $reader = new XMLReader();
+            $reader->getDomFromZip($tempPath, 'test.xml');
+        } catch (Exception $e) {
+            $exceptionMessage = $e->getMessage();
+        }
+
+        self::assertNotNull($exceptionMessage);
+
+        unlink($tempPath);
+    }
+
     /**
      * Test elements count.
      */

Original file line number	Diff line number	Diff line change
`@@ -815,8 +815,8 @@ public function cloneRow($search, $numberOfClones): void`
`815`	`815`	`*/`
`816`	`816`	`public function deleteRow(string $search): void`
`817`	`817`	`{`
`818`		`- if ('${' !== substr($search, 0, 2) && '}' !== substr($search, -1)) {`
`819`		`- $search = '${' . $search . '}';`
	`818`	`+ if (self::$macroOpeningChars !== substr($search, 0, 2) && self::$macroClosingChars !== substr($search, -1)) {`
	`819`	`+ $search = self::$macroOpeningChars . $search . self::$macroClosingChars;`
`820`	`820`	`}`
`821`	`821`
`822`	`822`	`$tagPos = strpos($this->tempDocumentMainPart, $search);`