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