1 package org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
;
3 import java
.util
.ArrayList
;
4 import java
.util
.HashMap
;
8 import org
.apache
.commons
.logging
.Log
;
9 import org
.apache
.commons
.logging
.LogFactory
;
10 import org
.argeo
.api
.NodeConstants
;
11 import org
.argeo
.cms
.CmsException
;
12 import org
.argeo
.cms
.auth
.CurrentUser
;
13 import org
.argeo
.cms
.auth
.UserAdminUtils
;
14 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.UiAdminUtils
;
15 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.UserAdminWrapper
;
16 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.CommonNameLP
;
17 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.DomainNameLP
;
18 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.MailLP
;
19 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserNameLP
;
20 import org
.argeo
.eclipse
.ui
.ColumnDefinition
;
21 import org
.argeo
.eclipse
.ui
.EclipseUiUtils
;
22 import org
.argeo
.eclipse
.ui
.parts
.LdifUsersTable
;
23 import org
.argeo
.naming
.LdapAttrs
;
24 import org
.argeo
.naming
.LdapObjs
;
25 import org
.argeo
.osgi
.transaction
.WorkTransaction
;
26 import org
.eclipse
.jface
.dialogs
.IPageChangeProvider
;
27 import org
.eclipse
.jface
.dialogs
.IPageChangedListener
;
28 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
29 import org
.eclipse
.jface
.dialogs
.PageChangedEvent
;
30 import org
.eclipse
.jface
.wizard
.IWizardContainer
;
31 import org
.eclipse
.jface
.wizard
.Wizard
;
32 import org
.eclipse
.jface
.wizard
.WizardPage
;
33 import org
.eclipse
.swt
.SWT
;
34 import org
.eclipse
.swt
.events
.ModifyEvent
;
35 import org
.eclipse
.swt
.events
.ModifyListener
;
36 import org
.eclipse
.swt
.events
.SelectionAdapter
;
37 import org
.eclipse
.swt
.events
.SelectionEvent
;
38 import org
.eclipse
.swt
.layout
.GridData
;
39 import org
.eclipse
.swt
.layout
.GridLayout
;
40 import org
.eclipse
.swt
.widgets
.Button
;
41 import org
.eclipse
.swt
.widgets
.Combo
;
42 import org
.eclipse
.swt
.widgets
.Composite
;
43 import org
.eclipse
.swt
.widgets
.Text
;
44 import org
.osgi
.framework
.InvalidSyntaxException
;
45 import org
.osgi
.service
.useradmin
.Role
;
46 import org
.osgi
.service
.useradmin
.User
;
47 import org
.osgi
.service
.useradmin
.UserAdminEvent
;
49 /** Wizard to update users */
50 public class UserBatchUpdateWizard
extends Wizard
{
52 private final static Log log
= LogFactory
.getLog(UserBatchUpdateWizard
.class);
53 private UserAdminWrapper userAdminWrapper
;
56 private ChooseCommandWizardPage chooseCommandPage
;
57 private ChooseUsersWizardPage userListPage
;
58 private ValidateAndLaunchWizardPage validatePage
;
60 // Various implemented commands keys
61 private final static String CMD_UPDATE_PASSWORD
= "resetPassword";
62 private final static String CMD_UPDATE_EMAIL
= "resetEmail";
63 private final static String CMD_GROUP_MEMBERSHIP
= "groupMembership";
65 private final Map
<String
, String
> commands
= new HashMap
<String
, String
>() {
66 private static final long serialVersionUID
= 1L;
68 put("Reset password(s)", CMD_UPDATE_PASSWORD
);
69 put("Reset email(s)", CMD_UPDATE_EMAIL
);
70 // TODO implement role / group management
71 // put("Add/Remove from group", CMD_GROUP_MEMBERSHIP);
75 public UserBatchUpdateWizard(UserAdminWrapper userAdminWrapper
) {
76 this.userAdminWrapper
= userAdminWrapper
;
80 public void addPages() {
81 chooseCommandPage
= new ChooseCommandWizardPage();
82 addPage(chooseCommandPage
);
83 userListPage
= new ChooseUsersWizardPage();
84 addPage(userListPage
);
85 validatePage
= new ValidateAndLaunchWizardPage();
86 addPage(validatePage
);
90 public boolean performFinish() {
93 WorkTransaction ut
= userAdminWrapper
.getUserTransaction();
94 if (!ut
.isNoTransactionStatus() && !MessageDialog
.openConfirm(getShell(), "Existing Transaction",
95 "A user transaction is already existing, " + "are you sure you want to proceed ?"))
98 // We cannot use jobs, user modifications are still meant to be done in
100 // UpdateJob job = null;
104 if (CMD_UPDATE_PASSWORD
.equals(chooseCommandPage
.getCommand())) {
105 char[] newValue
= chooseCommandPage
.getPwdValue();
106 if (newValue
== null)
107 throw new CmsException("Password cannot be null or an empty string");
108 ResetPassword job
= new ResetPassword(userAdminWrapper
, userListPage
.getSelectedUsers(), newValue
);
110 } else if (CMD_UPDATE_EMAIL
.equals(chooseCommandPage
.getCommand())) {
111 String newValue
= chooseCommandPage
.getEmailValue();
112 if (newValue
== null)
113 throw new CmsException("Password cannot be null or an empty string");
114 ResetEmail job
= new ResetEmail(userAdminWrapper
, userListPage
.getSelectedUsers(), newValue
);
120 public boolean canFinish() {
121 if (this.getContainer().getCurrentPage() == validatePage
)
126 private class ResetPassword
{
127 private char[] newPwd
;
128 private UserAdminWrapper userAdminWrapper
;
129 private List
<User
> usersToUpdate
;
131 public ResetPassword(UserAdminWrapper userAdminWrapper
, List
<User
> usersToUpdate
, char[] newPwd
) {
132 this.newPwd
= newPwd
;
133 this.usersToUpdate
= usersToUpdate
;
134 this.userAdminWrapper
= userAdminWrapper
;
137 @SuppressWarnings("unchecked")
138 protected void doUpdate() {
139 userAdminWrapper
.beginTransactionIfNeeded();
141 for (User user
: usersToUpdate
) {
142 // the char array is emptied after being used.
143 user
.getCredentials().put(null, newPwd
.clone());
145 userAdminWrapper
.commitOrNotifyTransactionStateChange();
146 } catch (Exception e
) {
147 throw new CmsException("Cannot perform batch update on users", e
);
149 WorkTransaction ut
= userAdminWrapper
.getUserTransaction();
150 if (!ut
.isNoTransactionStatus())
156 private class ResetEmail
{
157 private String newEmail
;
158 private UserAdminWrapper userAdminWrapper
;
159 private List
<User
> usersToUpdate
;
161 public ResetEmail(UserAdminWrapper userAdminWrapper
, List
<User
> usersToUpdate
, String newEmail
) {
162 this.newEmail
= newEmail
;
163 this.usersToUpdate
= usersToUpdate
;
164 this.userAdminWrapper
= userAdminWrapper
;
167 @SuppressWarnings("unchecked")
168 protected void doUpdate() {
169 userAdminWrapper
.beginTransactionIfNeeded();
171 for (User user
: usersToUpdate
) {
172 // the char array is emptied after being used.
173 user
.getProperties().put(LdapAttrs
.mail
.name(), newEmail
);
176 userAdminWrapper
.commitOrNotifyTransactionStateChange();
177 if (!usersToUpdate
.isEmpty())
178 userAdminWrapper
.notifyListeners(
179 new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, usersToUpdate
.get(0)));
180 } catch (Exception e
) {
181 throw new CmsException("Cannot perform batch update on users", e
);
183 WorkTransaction ut
= userAdminWrapper
.getUserTransaction();
184 if (!ut
.isNoTransactionStatus())
190 // @SuppressWarnings("unused")
191 // private class AddToGroup extends UpdateJob {
192 // private String groupID;
193 // private Session session;
195 // public AddToGroup(Session session, List<Node> nodesToUpdate,
197 // super(session, nodesToUpdate);
198 // this.session = session;
199 // this.groupID = groupID;
202 // protected void doUpdate(Node node) {
203 // log.info("Add/Remove to group actions are not yet implemented");
204 // // TODO implement this
206 // // throw new CmsException("Not yet implemented");
207 // // } catch (RepositoryException re) {
208 // // throw new CmsException(
209 // // "Unable to update boolean value for node " + node, re);
215 // * Base privileged job that will be run asynchronously to perform the
219 // private abstract class UpdateJob extends PrivilegedJob {
221 // private final UserAdminWrapper userAdminWrapper;
222 // private final List<User> usersToUpdate;
224 // protected abstract void doUpdate(User user);
226 // public UpdateJob(UserAdminWrapper userAdminWrapper,
227 // List<User> usersToUpdate) {
228 // super("Perform update");
229 // this.usersToUpdate = usersToUpdate;
230 // this.userAdminWrapper = userAdminWrapper;
234 // protected IStatus doRun(IProgressMonitor progressMonitor) {
236 // JcrMonitor monitor = new EclipseJcrMonitor(progressMonitor);
237 // int total = usersToUpdate.size();
238 // monitor.beginTask("Performing change", total);
239 // userAdminWrapper.beginTransactionIfNeeded();
240 // for (User user : usersToUpdate) {
242 // monitor.worked(1);
244 // userAdminWrapper.getUserTransaction().commit();
245 // } catch (Exception e) {
246 // throw new CmsException(
247 // "Cannot perform batch update on users", e);
249 // UserTransaction ut = userAdminWrapper.getUserTransaction();
251 // if (ut.getStatus() != javax.transaction.Status.STATUS_NO_TRANSACTION)
253 // } catch (IllegalStateException | SecurityException
254 // | SystemException e) {
255 // log.error("Unable to rollback session in 'finally', "
256 // + "the system might be in a dirty state");
257 // e.printStackTrace();
260 // return Status.OK_STATUS;
266 * Displays a combo box that enables user to choose which action to perform
268 private class ChooseCommandWizardPage
extends WizardPage
{
269 private static final long serialVersionUID
= -8069434295293996633L;
270 private Combo chooseCommandCmb
;
271 private Button trueChk
;
272 private Text valueTxt
;
274 private Text pwd2Txt
;
276 public ChooseCommandWizardPage() {
277 super("Choose a command to run.");
278 setTitle("Choose a command to run.");
282 public void createControl(Composite parent
) {
283 GridLayout gl
= new GridLayout();
284 Composite container
= new Composite(parent
, SWT
.NO_FOCUS
);
285 container
.setLayout(gl
);
287 chooseCommandCmb
= new Combo(container
, SWT
.READ_ONLY
);
288 chooseCommandCmb
.setLayoutData(EclipseUiUtils
.fillWidth());
289 String
[] values
= commands
.keySet().toArray(new String
[0]);
290 chooseCommandCmb
.setItems(values
);
292 final Composite bottomPart
= new Composite(container
, SWT
.NO_FOCUS
);
293 bottomPart
.setLayoutData(EclipseUiUtils
.fillAll());
294 bottomPart
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
296 chooseCommandCmb
.addSelectionListener(new SelectionAdapter() {
297 private static final long serialVersionUID
= 1L;
300 public void widgetSelected(SelectionEvent e
) {
301 if (getCommand().equals(CMD_UPDATE_PASSWORD
))
302 populatePasswordCmp(bottomPart
);
303 else if (getCommand().equals(CMD_UPDATE_EMAIL
))
304 populateEmailCmp(bottomPart
);
305 else if (getCommand().equals(CMD_GROUP_MEMBERSHIP
))
306 populateGroupCmp(bottomPart
);
308 populateBooleanFlagCmp(bottomPart
);
310 bottomPart
.layout(true, true);
313 setControl(container
);
316 private void populateBooleanFlagCmp(Composite parent
) {
317 EclipseUiUtils
.clear(parent
);
318 trueChk
= new Button(parent
, SWT
.CHECK
);
319 trueChk
.setText("Do it. (It will to the contrary if unchecked)");
320 trueChk
.setSelection(true);
321 trueChk
.setLayoutData(new GridData(SWT
.LEFT
, SWT
.TOP
, false, false));
324 private void populatePasswordCmp(Composite parent
) {
325 EclipseUiUtils
.clear(parent
);
326 Composite body
= new Composite(parent
, SWT
.NO_FOCUS
);
328 ModifyListener ml
= new ModifyListener() {
329 private static final long serialVersionUID
= -1558726363536729634L;
332 public void modifyText(ModifyEvent event
) {
337 body
.setLayout(new GridLayout(2, false));
338 body
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
339 pwdTxt
= EclipseUiUtils
.createGridLP(body
, "New password", ml
);
340 pwd2Txt
= EclipseUiUtils
.createGridLP(body
, "Repeat password", ml
);
343 private void populateEmailCmp(Composite parent
) {
344 EclipseUiUtils
.clear(parent
);
345 Composite body
= new Composite(parent
, SWT
.NO_FOCUS
);
347 ModifyListener ml
= new ModifyListener() {
348 private static final long serialVersionUID
= 2147704227294268317L;
351 public void modifyText(ModifyEvent event
) {
356 body
.setLayout(new GridLayout(2, false));
357 body
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
358 valueTxt
= EclipseUiUtils
.createGridLT(body
, "New e-mail", ml
);
361 private void checkPageComplete() {
362 String errorMsg
= null;
363 if (chooseCommandCmb
.getSelectionIndex() < 0)
364 errorMsg
= "Please select an action";
365 else if (CMD_UPDATE_EMAIL
.equals(getCommand())) {
366 if (!valueTxt
.getText().matches(UiAdminUtils
.EMAIL_PATTERN
))
367 errorMsg
= "Not a valid e-mail address";
368 } else if (CMD_UPDATE_PASSWORD
.equals(getCommand())) {
369 if (EclipseUiUtils
.isEmpty(pwdTxt
.getText()) || pwdTxt
.getText().length() < 4)
370 errorMsg
= "Please enter a password that is at least 4 character long";
371 else if (!pwdTxt
.getText().equals(pwd2Txt
.getText()))
372 errorMsg
= "Passwords are different";
374 if (EclipseUiUtils
.notEmpty(errorMsg
)) {
375 setMessage(errorMsg
, WizardPage
.ERROR
);
376 setPageComplete(false);
378 setMessage("Page complete, you can proceed to user choice", WizardPage
.INFORMATION
);
379 setPageComplete(true);
382 getContainer().updateButtons();
385 private void populateGroupCmp(Composite parent
) {
386 EclipseUiUtils
.clear(parent
);
387 trueChk
= new Button(parent
, SWT
.CHECK
);
388 trueChk
.setText("Add to group. (It will remove user(s) from the " + "corresponding group if unchecked)");
389 trueChk
.setSelection(true);
390 trueChk
.setLayoutData(new GridData(SWT
.LEFT
, SWT
.TOP
, false, false));
393 protected String
getCommand() {
394 return commands
.get(chooseCommandCmb
.getItem(chooseCommandCmb
.getSelectionIndex()));
397 protected String
getCommandLbl() {
398 return chooseCommandCmb
.getItem(chooseCommandCmb
.getSelectionIndex());
401 @SuppressWarnings("unused")
402 protected boolean getBoleanValue() {
403 // FIXME this is not consistent and will lead to errors.
404 if ("argeo:enabled".equals(getCommand()))
405 return trueChk
.getSelection();
407 return !trueChk
.getSelection();
410 @SuppressWarnings("unused")
411 protected String
getStringValue() {
413 if (valueTxt
!= null) {
414 value
= valueTxt
.getText();
415 if ("".equals(value
.trim()))
421 protected char[] getPwdValue() {
422 // We do not directly reset the password text fields: There is no
423 // need to over secure this process: setting a pwd to multi users
424 // at the same time is anyhow a bad practice and should be used only
425 // in test environment or for temporary access
426 if (pwdTxt
== null || pwdTxt
.isDisposed())
429 return pwdTxt
.getText().toCharArray();
432 protected String
getEmailValue() {
433 // We do not directly reset the password text fields: There is no
434 // need to over secure this process: setting a pwd to multi users
435 // at the same time is anyhow a bad practice and should be used only
436 // in test environment or for temporary access
437 if (valueTxt
== null || valueTxt
.isDisposed())
440 return valueTxt
.getText();
445 * Displays a list of users with a check box to be able to choose some of them
447 private class ChooseUsersWizardPage
extends WizardPage
implements IPageChangedListener
{
448 private static final long serialVersionUID
= 7651807402211214274L;
449 private ChooseUserTableViewer userTableCmp
;
451 public ChooseUsersWizardPage() {
452 super("Choose Users");
453 setTitle("Select users who will be impacted");
457 public void createControl(Composite parent
) {
458 Composite pageCmp
= new Composite(parent
, SWT
.NONE
);
459 pageCmp
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
461 // Define the displayed columns
462 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
463 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Common Name", 150));
464 columnDefs
.add(new ColumnDefinition(new MailLP(), "E-mail", 150));
465 columnDefs
.add(new ColumnDefinition(new DomainNameLP(), "Domain", 200));
467 // Only show technical DN to admin
468 if (CurrentUser
.isInRole(NodeConstants
.ROLE_ADMIN
))
469 columnDefs
.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name", 300));
471 userTableCmp
= new ChooseUserTableViewer(pageCmp
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
);
472 userTableCmp
.setLayoutData(EclipseUiUtils
.fillAll());
473 userTableCmp
.setColumnDefinitions(columnDefs
);
474 userTableCmp
.populate(true, true);
475 userTableCmp
.refresh();
479 // Add listener to update message when shown
480 final IWizardContainer wContainer
= this.getContainer();
481 if (wContainer
instanceof IPageChangeProvider
) {
482 ((IPageChangeProvider
) wContainer
).addPageChangedListener(this);
488 public void pageChanged(PageChangedEvent event
) {
489 if (event
.getSelectedPage() == this) {
490 String msg
= "Chosen batch action: " + chooseCommandPage
.getCommandLbl();
491 ((WizardPage
) event
.getSelectedPage()).setMessage(msg
);
495 protected List
<User
> getSelectedUsers() {
496 return userTableCmp
.getSelectedUsers();
499 private class ChooseUserTableViewer
extends LdifUsersTable
{
500 private static final long serialVersionUID
= 5080437561015853124L;
501 private final String
[] knownProps
= { LdapAttrs
.uid
.name(), LdapAttrs
.DN
, LdapAttrs
.cn
.name(),
502 LdapAttrs
.givenName
.name(), LdapAttrs
.sn
.name(), LdapAttrs
.mail
.name() };
504 public ChooseUserTableViewer(Composite parent
, int style
) {
505 super(parent
, style
);
509 protected List
<User
> listFilteredElements(String filter
) {
513 StringBuilder builder
= new StringBuilder();
515 StringBuilder tmpBuilder
= new StringBuilder();
516 if (EclipseUiUtils
.notEmpty(filter
))
517 for (String prop
: knownProps
) {
518 tmpBuilder
.append("(");
519 tmpBuilder
.append(prop
);
520 tmpBuilder
.append("=*");
521 tmpBuilder
.append(filter
);
522 tmpBuilder
.append("*)");
524 if (tmpBuilder
.length() > 1) {
525 builder
.append("(&(").append(LdapAttrs
.objectClass
.name()).append("=")
526 .append(LdapObjs
.inetOrgPerson
.name()).append(")(|");
527 builder
.append(tmpBuilder
.toString());
528 builder
.append("))");
530 builder
.append("(").append(LdapAttrs
.objectClass
.name()).append("=")
531 .append(LdapObjs
.inetOrgPerson
.name()).append(")");
532 roles
= userAdminWrapper
.getUserAdmin().getRoles(builder
.toString());
533 } catch (InvalidSyntaxException e
) {
534 throw new CmsException("Unable to get roles with filter: " + filter
, e
);
536 List
<User
> users
= new ArrayList
<User
>();
537 for (Role role
: roles
)
538 // Prevent current logged in user to perform batch on
540 if (!UserAdminUtils
.isCurrentUser((User
) role
))
541 users
.add((User
) role
);
547 /** Summary of input data before launching the process */
548 private class ValidateAndLaunchWizardPage
extends WizardPage
implements IPageChangedListener
{
549 private static final long serialVersionUID
= 7098918351451743853L;
550 private ChosenUsersTableViewer userTableCmp
;
552 public ValidateAndLaunchWizardPage() {
553 super("Validate and launch");
554 setTitle("Validate and launch");
558 public void createControl(Composite parent
) {
559 Composite pageCmp
= new Composite(parent
, SWT
.NO_FOCUS
);
560 pageCmp
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
562 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
563 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Common Name", 150));
564 columnDefs
.add(new ColumnDefinition(new MailLP(), "E-mail", 150));
565 columnDefs
.add(new ColumnDefinition(new DomainNameLP(), "Domain", 200));
566 // Only show technical DN to admin
567 if (CurrentUser
.isInRole(NodeConstants
.ROLE_ADMIN
))
568 columnDefs
.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name", 300));
569 userTableCmp
= new ChosenUsersTableViewer(pageCmp
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
);
570 userTableCmp
.setLayoutData(EclipseUiUtils
.fillAll());
571 userTableCmp
.setColumnDefinitions(columnDefs
);
572 userTableCmp
.populate(false, false);
573 userTableCmp
.refresh();
575 // Add listener to update message when shown
576 final IWizardContainer wContainer
= this.getContainer();
577 if (wContainer
instanceof IPageChangeProvider
) {
578 ((IPageChangeProvider
) wContainer
).addPageChangedListener(this);
583 public void pageChanged(PageChangedEvent event
) {
584 if (event
.getSelectedPage() == this) {
585 @SuppressWarnings({ "unchecked", "rawtypes" })
586 Object
[] values
= ((ArrayList
) userListPage
.getSelectedUsers())
587 .toArray(new Object
[userListPage
.getSelectedUsers().size()]);
588 userTableCmp
.getTableViewer().setInput(values
);
589 String msg
= "Following batch action: [" + chooseCommandPage
.getCommandLbl()
590 + "] will be perfomed on the users listed below.\n";
591 // + "Are you sure you want to proceed?";
596 private class ChosenUsersTableViewer
extends LdifUsersTable
{
597 private static final long serialVersionUID
= 7814764735794270541L;
599 public ChosenUsersTableViewer(Composite parent
, int style
) {
600 super(parent
, style
);
604 protected List
<User
> listFilteredElements(String filter
) {
605 return userListPage
.getSelectedUsers();