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