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