NEWS ( CHANGELOG and HISTORY ) HTMLPurifier ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| = KEY ==================== # Breaks back-compat ! Feature - Bugfix + Sub-comment . Internal change ========================== 3.1.2, unknown release date # Using %Core.CollectErrors forces line number/column tracking on, whereas previously you could theoretically turn it off. ! %Output.AttrSort for when you need your attributes in alphabetical order to deal with a bug in FCKEditor. Requested by frank farmer. ! Enable HTML comments when %HTML.Trusted is on. Requested by Waldo Jaquith. ! Proper support for name attribute. It is now allowed and equivalent to the id attribute in a and img tags, and is only converted to id when %HTML.TidyLevel is heavy (for all doctypes). ! %AutoFormat.RemoveEmpty to remove some empty tags from documents. Please don't use on hand-written HTML. ! Add error-cases for unsupported elements in MakeWellFormed. This enables the strategy to be used, standalone, on untrusted input. ! %Core.AggressivelyFixLt is on by default. This causes more sensible processing of left angled brackets in smileys and other whatnot. ! Test scripts now have a 'type' parameter, which lets you say 'htmlpurifier', 'phpt', 'vtest', etc. in order to only execute those tests. This supercedes the --only-phpt parameter, although for backwards-compatibility the flag will still work. ! AutoParagraph auto-formatter will now preserve double-newlines upon output. Users who are not performing inbound filtering, this may seem a little useless, but as a bonus, the test suite and handling of edge cases is also improved. ! Experimental implementation of forms for %HTML.Trusted ! Track column numbers when maintain line numbers is on ! Proprietary 'background' attribute on table-related elements converted into corresponding CSS. Thanks Fusemail for sponsoring this feature! - Fix two bugs in %URI.MakeAbsolute; one involving empty paths in base URLs, the other involving an undefined $is_folder error. - Throw error when %Core.Encoding is set to a spurious value. Previously, this errored silently and returned false. - Redirected stderr to stdout for flush error output. - %URI.DisableExternal will now use the host in %URI.Base if %URI.Host is not available. - Do not re-munge URL if the output URL has the same host as the input URL. Requested by Chris. - Fix error in documentation regarding %Filter.ExtractStyleBlocks - Prevent ]]> from triggering %Core.ConvertDocumentToFragment - Fix bug with inline elements in blockquotes conflicting with strict doctype - Detect if HTML support is disabled for DOM by checking for loadHTML() method. - Fix bug where dots and double-dots in absolute URLs without hostname were not collapsed by URIFilter_MakeAbsolute. - Fix bug with anonymous modules operating on SafeEmbed or SafeObject elements by reordering their addition. - Will now throw exception on many error conditions during lexer creation; also throw an exception when MaintainLineNumbers is true, but a non-tracksLineNumbers is being used. . Strategy_MakeWellFormed now operates in-place, saving memory and allowing for more interesting filter-backtracking . New HTMLPurifier_Injector->rewind() functionality, allows injectors to rewind index to reprocess tokens. . StringHashParser now allows for multiline sections with "empty" content; previously the section would remain undefined. . Added --quick option to multitest.php, which tests only the most recent release for each series. . Added --distro option to multitest.php, which accepts either 'normal' or 'standalone'. This supercedes --exclude-normal and --exclude-standalone 3.1.1, released 2008-06-19 # %URI.Munge now, by default, does not munge resources (for example, ) In order to enable this again, please set %URI.MungeResources to true. ! More robust imagecrash protection with height/width CSS with %CSS.MaxImgLength, and height/width HTML with %HTML.MaxImgLength. ! %URI.MungeSecretKey for secure URI munging. Thanks Chris for sponsoring this feature. Check out the corresponding documentation for details. (Att Nightly testers: The API for this feature changed before the general release. Namely, rename your directives %URI.SecureMungeSecretKey => %URI.MungeSecretKey and and %URI.SecureMunge => %URI.Munge) ! Implemented post URI filtering. Set member variable $post to true to set a URIFilter as such. ! Allow modules to define injectors via $info_injector. Injectors are automatically disabled if injector's needed elements are not found. ! Support for "safe" objects added, use %HTML.SafeObject and %HTML.SafeEmbed. Thanks Chris for sponsoring. If you've been using ad hoc code from the forums, PLEASE use this instead. ! Added substitutions for %e, %n, %a and %p in %URI.Munge (in order, embedded, tag name, attribute name, CSS property name). See %URI.Munge for more details. Requested by Jochem Blok. - Disable percent height/width attributes for img. - AttrValidator operations are now atomic; updates to attributes are not manifest in token until end of operations. This prevents naughty internal code from directly modifying CurrentToken when they're not supposed to. This semantics change was requested by frank farmer. - Percent encoding checks enabled for URI query and fragment - Fix stray backslashes in font-family; CSS Unicode character escapes are now properly resolved (although *only* in font-family). Thanks Takeshi Terada for reporting. - Improve parseCDATA algorithm to take into account newline normalization - Account for browser confusion between Yen character and backslash in Shift_JIS encoding. This fix generalizes to any other encoding which is not a strict superset of printable ASCII. Thanks Takeshi Terada for reporting. - Fix missing configuration parameter in Generator calls. Thanks vs for the partial patch. - Improved adherence to Unicode by checking for non-character codepoints. Thanks Geoffrey Sneddon for reporting. This may result in degraded performance for extremely large inputs. - Allow CSS property-value pair ''text-decoration: none''. Thanks Jochem Blok for reporting. . Added HTMLPurifier_UnitConverter and HTMLPurifier_Length for convenient handling of CSS-style lengths. HTMLPurifier_AttrDef_CSS_Length now uses this class. . API of HTMLPurifier_AttrDef_CSS_Length changed from __construct($disable_negative) to __construct($min, $max). __construct(true) is equivalent to __construct('0'). . Added HTMLPurifier_AttrDef_Switch class . Rename HTMLPurifier_HTMLModule_Tidy->construct() to setup() and bubble method up inheritance hierarchy to HTMLPurifier_HTMLModule. All HTMLModules get this called with the configuration object. All modules now use this rather than __construct(), although legacy code using constructors will still work--the new format, however, lets modules access the configuration object for HTML namespace dependant tweaks. . AttrDef_HTML_Pixels now takes a single construction parameter, pixels. . ConfigSchema data-structure heavily optimized; on average it uses a third the memory it did previously. The interface has changed accordingly, consult changes to HTMLPurifier_Config for details. . Variable parsing types now are magic integers instead of strings . Added benchmark for ConfigSchema . HTMLPurifier_Generator requires $config and $context parameters. If you don't know what they should be, use HTMLPurifier_Config::createDefault() and new HTMLPurifier_Context(). . Printers now properly distinguish between output configuration, and target configuration. This is not applicable to scripts using the Printers for HTML Purifier related tasks. . HTML/CSS Printers must be primed with prepareGenerator($gen_config), otherwise fatal errors will ensue. . URIFilter->prepare can return false in order to abort loading of the filter . Factory for AttrDef_URI implemented, URI#embedded to indicate URI that embeds an external resource. . %URI.Munge functionality factored out into a post-filter class. . Added CurrentCSSProperty context variable during CSS validation 3.1.0, released 2008-05-18 # Unnecessary references to objects (vestiges of PHP4) removed from method signatures. The following methods do not need references when assigning from them and will result in E_STRICT errors if you try: + HTMLPurifier_Config->get*Definition() [* = HTML, CSS] + HTMLPurifier_ConfigSchema::instance() + HTMLPurifier_DefinitionCacheFactory::instance() + HTMLPurifier_DefinitionCacheFactory->create() + HTMLPurifier_DoctypeRegistry->register() + HTMLPurifier_DoctypeRegistry->get() + HTMLPurifier_HTMLModule->addElement() + HTMLPurifier_HTMLModule->addBlankElement() + HTMLPurifier_LanguageFactory::instance() # Printer_ConfigForm's get*() functions were static-ified # %HTML.ForbiddenAttributes requires attribute declarations to be in the form of tag@attr, NOT tag.attr (which will throw an error and won't do anything). This is for forwards compatibility with XML; you'd do best to migrate an %HTML.AllowedAttributes directives to this syntax too. ! Allow index to be false for config from form creation ! Added HTMLPurifier::VERSION constant ! Commas, not dashes, used for serializer IDs. This change is forwards-compatible and allows for version numbers like "3.1.0-dev". ! %HTML.Allowed deals gracefully with whitespace anywhere, anytime! ! HTML Purifier's URI handling is a lot more robust, with much stricter validation checks and better percent encoding handling. Thanks Gareth Heyes for indicating security vulnerabilities from lax percent encoding. ! Bootstrap autoloader deals more robustly with classes that don't exist, preventing class_exists($class, true) from barfing. - InterchangeBuilder now alphabetizes its lists - Validation error in configdoc output fixed - Iconv and other encoding errors muted even with custom error handlers that do not honor error_reporting - Add protection against imagecrash attack with CSS height/width - HTMLPurifier::instance() created for consistency, is equivalent to getInstance() - Fixed and revamped broken ConfigForm smoketest - Bug with bool/null fields in Printer_ConfigForm fixed - Bug with global forbidden attributes fixed - Improved error messages for allowed and forbidden HTML elements and attributes - Missing (or null) in configdoc documentation restored - If DOM throws and exception during parsing with PH5P (occurs in newer versions of DOM), HTML Purifier punts to DirectLex - Fatal error with unserialization of ScriptRequired - Created directories are now chmod'ed properly - Fixed bug with fallback languages in LanguageFactory - Standalone testing setup properly with autoload . Out-of-date documentation revised . UTF-8 encoding check optimization as suggested by Diego . HTMLPurifier_Error removed in favor of exceptions . More copy() function removed; should use clone instead . More extensive unit tests for HTMLDefinition . assertPurification moved to central harness . HTMLPurifier_Generator accepts $config and $context parameters during instantiation, not runtime . Double-quotes outside of attribute values are now unescaped 3.1.0rc1, released 2008-04-22 # Autoload support added. Internal require_once's removed in favor of an explicit require list or autoloading. To use HTML Purifier, you must now either use HTMLPurifier.auto.php or HTMLPurifier.includes.php; setting the include path and including HTMLPurifier.php is insufficient--in such cases include HTMLPurifier.autoload.php as well to register our autoload handler (or modify your autoload function to check HTMLPurifier_Bootstrap::getPath($class)). You can also use HTMLPurifier.safe-includes.php for a less performance friendly but more user-friendly library load. # HTMLPurifier_ConfigSchema static functions are officially deprecated. Schema information is stored in the ConfigSchema directory, and the maintenance/generate-schema-cache.php generates the schema.ser file, which is now instantiated. Support for userland schema changes coming soon! # HTMLPurifier_Config will now throw E_USER_NOTICE when you use a directive alias; to get rid of these errors just modify your configuration to use the new directive name. # HTMLPurifier->addFilter is deprecated; built-in filters can now be enabled using %Filter.$filter_name or by setting your own filters using %Filter.Custom # Directive-level safety properties superceded in favor of module-level safety. Internal method HTMLModule->addElement() has changed, although the externally visible HTMLDefinition->addElement has *not* changed. ! Extra utility classes for testing and non-library operations can be found in extras/. Specifically, these are FSTools and ConfigDoc. You may find a use for these in your own project, but right now they are highly experimental and volatile. ! Integration with PHPT allows for automated smoketests ! Limited support for proprietary HTML elements, namely , sponsored by Chris. You can enable them with %HTML.Proprietary if your client demands them. ! Support for !important CSS cascade modifier. By default, this will be stripped from CSS, but you can enable it using %CSS.AllowImportant ! Support for display and visibility CSS properties added, set %CSS.AllowTricky to true to use them. ! HTML Purifier now has its own Exception hierarchy under HTMLPurifier_Exception. Developer error (not enduser error) can cause these to be triggered. ! Experimental kses() wrapper introduced with HTMLPurifier.kses.php ! Finally %CSS.AllowedProperties for tweaking allowed CSS properties without mucking around with HTMLPurifier_CSSDefinition ! ConfigDoc output has been enhanced with version and deprecation info. ! %HTML.ForbiddenAttributes and %HTML.ForbiddenElements implemented. - Autoclose now operates iteratively, i.e.
now has both span tags closed. - Various HTMLPurifier_Config convenience functions now accept another parameter $schema which defines what HTMLPurifier_ConfigSchema to use besides the global default. - Fix bug with trusted script handling in libxml versions later than 2.6.28. - Fix bug in ExtractStyleBlocks with comments in style tags - Fix bug in comment parsing for DirectLex - Flush output now displayed when in command line mode for unit tester - Fix bug with rgb(0, 1, 2) color syntax with spaces inside shorthand syntax - HTMLPurifier_HTMLDefinition->addAttribute can now be called multiple times on the same element without emitting errors. - Fixed fatal error in PH5P lexer with invalid tag names . Plugins now get their own changelogs according to project conventions. . Convert tokens to use instanceof, reducing memory footprint and improving comparison speed. . Dry runs now supported in SimpleTest; testing facilities improved . Bootstrap class added for handling autoloading functionality . Implemented recursive glob at FSTools->globr . ConfigSchema now has instance methods for all corresponding define* static methods. . A couple of new historical maintenance scripts were added. . HTMLPurifier/HTMLModule/Tidy/XHTMLAndHTML4.php split into two files . tests/index.php can now be run from any directory. . HTMLPurifier_Token subclasses split into seperate files . HTMLPURIFIER_PREFIX now is defined in Bootstrap.php, NOT HTMLPurifier.php . HTMLPURIFIER_PREFIX can now be defined outside of HTML Purifier . New --php=php flag added, allows PHP executable to be specified (command line only!) . htmlpurifier_add_test() preferred method to translate test files in to classes, because it handles PHPT files too. . Debugger class is deprecated and will be removed soon. . Command line argument parsing for testing scripts revamped, now --opt value format is supported. . Smoketests now cleanup after magic quotes . Generator now can output comments (however, comments are still stripped from HTML Purifier output) . HTMLPurifier_ConfigSchema->validate() deprecated in favor of HTMLPurifier_VarParser->parse() . Integers auto-cast into float type by VarParser. . HTMLPURIFIER_STRICT removed; no validation is performed on runtime, only during cache generation . Reordered script calls in maintenance/flush.php . Command line scripts now honor exit codes . When --flush fails in unit testers, abort tests and print message . Improved documentation in docs/dev-flush.html about the maintenance scripts . copy() methods removed in favor of clone keyword 3.0.0, released 2008-01-06 # HTML Purifier is PHP 5 only! The 2.1.x branch will be maintained until PHP 4 is completely deprecated, but no new features will be added to it. + Visibility declarations added + Constructor methods renamed to __construct() + PHP4 reference cruft removed (in progress) ! CSS properties are now case-insensitive ! DefinitionCacheFactory now can register new implementations ! New HTMLPurifier_Filter_ExtractStyleBlocks for extracting