3 /*************************************************************************
5 * class.html2text.inc *
7 *************************************************************************
9 * Converts HTML to formatted plain text *
11 * Copyright (c) 2005-2007 Jon Abernathy <jon@chuggnutt.com> *
12 * All rights reserved. *
14 * This script is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * The GNU General Public License can be found at *
20 * http://www.gnu.org/copyleft/gpl.html. *
22 * This script is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * Author(s): Jon Abernathy <jon@chuggnutt.com> *
29 * Last modified: 08/08/07 *
31 *************************************************************************/
35 * Takes HTML and converts it to formatted, plain text.
37 * Thanks to Alexander Krug (http://www.krugar.de/) to pointing out and
38 * correcting an error in the regexp search array. Fixed 7/30/03.
40 * Updated set_html() function's file reading mechanism, 9/25/03.
42 * Thanks to Joss Sanglier (http://www.dancingbear.co.uk/) for adding
43 * several more HTML entity codes to the $search and $replace arrays.
46 * Thanks to Darius Kasperavicius (http://www.dar.dar.lt/) for
47 * suggesting the addition of $allowed_tags and its supporting function
48 * (which I slightly modified). Updated 3/12/04.
50 * Thanks to Justin Dearing for pointing out that a replacement for the
51 * <TH> tag was missing, and suggesting an appropriate fix.
54 * Thanks to Mathieu Collas (http://www.myefarm.com/) for finding a
55 * display/formatting bug in the _build_link_list() function: email
56 * readers would show the left bracket and number ("[1") as part of the
57 * rendered email address.
60 * Thanks to Wojciech Bajon (http://histeria.pl/) for submitting code
61 * to handle relative links, which I hadn't considered. I modified his
62 * code a bit to handle normal HTTP links and MAILTO links. Also for
63 * suggesting three additional HTML entity codes to search for.
66 * Thanks to Jacob Chandler for pointing out another link condition
67 * for the _build_link_list() function: "https".
70 * Thanks to Marc Bertrand (http://www.dresdensky.com/) for
71 * suggesting a revision to the word wrapping functionality; if you
72 * specify a $width of 0 or less, word wrapping will be ignored.
75 * *** Big housecleaning updates below:
77 * Thanks to Colin Brown (http://www.sparkdriver.co.uk/) for
78 * suggesting the fix to handle </li> and blank lines (whitespace).
79 * Christian Basedau (http://www.movetheweb.de/) also suggested the
82 * Special thanks to Marcus Bointon (http://www.synchromedia.co.uk/),
83 * Christian Basedau, Norbert Laposa (http://ln5.co.uk/),
84 * Bas van de Weijer, and Marijn van Butselaar
85 * for pointing out my glaring error in the <th> handling. Marcus also
86 * supplied a host of fixes.
88 * Thanks to Jeffrey Silverman (http://www.newtnotes.com/) for pointing
89 * out that extra spaces should be compressed--a problem addressed with
90 * Marcus Bointon's fixes but that I had not yet incorporated.
92 * Thanks to Daniel Schledermann (http://www.typoconsult.dk/) for
93 * suggesting a valuable fix with <a> tag handling.
95 * Thanks to Wojciech Bajon (again!) for suggesting fixes and additions,
96 * including the <a> tag handling that Daniel Schledermann pointed
97 * out but that I had not yet incorporated. I haven't (yet)
98 * incorporated all of Wojciech's changes, though I may at some
101 * *** End of the housecleaning updates. Updated 08/08/07.
103 * @author Jon Abernathy <jon@chuggnutt.com>
111 * Contains the HTML content to convert.
119 * Contains the converted, formatted text.
127 * Maximum width of the formatted text, in columns.
129 * Set this value to 0 (or less) to ignore word wrapping
130 * and not constrain text to a fixed-width column.
132 * @var integer $width
138 * List of preg* regular expression patterns to search for,
139 * used in conjunction with $replace.
146 "/\r/", // Non-legal carriage return
147 "/[\n\t]+/", // Newlines and tabs
148 '/[ ]{2,}/', // Runs of spaces, pre-handling
149 '/<script[^>]*>.*?<\/script>/i', // <script>s -- which strip_tags supposedly has problems with
150 '/<style[^>]*>.*?<\/style>/i', // <style>s -- which strip_tags supposedly has problems with
151 //'/<!-- .* -->/', // Comments -- which strip_tags might have problem a with
152 '/<p[^>]*>/i', // <P>
153 '/<br[^>]*>/i', // <br>
154 '/<i[^>]*>(.*?)<\/i>/i', // <i>
155 '/<em[^>]*>(.*?)<\/em>/i', // <em>
156 '/(<ul[^>]*>|<\/ul>)/i', // <ul> and </ul>
157 '/(<ol[^>]*>|<\/ol>)/i', // <ol> and </ol>
158 '/<li[^>]*>(.*?)<\/li>/i', // <li> and </li>
159 '/<li[^>]*>/i', // <li>
160 '/<hr[^>]*>/i', // <hr>
161 '/(<table[^>]*>|<\/table>)/i', // <table> and </table>
162 '/(<tr[^>]*>|<\/tr>)/i', // <tr> and </tr>
163 '/<td[^>]*>(.*?)<\/td>/i', // <td> and </td>
164 '/&(nbsp|#160);/i', // Non-breaking space
165 '/&(quot|rdquo|ldquo|#8220|#8221|#147|#148);/i',
167 '/&(apos|rsquo|lsquo|#8216|#8217);/i', // Single quotes
168 '/>/i', // Greater-than
169 '/</i', // Less-than
170 '/&(amp|#38);/i', // Ampersand
171 '/&(copy|#169);/i', // Copyright
172 '/&(trade|#8482|#153);/i', // Trademark
173 '/&(reg|#174);/i', // Registered
174 '/&(mdash|#151|#8212);/i', // mdash
175 '/&(ndash|minus|#8211|#8722);/i', // ndash
176 '/&(bull|#149|#8226);/i', // Bullet
177 '/&(pound|#163);/i', // Pound sign
178 '/&(euro|#8364);/i', // Euro sign
179 '/&[^&;]+;/i', // Unknown/unhandled entities
180 '/[ ]{2,}/' // Runs of spaces, post-handling
184 * List of pattern replacements corresponding to patterns searched.
186 * @var array $replace
190 var $replace = array(
191 '', // Non-legal carriage return
192 ' ', // Newlines and tabs
193 ' ', // Runs of spaces, pre-handling
194 '', // <script>s -- which strip_tags supposedly has problems with
195 '', // <style>s -- which strip_tags supposedly has problems with
196 //'', // Comments -- which strip_tags might have problem a with
201 "\n\n", // <ul> and </ul>
202 "\n\n", // <ol> and </ol>
203 "\t* \\1\n", // <li> and </li>
205 "\n-------------------------\n", // <hr>
206 "\n\n", // <table> and </table>
207 "\n", // <tr> and </tr>
208 "\t\t\\1\n", // <td> and </td>
209 ' ', // Non-breaking space
210 '"', // Double quotes
211 "'", // Single quotes
222 'EUR', // Euro sign. € ?
223 '', // Unknown/unhandled entities
224 ' ' // Runs of spaces, post-handling
228 * List of preg* regular expression patterns to search for
229 * and replace using callback function.
231 * @var array $callback_search
234 var $callback_search = array(
235 '/<(h)[123456][^>]*>(.*?)<\/h[123456]>/i', // H1 - H3
236 '/<(b)[^>]*>(.*?)<\/b>/i', // <b>
237 '/<(strong)[^>]*>(.*?)<\/strong>/i', // <strong>
238 '/<(a) [^>]*href=("|\')([^"\']+)\2[^>]*>(.*?)<\/a>/i',
240 '/<(th)[^>]*>(.*?)<\/th>/i', // <th> and </th>
244 * List of preg* regular expression patterns to search for in PRE body,
245 * used in conjunction with $pre_replace.
247 * @var array $pre_search
251 var $pre_search = array(
260 * List of pattern replacements corresponding to patterns searched for PRE body.
262 * @var array $pre_replace
266 var $pre_replace = array(
268 ' ',
275 * Contains a list of HTML tags to allow in the resulting text.
277 * @var string $allowed_tags
279 * @see set_allowed_tags()
281 var $allowed_tags = '';
284 * Contains the base URL that relative links should resolve to.
292 * Indicates whether content in the $html variable has been converted yet.
294 * @var boolean $_converted
298 var $_converted = false;
301 * Contains URL addresses from links to be rendered in plain text.
303 * @var string $_link_list
305 * @see _build_link_list()
307 var $_link_list = '';
310 * Number of valid links detected in the text, used for plain text
311 * display (rendered similar to footnotes).
313 * @var integer $_link_count
315 * @see _build_link_list()
317 var $_link_count = 0;
320 * Boolean flag, true if a table of link URLs should be listed after the text.
322 * @var boolean $_do_links
326 var $_do_links = true;
331 * If the HTML source string (or file) is supplied, the class
332 * will instantiate with that source propagated, all that has
333 * to be done it to call get_text().
335 * @param string $source HTML content
336 * @param boolean $from_file Indicates $source is a file to pull content from
337 * @param boolean $do_links Indicate whether a table of link URLs is desired
338 * @param integer $width Maximum width of the formatted text, 0 for no limit
342 function html2text( $source = '', $from_file = false, $do_links = true, $width = 75 )
344 if ( !empty($source) ) {
345 $this->set_html($source, $from_file);
348 $this->set_base_url();
349 $this->_do_links
= $do_links;
350 $this->width
= $width;
354 * Loads source HTML into memory, either from $source string or a file.
356 * @param string $source HTML content
357 * @param boolean $from_file Indicates $source is a file to pull content from
361 function set_html( $source, $from_file = false )
363 if ( $from_file && file_exists($source) ) {
364 $this->html
= file_get_contents($source);
367 $this->html
= $source;
369 $this->_converted
= false;
373 * Returns the text, converted from HTML.
380 if ( !$this->_converted
) {
388 * Prints the text, converted from HTML.
393 function print_text()
395 print $this->get_text();
399 * Alias to print_text(), operates identically.
407 print $this->get_text();
411 * Sets the allowed HTML tags to pass through to the resulting text.
413 * Tags should be in the form "<p>", with no corresponding closing tag.
418 function set_allowed_tags( $allowed_tags = '' )
420 if ( !empty($allowed_tags) ) {
421 $this->allowed_tags
= $allowed_tags;
426 * Sets a base URL to handle relative links.
431 function set_base_url( $url = '' )
434 if ( !empty($_SERVER['HTTP_HOST']) ) {
435 $this->url
= 'http://' . $_SERVER['HTTP_HOST'];
440 // Strip any trailing slashes for consistency (relative
441 // URLs may already start with a slash like "/file.html")
442 if ( substr($url, -1) == '/' ) {
443 $url = substr($url, 0, -1);
450 * Workhorse function that does actual conversion.
452 * First performs custom tag replacement specified by $search and
453 * $replace arrays. Then strips any remaining HTML tags, reduces whitespace
454 * and newlines to a readable format, and word wraps the text to
462 // Variables used for building the link list
463 $this->_link_count
= 0;
464 $this->_link_list
= '';
466 $text = trim(stripslashes($this->html
));
469 $this->_convert_pre($text);
471 // Replace known html entities
472 $text = html_entity_decode($text, ENT_COMPAT
, 'UTF-8');
474 // Run our defined search-and-replace
475 $text = preg_replace($this->search
, $this->replace
, $text);
476 $text = preg_replace_callback($this->callback_search
, array('html2text', '_preg_callback'), $text);
478 // Strip any other HTML tags
479 $text = strip_tags($text, $this->allowed_tags
);
481 // Bring down number of empty lines to 2 max
482 $text = preg_replace("/\n\s+\n/", "\n\n", $text);
483 $text = preg_replace("/[\n]{3,}/", "\n\n", $text);
486 if ( !empty($this->_link_list
) ) {
487 $text .= "\n\nLinks:\n------\n" . $this->_link_list
;
490 // Wrap the text to a readable format
491 // for PHP versions >= 4.0.2. Default width is 75
492 // If width is 0 or less, don't wrap the text.
493 if ( $this->width
> 0 ) {
494 $text = wordwrap($text, $this->width
);
499 $this->_converted
= true;
503 * Helper function called by preg_replace() on link replacement.
505 * Maintains an internal list of links to be displayed at the end of the
506 * text, with numeric indices to the original point in the text they
507 * appeared. Also makes an effort at identifying and handling absolute
508 * and relative links.
510 * @param string $link URL of the link
511 * @param string $display Part of the text to associate number with
515 function _build_link_list( $link, $display )
517 if ( !$this->_do_links
) return $display;
519 if ( substr($link, 0, 7) == 'http://' ||
substr($link, 0, 8) == 'https://' ||
520 substr($link, 0, 7) == 'mailto:' ) {
521 $this->_link_count++
;
522 $this->_link_list
.= "[" . $this->_link_count
. "] $link\n";
523 $additional = ' [' . $this->_link_count
. ']';
524 } elseif ( substr($link, 0, 11) == 'javascript:' ) {
525 // Don't count the link; ignore it
527 // what about href="#anchor" ?
529 $this->_link_count++
;
530 $this->_link_list
.= "[" . $this->_link_count
. "] " . $this->url
;
531 if ( substr($link, 0, 1) != '/' ) {
532 $this->_link_list
.= '/';
534 $this->_link_list
.= "$link\n";
535 $additional = ' [' . $this->_link_count
. ']';
538 return $display . $additional;
542 * Helper function for PRE body conversion.
544 * @param string HTML content
547 function _convert_pre(&$text)
549 while(preg_match('/<pre[^>]*>(.*)<\/pre>/ismU', $text, $matches))
551 $result = preg_replace($this->pre_search
, $this->pre_replace
, $matches[1]);
552 $text = preg_replace('/<pre[^>]*>.*<\/pre>/ismU', '<div><br>' . $result . '<br></div>', $text, 1);
557 * Callback function for preg_replace_callback use.
559 * @param array PREG matches
563 function _preg_callback($matches)
569 return $this->_strtoupper($matches[2]);
571 return $this->_strtoupper("\t\t". $matches[2] ."\n");
573 return $this->_strtoupper("\n\n". $matches[2] ."\n\n");
575 return $this->_build_link_list($matches[3], $matches[4]);
580 * Strtoupper multibyte wrapper function
586 function _strtoupper($str)
588 if (function_exists('mb_strtoupper'))
589 return mb_strtoupper($str);
591 return strtoupper($str);