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