Wiki source code of Release Notes for XWiki 7.0 Milestone 2
Version 18.1 by Vincent Massol on 2015/02/25
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 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 | <insert description of release here> | ||
| 8 | |||
| 9 | = New and Noteworthy (since XWiki 7.0 Milestone 1) = | ||
| 10 | |||
| 11 | [[Full list of issues fixed and Dashboard for 7.0>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13092]]. | ||
| 12 | |||
| 13 | == Wiki Creation == | ||
| 14 | |||
| 15 | * During the wiki creation, Distribution Wizard is not triggered anymore. Instead, the whole wiki creation process has been moved into a job, and everything happens inside the Wiki Creation Wizard (with a progress bar and a logging area):((( | ||
| 16 | {{image reference="WikiCreationStep.png" width="45%"/}} {{image reference="WikiCreationStepEnd.png" width="45%"/}} | ||
| 17 | ))) | ||
| 18 | * The Wiki Provisioning Step has been integrated into the job too. | ||
| 19 | * When a wiki is created from a template, we now have a message in the logs that displays which document is copied. | ||
| 20 | |||
| 21 | == Miscellaneous == | ||
| 22 | |||
| 23 | * The user/group displayer is now showing the wiki for local users/groups in edit mode too (the wiki was shown only in view mode previously).((( | ||
| 24 | {{image reference="userDisplayer-editMode-wiki.png"/}} | ||
| 25 | ))) | ||
| 26 | * When deleting a wiki the confirmation page now asks to type in the wiki identifier to prevent accidental deletion.((( | ||
| 27 | {{image reference="delete-wiki-confirm-screen.png"/}} | ||
| 28 | ))) | ||
| 29 | |||
| 30 | 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+%227.0-milestone-2%22&tempMax=1000]] fixed in this release. | ||
| 31 | |||
| 32 | = For Developers = | ||
| 33 | |||
| 34 | == Mail Sender API Improvements == | ||
| 35 | |||
| 36 | The [[Mail Sender API>>extensions:Extension.Mail Sender API]] has been improved to allow sending mails to a list of users, a list of groups and a list of email addresses, all at once. It also supports excluding users, groups and email addresses. Last, it ensures that recipients don't get duplicate mails. Before 6.4.2/7.0M2, you could send a mail either to a list of users or to a group (and to an email address) but you had to use several API calls for that and you had to handle yourself potential mail duplication (if a user was inside your user list and inside the group you were sending to for example). | ||
| 37 | |||
| 38 | Using the new API, the following example will send a template email to all the users in the ##XWiki.MyGroup## group, to the ##XWiki.User1## and ##XWiki.User2## users + to the ##john@doe.com## email address. | ||
| 39 | |||
| 40 | Also note that contrary to the previous API to send email to a group, the new API handles nested groups (i.e. if the ##XWiki.MyGroup## group contains other groups, all users of those other groups will also receive the template email)! | ||
| 41 | |||
| 42 | {{code language="none"}} | ||
| 43 | {{velocity}} | ||
| 44 | ## Parameters for the 'template' MimeMessageFactory | ||
| 45 | #set ($templateParameters = {'language' : $xcontext.language, 'velocityVariables' : { 'var1' : 'value1' }}) | ||
| 46 | |||
| 47 | #set ($templateReference = $services.model.createDocumentReference('', 'Space', 'MailTemplatePage')) | ||
| 48 | #set ($parameters = {'hint' : 'template', 'parameters' : $templateParameters, 'source' : $templateReference}) | ||
| 49 | |||
| 50 | #set ($groupReference = $services.model.createDocumentReference('', 'XWiki', 'MyGroup')) | ||
| 51 | #set ($user1Reference = $services.model.createDocumentReference('', 'XWiki', 'User1')) | ||
| 52 | #set ($user2Reference = $services.model.createDocumentReference('', 'XWiki', 'User2')) | ||
| 53 | |||
| 54 | #set ($source = {'groups' : [$groupReference], 'users' : [$user1Reference, $user2Reference], 'emails' : ['john@doe.com']}) | ||
| 55 | |||
| 56 | #set ($messages = $services.mailsender.createMessages('usersandgroups', $source, $parameters)) | ||
| 57 | #set ($mailResult = $services.mailsender.send($messages, 'database')) | ||
| 58 | {{/velocity}} | ||
| 59 | {{/code}} | ||
| 60 | |||
| 61 | == Group Member Iterator == | ||
| 62 | |||
| 63 | A new ##ReferenceUserIterator## iterator has been introduced to iterate over all the users found in a list of users/groups. It supports the following: | ||
| 64 | * Ability to iterate over a list of references (either group or user) or a single user/group | ||
| 65 | * Handles nested groups | ||
| 66 | * Ability to return user data (e.g. user's email) and to programatically skip some entries based on programmatic condition | ||
| 67 | * Ability to exclude users/groups | ||
| 68 | |||
| 69 | Notes: | ||
| 70 | * Right now duplication is not handled at the level of ##UserIterator## (thus for example if a user is a member of several groups it'll be returned several times). | ||
| 71 | * This code is not performant as it will load one document per group and per user found. There's [[currently no way of handling this in a performant way>>http://jira.xwiki.org/browse/XWIKI-10377]]. | ||
| 72 | |||
| 73 | Example 1: List all users of a group by returning references | ||
| 74 | |||
| 75 | {{code language="groovy"}} | ||
| 76 | {{groovy}} | ||
| 77 | import com.xpn.xwiki.internal.plugin.rightsmanager.* | ||
| 78 | import org.xwiki.model.reference.* | ||
| 79 | import org.xwiki.context.* | ||
| 80 | |||
| 81 | def groupReference = new DocumentReference("xwiki", "XWiki", "XWikiAllGroup") | ||
| 82 | def resolver = services.component.getInstance(DocumentReferenceResolver.TYPE_STRING, "explicit") | ||
| 83 | def execution = services.component.getInstance(Execution.class) | ||
| 84 | def iterator = new ReferenceUserIterator(groupReference, resolver, execution) | ||
| 85 | iterator.each() { | ||
| 86 | println "* ${it}" | ||
| 87 | } | ||
| 88 | {{/groovy}} | ||
| 89 | {{/code}} | ||
| 90 | |||
| 91 | Example 2: Get all emails from all users inside the passed groups | ||
| 92 | |||
| 93 | {{code language="groovy"}} | ||
| 94 | {{groovy}} | ||
| 95 | import com.xpn.xwiki.doc.* | ||
| 96 | import com.xpn.xwiki.objects.* | ||
| 97 | import com.xpn.xwiki.internal.plugin.rightsmanager.* | ||
| 98 | import org.xwiki.model.reference.* | ||
| 99 | import org.xwiki.context.* | ||
| 100 | |||
| 101 | def group1Reference = new DocumentReference("xwiki", "XWiki", "XWikiAllGroup") | ||
| 102 | def group2Reference = new DocumentReference("xwiki", "XWiki", "XWikiAdminGroup") | ||
| 103 | def resolver = services.component.getInstance(DocumentReferenceResolver.TYPE_STRING, "explicit") | ||
| 104 | def execution = services.component.getInstance(Execution.class) | ||
| 105 | |||
| 106 | class EmailUserDataExtractor implements UserDataExtractor<String> | ||
| 107 | { | ||
| 108 | public String extractFromSuperadmin(DocumentReference reference) | ||
| 109 | { | ||
| 110 | return null | ||
| 111 | } | ||
| 112 | |||
| 113 | public String extractFromGuest(DocumentReference reference) | ||
| 114 | { | ||
| 115 | return null | ||
| 116 | } | ||
| 117 | |||
| 118 | public String extract(DocumentReference reference, XWikiDocument document, BaseObject userObject) | ||
| 119 | { | ||
| 120 | return userObject.getStringValue("email") | ||
| 121 | } | ||
| 122 | } | ||
| 123 | |||
| 124 | def iterator = new UserIterator([group1Reference, group2Reference], [], new EmailUserDataExtractor(), resolver, execution) | ||
| 125 | iterator.each() { | ||
| 126 | println "* ${it}" | ||
| 127 | } | ||
| 128 | {{/groovy}} | ||
| 129 | {{/code}} | ||
| 130 | |||
| 131 | == Deprecated and Retired projects == | ||
| 132 | |||
| 133 | <description of deprecated and retired projects> | ||
| 134 | |||
| 135 | == Upgrades == | ||
| 136 | |||
| 137 | The following dependencies have been upgraded: | ||
| 138 | |||
| 139 | * [[Selenium 2.44.0>>http://jira.xwiki.org/browse/XCOMMONS-753]] | ||
| 140 | * [[Arquilian Phantom JS Driver 1.1.3.Final>>http://jira.xwiki.org/browse/XWIKI-11832]] | ||
| 141 | |||
| 142 | == Miscellaneous == | ||
| 143 | |||
| 144 | * $datetool has a new method to access the [[DateFormatSymbols>>http://docs.oracle.com/javase/7/docs/api/java/text/DateFormatSymbols.html]]:((( | ||
| 145 | {{code language="none"}} | ||
| 146 | {{velocity}} | ||
| 147 | #set ($currentLocale = $services.localization.currentLocale) | ||
| 148 | #set ($dateFormatSymbols = $datetool.getDateFormatSymbols($currentLocale)) | ||
| 149 | $jsontool.serialize($dateFormatSymbols.shortMonths) | ||
| 150 | |||
| 151 | ## Output for French locale: | ||
| 152 | ## ["janv.","févr.","mars","avr.","mai","juin","juil.","août","sept.","oct.","nov.","déc.",""] | ||
| 153 | {{/velocity}} | ||
| 154 | {{/code}} | ||
| 155 | ))) | ||
| 156 | * Message Stream script service now offers a ##getLastError()## method to get the last error. | ||
| 157 | * "input" displayed Static and Database Lists separators handling has been improved to properly allow using multiple separators at once for entering data (including escaped separators inside list values). More importantly, when displaying an existing list inside an input, the existing values will always be separated using the first separator specified in the object's class for the edited object property. For non-relationally stored properties, the value that is stored in the database as a LargeStringProperty will always be separated using the default pipe ("|") separator. See [[XWIKI-10098>>http://jira.xwiki.org/browse/XWIKI-10098]] for more details. | ||
| 158 | * The ##/deleteversions/## action now supports the "latest" and "previous" pseudoversions and the ##/rollback/## action now supports the "previous" pseudoversion. See [[XWIKI-11841>>http://jira.xwiki.org/browse/XWIKI-11841]] for more information. | ||
| 159 | |||
| 160 | = Translations = | ||
| 161 | |||
| 162 | The following translations have been updated: | ||
| 163 | |||
| 164 | {{language codes="none, none"/}} | ||
| 165 | |||
| 166 | = Tested Browsers & Databases = | ||
| 167 | |||
| 168 | {{include reference="TestReports.ManualTestReportSummaryXWiki70M2"/}} | ||
| 169 | |||
| 170 | = Performances tests compared to <last super stable version> = | ||
| 171 | |||
| 172 | <a summary of the comparison with latest super stable version> | ||
| 173 | |||
| 174 | More details on <link to the test report>. | ||
| 175 | |||
| 176 | = Known issues = | ||
| 177 | |||
| 178 | * [[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]] | ||
| 179 | |||
| 180 | = Backward Compatibility and Migration Notes = | ||
| 181 | |||
| 182 | == General Notes == | ||
| 183 | |||
| 184 | 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. | ||
| 185 | |||
| 186 | == Issues specific to XWiki 7.0M2 == | ||
| 187 | |||
| 188 | * The watchlist class and its objects have been migrated to use relationally stored DBList properties instead of TextArea properties in order to solve scalability issues that occurred when too many elements were being watched by a user. See [[XWIKI-7339>>http://jira.xwiki.org/browse/XWIKI-7339]]. | ||
| 189 | |||
| 190 | == API Breakages == | ||
| 191 | |||
| 192 | The following APIs were modified since XWiki 6.4.1: | ||
| 193 | |||
| 194 | {{code language="none"}} | ||
| 195 | <clirr output here> | ||
| 196 | {{/code}} |
