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