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