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