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