Version 9.1 by Ecaterina Moraru (Valica) on 2011/10/11

Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("ReleaseNotesXWikiEnterprise30M3")
3 {{/velocity}}
4
5 {{box cssClass="floatinginfobox" title="**Contents**"}}
6 {{toc/}}
7 {{/box}}
8
9 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:
10
11 * many **extension manager improvements**
12 * 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
13 * **user dashboards** giving each user the possibility to configure their own home page
14 * introduction of **wiki workspaces**, as a more collaborative way of managing an XWiki virtual farm
15 * improvements of **search results** scoring
16 * **storage improvements**, bringing in numerous performance and compatibility improvements
17 * conversion of the **panels application** to the XWiki 2.0+ syntax
18 * easier activation and configuration of **Google Analytics**
19
20 And on the developers' front:
21
22 * **CSRF prevention** enabled by default
23 * support for **DocBook syntax**
24 * ##xwiki-commons## and ##xwiki-rendering## are now [[**published on the central Maven2 repository**>>http://search.maven.org/#search%7Cga%7C1%7Corg.xwiki]]
25 * some major **code cleanup** due to the retirement of some very old plugins and the move of legacy/deprecated code into separate modules
26
27 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.
28
29 = New and Noteworthy (since XWiki Enterprise 3.1) =
30
31 == Extension Manager improvements ==
32
33 Progressing towards the completion of the extension manager, 3.2 adds support for:
34
35 * [[virtual extensions>>extensions:Extension.Extension Module Virtual Extensions]], or aliases for extensions that have changed their identifier
36 * automated 3-way merging of wiki documents, which brings update capabilities for XAR extensions
37 * better error reporting during installation, upgrade or removal of extensions
38 * [[XWiki repository>>extensions:Extension.Extension Module Repository]] REST protocol has been rewritten
39 * local extensions repository moved from ##~~/.xwiki## to container persisted directory
40 * display all the extensions metadatas when resolving it
41
42 == New implementation of the sheet system ==
43
44 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.
45
46 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.
47
48 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**.
49
50 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.
51
52 You can read more about this feature on the [[Sheet Module>>extensions:Extension.Sheet Module]] documentation page.
53
54 == User Dashboards ==
55
56 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.
57
58 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M2@userdashboard.png||class="screenshot"]]
59
60 == Wiki Workspaces ==
61
62 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.
63
64 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]].
65
66 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@create-workspace-entry.png||alt="Create workspace button" class="screenshot"]]
67 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@main-wiki-section-in-a-workspace.png||alt="Main wiki section displayed in top menu while in a workspace" class="screenshot"]]
68 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@workspace-administration-workspaceusers-section.png||alt="Workspace Users section in the workspace's administration section replacing 'Registration' and 'Users'" class="screenshot"]]
69 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32RC1@workspaceDirectory.png||alt="Workspace Directory listing available workspaces and available actions" class="screenshot"]]
70
71 The //Workspace Application// is not bundled by default with any XWiki product, but it can be installed as an extension.
72
73 == Improved search results scoring ==
74
75 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.
76
77 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M3@search.png||class="screenshot"]]
78
79 == Storage improvements ==
80
81 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.
82
83 == Converted the Panels application to the new XWiki syntax ==
84
85 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.
86
87 == Easier activation and configuration of Google Analytics ==
88
89 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.
90
91 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M3@analytics.png||style="border: 1px solid black;"]]
92
93 The new implementation also allows to define different tracking accounts for each wiki, and to use more than one tracking account per wiki.
94
95 = For Developers =
96
97 == CSRF prevention is enabled by default ==
98
99 [[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.
100
101 {{warning}}
102 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.
103 {{/warning}}
104
105 == New rendering features: DocBook syntax and ~{~{comment}} macro ==
106
107 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:
108
109 * 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
110 * 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
111 * the xwiki-rendering project can be integrated in a tool to convert wiki markup into DocBook content
112
113 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.
114
115 {{code language="none"}}
116 Visible text. {{comment}}This text won't be visible in the resulting HTML page{{/comment}} And this is visible again.
117 {{/code}}
118
119 == Improvements to the Suggestion and Spotlight Search widgets ==
120
121 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.
122
123 [[image:ReleaseNotes.ReleaseNotesXWikiEnterprise32M2@suggest.png||class="screenshot"]]
124
125 == New JavaScript testing framework ==
126
127 Unit tests for JavaScript code can now be written using the [[Jasmine framework>>http://pivotal.github.com/jasmine/]] for behavioral-driven development.
128
129 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]]:
130
131 {{code language="javascript"}}
132 describe("Suggest", function() {
133 describe("Emphasis Matcher", function() {
134 it("emphasizes a single match", function() {
135 var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Typed", "Value with Typed word");
136 expect("Value with <em>Typed</em> word").toEqual(result);
137 });
138
139 it("emphasizes several matches", function() {
140 var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Words Typed", "A Selection Of Words Been Typed");
141 expect("A Selection Of <em>Words</em> Been <em>Typed</em>").toEqual(result);
142 });
143
144 it("emphasizes repeated matches", function() {
145 var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("To Be", "To Be, Or Not To Be");
146 expect("<em>To</em> <em>Be</em>, Or Not <em>To</em> <em>Be</em>").toEqual(result);
147 });
148
149 it("preserves original case", function() {
150 var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("wOrDs TypEd By An eMo kID", "Words Typed By John Doe");
151 expect("<em>Words</em> <em>Typed</em> <em>By</em> John Doe").toEqual(result);
152 });
153
154 it("is neutral when there are no match", function() {
155 var result = XWiki.widgets.Suggest.prototype.emphasizeMatches("Rock'n'roll", "Bring me A bowl of coffee before I turn into a goat");
156 expect("Bring me A bowl of coffee before I turn into a goat").toEqual(result);
157 });
158 });
159 });
160 {{/code}}
161
162 == Named parameters for the event stream ==
163
164 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]].
165
166 == GPG signed artifacts ==
167
168 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.
169
170 To check the signatures, you should:
171
172 # Install GPG, if it's not already installed on your system
173 # Download both the artifact and its ##.asc## counterpart
174 # Run ##gpg ~-~-verify ~-~-keyserver-options auto-key-retrieve=true //artifact-file.jar.asc//##
175
176 == Official HTTPS support ==
177
178 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.
179
180 == ##xwiki-commons## and ##xwiki-rendering## published on the central maven repository ==
181
182 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.
183
184 == New location for storing persistent data ==
185
186 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.
187
188 {{warning}}
189 Read the [[migration notes below>>#HIssuesspecifictoXWikiEnterprise3.2]] for important details about migrating existing data into the new location.
190 {{/warning}}
191
192 == Deprecated and Retired projects ==
193
194 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:
195
196 * 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]]
197 * 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]]
198 * 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
199
200 Several very old and unmaintained projects have been retired as repositories in the [[xwiki-contrib organization on GitHub>>https://github.com/xwiki-contrib/]]:
201
202 * [[adwords plugin>>https://github.com/xwiki-contrib/plugin-adwords]]
203 * [[Albatross skin>>https://github.com/xwiki-contrib/skin-albatross]]
204 * [[alexa plugin>>https://github.com/xwiki-contrib/plugin-alexa]]
205 * [[calendar plugin and application>>https://github.com/xwiki-contrib/plugin-calendar]]
206 * [[exoplatform plugin>>https://github.com/xwiki-contrib/plugin-exoplatform]]
207 * [[photo album application>>https://github.com/xwiki-contrib/application-photoalbum]]
208 * [[S5 presentation application>>https://github.com/xwiki-contrib/application-s5]]
209 * [[workstream application>>https://github.com/xwiki-contrib/application-workstream]]
210
211 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]].
212
213 == Various ==
214
215 * [[XCOMMONS-14>>http://jira.xwiki.org/jira/browse/XCOMMONS-14]]: Added new XML manipulation methods to the ##XMLUtils## helper class.
216 * [[XCOMMONS-17>>http://jira.xwiki.org/jira/browse/XCOMMONS-17]]: Added a bridge that converts LogBack log events into observable events.
217 * [[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.
218 * [[XWIKI-6832>>http://jira.xwiki.org/browse/XWIKI-6832]]: Added support for OpenOffice 3.3.
219
220 == Upgrades ==
221
222 The following dependencies have been upgraded:
223
224 * Aether 1.13
225 * batik-rasterizer 1.7
226 * commons-configuration 1.7
227 * commons-lang 3.0.1
228 * Doxia 1.2
229 * Groovy 1.8.2
230 * Hibernate 3.6.7 Final (and related dependencies)
231 * hibernate-validator 4.2.0.Final
232 * HTML Cleaner 2.2
233 * Jetty 7.4.5
234 * JodConverter 3.0-beta-4-xwiki-20110822
235 * jruby 1.6.3
236 * Logback 0.9.30
237 * Lucene 3.4
238 * Reflections 0.9.5
239 * Selenium 2.7.0
240 * slf4j 1.6.2
241
242 == Miscellaneous ==
243
244 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.
245
246 == Translations ==
247
248 The following translations have been updated: ##de##, ##fr##, ##it##, ##lv##, ##nl##, ##ru##, ##sv##, ##zh##
249
250 = Supported Browsers =
251
252 Here's the list of supported browsers for this version (i.e. browsers that we've tested as working):
253
254 {{browser name="iexplorer" version="8"/}}
255
256 {{browser name="iexplorer" version="9"/}}
257
258 {{browser name="firefox" version="3.6.23"/}}
259
260 {{browser name="firefox" version="7.0"/}}
261
262 {{browser name="firefox" version="7.0.1"/}}
263
264 {{browser name="chrome" version="14"/}}
265
266 = Known issues =
267
268 * [[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]]
269
270 = Test Report =
271
272 You can check the [[manual test report>>TestReports.WebHome#HVersions3.2.x]] to learn about what was tested and the results on various browsers.
273
274 = Backward Compatibility and Migration Notes =
275
276 == General Notes ==
277
278 {{warning}}
279 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,...//.
280 {{/warning}}
281
282 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
283
284 {{warning}}
285 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.
286 {{/warning}}
287
288 == Issues specific to XWiki Enterprise 3.2 ==
289
290 * 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"##.
291 * 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.
292 * 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).
293 * 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.
294 * 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.
295 * See the backward compatibility and migration notes for the new implementation of the [[sheet system>>extensions:Extension.Sheet Module]].
296 * 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.
297
298 === Fixing applications broken by the CSRF prevention mechanism ===
299
300 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:
301
302 {{code language="none"}}
303 Inside forms:
304 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
305
306 Inside URLs:
307 $doc.getURL('action', "parameters=values&form_token=$!{services.csrf.getToken()}")
308 $xwiki.getURL('Some.Document', 'action', "parameters=values&form_token=$!{services.csrf.getToken()}")
309 {{/code}}
310
311 If you want to completely disable this feature, edit ##WEB-INF/xwiki.properties## and add ##csrf.enabled = false## at the end.
312
313 == API Breakages ==
314
315 The following xwiki-core APIs were modified since XWiki Enterprise 3.1:
316
317 {{code language="none"}}
318 org.xwiki.component.annotation.Requirement: Class org.xwiki.component.annotation.Requirement removed
319 org.xwiki.component.logging.AbstractLogEnabled: Class org.xwiki.component.logging.AbstractLogEnabled removed
320 org.xwiki.component.logging.Logger: Class org.xwiki.component.logging.Logger removed
321 org.xwiki.component.logging.VoidLogger: Class org.xwiki.component.logging.VoidLogger removed
322 org.xwiki.component.phase.LogEnabled: Class org.xwiki.component.phase.LogEnabled removed
323 org.xwiki.component.util.ReflectionUtils: Added final modifier to class
324 org.xwiki.component.util.ReflectionUtils: Accessibility of method 'public ReflectionUtils()' has been decreased from public to private
325 org.xwiki.component.logging.AbstractLogger: Class org.xwiki.component.logging.AbstractLogger removed
326 org.xwiki.component.logging.DefaultLogger: Class org.xwiki.component.logging.DefaultLogger removed
327 com.xpn.xwiki.plugin.activitystream.api.ActivityEvent: Method 'public java.util.Map getParameters()' has been added to an interface
328 com.xpn.xwiki.plugin.activitystream.api.ActivityEvent: Method 'public void setParameters(java.util.Map)' has been added to an interface
329 org.xwiki.bridge.AttachmentNameFactory: Class org.xwiki.bridge.AttachmentNameFactory removed
330 org.xwiki.bridge.AttachmentNameSerializer: Class org.xwiki.bridge.AttachmentNameSerializer removed
331 org.xwiki.bridge.DocumentAccessBridge: Method 'public int getObjectNumber(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.DocumentReference, java.lang.String, java.lang.String)' has been added to an interface
332 org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.Object getProperty(org.xwiki.model.reference.ObjectReference, java.lang.String)' has been added to an interface
333 org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.Object getProperty(org.xwiki.model.reference.ObjectPropertyReference)' has been added to an interface
334 org.xwiki.bridge.DocumentAccessBridge: Method 'public java.lang.Object getProperty(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.DocumentReference, int, java.lang.String)' has been added to an interface
335 org.xwiki.bridge.DocumentNameFactory: Class org.xwiki.bridge.DocumentNameFactory removed
336 org.xwiki.bridge.DocumentNameSerializer: Class org.xwiki.bridge.DocumentNameSerializer removed
337 org.xwiki.container.ApplicationContext: Method 'public java.io.File getPermanentDirectory()' has been added to an interface
338 org.xwiki.container.Request: Method 'public java.util.List getProperties(java.lang.String)' has been added to an interface
339 org.xwiki.container.portlet.PortletApplicationContext: In method 'public PortletApplicationContext(javax.portlet.PortletContext)' the number of arguments has changed
340 org.xwiki.container.servlet.ServletApplicationContext: In method 'public ServletApplicationContext(javax.servlet.ServletContext)' the number of arguments has changed
341 org.xwiki.eventstream.Event: Method 'public java.util.Map getParameters()' has been added to an interface
342 org.xwiki.eventstream.Event: Method 'public void setParameters(java.util.Map)' has been added to an interface
343 org.xwiki.gwt.dom.client.Style$IEFloatProperty: Class org.xwiki.gwt.dom.client.Style$IEFloatProperty removed
344 com.xpn.xwiki.api.Api: Method 'public boolean checkProgrammingRights()' has been removed
345 com.xpn.xwiki.api.Context: Method 'public boolean isVirtual()' has been removed
346 com.xpn.xwiki.api.Document: Method 'public com.xpn.xwiki.stats.impl.DocumentStats getCurrentMonthWebStats(java.lang.String)' has been removed
347 com.xpn.xwiki.api.StatsService: Method 'public com.xpn.xwiki.XWikiContext ajc$superDispatch$com_xpn_xwiki_api_StatsService$getXWikiContext()' has been removed
348 com.xpn.xwiki.api.StatsService: Method 'public com.xpn.xwiki.stats.impl.DocumentStats getCurrentMonthXWikiStats(java.lang.String)' has been removed
349 com.xpn.xwiki.api.StatsServiceCompatibilityAspect: Class com.xpn.xwiki.api.StatsServiceCompatibilityAspect removed
350 com.xpn.xwiki.api.XWiki: Removed field ajc$interField$com_xpn_xwiki_api_XWikiCompatibilityAspect$util
351 com.xpn.xwiki.api.XWiki: Method 'public int add(int, int)' has been removed
352 com.xpn.xwiki.api.XWiki: Method 'public long add(long, long)' has been removed
353 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String add(java.lang.String, java.lang.String)' has been removed
354 com.xpn.xwiki.api.XWiki: Method 'public com.xpn.xwiki.XWiki ajc$privFieldGet$com_xpn_xwiki_api_XWikiCompatibilityAspect$com_xpn_xwiki_api_XWiki$xwiki(com.xpn.xwiki.api.XWiki)' has been removed
355 com.xpn.xwiki.api.XWiki: Method 'public void ajc$privFieldSet$com_xpn_xwiki_api_XWikiCompatibilityAspect$com_xpn_xwiki_api_XWiki$xwiki(com.xpn.xwiki.api.XWiki, com.xpn.xwiki.XWiki)' has been removed
356 com.xpn.xwiki.api.XWiki: Method 'public com.xpn.xwiki.XWikiContext ajc$superDispatch$com_xpn_xwiki_api_XWiki$getXWikiContext()' has been removed
357 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String clearAccents(java.lang.String)' has been removed
358 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String clearName(java.lang.String)' has been removed
359 com.xpn.xwiki.api.XWiki: Method 'public int copyWikiWeb(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)' has been removed
360 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String escapeText(java.lang.String)' has been removed
361 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String escapeURL(java.lang.String)' has been removed
362 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String generateRandomString(int)' has been removed
363 com.xpn.xwiki.api.XWiki: Method 'public java.util.List getArrayList()' has been removed
364 com.xpn.xwiki.api.XWiki: Method 'public java.util.Date getCurrentDate()' has been removed
365 com.xpn.xwiki.api.XWiki: Method 'public java.util.Date getDate()' has been removed
366 com.xpn.xwiki.api.XWiki: Method 'public java.util.Date getDate(long)' has been removed
367 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getDocLanguagePreference()' has been removed
368 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getFormEncoded(java.lang.String)' has been removed
369 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getHTMLArea(java.lang.String)' has been removed
370 com.xpn.xwiki.api.XWiki: Method 'public java.util.Map getHashMap()' has been removed
371 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getMessage(java.lang.String)' has been removed
372 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getNl()' has been removed
373 com.xpn.xwiki.api.XWiki: Method 'public com.xpn.xwiki.api.Object getNull()' has been removed
374 com.xpn.xwiki.api.XWiki: Method 'public java.util.Collection getRecentActions(java.lang.String, int)' has been removed
375 com.xpn.xwiki.api.XWiki: Method 'public int getTimeDelta(long)' has been removed
376 com.xpn.xwiki.api.XWiki: Method 'public java.util.Map getTreeMap()' has been removed
377 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getURLEncoded(java.lang.String)' has been removed
378 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getWebCopyright()' has been removed
379 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getWebPreference(java.lang.String)' has been removed
380 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getWebPreference(java.lang.String, java.lang.String)' has been removed
381 com.xpn.xwiki.api.XWiki: Method 'public int getWebPreferenceAsInt(java.lang.String)' has been removed
382 com.xpn.xwiki.api.XWiki: Method 'public int getWebPreferenceAsInt(java.lang.String, int)' has been removed
383 com.xpn.xwiki.api.XWiki: Method 'public long getWebPreferenceAsLong(java.lang.String)' has been removed
384 com.xpn.xwiki.api.XWiki: Method 'public long getWebPreferenceAsLong(java.lang.String, long)' has been removed
385 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getWebPreferenceFor(java.lang.String, java.lang.String)' has been removed
386 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getWebPreferenceFor(java.lang.String, java.lang.String, java.lang.String)' has been removed
387 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String getXMLEncoded(java.lang.String)' has been removed
388 com.xpn.xwiki.api.XWiki: Method 'public boolean isVirtual()' has been removed
389 com.xpn.xwiki.api.XWiki: Method 'public void outputImage(java.awt.image.BufferedImage)' has been removed
390 com.xpn.xwiki.api.XWiki: Method 'public double parseDouble(java.lang.String)' has been removed
391 com.xpn.xwiki.api.XWiki: Method 'public float parseFloat(java.lang.String)' has been removed
392 com.xpn.xwiki.api.XWiki: Method 'public int parseInt(java.lang.String)' has been removed
393 com.xpn.xwiki.api.XWiki: Method 'public java.lang.Integer parseInteger(java.lang.String)' has been removed
394 com.xpn.xwiki.api.XWiki: Method 'public long parseLong(java.lang.String)' has been removed
395 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String parseMessage()' has been removed
396 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String parseMessage(java.lang.String)' has been removed
397 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String printStrackTrace(java.lang.Throwable)' has been removed
398 com.xpn.xwiki.api.XWiki: Method 'public void sendMessage(java.lang.String, java.lang.String, java.lang.String)' has been removed
399 com.xpn.xwiki.api.XWiki: Method 'public void sendMessage(java.lang.String, java.lang.String[], java.lang.String)' has been removed
400 com.xpn.xwiki.api.XWiki: Method 'public java.util.List sort(java.util.List)' has been removed
401 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String[] split(java.lang.String, java.lang.String)' has been removed
402 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String sqlfilter(java.lang.String)' has been removed
403 com.xpn.xwiki.api.XWiki: Method 'public java.lang.Number toNumber(com.xpn.xwiki.api.Object)' has been removed
404 com.xpn.xwiki.api.XWikiCompatibilityAspect: Class com.xpn.xwiki.api.XWikiCompatibilityAspect removed
405 com.xpn.xwiki.cache.api.XWikiCache: Class com.xpn.xwiki.cache.api.XWikiCache removed
406 com.xpn.xwiki.cache.api.XWikiCacheNeedsRefreshException: Class com.xpn.xwiki.cache.api.XWikiCacheNeedsRefreshException removed
407 com.xpn.xwiki.cache.api.XWikiCacheService: Class com.xpn.xwiki.cache.api.XWikiCacheService removed
408 com.xpn.xwiki.user.api.XWikiRightService: Method 'public boolean hasWikiAdminRights(com.xpn.xwiki.XWikiContext)' has been added to an interface
409 compatibility.com.xpn.xwiki.api.ApiCompatibilityAspect: Class compatibility.com.xpn.xwiki.api.ApiCompatibilityAspect removed
410 compatibility.com.xpn.xwiki.api.ContextCompatibilityAspect: Class compatibility.com.xpn.xwiki.api.ContextCompatibilityAspect removed
411 compatibility.com.xpn.xwiki.api.DocumentCompatibilityAspect: Class compatibility.com.xpn.xwiki.api.DocumentCompatibilityAspect removed
412 com.xpn.xwiki.plugin.lucene.IndexRebuilder: Method 'protected int addTranslationsOfDocument(com.xpn.xwiki.doc.XWikiDocument, com.xpn.xwiki.XWikiContext)' has been removed
413 com.xpn.xwiki.plugin.lucene.SearchResults: In method 'public SearchResults(org.apache.lucene.search.Hits, com.xpn.xwiki.api.XWiki, com.xpn.xwiki.XWikiContext)' the number of arguments has changed
414 com.xpn.xwiki.plugin.lucene.SearchResults: Accessibility of method 'public SearchResults(org.apache.lucene.search.Hits, com.xpn.xwiki.api.XWiki, com.xpn.xwiki.XWikiContext)' has been decreased from public to package
415 com.xpn.xwiki.plugin.tag.TagPlugin: Removed field LOG
416 com.xpn.xwiki.plugin.globalsearch.GlobalSearchPlugin: Removed field LOG
417 com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi: Removed field LOG
418 com.xpn.xwiki.plugin.wikimanager.WikiManager: Removed field LOG
419 com.xpn.xwiki.plugin.wikimanager.WikiManager: Method 'public void importPackage(java.lang.String, java.lang.String, com.xpn.xwiki.XWikiContext)' has been removed
420 com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin: Removed field LOG
421 com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi: Removed field LOG
422 com.xpn.xwiki.plugin.wikimanager.doc.Wiki: Removed field LOG
423 org.xwiki.gwt.wysiwyg.client.plugin.submit.IESubmitPlugin: Class org.xwiki.gwt.wysiwyg.client.plugin.submit.IESubmitPlugin removed
424 {{/code}}

Get Connected