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