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