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