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