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