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