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