parts/UserMainPage.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.security.ui.admin.internal.parts;
  17
  18 import java.util.ArrayList;
  19 import java.util.Iterator;
  20 import java.util.List;
  21
  22 import org.argeo.ArgeoException;
  23 import org.argeo.cms.auth.AuthConstants;
  24 import org.argeo.eclipse.ui.ColumnDefinition;
  25 import org.argeo.eclipse.ui.EclipseUiUtils;
  26 import org.argeo.eclipse.ui.parts.LdifUsersTable;
  27 import org.argeo.jcr.ArgeoNames;
  28 import org.argeo.osgi.useradmin.LdifName;
  29 import org.argeo.security.ui.admin.SecurityAdminImages;
  30 import org.argeo.security.ui.admin.internal.UiAdminUtils;
  31 import org.argeo.security.ui.admin.internal.UserAdminWrapper;
  32 import org.argeo.security.ui.admin.internal.parts.UserEditor.GroupChangeListener;
  33 import org.argeo.security.ui.admin.internal.parts.UserEditor.MainInfoListener;
  34 import org.argeo.security.ui.admin.internal.providers.CommonNameLP;
  35 import org.argeo.security.ui.admin.internal.providers.DomainNameLP;
  36 import org.argeo.security.ui.admin.internal.providers.RoleIconLP;
  37 import org.argeo.security.ui.admin.internal.providers.UserFilter;
  38 import org.argeo.security.ui.admin.internal.providers.UserNameLP;
  39 import org.argeo.security.ui.admin.internal.providers.UserTableDefaultDClickListener;
  40 import org.eclipse.jface.action.Action;
  41 import org.eclipse.jface.action.ToolBarManager;
  42 import org.eclipse.jface.resource.ImageDescriptor;
  43 import org.eclipse.jface.viewers.ISelection;
  44 import org.eclipse.jface.viewers.IStructuredSelection;
  45 import org.eclipse.jface.viewers.TableViewer;
  46 import org.eclipse.jface.viewers.Viewer;
  47 import org.eclipse.jface.viewers.ViewerDropAdapter;
  48 import org.eclipse.swt.SWT;
  49 import org.eclipse.swt.dnd.DND;
  50 import org.eclipse.swt.dnd.DropTargetEvent;
  51 import org.eclipse.swt.dnd.TextTransfer;
  52 import org.eclipse.swt.dnd.Transfer;
  53 import org.eclipse.swt.dnd.TransferData;
  54 import org.eclipse.swt.events.DisposeEvent;
  55 import org.eclipse.swt.events.DisposeListener;
  56 import org.eclipse.swt.events.ModifyEvent;
  57 import org.eclipse.swt.events.ModifyListener;
  58 import org.eclipse.swt.events.SelectionAdapter;
  59 import org.eclipse.swt.events.SelectionEvent;
  60 import org.eclipse.swt.graphics.Cursor;
  61 import org.eclipse.swt.layout.GridData;
  62 import org.eclipse.swt.layout.GridLayout;
  63 import org.eclipse.swt.widgets.Button;
  64 import org.eclipse.swt.widgets.Composite;
  65 import org.eclipse.swt.widgets.Label;
  66 import org.eclipse.swt.widgets.Text;
  67 import org.eclipse.swt.widgets.ToolBar;
  68 import org.eclipse.ui.forms.AbstractFormPart;
  69 import org.eclipse.ui.forms.IManagedForm;
  70 import org.eclipse.ui.forms.SectionPart;
  71 import org.eclipse.ui.forms.editor.FormEditor;
  72 import org.eclipse.ui.forms.editor.FormPage;
  73 import org.eclipse.ui.forms.widgets.FormToolkit;
  74 import org.eclipse.ui.forms.widgets.ScrolledForm;
  75 import org.eclipse.ui.forms.widgets.Section;
  76 import org.osgi.service.useradmin.Group;
  77 import org.osgi.service.useradmin.Role;
  78 import org.osgi.service.useradmin.User;
  79 import org.osgi.service.useradmin.UserAdmin;
  80 import org.osgi.service.useradmin.UserAdminEvent;
  81
  82 /** Display/edit the properties of a given user */
  83 public class UserMainPage extends FormPage implements ArgeoNames {
  84         final static String ID = "UserEditor.mainPage";
  85
  86         private final UserEditor editor;
  87         private UserAdminWrapper userAdminWrapper;
  88
  89         // Local configuration
  90         private final int PRE_TITLE_INDENT = 10;
  91
  92         public UserMainPage(FormEditor editor, UserAdminWrapper userAdminWrapper) {
  93                 super(editor, ID, "Main");
  94                 this.editor = (UserEditor) editor;
  95                 this.userAdminWrapper = userAdminWrapper;
  96         }
  97
  98         protected void createFormContent(final IManagedForm mf) {
  99                 ScrolledForm form = mf.getForm();
 100                 Composite body = form.getBody();
 101                 GridLayout mainLayout = new GridLayout();
 102                 // mainLayout.marginRight = 10;
 103                 body.setLayout(mainLayout);
 104                 User user = editor.getDisplayedUser();
 105                 appendOverviewPart(body, user);
 106                 // Remove to ability to force the password for his own user. The user
 107                 // must then use the change pwd feature
 108                 if (!UiAdminUtils.isCurrentUser(user))
 109                         appendPasswordPart(body, user);
 110                 appendMemberOfPart(body, user);
 111         }
 112
 113         /** Creates the general section */
 114         private void appendOverviewPart(Composite parent, final User user) {
 115                 FormToolkit tk = getManagedForm().getToolkit();
 116
 117                 Section section = addSection(tk, parent, "Main information");
 118                 Composite body = (Composite) section.getClient();
 119                 body.setLayout(new GridLayout(2, false));
 120
 121                 final Text distinguishedName = createLT(tk, body, "User Name",
 122                                 UiAdminUtils.getProperty(user, LdifName.uid.name()));
 123                 distinguishedName.setEnabled(false);
 124
 125                 final Text commonName = createLT(tk, body, "Common Name",
 126                                 UiAdminUtils.getProperty(user, LdifName.cn.name()));
 127                 commonName.setEnabled(false);
 128
 129                 final Text firstName = createLT(tk, body, "First name",
 130                                 UiAdminUtils.getProperty(user, LdifName.givenname.name()));
 131
 132                 final Text lastName = createLT(tk, body, "Last name",
 133                                 UiAdminUtils.getProperty(user, LdifName.sn.name()));
 134
 135                 final Text email = createLT(tk, body, "Email",
 136                                 UiAdminUtils.getProperty(user, LdifName.mail.name()));
 137
 138                 // create form part (controller)
 139                 AbstractFormPart part = new SectionPart((Section) body.getParent()) {
 140                         private MainInfoListener listener;
 141
 142                         @Override
 143                         public void initialize(IManagedForm form) {
 144                                 super.initialize(form);
 145                                 listener = editor.new MainInfoListener(this);
 146                                 userAdminWrapper.addListener(listener);
 147                         }
 148
 149                         @Override
 150                         public void dispose() {
 151                                 userAdminWrapper.removeListener(listener);
 152                                 super.dispose();
 153                         }
 154
 155                         @SuppressWarnings("unchecked")
 156                         public void commit(boolean onSave) {
 157                                 // TODO Sanity checks (mail validity...)
 158                                 user.getProperties().put(LdifName.givenname.name(),
 159                                                 firstName.getText());
 160                                 user.getProperties()
 161                                                 .put(LdifName.sn.name(), lastName.getText());
 162                                 user.getProperties().put(LdifName.cn.name(),
 163                                                 commonName.getText());
 164                                 user.getProperties().put(LdifName.mail.name(), email.getText());
 165                                 super.commit(onSave);
 166                         }
 167
 168                         @Override
 169                         public void refresh() {
 170                                 distinguishedName.setText(UiAdminUtils.getProperty(user,
 171                                                 LdifName.uid.name()));
 172                                 commonName.setText(UiAdminUtils.getProperty(user,
 173                                                 LdifName.cn.name()));
 174                                 firstName.setText(UiAdminUtils.getProperty(user,
 175                                                 LdifName.givenname.name()));
 176                                 lastName.setText(UiAdminUtils.getProperty(user,
 177                                                 LdifName.sn.name()));
 178                                 email.setText(LdifName.mail.name());
 179                                 refreshFormTitle(user);
 180                                 super.refresh();
 181                         }
 182                 };
 183
 184                 // Improve this: automatically generate CN when first or last name
 185                 // changes
 186                 ModifyListener cnML = new ModifyListener() {
 187                         private static final long serialVersionUID = 4298649222869835486L;
 188
 189                         @Override
 190                         public void modifyText(ModifyEvent event) {
 191                                 String first = firstName.getText();
 192                                 String last = lastName.getText();
 193                                 String cn = first.trim() + " " + last.trim() + " ";
 194                                 cn = cn.trim();
 195                                 commonName.setText(cn);
 196                                 getManagedForm().getForm().setText(cn);
 197                                 editor.updateEditorTitle(cn);
 198                         }
 199                 };
 200                 firstName.addModifyListener(cnML);
 201                 lastName.addModifyListener(cnML);
 202
 203                 ModifyListener defaultListener = editor.new FormPartML(part);
 204                 firstName.addModifyListener(defaultListener);
 205                 lastName.addModifyListener(defaultListener);
 206                 email.addModifyListener(defaultListener);
 207                 getManagedForm().addPart(part);
 208         }
 209
 210         /** Creates the password section */
 211         private void appendPasswordPart(Composite parent, final User user) {
 212                 FormToolkit tk = getManagedForm().getToolkit();
 213                 Section section = addSection(tk, parent, "Password");
 214                 Composite body = (Composite) section.getClient();
 215                 body.setLayout(new GridLayout(2, false));
 216
 217                 // add widgets (view)
 218                 final Text password1 = createLP(tk, body, "New password", "");
 219                 final Text password2 = createLP(tk, body, "Repeat password", "");
 220
 221                 // create form part (controller)
 222                 AbstractFormPart part = new SectionPart((Section) body.getParent()) {
 223                         @SuppressWarnings("unchecked")
 224                         public void commit(boolean onSave) {
 225                                 if (!password1.getText().equals("")
 226                                                 || !password2.getText().equals("")) {
 227                                         if (password1.getText().equals(password2.getText())) {
 228                                                 char[] newPassword = password1.getText().toCharArray();
 229                                                 userAdminWrapper.beginTransactionIfNeeded();
 230                                                 user.getCredentials().put(null, newPassword);
 231                                                 password1.setText("");
 232                                                 password2.setText("");
 233                                                 super.commit(onSave);
 234                                         } else {
 235                                                 password1.setText("");
 236                                                 password2.setText("");
 237                                                 throw new ArgeoException("Passwords are not equals");
 238                                         }
 239                                 }
 240                         }
 241                 };
 242                 ModifyListener defaultListener = editor.new FormPartML(part);
 243                 password1.addModifyListener(defaultListener);
 244                 password2.addModifyListener(defaultListener);
 245                 getManagedForm().addPart(part);
 246         }
 247
 248         private LdifUsersTable appendMemberOfPart(Composite parent, User user) {
 249                 FormToolkit tk = getManagedForm().getToolkit();
 250                 Section section = addSection(tk, parent, "Roles");
 251                 Composite body = (Composite) section.getClient();
 252                 body.setLayout(EclipseUiUtils.noSpaceGridLayout());
 253
 254                 boolean isAdmin = UiAdminUtils.isUserInRole(AuthConstants.ROLE_ADMIN);
 255
 256                 // Displayed columns
 257                 List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
 258                 columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
 259                 columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Common Name",
 260                                 150));
 261                 columnDefs.add(new ColumnDefinition(new DomainNameLP(), "Domain Name",
 262                                 200));
 263                 // Only show technical DN to administrators
 264                 if (isAdmin)
 265                         columnDefs.add(new ColumnDefinition(new UserNameLP(),
 266                                         "Distinguished Name", 120));
 267
 268                 // Create and configure the table
 269                 final LdifUsersTable userViewerCmp = new MyUserTableViewer(body,
 270                                 SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL, user);
 271
 272                 userViewerCmp.setColumnDefinitions(columnDefs);
 273                 if (isAdmin)
 274                         userViewerCmp.populateWithStaticFilters(false, false);
 275                 else
 276                         userViewerCmp.populate(true, false);
 277                 GridData gd = EclipseUiUtils.fillAll();
 278                 gd.heightHint = 300;
 279                 userViewerCmp.setLayoutData(gd);
 280
 281                 // Controllers
 282                 TableViewer userViewer = userViewerCmp.getTableViewer();
 283                 userViewer.addDoubleClickListener(new UserTableDefaultDClickListener());
 284                 int operations = DND.DROP_COPY | DND.DROP_MOVE;
 285                 Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
 286                 GroupDropListener dropL = new GroupDropListener(userAdminWrapper,
 287                                 userViewer, user);
 288                 userViewer.addDropSupport(operations, tt, dropL);
 289
 290                 SectionPart part = new SectionPart((Section) body.getParent()) {
 291
 292                         private GroupChangeListener listener;
 293
 294                         @Override
 295                         public void initialize(IManagedForm form) {
 296                                 super.initialize(form);
 297                                 listener = editor.new GroupChangeListener(this);
 298                                 userAdminWrapper.addListener(listener);
 299                         }
 300
 301                         public void commit(boolean onSave) {
 302                                 super.commit(onSave);
 303                         }
 304
 305                         @Override
 306                         public void dispose() {
 307                                 userAdminWrapper.removeListener(listener);
 308                                 super.dispose();
 309                         }
 310
 311                         @Override
 312                         public void refresh() {
 313                                 userViewerCmp.refresh();
 314                                 super.refresh();
 315                         }
 316                 };
 317                 getManagedForm().addPart(part);
 318                 addRemoveAbitily(part, userViewer, user);
 319                 return userViewerCmp;
 320         }
 321
 322         private class MyUserTableViewer extends LdifUsersTable {
 323                 private static final long serialVersionUID = 2653790051461237329L;
 324
 325                 private Button showSystemRoleBtn;
 326
 327                 private final User user;
 328                 private final UserFilter userFilter;
 329
 330                 public MyUserTableViewer(Composite parent, int style, User user) {
 331                         super(parent, style, true);
 332                         this.user = user;
 333                         userFilter = new UserFilter();
 334                         userFilter.setShowSystemRole(false);
 335                 }
 336
 337                 protected void populateStaticFilters(Composite staticFilterCmp) {
 338                         staticFilterCmp.setLayout(new GridLayout());
 339                         showSystemRoleBtn = new Button(staticFilterCmp, SWT.CHECK);
 340                         showSystemRoleBtn.setText("Show system roles");
 341                         showSystemRoleBtn.addSelectionListener(new SelectionAdapter() {
 342                                 private static final long serialVersionUID = -7033424592697691676L;
 343
 344                                 @Override
 345                                 public void widgetSelected(SelectionEvent e) {
 346                                         userFilter.setShowSystemRole(showSystemRoleBtn
 347                                                         .getSelection());
 348                                         refresh();
 349                                 }
 350                         });
 351                 }
 352
 353                 @Override
 354                 protected List<User> listFilteredElements(String filter) {
 355                         List<User> users = (List<User>) editor.getFlatGroups(null);
 356                         List<User> filteredUsers = new ArrayList<User>();
 357                         if (users.contains(user))
 358                                 users.remove(user);
 359                         userFilter.setSearchText(filter);
 360                         for (User user : users)
 361                                 if (userFilter.select(null, null, user))
 362                                         filteredUsers.add(user);
 363                         return filteredUsers;
 364                 }
 365         }
 366
 367         private void addRemoveAbitily(SectionPart sectionPart,
 368                         TableViewer userViewer, User user) {
 369                 Section section = sectionPart.getSection();
 370                 ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
 371                 ToolBar toolbar = toolBarManager.createControl(section);
 372                 final Cursor handCursor = new Cursor(section.getDisplay(),
 373                                 SWT.CURSOR_HAND);
 374                 toolbar.setCursor(handCursor);
 375                 toolbar.addDisposeListener(new DisposeListener() {
 376                         private static final long serialVersionUID = 3882131405820522925L;
 377
 378                         public void widgetDisposed(DisposeEvent e) {
 379                                 if ((handCursor != null) && (handCursor.isDisposed() == false)) {
 380                                         handCursor.dispose();
 381                                 }
 382                         }
 383                 });
 384
 385                 String tooltip = "Remove " + UiAdminUtils.getUsername(user)
 386                                 + " from the below selected groups";
 387                 Action action = new RemoveMembershipAction(userViewer, user, tooltip,
 388                                 SecurityAdminImages.ICON_REMOVE_DESC);
 389                 toolBarManager.add(action);
 390                 toolBarManager.update(true);
 391                 section.setTextClient(toolbar);
 392         }
 393
 394         private class RemoveMembershipAction extends Action {
 395                 private static final long serialVersionUID = -1337713097184522588L;
 396
 397                 private final TableViewer userViewer;
 398                 private final User user;
 399
 400                 RemoveMembershipAction(TableViewer userViewer, User user, String name,
 401                                 ImageDescriptor img) {
 402                         super(name, img);
 403                         this.userViewer = userViewer;
 404                         this.user = user;
 405                 }
 406
 407                 @Override
 408                 public void run() {
 409                         ISelection selection = userViewer.getSelection();
 410                         if (selection.isEmpty())
 411                                 return;
 412
 413                         @SuppressWarnings("unchecked")
 414                         Iterator<Group> it = ((IStructuredSelection) selection).iterator();
 415                         List<Group> groups = new ArrayList<Group>();
 416                         // StringBuilder builder = new StringBuilder();
 417                         while (it.hasNext()) {
 418                                 Group currGroup = it.next();
 419                                 // String groupName = UiAdminUtils.getUsername(currGroup);
 420                                 // builder.append(groupName).append("; ");
 421                                 groups.add(currGroup);
 422                         }
 423
 424                         // if (!MessageDialog.openQuestion(
 425                         // HandlerUtil.getActiveShell(event),
 426                         // "Re",
 427                         // "Are you sure that you want to delete these users?\n"
 428                         // + builder.substring(0, builder.length() - 2)))
 429                         // return null;
 430
 431                         userAdminWrapper.beginTransactionIfNeeded();
 432                         for (Group group : groups) {
 433                                 group.removeMember(user);
 434                                 // sectionPart.refresh();
 435                                 userAdminWrapper.notifyListeners(new UserAdminEvent(null,
 436                                                 UserAdminEvent.ROLE_CHANGED, group));
 437                         }
 438                 }
 439         }
 440
 441         /**
 442          * Defines the table as being a potential target to add group memberships
 443          * (roles) to this user
 444          */
 445         private class GroupDropListener extends ViewerDropAdapter {
 446                 private static final long serialVersionUID = 2893468717831451621L;
 447
 448                 private final UserAdminWrapper myUserAdminWrapper;
 449                 private final User myUser;
 450
 451                 public GroupDropListener(UserAdminWrapper userAdminWrapper,
 452                                 Viewer userViewer, User user) {
 453                         super(userViewer);
 454                         this.myUserAdminWrapper = userAdminWrapper;
 455                         this.myUser = user;
 456                 }
 457
 458                 @Override
 459                 public boolean validateDrop(Object target, int operation,
 460                                 TransferData transferType) {
 461                         // Target is always OK in a list only view
 462                         // TODO check if not a string
 463                         boolean validDrop = true;
 464                         return validDrop;
 465                 }
 466
 467                 @Override
 468                 public void drop(DropTargetEvent event) {
 469                         String name = (String) event.data;
 470                         UserAdmin myUserAdmin = myUserAdminWrapper.getUserAdmin();
 471                         Role role = myUserAdmin.getRole(name);
 472                         // TODO this check should be done before.
 473                         if (role.getType() == Role.GROUP) {
 474                                 // TODO check if the user is already member of this group
 475                                 myUserAdminWrapper.beginTransactionIfNeeded();
 476                                 Group group = (Group) role;
 477                                 group.addMember(myUser);
 478                                 myUserAdminWrapper.notifyListeners(new UserAdminEvent(null,
 479                                                 UserAdminEvent.ROLE_CHANGED, group));
 480                         }
 481                         super.drop(event);
 482                 }
 483
 484                 @Override
 485                 public boolean performDrop(Object data) {
 486                         // userTableViewerCmp.refresh();
 487                         return true;
 488                 }
 489         }
 490
 491         // LOCAL HELPERS
 492         private void refreshFormTitle(User group) {
 493                 getManagedForm().getForm().setText(
 494                                 UiAdminUtils.getProperty(group, LdifName.cn.name()));
 495         }
 496
 497         /** Appends a section with a title */
 498         private Section addSection(FormToolkit tk, Composite parent, String title) {
 499                 Section section = tk.createSection(parent, Section.TITLE_BAR);
 500                 GridData gd = EclipseUiUtils.fillWidth();
 501                 gd.verticalAlignment = PRE_TITLE_INDENT;
 502                 section.setLayoutData(gd);
 503                 section.setText(title);
 504                 // section.getMenu().setVisible(true);
 505
 506                 Composite body = tk.createComposite(section, SWT.WRAP);
 507                 body.setLayoutData(EclipseUiUtils.fillAll());
 508                 section.setClient(body);
 509
 510                 return section;
 511         }
 512
 513         /** Creates label and multiline text. */
 514         Text createLMT(FormToolkit toolkit, Composite body, String label,
 515                         String value) {
 516                 Label lbl = toolkit.createLabel(body, label);
 517                 lbl.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, false, false));
 518                 Text text = toolkit.createText(body, value, SWT.BORDER | SWT.MULTI);
 519                 text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true));
 520                 return text;
 521         }
 522
 523         /** Creates label and password. */
 524         Text createLP(FormToolkit toolkit, Composite body, String label,
 525                         String value) {
 526                 Label lbl = toolkit.createLabel(body, label);
 527                 lbl.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, false, false));
 528                 Text text = toolkit.createText(body, value, SWT.BORDER | SWT.PASSWORD);
 529                 text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
 530                 return text;
 531         }
 532
 533         /** Creates label and text. */
 534         Text createLT(FormToolkit toolkit, Composite body, String label,
 535                         String value) {
 536                 Label lbl = toolkit.createLabel(body, label);
 537                 lbl.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, false, false));
 538                 Text text = toolkit.createText(body, value, SWT.BORDER);
 539                 text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
 540                 return text;
 541         }
 542 }