Wiki source code of Release Notes for XWiki 5.0 Milestone 2
Version 33.1 by Thomas Mortagne on 2013/04/03
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version. | ||
| 6 | |||
| 7 | This version contain some very important changes like the new security module by default, XWiki is now always in virtual mode, JQuery is embedded by default, xwiki/1.0 syntax is now disabled and lots of other improvements. | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki 5.0 Milestone 1) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 5.0>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11493]]. | ||
| 12 | |||
| 13 | == New security authorization module replace the old RightService == | ||
| 14 | |||
| 15 | With this new module, we bring the following improvements: | ||
| 16 | |||
| 17 | * More efficient and performant authorization management thanks to a smart access rules and decision cache. | ||
| 18 | * More generic and consistant right policy based on declarative definition of rights. | ||
| 19 | * Extensible solution, allowing registration of new rights. | ||
| 20 | * Customizable thanks to pluggable authentication settlers using configuration. | ||
| 21 | |||
| 22 | Read the [[full documentation of this module>>extensions:Extension.Security Module]] for complete details. | ||
| 23 | |||
| 24 | {{warning}}With this new module, the access policies also evolve and this introduce some major changes that you should consider if you are migrating an existing installation. Please read those changes in the migration chapter below.{{/warning}} | ||
| 25 | |||
| 26 | == Automatic Paste Cleaning in WYSIWYG Editor == | ||
| 27 | |||
| 28 | Starting with this version, whenever you paste some content into the rich text area of the WYSIWYG Editor that content is (by default) automatically cleaned before being inserted into the rest of the content. | ||
| 29 | |||
| 30 | You can disable the automatic cleaning from the WYSIWYG Editor administration section if you wish: | ||
| 31 | |||
| 32 | {{image reference="WYSIWYGEditor-AdminSection-cleanPasteAutomatically.png"/}} | ||
| 33 | |||
| 34 | == Virtual mode is always enabled == | ||
| 35 | |||
| 36 | Virtual mode and ##multiwiki## is now part of XWiki's model and can no longer be disabled. What this means is that the difference between the 2 main products ([[XE>>enterprise:Main.WebHome]] and [[XEM>>manager:Main.WebHome]]) is getting smaller and smaller. | ||
| 37 | |||
| 38 | In the past, XEM differed from XE by the fact that it allowed the creation of multiple wikis (called subwikis) because it had the property ##xwiki.virtual=1## by default in xwiki.cfg, where as XE had ##xwiki.virtual=0## by default. Coupled with the [[extensions:Extension.Wiki Manager Application]] and the [[extensions:Extension.Workspace Application]] which were bundled by default, this allowed XEM to create and manage subwikis, while XE could not. This was causing confusion to users that had installed one product and later on, found out that they needed the other. | ||
| 39 | |||
| 40 | To avoid confusion and to simplify our development as well, we have defaulted to a virtual mode enabled by default, allowing you to create and manage subwikis/workspaces no matter what product you have downloaded. For instance, if you have downloaded XE, you now only have to install one or two extensions ([[extensions:Extension.Wiki Manager Application]] and/or [[extensions:Extension.Workspace Application]]) using the extension manager and you are all set. Most likely we will also switch to a single product scheme in the future. | ||
| 41 | |||
| 42 | == Replace "xwiki.virtual.redirect" with an error template(or page) == | ||
| 43 | |||
| 44 | This xwiki.cfg setting allowed the admin to redirect to a specified URL an user that tried to access an nonexistent wiki. However, it was enabled by default and the default value was ##http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist ## which was definitely wrong and was causing more problems than it solved. See {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-479{{/jira}} for an example. | ||
| 45 | |||
| 46 | We have decided to drop this feature and replace it with an error template ##wikidoesnotexist.vm## that can be overridden by a document in the main wiki named ##XWiki.WikiDoesNotExist##, to be consistent with what we are doing for other XWiki entities (documents, attachments, etc). | ||
| 47 | |||
| 48 | However, to avoid hitting problems with accessing your main wiki, this feature is disabled by default and can be enabled by uncommenting ##xwiki.virtual.failOnWikiDoesNotExist## in ##xwiki.cfg## and setting its value to ##1##. Otherwise, by default, the user will always get server the content of the main wiki if the wiki he requested is not found. | ||
| 49 | |||
| 50 | For those that want to achieve the same behavior as before (by redirecting to a fixed URL every time), they have to enable ##xwiki.virtual.failOnWikiDoesNotExist## in ##xwiki.cfg## and then redirect to the desired URL either in ##wikidoesnotexist.vm## or in the main wiki's ##XWiki.WikiDoesNotExist##. | ||
| 51 | |||
| 52 | == Miscellaneous == | ||
| 53 | |||
| 54 | - ##autowww## is not enabled by default {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8877{{/jira}} and mandatory (can not be disabled), since with virtual mode enabled by default if could prove problematic to access your main wiki without a proper wiki descriptor set up. The main reason why you could have needed to disable it was if you actually had subwiki named ##www## and you wanted to access it instead of the main wiki. Now the ##autowww## feature checks for this case and serves the right content. | ||
| 55 | |||
| 56 | 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+fixVersion+%3D+%225.0-milestone-2%22&tempMax=1000]] fixed in this release. | ||
| 57 | |||
| 58 | = For Developers = | ||
| 59 | |||
| 60 | == Translate log == | ||
| 61 | |||
| 62 | It's possible to provide a translation key with any log to let log displayer use some localization framework to find proper translation for it. | ||
| 63 | |||
| 64 | See [[extensions:Extension.Logging Module||anchor="HTranslatelog"]] for more details. | ||
| 65 | |||
| 66 | == JQuery in XWiki using AMD/Require.js == | ||
| 67 | |||
| 68 | Now with [[require.js>>http://requirejs.org/]] you can pull in jQuery and use it when you need it without incurring the performance penalty when you don't need it. | ||
| 69 | To use jquery, use the script below: | ||
| 70 | |||
| 71 | {{code language="html"}} | ||
| 72 | {{html}} | ||
| 73 | <script> | ||
| 74 | require(['jquery'], function($) { | ||
| 75 | $('#document-title>h1').text('JQuery in action'); | ||
| 76 | }); | ||
| 77 | </script> | ||
| 78 | {{/html}} | ||
| 79 | {{/code}} | ||
| 80 | |||
| 81 | You can learn more about the power of AMD javascript modules by reading [[require.js documentation>>http://requirejs.org/docs/whyamd.html]]. | ||
| 82 | |||
| 83 | == Back to JUnit == | ||
| 84 | |||
| 85 | XWiki Commons used to force using junit-dep instead of junit at build time because of embedded libraries in junit jar. Since it's not the case anymore the enforcer rule and everything about junit-dep has been removed from our pom.xml files. | ||
| 86 | |||
| 87 | The main change for external projects if that if you depends on junit-dep and don't specify the version your project won't build anymore and you should change for junit | ||
| 88 | |||
| 89 | == XWikiDocument authors and public access == | ||
| 90 | |||
| 91 | The document reference used to indicate that a document has been created/modified by a public access user (or guest user) is now null. It's following what is already the XWikiContext behavior which means that you can now safely compare context user reference and document authors reference since both of these APIs have the same behavior regarding unauthenticated users. | ||
| 92 | |||
| 93 | == Document rollback events == | ||
| 94 | |||
| 95 | We introduced two new document events: ##DocumentRollingBackEvent## and ##DocumentRolledBackEvent##. The first one is triggered before the document is saved (before the ##DocumentUpdatingEvent##) and the second is triggered after the document is saved (after the ##DocumentUpdatedEvent##). Checkout the [[Observation Module documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Observation+Module]] to see how you can listen to these events. | ||
| 96 | |||
| 97 | == Upgrades == | ||
| 98 | |||
| 99 | The following dependencies have been upgraded: | ||
| 100 | |||
| 101 | * GWT 2.5.1 | ||
| 102 | * JUnit 4.11 | ||
| 103 | * slf4j 1.7.5 | ||
| 104 | * logback 1.0.11 | ||
| 105 | * Hamcrest 1.3 | ||
| 106 | * Groovy 2.1.2 | ||
| 107 | |||
| 108 | == Miscellaneous == | ||
| 109 | |||
| 110 | - Added methods to query existing wikis: api.XWiki.getWikiNames() {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8841{{/jira}} and api.XWiki.hasSubWikis() {{jira url="http://jira.xwiki.org" style="enum"}}XWIKI-8875{{/jira}} | ||
| 111 | - XWiki is now always in virtual mode so development needs to consider the fact that the main wiki may not be the only wiki available. | ||
| 112 | - With the transition to virtual mode by default, the XWiki.XWikiServerClass is now a mandatory class to be used when creating a wiki descriptor. Its existence will be, like all mandatory classes, checked when XWiki starts, but only for the main wiki. It was formerly initialized by and part of the wiki-manager module but it's now part of the core. Also, the XWiki.XWikiServerClassSheet has been moved to the wiki-manager-ui module. | ||
| 113 | - The ##xwikilargestrings## table was used to store both ##LargeStringProperty## and ##StringListProperty## values; now ##StringListProperty##es are stored in a new table, ##xwikistringlists##. Existing data should be automatically migrated from one table to the other. | ||
| 114 | |||
| 115 | = Translations = | ||
| 116 | |||
| 117 | The following translations have been updated: | ||
| 118 | |||
| 119 | {{language codes="da, fr, pt_BR, zh"/}} | ||
| 120 | |||
| 121 | = Tested Browsers & Databases = | ||
| 122 | |||
| 123 | {{include reference="TestReports.ManualTestReportTemplateSummary"/}} | ||
| 124 | |||
| 125 | = Known issues = | ||
| 126 | |||
| 127 | * [[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]] | ||
| 128 | |||
| 129 | = Backward Compatibility and Migration Notes = | ||
| 130 | |||
| 131 | == General Notes == | ||
| 132 | |||
| 133 | You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above. | ||
| 134 | |||
| 135 | {{warning}} | ||
| 136 | 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. | ||
| 137 | {{/warning}} | ||
| 138 | |||
| 139 | == Issues specific to XWiki 5.0 Milestone 2 == | ||
| 140 | |||
| 141 | === Page/Attachment deletion on Oracle and PosgreSQL === | ||
| 142 | |||
| 143 | In multiwiki mode, page deletion wasn't working prior to XWiki 4.5.4 and 5.0M2. If you have created subwikis and you get an error you'll need to issue the following SQL command for all your subwikis:((( | ||
| 144 | {{code}} | ||
| 145 | create sequence hibernate_sequence | ||
| 146 | {{/code}} | ||
| 147 | |||
| 148 | Of course all new subwikis you create starting with XWiki 4.5.4 and 5.0M2 will work seamlessly. | ||
| 149 | ))) | ||
| 150 | |||
| 151 | === XWikiDocument authors and public access === | ||
| 152 | |||
| 153 | The document reference used to indicate that a document has been created/modified by a public access user (or guest user) is now null. In practice in means that even if the database indicate that the document has been saved by "XWiki.XWikiGuest" document.getAuthorReference() will return null. See http://jira.xwiki.org/browse/XWIKI-8953. | ||
| 154 | |||
| 155 | === Programming right imply Admin right and not the opposite === | ||
| 156 | |||
| 157 | With the previous Right Service implementation some side effect used to give you Programming Right when you had main wiki admin right, it's not the case anymore. Programming right is stronger than admin right in new security module default implementation which means you can have admin right without programming right, even on main wiki. | ||
| 158 | |||
| 159 | {{warning}}In practice it means that most of the time you will have to give Programming Right to main wiki admin group which used to be granted only Admin right by default distribution.{{/warning}} | ||
| 160 | |||
| 161 | === Sub-wikis now inherit rights from their main wiki === | ||
| 162 | |||
| 163 | With the previous Right Service implementation, only the admin and programming rights get inherited somehow on sub-wikis. The new implementation provide a more consistant behavior, all rights are inherited from the main wiki into sub-wikis in the same maner they are between wiki, space and document. | ||
| 164 | |||
| 165 | === Public access on an empty wiki does not receive admin right anymore === | ||
| 166 | |||
| 167 | With the previous Right Service implementation, until some right are sets, the public (previously XWikiGuest user, now null user) used to receive admin access and is able to import the default XAR. Since we now have a Distribution Wizard that kicks in to allow installing at least a minimal flavor to get you started, this is no more needed. This will improve security since the detection of an initial import situation was not so trivial. | ||
| 168 | |||
| 169 | If you do not have installed a minimal package using the new Distribution Wizard or you want to continue to import XAR manually, you may use the superadmin access to do so. | ||
| 170 | |||
| 171 | Note that public receive view, edit, comment, login, and register access to an empty wiki. | ||
| 172 | |||
| 173 | === Edit right now imply view right === | ||
| 174 | |||
| 175 | With the previous Right Service implementation, you were able to receive edit access to a document while you were not able to see or read that same document. This potential issue stay hidden since nobody notice until a edit URL is manually entered. Since we do not see any practical use case where a user would need to edit a document he cannot access, the edit right now imply the view right. Therefore, giving edit alone is now sufficient. | ||
| 176 | |||
| 177 | === Edition of XWikiPreferences and WebPreferences === | ||
| 178 | |||
| 179 | For increased security, edition of the XWikiPreferences and WebPreferences documents are now always restricted to admin users, whatever the right settings of these documents and their parents. | ||
| 180 | |||
| 181 | === The xwiki/1.0 syntax is now hidden by default === | ||
| 182 | |||
| 183 | The old xwiki/1.0 syntax is no longer available for selection when editing a document. The rendering engine will continue to be available, so existing documents using it will continue to work, and creating application documents based on a template in the xwiki/1.0 syntax will still work. Anyway, users are strongly encouraged to migrate away from this syntax. | ||
| 184 | |||
| 185 | === Miscellaneous === | ||
| 186 | |||
| 187 | * The translations page for each workspace (xwiki:WorkspaceManager.TemplateTranslations) has been moved to the template (and implicitly locally, on each workspace) in XWiki.WorkspaceTranslations. Existing workspaces will still use any existing xwiki:WorkspaceManager.TemplateTranslations document (registered as translation bundle) that you may still have on the main wiki. New workspaces will use their local XWiki.WorkspaceTranslations document. | ||
| 188 | * As stated above, a new table has been added to the schema, ##xwikistringlists##. Make sure the DB user has the required privileges to create it automatically, or create it manually before starting the new version. | ||
| 189 | * Links to attachment by default point to a specific version instead of a versionless "display the latest" link. | ||
| 190 | * Several velocity templates have been removed, since they haven't been used in a very long time; this might break custom skins built on top of old skins like Dodo or Albatross. See [[the related issue>>http://jira.xwiki.org/browse/XWIKI-8987]] for more details. | ||
| 191 | ** One important template that was removed is ##analytics.vm##, the preferred way of enabling Google Analytics is through the dedicated administration section | ||
| 192 | |||
| 193 | == API Breakages == | ||
| 194 | |||
| 195 | The following APIs were modified since XWiki 4.5.3: | ||
| 196 | |||
| 197 | {{code language="none"}} | ||
| 198 | <clirr output here> | ||
| 199 | {{/code}} |
