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