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