| | | | Licensed under the GNU General Public License version 3 or | | any later version with exceptions for skins & plugins. | | See the README file for a full license statement. | | | | PURPOSE: | | Converts HTML to formatted plain text (based on html2text class) | +-----------------------------------------------------------------------+ | Author: Thomas Bruederli | | Author: Aleksander Machniak | | Author: Jon Abernathy | +-----------------------------------------------------------------------+ */ /** * Takes HTML and converts it to formatted, plain text. * * Thanks to Alexander Krug (http://www.krugar.de/) to pointing out and * correcting an error in the regexp search array. Fixed 7/30/03. * * Updated set_html() function's file reading mechanism, 9/25/03. * * Thanks to Joss Sanglier (http://www.dancingbear.co.uk/) for adding * several more HTML entity codes to the $search and $replace arrays. * Updated 11/7/03. * * Thanks to Darius Kasperavicius (http://www.dar.dar.lt/) for * suggesting the addition of $allowed_tags and its supporting function * (which I slightly modified). Updated 3/12/04. * * Thanks to Justin Dearing for pointing out that a replacement for the * tag was missing, and suggesting an appropriate fix. * Updated 8/25/04. * * Thanks to Mathieu Collas (http://www.myefarm.com/) for finding a * display/formatting bug in the _build_link_list() function: email * readers would show the left bracket and number ("[1") as part of the * rendered email address. * Updated 12/16/04. * * Thanks to Wojciech Bajon (http://histeria.pl/) for submitting code * to handle relative links, which I hadn't considered. I modified his * code a bit to handle normal HTTP links and MAILTO links. Also for * suggesting three additional HTML entity codes to search for. * Updated 03/02/05. * * Thanks to Jacob Chandler for pointing out another link condition * for the _build_link_list() function: "https". * Updated 04/06/05. * * Thanks to Marc Bertrand (http://www.dresdensky.com/) for * suggesting a revision to the word wrapping functionality; if you * specify a $width of 0 or less, word wrapping will be ignored. * Updated 11/02/06. * * *** Big housecleaning updates below: * * Thanks to Colin Brown (http://www.sparkdriver.co.uk/) for * suggesting the fix to handle and blank lines (whitespace). * Christian Basedau (http://www.movetheweb.de/) also suggested the * blank lines fix. * * Special thanks to Marcus Bointon (http://www.synchromedia.co.uk/), * Christian Basedau, Norbert Laposa (http://ln5.co.uk/), * Bas van de Weijer, and Marijn van Butselaar * for pointing out my glaring error in the handling. Marcus also * supplied a host of fixes. * * Thanks to Jeffrey Silverman (http://www.newtnotes.com/) for pointing * out that extra spaces should be compressed--a problem addressed with * Marcus Bointon's fixes but that I had not yet incorporated. * * Thanks to Daniel Schledermann (http://www.typoconsult.dk/) for * suggesting a valuable fix with tag handling. * * Thanks to Wojciech Bajon (again!) for suggesting fixes and additions, * including the tag handling that Daniel Schledermann pointed * out but that I had not yet incorporated. I haven't (yet) * incorporated all of Wojciech's changes, though I may at some * future time. * * *** End of the housecleaning updates. Updated 08/08/07. */ /** * Converts HTML to formatted plain text * * @package Framework * @subpackage Utils */ class rcube_html2text { /** * Contains the HTML content to convert. * * @var string $html */ protected $html; /** * Contains the converted, formatted text. * * @var string $text */ protected $text; /** * Maximum width of the formatted text, in columns. * * Set this value to 0 (or less) to ignore word wrapping * and not constrain text to a fixed-width column. * * @var integer $width */ protected $width = 70; /** * Target character encoding for output text * * @var string $charset */ protected $charset = 'UTF-8'; /** * List of preg* regular expression patterns to search for, * used in conjunction with $replace. * * @var array $search * @see $replace */ protected $search = array( "/\r/", // Non-legal carriage return "/[\n\t]+/", // Newlines and tabs '/]*>.*?<\/head>/i', // '/]*>.*?<\/script>/i', //