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