Release Notes for XWiki 5.3 (XWiki.org)

This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. They share the same release notes as they are released together and have the same version.

6

7

8

We've discovered several important regressions in this version after it was released:

9

10

* Repairing the main wiki UI when upgrading from an XWiki version older than 4.2 using the Distribution Wizard doesn't work any more ([[XWIKI-9912>>http://jira.xwiki.org/browse/XWIKI-9912]]).

11

* The ##history## URL parameter is ignored when [[exporting a page as XAR>>platform:Features.Exports||anchor="HXARExport"]] ([[XWIKI-9913>>http://jira.xwiki.org/browse/XWIKI-9913]]). The workaround is to switch to old packager plugin using property ##xwiki.action.export.xar.usewikistream## in ##xwiki.cfg## file.

12

13

They will be fixed in XWiki 5.3.1 and later.

14

15

16

This release comes with a new syntax guide and brings improvements to the Solr search, multi-wiki support and the Wiki Stream module. You can now choose the user scope (local, global or both) and also create wiki templates from the wiki creation wizard. The Wiki Stream can be used to import large XARs and content from the Confluence wiki. The Solr search UI has been polished: we added new facets and improved the results display. The Solr index has been modified to support the search for documents matching specific values in multiple object properties and attachments. As a consequence you can now facet and sort the search results based on property values and attachment meta data. A lot of bug fixes (115) and many improvements (55) complete this release and make it worth trying.

17

18

= New and Noteworthy (since XWiki 5.2.2) =

19

20

[[Full list of issues fixed and Dashboard for 5.3>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11698]].

21

22

== Solr Search Improvements ==

23

24

=== Search Results Display ===

25

26

We improved the way attachments, objects and object properties are displayed in the list of search results.

Attachment search results are now displayed in the same way attachments are displayed in the Attachments bottom tab from any wiki page. We also added support for sorting attachment search results based on the file name, file size, uploader and upload date.

For object results we now display the XClass name instead of the document title.

Object property results show the XClass name and the property name instead of the document title.

39

40

=== Search Facets ===

41

42

We added a couple of new search facets and we improved the display of some of the existing ones. The search facets are now collapsed by default.

The Author and Creator facets now show the user full name, alias and avatar.

The wiki facet displays the wiki pretty name instead of the wiki identifier.

The language facet displays the full language name and country (when applicable) in the current locale.

As you can see there can be documents with no language set. We also added a hint to explain why this is possible.

The number of displayed facet values is limited to 5 by default but you can see the rest of the values by clicking on the link following the facet values (each click will show 5 more values).

63

64

The date facets (last modification date and creation date) have been improved to display a list of predefined date intervals, with the possibility to specify a custom date interval.

When selected, the date facet displays the end points of the date interval. If you specify only the start/end date then the interval will include all dates after/before the specified date.

The 'Object Type' facet displays the XClass names in a prettier way. In case you want to know the actual document that defines the XClass you can hover on the XClass pretty name.

You can now use the 'Media Type', 'Uploaded By', 'Upload Date' and 'File Size' facets to filter attachment results and even documents that have attachments.

77

78

We also improved the way Static List properties are indexed. We now index the raw value (what is saved in the database) as verbatim (without being analysed, for exact matching) and the display value (what is specified in the XClass) as localized text (using the locale of the document that holds the XObject).

=== RSS Feed ===

We added a RSS feed for Solr search results. You can find the link on the default search page after the list of results. The feed provides the most recent results that match the current search query and filters. It contains the same type of information that was included in the Lucene search RSS feed.

83

84

See the [[Solr Search Application documentation>>extensions:Extension.Solr Search Application]] for details.

85

86

{{include reference="ReleaseNotesXWiki53M2" section="HWikiStreamimprovements"/}}

87

88

=== Import large XARs ===

89

90

It's possible to enable the use of new [[WikiStream>>doc:extensions:Extension.Wiki Stream Module]] framework in standard import action (used in the standard import UI for example). Among other things it allows importing a wiki XAR of pretty much any size.

91

92

[[WikiStream>>doc:extensions:Extension.Wiki Stream Module]] is too young to be enabled by default and will require heavy testing. In the meantime you can try it by uncommenting {{code}}#xwiki.action.import.xar.usewikistream=1{{/code}} at the end of xwiki.cfg file.

93

94

{{display reference="ReleaseNotesXWiki53M2" section="HNewSyntaxGuide"/}}

95

96

{{display reference="ReleaseNotesXWiki53M2" section="HMulti-Wiki"/}}

== Miscellaneous ==

Changes regarding the multi-wiki support:

101

102

* When creating an empty wiki you now get the Distribution Wizard even when ##ALLINONE## upgrade is selected (this used to disable the Distribution Wizard on subwikis)

103

* When a new wiki is created from the Add Wiki Wizard, its Activity Stream is now empty.

104

* If you want to change the wiki owner or the prettyname of the wiki, you cannot go to the "Wiki" section of the Wiki Administration anymore since it's been removed for the moment due to some technical issue. Instead, go to the Wiki Index and then click on the "edit" action corresponding to the wiki for which to update the settings.

105

* Deleted users do not appear anymore in the "Top Active Members" list in the wiki dashboard.

Other changes:

* The Statistics Application now has an entry point in the Applications Panel (only visible by Admins by default):(((

110

111

)))

112

* The Scheduler Application now has an entry point in the Applications Panel (only visible by Admins by default):(((

113

114

)))

115

* We're now officially not supporting saving Servlet Session in URL (a.k.a URL Rewriting). This means that if you want to remain logged on in XWiki you need to enable cookies (See why ##jsessionid## are considered harmful [[here>>https://randomcoder.org/articles/jsessionid-considered-harmful]] and [[here>>http://java.dzone.com/articles/java-jsessionid-harmful]]).

116

* By default only results from XE instance pings and for non-snapshot versions are counted in [[Active Installs>>extensions:Extension.Active Installs Server Application]].

117

* Added new configuration parameter for the Link Checker: ##rendering.transformation.linkchecker.excludedReferencePatterns## (See [[Reference documentation>>extensions:Extension.Link Checker Transformation]]).

118

* Some XSS fixes.

119

120

See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+in+%28%225.3-milestone-1%22%2C+%225.3-milestone-2%22%2C+%225.3-rc-1%22%2C+%225.3%22%29&tempMax=1000]] fixed in this release.

= For Developers =

{{include reference="ReleaseNotesXWiki53RC1" section="HSearchforDocumentsMatchingSpecificValuesinMultipleXObjectProperties"/}}

125

126

== Search for Documents Matching Specific Attachment Meta Data ==

127

128

Another important search use case is to find documents matching specific attachment meta data. For instance, you could be looking for a blog post that has a PDF file attached. Or you may be searching for a wiki page where you recently uploaded an image. Finding the documents tagged with 'News' and which have large attachments is another example.

129

130

Previously, we were indexing attachment data on separate index rows. As with XObjects, you had to use joins in the Solr search syntax in order to match both document and attachment rows in the search index. Starting with this version we index attachment data on document rows also. Obviously this means the attachment data is now duplicated but we think the increase of the index size is worth the improved search speed and the simplified query syntax:

131

132

133

object:Blog.BlogPostClass AND mimetype:"application/pdf" AND mistake

134

135

title:profile attdate:[NOW-3DAYS TO NOW] AND mimetype:image\/*

136

137

property.XWiki.TagClass.tags:"News" AND attsize:[50000 TO *]

138

139

140

See [[Solr Schema Design>>design:Design.SolrSchema]] for the list of attachment fields that can be used in the Solr search query.

141

142

{{include reference="ReleaseNotesXWiki53M1" section="HDocumentReferenceLocalenowtakenintoaccountinXWiki23existsandXWiki23getDocument"/}}

143

144

{{include reference="ReleaseNotesXWiki53M1" section="HNewExtensionManagerAPIs"/}}

145

146

{{include reference="ReleaseNotesXWiki53M1" section="HXWikiEnterpriseArchetype"/}}

147

148

{{include reference="ReleaseNotesXWiki53M1" section="HXARpluginimprovements"/}}

149

150

{{include reference="ReleaseNotesXWiki53M1" section="HFoldEvents"/}}

151

152

{{include reference="ReleaseNotesXWiki53M2" section="HMulti-Wiki-1"/}}

153

154

== Deprecated and Retired projects ==

155

156

* Workspace has been moved to https://github.com/xwiki-contrib/xwiki-platform-workspace

== Upgrades ==

The following dependencies have been upgraded:

161

162

* [[Bouncy Castle Crypto package 1.49>>http://jira.xwiki.org/browse/XWIKI-9631]] (Warning: Not fully binary compatible)

163

* [[commons-fileupload 1.3>>http://jira.xwiki.org/browse/XCOMMONS-458]]

164

* [[cssparser 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-459]]

165

* [[Groovy 2.1.9>>http://jira.xwiki.org/browse/XWIKI-9603]]

166

* [[HttpClient 4.3>>http://jira.xwiki.org/browse/XCOMMONS-460]]

167

* [[Struts 1.3.10>>http://jira.xwiki.org/browse/XWIKI-9582]]

168

* [[XStream 1.4.5>>http://jira.xwiki.org/browse/XCOMMONS-462]]

== Miscellaneous ==

* [[Script Services implementations have been moved outside of the ##internal## package>>dev:Community.JavaCodeStyle||anchor="HPackagenames"]] in order for CLIRR to check them for backward incompatibilities and so that their API are made available in generated Javadoc.

173

* [[New Java API + a few new APIs in the Git module>>extensions:Extension.Git Module]]

174

* New {{code language="none"}}com.xpn.xwiki.doc.XWikiDocument#getDocumentReferenceWithLocale(){{/code}} method to get the real reference of the document to use in {{code language="none"}}com.xpn.xwiki.XWiki#getDocument(DocumentReference, XWikiContext){{/code}} for example

175

* You can now easily [[run functional tests using PhantomJS>>dev:Community.Testing||anchor="HSelenium2-basedFramework"]] by using ##-Dbrowser=*phantomjs##.

= Translations =

The following translations have been updated:

180

181

{{language codes="ca, da, de, es, fr, it, lv, nl, pt_BR, ru, sv, uk"/}}

182

183

= Tested Browsers & Databases =

184

185

{{include reference="TestReports.ManualTestReportXWiki53Summary"/}}

= Known issues =

* [[Bugs we know about>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+%3D+%22Top+Level+Projects%22+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]]

190

191

= 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.

196

197

== Solr Search Index ==

198

199

200

We made important changes to the [[Solr schema>>http://design.xwiki.org/xwiki/bin/view/Design/SolrSchema]] in this release and unfortunately we don't have support for automatic Solr search index migration at this point. If you upgrade from XWiki 4.3 Milestone 2 or greater then **you have to delete the 'solr' folder** from the configured permanent directory of your XWiki instance. The Solr index will be recreated automatically and the entire wiki/farm will be re-indexed after a server restart.

201

202

203

The following index fields are now **multiValued**: class, filename, mimetype and attcontent. The reason is because these fields are now used also on document index rows, and a document can have multiple XObjects and multiple attachments. This is a consequence of the fact that we now index XObject and attachment data on document rows to avoid the need for using joins in the Solr query syntax when matching documents with specific XObjects and attachments. You'll have to update your code like this:

## Before

#set ($classFullName = $searchResult.get('class'))

208

##

209

## Now

210

#set ($classFullName = $searchResult.get('class').get(0))

== API Breakages ==

The following APIs were modified since XWiki 5.2.2:

216

217

* Requesting a dependency without indicating the namespace does not really make sense. This interface is not really supposed to be implemented anyway.

218

219

220

org.xwiki.extension.ExtensionManager: Method 'public org.xwiki.extension.Extension resolveExtension(org.xwiki.extension.ExtensionDependency, java.lang.String)' has been added to an interface

221

222

223

* Needed to filter search by namespace. This interface is not really supposed to be implemented anyway.

224

225

226

org.xwiki.extension.repository.InstalledExtensionRepository: Method 'public org.xwiki.extension.repository.result.IterableResult searchInstalledExtensions(java.lang.String, java.lang.String, int, int)' has been added to an interface

227

228

229

* Young API. Not supposed to be implemented from outside.

230

231

232

org.xwiki.filter.xml.parser.XMLParserFactory: Method 'public javax.xml.stream.XMLEventWriter createXMLEventWriter(java.lang.Object, org.xwiki.filter.xml.XMLConfiguration)' has been added to an interface

233

org.xwiki.filter.xml.serializer.XMLSerializerFactory: Method 'public java.lang.Object createSerializer(java.lang.Class[], javax.xml.transform.Result, org.xwiki.filter.xml.XMLConfiguration)' has been added to an interface

234

235

236

* Young API. Not supposed to be implemented from outside.

237

238

239

org.xwiki.filter.FilterDescriptorManager: Method 'public java.lang.Object createCompositeFilter(java.lang.ClassLoader, java.lang.Object[])' has been added to an interface

240

org.xwiki.filter.FilterDescriptorManager: Method 'public java.lang.Object createFilterProxy(java.lang.Object, java.lang.ClassLoader, java.lang.Class[])' has been added to an interface

241

242

243

* Young API that has been refactored to introduce the new Resource module.

244

245

246

org.xwiki.url.AbstractXWikiURL: Class org.xwiki.url.AbstractXWikiURL removed

247

org.xwiki.url.URLCreationException: Class org.xwiki.url.URLCreationException removed

248

org.xwiki.url.UnsupportedURLException: Class org.xwiki.url.UnsupportedURLException removed

249

org.xwiki.url.XWikiEntityURL: Class org.xwiki.url.XWikiEntityURL removed

250

org.xwiki.url.XWikiURL: Class org.xwiki.url.XWikiURL removed

251

org.xwiki.url.XWikiURLFactory: Class org.xwiki.url.XWikiURLFactory removed

252

org.xwiki.url.XWikiURLManager: Class org.xwiki.url.XWikiURLManager removed

253

org.xwiki.url.XWikiURLSerializer: Class org.xwiki.url.XWikiURLSerializer removed

254

org.xwiki.url.XWikiURLType: Class org.xwiki.url.XWikiURLType removed

255

256

257

* XWikiURL (now Resource) should only be in the Execution Context and not in the Request.

258

259

260

org.xwiki.container.servlet.ServletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed

261

org.xwiki.container.servlet.ServletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed

262

org.xwiki.container.portlet.PortletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed

263

org.xwiki.container.portlet.PortletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed

264

org.xwiki.container.Request: Field XWIKI_URL has been removed, but it was previously a constant

265

266

267

* Lots of refactoring in WikiStream.

268

269

270

org.xwiki.wikistream.xml.input.source.SourceInputSource: Class org.xwiki.wikistream.xml.input.source.SourceInputSource removed

271

org.xwiki.wikistream.WikiStream: Class org.xwiki.wikistream.WikiStream removed

272

org.xwiki.wikistream.descriptor.DefaultWikiStreamBeanParameterDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed

273

org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed

274

org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getType()' has been added to an interface

275

org.xwiki.wikistream.filter.FarmFilter: Class org.xwiki.wikistream.filter.FarmFilter removed

276

org.xwiki.wikistream.filter.WikiAttachmentFilter: Class org.xwiki.wikistream.filter.WikiAttachmentFilter removed

277

org.xwiki.wikistream.filter.WikiClassFilter: Class org.xwiki.wikistream.filter.WikiClassFilter removed

278

org.xwiki.wikistream.filter.WikiClassPropertyFilter: Class org.xwiki.wikistream.filter.WikiClassPropertyFilter removed

279

org.xwiki.wikistream.filter.WikiDocumentFilter: Class org.xwiki.wikistream.filter.WikiDocumentFilter removed

280

org.xwiki.wikistream.filter.WikiFilter: Class org.xwiki.wikistream.filter.WikiFilter removed

281

org.xwiki.wikistream.filter.WikiObjectFilter: Class org.xwiki.wikistream.filter.WikiObjectFilter removed

282

org.xwiki.wikistream.filter.WikiObjectPropertyFilter: Class org.xwiki.wikistream.filter.WikiObjectPropertyFilter removed

283

org.xwiki.wikistream.filter.WikiSpaceFilter: Class org.xwiki.wikistream.filter.WikiSpaceFilter removed

284

org.xwiki.wikistream.input.BeanInputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces

285

org.xwiki.wikistream.input.BeanInputWikiStreamFactory: Return type of method 'public org.xwiki.wikistream.input.InputWikiStream createInputWikiStream(java.lang.Object)' has been changed to org.xwiki.wikistream.internal.input.BeanInputWikiStream

286

org.xwiki.wikistream.input.InputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces

287

org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces

288

org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.lang.Object)' has been removed

289

org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.internal.output.BeanOutputWikiStream createOutputWikiStream(java.lang.Object)' has been added to an interface

290

org.xwiki.wikistream.output.OutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces

291

org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.util.Map)' has been removed

292

org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(java.util.Map)' has been added to an interface

293

org.xwiki.wikistream.type.WikiStreamType: Removed field XWIKI_XAR

294

org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces

295

org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces

296

org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces

297

org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces

298

org.xwiki.wikistream.instance.input.EntityEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface

299

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces

300

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces

301

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces

302

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces

303

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface

304

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public java.util.Collection getFilterInterfaces()' has been added to an interface

305

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiDocumentParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface

306

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiFarmParameters(org.xwiki.filter.FilterEventParameters)' has been added to an interface

307

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface

308

org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiSpaceParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface

309

org.xwiki.wikistream.instance.output.OutputInstanceWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces

310

org.xwiki.wikistream.instance.script.InstanceWikiStreamScriptService: Method 'public void export(org.xwiki.wikistream.type.WikiStreamType, org.xwiki.wikistream.instance.internal.input.InstanceInputProperties, java.util.Map)' has been removed

311

org.xwiki.wikistream.instance.script.InstanceWikiStreamScriptService: Return type of method 'public org.xwiki.wikistream.instance.internal.input.InstanceInputProperties newInstanceInputProperties()' has been changed to org.xwiki.wikistream.instance.input.InstanceInputProperties

312

org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public void convert(org.xwiki.wikistream.type.WikiStreamType, java.util.Map, org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed

313

org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.input.InputWikiStream createInputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed

314

org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed

315

Wiki source code of Release Notes for XWiki 5.3

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected