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