Wiki source code of Release Notes for XWiki 7.2

Last modified by Thomas Mortagne on 2017/03/24

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 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 This release is probably one of the biggest releases we have done in XWiki for years (more than 900 commits)! We have worked hard during all the summer to finally achieve the introduction of a new concept: **//Nested Pages//**. This big change affects both the platform and the user interface, and you will discover many differences while using XWiki.
8
9 {{warning}}
10 As a consequence, we do not recommend using this version in production because we still need to fine-tune the UI to fully adapt it to Nested Pages. This will be done in XWiki 7.3. However, in order to flush out all issues, especially about usability, please try upgrading to this version and play with it to let us know what you like/don't like. There's still time to adjust things. Thanks for your help!
11 {{/warning}}
12
13 {{error}}
14 The following blocking issues were found after this version was released. You should verify if you're using the affected features and if so, you can click on them to see in which version they are fixed):
15
16 {{jira url="https://jira.xwiki.org" style="list" source="jql"}}
17 category = "Top Level Projects" and affectedVersion in ("7.2-milestone-1", "7.2-milestone-2", "7.2-milestone-3", "7.2-rc-1", "7.2") and fixVersion > "7.2" and priority = Blocker and resolution = Fixed
18 {{/jira}}
19 {{/error}}
20
21 For developers, this release also introduces a new //Script// right and some changes in the REST, Job and Refactoring modules, just to list a few...
22
23 Finally, it also brings a lot of bugs fixes!
24
25 = New and Noteworthy (since XWiki 7.1) =
26
27 [[Full list of issues fixed and Dashboard for 7.2>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13499]].
28
29 == Nested Pages ==
30
31 It's now possible to create wiki pages inside other wiki pages. More specifically we've decided to drop the concept of Space in the UI (it's still there at the API/platform level) and instead, to replace it with the concept of Nested Pages.
32
33 We've also decided to drop the concept of Parent/Child relationship since it was too complex for end users to have 2 hierarchies: the Space/Page hierarchy and the Parent/Child hierarchy. The Parent/Child hierarchy also had limitations: you couldn't inherit page permissions for example. Thus the idea is to have a single hierarchy based on Nested Pages.
34
35 Advantages of Nested Pages:
36
37 * The URL reflects the page hierarchy
38 * Finer-grained control: Ability to set permissions at each level
39 * Generally speaking, a nicer and simpler way to organize your content hierarchically
40 * Moving and Deleting pages updates the hierarchy
41
42 Terminology:
43
44 * **Nested Page** (a.k.a **Non-Terminal Page**): This is a wiki page that can have children pages. Technically a Nested Page is implemented as a Nested Space (i.e. a **WebHome** page).
45 * **Non-Nested Page** (a.k.a **Terminal Page**): This a wiki page that cannot have children pages. Applications and script can create Terminal Pages. Advanced Users will also be able to create Terminal Pages from the UI. Standard Users will only be able to create Nested Pages.
46 * **Nested Space**: A Space which has another Space as parent. As mentioned above, a Nested Page is technically implemented as a Nested Space. You will used the term Nested Space when speaking technically about XWiki APIs for example but when talking about UI you should favor using the term Nested Page instead.
47
48 For more information, see [[Content Organization>>platform:Features.ContentOrganization||anchor="HHistory"]].
49
50 We have worked a lot to minimize the retro-compatibility issues. However, some Extensions are not adapted for //Nested Pages// yet, and their execution is still sub-optimal. For the next releases, we plan to work on the adaptation of these Extensions.
51
52 == Script right ==
53
54 A new Script Right has been added to allow controlling who has the right to write Scripts. Specifically anyone with Edit rights can edit a page and write a Script in it. However, when the page is rendered the script will only execute if the last author of the page has the Script right.
55
56 Example when the author of a script doesn't have the Script right:
57
58 {{image reference="scriptRightsErrorNotAllowed.png"/}}
59
60 The Script Right is set to DENY by default, meaning that if you do not have it explicitly, you will not be able to execute the scripts that you write with your user account.
61
62 However, for backward-compatibility reasons, the standard XWiki Enterprise distribution comes with the Script Right being allowed for all users at the main wiki level, so that, unless you (as an Admin) explicitly revoke the right for some users or explicitly deny it, they will be able to execute the scripts they wrote, just like before.
63
64 {{image reference="scriptRightsExplicitlyAllowedInXWikiPreferences.png"/}}
65
66 == Hiding of the Parent-Child Relationship ==
67
68 Following our decision to drop the Parent-Child relationship (see above), it's now been turned off by default in favor of Nested Pages.
69
70 Note that it's possible to go back to the previous behavior, in which the Breadcrumb was following the Parent/Child relationship, by setting the ##core.hierarchyMode## property to ##parentchild## in the ##xwiki.properties## configuration file.
71
72 === New Breadcrumb ===
73
74 The Breadcrumb has been reworked to reflect the location of a Page in the reference hierarchy. For example for a Page "CEO" inside a Page "Boarding" inside a Page "Management" inside a Page "Staff" you would have the following Breadcrumb:
75
76 {{image reference="[email protected]"/}}
77
78 === New Index Tree ===
79
80 The Index Tree is now using the [[reworked Document Tree Macro>>extensions:Extension.Document Tree Macro]] and is thus honoring the Nested Pages hierarchy. For example:
81
82 {{image reference="[email protected]"/}}
83
84 === Updated Edit Mode ===
85
86 In Edit mode, the ability to change the Parent has been removed by default since we're now honoring the Nested Pages hierarchy. For example:
87
88 {{image reference="[email protected]"/}}
89
90 == Flamingo ==
91
92 Following the introduction of the Nested Pages feature, we have changed a lot our default skin, Flamingo:
93
94 * The top menu has been removed and replaced by a //drawer// menu that you can expand by clicking on the top right icon
95 * The add menu has been relocated near the edit one
96 * The L&F of the Add, Edit, and "More Actions" menus has been changed
97 * A lot of actions have been moved to the "More Actions" menu
98 * The page breadcrumb has suffered some changes:
99 ** it is now also displayed on the wiki home page
100 ** the wiki home page is now included when it is part of the current document's hierarchy, i.e. for children and descendants of the wiki home page. See [[XWIKI-12423>>https://jira.xwiki.org/browse/XWIKI-12423]] for more details.
101 ** the sub-wiki pretty name is included between the home icon and the local page path
102 * The actions menus (edit, create, more actions) are now available from the rename, copy and delete actions.
103 * The create, copy and rename page actions have been modified to support nested pages:
104 ** The source and target pages are displayed using the breadcrumb
105 ** The target page can be selected using a document tree picker
106 ** For advanced users there is also the option to specify the target page using some text input fields (location advanced edit mode). This is useful especially if you want to create/move the page under a parent that doesn't exist yet (you cannot use the tree picker in this case because the parent would not be available in the tree).
107 * The delete action proposes to delete the children of the page.
108 * The welcome message from the main wiki home page has been updated.
109 * The "Spaces" widget from the wiki dashboard has been replaced with "Pages" which shows the hierarchy of nested pages from that wiki.
110 * For non terminal pages, we have introduced a "Page Administration", where you will find settings that concern the page and its children (it's actually the old space administration behind the scene). But we have also introduced 2 sections for setting rights on these pages:
111 ** a section to set rights for the page only.
112 ** a section to set rights for the page and its children.
113 * For terminal pages, nothing changes, you can change the access rights of the page in the "edit" menu. The only addition is a "Administer Parent" link in the "More actions" menu to administer the parent page (which again is the space administration behind the scene).
114 * The create action has been re-looked (with the introduction of the "page type" field) and proposes to import an office document.
115 * A new "children" viewer is now accessible in the "more actions" menu, along with the other viewers.
116 * For Terminal Pages, a new "siblings" viewer is present, which replaces the old "space index" feature.
117
118 {{gallery}}
119 image:[email protected]
120 image:[email protected]
121 image:[email protected]_actions.png
122 image:[email protected]
123 image:[email protected]
124 image:[email protected]
125 image:[email protected]er.png
126 image:[email protected]
127 image:[email protected]
128 image:[email protected]
129 image:[email protected]
130 image:[email protected]
131 image:[email protected]
132 image:[email protected]
133 image:[email protected]
134 image:[email protected]
135 image:[email protected]
136 image:[email protected]
137 image:[email protected]
138 image:[email protected]
139 image:[email protected]
140 image:[email protected]
141 image:[email protected]
142 image:[email protected]
143 image:[email protected]
144 {{/gallery}}
145
146 == LDAP improvements ==
147
148 It's now possible to disable subgroups resolution using ##xwiki.authentication.ldap.group_sync_resolve_subgroups## property in ##xwiki.cfg## configuration file. Resolving each member to check if it's a group might be very expensive with big groups so if you know there is no subgroup you should really disable it.
149
150 == Solr Search ==
151
152 You can now search for nested pages using the [[Solr Search Application>>extensions:Extension.Solr Search Application]]. The display of the search result location has been updated to support nested pages.
153
154 {{image reference="[email protected]"/}}
155
156 The "Space" facet has been replaced with a "Location" facet that supports nested pages. This allows you to search in a specific location in the page hierarchy.
157
158 {{image reference="[email protected]"/}}
159
160 The "Page" facet has been removed by default because it doesn't bring value in the context of the nested pages: all non-terminal pages have the same name 'WebHome'. The "Wiki" facet is displayed by default only on the main wiki and only if you have multiple wikis.
161
162 The search results location displayed on the [[Search suggest>>extensions:Extension.Search Application||anchor="HSearchSuggest"]] has also been updated to support nested pages.
163
164 {{image reference="searchSuggestLocation.png"/}}
165
166 == Miscellaneous ==
167
168 * When a space home page has an empty title (and the space home page doesn't have a sheet or the sheet doesn't control the title) then the displayed title is now the space name instead of 'WebHome'.
169 * The [[Document Tree Macro>>extensions:Extension.Document Tree Macro]] has a new parameter called ##showSpaceAsDocument## which allows you to merge the space nodes with the space home page nodes.
170 * The list of available template providers is now sorted by document full name.
171 * The [[Orphaned Pages>>extensions:Extension.Index Application||anchor="HAllorphanedDocuments"]] tab from the [[Document Index>>extensions:Extension.Index Application||anchor="HAccessingtheIndexes"]] is now displayed only when [[the Parent-Child Hierarchy Mode>>ReleaseNotesXWiki72M2||anchor="HHidingoftheParent-ChildRelationship"]] is enabled (which is not the case by default).
172 * Import UI move to new standard tree(((
173 {{image reference="[email protected]"/}}
174 )))
175 * The size of the Job status cache is now configurable. See ##job.statusCacheSize## property in ##xwiki.properties## files.
176 * The Spaces macro (which lists all Spaces) is now working fine when there are Nested Spaces.
177 * The LiveTable macro is now working fine when there are Nested Spaces.
178 * The Navigation panel displays nested pages:(((
179 {{image reference="[email protected]"/}}
180 )))
181 * When renaming or copying a nested page the document title is updated to reflect the new page name if its previous value was equal the old page name. This was happening already for terminal pages. We extended the behaviour to nested pages.
182 * Fixed various issues for several applications bundled in XE (such as WatchList and Annotations), which should now work well with Nested Spaces.
183 * The Administration mode for spaces and wikis now uses the standard reference-based breadcrumbs instead of the previously custom section-based breadcrumbs.(((
184 {{image reference="[email protected]"/}}
185 )))
186 * The Administration mode no longer features a select input on the right side for navigation between spaces since that input does no longer scale in the context of Nested Spaces. Thus, the breadcrumbs should be used instead and the future UI improvements that will soon become available in this direction.
187 * It's now possible to create Skins in Nested Spaces.
188 * Changed the exception message displayed when a script execution fails due to lack of rights to make it clearer that it's not a problem with the current user, but with the script.
189 * When [[creating, copying or renaming a page>>platform:Features.DocumentLifecycle]] you can now select a top level location from the tree picker (e.g. copy as top level page) even if you have a single wiki (i.e. only the main wiki). You do this by selecting the root of the tree (i.e. the wiki node).
190 * The [[Document Tree Macro>>extensions:Extension.Document Tree Macro]] is now displaying a message when the tree is empty.(((
191 {{image reference="[email protected]"/}}
192
193 With the new ##showRoot## parameter you can force the document tree to show the actual root node (either the one specified by the ##root## parameter or the default root node).
194 )))
195 * A couple of bugs in the [[App Within Minutes Application>>extensions:Extension.App Within Minutes Application]], that were caused by the introduction of the Nested Pages feature, have been fixed.
196 * It's now possible create new FAQs in Nested Spaces.
197 * When using the XWiki Jetty distribution, a memory dump is automatically created in XWiki's ##data/## folder when an ##Out Of Memory## error occurs.
198 * The Activity Stream now also displays activity for Nested Spaces.
199
200 See the [[full list of JIRA issues>>https://jira.xwiki.org/issues/?filter=14213]] fixed in this release.
201
202 = For Developers =
203
204 == Nested Spaces ==
205
206 Since Nested Spaces were already planned and supported in APIs like ##DocumentReference## there are not too many changes for those who were using recent APIs but there is still some and here are the main ones.
207
208 === Space Reference instead of Space name ===
209
210 The heart of the implementation is that the field that used to contain the unique document space now contain the possibly Nested Space Reference. In practice it means that:
211
212 * "##.##" (dot), "##:##" (colon) and "##\##" (baskslash) characters, which are part of a Space name will now be escaped (using the "##\##" character) in the ##space## (##XWD_WEB##) field from the Document's table in the Database. For example a space named ##Space:with.special\char## will be stored as ##Space\:with\.special~\~\char##.
213 * Same as for the database, the ##XWikiDocument/Document#getSpace()## methods now return a serialized Reference to the Space instead of what used to be the unique Space name (basically it return what's in the database). Same logic for ##XWikiDocument#setSpace()##. Those field have been deprecated a long time ago but they are still used in lots of places...
214 * Various APIs are also affected by this Space name to Space Reference input change:
215 ** ##XWiki#getSpaceDocsName## methods (both in the public and private XWiki API)
216 ** All the default ##XWikiURLFactory## implementation methods accepting a Space as parameter have been modified to accept a serialized Space Reference. Extensions/code implementing ##XWikiURLFactory## (or extending classes implementing ##XWikiURLFactory## such as ##XWikiServletURLFactory##) will need to be modified to handle nested spaces passed in the ##space## parameter of the various APIs. Here's how to parse Spaces passed as a String:(((
217 {{code language="java"}}
218 private EntityReferenceResolver<String> relativeEntityReferenceResolver =
219 Utils.getComponent(EntityReferenceResolver.TYPE_STRING, "relative");
220 ...
221 or
222 ...
223 @Inject
224 @Named("relative")
225 private EntityReferenceResolver<String> relativeEntityReferenceResolver;
226 ...
227 private List<String> extractSpaceNames(String spaces)
228 {
229 List<String> spaceNames = new ArrayList<>();
230 // Parse the spaces list into Space References
231 EntityReference spaceReference = this.relativeEntityReferenceResolver.resolve(spaces, EntityType.SPACE);
232 for (EntityReference reference : spaceReference.getReversedReferenceChain()) {
233 spaceNames.add(reference.getName());
234 }
235 return spaceNames;
236 }
237 {{/code}}
238 )))
239 ** Extensions/code implementing ##ExportURLFactoryActionHandler## will also need to be modified to handle nested Spaces passed in the ##space## parameter.
240 * Extensions/code implementing ##EntityReferenceSerializer## or ##DocumentReferenceResolver## must now handle Nested Spaces (in the past they were already supposed to handle Nested Spaces but since it was not used they could take shortcuts and it wasn't visible. It's now going to fail, see [[XWIKI-12191>>https://jira.xwiki.org/browse/XWIKI-12191]]).
241
242 === Space separator properly taken into account ===
243
244 The Reference syntax specification was already indication that "##.##" was supposed to be escaped in the space part of the Reference but it was not really taken into account so not escaping it was not making any difference. This is now fixed in the various standard String Reference resolvers so a Reference that don't follow the specification and did not escaped the "##.##" in the space part will be cut is several nested spaces. Anything that was serialized with one of the standard serializers was properly escaped so not worry here, the issue will be more for hand written or hardcoded String References.
245
246 === New XAR format ===
247
248 To support exporting/importing nested spaces some changes has been made to the XAR format. The format remain upward and downward compatible (except that you won't get nested spaces in your < 7.2 instance obviously).
249
250 Two new attributes has been added to the ##<xwikidoc>## root XML element
251
252 * ##reference##: the complete local Reference of the document in standard Reference format. ##<web>## and ##<name>## are deprecated (but still set). ##<web>## keep containing the (unescaped) space name when there is only one space and will contain the space Reference when there is several (when imported in a < 7.2 instance a document exported from a nested space will end up in a space having as name the space reference).
253 * ##locale##: the locale of the document. ##<language>## is deprecated. It was not technically needed in the context of nested spaces but it makes having the Reference as attribute more consistent. It also make getting all the entries from a new format XAR easier and faster since document space and name could be located anywhere in the XML document.
254
255 === REST module ===
256
257 * The REST module now supports Nested Spaces. Example of url to access the page ##A.B.C.MyPage##: ##/xwiki/rest/wikis/xwiki/spaces/A/spaces/B/spaces/C/pages/MyPage##.
258
259 === URL modules ===
260
261 The URL modules have been modified to support Nested Spaces. As a consequence the [[URL formats supported by the ##standard## URL scheme have been modified>>extensions:Extension.Standard URL API]].
262
263 === New Rename/Delete Jobs ===
264
265 New code has been developed to support Nested Pages/Nested Spaces and Script Services have been provided and they now run inside Jobs to better handle the fact that they are long-running operations.
266
267 The corresponding Script Services APIs have been added:
268
269 * Copy a Space(((
270 {{code language="none"}}
271 #set ($source = $services.model.resolveSpace('Path.To.Source'))
272 #set ($destination = $services.model.resolveSpace('Path.To.New.Parent'))
273 $services.refactoring.copy($source, $destination).join()
274 {{/code}}
275 )))
276 * Copy a Space As(((
277 {{code language="none"}}
278 #set ($source = $services.model.resolveSpace('Path.To.Source'))
279 #set ($destination = $services.model.resolveSpace('Path.To.New.Name'))
280 $services.refactoring.copyAs($source, $destination).join()
281 {{/code}}
282 )))
283 * Move a Space(((
284 {{code language="none"}}
285 #set ($source = $services.model.resolveSpace('Path.To.Source'))
286 #set ($destination = $services.model.resolveSpace('Path.To.New.Parent'))
287 $services.refactoring.move($source, $destination).join()
288 {{/code}}
289 )))
290 * Move a Page(((
291 {{code language="none"}}
292 #set ($source = $services.model.resolveDocument('Path.To.Source.WebHome'))
293 #set ($destination = $services.model.resolveSpace('Path.To.New.Parent'))
294 $services.refactoring.move($source, $destination).join()
295 {{/code}}
296 )))
297 * Rename a Space(((
298 {{code language="none"}}
299 #set ($source = $services.model.resolveSpace('Path.To.Source'))
300 $services.refactoring.rename($source, 'NewName').join()
301 {{/code}}
302 )))
303 * Rename a Page(((
304 {{code language="none"}}
305 #set ($source = $services.model.resolveDocument('Path.To.Source.WebHome'))
306 $services.refactoring.rename($source, 'NewName').join()
307 {{/code}}
308 )))
309 * Delete a Page(((
310 {{code language="none"}}
311 #set ($source = $services.model.resolveDocument('Path.To.Source.WebHome'))
312 $services.refactoring.delete($source).join()
313 {{/code}}
314 )))
315 * Delete a Space(((
316 {{code language="none"}}
317 #set ($source = $services.model.resolveSpace('Path.To.Source'))
318 $services.refactoring.delete($source).join()
319 {{/code}}
320 )))
321 * Convert a Terminal Page to a Nested Page(((
322 {{code language="none"}}
323 #set ($source = $services.model.resolveDocument('Path.To.Page'))
324 $services.refactoring.convertToNestedDocument($source).join()
325 {{/code}}
326 )))
327 * Convert a Nested Page to a Terminal Page(((
328 {{code language="none"}}
329 #set ($source = $services.model.resolveDocument('Path.To.Source.WebHome'))
330 $services.refactoring.convertToTerminalDocument($source).join()
331 {{/code}}
332 )))
333
334 === New create action parameters and logic ===
335
336 The create action now accepts a ##spaceReference## parameter and a ##name## parameter, together with an optional ##tocreate=terminal## parameter (usable on non-terminal pages). The previous space parameters was not scalable in the context of Nested Spaces since it was just a top-level space name so it did not allow the creation of deeper space levels. More details are available in the [[create action's documentation>>platform:DevGuide.Standard URL Format||anchor="HAction:create"]].
337
338 As explained previously, these logic is also available in the improved create UI, with the terminal pages option appearing only for advanced users and being checked or unchecked by default, depending on the type of the current page.
339
340 === JS API Improvements ===
341
342 * It's now possible to create a Nested Spaces Reference using XWiki's Javascript API. For example:(((
343 {{code language="javascript"}}
344 // Construct a Nested Space reference
345 var reference = new XWiki.SpaceReference('wiki', ['space1', 'space2']);
346 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2');
347 reference = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
348 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2.page');
349 // Construct a non-Nested Space reference
350 reference = new XWiki.SpaceReference('wiki', 'space');
351 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space');
352 // Try passing non-valid space parameters
353 expect(function() {new XWiki.SpaceReference('wiki', [])}).toThrow('Missing mandatory space name or invalid type for: []');
354 expect(function() {new XWiki.SpaceReference('wiki', 12)}).toThrow('Missing mandatory space name or invalid type for: [12]');
355 {{/code}}
356 )))
357 * A new ##XWiki.EntityReference.equals()## method has been added. For example:(((
358 {{code language="javascript"}}
359 var reference1 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
360 var reference2 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
361 var reference3 = new XWiki.DocumentReference('wiki2', ['space1', 'space2'], 'page');
362 expect(reference1.equals(reference2)).toBe(true);
363 expect(reference1.equals(reference3)).toBe(false);
364 {{/code}}
365 )))
366 * A new ##XWiki.EntityReference.fromJSONObject(obejct)## has been added to create a Javascript ##XWiki.EntityReference## from a Java ##EntityReference## directly serialized as JSON:(((
367 {{code language="javascript"}}
368 var reference = XWiki.EntityReference.fromJSONObject(jsonText.evalJSON());
369 {{/code}}
370 )))
371 * A new ##XWiki.EntityReferenceTree## JS class has been added, which partially mimics the Java ##EntityReferenceTree## Class. It's still missing features though as it was introduced mostly to make it easier to manipulate a serialized Java ##EntityReferenceTree##.
372
373 === Updated Document Tree Macro ===
374
375 The [[Document Tree Macro>>extensions:Extension.Document Tree Macro]] now supports Nested Pages and Nested Spaces modes. Specifically, the following changes have been made:
376
377 * removed the ##showSpaceAsDocument## parameter (was introduced recently in 7.2M1)
378 * deprecated the ##showChildDocuments## parameter
379 * added the ##hierarchyMode## parameter with two supported values: ##reference## (default) and ##parentchild##
380
381 As a result, you can use the document tree macro like this:
382
383 * Nested Page Tree(((
384 {{code language="none"}}
385 {{documentTree/}}
386 {{/code}}
387 )))
388 * Nested Space + Page Tree(((
389 {{code language="none"}}
390 {{documentTree showSpaces="true" /}}
391 {{/code}}
392 )))
393 * Parent-Child Page Tree(((
394 {{code language="none"}}
395 {{documentTree hierarchyMode="parentchild" /}}
396 {{/code}}
397 )))
398 * Old Page Index Tree (i.e. Parent-Child mixed with space grouping)(((
399 {{code language="none"}}
400 {{documentTree hierarchyMode="parentchild" showSpaces="true" /}}
401 {{/code}}
402 )))
403
404 === Solr Search ===
405
406 We added 3 new fields to the [[Solr Index>>design:Design.SolrSchema]] related to Nested Spaces:
407
408 * spaces: the list of nested spaces, e.g. ['A', 'B', 'C']
409 * space_facet: used for [[hierarchical faceting>>https://wiki.apache.org/solr/HierarchicalFaceting]] (the 'facet.prefix'-based drill down approach)
410 * space_prefix: used to match descendant documents, e.g. all documents from space ##A.B## and all its descendants (like space ##A.B.C##)
411
412 We also modified the value of the ##space## and ##space_exact## fields to contain the full local reference of the space (it was holding only the name of the last space prior to 7.2). Finally, the ##space## field has been deprecated in favour of the ##spaces## field.
413
414 == New Reference-related APIs ==
415
416 Various new API around References has been introduced while adding support for nested spaces.
417
418 === Complete References Providers ===
419
420 Complete References Providers (for DocumentReference, SpaceReference and WikiReference) with default or ##current## hints. They allow getting complete Reference created from each default or current part of those references (for example in SpaceReference you end up with the space of the XWikiContext document and the XWikiContext wiki)
421
422 {{code language="java"}}
423 @Inject
424 Provider<DocumentReference> defaultDocumentReference;
425
426 @Inject
427 @Named("current")
428 Provider<DocumentReference> currentDocumentReference;
429 {{/code}}
430
431 === org.xwiki.model.reference.EntityReferenceProvider ===
432
433 ##org.xwiki.model.reference.EntityReferenceProvider## replaces ##org.xwiki.model.reference.EntityReferenceValueProvider##. It's essentially the same thing but with ##EntityReference## instead of string which allow getting multiple spaces when you ask for the current ##EntityType.SPACE## for example.
434
435 {{code language="java"}}
436 @Inject
437 EntityReferenceProvider provider;
438 {{/code}}
439
440 === Properly support any kind of References in getDocument and getURL ===
441
442 ##com.xpn.xwiki.XWiki#getDocument(EntityReference)## and ##com.xpn.xwiki.api.XWiki#getDocument(EntityReference)## support any kind of Reference properly (e.g. a Space Reference will return the space home page, an Object Reference will return the Object Document Reference, etc).
443
444 Same for ##com.xpn.xwiki.XWiki#getURL(EntityReference)## and ##com.xpn.xwiki.api.XWiki#getURL(EntityReference)## (e.g. passing a Document Reference with Locale will return the URL to the specified document translation, by adding ##language=xx## to the query string).
445
446 === New helpers in EntityReference ===
447
448 * ##boolean equals(EntityReference otherReference, EntityType to)##: same as equals but only take into account Reference parts up to the passed entity type (included)
449 * ##boolean equals(EntityReference otherReference, EntityType from, EntityType to)##: same as equals but only take into account Reference parts between passed entity types (included)
450 * ##boolean equalsNonRecursive(EntityReference otherReference)##: same as equals but does not take into account the parent
451
452 === New helpers in LocalDocumentReference ===
453
454 * ##LocalDocumentReference(String pageName, EntityReference spaceReference)##: allowed created a LocalDocumentReference from a Space Reference instead of just the space name
455
456 === org.xwiki.model.reference.SpaceReferenceResolver ===
457
458 New default ##String## and ##EntityReference## based SpaceReferenceResolver has been added. It's the same behavior then ##DocumentReferenceResolver## but for spaces.
459
460 {{code language="java"}}
461 @Inject
462 SpaceReferenceResolver<String> stringResolver;
463
464 @Inject
465 SpaceReferenceResolver<EntityReference> referenceResolver;
466 {{/code}}
467
468 === New model Script Service helpers ===
469
470 * new help to escape an entity name according to default Reference syntax as in:(((
471 {{code language="velocity"}}
472 $services.model.escape('some.space:with\specialchars', 'SPACE')
473 {{/code}}
474
475 will print
476
477 {{code language="nonde"}}
478 some\.space\:with\\specialchars
479 {{/code}}
480 )))
481 * you can retrieve a node from an ##EntityReferenceTree## using its reference:(((
482 {{code language="velocity"}}
483 #set ($alice = $services.model.resolveDocument('wiki:Users.Alice.WebHome'))
484 #set ($bob = $services.model.resolveDocument('wiki:Users.Directory'))
485 #set ($tree = $services.model.toTree($alice, $bob))
486 #set ($usersNode = $tree.get($bob.lastSpaceReference))
487 {{/code}}
488 )))
489
490 === New components to generate REST URLs ===
491
492 * The component ##RestURLGenerator## has been added. Its role, in the long term, is to generate a REST URL for any kind of EntityReference. It currently handles ##DocumentReference## and ##SpaceReference##.
493 * The corresponding script service has been added: ##$services.rest## with the method ##$services.rest.url($entityReference)##.
494
495 === Reference Scripting API for Nested Spaces ===
496
497 The Script API for Entity References has been updated with new APIs to support creating Nested Spaces references. For example:
498
499 {{code language="none"}}
500 {{velocity}}
501 $services.model.createDocumentReference("wiki", ["space1", "space2"], "page")
502 $services.model.createDocumentReference("wiki", ["space1", "space2"], "page", "default")
503 $services.model.createSpaceReference(["space1", "space2"], $services.model.createWikiReference("wiki"))
504 {{/velocity}}
505 {{/code}}
506
507 === Resolve nested spaces in JavaScript ===
508
509 {{code language="js"}}
510 var spaceReference = XWiki.Model.resolve('A.B.C', XWiki.EntityType.SPACE);
511 spaceReference.getReversedReferenceChain().map(function(entityReference) {
512 return entityReference.name;
513 }).join(' > ');
514 // Produces: A > B > C
515 {{/code}}
516
517 See the [[JavaScript API documentation>>platform:DevGuide.JavaScriptAPI||anchor="HWorkwithEntityReferences"]] for more details.
518
519 == New readonly XWikiContext provider ==
520
521 You can inject a new "readonly" XWikiContext the following way:
522
523 {{code language="java"}}
524 @Inject
525 @Named("readonly")
526 Provider<XWikiContext> roXWikiContextProvider;
527 {{/code}}
528
529 The difference with default provider is that the readonly one won't try to create a new XWikiContext and will return null if it can't find any. It's been introduced for some low level components that were used during XWikiContext creation but in general it should be used by any component that only search for some XWikiContext property that might be null even in a valid XWikiContext.
530
531 == New Space/XWikiSpace table ==
532
533 A [[new table dedicated to Spaces has been introduced>>platform:DevGuide.DatabaseSchema]], in order to have performant and scalable Space-related queries (like supporting getting paginated Space which is useful for the Document Tree macro for example).
534
535 == Queries improvement ==
536
537 === Allow executing complete SELECT queries ===
538
539 In HQL and XWQL it's now possible to execute full ##SELECT## queries without Programming Right as long as you follow some rules currently defined in ##com.xpn.xwiki.internal.store.hibernate.query.HqlQueryUtils##, which contains a list of the database field allowed in the SELECT clause. Namely:
540
541 * For the ##Document##/##XWikiDocument## table: ##fullName##, ##name##, ##space##, ##language##, ##defaultLanguage##, ##translation##, ##hidden##
542 * For the ##XWikiSpace## table: ##reference##, ##name##, ##parent##, ##hidden##
543
544 This is also true for the Named Queries located in the ##queries.hbm.xml## file.
545
546 === New Secure Query ===
547
548 The right to execute or not some Query is now controlled by each ##org.xwiki.query.QueryExecutor##.
549
550 Anyone can ask the executor to check or ignore Right through the new ##org.xwiki.query.SecureQuery## extending ##org.xwiki.query.Query##:
551
552 * ##checkCurrentAuthor()##: indicate if the current author right should be checked
553 * ##checkCurrentUser()##: indicate if the result should be filtered based on current user Right (only implemented by SOLR right now)
554
555 == XWiki Select Widget ==
556
557 A [[new widget has been introduced>>platform:DevGuide.XWikiSelect]], to have a rich select box:
558
559 {{image reference="[email protected]"/}}
560
561 == Document Picker ==
562
563 Two new Velocity macros has been added to allow selecting a page from a tree picker and to display the path (breadcrumbs) to the selected page.
564
565 {{image reference="[email protected]"/}}
566
567 Check the [[Document Picker documentation>>extensions:Extension.Document Picker]] for more details.
568
569 == REST ==
570
571 2 new resources have been exposed to the REST API:
572
573 * [[JobStatus>>platform:Features.XWikiRESTfulAPI||anchor="HJobresources"]]
574 * [[JobLog>>platform:Features.XWikiRESTfulAPI||anchor="HJobresources"]]
575
576 === REST script services ===
577
578 New ##url(EntityReference)## was introduced to return relative REST URL of an entity. The new ##url(EntityReference reference, boolean external)## has been added to force returning an external form URL. See [[Generate a REST URL for a resource>>platform:Features.XWikiRESTfulAPI||anchor="HGenerateaRESTURLforaresource"]] for more details.
579
580 == Miscellaneous ==
581
582 * Objects, attachments and the document's class are now clearly not considered content, but metadata. Thus, any change in these will set the document's (XWikiDocument) metadataDirty flag to true and not touch the document's contentDirty flag unless there is an actual change in the document's content or title fields. This is also in line with the original intent of the contentAuthor document field. The direct impact of this is that the contentAuthor field will be updated only when the content is changed and thus the programming/script rights of a document will be changed much less often than before and much less by accident.
583 * custom Maven properties which have a special meaning (like ##xwiki.extension.features##) are not ##duplicated## in Extension custom properties anymore.
584 * standard fields names have been added to ##org.xwiki.extension.rating.RatingExtension##.
585 * URL configuration now use default ##ConfigurationSource## provider instead of only ##xwiki.properties## one which means it's possible to overwrite properties for each wiki among other things.
586 * Added ability to set and change the URL scheme to use in the Execution Context. This allows code to dynamically change the generated URLs when Rendering a document (useful when performing an Export for example).
587 * Started a new ##filesystem## URL Scheme for exporting Resources to the filesystem and generating URLs to them (useful for the HTML Export for example). At the moment, only the ##webjars## Resource Type is using it and all other Resource Types are using the old ##XWikiURLFactory## class.
588 * A new DocumentModelBridge.getContentAuthorReference() method has been added to allow accessing the content author of a document without depending on oldcore.
589 * Deprecate XWiki.parseContent(...) since it is was misleading and outdated. Its documentation mentioned that the passed content is parsed as velocity code, but it was actually doing much more than that and had some unwanted side-effect. Instead, use the parse/renderer that is specific to the type of content you have. See more details in [[XWIKI-12299>>https://jira.xwiki.org/browse/XWIKI-12299]].
590 * A new script service is available to retrieve the status of a specified job or the status of the currently running job from a specified group. See the [[Job Module>>extensions:Extension.Job Module||anchor="HScriptService"]] documentation for details.
591 * Custom displayers are now executed with the Rights of the user who wrote them (i.e. author of the class document or content author of the displayer document), and not the Rights of the user who wrote the script that uses them (i.e. current context document's content author). See [[XWIKI-12306>>https://jira.xwiki.org/browse/XWIKI-12306]] for more details.
592 * In the [[Active Install Extension>>extensions:Extension.Active Installs Server Application]], a new Velocity Macro has been introduced to compute the number of Active Installs having a specific Extension. Example usage:(((
593 {{code language="none"}}
594 {{include reference="ActiveInstalls.ExtensionCount"/}}
595
596 {{velocity}}
597 #set ($extensionIds = [
598 'org.xwiki.contrib:xwiki-totem-application',
599 'jsimard:event-reporter-application',
600 'mouhb:likeapplication'
601 ])
602 |=Extension Id|=Count
603 #foreach($extensionId in $extensionIds)
604 #countActiveInstallsUsingExtension($extensionId $count)
605 |$extensionId|$count
606 #end
607 {{/velocity}}
608 {{/code}}
609 )))
610 * Better support of non-DOCUMENT ##EntityReferences## in ##DocumentReferenceConverter##. It now behaves like ##XWiki#getDocument(EntityReference)##.
611 * The Copy/Rename/Delete UI actions are now using the [[Refactoring Module's Script Services>>extensions:Extension.Refactoring Module]].
612 * You can see the children and backlinks of any document with the new parameters ##?xpage=children## and ##?xpage=backlinks## to add to the document URL. To get the children according to the parent/child mechanism, you can use ##?xpage=children&hierarchy=parentchild##.
613 ** The features are also available as viewers: ##?viewer=children## and ##?viewer=backlinks##
614 ** A new "siblings" viewer has been added, accessible both with ##?viewer=siblings## and ##?xpage=siblings##.
615 ** For this viewers, a ##displayHidden## parameter has been added. By default, the hidden pages are not displayed unless the user's configuration overwrites this.
616 * You can now reuse the velocity ##hierarchy## macros defined in the Flamingo Skin's ##hierarchy_macros.vm## template to display the breadcrumbs for a particular document. See [[XWIKI-12408>>https://jira.xwiki.org/browse/XWIKI-12408]].
617
618 * In JavaScript, the class ##XWiki.Document## has been modified to handle nested spaces. A new constructor have been created, and the old one is deprecated.
619
620 == Deprecated and Retired projects ==
621
622 * The [[OSCache-based Cache Extension>>extensions:Extension.Cache OSCache]] has been [[moved to ##xwiki-contrib##>>https://github.com/xwiki-contrib/xwiki-platform-cache-oscache]] since we've been using the Infinispan implementation for a while now and the XWiki Core developers don't intend to continue supporting the OSCache-based one (it can be maintained by the Community, by whoever's interested in supporting it).
623
624 == Upgrades ==
625
626 The following dependencies have been upgraded:
627
628 * [[Bootstrap 3.3.5>>https://jira.xwiki.org/browse/XWIKI-12211]]
629 * [[Cssparser 0.9.16>>https://jira.xwiki.org/browse/XCOMMONS-817]]
630 * [[Commons-compress 1.10>>https://jira.xwiki.org/browse/XCOMMONS-842]]
631 * [[Groovy 2.4.4>>https://jira.xwiki.org/browse/XCOMMONS-831]]
632 * [[Hibernate Validator 4.3.2>>https://jira.xwiki.org/browse/XWIKI-12365]]
633 * [[HSQLDB 2.3.3>>https://jira.xwiki.org/browse/XE-1491]]
634 * [[Httpclient 4.5>>https://jira.xwiki.org/browse/XCOMMONS-815]]
635 * [[Httpcore 4.4.3>>https://jira.xwiki.org/browse/XCOMMONS-845]]
636 * [[Infinispan 7.2.5>>https://jira.xwiki.org/browse/XWIKI-12557]]
637 * [[Jackson 2.6.1>>https://jira.xwiki.org/browse/XCOMMONS-839]]
638 * [[JGroups 3.6.6>>https://jira.xwiki.org/browse/XWIKI-12507]]
639 * [[Joda-Time 2.8.2>>https://jira.xwiki.org/browse/XWIKI-12402]]
640 * [[JRuby 1.7.21>>https://jira.xwiki.org/browse/XWIKI-12344]]
641 * [[Less4j 1.14.0>>https://jira.xwiki.org/browse/XWIKI-12400]]
642 * [[Tika 1.10>>https://jira.xwiki.org/browse/XWIKI-12401]]
643
644 = Translations =
645
646 The following translations have been updated:
647
648 {{language codes="da, de, fr, hu, ko, pt_BR, sk, sv"/}}
649
650 = Tested Browsers & Databases =
651
652 {{include reference="TestReports.ManualTestReportSummaryXWiki72"/}}
653
654 = Performances tests compared to 6.4.5 =
655
656 There hasn't really been much performance work on this version (it will most probably start again in 7.3 and 7.4) which was dedicated to nested spaces support so we get mostly the same results than in [[7.1>>test:Performances.Jetty HSQLDB single wiki 712 to 72]]. The important point here was to check if nested spaces refactoring had much impact on performances.
657
658 {{warning}}
659 It's important to note that the way to measure performances has changed in this version (used to me a range of 10 values taken one by one and we are now using [[Dumbbench>>https://github.com/tsee/dumbbench]] usually on 100 values) and this is why you'll see some differences if you compare this Performance report with the one in [[7.1 release note>>ReleaseNotesXWiki71]] for example.
660 {{/warning}}
661
662 {{display reference="test:Performances.Jetty HSQLDB single wiki 645 to 72" section="HSummary"/}}
663
664 More details on [[performance comparison on single wiki between 7.2 and 6.4.5>>test:Performances.Jetty HSQLDB single wiki 645 to 72]].
665
666 = Known issues =
667
668 * [[Bugs we know about>>https://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]]
669
670 = Backward Compatibility and Migration Notes =
671
672 == General Notes ==
673
674 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.
675
676 == Issues specific to XWiki 7.2 ==
677
678 === Nested spaces ===
679
680 See [[previous Nested spaces section>>||anchor="HNestedSpaces"]] for details on what changes in the way some API and the database are dealing with the Document Space.
681
682 Note that some existing Extensions are impacted and may break slightly: Extensions taking some user input and creating Spaces based on that will most likely display {{{"\."}}}, {{{"\:"}}} and {{{"\\"}}} in the UI. Unless they already clean the user input and remove ".", ":" and "\" characters. So for example if a user enter a Space name of "my.space":
683
684 * before 7.2: the Extension would create/display a Space named "my.space"
685 * after 7.2: the Extension will create/display a Space named "my\.space"
686
687 === URLs ===
688
689 In order to support Nested Pages and have the ability that typing a URL such as ##/A## will lead to ##A.WebHome## we have stopped supporting URLs that don't specify the ##view## action (when ##xwiki.showviewaction=1##). Thus URLs such as ##/xwiki/bin/Something## now need to be written as ##/xwiki/bin/view/Something##. If ##xwiki.showviewaction=0## then you can still write ##/xwiki/bin/<something>## provided that ##<something>## isn't equal to ##view##. If it is (you have a space named ##view##) then you need to use ##/xwiki/bin/view/view[...]##.
690
691 === Templates ===
692
693 All the templates specific to [[extensions:Extension.Colibri Skin]] had been moved to it. If your skin depends on some of these templates, you should set Colibri as parent of your skin.
694
695 === Solr Search Index ===
696
697 We made [[important changes>>||anchor="HSolrSearch-1"]] to the Solr schema in this release and unfortunately we don't have support for automatic Solr search index migration at this point. 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.
698
699 == API Breakages ==
700
701 The following APIs were modified since XWiki 7.1.2:
702
703 * New configuration option to change the size of the Job statuses cache:(((
704 {{code language="none"}}
705 org.xwiki.job.JobManagerConfiguration: Method 'public int getJobStatusCacheSize()' has been added to an interface
706 {{/code}}
707 )))
708
709 * Added missing methods to the ##DocumentModelBridge## class, which are already implemented by XWikiDocument:(((
710 {{code language="none"}}
711 org.xwiki.bridge.DocumentModelBridge: Method 'public org.xwiki.model.reference.DocumentReference getContentAuthorReference()' has been added to an interface
712 {{/code}}
713 )))
714
715 * AbstractWrappingObject, AbstractSafeObject and ScriptSafeProvider have been moved to xwiki-commons-script:(((
716 {{code language="none"}}
717 org.xwiki.extension.wrap.WrappingIterableResult: Removed org.xwiki.extension.internal.safe.AbstractSafeObject from the list of superclasses
718 org.xwiki.extension.wrap.WrappingIterableResult: Removed org.xwiki.extension.wrap.AbstractWrappingObject from the list of superclasses
719 org.xwiki.extension.wrap.WrappingIterableResult: Parameter 2 of 'public WrappingIterableResult(org.xwiki.extension.repository.result.IterableResult, org.xwiki.extension.internal.safe.ScriptSafeProvider)' has changed its type to org.xwiki.script.internal.safe.ScriptSafeProvider
720 org.xwiki.filter.script.AbstractFilterScriptService: Changed type of field scriptProvider from org.xwiki.extension.internal.safe.ScriptSafeProvider to org.xwiki.script.internal.safe.ScriptSafeProvider
721 org.xwiki.extension.script.AbstractExtensionScriptService: Changed type of field scriptProvider from org.xwiki.extension.internal.safe.ScriptSafeProvider to org.xwiki.script.internal.safe.ScriptSafeProvider
722 {{/code}}
723 )))
724
725 * com.xpn.xwiki.XWiki#localStringEntityReferenceSerializer now exists in oldcore, we do not need it in the aspect anymore:(((
726 {{code language="none"}}
727 com.xpn.xwiki.XWikiCompatibilityAspect: Method 'public org.xwiki.model.reference.EntityReferenceSerializer ajc$interFieldGetDispatch$com_xpn_xwiki_XWikiCompatibilityAspect$com_xpn_xwiki_XWiki$localStringEntityReferenceSerializer(com.xpn.xwiki.XWiki)' has been removed
728 com.xpn.xwiki.XWikiCompatibilityAspect: Method 'public void ajc$interFieldInit$com_xpn_xwiki_XWikiCompatibilityAspect$com_xpn_xwiki_XWiki$localStringEntityReferenceSerializer(com.xpn.xwiki.XWiki)' has been removed
729 com.xpn.xwiki.XWikiCompatibilityAspect: Method 'public void ajc$interFieldSetDispatch$com_xpn_xwiki_XWikiCompatibilityAspect$com_xpn_xwiki_XWiki$localStringEntityReferenceSerializer(com.xpn.xwiki.XWiki, org.xwiki.model.reference.EntityReferenceSerializer)' has been removed
730 {{/code}}
731 )))
732
733 * Not a breakage. The legacy method was not in the right place (which mean that it was not available so it actually fix a breakage):(((
734 {{code language="none"}}
735 com.xpn.xwiki.XWikiCompatibilityAspect: Method 'public java.lang.Object getRenderingEngine()' has been removed
736 {{/code}}
737 )))
738
739 * Young API. ExportURLFactoryContext been renamed to FilesystemExportContext and moved to the Filesystem URL scheme module
740 {{comment}}Eduard @ 7.2RC1:
741 I have found 3 differences in xwiki-platform that have not generated a clirr error, maybe they are leftovers or the clirr report did not catch them for some reason. See https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/pom.xml#L493:L510{{/comment}}

Get Connected