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