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