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