Wiki source code of Release Notes for XWiki 5.3

Last modified by Thomas Mortagne on 2023/10/13

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 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.
7 {{error}}
8 We've discovered several important regressions in this version after it was released:
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>>]]).
11 * The ##history## URL parameter is ignored when [[exporting a page as XAR>>Documentation.UserGuide.Features.Exports||anchor="HXARExport"]] ([[XWIKI-9913>>]]). The workaround is to switch to old packager plugin using property ##xwiki.action.export.xar.usewikistream## in ##xwiki.cfg## file.
13 They will be fixed in XWiki 5.3.1 and later.
15 In addition the WikiStream-based standard import UI is not really usable, see [[XWIKI-9932>>]]. As a workaround you can use the [[WikiStream application>>extensions:Extension.XWiki Platform - WikiStream - UI]] to import a XAR.
16 {{/error}}
18 This release comes with a new syntax guide and brings improvements to the Solr search, multi-wiki support and the WikiStream module. You can now choose the user scope (local, global or both) and also create wiki templates from the wiki creation wizard. The WikiStream 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.
20 = New and Noteworthy (since XWiki 5.2.2) =
22 [[Full list of issues fixed and Dashboard for 5.3>>]].
24 == Solr Search Improvements ==
26 === Search Results Display ===
28 We improved the way attachments, objects and object properties are displayed in the list of search results.
30 {{image reference="searchAttachmentSort.png"/}}
32 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.
34 {{image reference="searchObjectResult.png"/}}
36 For object results we now display the XClass name instead of the document title.
38 {{image reference="searchObjectPropertyResult.png"/}}
40 Object property results show the XClass name and the property name instead of the document title.
42 === Search Facets ===
44 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.
46 {{image reference="searchFacets.png"/}}
48 The Author and Creator facets now show the user full name, alias and avatar.
50 {{image reference="[email protected]"/}}
52 The wiki facet displays the wiki pretty name instead of the wiki identifier.
54 {{image reference="[email protected]"/}}
56 The language facet displays the full language name and country (when applicable) in the current locale.
58 {{image reference="searchLanguageFacet.png"/}}
60 As you can see there can be documents with no language set. We also added a hint to explain why this is possible.
62 {{image reference="[email protected]"/}}
64 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).
66 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.
68 {{image reference="[email protected]"/}}
70 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.
72 {{image reference="[email protected]"/}}
74 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.
76 {{image reference="[email protected]"/}}
78 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.
80 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).
82 === RSS Feed ===
84 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.
86 See the [[Solr Search Application documentation>>extensions:Extension.Solr Search Application]] for details.
88 {{include reference="ReleaseNotesXWiki53M2" section="HWikiStreamimprovements"/}}
90 === Import large XARs ===
92 It's possible to enable the use of new [[WikiStream>>doc:extensions:Extension.WikiStream 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.
94 [[WikiStream>>doc:extensions:Extension.WikiStream 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.
96 {{display reference="ReleaseNotesXWiki53M2" section="HNewSyntaxGuide"/}}
98 {{display reference="ReleaseNotesXWiki53M2" section="HMulti-Wiki"/}}
100 == Miscellaneous ==
102 Changes regarding the multi-wiki support:
104 * 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)
105 * When a new wiki is created from the Add Wiki Wizard, its Activity Stream is now empty.
106 * 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.
107 * Deleted users do not appear anymore in the "Top Active Members" list in the wiki dashboard.
109 Other changes:
111 * The Statistics Application now has an entry point in the Applications Panel (only visible by Admins by default):(((
112 {{image reference="[email protected]"/}}
113 )))
114 * The Scheduler Application now has an entry point in the Applications Panel (only visible by Admins by default):(((
115 {{image reference="[email protected]"/}}
116 )))
117 * 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>>]] and [[here>>]]).
118 * By default only results from XE instance pings and for non-snapshot versions are counted in [[Active Installs>>extensions:Extension.Active Installs Server Application]].
119 * Added new configuration parameter for the Link Checker: ##rendering.transformation.linkchecker.excludedReferencePatterns## (See [[Reference documentation>>extensions:Extension.Link Checker Transformation]]).
120 * Some XSS fixes.
122 See the [[full list of JIRA issues>>]] fixed in this release.
124 = For Developers =
126 {{include reference="ReleaseNotesXWiki53RC1" section="HSearchforDocumentsMatchingSpecificValuesinMultipleXObjectProperties"/}}
128 == Search for Documents Matching Specific Attachment Meta Data ==
130 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.
132 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:
134 {{code language="none"}}
135 object:Blog.BlogPostClass AND mimetype:"application/pdf" AND mistake
137 title:profile attdate:[NOW-3DAYS TO NOW] AND mimetype:image\/*
139 property.XWiki.TagClass.tags:"News" AND attsize:[50000 TO *]
140 {{/code}}
142 See [[Solr Schema Design>>design:Design.SolrSchema]] for the list of attachment fields that can be used in the Solr search query.
144 {{include reference="ReleaseNotesXWiki53M1" section="HDocumentReferenceLocalenowtakenintoaccountinXWiki23existsandXWiki23getDocument"/}}
146 {{include reference="ReleaseNotesXWiki53M1" section="HNewExtensionManagerAPIs"/}}
148 {{include reference="ReleaseNotesXWiki53M1" section="HXWikiEnterpriseArchetype"/}}
150 {{include reference="ReleaseNotesXWiki53M1" section="HXARpluginimprovements"/}}
152 {{include reference="ReleaseNotesXWiki53M1" section="HFoldEvents"/}}
154 {{include reference="ReleaseNotesXWiki53M2" section="HMulti-Wiki-1"/}}
156 == Deprecated and Retired projects ==
158 * Workspace has been moved to
160 == Upgrades ==
162 The following dependencies have been upgraded:
164 * [[Bouncy Castle Crypto package 1.49>>]] (Warning: Not fully binary compatible)
165 * [[commons-fileupload 1.3>>]]
166 * [[cssparser 0.9.10>>]]
167 * [[Groovy 2.1.9>>]]
168 * [[HttpClient 4.3>>]]
169 * [[Struts 1.3.10>>]]
170 * [[XStream 1.4.5>>]]
172 == Miscellaneous ==
174 * [[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.
175 * [[New Java API + a few new APIs in the Git module>>extensions:Extension.Git Module]]
176 * 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
177 * You can now easily [[run functional tests using PhantomJS>>dev:Community.Testing||anchor="HSelenium2-basedFramework"]] by using ##-Dbrowser=*phantomjs##.
179 = Translations =
181 The following translations have been updated:
183 {{language codes="ca, da, de, es, fr, it, lv, nl, pt_BR, ru, sv, uk"/}}
185 = Tested Browsers & Databases =
187 {{include reference="TestReports.ManualTestReportXWiki53Summary"/}}
189 = Known issues =
191 * [[Bugs we know about>>]]
193 = Backward Compatibility and Migration Notes =
195 == General Notes ==
197 When upgrading make sure you compare your ##xwiki.cfg##, and ##web.xml## files with the newest version since some configuration parameters may have been modified or added. Note that you should add so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.
199 == Solr Search Index ==
201 {{error}}
202 We made important changes to the [[Solr schema>>]] 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.
203 {{/error}}
205 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:
207 {{code language="none"}}
208 ## Before
209 #set ($classFullName = $searchResult.get('class'))
210 ##
211 ## Now
212 #set ($classFullName = $searchResult.get('class').get(0))
213 {{/code}}
215 == API Breakages ==
217 The following APIs were modified since XWiki 5.2.2:
219 * Requesting a dependency without indicating the namespace does not really make sense. This interface is not really supposed to be implemented anyway.
221 {{code language="none"}}
222 org.xwiki.extension.ExtensionManager: Method 'public org.xwiki.extension.Extension resolveExtension(org.xwiki.extension.ExtensionDependency, java.lang.String)' has been added to an interface
223 {{/code}}
225 * Needed to filter search by namespace. This interface is not really supposed to be implemented anyway.
227 {{code language="none"}}
228 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
229 {{/code}}
231 * Young API. Not supposed to be implemented from outside.
233 {{code language="none"}}
234 org.xwiki.filter.xml.parser.XMLParserFactory: Method 'public createXMLEventWriter(java.lang.Object, org.xwiki.filter.xml.XMLConfiguration)' has been added to an interface
235 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
236 {{/code}}
238 * Young API. Not supposed to be implemented from outside.
240 {{code language="none"}}
241 org.xwiki.filter.FilterDescriptorManager: Method 'public java.lang.Object createCompositeFilter(java.lang.ClassLoader, java.lang.Object[])' has been added to an interface
242 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
243 {{/code}}
245 * Young API that has been refactored to introduce the new Resource module.
247 {{code language="none"}}
248 org.xwiki.url.AbstractXWikiURL: Class org.xwiki.url.AbstractXWikiURL removed
249 org.xwiki.url.URLCreationException: Class org.xwiki.url.URLCreationException removed
250 org.xwiki.url.UnsupportedURLException: Class org.xwiki.url.UnsupportedURLException removed
251 org.xwiki.url.XWikiEntityURL: Class org.xwiki.url.XWikiEntityURL removed
252 org.xwiki.url.XWikiURL: Class org.xwiki.url.XWikiURL removed
253 org.xwiki.url.XWikiURLFactory: Class org.xwiki.url.XWikiURLFactory removed
254 org.xwiki.url.XWikiURLManager: Class org.xwiki.url.XWikiURLManager removed
255 org.xwiki.url.XWikiURLSerializer: Class org.xwiki.url.XWikiURLSerializer removed
256 org.xwiki.url.XWikiURLType: Class org.xwiki.url.XWikiURLType removed
257 {{/code}}
259 * XWikiURL (now Resource) should only be in the Execution Context and not in the Request.
261 {{code language="none"}}
262 org.xwiki.container.servlet.ServletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed
263 org.xwiki.container.servlet.ServletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed
264 org.xwiki.container.portlet.PortletRequest: Method 'public org.xwiki.url.XWikiURL getURL()' has been removed
265 org.xwiki.container.portlet.PortletRequest: Method 'public void setXWikiURL(org.xwiki.url.XWikiURL)' has been removed
266 org.xwiki.container.Request: Field XWIKI_URL has been removed, but it was previously a constant
267 {{/code}}
269 * Lots of refactoring in WikiStream.
271 {{code language="none"}}
272 org.xwiki.wikistream.xml.input.source.SourceInputSource: Class org.xwiki.wikistream.xml.input.source.SourceInputSource removed
273 org.xwiki.wikistream.WikiStream: Class org.xwiki.wikistream.WikiStream removed
274 org.xwiki.wikistream.descriptor.DefaultWikiStreamBeanParameterDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed
275 org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getPropertyType()' has been removed
276 org.xwiki.wikistream.descriptor.WikiStreamPropertyDescriptor: Method 'public java.lang.reflect.Type getType()' has been added to an interface
277 org.xwiki.wikistream.filter.FarmFilter: Class org.xwiki.wikistream.filter.FarmFilter removed
278 org.xwiki.wikistream.filter.WikiAttachmentFilter: Class org.xwiki.wikistream.filter.WikiAttachmentFilter removed
279 org.xwiki.wikistream.filter.WikiClassFilter: Class org.xwiki.wikistream.filter.WikiClassFilter removed
280 org.xwiki.wikistream.filter.WikiClassPropertyFilter: Class org.xwiki.wikistream.filter.WikiClassPropertyFilter removed
281 org.xwiki.wikistream.filter.WikiDocumentFilter: Class org.xwiki.wikistream.filter.WikiDocumentFilter removed
282 org.xwiki.wikistream.filter.WikiFilter: Class org.xwiki.wikistream.filter.WikiFilter removed
283 org.xwiki.wikistream.filter.WikiObjectFilter: Class org.xwiki.wikistream.filter.WikiObjectFilter removed
284 org.xwiki.wikistream.filter.WikiObjectPropertyFilter: Class org.xwiki.wikistream.filter.WikiObjectPropertyFilter removed
285 org.xwiki.wikistream.filter.WikiSpaceFilter: Class org.xwiki.wikistream.filter.WikiSpaceFilter removed
286 org.xwiki.wikistream.input.BeanInputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
287 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
288 org.xwiki.wikistream.input.InputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
289 org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
290 org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.lang.Object)' has been removed
291 org.xwiki.wikistream.output.BeanOutputWikiStreamFactory: Method 'public org.xwiki.wikistream.internal.output.BeanOutputWikiStream createOutputWikiStream(java.lang.Object)' has been added to an interface
292 org.xwiki.wikistream.output.OutputWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
293 org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream creaOutputWikiStream(java.util.Map)' has been removed
294 org.xwiki.wikistream.output.OutputWikiStreamFactory: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(java.util.Map)' has been added to an interface
295 org.xwiki.wikistream.type.WikiStreamType: Removed field XWIKI_XAR
296 org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces
297 org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces
298 org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces
299 org.xwiki.wikistream.instance.input.AbstractInstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces
300 org.xwiki.wikistream.instance.input.EntityEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface
301 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.FarmFilter from the set of implemented interfaces
302 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiDocumentFilter from the set of implemented interfaces
303 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiFilter from the set of implemented interfaces
304 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Removed org.xwiki.wikistream.filter.WikiSpaceFilter from the set of implemented interfaces
305 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public org.xwiki.wikistream.descriptor.WikiStreamDescriptor getDescriptor()' has been added to an interface
306 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public java.util.Collection getFilterInterfaces()' has been added to an interface
307 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiDocumentParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
308 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiFarmParameters(org.xwiki.filter.FilterEventParameters)' has been added to an interface
309 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
310 org.xwiki.wikistream.instance.input.InstanceInputEventGenerator: Method 'public void setWikiSpaceParameters(java.lang.String, org.xwiki.filter.FilterEventParameters)' has been added to an interface
311 org.xwiki.wikistream.instance.output.OutputInstanceWikiStreamFactory: Removed org.xwiki.wikistream.WikiStream from the set of implemented interfaces
312 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
313 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
314 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
315 org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.input.InputWikiStream createInputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed
316 org.xwiki.wikistream.script.WikiStreamScriptService: Method 'public org.xwiki.wikistream.output.OutputWikiStream createOutputWikiStream(org.xwiki.wikistream.type.WikiStreamType, java.util.Map)' has been removed
317 {{/code}}

Get Connected