├── tests
    ├── html
    │   ├── empty.html
    │   ├── test3.html
    │   ├── test4.html
    │   ├── zero-width-non-joiners.html
    │   ├── nbsp.html
    │   ├── non-breaking-spaces.html
    │   ├── utf8-example.html
    │   ├── invalid.html
    │   ├── dom-processing.html
    │   ├── windows-1252-example.html
    │   ├── pre.html
    │   ├── lists.html
    │   ├── nested-divs.html
    │   ├── anchors.html
    │   ├── basic.html
    │   ├── more-anchors.html
    │   ├── newlines.html
    │   ├── blockquotes.html
    │   ├── table.html
    │   ├── images.html
    │   ├── msoffice.html
    │   └── full_email.html
    ├── txt
    │   ├── empty.txt
    │   ├── dom-processing.txt
    │   ├── invalid.txt
    │   ├── test3.txt
    │   ├── utf8-example.txt
    │   ├── zero-width-non-joiners.txt
    │   ├── test4.txt
    │   ├── nbsp.txt
    │   ├── windows-1252-example.txt
    │   ├── non-breaking-spaces.txt
    │   ├── pre.txt
    │   ├── table.txt
    │   ├── lists.txt
    │   ├── nested-divs.txt
    │   ├── msoffice.txt
    │   ├── basic.no-links.txt
    │   ├── basic.txt
    │   ├── more-anchors.txt
    │   ├── anchors.no-links.txt
    │   ├── anchors.txt
    │   ├── images.txt
    │   ├── newlines.txt
    │   ├── blockquotes.txt
    │   └── full_email.txt
    ├── failures
    │   └── .gitignore
    └── Html2TextTest.php
├── .gitignore
├── phpstan.neon.dist
├── phpunit.xml
├── src
    ├── Html2TextException.php
    └── Html2Text.php
├── .github
    └── workflows
    │   ├── lint.yml
    │   └── test.yml
├── html2text.php
├── .editorconfig
├── convert.php
├── composer.json
├── LICENSE.md
├── CHANGELOG.md
└── README.md


/tests/html/empty.html:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/tests/txt/empty.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/tests/txt/dom-processing.txt:
--------------------------------------------------------------------------------
1 | Hello


--------------------------------------------------------------------------------
/tests/html/test3.html:
--------------------------------------------------------------------------------
1 | test one<br />test two


--------------------------------------------------------------------------------
/tests/txt/invalid.txt:
--------------------------------------------------------------------------------
1 | Hello &nbsnbsp; world


--------------------------------------------------------------------------------
/tests/txt/test3.txt:
--------------------------------------------------------------------------------
1 | test one
2 | test two


--------------------------------------------------------------------------------
/tests/txt/utf8-example.txt:
--------------------------------------------------------------------------------
1 | - ÅÄÖ
2 | - åäö


--------------------------------------------------------------------------------
/tests/txt/zero-width-non-joiners.txt:
--------------------------------------------------------------------------------
1 | foobar


--------------------------------------------------------------------------------
/tests/txt/test4.txt:
--------------------------------------------------------------------------------
1 | 1
2 | 2
3 | 3
4 | 4
5 | 5 < 6


--------------------------------------------------------------------------------
/tests/txt/nbsp.txt:
--------------------------------------------------------------------------------
1 | hello world & people < > &NBSP;


--------------------------------------------------------------------------------
/tests/txt/windows-1252-example.txt:
--------------------------------------------------------------------------------
1 | - ÅÄÖ
2 | - åäö


--------------------------------------------------------------------------------
/tests/html/test4.html:
--------------------------------------------------------------------------------
1 | 1<br />2<br />3<br />4<br />5 &lt; 6


--------------------------------------------------------------------------------
/tests/html/zero-width-non-joiners.html:
--------------------------------------------------------------------------------
1 | <p>foo&zwnj;bar</p>
2 | 


--------------------------------------------------------------------------------
/tests/txt/non-breaking-spaces.txt:
--------------------------------------------------------------------------------
1 | these spaces are non-breaking


--------------------------------------------------------------------------------
/tests/html/nbsp.html:
--------------------------------------------------------------------------------
1 | hello &nbsp; world &amp; people &lt; &gt; &NBSP;


--------------------------------------------------------------------------------
/tests/html/non-breaking-spaces.html:
--------------------------------------------------------------------------------
1 | these spaces are non-breaking


--------------------------------------------------------------------------------
/tests/html/utf8-example.html:
--------------------------------------------------------------------------------
1 | <ul>
2 |   <li>ÅÄÖ</li>
3 |   <li>åäö</li>
4 | </ul>
5 | 


--------------------------------------------------------------------------------
/tests/html/invalid.html:
--------------------------------------------------------------------------------
1 | <b>Hello &nbsnbsp; world</b>
2 | <div class=">
3 | 	Error
4 | </div>


--------------------------------------------------------------------------------
/tests/html/dom-processing.html:
--------------------------------------------------------------------------------
1 | <html>
2 | <body>
3 | <?a
4 | I am a random piece of code
5 | ?>
6 | Hello
7 | </body>
8 | </html>


--------------------------------------------------------------------------------
/tests/txt/pre.txt:
--------------------------------------------------------------------------------
1 | Here is the code
2 | 
3 | #include <stdlib.h>
4 | #include <stdio.h>
5 | 
6 | int main(){
7 | 	return 0;
8 | };


--------------------------------------------------------------------------------
/tests/txt/table.txt:
--------------------------------------------------------------------------------
1 | Hello, World!
2 | 
3 | Col A	Col B
4 | Data A1	Data B1
5 | Data A2	Data B2
6 | Data A3	Data B4
7 | Total A	Total B


--------------------------------------------------------------------------------
/tests/html/windows-1252-example.html:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/protonmail/html2text/convert-document-2/tests/html/windows-1252-example.html


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | tests/*.output
2 | *.sublime-project
3 | *.sublime-workspace
4 | vendor/
5 | **/*.DS_Store
6 | .phpunit.result.cache
7 | composer.lock
8 | 


--------------------------------------------------------------------------------
/tests/failures/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore everything
2 | *
3 | 
4 | # But not these files...
5 | !.gitignore
6 | 
7 | # ...even if they are in subdirectories
8 | !*/
9 | 


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
1 | parameters:
2 | 	level: 6
3 | 	errorFormat: raw
4 | 	editorUrl: '%%file%% %%line%% %%column%%: %%error%%'
5 | 	paths:
6 | 		- src
7 | 		- tests
8 | 


--------------------------------------------------------------------------------
/tests/html/pre.html:
--------------------------------------------------------------------------------
 1 | Here is the code
 2 | <pre>
 3 | #include &lt;stdlib.h&gt;
 4 | #include &lt;stdio.h&gt;
 5 | 
 6 | int main(){
 7 | 	return 0;
 8 | };
 9 | 
10 | </pre>


--------------------------------------------------------------------------------
/tests/txt/lists.txt:
--------------------------------------------------------------------------------
 1 | List tests
 2 | 
 3 | Add some lists.
 4 | 
 5 | - one
 6 | - two
 7 | - three
 8 | 
 9 | An unordered list
10 | 
11 | - one
12 | - two
13 | - three
14 | 
15 | - one
16 | - two
17 | - three


--------------------------------------------------------------------------------
/tests/txt/nested-divs.txt:
--------------------------------------------------------------------------------
 1 | Just two divs
 2 | Hanging out
 3 | Nested divs and line breaks
 4 | 
 5 | Nested divs and line breaks
 6 | More text
 7 | 
 8 | Just text
 9 | Just text
10 | Just text
11 | 
12 | This is the end!


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 | <phpunit stopOnFailure="true" stopOnError="true" beStrictAboutTestsThatDoNotTestAnything="false">
2 | 	<testsuites>
3 | 		<testsuite name="Tests">
4 | 			<!-- loads all *Test.php -->
5 | 			<directory>tests</directory>
6 | 		</testsuite>
7 | 	</testsuites>
8 | </phpunit>
9 | 


--------------------------------------------------------------------------------
/tests/txt/msoffice.txt:
--------------------------------------------------------------------------------
 1 | Dear html2text,
 2 | 
 3 | This is an example email that can be used to test html2text conversion of outlook / exchange emails.
 4 | 
 5 | The addition of <o:p> tags is very annoying!
 6 | This is a single line return
 7 | 
 8 | This is bold
 9 | This is italic
10 | This is underline
11 | 
12 | Andrew


--------------------------------------------------------------------------------
/tests/txt/basic.no-links.txt:
--------------------------------------------------------------------------------
 1 | Hello, World!
 2 | 
 3 | This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.
 4 | 
 5 | Even mismatched tags.
 6 | 
 7 | A div
 8 | Another div
 9 | A div
10 | within a div
11 | 
12 | Another line
13 | Yet another line
14 | 
15 | A link


--------------------------------------------------------------------------------
/tests/txt/basic.txt:
--------------------------------------------------------------------------------
 1 | Hello, World!
 2 | 
 3 | This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.
 4 | 
 5 | Even mismatched tags.
 6 | 
 7 | A div
 8 | Another div
 9 | A div
10 | within a div
11 | 
12 | Another line
13 | Yet another line
14 | 
15 | [A link](http://foo.com)


--------------------------------------------------------------------------------
/tests/txt/more-anchors.txt:
--------------------------------------------------------------------------------
1 | Anchor tests
2 | 
3 | Visit http://openiaml.org or openiaml.org or http://openiaml.org.
4 | 
5 | To visit with SSL, visit https://openiaml.org or openiaml.org or https://openiaml.org.
6 | 
7 | To mail, email support@openiaml.org or mailto:support@openiaml.org or support@openiaml.org or mailto:support@openiaml.org.


--------------------------------------------------------------------------------
/tests/html/lists.html:
--------------------------------------------------------------------------------
 1 | <h1>List tests</h1>
 2 | 
 3 | <p>
 4 | Add some lists.
 5 | </p>
 6 | 
 7 | <ol>
 8 | 	<li>one</li>
 9 | 	<li>two
10 | 	<li>three
11 | </ol>
12 | 
13 | <h2>An unordered list</h2>
14 | 
15 | <ul>
16 | 	<li>one
17 | 	<li>two</li>
18 | 	<li>three</li>	
19 | </ul>
20 | <ul>
21 | 	<li>one
22 | 	<li>two</li>
23 | 	<li>three</li>	
24 | </ul>


--------------------------------------------------------------------------------
/tests/txt/anchors.no-links.txt:
--------------------------------------------------------------------------------
1 | A document without any HTML open/closing tags.
2 | ---------------------------------------------------------------
3 | We try and use the representation given by common browsers of the HTML document, so that it looks similar when converted to plain text. visit foo.com - or http://www.foo.com link
4 | 
5 | An anchor which will not appear


--------------------------------------------------------------------------------
/src/Html2TextException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Soundasleep;
 4 | 
 5 | class Html2TextException extends \Exception {
 6 | 
 7 | 	/** @var string $more_info */
 8 | 	public $more_info;
 9 | 
10 | 	public function __construct(string $message = "", string $more_info = "") {
11 | 		parent::__construct($message);
12 | 		$this->more_info = $more_info;
13 | 	}
14 | 
15 | }
16 | 


--------------------------------------------------------------------------------
/tests/txt/anchors.txt:
--------------------------------------------------------------------------------
1 | A document without any HTML open/closing tags.
2 | ---------------------------------------------------------------
3 | We try and use the representation given by common browsers of the HTML document, so that it looks similar when converted to plain text. [visit foo.com](http://foo.com) - or http://www.foo.com [link](http://foo.com)
4 | 
5 | [An anchor which will not appear]


--------------------------------------------------------------------------------
/tests/html/nested-divs.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <body>
 3 | <div>
 4 | Just two divs
 5 | </div>
 6 | <div>
 7 | Hanging out
 8 | </div>
 9 | <div><div><div>Nested divs and line breaks</div></div><br></div>
10 | <div><div>Nested divs and line breaks</div>More text<br></div>
11 | <div><br></div>
12 | <div>Just text</div>
13 | <div>Just text<br></div>
14 | <div>Just text<br><br></div>
15 | This is the end!
16 | </body>
17 | </html>
18 | 


--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
 1 | name: Lint
 2 | on:
 3 |   - push
 4 | jobs:
 5 |   lint:
 6 |     name: Lint
 7 |     runs-on: ubuntu-latest
 8 |     steps:
 9 |       - name: Checkout
10 |         uses: actions/checkout@v3
11 |       - name: Setup PHP
12 |         uses: shivammathur/setup-php@v2
13 |         with:
14 |           php-version: '7.4'
15 |           tools: phplint
16 |       - name: Check syntax
17 |         run: phplint .
18 | 


--------------------------------------------------------------------------------
/tests/txt/images.txt:
--------------------------------------------------------------------------------
 1 | One:
 2 | 
 3 | Two: [two]
 4 | 
 5 | Three: [three]
 6 | 
 7 | Four: [four]
 8 | 
 9 | With links
10 | 
11 | One: http://localhost
12 | 
13 | Two: [two](http://localhost)
14 | 
15 | Three: [three](http://localhost)
16 | 
17 | Four: [four](http://localhost)
18 | 
19 | With links with titles
20 | 
21 | One: [one link](http://localhost)
22 | 
23 | Two: [two link](http://localhost)
24 | 
25 | Three: [three link](http://localhost)
26 | 
27 | Four: [four link](http://localhost)


--------------------------------------------------------------------------------
/tests/html/anchors.html:
--------------------------------------------------------------------------------
 1 | A document without any HTML open/closing tags.
 2 | 
 3 | <hr>
 4 | 
 5 | We try and use the representation given by common browsers of the 
 6 | HTML document, so that it looks similar when converted to plain text.
 7 | 
 8 | <a href="http://foo.com">visit foo.com</a> - or <a href="http://www.foo.com">http://www.foo.com</a>
 9 | 
10 | <a href="http://foo.com" title="a link with a title">link</a>
11 | 
12 | <h2><a name="anchor">An anchor which will not appear</a></h2>
13 | 


--------------------------------------------------------------------------------
/html2text.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * This file is available if you still want to use functions rather than
 4 |  * autoloading classes.
 5 |  */
 6 | 
 7 | require_once(__DIR__ . "/src/Html2Text.php");
 8 | require_once(__DIR__ . "/src/Html2TextException.php");
 9 | 
10 | function convert_html_to_text($html, $ignore_error = false) {
11 | 	return Soundasleep\Html2Text::convert($html, $ignore_error);
12 | }
13 | 
14 | function fix_newlines($text) {
15 | 	return Soundasleep\Html2Text::fixNewlines($text);
16 | }
17 | 


--------------------------------------------------------------------------------
/tests/html/basic.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <title>Ignored Title</title>
 3 | <body>
 4 |   <h1>Hello, World!</h1>
 5 | 
 6 |   <p>This is some e-mail content.
 7 |   Even though it has whitespace and newlines, the e-mail converter
 8 |   will handle it correctly.
 9 | 
10 |   <p>Even mismatched tags.</p>
11 | 
12 |   <div>A div</div>
13 |   <div>Another div</div>
14 |   <div>A div<div>within a div</div></div>
15 | 
16 |   <p>Another line<br />Yet another line</p>
17 | 
18 |   <a href="http://foo.com">A link</a>
19 | 
20 | </body>
21 | </html>


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | # EditorConfig is awesome: http://EditorConfig.org
 2 | 
 3 | # top-most EditorConfig file
 4 | root = true
 5 | 
 6 | # Unix-style newlines with a newline ending every file
 7 | [*]
 8 | end_of_line = lf
 9 | charset = utf-8
10 | insert_final_newline = true
11 | trim_trailing_whitespace = true
12 | indent_style = tab
13 | indent_size = 4
14 | 
15 | [*.md]
16 | indent_style = space
17 | indent_size = 2
18 | 
19 | # don't add newlines to test files
20 | [tests/*]
21 | indent_style = tabs
22 | trim_trailing_whitespace = false
23 | insert_final_newline = false
24 | 


--------------------------------------------------------------------------------
/tests/txt/newlines.txt:
--------------------------------------------------------------------------------
 1 | Hello
 2 | How are you?
 3 | 
 4 | How are you?
 5 | 
 6 | How are you?
 7 | 
 8 | Just two divs
 9 | Hanging out
10 | This is not the end!
11 | How are you again?
12 | This is the end!
13 | Just kidding
14 | 
15 | Header 1
16 | 
17 | Some text
18 | ---------------------------------------------------------------
19 | Some more text
20 | 
21 | Paragraph tag!
22 | 
23 | Header 2
24 | 
25 | ---------------------------------------------------------------
26 | 
27 | Header 3
28 | 
29 | Some text
30 | 
31 | Header 4
32 | 
33 | Paragraph tag!
34 | 
35 | Final line


--------------------------------------------------------------------------------
/convert.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * This file allows you to convert through the command line.
 4 |  * Usage:
 5 |  *   php -f convert.php [input file]
 6 |  */
 7 | 
 8 | if (count($argv) < 2) {
 9 | 	throw new \InvalidArgumentException("Expected: php -f convert.php [input file]");
10 | }
11 | 
12 | if (!file_exists($argv[1])) {
13 | 	throw new \InvalidArgumentException("'" . $argv[1] . "' does not exist");
14 | }
15 | 
16 | $input = file_get_contents($argv[1]);
17 | 
18 | require_once(__DIR__ . "/src/Html2Text.php");
19 | require_once(__DIR__ . "/src/Html2TextException.php");
20 | 
21 | echo \Soundasleep\Html2Text::convert($input);
22 | 


--------------------------------------------------------------------------------
/tests/html/more-anchors.html:
--------------------------------------------------------------------------------
 1 | <h1>Anchor tests</h1>
 2 | 
 3 | <p>
 4 | Visit http://openiaml.org or <a href="http://openiaml.org">openiaml.org</a> or <a href="http://openiaml.org">http://openiaml.org</a>.
 5 | </p>
 6 | 
 7 | <p>
 8 | To visit with SSL, visit https://openiaml.org or <a href="https://openiaml.org">openiaml.org</a> or <a href="https://openiaml.org">https://openiaml.org</a>.
 9 | </p>
10 | 
11 | <p>
12 | To mail, email support@openiaml.org or mailto:support@openiaml.org
13 | or <a href="mailto:support@openiaml.org">support@openiaml.org</a> or <a href="mailto:support@openiaml.org">mailto:support@openiaml.org</a>.
14 | </p>
15 | 


--------------------------------------------------------------------------------
/tests/html/newlines.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <body>
 3 | <div>
 4 | Hello
 5 | <br>
 6 | </div>
 7 | <div>
 8 | How are you?
 9 | <br>
10 | </div>
11 | 
12 | <p>
13 | How are you?
14 | <br>
15 | </p>
16 | 
17 | <p>
18 | How are you?
19 | <br>
20 | </p>
21 | 
22 | <div>
23 | Just two divs
24 | </div>
25 | <div>
26 | Hanging out
27 | </div>
28 | 
29 | This is not the end!
30 | <div>
31 | How are you again?
32 | <br>
33 | </div>
34 | This is the end!
35 | <br>
36 | Just kidding
37 | <h1>Header 1</h1>
38 | Some text
39 | <hr>
40 | Some more text
41 | <p>Paragraph tag!</p>
42 | <h2>Header 2</h2>
43 | <hr>
44 | <h3>Header 3</h3>
45 | Some text
46 | <h4>Header 4</h4>
47 | <p>Paragraph tag!</p>
48 | Final line
49 | </body>
50 | </html>


--------------------------------------------------------------------------------
/tests/html/blockquotes.html:
--------------------------------------------------------------------------------
 1 | 
 2 | <span>Hello</span>
 3 | <blockquote>
 4 | Nest some block quotes with preformated text
 5 | <blockquote>
 6 | Here is the code
 7 | <pre>
 8 | #include &lt;stdlib.h&gt;
 9 | #include &lt;stdio.h&gt;
10 | 
11 | int main(){
12 | 	return 0;
13 | };
14 | 
15 | </pre>
16 | 
17 | <b>Put some tags</b>
18 | <i>at the end</i>
19 | </blockquote>
20 | 
21 | Some text <span>and tags</span> here
22 | 
23 | <blockquote>
24 | First line
25 | <h1>Header 1</h1>
26 | Some text
27 | <hr>
28 | Some more text
29 | <p>Paragraph tag!</p>
30 | <h2>Header 2</h2>
31 | <hr>
32 | <h3>Header 3</h3>
33 | Some text
34 | <h4>Header 4</h4>
35 | <blockquote>
36 | More quoted text!
37 | </blockquote>
38 | <p>Paragraph tag!</p>
39 | Final line
40 | </blockquote>
41 | </blockquote>
42 | Some ending text
43 | <b>just to make sure</b>


--------------------------------------------------------------------------------
/tests/txt/blockquotes.txt:
--------------------------------------------------------------------------------
 1 | Hello
 2 | 
 3 | > Nest some block quotes with preformated text
 4 | >
 5 | >> Here is the code
 6 | >>
 7 | >> #include <stdlib.h>
 8 | >> #include <stdio.h>
 9 | >>
10 | >> int main(){
11 | >>	return 0;
12 | >> };
13 | >>
14 | >> Put some tags at the end
15 | >
16 | > Some text and tags here
17 | >
18 | >> First line
19 | >>
20 | >> Header 1
21 | >>
22 | >> Some text
23 | >> ---------------------------------------------------------------
24 | >> Some more text
25 | >>
26 | >> Paragraph tag!
27 | >>
28 | >> Header 2
29 | >>
30 | >> ---------------------------------------------------------------
31 | >>
32 | >> Header 3
33 | >>
34 | >> Some text
35 | >>
36 | >> Header 4
37 | >>
38 | >>> More quoted text!
39 | >>
40 | >> Paragraph tag!
41 | >>
42 | >> Final line
43 | 
44 | Some ending text just to make sure


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "soundasleep/html2text",
 3 |   "description": "A PHP script to convert HTML into a plain text format",
 4 |   "type": "library",
 5 |   "keywords": [ "php", "html", "text", "email" ],
 6 |   "homepage": "https://github.com/soundasleep/html2text",
 7 |   "license": "MIT",
 8 |   "authors": [
 9 |     {
10 |       "name": "Jevon Wright",
11 |       "homepage": "https://jevon.org",
12 |       "role": "Developer"
13 |     }
14 |   ],
15 |   "autoload": {
16 |     "psr-4": {
17 |       "Soundasleep\\": "src"
18 |     }
19 |   },
20 |   "support": {
21 |     "email": "support@jevon.org"
22 |   },
23 |   "require": {
24 |     "php": "^7.3|^8.0",
25 |     "ext-dom": "*",
26 |     "ext-libxml": "*"
27 |   },
28 |   "require-dev": {
29 |     "phpunit/phpunit": "^7.0|^8.0|^9.0",
30 |     "phpstan/phpstan": "^1.9"
31 |   }
32 | }
33 | 


--------------------------------------------------------------------------------
/tests/html/table.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <title>Ignored Title</title>
 3 | <body>
 4 |   <h1>Hello, World!</h1>
 5 |   <table>
 6 |     <thead>
 7 |       <tr>
 8 |         <th>Col A</th>
 9 |         <th>Col B</th>
10 |       </tr>
11 |     </thead>
12 |     <tbody>
13 |       <tr>
14 |         <td>
15 |           Data A1
16 |         </td>
17 |         <td>
18 |           Data B1
19 |         </td>
20 |       </tr>
21 |       <tr>
22 |           <td>
23 |             Data A2
24 |           </td>
25 |           <td>
26 |             Data B2
27 |           </td>
28 |       </tr>
29 |       <tr>
30 |         <td>
31 |           Data A3
32 |         </td>
33 |         <td>
34 |           Data B4
35 |         </td>
36 |       </tr>
37 |     </tbody>
38 |     <tfoot>
39 |       <tr>
40 |           <td>
41 |             Total A
42 |           </td>
43 |           <td>
44 |             Total B
45 |           </td>
46 |        </tr>
47 | 
48 |     </tfoot>
49 | 
50 |   </table>
51 | 
52 | </body>
53 | </html>


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 Jevon Wright
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/tests/html/images.html:
--------------------------------------------------------------------------------
 1 | <body>
 2 |   <p>
 3 |     One: <img src="one.png">
 4 |   </p>
 5 | 
 6 |   <p>
 7 |     Two: <img src="two.png" alt="two">
 8 |   </p>
 9 | 
10 |   <p>
11 |     Three: <img src="three.png" title="three">
12 |   </p>
13 | 
14 |   <p>
15 |     Four: <img src="four.png" title="four" alt="four alt">
16 |   </p>
17 | 
18 |   <h1>With links</h1>
19 | 
20 |   <p>
21 |     One: <a href="http://localhost"><img src="one.png"></a>
22 |   </p>
23 | 
24 |   <p>
25 |     Two: <a href="http://localhost"><img src="two.png" alt="two"></a>
26 |   </p>
27 | 
28 |   <p>
29 |     Three: <a href="http://localhost"><img src="three.png" title="three"></a>
30 |   </p>
31 | 
32 |   <p>
33 |     Four: <a href="http://localhost"><img src="four.png" title="four" alt="four alt"></a>
34 |   </p>
35 | 
36 |   <h1>With links with titles</h1>
37 | 
38 |   <p>
39 |     One: <a href="http://localhost" title="one link"><img src="one.png"></a>
40 |   </p>
41 | 
42 |   <p>
43 |     Two: <a href="http://localhost" title="two link"><img src="two.png" alt="two"></a>
44 |   </p>
45 | 
46 |   <p>
47 |     Three: <a href="http://localhost" title="three link"><img src="three.png" title="three"></a>
48 |   </p>
49 | 
50 |   <p>
51 |     Four: <a href="http://localhost" title="four link"><img src="four.png" title="four" alt="four alt"></a>
52 |   </p>
53 | </body>
54 | </html>


--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
 1 | name: Test
 2 | on:
 3 |   - push
 4 | jobs:
 5 |   test:
 6 |     strategy:
 7 |       matrix:
 8 |         operating-system:
 9 |           - ubuntu-latest
10 |         php-version:
11 |           - '7.3'
12 |           - '7.4'
13 |           - '8.0'
14 |           - '8.1'
15 |           - '8.2'
16 |     name: php ${{ matrix.php-version }} on ${{ matrix.operating-system }}
17 |     runs-on: ${{ matrix.operating-system }}
18 |     steps:
19 |       - name: Checkout
20 |         uses: actions/checkout@v3
21 |       - name: Setup PHP
22 |         uses: shivammathur/setup-php@v2
23 |         with:
24 |           php-version: ${{ matrix.php-version }}
25 |           extensions: mbstring
26 |           coverage: none
27 |       - name: Get composer cache directory
28 |         id: composer-cache
29 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
30 |       - name: Setup composer cache
31 |         uses: actions/cache@v3
32 |         with:
33 |           path: ${{ steps.composer-cache.outputs.dir }}
34 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
35 |           restore-keys: ${{ runner.os }}-composer-
36 |       - name: Install composer dependencies
37 |         env:
38 |           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
39 |         run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
40 |       - name: Run tests
41 |         run: vendor/bin/phpunit
42 | 


--------------------------------------------------------------------------------
/tests/txt/full_email.txt:
--------------------------------------------------------------------------------
 1 | http://localhost/home	16 December 2015
 2 | Account 123
 3 | 
 4 | Hi Susan
 5 | 
 6 | Here is your cat report.
 7 | 
 8 | You have found 5 cats less than anyone else
 9 | [Find more cats](http://localhost/cats)
10 | 
11 | Down the road
12 | 
13 | Across the hall
14 | 
15 | Your achievements
16 | 
17 | You're currently finding about
18 | 12 cats
19 | per day
20 | 
21 | [Number of cats found]
22 | ---------------------------------------------------------------
23 | 
24 | Your last cat was found two days ago.
25 | 
26 | One type of cat is a kitten.
27 | 
28 | Special account  A1
29 | 
30 | 12.345
31 | 
32 | http://localhost/logout
33 | 
34 | How can you find more cats?
35 | 
36 | Look in trash cans
37 | 
38 | Start meowing
39 | 
40 | Eat cat food
41 | 
42 | Some cats like to hang out in trash cans. Some cats do not.	Some cats are attracted to similar tones.	So one day your tears may smell like cat food, attracting more cats.
43 | https://localhost/about	https://localhost/about	https://localhost/about
44 | [Cats are great.](https://github.com/soundasleep/html2text_ruby)	[Find more cats.](https://github.com/soundasleep/html2text_ruby)	[Do more things.](https://github.com/soundasleep/html2text_ruby)
45 | 
46 | [Contact us](http://localhost/contact)
47 | 
48 | cats@cats.com
49 | Monday and Friday
50 | 
51 | https://github.com/soundasleep/html2text https://github.com/soundasleep/html2text_ruby
52 | 
53 | Having trouble seeing this email? [View it online](http://localhost/view_it_online).


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | All notable changes to this project will be documented in this file.
 3 | 
 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 6 | 
 7 | ## [Unreleased]
 8 | 
 9 | ## [1.1.0] - 2019-02-15
10 | ### Added
11 | - Zero-width non-joiners are now stripped to prevent output issues, similar to non-breaking whitespace
12 | 
13 | ### Fixed
14 | - Fix namespace in composer [#67](https://github.com/soundasleep/html2text/pull/67)
15 | 
16 | ## [1.0.0] - 2019-02-14
17 | ### Added
18 | - Added `drop_links` option to render links without the target href [#65](https://github.com/soundasleep/html2text/pull/65)
19 | 
20 | ### Changed
21 | - **Important:** Changed namespace from `\Html2Text\Html2Text` to `\Soundasleep\Html2text` [#45](https://github.com/soundasleep/html2text/issues/45)
22 | - Treat non-breaking spaces consistently: never include them in output text [#64](https://github.com/soundasleep/html2text/pull/64)
23 | - Second argument to `convert()` is now an array, rather than boolean [#65](https://github.com/soundasleep/html2text/pull/65)
24 | - Optimise/improve newline & whitespace handling [#47](https://github.com/soundasleep/html2text/pull/47)
25 | - Upgrade PHP support to PHP 7.3+
26 | - Upgrade PHPUnit to 7.x
27 | - Re-release project under MIT license [#58](https://github.com/soundasleep/html2text/issues/58)
28 | 
29 | ## [0.5.0] - 2017-04-20
30 | ### Added
31 | - Add ignore_error optional argument [#63](https://github.com/soundasleep/html2text/pull/63)
32 | - Blockquote support [#50](https://github.com/soundasleep/html2text/pull/50)
33 | 
34 | [Unreleased]: https://github.com/soundasleep/html2text/compare/1.1.0...HEAD
35 | [1.1.0]: https://github.com/soundasleep/html2text/compare/1.0.0...1.1.0
36 | [1.0.0]: https://github.com/soundasleep/html2text/compare/0.5.0...1.0.0
37 | [0.5.0]: https://github.com/soundasleep/html2text/compare/0.5.0...0.3.4
38 | 


--------------------------------------------------------------------------------
/tests/html/msoffice.html:
--------------------------------------------------------------------------------
1 | <html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii"><meta name=Generator content="Microsoft Word 15 (filtered medium)"><style><!-- /* Font Definitions */ @font-face {font-family:"Cambria Math"; panose-1:2 4 5 3 5 4 6 3 2 4;} @font-face {font-family:Calibri; panose-1:2 15 5 2 2 2 4 3 2 4;} /* Style Definitions */ p.MsoNormal, li.MsoNormal, div.MsoNormal {margin:0cm; margin-bottom:.0001pt; font-size:11.0pt; font-family:"Calibri",sans-serif; mso-fareast-language:EN-US;} a:link, span.MsoHyperlink {mso-style-priority:99; color:#0563C1; text-decoration:underline;} a:visited, span.MsoHyperlinkFollowed {mso-style-priority:99; color:#954F72; text-decoration:underline;} span.EmailStyle17 {mso-style-type:personal-compose; font-family:"Calibri",sans-serif; color:windowtext;} .MsoChpDefault {mso-style-type:export-only; font-family:"Calibri",sans-serif; mso-fareast-language:EN-US;} @page WordSection1 {size:612.0pt 792.0pt; margin:72.0pt 72.0pt 72.0pt 72.0pt;} div.WordSection1 {page:WordSection1;} --></style><!--[if gte mso 9]><xml> <o:shapedefaults v:ext="edit" spidmax="1026" /> </xml><![endif]--><!--[if gte mso 9]><xml> <o:shapelayout v:ext="edit"> <o:idmap v:ext="edit" data="1" /> </o:shapelayout></xml><![endif]--></head><body lang=EN-GB link="#0563C1" vlink="#954F72"><div class=WordSection1><p class=MsoNormal>Dear html2text,<o:p></o:p></p><p class=MsoNormal><o:p>&nbsp;</o:p></p><p class=MsoNormal>This is an example email that can be used to test html2text conversion of outlook / exchange emails.<o:p></o:p></p><p class=MsoNormal><o:p>&nbsp;</o:p></p><p class=MsoNormal>The addition of &lt;o:p&gt; tags is very annoying!<o:p></o:p></p><p class=MsoNormal>This is a single line return<o:p></o:p></p><p class=MsoNormal><o:p>&nbsp;</o:p></p><p class=MsoNormal><b>This is bold<o:p></o:p></b></p><p class=MsoNormal><i>This is italic<o:p></o:p></i></p><p class=MsoNormal><u>This is underline<o:p></o:p></u></p><p class=MsoNormal><o:p>&nbsp;</o:p></p><p class=MsoNormal>Andrew<o:p></o:p></p></div></body></html>


--------------------------------------------------------------------------------
/tests/Html2TextTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require(__DIR__ . "/../src/Html2Text.php");
 4 | 
 5 | class Html2TextTest extends \PHPUnit\Framework\TestCase {
 6 | 
 7 | 	// delete all failures before we run
 8 | 	public static function setUpBeforeClass(): void {
 9 | 		foreach (new DirectoryIterator(__DIR__ . '/failures') as $fileInfo) {
10 | 			if ($fileInfo->getFileName()[0] != '.') {
11 | 				unlink($fileInfo->getPathname());
12 | 			}
13 | 		}
14 | 	}
15 | 
16 | 	/**
17 | 	 * @dataProvider providerFiles
18 | 	 */
19 | 	public function testFile(string $test): void {
20 | 		$this->doTestWithResults($test, $test, []);
21 | 	}
22 | 
23 | 	/** @param bool | array<string, bool | string> $options */
24 | 	function doTestWithResults(string $test, string $result, $options = []): void {
25 | 		$html = __DIR__ . "/html/$test.html";
26 | 		$txt = __DIR__ . "/txt/$result.txt";
27 | 		$this->assertTrue(file_exists($html), "File '{$html}' does not exist");
28 | 		$this->assertTrue(file_exists($txt), "File '{$txt}' does not exist");
29 | 		$input = file_get_contents($html);
30 | 		$expected = \Soundasleep\Html2Text::fixNewlines(file_get_contents($txt));
31 | 
32 | 		$output = \Soundasleep\Html2Text::convert($input, $options);
33 | 
34 | 		if ($output != $expected) {
35 | 			file_put_contents(__DIR__ . "/failures/$result.output", $output);
36 | 		}
37 | 		$this->assertEquals($expected, $output, "{$html} file failed to convert to {$txt}");
38 | 	}
39 | 
40 | 	/** @return array<array<string>> */
41 | 	public function providerFiles(): array {
42 | 		return [
43 | 			['basic'],
44 | 			['anchors'],
45 | 			['more-anchors'],
46 | 			['test3'],
47 | 			['test4'],
48 | 			['table'],
49 | 			['nbsp'],
50 | 			['lists'],
51 | 			['pre'],
52 | 			['newlines'],
53 | 			['nested-divs'],
54 | 			['blockquotes'],
55 | 			['full_email'],
56 | 			['images'],
57 | 			['non-breaking-spaces'],
58 | 			['utf8-example'],
59 | 			['msoffice'],
60 | 			['dom-processing'],
61 | 			['empty'],
62 | 			['huge-msoffice'],
63 | 			['zero-width-non-joiners'],
64 | 		];
65 | 	}
66 | 
67 | 	public function testInvalidXML(): void {
68 | 		$this->expectWarning();
69 | 		$this->doTestWithResults("invalid", "invalid", ['ignore_errors' => false]);
70 | 	}
71 | 
72 | 	public function testInvalidXMLIgnore(): void {
73 | 		$this->doTestWithResults("invalid", "invalid", ['ignore_errors' => true]);
74 | 	}
75 | 
76 | 	public function testInvalidXMLIgnoreOldSyntax(): void {
77 | 		// for BC, allow old #convert(text, bool) syntax
78 | 		$this->doTestWithResults("invalid", "invalid", true);
79 | 	}
80 | 
81 | 	public function testInvalidOption(): void {
82 | 		$this->expectException(InvalidArgumentException::class);
83 | 		$this->doTestWithResults("basic", "basic", ['invalid_option' => true]);
84 | 	}
85 | 
86 | 	public function testBasicDropLinks(): void {
87 | 		$this->doTestWithResults("basic", "basic.no-links", ['drop_links' => true]);
88 | 	}
89 | 
90 | 	public function testAnchorsDropLinks(): void {
91 | 		$this->doTestWithResults("anchors", "anchors.no-links", ['drop_links' => true]);
92 | 	}
93 | 
94 | 	public function testWindows1252(): void {
95 | 		$this->doTestWithResults("windows-1252-example", "windows-1252-example", ['char_set' => 'windows-1252']);
96 | 	}
97 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ![example workflow](https://github.com/soundasleep/html2text/actions/workflows/test.yml/badge.svg) [![Total Downloads](https://poser.pugx.org/soundasleep/html2text/downloads.png)](https://packagist.org/packages/soundasleep/html2text)
  2 | =========
  3 | 
  4 | html2text is a very simple script that uses DOM methods to convert HTML into a format similar to what would be
  5 | rendered by a browser - perfect for places where you need a quick text representation. For example:
  6 | 
  7 | ```html
  8 | <html>
  9 | <title>Ignored Title</title>
 10 | <body>
 11 |   <h1>Hello, World!</h1>
 12 | 
 13 |   <p>This is some e-mail content.
 14 |   Even though it has whitespace and newlines, the e-mail converter
 15 |   will handle it correctly.
 16 | 
 17 |   <p>Even mismatched tags.</p>
 18 | 
 19 |   <div>A div</div>
 20 |   <div>Another div</div>
 21 |   <div>A div<div>within a div</div></div>
 22 | 
 23 |   <a href="http://foo.com">A link</a>
 24 | 
 25 | </body>
 26 | </html>
 27 | ```
 28 | 
 29 | Will be converted into:
 30 | 
 31 | ```text
 32 | Hello, World!
 33 | 
 34 | This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.
 35 | 
 36 | Even mismatched tags.
 37 | 
 38 | A div
 39 | Another div
 40 | A div
 41 | within a div
 42 | 
 43 | [A link](http://foo.com)
 44 | ```
 45 | 
 46 | See the [original blog post](http://journals.jevon.org/users/jevon-phd/entry/19818) or the related [StackOverflow answer](http://stackoverflow.com/a/2564472/39531).
 47 | 
 48 | ## Installing
 49 | 
 50 | You can use [Composer](http://getcomposer.org/) to add the [package](https://packagist.org/packages/soundasleep/html2text) to your project:
 51 | 
 52 | ```json
 53 | {
 54 |   "require": {
 55 |     "soundasleep/html2text": "~1.1"
 56 |   }
 57 | }
 58 | ```
 59 | 
 60 | And then use it quite simply:
 61 | 
 62 | ```php
 63 | $text = \Soundasleep\Html2Text::convert($html);
 64 | ```
 65 | 
 66 | You can also include the supplied `html2text.php` and use `$text = convert_html_to_text($html);` instead.
 67 | 
 68 | ### Options
 69 | 
 70 | | Option | Default | Description |
 71 | |--------|---------|-------------|
 72 | | **ignore_errors** | `false` | Set to `true` to ignore any XML parsing errors. |
 73 | | **drop_links** | `false` | Set to `true` to not render links as `[http://foo.com](My Link)`, but rather just `My Link`. |
 74 | | **char_set** | `'auto'` | Specify a specific character set.  Pass multiple character sets (comma separated) to detect encoding, default is ASCII,UTF-8 |
 75 | 
 76 | Pass along options as a second argument to `convert`, for example:
 77 | 
 78 | ```php
 79 | $options = array(
 80 |   'ignore_errors' => true,
 81 |   // other options go here
 82 | );
 83 | $text = \Soundasleep\Html2Text::convert($html, $options);
 84 | ```
 85 | 
 86 | ## Tests
 87 | 
 88 | Some very basic tests are provided in the `tests/` directory. Run them with `composer install && vendor/bin/phpunit`.
 89 | 
 90 | ## Troubleshooting
 91 | 
 92 | ### Class 'DOMDocument' not found
 93 | 
 94 | You need to [install the PHP XML extension](https://github.com/soundasleep/html2text/issues/55) for your PHP version. e.g. `apt-get install php7.4-xml`
 95 | 
 96 | ## License
 97 | 
 98 | `html2text` is [licensed under MIT](LICENSE.md), making it suitable for both Eclipse and GPL projects.
 99 | 
100 | ## Other versions
101 | 
102 | Also see [html2text_ruby](https://github.com/soundasleep/html2text_ruby), a Ruby implementation.
103 | 


--------------------------------------------------------------------------------
/tests/html/full_email.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  2 | <html xmlns="http://www.w3.org/1999/xhtml">
  3 |   <head>
  4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5 |     <meta name="viewport" content="width=680">
  6 |   </head>
  7 |   <body class="cat-update-email cat-update" style="background: #ffccee; color: blue; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; text-align: center" bgcolor="#ffccee">
  8 | <style type="text/css">
  9 | body.cat-update-email {
 10 | margin: 0; padding: 0; background: #ffccee; color: blue; text-align: center;
 11 | }
 12 | body.cat-update-email {
 13 | font-size: 12px; font-family: Times New Roman; font-weight: normal;
 14 | }
 15 | body.cat-update-email th {
 16 | font-size: 12px; font-family: Times New Roman; font-weight: normal;
 17 | }
 18 | body.cat-update-email td {
 19 | font-size: 12px; font-family: Times New Roman; font-weight: normal;
 20 | }
 21 | </style>
 22 |     <table class="header-wrapper" style="border-spacing: 0; border: none; margin: 0; width: 100%">
 23 |       <tr>
 24 |         <td class="header" style="background: none; color: #999; font-family: Times New Roman; font-size: 12px; font-weight: normal; padding: 15px 0">
 25 |           <table cellspacing="0" cellpadding="0" border="0" style="margin: 0 auto; padding: 0 20px; width: 640px">
 26 |             <tr>
 27 |               <th style="font-family: Times New Roman; font-size: 12px; font-weight: normal">
 28 |                 <a class="logo" href="http://localhost/home" style="color: red; text-decoration: none">
 29 |                   <img border="0" height="32" src="test.png" width="200" style="display: block">
 30 | </a>              </th>
 31 |               <td class="account-number" style="color: white; font-family: Times New Roman; font-size: 12px; font-weight: normal; text-align: right" align="right">
 32 |                 16 December 2015<br>
 33 |                 Account 123
 34 |               </td>
 35 |             </tr>
 36 |           </table>
 37 |         </td>
 38 |       </tr>
 39 |     </table>
 40 | 
 41 |     <table class="section-wrapper" style="border-spacing: 0; border: none; margin: 0 auto 20px; width: 640px">
 42 |       <tr>
 43 |         <td class="salutation section" style="background: white; color: black; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0 auto 20px; padding: 40px 20px; text-align: left; width: 600px" align="left" bgcolor="white">
 44 |             <h1 class="user_greeting" style="font-family: Times New Roman; font-size: 1.8; font-weight: normal; line-height: 1.2; margin: 0 0 1em">
 45 |     Hi Susan
 46 |   </h1>
 47 |   <p class="message" style="font-size: 1.5em; line-height: 1.2; margin: 0">
 48 |       Here is your cat report.
 49 |   </p>
 50 | 
 51 |         </td>
 52 |       </tr>
 53 |     </table>
 54 | 
 55 | 
 56 | 
 57 | 
 58 | <table class="section-wrapper" style="border-spacing: 0; border: none; margin: 0 auto 20px; width: 640px">
 59 |   <tr>
 60 |     <td class="balance section" style="background: white; color: black; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0 auto 20px; padding: 40px 20px; text-align: left; width: 600px" align="left" bgcolor="white">
 61 |       <div class="account-status-heading" style="font-size: 2.5em; line-height: 1em; padding: 30px 20px; text-align: center" align="center">You have found <span class="status-cats-negative" style="color: #df0000">5 cats</span> less than anyone else</div>
 62 | 
 63 |       <div id="cat-update-action-buttons">
 64 |         <div id="buy-button" style="text-align: center" align="center">
 65 |           <a class="btn-alert" href="http://localhost/cats" id="buy-cats-button" style="-moz-appearance: none; -webkit-appearance: none; background: #DF0000; border-radius: 3px; border: 11px solid #df0000; color: #fff; cursor: pointer; display: block; font-size: 16px; height: 16px; line-height: 16px; margin: 0 auto; text-decoration: none; transition: background-color .15s; width: 120px">Find more cats</a>
 66 |         </div>
 67 |       </div>
 68 |     </td>
 69 |   </tr>
 70 | </table>
 71 | 
 72 | <table class="section-wrapper" style="border-spacing: 0; border: none; margin: 0 auto 20px; width: 640px">
 73 |   <tr>
 74 |     <td class="cats section" id="cats" style="background: white; color: black; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0 auto 20px; padding: 40px 20px; text-align: left; width: 600px" align="left" bgcolor="white">
 75 |       <div class="cats-usage">
 76 |   <h2 style="font-family: Times New Roman; font-size: 1.8; font-weight: normal; line-height: 1.2; margin: 0">Down the road</h2>
 77 |   <p class="fine-print" style="margin: 0">Across the hall</p>
 78 | 
 79 |   <h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 10px 0 0">Your achievements</h3>
 80 |   <table class="current-usage with-icon-left" style="border-collapse: collapse; border-spacing: 0; margin-bottom: 20px; margin-top: 20px; width: 100%">
 81 |     <tr>
 82 |       <th style="border: none; font-family: Times New Roman; font-size: 14px; font-weight: bold; margin: 0; padding: 0; text-align: left; vertical-align: middle; width: 50px" align="left" valign="middle"><img src="test.png"></th>
 83 |       <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; vertical-align: top; width: 550px" valign="top">
 84 |         <div class="top">You're currently finding about</div>
 85 |         <div class="large" style="color: black; font-size: 18px; padding: 4px 0">12 cats</div>
 86 |         <div class="bottom">per day</div>
 87 |       </td>
 88 |     </tr>
 89 |     <tr><td colspan="2" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; vertical-align: top; width: 550px" valign="top"> </td></tr>
 90 |     <tr>
 91 |       <td colspan="2" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; vertical-align: top; width: 550px" valign="top"><img alt="Number of cats found" src="test.png"></td>
 92 |     </tr>
 93 |   </table>
 94 | </div>
 95 | 
 96 | 
 97 |         <div class="summary">
 98 |   <hr class="fine-print" style="border-bottom-color: #eee; border-bottom-style: solid; border-width: 0 0 1px; margin: 20px 0">
 99 | 
100 |   <h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 10px 0 0">Your last cat was found two days ago.</h3>
101 |   <p class="fine-print" style="margin: 0">One type of cat is a kitten.</p>
102 | 
103 |   <table class="readings" style="border-collapse: collapse; border-spacing: 0; margin: 10px 0; width: 100%">
104 |       <tr style="color: #BD236C">
105 |         <td class="left-column" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; width: 5%">
106 |           <img src="test.png" style="padding-top: 10px">
107 |         </td>
108 |         <td class="center-column" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; width: 60%">
109 |           <h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 10px 0 0">Special account <span class="nickname" style="font-size: 12px"></span> <span class="fine-print">A1</span>
110 | </h3>
111 |         </td>
112 |         <td class="right-column" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0; width: 20%">
113 |           <h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 10px 0 0">12.345</h3>
114 |         </td>
115 |         <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 0"></td>
116 |       </tr>
117 |   </table>
118 | 
119 | </div>
120 | 
121 |     </td>
122 |   </tr>
123 | </table>
124 | 
125 |   <div class="banner" style="margin: 0 auto 20px; padding: 10px; text-align: center; width: 640px" align="center">
126 |     <a href="http://localhost/logout" style="color: red; text-decoration: none">
127 |       <img alt="" border="0" height="177" src="http://localhost/photo1.png" width="600">
128 |     </a>
129 | </div>
130 | 
131 |   <table class="section-wrapper" style="border-spacing: 0; border: none; margin: 0 auto 20px; width: 640px">
132 |     <tr>
133 |       <td class="tips section" style="background: white; color: black; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0 auto 20px; padding: 40px 20px; text-align: left; width: 600px" align="left" bgcolor="white">
134 |         <table style="border-collapse: collapse; border-spacing: 0; width: 100%">
135 |           <tr>
136 |             <td colspan="3" style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top"><h2 style="font-family: Times New Roman; font-size: 1.8; font-weight: normal; line-height: 1.2; margin: 0 0 10px">How can you find more cats?</h2></td>
137 |           </tr>
138 | 
139 |           <tr class="icon">
140 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top"><img height="40" src="http://localhost/photo1.png" width="40"></td>
141 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top"><img height="40" src="http://localhost/photo2.png" width="40"></td>
142 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top"><img height="40" src="http://localhost/photo3.png" width="40"></td>
143 |           </tr>
144 | 
145 |           <tr class="subtitle">
146 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top"><h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 0 0 5px">Look in trash cans</h3></td>
147 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top"><h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 0 0 5px">Start meowing</h3></td>
148 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top"><h3 style="font-family: Times New Roman; font-size: 18px; font-weight: normal; line-height: 2em; margin: 0 0 5px">Eat cat food</h3></td>
149 |           </tr>
150 | 
151 |           <tr class="body" style="color: green">
152 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top">Some cats like to hang out in trash cans. Some cats do not.</td>
153 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">Some cats are attracted to similar tones.</td>
154 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">So one day your tears may smell like cat food, attracting more cats.</td>
155 |           </tr>
156 | 
157 |           <tr class="image">
158 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top">
159 |                   <a href="https://localhost/about" style="color: red; text-decoration: none">
160 |                     <img border="0" height="130" src="http://localhost/photo1.png" style="display: block; margin: 10px 0" width="165">
161 |                   </a>
162 |               </td>
163 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">
164 |                   <a href="https://localhost/about" style="color: red; text-decoration: none">
165 |                     <img border="0" height="130" src="http://localhost/photo2.png" style="display: block; margin: 10px 0" width="165">
166 |                   </a>
167 |               </td>
168 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">
169 |                   <a href="https://localhost/about" style="color: red; text-decoration: none">
170 |                     <img border="0" height="130" src="http://localhost/photo3.png" style="display: block; margin: 10px 0" width="165">
171 |                   </a>
172 |               </td>
173 |           </tr>
174 | 
175 |           <tr class="tips-footer" style="color: green">
176 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0; vertical-align: top; width: 200px" valign="top">
177 |                   <a href="https://github.com/soundasleep/html2text_ruby" style="color: red; text-decoration: none">Cats are great.</a>
178 |               </td>
179 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">
180 |                   <a href="https://github.com/soundasleep/html2text_ruby" style="color: red; text-decoration: none">Find more cats.</a>
181 |               </td>
182 |               <td style="border: none; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0; padding: 5px 0 0 17px; vertical-align: top; width: 200px" valign="top">
183 |                   <a href="https://github.com/soundasleep/html2text_ruby" style="color: red; text-decoration: none">Do more things.</a>
184 |               </td>
185 |           </tr>
186 |         </table>
187 |       </td>
188 |     </tr>
189 |   </table>
190 | 
191 | 
192 | 
193 | 
194 | 
195 |     <table class="footer-wrapper" style="margin: 0 auto 20px">
196 |       <tr>
197 |         <td class="footer" style="color: #9B9B9B; font-family: Times New Roman; font-size: 12px; font-weight: normal; margin: 0 auto 4em; text-align: left; width: 600px" align="left">
198 |           <h3 style="font-family: Times New Roman; font-size: 1.2; font-weight: normal; line-height: 2em; margin: 0">
199 |               <a href="http://localhost/contact" style="color: red; text-decoration: none">Contact us</a>
200 |           </h3>
201 |           <p style="margin: 0 0 1em">
202 |             cats@cats.com<br>
203 |             Monday and Friday
204 |           </p>
205 | 
206 |           <p style="margin: 0 0 1em"><a href="https://github.com/soundasleep/html2text" style="color: red; text-decoration: none"><img align="absmiddle" height="26" src="test.png" width="26"></a>
207 | <a href="https://github.com/soundasleep/html2text_ruby" style="color: red; text-decoration: none"><img align="absmiddle" height="26" src="test.png" width="26"></a>
208 | </p>
209 | 
210 |             <p class="message no-web-display" style="margin: 0">Having trouble seeing this email?
211 |     <a href="http://localhost/view_it_online" style="color: red; text-decoration: none">View it online</a>.
212 |   </p>
213 | 
214 |         </td>
215 |       </tr>
216 |     </table>
217 |   <script async type="text/javascript" id="profiler" src="/profiler.js" data-version="1.0"></script>
218 | </body>
219 | </html>
220 | 
221 | 


--------------------------------------------------------------------------------
/src/Html2Text.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Soundasleep;
  4 | 
  5 | class Html2Text {
  6 | 
  7 | 	/** @return array<string, bool | string> */
  8 | 	public static function defaultOptions(): array {
  9 | 		return [
 10 | 			'ignore_errors' => false,
 11 | 			'drop_links'    => false,
 12 | 			'char_set'      => 'auto',
 13 | 			'is_office_document' => null, // auto-detect
 14 | 		];
 15 | 	}
 16 | 
 17 | 	/**
 18 | 	 * Tries to convert the given HTML into a plain text format - best suited for
 19 | 	 * e-mail display, etc.
 20 | 	 *
 21 | 	 * <p>In particular, it tries to maintain the following features:
 22 | 	 * <ul>
 23 | 	 *   <li>Links are maintained, with the 'href' copied over
 24 | 	 *   <li>Information in the &lt;head&gt; is lost
 25 | 	 * </ul>
 26 | 	 *
 27 | 	 * @param string $html the input HTML
 28 | 	 * @param array $options Parsing options
 29 | 	 * @return string the HTML converted, as best as possible, to text
 30 | 	 * @throws Html2TextException if the HTML could not be loaded as a {@link \DOMDocument}
 31 | 	 */
 32 | 	public static function convert(string $html, array $options = []): string {
 33 | 
 34 | 		$options = static::processOptions($options);
 35 | 
 36 | 		if (!isset($options['is_office_document'])) {
 37 | 			$options['is_office_document'] = static::isOfficeDocument($html);
 38 | 		}
 39 | 
 40 | 		$html = static::cleanHtml($html, $options);
 41 | 		$doc = static::getDocument($html, $options);
 42 | 		return static::convertDocument($doc, $options);
 43 | 	}
 44 | 
 45 | 	/**
 46 | 	 * Tries to convert the given DOMDocument into a plain text format - best suited for
 47 | 	 * e-mail display, etc.
 48 | 	 *
 49 | 	 * <p>In particular, it tries to maintain the following features:
 50 | 	 * <ul>
 51 | 	 *   <li>Links are maintained, with the 'href' copied over
 52 | 	 *   <li>Information in the &lt;head&gt; is lost
 53 | 	 * </ul>
 54 | 	 *
 55 | 	 * @param \DOMDocument $doc the input DOMDocument
 56 | 	 * @param array $options Parsing options
 57 | 	 * @return string the HTML converted, as best as possible, to text
 58 | 	 * @throws Html2TextException if the HTML could not be loaded as a {@link \DOMDocument}
 59 | 	 */
 60 | 	public static function convertDocument(\DOMDocument $doc, array $options = []) {
 61 | 
 62 | 		$options = static::processOptions($options);
 63 | 
 64 | 		$output = static::iterateOverNode($doc, null, false, $options);
 65 | 
 66 | 		// process output for whitespace/newlines
 67 | 		$output = static::processWhitespaceNewlines($output);
 68 | 
 69 | 		return $output;
 70 | 	}
 71 | 
 72 | 	/**
 73 | 	 * HTML newline, entity, MSOffice namespace cleaning
 74 | 	 *
 75 | 	 * @param string $html
 76 | 	 * @param array $options
 77 | 	 * @return string cleaned HTML
 78 | 	 */
 79 | 	public static function cleanHtml($html, array $options = []) {
 80 | 
 81 | 		$options = static::processOptions($options);
 82 | 
 83 | 		if ($options['is_office_document']) {
 84 | 			// remove office namespace
 85 | 			$html = str_replace(["<o:p>", "</o:p>"], "", $html);
 86 | 		}
 87 | 
 88 | 		$html = static::fixNewlines($html);
 89 | 		// use mb_convert_encoding for legacy versions of php
 90 | 		if (PHP_MAJOR_VERSION * 10 + PHP_MINOR_VERSION < 81 && mb_detect_encoding($html, "UTF-8", true)) {
 91 | 			$html = mb_convert_encoding($html, "HTML-ENTITIES", "UTF-8");
 92 | 		}
 93 | 
 94 | 		return $html;
 95 | 	}
 96 | 
 97 | 	/**
 98 | 	 * Options pre-processing
 99 | 	 *
100 | 	 * @return array processed options array with defaults applied
101 | 	 */
102 | 	protected static function processOptions(array $options): array {
103 | 		$options = array_merge(static::defaultOptions(), $options);
104 | 
105 | 		// check all options are valid
106 | 		foreach ($options as $key => $value) {
107 | 			if (!in_array($key, array_keys(static::defaultOptions()))) {
108 | 				throw new \InvalidArgumentException("Unknown html2text option '$key'");
109 | 			}
110 | 		}
111 | 
112 | 		return $options;
113 | 	}
114 | 
115 | 	/**
116 | 	 * Unify newlines; in particular, \r\n becomes \n, and
117 | 	 * then \r becomes \n. This means that all newlines (Unix, Windows, Mac)
118 | 	 * all become \ns.
119 | 	 *
120 | 	 * @param string $text text with any number of \r, \r\n and \n combinations
121 | 	 * @return string the fixed text
122 | 	 */
123 | 	public static function fixNewlines(string $text): string {
124 | 		// replace \r\n to \n
125 | 		$text = str_replace("\r\n", "\n", $text);
126 | 		// remove \rs
127 | 		$text = str_replace("\r", "\n", $text);
128 | 
129 | 		return $text;
130 | 	}
131 | 
132 | 	/** @return array<string> */
133 | 	public static function nbspCodes(): array {
134 | 		return [
135 | 			"\xc2\xa0",
136 | 			"\u00a0",
137 | 		];
138 | 	}
139 | 
140 | 	/** @return array<string> */
141 | 	public static function zwnjCodes(): array {
142 | 		return [
143 | 			"\xe2\x80\x8c",
144 | 			"\u200c",
145 | 		];
146 | 	}
147 | 
148 | 	/**
149 | 	 * Remove leading or trailing spaces and excess empty lines from provided multiline text
150 | 	 *
151 | 	 * @param string $text multiline text any number of leading or trailing spaces or excess lines
152 | 	 * @return string the fixed text
153 | 	 */
154 | 	public static function processWhitespaceNewlines(string $text): string {
155 | 
156 | 		// remove excess spaces around tabs
157 | 		$text = preg_replace("/ *\t */im", "\t", $text);
158 | 
159 | 		// remove leading whitespace
160 | 		$text = ltrim($text);
161 | 
162 | 		// remove leading spaces on each line
163 | 		$text = preg_replace("/\n[ \t]*/im", "\n", $text);
164 | 
165 | 		// convert non-breaking spaces to regular spaces to prevent output issues,
166 | 		// do it here so they do NOT get removed with other leading spaces, as they
167 | 		// are sometimes used for indentation
168 | 		$text = self::renderText($text);
169 | 
170 | 		// remove trailing whitespace
171 | 		$text = rtrim($text);
172 | 
173 | 		// remove trailing spaces on each line
174 | 		$text = preg_replace("/[ \t]*\n/im", "\n", $text);
175 | 
176 | 		// unarmor pre blocks
177 | 		$text = self::fixNewlines($text);
178 | 
179 | 		// remove unnecessary empty lines
180 | 		$text = preg_replace("/\n\n\n*/im", "\n\n", $text);
181 | 
182 | 		return $text;
183 | 	}
184 | 
185 | 	/**
186 | 	 * Can we guess that this HTML is generated by Microsoft Office?
187 | 	 */
188 | 	public static function isOfficeDocument(string $html): bool {
189 | 		return strpos($html, "urn:schemas-microsoft-com:office") !== false;
190 | 	}
191 | 
192 | 	public static function isWhitespace(string $text): bool {
193 | 		return strlen(trim(self::renderText($text), "\n\r\t ")) === 0;
194 | 	}
195 | 
196 | 	/**
197 | 	 * Parse HTML into a DOMDocument
198 | 	 *
199 | 	 * @param string $html the input HTML
200 | 	 * @param array<string, bool | string> $options Parsing options
201 | 	 * @return \DOMDocument the parsed document tree
202 | 	 */
203 | 	public static function getDocument(string $html, array $options): \DOMDocument {
204 | 		$options = static::processOptions($options);
205 | 
206 | 		$doc = new \DOMDocument();
207 | 
208 | 		$html = trim($html);
209 | 
210 | 		if (!$html) {
211 | 			// DOMDocument doesn't support empty value and throws an error
212 | 			// Return empty document instead
213 | 			return $doc;
214 | 		}
215 | 
216 | 		if ($html[0] !== '<') {
217 | 			// If HTML does not begin with a tag, we put a body tag around it.
218 | 			// If we do not do this, PHP will insert a paragraph tag around
219 | 			// the first block of text for some reason which can mess up
220 | 			// the newlines. See pre.html test for an example.
221 | 			$html = '<body>' . $html . '</body>';
222 | 		}
223 | 
224 | 		$header = '';
225 | 		// use char sets for modern versions of php
226 | 		if (PHP_MAJOR_VERSION * 10 + PHP_MINOR_VERSION >= 81) {
227 | 			// use specified char_set, or auto detect if not set
228 | 			$char_set = ! empty($options['char_set']) ? $options['char_set'] : 'auto';
229 | 			if ('auto' === $char_set) {
230 | 				$char_set = mb_detect_encoding($html);
231 | 			} else if (strpos($char_set, ',')) {
232 | 				mb_detect_order($char_set);
233 | 				$char_set = mb_detect_encoding($html);
234 | 			}
235 | 			// turn off error detection for Windows-1252 legacy html
236 | 			if (strpos($char_set, '1252')) {
237 | 				$options['ignore_errors'] = true;
238 | 			}
239 | 			$header = '<?xml version="1.0" encoding="' . $char_set . '">';
240 | 		}
241 | 
242 | 		if ($options['ignore_errors']) {
243 | 			$doc->strictErrorChecking = false;
244 | 			$doc->recover = true;
245 | 			$doc->xmlStandalone = true;
246 | 			$old_internal_errors = libxml_use_internal_errors(true);
247 | 			$load_result = $doc->loadHTML($header . $html, LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NONET | LIBXML_PARSEHUGE);
248 | 			libxml_use_internal_errors($old_internal_errors);
249 | 		}
250 | 		else {
251 | 			$load_result = $doc->loadHTML($header . $html);
252 | 		}
253 | 
254 | 		if (!$load_result) {
255 | 			throw new Html2TextException("Could not load HTML - badly formed?", $html);
256 | 		}
257 | 
258 | 		return $doc;
259 | 	}
260 | 
261 | 	/**
262 | 	 * Replace any special characters with simple text versions, to prevent output issues:
263 | 	 * - Convert non-breaking spaces to regular spaces; and
264 | 	 * - Convert zero-width non-joiners to '' (nothing).
265 | 	 *
266 | 	 * This is to match our goal of rendering documents as they would be rendered
267 | 	 * by a browser.
268 | 	 */
269 | 	private static function renderText(string $text): string {
270 | 		$text = str_replace(self::nbspCodes(), " ", $text);
271 | 		$text = str_replace(self::zwnjCodes(), "", $text);
272 | 		return $text;
273 | 	}
274 | 
275 | 	private static function nextChildName(?\DOMNode $node): ?string {
276 | 		// get the next child
277 | 		$nextNode = $node->nextSibling;
278 | 		while ($nextNode != null) {
279 | 			if ($nextNode instanceof \DOMText) {
280 | 				if (!self::isWhitespace($nextNode->wholeText)) {
281 | 					break;
282 | 				}
283 | 			}
284 | 
285 | 			if ($nextNode instanceof \DOMElement) {
286 | 				break;
287 | 			}
288 | 
289 | 			$nextNode = $nextNode->nextSibling;
290 | 		}
291 | 
292 | 		$nextName = null;
293 | 		if (($nextNode instanceof \DOMElement || $nextNode instanceof \DOMText) && $nextNode != null) {
294 | 			$nextName = strtolower($nextNode->nodeName);
295 | 		}
296 | 
297 | 		return $nextName;
298 | 	}
299 | 
300 | 	/** @param array<string, bool | string> $options */
301 | 	private static function iterateOverNode(\DOMNode $node, ?string $prevName, bool $in_pre, array $options): string {
302 | 		if ($node instanceof \DOMText) {
303 | 		  // Replace whitespace characters with a space (equivilant to \s)
304 | 			if ($in_pre) {
305 | 				$text = "\n" . trim(self::renderText($node->wholeText), "\n\r\t ") . "\n";
306 | 
307 | 				// Remove trailing whitespace only
308 | 				$text = preg_replace("/[ \t]*\n/im", "\n", $text);
309 | 
310 | 				// armor newlines with \r.
311 | 				return str_replace("\n", "\r", $text);
312 | 
313 | 			}
314 | 			$text = self::renderText($node->wholeText);
315 | 			$text = preg_replace("/[\\t\\n\\f\\r ]+/im", " ", $text);
316 | 
317 | 			if (!self::isWhitespace($text) && ($prevName == 'p' || $prevName == 'div')) {
318 | 				return "\n" . $text;
319 | 			}
320 | 			return $text;
321 | 		}
322 | 
323 | 		if ($node instanceof \DOMDocumentType || $node instanceof \DOMProcessingInstruction) {
324 | 			// ignore
325 | 			return "";
326 | 		}
327 | 
328 | 		$name = strtolower($node->nodeName);
329 | 		$nextName = self::nextChildName($node);
330 | 
331 | 		// start whitespace
332 | 		switch ($name) {
333 | 			case "hr":
334 | 				$prefix = '';
335 | 				if ($prevName != null) {
336 | 					$prefix = "\n";
337 | 				}
338 | 				return $prefix . "---------------------------------------------------------------\n";
339 | 
340 | 			case "style":
341 | 			case "head":
342 | 			case "title":
343 | 			case "meta":
344 | 			case "script":
345 | 				// ignore these tags
346 | 				return "";
347 | 
348 | 			case "h1":
349 | 			case "h2":
350 | 			case "h3":
351 | 			case "h4":
352 | 			case "h5":
353 | 			case "h6":
354 | 			case "ol":
355 | 			case "ul":
356 | 			case "pre":
357 | 				// add two newlines
358 | 				$output = "\n\n";
359 | 				break;
360 | 
361 | 			case "td":
362 | 			case "th":
363 | 				// add tab char to separate table fields
364 | 			   $output = "\t";
365 | 			   break;
366 | 
367 | 			case "p":
368 | 				// Microsoft exchange emails often include HTML which, when passed through
369 | 				// html2text, results in lots of double line returns everywhere.
370 | 				//
371 | 				// To fix this, for any p element with a className of `MsoNormal` (the standard
372 | 				// classname in any Microsoft export or outlook for a paragraph that behaves
373 | 				// like a line return) we skip the first line returns and set the name to br.
374 | 				// @phpstan-ignore-next-line
375 | 				if ($options['is_office_document'] && $node->getAttribute('class') == 'MsoNormal') {
376 | 					$output = "";
377 | 					$name = 'br';
378 | 					break;
379 | 				}
380 | 
381 | 				// add two lines
382 | 				$output = "\n\n";
383 | 				break;
384 | 
385 | 			case "tr":
386 | 				// add one line
387 | 				$output = "\n";
388 | 				break;
389 | 
390 | 			case "div":
391 | 				$output = "";
392 | 				if ($prevName !== null) {
393 | 					// add one line
394 | 					$output .= "\n";
395 | 				}
396 | 				break;
397 | 
398 | 			case "li":
399 | 				$output = "- ";
400 | 				break;
401 | 
402 | 			default:
403 | 				// print out contents of unknown tags
404 | 				$output = "";
405 | 				break;
406 | 		}
407 | 
408 | 		// debug
409 | 		//$output .= "[$name,$nextName]";
410 | 
411 | 		if (isset($node->childNodes)) {
412 | 
413 | 			$n = $node->childNodes->item(0);
414 | 			$previousSiblingNames = [];
415 | 			$previousSiblingName = null;
416 | 
417 | 			$parts = [];
418 | 			$trailing_whitespace = 0;
419 | 
420 | 			while ($n != null) {
421 | 
422 | 				$text = self::iterateOverNode($n, $previousSiblingName, $in_pre || $name == 'pre', $options);
423 | 
424 | 				// Pass current node name to next child, as previousSibling does not appear to get populated
425 | 				if ($n instanceof \DOMDocumentType
426 | 					|| $n instanceof \DOMProcessingInstruction
427 | 					|| ($n instanceof \DOMText && self::isWhitespace($text))) {
428 | 					// Keep current previousSiblingName, these are invisible
429 | 					$trailing_whitespace++;
430 | 				}
431 | 				else {
432 | 					$previousSiblingName = strtolower($n->nodeName);
433 | 					$previousSiblingNames[] = $previousSiblingName;
434 | 					$trailing_whitespace = 0;
435 | 				}
436 | 
437 | 				$node->removeChild($n);
438 | 				$n = $node->childNodes->item(0);
439 | 
440 | 				$parts[] = $text;
441 | 			}
442 | 
443 | 			// Remove trailing whitespace, important for the br check below
444 | 			while ($trailing_whitespace-- > 0) {
445 | 				array_pop($parts);
446 | 			}
447 | 
448 | 			// suppress last br tag inside a node list if follows text
449 | 			$last_name = array_pop($previousSiblingNames);
450 | 			if ($last_name === 'br') {
451 | 				$last_name = array_pop($previousSiblingNames);
452 | 				if ($last_name === '#text') {
453 | 					array_pop($parts);
454 | 				}
455 | 			}
456 | 
457 | 			$output .= implode('', $parts);
458 | 		}
459 | 
460 | 		// end whitespace
461 | 		switch ($name) {
462 | 			case "h1":
463 | 			case "h2":
464 | 			case "h3":
465 | 			case "h4":
466 | 			case "h5":
467 | 			case "h6":
468 | 			case "pre":
469 | 			case "p":
470 | 				// add two lines
471 | 				$output .= "\n\n";
472 | 				break;
473 | 
474 | 			case "br":
475 | 				// add one line
476 | 				$output .= "\n";
477 | 				break;
478 | 
479 | 			case "div":
480 | 				break;
481 | 
482 | 			case "a":
483 | 				// links are returned in [text](link) format
484 | 				// @phpstan-ignore-next-line
485 | 				$href = $node->getAttribute("href");
486 | 
487 | 				$output = trim($output);
488 | 
489 | 				// remove double [[ ]] s from linking images
490 | 				if (substr($output, 0, 1) == "[" && substr($output, -1) == "]") {
491 | 					$output = substr($output, 1, strlen($output) - 2);
492 | 
493 | 					// for linking images, the title of the <a> overrides the title of the <img>
494 | 					// @phpstan-ignore-next-line
495 | 					if ($node->getAttribute("title")) {
496 | 						// @phpstan-ignore-next-line
497 | 						$output = $node->getAttribute("title");
498 | 					}
499 | 				}
500 | 
501 | 				// if there is no link text, but a title attr
502 | 				// @phpstan-ignore-next-line
503 | 				if (!$output && $node->getAttribute("title")) {
504 | 					// @phpstan-ignore-next-line
505 | 					$output = $node->getAttribute("title");
506 | 				}
507 | 
508 | 				if ($href == null) {
509 | 					// it doesn't link anywhere
510 | 					// @phpstan-ignore-next-line
511 | 					if ($node->getAttribute("name") != null) {
512 | 						if ($options['drop_links']) {
513 | 							$output = "$output";
514 | 						} else {
515 | 							$output = "[$output]";
516 | 						}
517 | 					}
518 | 				} else {
519 | 					if ($href == $output || $href == "mailto:$output" || $href == "http://$output" || $href == "https://$output") {
520 | 						// link to the same address: just use link
521 | 						$output = "$output";
522 | 					} else {
523 | 						// replace it
524 | 						if ($output) {
525 | 							if ($options['drop_links']) {
526 | 								$output = "$output";
527 | 							} else {
528 | 								$output = "[$output]($href)";
529 | 							}
530 | 						} else {
531 | 							// empty string
532 | 							$output = "$href";
533 | 						}
534 | 					}
535 | 				}
536 | 
537 | 				// does the next node require additional whitespace?
538 | 				switch ($nextName) {
539 | 					case "h1": case "h2": case "h3": case "h4": case "h5": case "h6":
540 | 						$output .= "\n";
541 | 						break;
542 | 				}
543 | 				break;
544 | 
545 | 			case "img":
546 | 				// @phpstan-ignore-next-line
547 | 				if ($node->getAttribute("title")) {
548 | 					// @phpstan-ignore-next-line
549 | 					$output = "[" . $node->getAttribute("title") . "]";
550 | 				// @phpstan-ignore-next-line
551 | 				} elseif ($node->getAttribute("alt")) {
552 | 					// @phpstan-ignore-next-line
553 | 					$output = "[" . $node->getAttribute("alt") . "]";
554 | 				} else {
555 | 					$output = "";
556 | 				}
557 | 				break;
558 | 
559 | 			case "li":
560 | 				$output .= "\n";
561 | 				break;
562 | 
563 | 			case "blockquote":
564 | 				// process quoted text for whitespace/newlines
565 | 				$output = self::processWhitespaceNewlines($output);
566 | 
567 | 				// add leading newline
568 | 				$output = "\n" . $output;
569 | 
570 | 				// prepend '> ' at the beginning of all lines
571 | 				$output = preg_replace("/\n/im", "\n> ", $output);
572 | 
573 | 				// replace leading '> >' with '>>'
574 | 				$output = preg_replace("/\n> >/im", "\n>>", $output);
575 | 
576 | 				// add another leading newline and trailing newlines
577 | 				$output = "\n" . $output . "\n\n";
578 | 				break;
579 | 			default:
580 | 				// do nothing
581 | 		}
582 | 
583 | 		return $output;
584 | 	}
585 | }
586 | 


--------------------------------------------------------------------------------