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