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