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