Version 19.2 by Sorin Burjan on 2012/06/19

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 {{error}}
6 A bug making impossible to install a XAR extension containing an attachment has been found in this version and is fixed in [[4.1.1>>ReleaseNotesXWikiEnterprise411]].
7 {{/error}}
8
9 This is the second release of the 4.x cycle ([[Roadmap>>Main.Roadmap]]). This release brings Extension Manager improvements such as merging of configuration documents during extension upgrade, a more gentle learning curve by hiding internal documents from non-technical users, and lots of goodies for the developers such as easy sharing of variables between scripts in different languages.
10
11 = New and Noteworthy (since XWiki Enterprise 4.0 version) =
12
13 Here are notable new features and improvements. For the full list of issues (including statistics) see the [[JIRA Dashboard>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11090]].
14
15 == Improvements to the Extension Manager ==
16
17 The speed and reliability of the [[Extension Repository>>extensions:Extension.Extension Repository Application]] has been improved considerably. For example the [[XWiki.org Extension Repository>>extensions:Extension.WebHome]] is now much faster when you access it from XWiki Enterprise and you should now be able to browse and install extensions in no time.
18
19 Upgrading applications with related configuration documents is now handled using the merge conflict resolution UI. Changes are displayed as if you were comparing versions from a document's history.
20
21 {{image reference="EM-mergeConflict.png"/}}
22
23 If extension installation fails, the error message is extracted from the logs and displayed. You can view the full stack trace by clicking on the error message.
24
25 (in the image below the job of computing the install plan fails)
26
27 image:EM-extensionLog.png
28
29 The install and uninstall plans display extensions like in the dependency section. This way you can follow the link of an extension to find out more about what is going to be installed.
30
31 image:EM-uninstallPlan.png
32
33 The install and uninstall process is now completely asynchronous. You can see below how the progress is indicated.
34
35 image:EM-asyncInstall.png
36
37 See the [[Extension Manager Application documentation>>doc:extensions:Extension.Extension Manager Application]] for more details.
38
39 == Hide technical documents from non-technical users ==
40
41 * Users who do not opt to see hidden documents do not see them on panels or in search results.
42 * For advanced users, it is now possible to specify that a document should be hidden when editing the document (only //wiki// or //wysiwyg// edit modes):(((
43 [[image:HideDocument.png||style="border:1px solid silver" width="240px"]]
44
45 And now there's a new setting in the user profiles, letting users choose whether they want hidden documents to appear in search results and panels:
46
47 [[image:ShowHiddenDocuments.png||style="border:1px solid silver" width="300px"]]
48
49 * If the user doesn't set explicitly the Hidden setting value in his profile, he won't see hidden documents by default. Thus seeing hidden documents is an explicit choice.
50 )))
51
52
53 == New types of charts ==
54
55 We've [[added 2 new types of charts>>extensions:Extension.Chart Macro]], **bar3D** and **line3D**, which draw 3D charts.
56
57 For example the following code:
58
59 {{code}}
60 {{chart type='bar3D' source='inline' params='range:B2-B9;series:columns'}}
61 |=Date|=Value
62 |2012-02-21|1.97
63 |2012-02-26|2.96
64 |2012-03-04|3.93
65 |2012-03-11|4.84
66 |2012-03-18|5.83
67 |2012-03-25|4.5
68 |2012-04-01|3.85
69 |2012-04-08|4.87
70 {{/chart}}
71 {{/code}}
72
73 Will be rendered as this:
74
75 [[image:chart-example.png]]
76
77
78 It's now possible to select [[custom colors in Chart graphs>>extensions:Extension.Chart Macro]]. For example:
79
80 {{code}}
81 {{chart type="pie" source="inline" params="range:B2-D5;series:columns;colors:C3E3F7,1D9FF5,015891,012A45" title="Chart Test" width="320" height="240"}}
82 | |X |Y |Z
83 |Q1|1.2|3.4|1.3
84 |Q2|4.5|3.4|2.3
85 |Q3|1.2|4.5|9.0
86 |Q4|3.4|1.2|1.2
87 {{/chart}}
88 {{/code}}
89
90 Will generate:
91
92 {{image reference="extensions:Extension.Chart Macro@customcolors.png"/}}
93
94
95 == New macro for sending messages ==
96
97 Whereas the Activity Stream allows users to send a message as well as observing messages and activities of other users, this macro allows the explicit message sending functionality to be duplicated in other places without including the activity stream as well.
98
99 The code:
100
101 {{code language="none"}}
102 {{messageSender /}}
103 {{/code}}
104
105 Produces the following:
106
107 {{image reference="messageSenderMacro.png"/}}
108
109 == Danish Translation ==
110
111 [[image:Denmark.png||width=50px]] XWiki Enterprise is now available in the Danish language.
112
113 == Global and per-user timezone setting ==
114
115 Wiki administrators can now use a specific timezone regardless of the clock configuration on the wiki server. The following setting can be found under **Administration > Localization**.
116 Users will find the same setting, allowing them to see dates reflecting their current location. The user setting is accessible through **Profile > Preferences > Localization Preferences**.
117
118 {{image reference="timezone.jpg"/}}
119
120
121 = For developers =
122
123 * New rendering [[Compatibility Test Suite>>rendering:Main.CompatibilityTestSuite]] to make testing easier and simplify implementation of new syntax Parsers and Renderers. You can checkout the [[Compatibility report>>rendering:Main.SyntaxReport]] for all the syntaxes that are supported out of the box by XWiki.
124
125 * New diff/merge module has been added to make easier to deal with diff and merge both from component and scripts. See [[Diff module >>extensions:Extension.Diff Module]] for details.
126
127 == Easy variable sharing between scripts ==
128 It's now much easier to share variable between languages.
129 You can now create a variable in a Groovy script and use it in a Velocity script.
130
131 For example:(((
132 {{code language="none"}}
133 {{python}}
134 a = "This"
135 {{/python}}
136
137 {{groovy}}
138 b = "changes";
139 {{/groovy}}
140
141 {{velocity}}
142 $a $b everything.
143 {{/velocity}}
144 {{/code}}
145 )))
146
147 == Script access to Component Manager ==
148 With the [[new Component Access Script Service>>platform:DevGuide.Scripting||anchor="HXWikiComponentAccess"]] privileged scripts can now easily load components from the Component Manager (XWiki's dependency injection system). This is not available in Velocity because of it's limited capability to load classes.
149
150 For example:(((
151 {{code}}
152 {{groovy}}
153 def myComponent = services.component.getInstance(MyComponentRole.class)
154 {{/groovy}}
155 {{/code}}
156 )))
157
158 == Velocity interprets Strings in function calls ==
159 With the [[new Velocity uberspector>>doc:extensions:Extension.Velocity Module||anchor="HMethodArgumentsUberspector"]], Velocity will convert method arguments in string form to formal parameter types when the passed arguments don't match the method signature.
160
161 For example:(((
162 {{code}}
163 $obj.someMethod('VALUE')
164 // will forward to
165 obj.someMethod(SomeEnum.VALUE)
166 // if obj has a method with signature someMethod(SomeEnum) and not someMethod(String)
167 {{/code}}
168
169 But this is not limited to enums. The conversion is done using the [[Properties Module>>doc:extensions:Extension.Properties Module]] which means you can create and register custom converters for data types specific to your application domain.
170 )))
171
172
173 == Taming of Groovy scripts ==
174
175 Since traditionally, Groovy scripts can enter into unstoppable infinite loops, use reflection to violate security assumptions, access server resources, or even crash the virtual machine, they have been off limits to non-administrators.
176
177 In a bid to open up new scripting options to less permitted users (especially in wiki farms where getting Programming Rights is a problem since it means having those rights on the whole farm), steps have been taken to make Groovy safer.
178
179 Groovy scripts are now technically allowed to users having simple Edit rights but the Groovy Sandbox is currently very restrictive (said differently, you cannot do anything useful with it at the moment! :)). Now that we have the mechanism in place our plan is to slowly open up allowed operations.
180
181 To enable and test this feature read the document for both the [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]] and the [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]].
182
183 === Compilation customizers ===
184
185 Customizers can be registered to alter the Groovy script as it is compiled such as filtering System.exit() calls and adding timeout checks to loops to prevent infinite looping. Learn more: http://www.jroller.com/melix/entry/upcoming_groovy_goodness_automatic_thread
186
187 === Stop run-away scripts after a configurable timeout ===
188
189 You can now configure your wiki to stop Groovy scripts after a configurable amount of run time. For example if you wish to have a timeout of 10 seconds for your XWiki runtime, you'd configure xwiki's ##xwiki.properties## with:
190
191 {{code language="none"}}
192 groovy.compilationCustomizers=timedinterrupt
193 groovy.customizer.timedInterrupt.timeout=10
194 {{/code}}
195
196 == Shorthand HQL queries in the Query Manager ==
197
198 When you send a search query to the Query Manager such as {{code language="none"}}where doc.creationDate > '2008-01-01'{{/code}} It is now assumed that you meant:
199
200 {{code language="none"}}
201 select doc.fullName from XWikiDocument as doc where doc.creationDate > '2008-01-01'
202 {{/code}}
203
204 == Bug fixes and improvements ==
205
206 * Filenames of entries in XAR files are now [[always decoded using UTF-8 during import>>http://jira.xwiki.org/browse/XWIKI-6863]]. The previous behavior was to use the platform encoding. The filenames have always been encoded using UTF-8 in XAR files, but now also the Unicode extra fields are included, so unpacking XAR files with InfoZIP will result in the filenames beeing properly reencoded with the local filesystems character set.
207 * Temporary files are now placed in a special sub-directory of the normal temporary directory, this sub-directory called "xwiki-temp" is deleted after each startup of the xwiki system so it is critical that nothing else it placed in it. This improvement means that temporary files such as cached attachments will be removed even if the JVM crashes.
208 * Fixed wrong calculation of IDs for stats values making it impossible to upgrade a wiki to version 4.0 if statistics collection is enabled.
209 * Faster first startup time by not running a database migration when it is not needed.
210 * Simplify reverse proxy setup by making all HTTP redirects use relitive URLs.
211 * Add support for bold, italic and monospace in the TeX Renderer
212 * Was impossible to delete then recreate a subwiki with the same name, fixed.
213 * Fixed Javascript error when scrolling over Search Suggest results in Internet Explorer 6.
214 * Trying to change a document's parent from the REST service resulted in an error, fixed.
215 * It is now possible for non-administrators to execute cross-wiki XWQL queries.
216 * Move ComponentManager deprecated methods to Legacy modules
217 * New Groovy module in xwiki-commons
218 * Add legacy module structure for XWiki Rendering
219 * Have one Maven module per XWiki Rendering syntax
220 * Separate Event Syntax from Rendering API by moving it to a Syntax module
221 * Plain syntax and Event syntax have been moved out of Rendering API nto their own modules.
222 * [[XWIKI-7913>>http://jira.xwiki.org/browse/XWIKI-7913]] Could not register a Javascript or CSS skin extension for the whole wiki.
223
224
225 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%2C+XEM%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+%28fixVersion+%3D+%224.1-milestone-1%22+%7C%7C+fixVersion+%3D+%224.1-milestone-2%22+%7C%7C+fixVersion+%3D+%224.1-rc-1%22+%7C%7C+fixVersion+%3D+%224.1%22%29&tempMax=1000]] fixed in the 4.1 release cycle.
226
227
228 == Upgrades ==
229
230 The following dependencies have been upgraded since XWiki Enterprise 4.0
231
232 === Upgraded in XWiki Enterprise Milestone 1 ===
233
234 * Tika 1.1
235 * JGroups 3.0.10
236 * Pygments 1.5
237 * Selenium 2.21
238 * Maven AspectJ Plugin 1.4
239 * commons-io 2.3
240 * Maven Shade plugin 1.6
241
242 === Upgraded in XWiki Enterprise Milestone 2 ===
243
244 * Restlet 2.0.14
245 ** Prior to Restlet 2.0.14, there was a REST bug allowing arbitrary filesystem read access for registered users.
246 * Reflections 0.9.7
247
248 = Tested Browsers =
249
250 Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of [[supported browsers>>dev:Community.BrowserSupportStrategy]]):
251
252 {{browser name="firefox" version="13"/}}
253
254 {{browser name="chrome" version="17"/}}
255
256 {{browser name="iexplorer" version="8"/}}
257
258 {{browser name="iexplorer" version="9"/}}
259
260
261 = Tested Databases =
262
263 {{database name="hsqldb" version="2.2.8"/}}
264
265 {{database name="mysql" version="5.x"/}}
266
267 {{database name='oracle' version= '11.x'/}}
268
269 {{database name='postgresql' version= '9.x'/}}
270
271
272 = Known issues =
273
274 * [[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]]
275
276 = Test Report =
277
278 You can check the [[manual test report>>TestReports.ManualTestReportXE41]] to learn about what was tested and the results on various browsers.
279
280 = Backward Compatibility and Migration Notes =
281
282 == General Notes ==
283
284 {{info}}
285 If you're running in a multiwiki setup you'll also need to define the property //xwiki.store.migration.databases// in your //xwiki.cfg// file if you want to explicitly name some databases to be migrated as the default is now to migrate all databases. Database that are not migrated could not be accessed.
286 {{/info}}
287
288 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
289
290 {{warning}}
291 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.
292 {{/warning}}
293
294 == Issues specific to XWiki Enterprise 4.1 ==
295
296 The old experimental real-time synchronization plugin for the WYSIWYG content editor has been retired. We hope that its functionality will be replaced by the real-time editing feature developed on the [[Wiki 3.0>>https://github.com/xwiki-contrib/wiki30]] project. If you want to continue using the old plugin you need to:
297
298 * take the code from [[##xwiki-contrib/retired## GitHub repo>>https://github.com/xwiki-contrib/retired/tree/master/xwiki-platform-wysiwyg-plugin-sync]]
299 * add the client and server side as dependencies to the WYSIWYG client and server side respectively
300 * modify ##WysiwygEditorFactory## to register the factory of the sync plugin
301 * rebuild the editor and update the jars and client side resources on your XWiki Enterprise instance
302
303 == API Breakages ==
304
305 The following APIs were modified since version 4.0:
306
307 * Breakage in Query module done to support adding several Filters to a Query:(((
308 {{code language="none"}}
309 org.xwiki.query.QueryFilter: Method 'public java.util.List filterResults(java.util.List)' has been added to an interface
310 {{/code}}
311 )))
312 * This method should have been internal from the beginning:(((
313 {{code language="none"}}
314 org.xwiki.environment.EnvironmentConfiguration: Class org.xwiki.environment.EnvironmentConfiguration removed
315 {{/code}}
316 )))
317 * The Job module is new and is still considered a "young API":(((
318 {{code language="none"}}
319 org.xwiki.job.AbstractJob: Changed type of field status from org.xwiki.job.internal.DefaultJobStatus to org.xwiki.job.internal.AbstractJobStatus
320 org.xwiki.job.AbstractJob: Return type of method 'protected org.xwiki.job.internal.DefaultJobStatus createNewStatus(org.xwiki.job.Request)' has been changed to org.xwiki.job.internal.AbstractJobStatus
321 org.xwiki.job.AbstractJob: Method 'protected java.lang.String getId()' has been removed
322 org.xwiki.job.AbstractRequest: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
323 org.xwiki.job.Job: Method 'public void join()' has been added to an interface
324 org.xwiki.job.Job: Method 'public boolean join(long, java.util.concurrent.TimeUnit)' has been added to an interface
325 org.xwiki.job.JobManager: Method 'public org.xwiki.job.event.status.JobStatus getJobStatus(java.util.List)' has been added to an interface
326 org.xwiki.job.Request: Return type of method 'public java.lang.String getId()' has been changed to java.util.List
327 org.xwiki.job.event.JobEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
328 org.xwiki.job.event.JobFinishedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
329 org.xwiki.job.event.JobStartedEvent: Return type of method 'public java.lang.String getJobId()' has been changed to java.util.List
330 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getEndDate()' has been added to an interface
331 org.xwiki.job.event.status.JobStatus: Method 'public java.util.Date getStartDate()' has been added to an interface
332 {{/code}}
333 )))
334 * The Extension module is relatively new and is still undergoing some API tuning:(((
335 {{code language="none"}}
336 org.xwiki.extension.job.plan.ExtensionPlan: Return type of method 'public java.util.Collection getTree()' has been changed to org.xwiki.extension.job.plan.ExtensionPlanTree
337 org.xwiki.extension.version.VersionConstraint: Method 'public boolean isCompatible(org.xwiki.extension.version.Version)' has been added to an interface
338 {{/code}}
339 )))
340 * This class was added in 3.2M2 by error in a user-public package. It's been moved again in the internal package as it should have been. We don't expect many users to be affected by this:(((
341 {{code language="none"}}
342 com.xpn.xwiki.doc.merge.MergeUtils: Class com.xpn.xwiki.doc.merge.MergeUtils removed
343 {{/code}}
344 )))
345 * In 2.2M1 we refactored BaseCollection to add getXClass() but we forgot to add it to the ObjectInterface interface. Even though this could break user we think it's very limited since nobody should implement directly ObjectInterface; instead everyone should extend BaseClass or BaseCollection:(((
346 {{code language="none"}}
347 com.xpn.xwiki.objects.ObjectInterface: Method 'public com.xpn.xwiki.objects.classes.BaseClass getXClass(com.xpn.xwiki.XWikiContext)' has been added to an interface
348 {{/code}}
349 )))
350 * The Autotag plugin has been extracted from the oldcore module and is now a module on its own so the following are not real breakages:(((
351 {{code language="none"}}
352 com.xpn.xwiki.plugin.autotag.AutoTagPlugin: Class com.xpn.xwiki.plugin.autotag.AutoTagPlugin removed
353 com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI: Class com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI removed
354 com.xpn.xwiki.plugin.autotag.FrenchStemmer: Class com.xpn.xwiki.plugin.autotag.FrenchStemmer removed
355 com.xpn.xwiki.plugin.autotag.Tag: Class com.xpn.xwiki.plugin.autotag.Tag removed
356 com.xpn.xwiki.plugin.autotag.TagCloud: Class com.xpn.xwiki.plugin.autotag.TagCloud removed
357 {{/code}}
358 )))
359 * The WYSIWYG Diff and Sync plugins have been extracted into their own modules so the following are not real breakages:(((
360 {{code language="none"}}
361 org.xwiki.gwt.wysiwyg.client.Images: Method 'public com.google.gwt.resources.client.ImageResource sync()' has been removed
362 org.xwiki.gwt.wysiwyg.client.Strings: Method 'public java.lang.String sync()' has been removed
363 org.xwiki.gwt.wysiwyg.client.diff.AddDelta: Class org.xwiki.gwt.wysiwyg.client.diff.AddDelta removed
364 org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta: Class org.xwiki.gwt.wysiwyg.client.diff.ChangeDelta removed
365 org.xwiki.gwt.wysiwyg.client.diff.Chunk: Class org.xwiki.gwt.wysiwyg.client.diff.Chunk removed
366 org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta: Class org.xwiki.gwt.wysiwyg.client.diff.DeleteDelta removed
367 org.xwiki.gwt.wysiwyg.client.diff.Delta: Class org.xwiki.gwt.wysiwyg.client.diff.Delta removed
368 org.xwiki.gwt.wysiwyg.client.diff.Diff: Class org.xwiki.gwt.wysiwyg.client.diff.Diff removed
369 org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm: Class org.xwiki.gwt.wysiwyg.client.diff.DiffAlgorithm removed
370 org.xwiki.gwt.wysiwyg.client.diff.DiffException: Class org.xwiki.gwt.wysiwyg.client.diff.DiffException removed
371 org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.DifferentiationFailedException removed
372 org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException: Class org.xwiki.gwt.wysiwyg.client.diff.PatchFailedException removed
373 org.xwiki.gwt.wysiwyg.client.diff.Revision: Class org.xwiki.gwt.wysiwyg.client.diff.Revision removed
374 org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor: Class org.xwiki.gwt.wysiwyg.client.diff.RevisionVisitor removed
375 org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff: Class org.xwiki.gwt.wysiwyg.client.diff.SimpleDiff removed
376 org.xwiki.gwt.wysiwyg.client.diff.ToString: Class org.xwiki.gwt.wysiwyg.client.diff.ToString removed
377 org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.DiffNode removed
378 org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff: Class org.xwiki.gwt.wysiwyg.client.diff.myers.MyersDiff removed
379 org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode: Class org.xwiki.gwt.wysiwyg.client.diff.myers.PathNode removed
380 org.xwiki.gwt.wysiwyg.client.diff.myers.Snake: Class org.xwiki.gwt.wysiwyg.client.diff.myers.Snake removed
381 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPlugin removed
382 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncPluginFactory removed
383 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncResult removed
384 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncService removed
385 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncServiceAsync removed
386 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncStatus removed
387 org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools: Class org.xwiki.gwt.wysiwyg.client.plugin.sync.SyncTools removed
388 org.xwiki.wysiwyg.server.plugin.sync.SyncEngine: Class org.xwiki.wysiwyg.server.plugin.sync.SyncEngine removed
389 org.xwiki.wysiwyg.server.plugin.sync.SyncException: Class org.xwiki.wysiwyg.server.plugin.sync.SyncException removed
390 {{/code}}
391 )))

Get Connected