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