Release Notes for XWiki Enterprise 3.2 (XWiki.org)

$xwiki.ssx.use("ReleaseNotesXWikiEnterprise30M3")

Following the [[goals established for the 3.x cycle>>enterprise:Main.Roadmap#HXWikiEnterprise3.xCycle]], XWiki Enterprise 3.2 pushes forward in the directions of the Application Within Minutes and Extension Manager features. The highlights of this release are:

8

9

* many **extension manager improvements**

10

* new implementation of the **sheet system** making it easier to bind sheets to objects without an explicit inclusion of the sheet in the document content

11

* **user dashboards** giving each user the possibility to configure their own home page

12

* introduction of **wiki workspaces**, as a more collaborative way of managing an XWiki virtual farm

13

* improvements of **search results** scoring

14

* **storage improvements**, bringing in numerous performance and compatibility improvements

15

* conversion of the **panels application** to the XWiki 2.0+ syntax

16

* easier activation and configuration of **Google Analytics**

17

18

And on the developers' front:

19

20

* **CSRF prevention** enabled by default

21

* support for **DocBook syntax**

22

* ##xwiki-commons## and ##xwiki-rendering## are now [[**published on the central Maven2 repository**>>http://search.maven.org/#search%7Cga%7C1%7Corg.xwiki]]

23

* some major **code cleanup** due to the retirement of some very old plugins and the move of legacy/deprecated code into separate modules

24

25

We've setup a [[Jira dashboard>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=10581]] to present the work done for the whole 3.2 release. In summary, 338 issues have been closed by 12 committers (and other contributors providing patches), out of which 149 are fixed bugs.

26

27

= New and Noteworthy (since XWiki Enterprise 3.1) =

28

29

== Extension Manager improvements ==

30

31

Progressing towards the completion of the extension manager, 3.2 adds support for:

32

* [[virtual extensions>>extensions:Extension.Extension Module Virtual Extensions]], or aliases for extensions that have changed their identifier

33

* automated 3-way merging of wiki documents, which brings update capabilities for XAR extensions

34

* better error reporting during installation, upgrade or removal of extensions

35

* [[XWiki repository>>extensions:Extension.Extension Module Repository]] REST protocol has been rewritten

36

* local extensions repository moved from ##~~/.xwiki## to container persisted directory

37

* display all the extensions metadatas when resolving it

38

39

== New implementation of the sheet system ==

40

41

In preparation for the //Application Within Minutes// major feature, this release introduces a new way of associating objects with the sheets used for displaying them. Whereas until now the content of the document had to explicitly contain an ##{~{include}~}## statement in order to display an attached object, an object can pull its sheet automatically. This frees up the document content for a more useful purpose.

42

43

The new sheet detection mechanism allows for more flexibility. Whereas with the old ##{~{include}~}## mechanism sheets could only be bound to a specific document, the new implementation brings a plethora of additional options: sheets can be associated globally to a class, they can be differentiated on a specific action (allowing to use different sheets for //view//, //edit// or //export//), they can be specified for different users or groups, or even forced explicitly via request parameters.

44

45

With the new sheet mechanism, form editing can now be performed using the ##/edit/## action, either automatically for documents containing sheet-bound objects, or explicitly forced using the ##editor=inline## request parameter. In consequence, **the ##/inline/## action has been deprecated**.

46

47

Most of the classes/sheets bundled with XWiki Enterprise have been updated already to use the new mechanism. Upgraded wiki instances containing documents which still rely on the old sheet inclusion mechanism will continue to work, but it's recommended to update them.

48

49

You can read more about this feature on the [[Sheet Module>>extensions:Extension.Sheet Module]] documentation page.

50

51

== User Dashboards ==

52

53

After wiki- and space-wide dashboards, this release brings support for personal dashboards. Each user can define their own dashboard in their profile document, and they can use it either in their profile document, or display it instead of the homepage default dashboard.

54

55

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M2@userdashboard.png||class="screenshot"]]

56

57

== Wiki Workspaces ==

58

59

We have adopted the [[extensions:Extension.Workspace Application]] as an XWiki platform project. In a few words, the //Workspace Application// allows regular users to create workspaces where they can collaborate on a specific topic. A workspaces is, in essence, a regular subwiki that is to be used by a group of global users. It allows global users to join or be invited and to easily navigate through the available workspaces and back to the main wiki.

60

61

The //Workspace Application// is best suited for intranets or any other use case that involves having only global users and going back and forward through projects or departments that are separated in subwikis. It is not intended for environments such as wiki farms, where each subwiki is a bubble, having its own users, oblivious about other subwikis or the main wiki. This later use case is better served by [[XWiki Enterprise Manager>>manager:Main.WebHome]].

62

63

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@create-workspace-entry.png||alt="Create workspace button" class="screenshot"]]

64

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@main-wiki-section-in-a-workspace.png||alt="Main wiki section displayed in top menu while in a workspace" class="screenshot"]]

65

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@workspace-administration-workspaceusers-section.png||alt="Workspace Users section in the workspace's administration section replacing 'Registration' and 'Users'" class="screenshot"]]

66

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@workspaceDirectory.png||alt="Workspace Directory listing available workspaces and available actions" class="screenshot"]]

67

68

The //Workspace Application// is not bundled by default with any XWiki product, but it can be installed as an extension.

69

70

== Improved search results scoring ==

71

72

The search results retrieved by the Lucene plugin have been for a long time the target of many complaints, since documents that were actually relevant for a query usually appeared too low in the results list. This issue has now been improved, by scoring results differently depending on the field where the search query matches. A hit on the document title will ensure that the document will be among the first results, while a hit on the owner document's name of an attached image will place the image towards the end.

73

74

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M3@search.png||class="screenshot"]]

75

76

== Storage improvements ==

77

78

The version of [[Hibernate>>http://hibernate.org]] used by XWiki has been upgraded to 3.6.7, bringing in numerous performance and compatibility improvements. Additionally, the mapping and configuration files have been reviewed, upgraded and simplified. InnoDB, which used to be only recommended, is now enforced by default when creating a new database or table in MySQL. Further performance enhancements for default installations come from the fact that the proper indexes needed for efficient database access are now auto-created at startup, eliminating the need for manual configuration.

79

80

== Converted the Panels application to the new XWiki syntax ==

81

82

Although only a rewrite, with no new features, this makes it easier to edit panels. Several panels have also been cleaned up and optimized, minimizing the use of inline HTML, which was replaced with wiki markup.

83

84

== Easier activation and configuration of Google Analytics ==

85

86

In older versions, XWiki provided a velocity template that could be edited to enable Google Analytics. Still, this required either access to the server or overriding a template in the skin document, which was not that easy to discover. Starting with this version, there is a custom section in the wiki Administration which makes it extremely easy to enable Google Analytics tracking.

87

88

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M3@analytics.png||style="border: 1px solid black"]]

89

90

The new implementation also allows to define different tracking accounts for each wiki, and to use more than one tracking account per wiki.

= For Developers =

== CSRF prevention is enabled by default ==

95

96

[[Cross-site request forgery>>https://secure.wikimedia.org/wikipedia/en/wiki/CSRF]] is an exploit done via JavaScript, which allows a malicious/broken site to include javascript that performs actions on another site on behalf of the currently logged in user. Starting with 3.2, XWiki comes with a prevention mechanism enabled by default. Although it was introduced earlier, in [[2.5>>ReleaseNotes.ReleaseNotesXWikiEnterprise25#HTestingCSRFprotection]], it wasn't enabled by default since several actions were broken by this change. While we now expect almost everything to work fine, please [[report>>http://jira.xwiki.org/secure/Dashboard.jspa]] any actions that are still broken.

97

98

{{warning}}This feature can break custom applications that don't use the standard form edition mode and instead implement their own forms or form handling mechanism. See the [[Migration notes>>#HFixingapplicationsbrokenbytheCSRFpreventionmechanism]] below for more details about how to fix broken applications.{{/warning}}

99

100

== New rendering features: DocBook syntax and {~{comment}~} macro ==

101

102

The XWiki rendering engine includes support for parsing from and rendering into the [[DocBook>>http://en.wikipedia.org/wiki/DocBook]] syntax, thanks to the corresponding Doxia modules. Among other usecases, this means that:

103

* XWiki pages can be transformed into DocBook documents to be further transformed into other formats, like ##man## pages or epub documents, making XWiki a better tool for documentation writing

104

* existing DocBook documents can be imported directly into an XWiki instance, thereby benefiting from the lifecycle of any wiki document, such as easy on-line editing and instant HTML preview

105

* the xwiki-rendering project can be integrated in a tool to convert wiki markup into DocBook content

106

107

A new ##{~{comment}~}## macro is provided for including textual comments inside documents, other than HTML ##<!~--comments ~-->## inside a ##{~{html}~}## macro or Velocity ##~#* comments *~### inside a ##{~{velocity}~}## macro.

108

109

110

Visible text. {{comment}}This text won't be visible in the resulting HTML page{{/comment}} And this is visible again.

111

112

113

== Improvements to the Suggestion and Spotlight Search widgets ==

114

115

Extensive polishing and bugfixing work has been done for the Spotlight-like search, making it more stable and easier to use and customize. Some improvements include the option to display only one "//loading//" status for all the suggestion sources, the option to display hints next to each search result, better highlighting of matches between the input text and the displayed items, plus various bugfixes.

116

117

[[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M2@suggest.png||class="screenshot"]]

118

119

== New JavaScript testing framework ==

120

121

Unit tests for JavaScript code can now be written using the [[Jasmine framework>>http://pivotal.github.com/jasmine/]] for behavioral-driven development.

122

123

Example [[tests>>https://github.com/xwiki/xwiki-platform/blob/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-web/src/test/javascript/spec/suggest.js]] for the [[input suggestions widget>>https://github.com/xwiki/xwiki-platform/blob/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-web/src/main/webapp/resources/uicomponents/suggest/suggest.js]]:

124

125

126

describe("Suggest", function() {

127

describe("Emphasis Matcher", function() {

128

it("emphasizes a single match", function() {

129

var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Typed", "Value with Typed word");

130

expect("Value with Typed word").toEqual(result);

131

});

132

133

it("emphasizes several matches", function() {

134

var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Words Typed", "A Selection Of Words Been Typed");

135

expect("A Selection Of Words Been Typed").toEqual(result);

136

});

137

138

it("emphasizes repeated matches", function() {

139

var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("To Be", "To Be, Or Not To Be");

140

expect("To Be, Or Not To Be").toEqual(result);

141

});

142

143

it("preserves original case", function() {

144

var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("wOrDs TypEd By An eMo kID", "Words Typed By John Doe");

145

expect("Words Typed By John Doe").toEqual(result);

146

});

147

148

it("is neutral when there are no match", function() {

149

var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Rock'n'roll", "Bring me A bowl of coffee before I turn into a goat");

150

expect("Bring me A bowl of coffee before I turn into a goat").toEqual(result);

});

});

});

== Named parameters for the event stream ==

157

158

The new [[event stream module>>extensions:Extension.Event Stream Module]] offers support for arbitrarily named parameters to be associated with stored events. This is a better way of dealing with extra parameters than the old up to 5 numbered parameters supported by the ActivityStream plugin. The limitation is that both the name and the value must be strings of at most 255 characters. Read more about the event stream module and how to use these named parameters in [[the module's documentation>>extensions:Extension.Event Stream Module]].

159

160

== GPG signed artifacts ==

161

162

Starting with this release, all build artifacts will be signed by one of the XWiki developers using a PGP signature. Such signatures are available in [[our maven repository>>http://maven.xwiki.org/releases/org/]] as ##.asc## files next to each artifact. We advise you to check the signatures of the files you download to make sure there are no problems with them.

163

164

To check the signatures, you should:

165

166

# Install GPG, if it's not already installed on your system

167

# Download both the artifact and its ##.asc## counterpart

168

# Run ##gpg -~-verify -~-keyserver-options auto-key-retrieve=true //artifact-file.jar.asc//##

169

170

== Official HTTPS support ==

171

172

While our sysadmins have been able for a very long time to use the right configuration for Tomcat, Apache HTTPD and the AJP connector between them, starting with 3.2 the XWiki community pledges to officially maintain proper HTTPS support for XWiki.

173

174

== ##xwiki-commons## and ##xwiki-rendering## published on the central maven repository ==

175

176

Starting with this version, [[##xwiki-commons##>>http://repo1.maven.org/maven2/org/xwiki/commons/]] and [[##xwiki-rendering##>>http://repo1.maven.org/maven2/org/xwiki/rendering/]] are deployed on the central maven repository, which makes it easier to reuse modules from these projects inside a third party application, unrelated to XWiki.

177

178

== New location for storing persistent data ==

179

180

Because of a [[bug>>http://jira.xwiki.org/browse/XWIKI-6959]] in the old core, it was very hard to configure a directory where data could be safely stored. This bug has been fixed for the 3.2 release. Additionally, a new [[API>>http://jira.xwiki.org/browse/XWIKI-6957]] for accessing this directory has been introduced, a few components have been updated to use this location, and in the default standalone distribution a new ##data/## directory is configured to store permanent data.

181

182

{{warning}}Read the [[migration notes below>>#HIssuesspecifictoXWikiEnterprise3.2]] for important details about migrating existing data into the new location.{{/warning}}

183

184

== Deprecated and Retired projects ==

185

186

By default, the platform is now free of legacy code. Deprecated features have been officially removed, but are still included via aspects for backwards compatibility in the final distribution packages. For each module that had legacy code, there is a corresponding module in ##xwiki-commons-legacy## or ##xwiki-platform-legacy## that generates an extended ##jar## containing the deprecated classes or methods on top of the clean code. Apart from moving already deprecated code, such as [[old observation events>>https://github.com/xwiki/xwiki-platform/tree/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-legacy/xwiki-platform-legacy-observation]] or [[the backwards-compatibility aspects for the old core>>https://github.com/xwiki/xwiki-platform/tree/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-legacy/xwiki-platform-legacy-oldcore/src/main/aspect/compatibility]], new deprecations appeared in this release:

187

188

* the old [[XWikiCache API>>https://github.com/xwiki/xwiki-platform/tree/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-legacy/xwiki-platform-legacy-oldcore/src/main/java/com/xpn/xwiki/cache]], replaced by the [[cache module>>extensions:Extension.Cache Module]]

189

* the old [[notification system>>https://github.com/xwiki/xwiki-platform/tree/xwiki-platform-3.2-rc-1/xwiki-platform-core/xwiki-platform-legacy/xwiki-platform-legacy-oldcore/src/main/java/com/xpn/xwiki/notify]], replaced by the [[observation module>>extensions:Extension.Observation Module]]

190

* the support for the old [[@Requirement>>https://github.com/xwiki/xwiki-commons/tree/xwiki-commons-3.2-rc-1/xwiki-commons-core/xwiki-commons-legacy/xwiki-commons-legacy-component]] way of declaring injected dependencies; ##@Inject## combined with ##@Named## should be used instead

191

192

Several very old and unmaintained projects have been retired as repositories in the [[xwiki-contrib organization on GitHub>>https://github.com/xwiki-contrib/]]:

193

194

* [[adwords plugin>>https://github.com/xwiki-contrib/plugin-adwords]]

195

* [[Albatross skin>>https://github.com/xwiki-contrib/skin-albatross]]

196

* [[alexa plugin>>https://github.com/xwiki-contrib/plugin-alexa]]

197

* [[calendar plugin and application>>https://github.com/xwiki-contrib/plugin-calendar]]

198

* [[exoplatform plugin>>https://github.com/xwiki-contrib/plugin-exoplatform]]

199

* [[photo album application>>https://github.com/xwiki-contrib/application-photoalbum]]

200

* [[S5 presentation application>>https://github.com/xwiki-contrib/application-s5]]

201

* [[workstream application>>https://github.com/xwiki-contrib/application-workstream]]

202

203

The swizzle-based plugin for interacting with Jira has been replaced by a new [[jira module>>extensions:Extension.JIRA Module]] which uses the new REST APIs offered by Jira instead of the deprecated XML-RPC services. The old swizzle plugin code is no longer maintained, but it can be retrieved from [[older tags>>https://github.com/xwiki/xwiki-platform/tree/xwiki-platform-3.2-milestone-1/xwiki-platform-core/xwiki-platform-swizzle]].

== Various ==

* [[XCOMMONS-14>>http://jira.xwiki.org/jira/browse/XCOMMONS-14]]: Added new XML manipulation methods to the ##XMLUtils## helper class.

208

* [[XCOMMONS-17>>http://jira.xwiki.org/jira/browse/XCOMMONS-17]]: Added a bridge that converts LogBack log events into observable events.

209

* [[XCOMMONS-19>>http://jira.xwiki.org/jira/browse/XCOMMONS-19]]: Added new methods to ##$escapetool## for encoding test into the [[Quoted-Printable>>http://tools.ietf.org/html/rfc2045#section-6.7]] and the [[B and Q>>http://tools.ietf.org/html/rfc2047]] MIME encodings. These methods are usually needed when generating emails.

210

* [[XWIKI-6832>>http://jira.xwiki.org/browse/XWIKI-6832]]: Added support for OpenOffice 3.3.

== Upgrades ==

The following dependencies have been upgraded:

215

216

* Aether 1.13

217

* batik-rasterizer 1.7

218

* commons-configuration 1.7

* commons-lang 3.0.1

* Doxia 1.2

* Groovy 1.8.2

* Hibernate 3.6.7 Final (and related dependencies)

223

* hibernate-validator 4.2.0.Final

224

* HTML Cleaner 2.2

225

* Jetty 7.4.5

226

* JodConverter 3.0-beta-4-xwiki-20110822

* jruby 1.6.3

* Logback 0.9.30

* Lucene 3.4

* Reflections 0.9.5

* Selenium 2.7.0

* slf4j 1.6.2

== Miscellaneous ==

Besides the major features described above, this release brings lots of bug fixes as well as improvements in various domains of XWiki, including color theme usage and refreshing, observation events, annotations, multilingual mode, PDF export, special characters handling, section editing, deleted document and attachments trash, flickering integration tests, and many build reusability and enforcements. See the [[full list of closed issues>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+in+%28%22Top+Level+Projects%22%29+and+fixVersion+in+%28%223.2+M1%22%2C+%223.2+M2%22%2C+%223.2+M3%22%2C+%223.2+RC1%22%2C+%223.2%22%29+and+resolution+in+%28%22Fixed%22%29]] and the release notes for 3.2 [[Milestone 1>>ReleaseNotesXWikiEnterprise32M1]], [[Milestone 2>>ReleaseNotesXWikiEnterprise32M2]], [[Milestone 3>>ReleaseNotesXWikiEnterprise32M3]] and [[Release Candidate 1>>ReleaseNotesXWikiEnterprise32RC1]] for details.

== Translations ==

The following translations have been updated: ##de##, ##fr##, ##it##, ##lv##, ##nl##, ##ru##, ##sv##, ##zh##

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

= Test Report =

You can check the [[manual test report>>TestReports.WebHome#HVersions3.2.x]] to learn about what was tested and the results on various browsers.

249

250

= Backward Compatibility and Migration Notes =

== General Notes ==

If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases=all// to your //xwiki.cfg// file or explicitly name all databases to be migrated as in //xwiki.store.migration.databases=db1,db2,...//.

256

257

258

You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.

259

260

261

Always make sure you compare your ##xwiki.cfg## and ##xwiki.properties## files with the newest version since some configuration parameters were 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.

262

263

264

== Issues specific to XWiki Enterprise 3.2 ==

265

266

* The behavior of the HTML Macro has changed slightly (as a consequence of the upgrade to HTML Cleaner 2.2): CDATA elements not located inside SCRIPT or STYLE elements are now removed when cleaned (i.e. when the ##clean## parameter is ##true##). If you don't want any cleaning done, use ##clean="false"##.

267

* Since the Lucene engine has been upgraded to a new major version, you should completely rebuild the index. This can be done from the main wiki administration, in the //Search// section.

268

* See the [[retired section>>#HDeprecatedandRetiredprojects]] above for the list of removed modules. The most important one is the **removal of the Albatross skin** from the distribution. Be careful to review your ##xwiki.cfg## file and update the ##xwiki.defaultskin## and ##xwiki.defaultbaseskin## properties and make sure their values is now ##colibri## (unless you wish to continue using Albatross, in which case you'll need to install an older release of the Albatross skin in your installation).

269

* The **ehcache** library is no longer packaged by default. If you've configured a second level hibernate cache using this library, make sure you manually download it in the libs or replace your configuration with another cache engine.

270

* The **oscache** based implementation of the xwiki cache module is no longer packaged by default. If you'd like to use this specific implementation, make sure you explicitly include it in your distributions.

271

* See the backward compatibility and migration notes for the new implementation of the [[sheet system>>extensions:Extension.Sheet Module]].

272

* The permanent data storage directory is now by default ##data##, in the root of the standalone distribution. This is where you'll find, for example, the Lucene index, the custom extensions installed by the extension manager, or the attachments when the filesystem attachment storage is configured. If you're upgrading from an older version, make sure you first move the existing data from the ##jetty/work/## directory. You can configure the location of the permanent data storage in ##xwiki.properties## via the ##container.persistentDirectory## setting, and, for older code using the ##XWiki.getWorkDirectory## method, in ##xwiki.cfg## via the ##xwiki.work.dir## setting.

273

274

=== Fixing applications broken by the CSRF prevention mechanism ===

275

276

If your application has been broken by this change, usually all it takes to make it compatible with the CSRF prevention mechanism is to add a hidden field inside the submitted forms, or to add a request parameter to the data-altering URLs:

Inside forms:

Inside URLs:

$doc.getURL('action', "parameters=values&form_token=$!{services.csrf.getToken()}")

284

$xwiki.getURL('Some.Document', 'action', "parameters=values&form_token=$!{services.csrf.getToken()}")