Skip to content

Commit

Permalink
XWIKI-21611: Set right author when disabling/enabling an account
Browse files Browse the repository at this point in the history 
* Set only the original metadata author in XWikiUser.setDisabled
* Use the same disable/enable action everywhere
* Remove no longer needed request parameters
  • Loading branch information
@pjeanjean @michitux
pjeanjean authored and michitux committed Jan 24, 2024
1 parent 16c7948 commit f89c8f4
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 94 deletions.
17 changes: 16 additions & 1 deletion ...-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiUser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
import org.xwiki.model.reference.EntityReferenceSerializer;
import org.xwiki.model.reference.LocalDocumentReference;
import org.xwiki.model.reference.WikiReference;
import org.xwiki.user.UserReference;
import org.xwiki.user.UserReferenceResolver;

import com.xpn.xwiki.XWiki;
import com.xpn.xwiki.XWikiContext;
Expand Down Expand Up @@ -71,6 +73,8 @@ public class XWikiUser

private ContextualLocalizationManager localization;

private UserReferenceResolver<DocumentReference> documentReferenceUserReferenceResolver;

private Logger logger = LoggerFactory.getLogger(XWikiUser.class);

private String fullName;
Expand Down Expand Up @@ -204,6 +208,15 @@ private EntityReferenceSerializer<String> getLocalEntityReferenceSerializer()
return localEntityReferenceSerializer;
}

private UserReferenceResolver<DocumentReference> getDocumentReferenceUserReferenceResolver()
{
if (this.documentReferenceUserReferenceResolver == null) {
this.documentReferenceUserReferenceResolver =
Utils.getComponent(UserReferenceResolver.TYPE_DOCUMENT_REFERENCE, "document");
}
return this.documentReferenceUserReferenceResolver;
}

private ContextualLocalizationManager getLocalization()
{
if (this.localization == null) {
Expand Down Expand Up @@ -337,7 +350,9 @@ public void setDisabled(boolean disable, XWikiContext context)
XWikiDocument userdoc = getUserDocument(context);
userdoc.setIntValue(getUserClassReference(userdoc.getDocumentReference().getWikiReference()),
ACTIVE_PROPERTY, activeFlag);
userdoc.setAuthorReference(context.getUserReference());
UserReference userReference =
getDocumentReferenceUserReferenceResolver().resolve(context.getUserReference());
userdoc.getAuthors().setOriginalMetadataAuthor(userReference);
context.getWiki().saveDocument(userdoc,
localizePlainOrKey("core.users." + (disable ? "disable" : "enable") + ".saveComment"), context);
} catch (XWikiException e) {
Expand Down
187 changes: 102 additions & 85 deletions ...tform-core/xwiki-platform-oldcore/src/test/java/com/xpn/xwiki/user/api/XWikiUserTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,17 @@
*/
package com.xpn.xwiki.user.api;

import javax.inject.Named;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.xwiki.localization.ContextualLocalizationManager;
import org.xwiki.model.document.DocumentAuthors;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.test.junit5.mockito.MockComponent;
import org.xwiki.test.mockito.MockitoComponentManager;
import org.xwiki.user.UserReferenceResolver;

import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.doc.XWikiDocument;
Expand Down Expand Up @@ -56,21 +61,29 @@ public class XWikiUserTest
@InjectMockitoOldcore
private MockitoOldcore mockitoOldcore;

@MockComponent
@Named("document")
private UserReferenceResolver<DocumentReference> documentReferenceUserReferenceResolver;

@Mock
private XWikiDocument userDocument;

private DocumentReference userClassReference = new DocumentReference("xwiki", "XWiki", "XWikiUsers");
@Mock
private DocumentAuthors authors;

private final DocumentReference userClassReference = new DocumentReference("xwiki", "XWiki", "XWikiUsers");

private DocumentReference userReference = new DocumentReference("xwiki", "XWiki", "Foo");
private final DocumentReference userReference = new DocumentReference("xwiki", "XWiki", "Foo");

@BeforeEach
public void setup(MockitoComponentManager componentManager) throws Exception
{
when(mockitoOldcore.getSpyXWiki().getDocument(userReference, mockitoOldcore.getXWikiContext()))
.thenReturn(userDocument);
when(userDocument.getDocumentReference()).thenReturn(userReference);
when(userDocument.getDocumentReferenceWithLocale()).thenReturn(userReference);
when(userDocument.clone()).thenReturn(userDocument);
when(this.mockitoOldcore.getSpyXWiki().getDocument(this.userReference, this.mockitoOldcore.getXWikiContext()))
.thenReturn(this.userDocument);
when(this.userDocument.getDocumentReference()).thenReturn(this.userReference);
when(this.userDocument.getDocumentReferenceWithLocale()).thenReturn(this.userReference);
when(this.userDocument.getAuthors()).thenReturn(this.authors);
when(this.userDocument.clone()).thenReturn(this.userDocument);
componentManager.registerMockComponent(ContextualLocalizationManager.class, "default");
}

Expand All @@ -95,138 +108,142 @@ public void createWithNullFullName()
@Test
public void isDisabled()
{
XWikiUser user = new XWikiUser(userReference);
when(userDocument.getIntValue(userClassReference, XWikiUser.ACTIVE_PROPERTY, 1)).thenReturn(1);
assertFalse(user.isDisabled(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
when(this.userDocument.getIntValue(this.userClassReference, XWikiUser.ACTIVE_PROPERTY, 1)).thenReturn(1);
assertFalse(user.isDisabled(this.mockitoOldcore.getXWikiContext()));

when(userDocument.getIntValue(userClassReference, XWikiUser.ACTIVE_PROPERTY, 1)).thenReturn(0);
assertTrue(user.isDisabled(mockitoOldcore.getXWikiContext()));
when(this.userDocument.getIntValue(this.userClassReference, XWikiUser.ACTIVE_PROPERTY, 1)).thenReturn(0);
assertTrue(user.isDisabled(this.mockitoOldcore.getXWikiContext()));

user = new XWikiUser((DocumentReference) null);
assertFalse(user.isDisabled(mockitoOldcore.getXWikiContext()));
assertFalse(user.isDisabled(this.mockitoOldcore.getXWikiContext()));

user = new XWikiUser(XWikiRightService.SUPERADMIN_USER_FULLNAME);
assertFalse(user.isDisabled(mockitoOldcore.getXWikiContext()));
assertFalse(user.isDisabled(this.mockitoOldcore.getXWikiContext()));
}

@Test
public void setDisabledFalseNormalUser() throws XWikiException
{
XWikiUser user = new XWikiUser(userReference);
user.setDisabled(false, mockitoOldcore.getXWikiContext());
verify(userDocument, times(1)).setIntValue(userClassReference, XWikiUser.ACTIVE_PROPERTY, 1);
verify(mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(userDocument), any(String.class), same(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
user.setDisabled(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, times(1)).setIntValue(this.userClassReference, XWikiUser.ACTIVE_PROPERTY, 1);
verify(this.mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(this.userDocument), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
verify(this.authors, times(1)).setOriginalMetadataAuthor(any());
verify(this.authors, never()).setEffectiveMetadataAuthor(any());
}

@Test
public void setDisabledTrueNormalUser() throws XWikiException
{
XWikiUser user = new XWikiUser(userReference);
user.setDisabled(true, mockitoOldcore.getXWikiContext());
verify(userDocument, times(1)).setIntValue(userClassReference, XWikiUser.ACTIVE_PROPERTY, 0);
verify(mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(userDocument), any(String.class), same(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
user.setDisabled(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, times(1)).setIntValue(this.userClassReference, XWikiUser.ACTIVE_PROPERTY, 0);
verify(this.mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(this.userDocument), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
verify(this.authors, times(1)).setOriginalMetadataAuthor(any());
verify(this.authors, never()).setEffectiveMetadataAuthor(any());
}

@Test
public void setDisabledGuestOrSuperadminUser() throws XWikiException
{
// With guest user we never save anything
XWikiUser user = new XWikiUser((DocumentReference) null);
user.setDisabled(true, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));

user.setDisabled(false, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));
user.setDisabled(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

user.setDisabled(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

// With superadmin user we never save anything
user = new XWikiUser(XWikiRightService.SUPERADMIN_USER_FULLNAME);
user.setDisabled(true, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));

user.setDisabled(false, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));
user.setDisabled(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

user.setDisabled(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
}

@Test
public void isEmailChecked()
{
XWikiUser user = new XWikiUser(userReference);
when(userDocument.getIntValue(userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1)).thenReturn(1);
assertTrue(user.isEmailChecked(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
when(this.userDocument.getIntValue(this.userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1)).thenReturn(1);
assertTrue(user.isEmailChecked(this.mockitoOldcore.getXWikiContext()));

when(userDocument.getIntValue(userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1)).thenReturn(0);
assertFalse(user.isEmailChecked(mockitoOldcore.getXWikiContext()));
when(this.userDocument.getIntValue(this.userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1)).thenReturn(0);
assertFalse(user.isEmailChecked(this.mockitoOldcore.getXWikiContext()));

user = new XWikiUser((DocumentReference) null);
assertTrue(user.isEmailChecked(mockitoOldcore.getXWikiContext()));
assertTrue(user.isEmailChecked(this.mockitoOldcore.getXWikiContext()));

user = new XWikiUser(XWikiRightService.SUPERADMIN_USER_FULLNAME);
assertTrue(user.isEmailChecked(mockitoOldcore.getXWikiContext()));
assertTrue(user.isEmailChecked(this.mockitoOldcore.getXWikiContext()));
}

@Test
public void setEmailCheckedFalseNormalUser() throws XWikiException
{
XWikiUser user = new XWikiUser(userReference);
user.setEmailChecked(false, mockitoOldcore.getXWikiContext());
verify(userDocument, times(1)).setIntValue(userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 0);
verify(mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(userDocument), any(String.class), same(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
user.setEmailChecked(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, times(1)).setIntValue(this.userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 0);
verify(this.mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(this.userDocument), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
}

@Test
public void setEmailCheckedTrueNormalUser() throws XWikiException
{
XWikiUser user = new XWikiUser(userReference);
user.setEmailChecked(true, mockitoOldcore.getXWikiContext());
verify(userDocument, times(1)).setIntValue(userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1);
verify(mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(userDocument), any(String.class), same(mockitoOldcore.getXWikiContext()));
XWikiUser user = new XWikiUser(this.userReference);
user.setEmailChecked(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, times(1)).setIntValue(this.userClassReference, XWikiUser.EMAIL_CHECKED_PROPERTY, 1);
verify(this.mockitoOldcore.getSpyXWiki(), times(1))
.saveDocument(same(this.userDocument), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
}

@Test
public void setEmailCheckedGuestOrSuperadminUser() throws XWikiException
{
// With guest user we never save anything
XWikiUser user = new XWikiUser((DocumentReference) null);
user.setEmailChecked(true, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));

user.setEmailChecked(false, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));
user.setEmailChecked(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

user.setEmailChecked(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

// With superadmin user we never save anything
user = new XWikiUser(XWikiRightService.SUPERADMIN_USER_FULLNAME);
user.setEmailChecked(true, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));

user.setEmailChecked(false, mockitoOldcore.getXWikiContext());
verify(userDocument, never())
.setIntValue(same(userClassReference), any(String.class), any(Integer.class));
verify(mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(mockitoOldcore.getXWikiContext()));
user.setEmailChecked(true, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));

user.setEmailChecked(false, this.mockitoOldcore.getXWikiContext());
verify(this.userDocument, never())
.setIntValue(same(this.userClassReference), any(String.class), any(Integer.class));
verify(this.mockitoOldcore.getSpyXWiki(), never())
.saveDocument(any(XWikiDocument.class), any(String.class), same(this.mockitoOldcore.getXWikiContext()));
}
}
18 changes: 10 additions & 8 deletions .../xwiki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/getusers.vm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,18 @@
'doc_hasdelete': $hasDelete,
'doc_delete_url': $user.getURL('delete'),
'doc_hasdisable': $hasDisable,
'doc_disable_url': $user.getURL('save', $escapetool.url({
"${userClassName}_0_active": 0,
'comment': $services.localization.render('core.users.disable.saveComment'),
'form_token': $services.csrf.token
'doc_disable_url': $xwiki.getURL('XWiki.XWikiUserProfileSheet', 'get', $escapetool.url({
'outputSyntax': 'plain',
'action': 'disable',
'userId': $user.documentReference,
'csrf': $services.csrf.token
})),
'doc_hasenable': $hasEnable,
'doc_enable_url': $user.getURL('save', $escapetool.url({
"${userClassName}_0_active": 1,
'comment': $services.localization.render('core.users.enable.saveComment'),
'form_token': $services.csrf.token
'doc_enable_url': $xwiki.getURL('XWiki.XWikiUserProfileSheet', 'get', $escapetool.url({
'outputSyntax': 'plain',
'action': 'enable',
'userId': $user.documentReference,
'csrf': $services.csrf.token
})),
'name': "#displayUserAliasWithAvatar($user.documentReference $disabled)",
'first_name': $userObject.getValue('first_name'),
Expand Down

0 comments on commit f89c8f4

Please sign in to comment.