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