Release Notes for XWiki 6.4 (XWiki.org)

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

6

7

The 6.4 release is the last major release of the 6.x development Cycle and as such was mainly dedicated to improvements and bugfixes on things introduced during 6.X.

8

9

This version introduces some developer oriented improvements: allow wiki based skins to overwrite macro.vm template, allow filesystem skins indicating explicitly the skin they are inheriting from, allow any component to be injected with its ComponentDescriptor, Panels and UI extensions are now executed with the right of their author so among other things they can use APIs requiring Programming rights.

10

11

It also brings UI improvements in the Menu application, a new Mail application (and Mail-related improvements, such as the ability to send massive number of emails) and lots of Flamingo skin improvements (Mobile-friendliness to mention one), while offering developers the ability to write LESS in Skin Extensions, and a cool icon picker.

12

13

Last but not least, this version provides the ability to rate Extensions inside the Extension Repository and visualise them inside the Extension Manager.

14

15

16

Important problems noticed after the 6.4 release:

17

18

* In this release, we're now providing an easy way to install SOLR as an external server. When doing this change, we moved a plugin inside the SOLR index directory. Thus, if you're using XWiki with SOLR in embedded mode (the default), when you upgrade, this plugin will not be present in your SOLR directory and XWiki will fail to start. To work around this problem, you'll need to remove the ##<permanent directory>/solr/## directory (which will trigger a new reindexing when you next start XWiki). This will be [[fixed in XWiki 6.4.1>>http://jira.xwiki.org/browse/XE-1463]].

19

* The main CSS is often badly generated, [[this will be fixed in 6.4.1>>http://jira.xwiki.org/browse/XWIKI-11755]].

20

* [[HTML exports are taking very long>>http://jira.xwiki.org/browse/XWIKI-11731]] (over 1 minute to export a single page). Thus if you're using this feature, we recommend waiting for 6.4.1 and not upgrading to 6.4.

21

22

23

= New and Noteworthy (since XWiki 6.3) =

24

25

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

26

27

== Menu Application ==

28

29

Taking advantage of the ability to have LESS inside our [[StyleSheetExtensions>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]], we improved the [[Menu Application>>extensions:Extension.Menu Application]], on Flamingo based skins, making it responsive and also adapting its styling according to the active [[Flamingo Theme>>extensions:Extension.Flamingo Theme Application]].

30

Colibri based skins preserve the initial styling.

31

32

33

image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal.png

34

image:ReleaseNotesXWiki64M2@menu_flamingo_united.png

35

image:ReleaseNotesXWiki64M2@menu_flamingo_darkly.png

36

image:ReleaseNotesXWiki64M2@menu_flamingo_simplex.png

37

image:ReleaseNotesXWiki64M2@menu_flamingo_charcoal_responsive.png

== Flamingo Skin ==

We partially restored the behaviour of the top level menu from version 6.2, with some improvements:

43

44

* For tablet and desktop:

45

** the menu label is a link used for navigation

46

** the toggle (arrow / caret) is used for opening the drop down menu, but should be better separated from the label

47

* On phones the behaviour remains the same: taping on the label opens the menu

48

49

Default: {{image reference="ReleaseNotesXWiki64M2@charcoal-default.png"/}}

50

Hover Link: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-link.png"/}}

51

Hover Toggle: {{image reference="ReleaseNotesXWiki64M2@charcoal-hover-toggle.png"/}}

52

Open: {{image reference="ReleaseNotesXWiki64M2@charcoal-open.png"/}}

53

54

The history table, under each page, is now responsive to the screen size:

55

56

(((

57

{{image reference="ReleaseNotesXWiki64M2@responsive-history.png"/}}

58

)))

59

60

Some improvements have been made on the responsive tables (including the livetables) and we have fixed the broken livetables for mobiles on some places:

61

62

(((

63

{{image reference="ReleaseNotesXWiki64M3@livetable-rights.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-users.png" width="30%"/}} {{image reference="ReleaseNotesXWiki64M3@mobile-groups.png" width="30%"/}}

64

)))

65

66

== Rating Features ==

67

68

The Contrib ratings project has been moved to platform. Java APIs have been broken by the package renaming but script APIs have been kept retro-compatible and the UI is mostly the same. See [[Ratings Application>>extensions:Extension.Ratings Application]].

69

70

It's now possible to rate extensions in [[Extension Repository>>extensions:Extension.Repository Application]] and any repository handler can expose extension rating that are displayed (read only for now) in [[Extension Manager>>extensions:Extension.Extension Manager Application]].

== Wiki Configuration ==

75

76

A new "Configuration > Wiki" section is added in Administration where you can configure the current wiki, whether it is the main wiki or a subwiki.

77

78

{{image reference="ReleaseNotesXWiki64M3@wikiDescriptorEditingAdministration-cropped.png"/}}

79

80

For more information, see the [[documentation>>extensions:Extension.Wiki Application||anchor="HConfigureWiki"]].

81

82

== New Parameters for Document Tree Macro ==

83

84

We added 3 new parameters to the [[Document Tree Macro>>extensions:Extension.Document Tree Macro]]:

85

86

* **filterByClass**: show only the documents that have an object of the specified type. The value of this parameter is the full name of an XWiki document that holds a class definition. For example, 'Blog.CategoryClass' can be used to show only the documents that represent blog categories.

87

* **openTo**: the id of the node to open the tree to. All the ancestors of the specified node, up to the root of the tree, will be opened also.

88

* **showOnlyViewable**: show only the wiki, space and document nodes for which the current user has view right. If this is set to false then the wiki, space and document nodes that are not viewable by the current user are listed in the tree using their names. The user won't be able to see their content by following their links though (the user will just be aware of their existence).

== Mail Feature ==

* The mail feature has a new Category in the Admin UI (see the [[Mail Application>>extensions:Extension.Mail Application]] for details).(((

93

94

)))

95

* There's now the possibility to configure default BCC addresses which will be added by default to all emails sent using the [[Mail Sender API>>extensions:Extension.Mail Sender API]].(((

96

97

)))

98

* The [[Mail Sender API>>extensions:Extension.Mail Sender API]] now checks for permission before sending emails, when using it from scripts (i.e. when using the Mail Sender Script Service). There are currently 2 possible strategies that you configure in your ##xwiki.properties## file(((

99

100

#-# [Since 6.4M2]

101

#-# Defines which authorization checks are done when sending mails using the Mail Sender Script Service.

102

#-# Example of valid values:

103

#-# - "programmingrights": the current document must have Programming Rights

104

#-# - "alwaysallow": no check is performed. This is useful when running XWiki in a secure environment where we

105

#-# want to allow all users to be able to send emails through the Script Service.

106

#-# The default is:

107

# mail.sender.scriptServiceCheckerHint = programmingrights

108

109

)))

110

* The [[Mail Sender API>>extensions:Extension.Mail Sender API]] has been modified to support sending a large number of mails at once. In addition the [[Mail Admin UI>>extensions:Extension.Mail Application]] has been improved to display the statuses of mails (when they're sent by XWiki features specifying that the mail statuses should be persisted).(((

)))

* You can now specify the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not be considered a spammer by mail servers. For example if you wish to wait 10 seconds (if not specified the default is 8 seconds, which is 450 mails per hour), set the following in your ##xwiki.properties##:(((

116

117

mail.sender.sendWaitTime = 10000

118

119

120

The configuration parameter can also be changed from the [[Mail Admin UI>>extensions:Extension.Mail Application]]:

)))

* We now save both an error summary and a full error description when a mail fails to be sent when using the Database Mail Listener. This allows to see the full stack trace of the problem to more easily debug it.(((

125

126

)))

127

* The Mail Type is now displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]]:(((

128

129

)))

130

* The ##MailResult.isSent()## API has been renamed to ##MailResult.isProcessed()## to avoid thinking that it'll return true if all mails have been sent successfully. What it does is simply return true when all mails have been processed, whether they've been sent successfully or not.

131

* A new scripting API has been added to set the mail type:(((

132

133

$message.setType("Some type")

134

135

)))

136

* In the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] we now only display mails sent by the current wiki unless we're on the main wiki.

137

* The [[Mail Application>>extensions:Extension.Mail Application]] doesn't require Programming Rights for installation anymore.

138

* Account Validation email results are now saved and visible in the [[Mail Application>>extensions:Extension.Mail Application]].

139

* Some new [[Mail Sender Storage script services>>extensions:Extension.Mail Sender Storage]] have been added: ability to delete mail statuses for a single mail and for a whole batch, and ability to load mail statuses with criteria.

140

* When messages are sent with the API they are now persisted locally before they are effectively sent, one by one. This means that even if XWiki crashes when mails are being sent, their statuses will be correctly displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]] and can be resent.

141

* The Java API has been modified to use Strings in all places where it was previously using a UUID, in order to allow for change in unique id generation in the future.

142

* The wiki is not displayed in the [[Mail Sender Status Admin UI>>extensions:Extension.Mail Application]](((

)))

== Wikis ==

A "Wikis" category has been created in the administration, where the configuration have been moved and split in different sections:

149

150

(((

151

|=Left menu|=Right menu

152

|{{image reference="ReleaseNotesXWiki64RC1@AdminWikis.png"/}}|{{image reference="ReleaseNotesXWiki64RC1@AdminWikis2.png"/}}

153

)))

154

155

== Extension Manager incompatible exceptions ==

156

157

When trying to install an incompatible extension (i.e. you are running XWiki 6.2.4 and want to install FAQ Application 6.3), you are now displayed a proper error instead of having to read through the install log to understand what went wrong, and you are instructed to use the ##Description > Stable Versions## section to manually (for now) find a compatible version of the extension that you want to install.

158

159

{{image reference="ReleaseNotesXWiki64RC1@incompatibleExtensionError.png"/}}

160

161

== Solr server setup package ==

162

163

Everything needed to setup an XWiki index in a remote Solr server is now packaged in a standalone project (##xwiki-platform-search-solr-server-data##). A Debian package (##xwiki-solr-data##) has also been provided to make easier to keep it up to date.

== Miscellaneous ==

* It's [[now possible to send Registration emails in HTML>>extensions:Extension.Administration Application||anchor="HRegistration"]] (by default they're sent in plain text). This is achieved by fully supporting any MIME content in the "Validation Email Content" and "Confirmation Email Content" sections of the Registration Administration UI. For example for the "Validation Email Content" field, you could use the following template to send HTML emails:(((

168

169

#set ($wikiname = $request.serverName)

170

#set ($host = ${request.getRequestURL()})

171

#set ($host = ${host.substring(0, ${host.indexOf('/', ${mathtool.add(${host.indexOf('//')}, 2)})})})

172

Subject: Validate your account on ${wikiname}

173

Content-type: text/html; charset=iso-8859-1

174

175

Hello ${xwiki.getUserName("XWiki.$xwikiname", false)},

176

This email address was used to register a new account on ${wikiname}. If you did not make the request, please ignore this message.

177

In order to activate your account, please follow this link:

178

${host}${xwiki.getURL('XWiki.AccountValidation', 'view', "validkey=${validkey}&xwikiname=${xwikiname}")}

179

180

)))

181

* The selected tree node is now highlighted even when links are enabled:(((

182

{{image reference="ReleaseNotesXWiki64M2@highlightSelectedTreeNode.png"/}}

183

)))

184

* A list of icons supported by XWiki have been created, with mapping for Silk and Font Awesome. Which means that we now propose a list of icons that are both present in Silk and Font Awesome.

185

* The list of columns in the UserDirectory customization screen is now sorted alphabetically

186

* The accuracy of the attachment content type detection has been improved. If the file name extension is unknown then we attempt to detect the content type from the first bytes of the file content. You can check this by attaching a text file without the 'txt' file name extension.

187

* Displaying the 'Stable versions' label in an extension's description in Extension Manager before and after the list of versions is retrieved.

188

* A click to the Document Index does not lead to an other space anymore.

189

* [[extensions:Extension.Tag Cloud Macro]] has now a new parameter (spaces) to display a tag cloud from multiple spaces.

190

191

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

= For Developers =

== Icon Picker ==

An [[icon picker>>extensions:Extension.Icon Theme Application||anchor="#HIconPicker"]] has been created to help users selecting an image in the list of supported icons.

This picker is already used in [[Application Within Minutes>>extensions:Extension.App Within Minutes Application]] for the application's icon selection.

202

203

== Skin Extensions ==

204

205

[[Now you can use LESS in your Skin Extensions!>>extensions:Extension.Skin Extension Plugin||anchor="HUseLESS"]]. You just need to set the new property "Content Type" to LESS inside your Skin Extension object:

206

207

{{image reference="ReleaseNotesXWiki64M2@contentTypeLESS.png"/}}.

208

209

== Admin ConfigurableClass ==

210

211

The [[##ConfigurableClass## mechanism>>extensions:Extension.Administration Application||anchor="HMakingyourapplicationconfigurablewithConfigurableClass"]] has been improved to be able to contribute new categories in the Admin UI. For example the "Email" Category in the following screenshot is contributed through a ##ConfigurableClass##:

It was configured using:

216

217

{{image reference="ReleaseNotesXWiki64M2@emailconfigurableclass.png"/}}

218

219

== Velocity changes ==

220

221

=== Remove a Velocity Engine from the cache ===

222

223

##org.xwiki.velocity.VelocityFactory## now provide an API to remove a cached Velocity Engine.

224

225

=== Overriding Velocimacros in wiki-based skins ===

226

227

It's now possible to override the ##macros.vm## template in a wiki based skin (object property and attachment). Any modification to this template is also taken into account (the Velocity engine is recreated when the template is modified).

228

229

=== Cleanup unprotected namespaces ===

230

231

VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected.

232

233

In practice in means that the following:

234

235

236

engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")

237

238

Writer out = new StringWriter();

239

engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")

240

241

System.out.println(out.toString())

will now print

#mymacro()

To get

toto

you need the following

257

258

259

engine.startedUsingMacroNamespace("namespace")

260

261

try {

262

engine.evaluate(new VelocityContext(), new StringWriter(), "namespace", "#macro(mymacro)toto#end")

263

264

Writer out = new StringWriter();

265

engine.evaluate(new VelocityContext(), out, "namespace", "#mymacro()")

266

267

System.out.println(out.toString())

268

} finally {

269

engine.stoppedUsingMacroNamespace("namespace")

}

== Skins system improvements ==

274

275

Support for a new ##skin.properties## configuration file has been introduced in filesystem skins.

276

277

Right now it supports a ##parent## property to indicate another skin to inherit from. If set to an empty value ({{code language="properties"}}parent={{/code}}) the skin will directly inherit from the WAR; if not set at all it will behave as before which means inherit from whatever is configured in ##xwiki.cfg##'s ##xwiki.defaultbaseskin## property.

278

279

== Component Metadata Access ==

280

281

If your Component implementation needs to get access to its component metadata (i.e. its ##ComponentDescriptor##) then it can [[get it injected automatically>>extensions:Extension.Component Module||anchor="HComponentMetadata"]]. For example:

282

283

284

import org.xwiki.component.descriptor.ComponentDescriptor;

...

@Component

@Singleton

public class MyComponentImpl implements MyComponent

289

{

290

@Inject

291

private ComponentDescriptor<MyComponent> descriptor;

292

293

public void doSomething()

294

{

295

String hint = this.descriptor.getRoleHint();

...

}

}

== Panels executed with the rights of their author ==

302

303

It's now possible to write script requiring programming right in panels as long as you have programming right, same as wiki macros.

304

305

== UI extensions executed with the rights of their author ==

306

307

What you can execute in UI extension used to depend on current document author right, it's now based on the own ui extension author.

== Rendering ==

XWiki Rendering now provide an HTML5 Renderer.

== REST ==

The REST API for the repository module has been updated to include information about the extension's rating.

316

The information regarding ratings has been included in the AbstractExtension element of the XML Schema, thus it is available in the extension's detailed information and in the search results.

317

318

**More information:**

319

320

* [[Repository module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Repository+Module#HREST]]

**Example:**

<id>org.xwiki.contrib:application-filemanager-ui</id>

327

<name>File Manager Application</name>

328

329

</rating>

335

<summary>Application to manage a hierarchy of folders and files. It embeds viewers for many known file types, such as office and PDF.</summary>

336

<description>This application lets your organize your files inside XWiki using a tree hierarchy of folders. It supports all standard operations like move, rename, copy, delete on both files and folders. You can use drag & drop to upload new files and to modify the folder hierarchy. A wide range of files types can be viewed or played (in case of audio and video files) directly from the wiki. This includes PDF and office documents [...]</description>

337

338

<name>GNU Lesser General Public License 2.1</name>

339

</licenses>

340

<website>http://extensions.xwiki.org/xwiki/bin/view/Extension/File+Manager+Application</website>

341

342

<name>Thomas Delafosse</name>

343

<url>http://www.xwiki.org/xwiki/bin/view/XWiki/tdelafosse</url>

344

</authors>

345

346

<name>Ludovic Dubost</name>

347

<url>http://www.xwiki.org/xwiki/bin/view/XWiki/LudovicDubost</url>

348

</authors>

349

350

<name>Marius Dumitru Florea</name>

351

<url>http://www.xwiki.org/xwiki/bin/view/XWiki/mflorea</url>

352

</authors>

353

<features>tdelafosse:file-manager-application</features>

354

<features>org.xwiki.contrib:application-filemanager</features>

</extension>

== Bridging custom XWiki events from Prototype to jQuery ==

359

360

Starting with this version you can catch from jQuery the custom XWiki events that are fired from Prototype.

361

362

363

require(['jquery', 'xwiki-events-bridge'], function($) {

364

$('.some-element').on('xwiki:moduleName:eventName', function(event, data) {

365

// Here, do something that will be executed at the moment the event is fired.

366

doSomething();

367

368

// The passed data is a reference to the event.memo from Prototype.

369

console.log(data.somethingINeedToKnow);

});

});

See the [[JavaScript API documentation>>platform:DevGuide.JavaScriptAPI]] for the list of events that you can listen to.

== Miscellaneous ==

* Added new APIs to get all the icon themes present on the wiki, and all icons that these icon themes contain.(((

379

380

$services.icon.getIconSetNames()

381

$services.icon.getIconNames()

382

$services.icon.getIconNames("Font Awesome")

383

384

)))

385

* A new parameter has been added to the ##get## action and the ##plain## xpage: ##htmlHeaderAndFooter##, which add the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...). It could be useful to create light popups that display only the document content without any UI.

386

* XWikiAttachment now provide ##setAuthorReference## and ##getAuthorReference## APIs

387

* ##org.xwiki.logging.event.LogEvent## now have a getTimestamp() method returning the number of milliseconds elapsed from 1/1/1970 until logging event was created.

388

* A SOLR-based implementation of the standard REST search resource has been added

389

* The [[Solr Query>>extensions:Extension.Solr Search Query API]] parameter ##xwiki.supportedLocales## has a new default value: the list of supported locales configured for the current wiki (where you execute the search).

390

* The ##{{{@Component}}}## annotation is no longer inheritable. Thus each component implementation class must now define it and not rely on it being present in some Abstract class.

391

* The XWiki build now verifies that all components are correctly listed in ##META-INF/components.txt## files and that the threading model is explicitly defined (i.e. that either ##{{{@Singleton}}}## or ##{{{@InstantiationStrategy(ComponentInstantiationStrategy.PER_LOOKUP)}}}## is used). If not, the build fails. A new ##{{{@Component}}}## annotation parameter has been added for explicitly mentioning that a Component should not be statically registered (these components are usually used in tests). It's used as follows:(((

392

393

@Component(staticRegistration = false)

394

395

)))

396

* You can now control in which order the sections added via the [[ConfigurableClass>>extensions:Extension.Administration Application||anchor="HFieldsyoucandefine"]] are displayed in the administration.

397

* New APIs to generate unescaped display user name:

398

** ##com.xpn.xwiki.XWiki#getPlainUserName(DocumentReference userReference, XWikiContext context)##

399

** ##com.xpn.xwiki.XWiki#getUserName(DocumentReference userReference, String format, boolean link, boolean escapeXML, XWikiContext context)##

400

** ##com.xpn.xwiki.api.XWiki#getPlainUserName(DocumentReference userReference)##

401

* New script oriented APIs to get document author/contentAuthor/creator as ##DocumentReference##

402

* It's now possible to provide metadatas to ##MacroContentParser#parse## API

403

* It's now possible to know what namespace a ComponentManager instance is associated with by casting it to ##org.xwiki.component.manager.NamespacedComponentManager##. See [[Component Module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module||anchor="HNamespacedComponentManager"]].

404

* Added getCurrentWikiDescriptor() method to the wiki API and script service to be consistent with the existing getCurrentWikiId() method

405

* The ClassLoader automatically set as Thread ClassLoader is now dynamic meaning that any modification of the context wiki will automatically change the actual Thread ClassLoader. It used to be set to whatever was the wiki in the URL at ExecutionContext init.

406

* [[A new CSS class>>platform:DevGuide.SpecialCSSClasses||anchor="HClassesfortheresponsiveness"]] have been added in Flamingo, to handle responsive tables.

407

* The #sheetTitle Velocity macro supports a new use case: displaying the sheet title if the current document doesn't have an object of some type:(((

408

409

#sheetTitle('The sheet used to display objects of type Space.MyClass', 'Space.MyClass')

)))

== Upgrades ==

The following dependencies have been upgraded:

416

417

* [[httpclient 4.3.6>>http://jira.xwiki.org/browse/XCOMMONS-681]]

418

* [[commons-codec 1.10>>http://jira.xwiki.org/browse/XCOMMONS-684]]

419

* [[Groovy 2.3.8>>http://jira.xwiki.org/browse/XCOMMONS-704]]

420

* [[JGroups 3.6.1>>http://jira.xwiki.org/browse/XWIKI-11523]]

421

* [[Pygments 2.0.1>>http://jira.xwiki.org/browse/XWIKI-11522]]

422

* [[Joda-Time 2.6>>http://jira.xwiki.org/browse/XWIKI-11516]]

423

* [[Bootstrap 3.3.1>>http://jira.xwiki.org/browse/XWIKI-11381]]

424

* [[Bootswatch 3.3.1+2>>http://jira.xwiki.org/browse/XWIKI-11569]]

425

* [[slf4j 1.7.9>>http://jira.xwiki.org/browse/XCOMMONS-712]]

426

* [[Lucene and SOLR 4.10.3>>http://jira.xwiki.org/browse/XWIKI-11603]]

= Translations =

The following translations have been updated:

431

432

{{language codes="da, de, es, fr, ko, lv, pl, pt_BR, ro, ru, sv, tr"/}}

433

434

= Tested Browsers & Databases =

435

436

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

437

438

= Performances tests compared to 5.4.6 =

439

440

Performances improved a bit since 6.3 and we are now generally slightly better than 5.4.6 performances except for the first-loaded page with UI (which incurs the cost of one-time LESS compilation). Lets continue the work in 7.x and improve even more !

441

442

{{display reference="test:Performances.Jetty HSQLDB single wiki 546 to 64" section="HSummary"/}}

443

444

More details on [[performance comparison on single wiki between 6.4 and 5.4.6>>test:Performances.Jetty HSQLDB single wiki 546 to 64]].

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

449

* A problem was discovered after the release when trying to start XWiki on Oracle. When you uncomment the Oracle section in the ##hibernate.cfg.xml## file, you'll get a mapping file declared twice, as in:(((

You'll need to remove first to keep only the following:

)))

= Backward Compatibility and Migration Notes =

== General Notes ==

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

467

468

== Issues specific to XWiki 6.4 ==

469

470

* VelocityEngine automatically get rid of the passed namespace at the end of execution unless it's protected. See [[Velocity section>>||anchor="HVelocitychanges"]].

471

* If upgrading the content in the DistributionWizard, and the upgrade is from XWiki 6.2.x or 6.3, you might get a conflict for the document Blog.BlogSheet. Unless you have done modifications to that document, please keep the new version; otherwise please keep the merged, or if not available, keep your version. For details see issue [[XWIKI-11450>>http://jira.xwiki.org/browse/XWIKI-11450]].

472

* The way to deal with XWiki SOLR plugin changed and you might have issue starting with an existing embedded SOLR index. The simplest is to delete <permdir>/solr folder and let XWiki reindex the instance.

== API Breakages ==

The following APIs were modified since XWiki 6.3:

477

478

* Needed to make sure transformations are executed with the right metadata(((

479

480

org.xwiki.rendering.macro.MacroContentParser: Method 'public org.xwiki.rendering.block.XDOM parse(java.lang.String, org.xwiki.rendering.transformation.MacroTransformationContext, boolean, org.xwiki.rendering.listener.MetaData, boolean)' has been added to an interface

)))

* It's very unlikely that this class is implemented by anything else and it does not make much sense to not have this method, since this is not really a cache behind it but a Map that keep engines forever it may create a memory leak on a big farm running for a long time(((

485

486

org.xwiki.velocity.VelocityFactory: Method 'public org.xwiki.velocity.VelocityEngine removeVelocityEngine(java.lang.String)' has been added to an interface

)))

* This shouldn't be a backward incompatible change since it's a method addition on an Annotation.(((

491

492

org.xwiki.component.annotation.Component: Method 'public boolean staticRegistration()' has been added to an interface

)))

* Does not make much sense allowing to register a JMX bean and not to unregister it.(((

497

498

org.xwiki.management.JMXBeanRegistration: Method 'public void unregisterMBean(java.lang.String)' has been added to an interface

)))

* Young API, this method needs to be available for consistency with the getMainWikiDescriptor/Id pair of methods(((

503

504

org.xwiki.wiki.descriptor.WikiDescriptorManager: Method 'public org.xwiki.wiki.descriptor.WikiDescriptor getCurrentWikiDescriptor()' has been added to an interface

)))

* WYSIWYG's MacroService API was not previously considering a multiwiki environment.(((

509

510

org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroService: Method 'public org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroDescriptor getMacroDescriptor(java.lang.String, java.lang.String, java.lang.String)' has been added to an interface

511

org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroService: Method 'public java.util.List getMacroDescriptors(java.lang.String, java.lang.String)' has been added to an interface

512

org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroServiceAsync: Method 'public void getMacroDescriptor(java.lang.String, java.lang.String, java.lang.String, com.google.gwt.user.client.rpc.AsyncCallback)' has been added to an interface

513

org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroServiceAsync: Method 'public void getMacroDescriptors(java.lang.String, java.lang.String, com.google.gwt.user.client.rpc.AsyncCallback)' has been added to an interface

)))

* Young API. Add new methods to the Icon Set Module(((

518

519

org.xwiki.icon.IconManager: Method 'public java.util.List getIconNames()' has been added to an interface

520

org.xwiki.icon.IconManager: Method 'public java.util.List getIconNames(java.lang.String)' has been added to an interface

521

org.xwiki.icon.IconSetManager: Method 'public java.util.List getIconSetNames()' has been added to an interface

)))

* Young API. LESS refactoring.(((

526

527

org.xwiki.lesscss.LessCompilerScriptService: Method 'public boolean clearCacheFromFileSystemSkin(java.lang.String)' has been removed

528

org.xwiki.lesscss.LessCompilerScriptService: Return type of method 'public org.xwiki.lesscss.ColorTheme getColorThemeFromSkinFile(java.lang.String)' has been changed to org.xwiki.lesscss.colortheme.ColorTheme

529

org.xwiki.lesscss.LessCompilerScriptService: Return type of method 'public org.xwiki.lesscss.ColorTheme getColorThemeFromSkinFile(java.lang.String, java.lang.String)' has been changed to org.xwiki.lesscss.colortheme.ColorTheme

530

org.xwiki.lesscss.ColorTheme: Class org.xwiki.lesscss.ColorTheme removed

531

org.xwiki.lesscss.ColorThemeCache: Class org.xwiki.lesscss.ColorThemeCache removed

532

org.xwiki.lesscss.LESSCache: Class org.xwiki.lesscss.LESSCache removed

533

org.xwiki.lesscss.LESSColorThemeConverter: Class org.xwiki.lesscss.LESSColorThemeConverter removed

534

org.xwiki.lesscss.LESSCompiler: Class org.xwiki.lesscss.LESSCompiler removed

535

org.xwiki.lesscss.LESSCompilerException: Class org.xwiki.lesscss.LESSCompilerException removed

536

org.xwiki.lesscss.LESSSkinFileCache: Class org.xwiki.lesscss.LESSSkinFileCache removed

537

org.xwiki.lesscss.LESSSkinFileCompiler: Class org.xwiki.lesscss.LESSSkinFileCompiler removed

)))

* Young API. Lots of refactoring on the new Mail module(((

542

543

org.xwiki.mail.MailResultListener: Class org.xwiki.mail.MailResultListener removed

544

org.xwiki.mail.MailSender: Method 'public void send(javax.mail.internet.MimeMessage, javax.mail.Session)' has been removed

545

org.xwiki.mail.MailSender: Parameter 1 of 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has changed its type to java.lang.Iterable

546

org.xwiki.mail.MailSender: Parameter 3 of 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has changed its type to org.xwiki.mail.MailListener

547

org.xwiki.mail.MailSender: Return type of method 'public void sendAsynchronously(javax.mail.internet.MimeMessage, javax.mail.Session, org.xwiki.mail.MailResultListener)' has been changed to org.xwiki.mail.MailResult

548

org.xwiki.mail.MailSender: Method 'public void waitTillSent(long)' has been removed

549

org.xwiki.mail.MailSenderConfiguration: Method 'public java.util.List getBCCAddresses()' has been added to an interface

550

org.xwiki.mail.MailSenderConfiguration: Method 'public java.lang.String getScriptServicePermissionCheckerHint()' has been added to an interface

551

org.xwiki.mail.MailSenderConfiguration: Method 'public long getSendWaitTime()' has been added to an interface

552

org.xwiki.mail.script.MimeMessageWrapper: In method 'public MimeMessageWrapper(org.xwiki.mail.internal.ExtendedMimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' the number of arguments has changed

553

org.xwiki.mail.script.MimeMessageWrapper: Accessibility of method 'public MimeMessageWrapper(org.xwiki.mail.internal.ExtendedMimeMessage, javax.mail.Session, org.xwiki.mail.MailSender, org.xwiki.context.Execution, org.xwiki.component.manager.ComponentManager)' has been decreased from public to package

554

org.xwiki.mail.script.MimeMessageWrapper: Method 'public java.util.concurrent.BlockingQueue getErrors()' has been removed

555

org.xwiki.mail.script.MimeMessageWrapper: Method 'public void send()' has been removed

556

org.xwiki.mail.script.MimeMessageWrapper: Method 'public void sendAsynchronously()' has been removed

557

org.xwiki.mail.script.MimeMessageWrapper: Method 'public void waitTillSent(long)' has been removed

)))

* Switched to the generics-aware commons-collections4.(((

562

563

com.xpn.xwiki.monitor.api.MonitorPlugin: Return type of method 'public org.apache.commons.collections.buffer.CircularFifoBuffer getLastTimerData()' has been changed to org.apache.commons.collections4.queue.CircularFifoQueue

564

com.xpn.xwiki.monitor.api.MonitorPlugin: Return type of method 'public org.apache.commons.collections.buffer.CircularFifoBuffer getLastUnfinishedTimerData()' has been changed to org.apache.commons.collections4.queue.CircularFifoQueue

565

566

)))

Wiki source code of Release Notes for XWiki 6.4

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected