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