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