Release Notes XWiki 7.4 Milestone 2

Last modified by Thomas Mortagne on 2023/10/13
Contents

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

This is our last stabilization branch for the XWiki 7.x Cycle. It brings polishing and stabilization for the Nested Pages feature and the changes in UI that resulted from it. It is now possible to have template hierarchies, and to add an automatic redirect when a page is renamed.

New and Noteworthy (since XWiki 7.4 Milestone 1)

Full list of issues fixed and Dashboard for 7.4.

Support for template hierarchies

When creating a new document from template, if the template has descendent documents under its path, those documents will also be copied over to the new document's location, preserving the hierarchy, as it was under the template document.

The save operation will display progress and if it was a Save&View operation, the form will be disabled until the operation is complete.

More details on the documentation page on document templates.

savingNewDocumentWithTemplateHierarchy.png

Automatic Redirect on Page Rename

The Rename Page action has a new option (selected by default) to create an automatic redirect from the old page location to the new one. This will ensure that the external links (e.g. the bookmarks) to the renamed page (and its children) will continue to work.

RenameConfirmFlamingo.png

Database Search

The Database Search UI has been modified to support nested pages.

databaseSearch.png

Miscellaneous

  • The "annotations" button in the "More Actions" menu has been moved in the same menu but with other actions and renamed "Annotate".

      Annotate.png

  • The Create Page UI allows you to view and change the location of the new page (that is going to be created) even when you open directly the URL of a new page.

See the full list of JIRA issues fixed in this release.

For Developers

New lifespan LRU Cache setup

It's now possible to define the maximum time to live since the entry is put in the cache. It used to be possible to set it only since the last time the value was used.

// Configure cache eviction policy
LRUEvictionConfiguration lru = new LRUEvictionConfiguration();
// Set maximum size of the cache as 1000 entries
lru.setMaxEntries(1000);
// Set the maximum time to live since when the entry is used to 1 hour
lru.setMaxIdle(3600)
// Set the maximum time to live since when the entry is put in the cache to 1 hour
lru.setLifespan(3600)

Cache Macro and Rendering Cache are now based on this behavior.

VFS API

Right now the VFS API is missing authorization checks, meaning that you should use it only for public archives.

Replacement of the Zip Explorer Plugin. API to access the content of archives files (zip, jar, gzip, tar, etc) located as attachments in wiki pages or elsewhere (external URLs, file system, et).

In addition a new Velocity Tool was added in order to be able to use a portion of the NIO2 API from Velocity: niotool.

See VFS API and VFS Tree Macro for more details. Some API examples:

{{velocity}}
## Get the URL to access the content of a file inside a zip:
[[link to file in zip>>$services.vfs.url("attach:Sandbox.WebHome@vma.txt.zip/vma.txt")]]

## Display inline an image from a zip attached to a wiki page:
[[image:path:$services.vfs.url("attach:Sandbox.WebHome@test.zip/test.png")]]

## Read the content of a file inside a zip attached to a page:
$stringtool.toString($niotool.readAllBytes("attach:Sandbox.WebHome@vma.txt.zip/vma.txt"), "utf-8")

## List all entries inside a zip attached to a page:
#set ($dirStream = $niotool.newDirectoryStream("attach:Sandbox.WebHome@vma.txt.zip/"))
#foreach ($entry in $dirStream)
  * {{{$entry}}} - $niotool.isDirectory($entry)
#end
{{/velocity}}

{{vfsTree root="attach:Sandbox.WebHome@vma.txt.zip/"/}}

Example of using the vfsTree Macro:

{{vfsTree root="attach:Sandbox.WebHome@vma.txt.zip/"/}}

Results in:

vfstree.png

Miscellaneous

  • WebJars URL format now supports a wiki query string parameter to specify the wiki in which the webjars resource is available. For example: /xwiki/webjars/AjaxQ/0.0.2/ajaxq.js?wiki=mywiki
  • The default link behaviour can be disabled for a tree node, when you use the Tree Widget, by using the 'jstree-no-link' CSS class on the node anchor, which can be set from the node JSON:
    {
      ... (node JSON) ...
      'a_attr': {
        'class': 'jstree-no-link',
        'href': 'some/url'
      }
    }
  • The $regextool Velocity Tool has a new method:
    /**
     * @param content the content to parse
     * @param regex the regular expression to look for in the passed content
     * @return an empty list if the passed regular expression doesn't match the content, several {@link RegexResult}
     *         objects containing the matched position and matched content for all capturing groups and sub-groups
     *         otherwise
     */
    public List<List<RegexResult>> findAll(String content, String regex)

    We had to add a new method because the existing RegexTool#find(String, String) returns information about only the first capturing group. Here's a test to show how the new method works:

    @Test
    public void findAll()
    {
        RegexTool tool = new RegexTool();
        List<List<RegexResult>> result =
            tool.findAll("one :two three (:four) five :six seven=:eight", ":(\\w+) (\\w+)");

        Assert.assertEquals(2, result.size());
        Assert.assertEquals(":two three", result.get(0).get(0).getGroup());
        Assert.assertEquals(":six seven", result.get(1).get(0).getGroup());

        Assert.assertEquals(3, result.get(0).size());
        Assert.assertEquals("two", result.get(0).get(1).getGroup());
        Assert.assertEquals("three", result.get(0).get(2).getGroup());

        Assert.assertEquals(3, result.get(1).size());
        Assert.assertEquals("six", result.get(1).get(1).getGroup());
        Assert.assertEquals("seven", result.get(1).get(2).getGroup());
    }

Deprecated and Retired projects

Upgrades

The following dependencies have been upgraded:

Translations

The following translations have been updated: 

Tested Browsers & Databases

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:TestReports.ManualTestReportSummaryXWiki74M2]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Here is the list of browsers we support and how they have been tested for this release:

BrowserTest Result
Chrome30.pngGoogle Chrome 47Not Tested
Firefox30.pngMozilla Firefox 43Jira Tickets Marked as Fixed in the Release Notes
IE30.pngInternet Explorer 10Not Tested
IE30.pngInternet Explorer 11Not Tested

Here is the list of databases we support and how they have been tested for this release:

DatabaseTest Result
hypersql.pngHyperSQL 2.3.3Not Tested
mysql.pngMySQL 5.6.24Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.3.10Jira Tickets Marked as Fixed in the Release Notes

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

API Breakages

The following APIs were modified since XWiki 7.3:

  • Job code was wrongly extending an internal class:
    org.xwiki.extension.job.history.ReplayJobStatus: Removed org.xwiki.job.internal.AbstractJobStatus from the list of superclasses
    org.xwiki.extension.job.history.ReplayJobStatus: Removed org.xwiki.job.internal.DefaultJobStatus from the list of superclasses
    org.xwiki.extension.xar.job.diff.DiffXarJobStatus: Removed org.xwiki.job.internal.AbstractJobStatus from the list of superclasses
    org.xwiki.extension.xar.job.diff.DiffXarJobStatus: Removed org.xwiki.job.internal.DefaultJobStatus from the list of superclasses
    org.xwiki.refactoring.job.EntityJobStatus: Removed org.xwiki.job.internal.AbstractJobStatus from the list of superclasses
    org.xwiki.refactoring.job.EntityJobStatus: Removed org.xwiki.job.internal.DefaultJobStatus from the list of superclasses
  • Remove the XMLRPC module:
    com.xpn.xwiki.XWikiContext: Method 'public org.apache.xmlrpc.server.XmlRpcServer ajc$get$xmlRpcServer(com.xpn.xwiki.XWikiContext)' has been removed
    com.xpn.xwiki.XWikiContext: Method 'public void ajc$set$xmlRpcServer(com.xpn.xwiki.XWikiContext, org.apache.xmlrpc.server.XmlRpcServer)' has been removed
    com.xpn.xwiki.XWikiContext: Method 'public org.apache.xmlrpc.server.XmlRpcServer getXMLRPCServer()' has been removed
    com.xpn.xwiki.XWikiContext: Method 'public void setXMLRPCServer(org.apache.xmlrpc.server.XmlRpcServer)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public org.apache.xmlrpc.server.XmlRpcServer ajc$interFieldGetDispatch$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$xmlRpcServer(com.xpn.xwiki.XWikiContext)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public void ajc$interFieldInit$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$xmlRpcServer(com.xpn.xwiki.XWikiContext)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public void ajc$interFieldSetDispatch$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$xmlRpcServer(com.xpn.xwiki.XWikiContext, org.apache.xmlrpc.server.XmlRpcServer)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public org.apache.xmlrpc.server.XmlRpcServer ajc$interMethod$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$getXMLRPCServer(com.xpn.xwiki.XWikiContext)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public void ajc$interMethod$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$setXMLRPCServer(com.xpn.xwiki.XWikiContext, org.apache.xmlrpc.server.XmlRpcServer)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public org.apache.xmlrpc.server.XmlRpcServer ajc$interMethodDispatch1$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$getXMLRPCServer(com.xpn.xwiki.XWikiContext)' has been removed
    com.xpn.xwiki.XWikiContextCompatibilityAspect: Method 'public void ajc$interMethodDispatch1$com_xpn_xwiki_XWikiContextCompatibilityAspect$com_xpn_xwiki_XWikiContext$setXMLRPCServer(com.xpn.xwiki.XWikiContext, org.apache.xmlrpc.server.XmlRpcServer)' has been removed

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected