NEWS

   1 NEWS ( CHANGELOG and HISTORY )                                     HTMLPurifier
   2 |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
   3
   4 = KEY ====================
   5     # Breaks back-compat
   6     ! Feature
   7     - Bugfix
   8       + Sub-comment
   9     . Internal change
  10 ==========================
  11
  12 3.1.2, unknown release date
  13 # Using %Core.CollectErrors forces line number/column tracking on, whereas
  14   previously you could theoretically turn it off.
  15 # HTMLPurifier_Injector->notifyEnd() is formally deprecated, and has changed
  16   behavior slightly (end tokens it sees are not guaranteed to exist). Please
  17   use handleEnd() instead.
  18 ! %Output.AttrSort for when you need your attributes in alphabetical order to
  19   deal with a bug in FCKEditor. Requested by frank farmer.
  20 ! Enable HTML comments when %HTML.Trusted is on. Requested by Waldo Jaquith.
  21 ! Proper support for name attribute. It is now allowed and equivalent to the id
  22   attribute in a and img tags, and is only converted to id when %HTML.TidyLevel
  23   is heavy (for all doctypes).
  24 ! %AutoFormat.RemoveEmpty to remove some empty tags from documents. Please don't
  25   use on hand-written HTML.
  26 ! Add error-cases for unsupported elements in MakeWellFormed. This enables
  27   the strategy to be used, standalone, on untrusted input.
  28 ! %Core.AggressivelyFixLt is on by default. This causes more sensible
  29   processing of left angled brackets in smileys and other whatnot.
  30 ! Test scripts now have a 'type' parameter, which lets you say 'htmlpurifier',
  31   'phpt', 'vtest', etc. in order to only execute those tests. This supercedes
  32   the --only-phpt parameter, although for backwards-compatibility the flag
  33   will still work.
  34 ! AutoParagraph auto-formatter will now preserve double-newlines upon output.
  35   Users who are not performing inbound filtering, this may seem a little
  36   useless, but as a bonus, the test suite and handling of edge cases is also
  37   improved.
  38 ! Experimental implementation of forms for %HTML.Trusted
  39 ! Track column numbers when maintain line numbers is on
  40 ! Proprietary 'background' attribute on table-related elements converted into
  41   corresponding CSS.  Thanks Fusemail for sponsoring this feature!
  42 ! Add forward(), forwardUntilEndToken(), backward() and current() to Injector
  43   supertype.
  44 ! HTMLPurifier_Injector->handleEnd() permits modification to end tokens. The
  45   time of operation varies slightly from notifyEnd() as *all* end tokens are
  46   processed by the injector before they are subject to the well-formedness rules.
  47 ! %Attr.DefaultImageAlt allows overriding default behavior of setting alt to
  48   basename of image when not present.
  49 - Fix two bugs in %URI.MakeAbsolute; one involving empty paths in base URLs,
  50   the other involving an undefined $is_folder error.
  51 - Throw error when %Core.Encoding is set to a spurious value. Previously,
  52   this errored silently and returned false.
  53 - Redirected stderr to stdout for flush error output.
  54 - %URI.DisableExternal will now use the host in %URI.Base if %URI.Host is not
  55   available.
  56 - Do not re-munge URL if the output URL has the same host as the input URL.
  57   Requested by Chris.
  58 - Fix error in documentation regarding %Filter.ExtractStyleBlocks
  59 - Prevent <![CDATA[<body></body>]]> from triggering %Core.ConvertDocumentToFragment
  60 - Fix bug with inline elements in blockquotes conflicting with strict doctype
  61 - Detect if HTML support is disabled for DOM by checking for loadHTML() method.
  62 - Fix bug where dots and double-dots in absolute URLs without hostname were
  63   not collapsed by URIFilter_MakeAbsolute.
  64 - Fix bug with anonymous modules operating on SafeEmbed or SafeObject elements
  65   by reordering their addition.
  66 - Will now throw exception on many error conditions during lexer creation; also
  67   throw an exception when MaintainLineNumbers is true, but a non-tracksLineNumbers
  68   is being used.
  69 - Detect if domxml extension is loaded, and use DirectLEx accordingly.
  70 . Strategy_MakeWellFormed now operates in-place, saving memory and allowing
  71   for more interesting filter-backtracking
  72 . New HTMLPurifier_Injector->rewind() functionality, allows injectors to rewind
  73   index to reprocess tokens.
  74 . StringHashParser now allows for multiline sections with "empty" content;
  75   previously the section would remain undefined.
  76 . Added --quick option to multitest.php, which tests only the most recent
  77   release for each series.
  78 . Added --distro option to multitest.php, which accepts either 'normal' or
  79   'standalone'. This supercedes --exclude-normal and --exclude-standalone
  80
  81 3.1.1, released 2008-06-19
  82 # %URI.Munge now, by default, does not munge resources (for example, <img src="">)
  83   In order to enable this again, please set %URI.MungeResources to true.
  84 ! More robust imagecrash protection with height/width CSS with %CSS.MaxImgLength,
  85   and height/width HTML with %HTML.MaxImgLength.
  86 ! %URI.MungeSecretKey for secure URI munging. Thanks Chris
  87   for sponsoring this feature. Check out the corresponding documentation
  88   for details. (Att Nightly testers: The API for this feature changed before
  89   the general release. Namely, rename your directives %URI.SecureMungeSecretKey =>
  90   %URI.MungeSecretKey and and %URI.SecureMunge => %URI.Munge)
  91 ! Implemented post URI filtering. Set member variable $post to true to set
  92   a URIFilter as such.
  93 ! Allow modules to define injectors via $info_injector. Injectors are
  94   automatically disabled if injector's needed elements are not found.
  95 ! Support for "safe" objects added, use %HTML.SafeObject and %HTML.SafeEmbed.
  96   Thanks Chris for sponsoring. If you've been using ad hoc code from the
  97   forums, PLEASE use this instead.
  98 ! Added substitutions for %e, %n, %a and %p in %URI.Munge (in order,
  99   embedded, tag name, attribute name, CSS property name). See %URI.Munge
 100   for more details. Requested by Jochem Blok.
 101 - Disable percent height/width attributes for img.
 102 - AttrValidator operations are now atomic; updates to attributes are not
 103   manifest in token until end of operations. This prevents naughty internal
 104   code from directly modifying CurrentToken when they're not supposed to.
 105   This semantics change was requested by frank farmer.
 106 - Percent encoding checks enabled for URI query and fragment
 107 - Fix stray backslashes in font-family; CSS Unicode character escapes are
 108   now properly resolved (although *only* in font-family). Thanks Takeshi Terada
 109   for reporting.
 110 - Improve parseCDATA algorithm to take into account newline normalization
 111 - Account for browser confusion between Yen character and backslash in
 112   Shift_JIS encoding. This fix generalizes to any other encoding which is not
 113   a strict superset of printable ASCII. Thanks Takeshi Terada for reporting.
 114 - Fix missing configuration parameter in Generator calls. Thanks vs for the
 115   partial patch.
 116 - Improved adherence to Unicode by checking for non-character codepoints.
 117   Thanks Geoffrey Sneddon for reporting. This may result in degraded
 118   performance for extremely large inputs.
 119 - Allow CSS property-value pair ''text-decoration: none''. Thanks Jochem Blok
 120   for reporting.
 121 . Added HTMLPurifier_UnitConverter and HTMLPurifier_Length for convenient
 122   handling of CSS-style lengths. HTMLPurifier_AttrDef_CSS_Length now uses
 123   this class.
 124 . API of HTMLPurifier_AttrDef_CSS_Length changed from __construct($disable_negative)
 125   to __construct($min, $max). __construct(true) is equivalent to
 126   __construct('0').
 127 . Added HTMLPurifier_AttrDef_Switch class
 128 . Rename HTMLPurifier_HTMLModule_Tidy->construct() to setup() and bubble method
 129   up inheritance hierarchy to HTMLPurifier_HTMLModule. All HTMLModules
 130   get this called with the configuration object.  All modules now
 131   use this rather than __construct(), although legacy code using constructors
 132   will still work--the new format, however, lets modules access the
 133   configuration object for HTML namespace dependant tweaks.
 134 . AttrDef_HTML_Pixels now takes a single construction parameter, pixels.
 135 . ConfigSchema data-structure heavily optimized; on average it uses a third
 136   the memory it did previously. The interface has changed accordingly,
 137   consult changes to HTMLPurifier_Config for details.
 138 . Variable parsing types now are magic integers instead of strings
 139 . Added benchmark for ConfigSchema
 140 . HTMLPurifier_Generator requires $config and $context parameters. If you
 141   don't know what they should be, use HTMLPurifier_Config::createDefault()
 142   and new HTMLPurifier_Context().
 143 . Printers now properly distinguish between output configuration, and
 144   target configuration. This is not applicable to scripts using
 145   the Printers for HTML Purifier related tasks.
 146 . HTML/CSS Printers must be primed with prepareGenerator($gen_config), otherwise
 147   fatal errors will ensue.
 148 . URIFilter->prepare can return false in order to abort loading of the filter
 149 . Factory for AttrDef_URI implemented, URI#embedded to indicate URI that embeds
 150   an external resource.
 151 . %URI.Munge functionality factored out into a post-filter class.
 152 . Added CurrentCSSProperty context variable during CSS validation
 153
 154 3.1.0, released 2008-05-18
 155 # Unnecessary references to objects (vestiges of PHP4) removed from method
 156   signatures.  The following methods do not need references when assigning from
 157   them and will result in E_STRICT errors if you try:
 158     + HTMLPurifier_Config->get*Definition() [* = HTML, CSS]
 159     + HTMLPurifier_ConfigSchema::instance()
 160     + HTMLPurifier_DefinitionCacheFactory::instance()
 161     + HTMLPurifier_DefinitionCacheFactory->create()
 162     + HTMLPurifier_DoctypeRegistry->register()
 163     + HTMLPurifier_DoctypeRegistry->get()
 164     + HTMLPurifier_HTMLModule->addElement()
 165     + HTMLPurifier_HTMLModule->addBlankElement()
 166     + HTMLPurifier_LanguageFactory::instance()
 167 # Printer_ConfigForm's get*() functions were static-ified
 168 # %HTML.ForbiddenAttributes requires attribute declarations to be in the
 169   form of tag@attr, NOT tag.attr (which will throw an error and won't do
 170   anything). This is for forwards compatibility with XML; you'd do best
 171   to migrate an %HTML.AllowedAttributes directives to this syntax too.
 172 ! Allow index to be false for config from form creation
 173 ! Added HTMLPurifier::VERSION constant
 174 ! Commas, not dashes, used for serializer IDs. This change is forwards-compatible
 175   and allows for version numbers like "3.1.0-dev".
 176 ! %HTML.Allowed deals gracefully with whitespace anywhere, anytime!
 177 ! HTML Purifier's URI handling is a lot more robust, with much stricter
 178   validation checks and better percent encoding handling. Thanks Gareth Heyes
 179   for indicating security vulnerabilities from lax percent encoding.
 180 ! Bootstrap autoloader deals more robustly with classes that don't exist,
 181   preventing class_exists($class, true) from barfing.
 182 - InterchangeBuilder now alphabetizes its lists
 183 - Validation error in configdoc output fixed
 184 - Iconv and other encoding errors muted even with custom error handlers that
 185   do not honor error_reporting
 186 - Add protection against imagecrash attack with CSS height/width
 187 - HTMLPurifier::instance() created for consistency, is equivalent to getInstance()
 188 - Fixed and revamped broken ConfigForm smoketest
 189 - Bug with bool/null fields in Printer_ConfigForm fixed
 190 - Bug with global forbidden attributes fixed
 191 - Improved error messages for allowed and forbidden HTML elements and attributes
 192 - Missing (or null) in configdoc documentation restored
 193 - If DOM throws and exception during parsing with PH5P (occurs in newer versions
 194   of DOM), HTML Purifier punts to DirectLex
 195 - Fatal error with unserialization of ScriptRequired
 196 - Created directories are now chmod'ed properly
 197 - Fixed bug with fallback languages in LanguageFactory
 198 - Standalone testing setup properly with autoload
 199 . Out-of-date documentation revised
 200 . UTF-8 encoding check optimization as suggested by Diego
 201 . HTMLPurifier_Error removed in favor of exceptions
 202 . More copy() function removed; should use clone instead
 203 . More extensive unit tests for HTMLDefinition
 204 . assertPurification moved to central harness
 205 . HTMLPurifier_Generator accepts $config and $context parameters during
 206   instantiation, not runtime
 207 . Double-quotes outside of attribute values are now unescaped
 208
 209 3.1.0rc1, released 2008-04-22
 210 # Autoload support added. Internal require_once's removed in favor of an
 211   explicit require list or autoloading. To use HTML Purifier,
 212   you must now either use HTMLPurifier.auto.php
 213   or HTMLPurifier.includes.php; setting the include path and including
 214   HTMLPurifier.php is insufficient--in such cases include HTMLPurifier.autoload.php
 215   as well to register our autoload handler (or modify your autoload function
 216   to check HTMLPurifier_Bootstrap::getPath($class)). You can also use
 217   HTMLPurifier.safe-includes.php for a less performance friendly but more
 218   user-friendly library load.
 219 # HTMLPurifier_ConfigSchema static functions are officially deprecated. Schema
 220   information is stored in the ConfigSchema directory, and the
 221   maintenance/generate-schema-cache.php generates the schema.ser file, which
 222   is now instantiated. Support for userland schema changes coming soon!
 223 # HTMLPurifier_Config will now throw E_USER_NOTICE when you use a directive
 224   alias; to get rid of these errors just modify your configuration to use
 225   the new directive name.
 226 # HTMLPurifier->addFilter is deprecated; built-in filters can now be
 227   enabled using %Filter.$filter_name or by setting your own filters using
 228   %Filter.Custom
 229 # Directive-level safety properties superceded in favor of module-level
 230   safety. Internal method HTMLModule->addElement() has changed, although
 231   the externally visible HTMLDefinition->addElement has *not* changed.
 232 ! Extra utility classes for testing and non-library operations can
 233   be found in extras/. Specifically, these are FSTools and ConfigDoc.
 234   You may find a use for these in your own project, but right now they
 235   are highly experimental and volatile.
 236 ! Integration with PHPT allows for automated smoketests
 237 ! Limited support for proprietary HTML elements, namely <marquee>, sponsored
 238   by Chris. You can enable them with %HTML.Proprietary if your client
 239   demands them.
 240 ! Support for !important CSS cascade modifier. By default, this will be stripped
 241   from CSS, but you can enable it using %CSS.AllowImportant
 242 ! Support for display and visibility CSS properties added, set %CSS.AllowTricky
 243   to true to use them.
 244 ! HTML Purifier now has its own Exception hierarchy under HTMLPurifier_Exception.
 245   Developer error (not enduser error) can cause these to be triggered.
 246 ! Experimental kses() wrapper introduced with HTMLPurifier.kses.php
 247 ! Finally %CSS.AllowedProperties for tweaking allowed CSS properties without
 248   mucking around with HTMLPurifier_CSSDefinition
 249 ! ConfigDoc output has been enhanced with version and deprecation info.
 250 ! %HTML.ForbiddenAttributes and %HTML.ForbiddenElements implemented.
 251 - Autoclose now operates iteratively, i.e. <span><span><div> now has
 252   both span tags closed.
 253 - Various HTMLPurifier_Config convenience functions now accept another parameter
 254   $schema which defines what HTMLPurifier_ConfigSchema to use besides the
 255   global default.
 256 - Fix bug with trusted script handling in libxml versions later than 2.6.28.
 257 - Fix bug in ExtractStyleBlocks with comments in style tags
 258 - Fix bug in comment parsing for DirectLex
 259 - Flush output now displayed when in command line mode for unit tester
 260 - Fix bug with rgb(0, 1, 2) color syntax with spaces inside shorthand syntax
 261 - HTMLPurifier_HTMLDefinition->addAttribute can now be called multiple times
 262   on the same element without emitting errors.
 263 - Fixed fatal error in PH5P lexer with invalid tag names
 264 . Plugins now get their own changelogs according to project conventions.
 265 . Convert tokens to use instanceof, reducing memory footprint and
 266   improving comparison speed.
 267 . Dry runs now supported in SimpleTest; testing facilities improved
 268 . Bootstrap class added for handling autoloading functionality
 269 . Implemented recursive glob at FSTools->globr
 270 . ConfigSchema now has instance methods for all corresponding define*
 271   static methods.
 272 . A couple of new historical maintenance scripts were added.
 273 . HTMLPurifier/HTMLModule/Tidy/XHTMLAndHTML4.php split into two files
 274 . tests/index.php can now be run from any directory.
 275 . HTMLPurifier_Token subclasses split into seperate files
 276 . HTMLPURIFIER_PREFIX now is defined in Bootstrap.php, NOT HTMLPurifier.php
 277 . HTMLPURIFIER_PREFIX can now be defined outside of HTML Purifier
 278 . New --php=php flag added, allows PHP executable to be specified (command
 279   line only!)
 280 . htmlpurifier_add_test() preferred method to translate test files in to
 281   classes, because it handles PHPT files too.
 282 . Debugger class is deprecated and will be removed soon.
 283 . Command line argument parsing for testing scripts revamped, now --opt value
 284   format is supported.
 285 . Smoketests now cleanup after magic quotes
 286 . Generator now can output comments (however, comments are still stripped
 287   from HTML Purifier output)
 288 . HTMLPurifier_ConfigSchema->validate() deprecated in favor of
 289   HTMLPurifier_VarParser->parse()
 290 . Integers auto-cast into float type by VarParser.
 291 . HTMLPURIFIER_STRICT removed; no validation is performed on runtime, only
 292   during cache generation
 293 . Reordered script calls in maintenance/flush.php
 294 . Command line scripts now honor exit codes
 295 . When --flush fails in unit testers, abort tests and print message
 296 . Improved documentation in docs/dev-flush.html about the maintenance scripts
 297 . copy() methods removed in favor of clone keyword
 298
 299 3.0.0, released 2008-01-06
 300 # HTML Purifier is PHP 5 only! The 2.1.x branch will be maintained
 301   until PHP 4 is completely deprecated, but no new features will be added
 302   to it.
 303   + Visibility declarations added
 304   + Constructor methods renamed to __construct()
 305   + PHP4 reference cruft removed (in progress)
 306 ! CSS properties are now case-insensitive
 307 ! DefinitionCacheFactory now can register new implementations
 308 ! New HTMLPurifier_Filter_ExtractStyleBlocks for extracting <style> from
 309   documents and cleaning their contents up. Requires the CSSTidy library
 310   <http://csstidy.sourceforge.net/>. You can access the blocks with the
 311   'StyleBlocks' Context variable ($purifier->context->get('StyleBlocks')).
 312   The output CSS can also be "scoped" for a specific element, use:
 313   %Filter.ExtractStyleBlocksScope
 314 ! Experimental support for some proprietary CSS attributes allowed:
 315   opacity (and all of the browser-specific equivalents) and scrollbar colors.
 316   Enable by setting %CSS.Proprietary to true.
 317 - Colors missing # but in hex form will be corrected
 318 - CSS Number algorithm improved
 319 - Unit testing and multi-testing now on steroids: command lines,
 320   XML output, and other goodies now added.
 321 . Unit tests for Injector improved
 322 . New classes:
 323   + HTMLPurifier_AttrDef_CSS_AlphaValue
 324   + HTMLPurifier_AttrDef_CSS_Filter
 325 . Multitest now has a file docblock
 326
 327 2.1.3, released 2007-11-05
 328 ! tests/multitest.php allows you to test multiple versions by running
 329   tests/index.php through multiple interpreters using `phpv` shell
 330   script (you must provide this script!)
 331 - Fixed poor include ordering for Email URI AttrDefs, causes fatal errors
 332   on some systems.
 333 - Injector algorithm further refined: off-by-one error regarding skip
 334   counts for dormant injectors fixed
 335 - Corrective blockquote definition now enabled for HTML 4.01 Strict
 336 - Fatal error when <img> tag (or any other element with required attributes)
 337   has 'id' attribute fixed, thanks NykO18 for reporting
 338 - Fix warning emitted when a non-supported URI scheme is passed to the
 339   MakeAbsolute URIFilter, thanks NykO18 (again)
 340 - Further refine AutoParagraph injector. Behavior inside of elements
 341   allowing paragraph tags clarified: only inline content delimeted by
 342   double newlines (not block elements) are paragraphed.
 343 - Buggy treatment of end tags of elements that have required attributes
 344   fixed (does not manifest on default tag-set)
 345 - Spurious internal content reorganization error suppressed
 346 - HTMLDefinition->addElement now returns a reference to the created
 347   element object, as implied by the documentation
 348 - Phorum mod's HTML Purifier help message expanded (unreleased elsewhere)
 349 - Fix a theoretical class of infinite loops from DirectLex reported
 350   by Nate Abele
 351 - Work around unnecessary DOMElement type-cast in PH5P that caused errors
 352   in PHP 5.1
 353 - Work around PHP 4 SimpleTest lack-of-error complaining for one-time-only
 354   HTMLDefinition errors, this may indicate problems with error-collecting
 355   facilities in PHP 5
 356 - Make ErrorCollectorEMock work in both PHP 4 and PHP 5
 357 - Make PH5P work with PHP 5.0 by removing unnecessary array parameter typedef
 358 . %Core.AcceptFullDocuments renamed to %Core.ConvertDocumentToFragment
 359   to better communicate its purpose
 360 . Error unit tests can now specify the expectation of no errors. Future
 361   iterations of the harness will be extremely strict about what errors
 362   are allowed
 363 . Extend Injector hooks to allow for more powerful injector routines
 364 . HTMLDefinition->addBlankElement created, as according to the HTMLModule
 365   method
 366 . Doxygen configuration file updated, with minor improvements
 367 . Test runner now checks for similarly named files in conf/ directory too.
 368 . Minor cosmetic change to flush-definition-cache.php: trailing newline is
 369   outputted
 370 . Maintenance script for generating PH5P patch added, original PH5P source
 371   file also added under version control
 372 . Full unit test runner script title made more descriptive with PHP version
 373 . Updated INSTALL file to state that 4.3.7 is the earliest version we
 374   are actively testing
 375
 376 2.1.2, released 2007-09-03
 377 ! Implemented Object module for trusted users
 378 ! Implemented experimental HTML5 parsing mode using PH5P. To use, add
 379   this to your code:
 380         require_once 'HTMLPurifier/Lexer/PH5P.php';
 381         $config->set('Core', 'LexerImpl', 'PH5P');
 382   Note that this Lexer introduces some classes not in the HTMLPurifier
 383   namespace.  Also, this is PHP5 only.
 384 ! CSS property border-spacing implemented
 385 - Fix non-visible parsing error in DirectLex with empty tags that have
 386   slashes inside attribute values.
 387 - Fix typo in CSS definition: border-collapse:seperate; was incorrectly
 388   accepted as valid CSS. Usually non-visible, because this styling is the
 389   default for tables in most browsers. Thanks Brett Zamir for pointing
 390   this out.
 391 - Fix validation errors in configuration form
 392 - Hammer out a bunch of edge-case bugs in the standalone distribution
 393 - Inclusion reflection removed from URISchemeRegistry; you must manually
 394   include any new schema files you wish to use
 395 - Numerous typo fixes in documentation thanks to Brett Zamir
 396 . Unit test refactoring for one logical test per test function
 397 . Config and context parameters in ComplexHarness deprecated: instead, edit
 398   the $config and $context member variables
 399 . HTML wrapper in DOMLex now takes DTD identifiers into account; doesn't
 400   really make a difference, but is good for completeness sake
 401 . merge-library.php script refactored for greater code reusability and
 402   PHP4 compatibility
 403
 404 2.1.1, released 2007-08-04
 405 - Fix show-stopper bug in %URI.MakeAbsolute functionality
 406 - Fix PHP4 syntax error in standalone version
 407 . Add prefix directory to include path for standalone, this prevents
 408   other installations from clobbering the standalone's URI schemes
 409 . Single test methods can be invoked by prefixing with __only
 410
 411 2.1.0, released 2007-08-02
 412 # flush-htmldefinition-cache.php superseded in favor of a generic
 413   flush-definition-cache.php script, you can clear a specific cache
 414   by passing its name as a parameter to the script
 415 ! Phorum mod implemented for HTML Purifier
 416 ! With %Core.AggressivelyFixLt, <3 and similar emoticons no longer
 417   trigger HTML removal in PHP5 (DOMLex). This directive is not necessary
 418   for PHP4 (DirectLex).
 419 ! Standalone file now available, which greatly reduces the amount of
 420   includes (although there are still a few files that reside in the
 421   standalone folder)
 422 ! Relative URIs can now be transformed into their absolute equivalents
 423   using %URI.Base and %URI.MakeAbsolute
 424 ! Ruby implemented for XHTML 1.1
 425 ! You can now define custom URI filtering behavior, see enduser-uri-filter.html
 426   for more details
 427 ! UTF-8 font names now supported in CSS
 428 - AutoFormatters emit friendly error messages if tags or attributes they
 429   need are not allowed
 430 - ConfigForm's compactification of directive names is now configurable
 431 - AutoParagraph autoformatter algorithm refined after field-testing
 432 - XHTML 1.1 now applies XHTML 1.0 Strict cleanup routines, namely
 433   blockquote wrapping
 434 - Contents of <style> tags removed by default when tags are removed
 435 . HTMLPurifier_Config->getSerial() implemented, this is extremely useful
 436   for output cache invalidation
 437 . ConfigForm printer now can retrieve CSS and JS files as strings, in
 438   case HTML Purifier's directory is not publically accessible
 439 . Introduce new text/itext configuration directive values: these represent
 440   longer strings that would be more appropriately edited with a textarea
 441 . Allow newlines to act as separators for lists, hashes, lookups and
 442   %HTML.Allowed
 443 . ConfigForm generates textareas instead of text inputs for lists, hashes,
 444   lookups, text and itext fields
 445 . Hidden element content removal genericized: %Core.HiddenElements can
 446   be used to customize this behavior, by default <script> and <style> are
 447   hidden
 448 . Added HTMLPURIFIER_PREFIX constant, should be used instead of dirname(__FILE__)
 449 . Custom ChildDef added to default include list
 450 . URIScheme reflection improved: will not attempt to include file if class
 451   already exists. May clobber autoload, so I need to keep an eye on it
 452 . ConfigSchema heavily optimized, will only collect information and validate
 453   definitions when HTMLPURIFIER_SCHEMA_STRICT is true.
 454 . AttrDef_URI unit tests and implementation refactored
 455 . benchmarks/ directory now protected from public view with .htaccess file;
 456   run the tests via command line
 457 . URI scheme is munged off if there is no authority and the scheme is the
 458   default one
 459 . All unit tests inherit from HTMLPurifier_Harness, not UnitTestCase
 460 . Interface for URIScheme changed
 461 . Generic URI object to hold components of URI added, most systems involved
 462   in URI validation have been migrated to use it
 463 . Custom filtering for URIs factored out to URIDefinition interface for
 464   maximum extensibility
 465
 466 2.0.1, released 2007-06-27
 467 ! Tag auto-closing now based on a ChildDef heuristic rather than a
 468   manually set auto_close array; some behavior may change
 469 ! Experimental AutoFormat functionality added: auto-paragraph and
 470   linkify your HTML input by setting %AutoFormat.AutoParagraph and
 471   %AutoFormat.Linkify to true
 472 ! Newlines normalized internally, and then converted back to the
 473   value of PHP_EOL. If this is not desired, set your newline format
 474   using %Output.Newline.
 475 ! Beta error collection, messages are implemented for the most generic
 476   cases involving Lexing or Strategies
 477 - Clean up special case code for <script> tags
 478 - Reorder includes for DefinitionCache decorators, fixes a possible
 479   missing class error
 480 - Fixed bug where manually modified definitions were not saved via cache
 481   (mostly harmless, except for the fact that it would be a little slower)
 482 - Configuration objects with different serials do not clobber each
 483   others when revision numbers are unequal
 484 - Improve Serializer DefinitionCache directory permissions checks
 485 - DefinitionCache no longer throws errors when it encounters old
 486   serial files that do not conform to the current style
 487 - Stray xmlns attributes removed from configuration documentation
 488 - configForm.php smoketest no longer has XSS vulnerability due to
 489   unescaped print_r output
 490 - Printer adheres to configuration's directives on output format
 491 - Fix improperly named form field in ConfigForm printer
 492 . Rewire some test-cases to swallow errors rather than expect them
 493 . HTMLDefinition printer updated with some of the new attributes
 494 . DefinitionCache keys reordered to reflect precedence: version number,
 495   hash, then revision number
 496 . %Core.DefinitionCache renamed to %Cache.DefinitionImpl
 497 . Interlinking in configuration documentation added using
 498   Injector_PurifierLinkify
 499 . Directives now keep track of aliases to themselves
 500 . Error collector now requires a severity to be passed, use PHP's internal
 501   error constants for this
 502 . HTMLPurifier_Config::getAllowedDirectivesForForm implemented, allows
 503   much easier selective embedding of configuration values
 504 . Doctype objects now accept public and system DTD identifiers
 505 . %HTML.Doctype is now constrained by specific values, to specify a custom
 506   doctype use new %HTML.CustomDoctype
 507 . ConfigForm truncates long directives to keep the form small, and does
 508   not re-output namespaces
 509
 510 2.0.0, released 2007-06-20
 511 # Completely refactored HTMLModuleManager, decentralizing safety
 512   information
 513 # Transform modules changed to Tidy modules, which offer more flexibility
 514   and better modularization
 515 # Configuration object now finalizes itself when a read operation is
 516   performed on it, ensuring that its internal state stays consistent.
 517   To revert this behavior, you can set the $autoFinalize member variable
 518   off, but it's not recommended.
 519 # New compact syntax for AttrDef objects that can be used to instantiate
 520   new objects via make()
 521 # Definitions (esp. HTMLDefinition) are now cached for a significant
 522   performance boost. You can disable caching by setting %Core.DefinitionCache
 523   to null. You CANNOT edit raw definitions without setting the corresponding
 524   DefinitionID directive (%HTML.DefinitionID for HTMLDefinition).
 525 # Contents between <script> tags are now completely removed if <script>
 526   is not allowed
 527 # Prototype-declarations for Lexer removed in favor of configuration
 528   determination of Lexer implementations.
 529 ! HTML Purifier now works in PHP 4.3.2.
 530 ! Configuration form-editing API makes tweaking HTMLPurifier_Config a
 531   breeze!
 532 ! Configuration directives that accept hashes now allow new string
 533   format: key1:value1,key2:value2
 534 ! ConfigDoc now factored into OOP design
 535 ! All deprecated elements now natively supported
 536 ! Implement TinyMCE styled whitelist specification format in
 537   %HTML.Allowed
 538 ! Config object gives more friendly error messages when things go wrong
 539 ! Advanced API implemented: easy functions for creating elements (addElement)
 540   and attributes (addAttribute) on HTMLDefinition
 541 ! Add native support for required attributes
 542 - Deprecated and removed EnableRedundantUTF8Cleaning. It didn't even work!
 543 - DOMLex will not emit errors when a custom error handler that does not
 544   honor error_reporting is used
 545 - StrictBlockquote child definition refrains from wrapping whitespace
 546   in tags now.
 547 - Bug resulting from tag transforms to non-allowed elements fixed
 548 - ChildDef_Custom's regex generation has been improved, removing several
 549   false positives
 550 . Unit test for ElementDef created, ElementDef behavior modified to
 551   be more flexible
 552 . Added convenience functions for HTMLModule constructors
 553 . AttrTypes now has accessor functions that should be used instead
 554   of directly manipulating info
 555 . TagTransform_Center deprecated in favor of generic TagTransform_Simple
 556 . Add extra protection in AttrDef_URI against phantom Schemes
 557 . Doctype object added to HTMLDefinition which describes certain aspects
 558   of the operational document type
 559 . Lexer is now pre-emptively included, with a conditional include for the
 560   PHP5 only version.
 561 . HTMLDefinition and CSSDefinition have a common parent class: Definition.
 562 . DirectLex can now track line-numbers
 563 . Preliminary error collector is in place, although no code actually reports
 564   errors yet
 565 . Factor out most of ValidateAttributes to new AttrValidator class
 566
 567 1.6.1, released 2007-05-05
 568 ! Support for more deprecated attributes via transformations:
 569   + hspace and vspace in img
 570   + size and noshade in hr
 571   + nowrap in td
 572   + clear in br
 573   + align in caption, table, img and hr
 574   + type in ul, ol and li
 575 ! DirectLex now preserves text in which a < bracket is followed by
 576   a non-alphanumeric character. This means that certain emoticons
 577   are now preserved.
 578 ! %Core.RemoveInvalidImg is now operational, when set to false invalid
 579   images will hang around with an empty src
 580 ! target attribute in a tag supported, use %Attr.AllowedFrameTargets
 581   to enable
 582 ! CSS property white-space now allows nowrap (supported in all modern
 583   browsers) but not others (which have spotty browser implementations)
 584 ! XHTML 1.1 mode now sort-of works without any fatal errors, and
 585   lang is now moved over to xml:lang.
 586 ! Attribute transformation smoketest available at smoketests/attrTransform.php
 587 ! Transformation of font's size attribute now handles super-large numbers
 588 - Possibly fatal bug with __autoload() fixed in module manager
 589 - Invert HTMLModuleManager->addModule() processing order to check
 590   prefixes first and then the literal module
 591 - Empty strings get converted to empty arrays instead of arrays with
 592   an empty string in them.
 593 - Merging in attribute lists now works.
 594 . Demo script removed: it has been added to the website's repository
 595 . Basic.php script modified to work out of the box
 596 . Refactor AttrTransform classes to reduce duplication
 597 . AttrTransform_TextAlign axed in favor of a more general
 598   AttrTransform_EnumToCSS, refer to HTMLModule/TransformToStrict.php to
 599   see how the new equivalent is implemented
 600 . Unit tests now use exclusively assertIdentical
 601
 602 1.6.0, released 2007-04-01
 603 ! Support for most common deprecated attributes via transformations:
 604   + bgcolor in td, th, tr and table
 605   + border in img
 606   + name in a and img
 607   + width in td, th and hr
 608   + height in td, th
 609 ! Support for CSS attribute 'height' added
 610 ! Support for rel and rev attributes in a tags added, use %Attr.AllowedRel
 611   and %Attr.AllowedRev to activate
 612 - You can define ID blacklists using regular expressions via
 613   %Attr.IDBlacklistRegexp
 614 - Error messages are emitted when you attempt to "allow" elements or
 615   attributes that HTML Purifier does not support
 616 - Fix segfault in unit test. The problem is not very reproduceable and
 617   I don't know what causes it, but a six line patch fixed it.
 618
 619 1.5.0, released 2007-03-23
 620 ! Added a rudimentary I18N and L10N system modeled off MediaWiki. It
 621   doesn't actually do anything yet, but keep your eyes peeled.
 622 ! docs/enduser-utf8.html explains how to use UTF-8 and HTML Purifier
 623 ! Newly structured HTMLDefinition modeled off of XHTML 1.1 modules.
 624   I am loathe to release beta quality APIs, but this is exactly that;
 625   don't use the internal interfaces if you're not willing to do migration
 626   later on.
 627 - Allow 'x' subtag in language codes
 628 - Fixed buggy chameleon-support for ins and del
 629 . Added support for IDREF attributes (i.e. for)
 630 . Renamed HTMLPurifier_AttrDef_Class to HTMLPurifier_AttrDef_Nmtokens
 631 . Removed context variable ParentType, replaced with IsInline, which
 632   is false when you're not inline and an integer of the parent that
 633   caused you to become inline when you are (so possibly zero)
 634 . Removed ElementDef->type in favor of ElementDef->descendants_are_inline
 635   and HTMLDefinition->content_sets
 636 . StrictBlockquote now reports what elements its supposed to allow,
 637   rather than what it does allow
 638 . Removed HTMLDefinition->info_flow_elements in favor of
 639   HTMLDefinition->content_sets['Flow']
 640 . Removed redundant "exclusionary" definitions from DTD roster
 641 . StrictBlockquote now requires a construction parameter as if it
 642   were an Required ChildDef, this is the "real" set of allowed elements
 643 . AttrDef partitioned into HTML, CSS and URI segments
 644 . Modify Youtube filter regexp to be multiline
 645 . Require both PHP5 and DOM extension in order to use DOMLex, fixes
 646   some edge cases where a DOMDocument class exists in a PHP4 environment
 647   due to DOM XML extension.
 648
 649 1.4.1, released 2007-01-21
 650 ! docs/enduser-youtube.html updated according to new functionality
 651 - YouTube IDs can have underscores and dashes
 652
 653 1.4.0, released 2007-01-21
 654 ! Implemented list-style-image, URIs now allowed in list-style
 655 ! Implemented background-image, background-repeat, background-attachment
 656   and background-position CSS properties. Shorthand property background
 657   supports all of these properties.
 658 ! Configuration documentation looks nicer
 659 ! Added %Core.EscapeNonASCIICharacters to workaround loss of Unicode
 660   characters while %Core.Encoding is set to a non-UTF-8 encoding.
 661 ! Support for configuration directive aliases added
 662 ! Config object can now be instantiated from ini files
 663 ! YouTube preservation code added to the core, with two lines of code
 664   you can add it as a filter to your code. See smoketests/preserveYouTube.php
 665   for sample code.
 666 ! Moved SLOW to docs/enduser-slow.html and added code examples
 667 - Replaced version check with functionality check for DOM (thanks Stephen
 668   Khoo)
 669 . Added smoketest 'all.php', which loads all other smoketests via frames
 670 . Implemented AttrDef_CSSURI for url(http://google.com) style declarations
 671 . Added convenient single test selector form on test runner
 672
 673 1.3.2, released 2006-12-25
 674 ! HTMLPurifier object now accepts configuration arrays, no need to manually
 675   instantiate a configuration object
 676 ! Context object now accessible to outside
 677 ! Added enduser-youtube.html, explains how to embed YouTube videos. See
 678   also corresponding smoketest preserveYouTube.php.
 679 ! Added purifyArray(), which takes a list of HTML and purifies it all
 680 ! Added static member variable $version to HTML Purifier with PHP-compatible
 681   version number string.
 682 - Fixed fatal error thrown by upper-cased language attributes
 683 - printDefinition.php: added labels, added better clarification
 684 . HTMLPurifier_Config::create() added, takes mixed variable and converts into
 685   a HTMLPurifier_Config object.
 686
 687 1.3.1, released 2006-12-06
 688 ! Added HTMLPurifier.func.php stub for a convenient function to call the library
 689 - Fixed bug in RemoveInvalidImg code that caused all images to be dropped
 690   (thanks to .mario for reporting this)
 691 . Standardized all attribute handling variables to attr, made it plural
 692
 693 1.3.0, released 2006-11-26
 694 # Invalid images are now removed, rather than replaced with a dud
 695   <img src="" alt="Invalid image" />. Previous behavior can be restored
 696   with new directive %Core.RemoveInvalidImg set to false.
 697 ! (X)HTML Strict now supported
 698   + Transparently handles inline elements in block context (blockquote)
 699 ! Added GET method to demo for easier validation, added 50kb max input size
 700 ! New directive %HTML.BlockWrapper, for block-ifying inline elements
 701 ! New directive %HTML.Parent, allows you to only allow inline content
 702 ! New directives %HTML.AllowedElements and %HTML.AllowedAttributes to let
 703   users narrow the set of allowed tags
 704 ! <li value="4"> and <ul start="2"> now allowed in loose mode
 705 ! New directives %URI.DisableExternalResources and %URI.DisableResources
 706 ! New directive %Attr.DisableURI, which eliminates all hyperlinking
 707 ! New directive %URI.Munge, munges URI so you can use some sort of redirector
 708   service to avoid PageRank leaks or warn users that they are exiting your site.
 709 ! Added spiffy new smoketest printDefinition.php, which lets you twiddle with
 710   the configuration settings and see how the internal rules are affected.
 711 ! New directive %URI.HostBlacklist for blocking links to bad hosts.
 712   xssAttacks.php smoketest updated accordingly.
 713 - Added missing type to ChildDef_Chameleon
 714 - Remove Tidy option from demo if there is not Tidy available
 715 . ChildDef_Required guards against empty tags
 716 . Lookup table HTMLDefinition->info_flow_elements added
 717 . Added peace-of-mind variable initialization to Strategy_FixNesting
 718 . Added HTMLPurifier->info_parent_def, parent child processing made special
 719 . Added internal documents briefly summarizing future progression of HTML
 720 . HTMLPurifier_Config->getBatch($namespace) added
 721 . More lenient casting to bool from string in HTMLPurifier_ConfigSchema
 722 . Refactored ChildDef classes into their own files
 723
 724 1.2.0, released 2006-11-19
 725 # ID attributes now disabled by default. New directives:
 726   + %HTML.EnableAttrID - restores old behavior by allowing IDs
 727   + %Attr.IDPrefix - %Attr.IDBlacklist alternative that munges all user IDs
 728     so that they don't collide with your IDs
 729   + %Attr.IDPrefixLocal - Same as above, but for when there are multiple
 730     instances of user content on the page
 731   + Profuse documentation on how to use these available in docs/enduser-id.txt
 732 ! Added MODx plugin <http://modxcms.com/forums/index.php/topic,6604.0.html>
 733 ! Added percent encoding normalization
 734 ! XSS attacks smoketest given facelift
 735 ! Configuration documentation now has table of contents
 736 ! Added %URI.DisableExternal, which prevents links to external websites.  You
 737   can also use %URI.Host to permit absolute linking to subdomains
 738 ! Non-accessible resources (ex. mailto) blocked from embedded URIs (img src)
 739 - Type variable in HTMLDefinition was not being set properly, fixed
 740 - Documentation updated
 741   + TODO added request Phalanger
 742   + TODO added request Native compression
 743   + TODO added request Remove redundant tags
 744   + TODO added possible plaintext formatter for HTML Purifier documentation
 745   + Updated ConfigDoc TODO
 746   + Improved inline comments in AttrDef/Class.php, AttrDef/CSS.php
 747     and AttrDef/Host.php
 748   + Revamped documentation into HTML, along with misc updates
 749 - HTMLPurifier_Context doesn't throw a variable reference error if you attempt
 750   to retrieve a non-existent variable
 751 . Switched to purify()-wide Context object registry
 752 . Refactored unit tests to minimize duplication
 753 . XSS attack sheet updated
 754 . configdoc.xml now has xml:space attached to default value nodes
 755 . Allow configuration directives to permit null values
 756 . Cleaned up test-cases to remove unnecessary swallowErrors()
 757
 758 1.1.2, released 2006-09-30
 759 ! Add HTMLPurifier.auto.php stub file that configures include_path
 760 - Documentation updated
 761   + INSTALL document rewritten
 762   + TODO added semi-lossy conversion
 763   + API Doxygen docs' file exclusions updated
 764   + Added notes on HTML versus XML attribute whitespace handling
 765   + Noted that HTMLPurifier_ChildDef_Custom isn't being used
 766   + Noted that config object's definitions are cached versions
 767 - Fixed lack of attribute parsing in HTMLPurifier_Lexer_PEARSax3
 768 - ftp:// URIs now have their typecodes checked
 769 - Hooked up HTMLPurifier_ChildDef_Custom's unit tests (they weren't being run)
 770 . Line endings standardized throughout project (svn:eol-style standardized)
 771 . Refactored parseData() to general Lexer class
 772 . Tester named "HTML Purifier" not "HTMLPurifier"
 773
 774 1.1.1, released 2006-09-24
 775 ! Configuration option to optionally Tidy up output for indentation to make up
 776   for dropped whitespace by DOMLex (pretty-printing for the entire application
 777   should be done by a page-wide Tidy)
 778 - Various documentation updates
 779 - Fixed parse error in configuration documentation script
 780 - Fixed fatal error in benchmark scripts, slightly augmented
 781 - As far as possible, whitespace is preserved in-between table children
 782 - Sample test-settings.php file included
 783
 784 1.1.0, released 2006-09-16
 785 ! Directive documentation generation using XSLT
 786 ! XHTML can now be turned off, output becomes <br>
 787 - Made URI validator more forgiving: will ignore leading and trailing
 788   quotes, apostrophes and less than or greater than signs.
 789 - Enforce alphanumeric namespace and directive names for configuration.
 790 - Table child definition made more flexible, will fix up poorly ordered elements
 791 . Renamed ConfigDef to ConfigSchema
 792
 793 1.0.1, released 2006-09-04
 794 - Fixed slight bug in DOMLex attribute parsing
 795 - Fixed rejection of case-insensitive configuration values when there is a
 796   set of allowed values.  This manifested in %Core.Encoding.
 797 - Fixed rejection of inline style declarations that had lots of extra
 798   space in them.  This manifested in TinyMCE.
 799
 800 1.0.0, released 2006-09-01
 801 ! Shorthand CSS properties implemented: font, border, background, list-style
 802 ! Basic color keywords translated into hexadecimal values
 803 ! Table CSS properties implemented
 804 ! Support for charsets other than UTF-8 (defined by iconv)
 805 ! Malformed UTF-8 and non-SGML character detection and cleaning implemented
 806 - Fixed broken numeric entity conversion
 807 - API documentation completed
 808 . (HTML|CSS)Definition de-singleton-ized
 809
 810 1.0.0beta, released 2006-08-16
 811 ! First public release, most functionality implemented. Notable omissions are:
 812   + Shorthand CSS properties
 813   + Table CSS properties
 814   + Deprecated attribute transformations