This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This release adds support for uploading pasted images and improves the performance and security of XWiki, among other minor improvements and bug fixes. This release contains security fixes, with the highest severity being 8.5/10.

New and Noteworthy (since XWiki 17.0.0)

Full list of issues fixed and Dashboard for 17.1.0.

For Users

Pasted Images are Uploaded as Attachments

 
If you copy images using the browser's Copy Image context menu or by selecting content (HTML) from the web that includes images, and paste them into the editor those images will be uploaded as attachments to the edited wiki page. You can prevent this by closing the notification message that is displayed before the images are uploaded. Note that it's not always possible to download the external images that were pasted (i.e. if they were copied from a different domain that has not configured CORS access), in order to upload them as attachments. In this case the external image will be referenced, so your content will depend on the availability of the external server. See the WYSIWYG editor documentation for more information.

Miscellaneous

• Document save speed improvements: 

  • Only modified objects are now really sent to the database. This should provide an important performance boost when doing small modifications to an existing document that contains a lot of objects.
  • XWiki does not store diff anymore for the history. It was not adding that much value and could be very expensive for big documents.

• Message macros now support the "status" role: A new parameter has been added to the message macros (info, warning, error, success) to improve their accessibility. This new parameter is the boolean status and will make sure any user is notified of the content of the message when it's created and updated. This new parameter is described in detail in the Message Macros documentation.

For Admins

No changes!

For Developers

• Required rights analyzers for macro parameters: A new component type MacroParameterRequiredRightsAnalyzer has been introduced to allow writing required rights analyzers for certain types of macro parameters like wiki syntax parameters. See the documentation for more details.

• Servlet resource URLs are cached: A cache has been added for servlet resources. It significantly speeds up requests in certain Servlet containers like Jetty 12 (we observed 50% faster responses). However, it means that new or deleted files in the WAR might not be noticed anymore by a running XWiki instance. You can bypass the cache in a request by force-refreshing the page. A restart also clears the cache.

• Jakarta-based session events: New Jakarta alternatives to SessionCreatedEvent and SessionDestroyedEvent events have been added. See Container Module for more details.

• Compressed tables: It's possible to enable compression for a table directly in the Hibernate mapping file. See DatabaseSchema for more details.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Translations

The following translations have been updated: 

• German
• French
• Russian

Security Issues

Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the XWiki Security Policy for more details.

Known issues

• Bugs we know about

Backward Compatibility and Migration Notes

General Notes

• When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
  • xwiki.cfg
  • xwiki.properties
  • web.xml
  • hibernate.cfg.xml
• Add xwiki.store.migration=1 in xwiki.cfg so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 17.1.0

No more diff in the history

Each version now contains a full serialization of the document while it used to be a diff and a full serialization only every 5 versions. It should provide an important performance boost for documents with a lot of objects, but if you notice problems because of this change don't hesitate to report it. See DsXWikiIrcs for more details about the storage.

API Breakages

The following APIs were modified since XWiki 17.0.0:

No breakage!

Credits

The following people have contributed code and translations to this release (sorted alphabetically):

• Dorian OUAKLI 
• Gankov Andrey 
• LucasC 
• Manuel Leduc 
• Marius Dumitru Florea 
• Michael Hamann 
• Simon Urli 
• Simpel 
• Thomas Mortagne 
• Vincent Massol 
• anonymous 
• jameswartell 
• raphj 
• xrichard