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