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