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