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