org.argeo.cms.ui.workbench/src/org/argeo/cms/ui/workbench/internal/useradmin/parts/GroupMainPage.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.cms.ui.workbench.internal.useradmin.parts;
  17
  18 import static org.argeo.cms.util.UserAdminUtils.setProperty;
  19 import static org.argeo.naming.LdapAttrs.businessCategory;
  20 import static org.argeo.naming.LdapAttrs.description;
  21 import static org.argeo.node.NodeInstance.WORKGROUP;
  22
  23 import java.util.ArrayList;
  24 import java.util.Iterator;
  25 import java.util.List;
  26
  27 import javax.jcr.Node;
  28 import javax.jcr.Repository;
  29 import javax.jcr.RepositoryException;
  30 import javax.jcr.Session;
  31 import javax.naming.InvalidNameException;
  32 import javax.naming.ldap.LdapName;
  33 import javax.transaction.UserTransaction;
  34
  35 import org.argeo.cms.ArgeoNames;
  36 import org.argeo.cms.CmsException;
  37 import org.argeo.cms.ui.workbench.CmsWorkbenchStyles;
  38 import org.argeo.cms.ui.workbench.internal.useradmin.SecurityAdminImages;
  39 import org.argeo.cms.ui.workbench.internal.useradmin.UserAdminWrapper;
  40 import org.argeo.cms.ui.workbench.internal.useradmin.parts.UserEditor.GroupChangeListener;
  41 import org.argeo.cms.ui.workbench.internal.useradmin.parts.UserEditor.MainInfoListener;
  42 import org.argeo.cms.ui.workbench.internal.useradmin.providers.CommonNameLP;
  43 import org.argeo.cms.ui.workbench.internal.useradmin.providers.MailLP;
  44 import org.argeo.cms.ui.workbench.internal.useradmin.providers.RoleIconLP;
  45 import org.argeo.cms.ui.workbench.internal.useradmin.providers.UserFilter;
  46 import org.argeo.cms.ui.workbench.internal.useradmin.providers.UserTableDefaultDClickListener;
  47 import org.argeo.cms.util.CmsUtils;
  48 import org.argeo.cms.util.UserAdminUtils;
  49 import org.argeo.eclipse.ui.ColumnDefinition;
  50 import org.argeo.eclipse.ui.EclipseUiUtils;
  51 import org.argeo.eclipse.ui.parts.LdifUsersTable;
  52 import org.argeo.jcr.JcrUtils;
  53 import org.argeo.naming.LdapAttrs;
  54 import org.argeo.node.NodeInstance;
  55 import org.argeo.node.NodeUtils;
  56 import org.eclipse.jface.action.Action;
  57 import org.eclipse.jface.action.ToolBarManager;
  58 import org.eclipse.jface.dialogs.MessageDialog;
  59 import org.eclipse.jface.resource.ImageDescriptor;
  60 import org.eclipse.jface.viewers.ISelection;
  61 import org.eclipse.jface.viewers.IStructuredSelection;
  62 import org.eclipse.jface.viewers.TableViewer;
  63 import org.eclipse.jface.viewers.ViewerDropAdapter;
  64 import org.eclipse.swt.SWT;
  65 import org.eclipse.swt.dnd.DND;
  66 import org.eclipse.swt.dnd.DropTargetEvent;
  67 import org.eclipse.swt.dnd.TextTransfer;
  68 import org.eclipse.swt.dnd.Transfer;
  69 import org.eclipse.swt.dnd.TransferData;
  70 import org.eclipse.swt.events.DisposeEvent;
  71 import org.eclipse.swt.events.DisposeListener;
  72 import org.eclipse.swt.events.ModifyListener;
  73 import org.eclipse.swt.events.SelectionAdapter;
  74 import org.eclipse.swt.events.SelectionEvent;
  75 import org.eclipse.swt.graphics.Cursor;
  76 import org.eclipse.swt.layout.GridData;
  77 import org.eclipse.swt.layout.GridLayout;
  78 import org.eclipse.swt.widgets.Composite;
  79 import org.eclipse.swt.widgets.Label;
  80 import org.eclipse.swt.widgets.Link;
  81 import org.eclipse.swt.widgets.Shell;
  82 import org.eclipse.swt.widgets.Text;
  83 import org.eclipse.swt.widgets.ToolBar;
  84 import org.eclipse.ui.forms.AbstractFormPart;
  85 import org.eclipse.ui.forms.IManagedForm;
  86 import org.eclipse.ui.forms.SectionPart;
  87 import org.eclipse.ui.forms.editor.FormEditor;
  88 import org.eclipse.ui.forms.editor.FormPage;
  89 import org.eclipse.ui.forms.widgets.FormToolkit;
  90 import org.eclipse.ui.forms.widgets.ScrolledForm;
  91 import org.eclipse.ui.forms.widgets.Section;
  92 import org.osgi.service.useradmin.Group;
  93 import org.osgi.service.useradmin.Role;
  94 import org.osgi.service.useradmin.User;
  95 import org.osgi.service.useradmin.UserAdmin;
  96 import org.osgi.service.useradmin.UserAdminEvent;
  97
  98 /** Display/edit main properties of a given group */
  99 public class GroupMainPage extends FormPage implements ArgeoNames {
 100         final static String ID = "GroupEditor.mainPage";
 101
 102         private final UserEditor editor;
 103         private final NodeInstance nodeInstance;
 104         private final UserAdminWrapper userAdminWrapper;
 105         private final Session session;
 106
 107         public GroupMainPage(FormEditor editor, UserAdminWrapper userAdminWrapper, Repository repository,
 108                         NodeInstance nodeInstance) {
 109                 super(editor, ID, "Main");
 110                 try {
 111                         session = repository.login();
 112                 } catch (RepositoryException e) {
 113                         throw new CmsException("Cannot retrieve session of in MainGroupPage constructor", e);
 114                 }
 115                 this.editor = (UserEditor) editor;
 116                 this.userAdminWrapper = userAdminWrapper;
 117                 this.nodeInstance = nodeInstance;
 118         }
 119
 120         protected void createFormContent(final IManagedForm mf) {
 121                 ScrolledForm form = mf.getForm();
 122                 Composite body = form.getBody();
 123                 GridLayout mainLayout = new GridLayout();
 124                 body.setLayout(mainLayout);
 125                 Group group = (Group) editor.getDisplayedUser();
 126                 appendOverviewPart(body, group);
 127                 appendMembersPart(body, group);
 128         }
 129
 130         @Override
 131         public void dispose() {
 132                 JcrUtils.logoutQuietly(session);
 133                 super.dispose();
 134         }
 135
 136         /** Creates the general section */
 137         protected void appendOverviewPart(final Composite parent, final Group group) {
 138                 FormToolkit tk = getManagedForm().getToolkit();
 139                 Composite body = addSection(tk, parent);
 140                 // GridLayout layout = new GridLayout(5, false);
 141                 GridLayout layout = new GridLayout(2, false);
 142                 body.setLayout(layout);
 143
 144                 String cn = UserAdminUtils.getProperty(group, LdapAttrs.cn.name());
 145                 createReadOnlyLT(body, "Name", cn);
 146                 // Text dnTxt = createReadOnlyLT(body, "DN", group.getName());
 147                 createReadOnlyLT(body, "Domain", UserAdminUtils.getDomainName(group));
 148
 149                 // Description
 150                 Label descLbl = new Label(body, SWT.LEAD);
 151                 descLbl.setFont(EclipseUiUtils.getBoldFont(body));
 152                 descLbl.setText("Description");
 153                 descLbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false, 2, 1));
 154                 final Text descTxt = new Text(body, SWT.LEAD | SWT.MULTI | SWT.WRAP | SWT.BORDER);
 155                 GridData gd = EclipseUiUtils.fillAll();
 156                 gd.heightHint = 50;
 157                 gd.horizontalSpan = 2;
 158                 descTxt.setLayoutData(gd);
 159
 160                 // Mark as workgroup
 161                 Link markAsWorkgroupLk = new Link(body, SWT.NONE);
 162                 markAsWorkgroupLk.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false, 2, 1));
 163
 164                 // create form part (controller)
 165                 final AbstractFormPart part = new SectionPart((Section) body.getParent()) {
 166
 167                         private MainInfoListener listener;
 168
 169                         @Override
 170                         public void initialize(IManagedForm form) {
 171                                 super.initialize(form);
 172                                 listener = editor.new MainInfoListener(parent.getDisplay(), this);
 173                                 userAdminWrapper.addListener(listener);
 174                         }
 175
 176                         @Override
 177                         public void dispose() {
 178                                 userAdminWrapper.removeListener(listener);
 179                                 super.dispose();
 180                         }
 181
 182                         public void commit(boolean onSave) {
 183                                 // group.getProperties().put(LdapAttrs.description.name(), descTxt.getText());
 184                                 setProperty(group, description, descTxt.getText());
 185                                 super.commit(onSave);
 186                         }
 187
 188                         @Override
 189                         public void refresh() {
 190                                 // dnTxt.setText(group.getName());
 191                                 // cnTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.cn.name()));
 192                                 descTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.description.name()));
 193                                 Node workgroupHome = NodeUtils.getGroupHome(session, cn);
 194                                 if (workgroupHome == null)
 195                                         markAsWorkgroupLk.setText("<a>Mark as workgroup</a>");
 196                                 else
 197                                         markAsWorkgroupLk.setText("Configured as workgroup");
 198                                 parent.layout(true, true);
 199                                 super.refresh();
 200                         }
 201                 };
 202
 203                 markAsWorkgroupLk.addSelectionListener(new SelectionAdapter() {
 204                         private static final long serialVersionUID = -6439340898096365078L;
 205
 206                         @Override
 207                         public void widgetSelected(SelectionEvent e) {
 208
 209                                 boolean confirmed = MessageDialog.openConfirm(parent.getShell(), "Mark as workgroup",
 210                                                 "Are you sure you want to mark " + cn + " as being a workgroup? ");
 211                                 if (confirmed) {
 212                                         Node workgroupHome = NodeUtils.getGroupHome(session, cn);
 213                                         if (workgroupHome != null)
 214                                                 return; // already marked as workgroup, do nothing
 215                                         else
 216                                                 try {
 217                                                         nodeInstance.createWorkgroup(new LdapName(group.getName()));
 218                                                         setProperty(group, businessCategory, WORKGROUP);
 219                                                         part.refresh();
 220                                                 } catch (InvalidNameException e1) {
 221                                                         throw new CmsException("Cannot create Workgroup for " + group.toString(), e1);
 222                                                 }
 223
 224                                 }
 225                         }
 226                 });
 227
 228                 ModifyListener defaultListener = editor.new FormPartML(part);
 229                 descTxt.addModifyListener(defaultListener);
 230                 getManagedForm().addPart(part);
 231         }
 232
 233         /** Filtered table with members. Has drag and drop ability */
 234         protected void appendMembersPart(Composite parent, Group group) {
 235                 FormToolkit tk = getManagedForm().getToolkit();
 236                 Section section = tk.createSection(parent, Section.TITLE_BAR);
 237                 section.setText("Members");
 238                 section.setLayoutData(EclipseUiUtils.fillAll());
 239
 240                 Composite body = new Composite(section, SWT.NO_FOCUS);
 241                 section.setClient(body);
 242                 body.setLayoutData(EclipseUiUtils.fillAll());
 243
 244                 LdifUsersTable userTableViewerCmp = createMemberPart(body, group);
 245
 246                 SectionPart part = new GroupMembersPart(section, userTableViewerCmp);
 247                 getManagedForm().addPart(part);
 248                 addRemoveAbitily(part, userTableViewerCmp.getTableViewer(), group);
 249         }
 250
 251         public LdifUsersTable createMemberPart(Composite parent, Group group) {
 252                 parent.setLayout(EclipseUiUtils.noSpaceGridLayout());
 253
 254                 // Define the displayed columns
 255                 List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
 256                 columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
 257                 columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
 258                 columnDefs.add(new ColumnDefinition(new MailLP(), "Mail", 150));
 259                 // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name",
 260                 // 240));
 261
 262                 // Create and configure the table
 263                 LdifUsersTable userViewerCmp = new MyUserTableViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL,
 264                                 userAdminWrapper.getUserAdmin());
 265
 266                 userViewerCmp.setColumnDefinitions(columnDefs);
 267                 userViewerCmp.populate(true, false);
 268                 userViewerCmp.setLayoutData(EclipseUiUtils.fillAll());
 269
 270                 // Controllers
 271                 TableViewer userViewer = userViewerCmp.getTableViewer();
 272                 userViewer.addDoubleClickListener(new UserTableDefaultDClickListener());
 273                 int operations = DND.DROP_COPY | DND.DROP_MOVE;
 274                 Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
 275                 userViewer.addDropSupport(operations, tt,
 276                                 new GroupDropListener(userAdminWrapper, userViewerCmp, (Group) editor.getDisplayedUser()));
 277
 278                 return userViewerCmp;
 279         }
 280
 281         // Local viewers
 282         private class MyUserTableViewer extends LdifUsersTable {
 283                 private static final long serialVersionUID = 8467999509931900367L;
 284
 285                 private final UserFilter userFilter;
 286
 287                 public MyUserTableViewer(Composite parent, int style, UserAdmin userAdmin) {
 288                         super(parent, style, true);
 289                         userFilter = new UserFilter();
 290
 291                 }
 292
 293                 @Override
 294                 protected List<User> listFilteredElements(String filter) {
 295                         // reload user and set it in the editor
 296                         Group group = (Group) editor.getDisplayedUser();
 297                         Role[] roles = group.getMembers();
 298                         List<User> users = new ArrayList<User>();
 299                         userFilter.setSearchText(filter);
 300                         // userFilter.setShowSystemRole(true);
 301                         for (Role role : roles)
 302                                 // if (role.getType() == Role.GROUP)
 303                                 if (userFilter.select(null, null, role))
 304                                         users.add((User) role);
 305                         return users;
 306                 }
 307         }
 308
 309         private void addRemoveAbitily(SectionPart sectionPart, TableViewer userViewer, Group group) {
 310                 Section section = sectionPart.getSection();
 311                 ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
 312                 ToolBar toolbar = toolBarManager.createControl(section);
 313                 final Cursor handCursor = new Cursor(section.getDisplay(), SWT.CURSOR_HAND);
 314                 toolbar.setCursor(handCursor);
 315                 toolbar.addDisposeListener(new DisposeListener() {
 316                         private static final long serialVersionUID = 3882131405820522925L;
 317
 318                         public void widgetDisposed(DisposeEvent e) {
 319                                 if ((handCursor != null) && (handCursor.isDisposed() == false)) {
 320                                         handCursor.dispose();
 321                                 }
 322                         }
 323                 });
 324
 325                 Action action = new RemoveMembershipAction(userViewer, group, "Remove selected items from this group",
 326                                 SecurityAdminImages.ICON_REMOVE_DESC);
 327                 toolBarManager.add(action);
 328                 toolBarManager.update(true);
 329                 section.setTextClient(toolbar);
 330         }
 331
 332         private class RemoveMembershipAction extends Action {
 333                 private static final long serialVersionUID = -1337713097184522588L;
 334
 335                 private final TableViewer userViewer;
 336                 private final Group group;
 337
 338                 RemoveMembershipAction(TableViewer userViewer, Group group, String name, ImageDescriptor img) {
 339                         super(name, img);
 340                         this.userViewer = userViewer;
 341                         this.group = group;
 342                 }
 343
 344                 @Override
 345                 public void run() {
 346                         ISelection selection = userViewer.getSelection();
 347                         if (selection.isEmpty())
 348                                 return;
 349
 350                         @SuppressWarnings("unchecked")
 351                         Iterator<User> it = ((IStructuredSelection) selection).iterator();
 352                         List<User> users = new ArrayList<User>();
 353                         while (it.hasNext()) {
 354                                 User currUser = it.next();
 355                                 users.add(currUser);
 356                         }
 357
 358                         userAdminWrapper.beginTransactionIfNeeded();
 359                         for (User user : users) {
 360                                 group.removeMember(user);
 361                         }
 362                         userAdminWrapper.commitOrNotifyTransactionStateChange();
 363                         userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, group));
 364                 }
 365         }
 366
 367         // LOCAL CONTROLLERS
 368         private class GroupMembersPart extends SectionPart {
 369                 private final LdifUsersTable userViewer;
 370                 // private final Group group;
 371
 372                 private GroupChangeListener listener;
 373
 374                 public GroupMembersPart(Section section, LdifUsersTable userViewer) {
 375                         super(section);
 376                         this.userViewer = userViewer;
 377                         // this.group = group;
 378                 }
 379
 380                 @Override
 381                 public void initialize(IManagedForm form) {
 382                         super.initialize(form);
 383                         listener = editor.new GroupChangeListener(userViewer.getDisplay(), GroupMembersPart.this);
 384                         userAdminWrapper.addListener(listener);
 385                 }
 386
 387                 @Override
 388                 public void dispose() {
 389                         userAdminWrapper.removeListener(listener);
 390                         super.dispose();
 391                 }
 392
 393                 @Override
 394                 public void refresh() {
 395                         userViewer.refresh();
 396                         super.refresh();
 397                 }
 398         }
 399
 400         /**
 401          * Defines this table as being a potential target to add group membership
 402          * (roles) to this group
 403          */
 404         private class GroupDropListener extends ViewerDropAdapter {
 405                 private static final long serialVersionUID = 2893468717831451621L;
 406
 407                 private final UserAdminWrapper userAdminWrapper;
 408                 // private final LdifUsersTable myUserViewerCmp;
 409                 private final Group myGroup;
 410
 411                 public GroupDropListener(UserAdminWrapper userAdminWrapper, LdifUsersTable userTableViewerCmp, Group group) {
 412                         super(userTableViewerCmp.getTableViewer());
 413                         this.userAdminWrapper = userAdminWrapper;
 414                         this.myGroup = group;
 415                         // this.myUserViewerCmp = userTableViewerCmp;
 416                 }
 417
 418                 @Override
 419                 public boolean validateDrop(Object target, int operation, TransferData transferType) {
 420                         // Target is always OK in a list only view
 421                         // TODO check if not a string
 422                         boolean validDrop = true;
 423                         return validDrop;
 424                 }
 425
 426                 @Override
 427                 public void drop(DropTargetEvent event) {
 428                         // TODO Is there an opportunity to perform the check before?
 429                         String newUserName = (String) event.data;
 430                         UserAdmin myUserAdmin = userAdminWrapper.getUserAdmin();
 431                         Role role = myUserAdmin.getRole(newUserName);
 432                         if (role.getType() == Role.GROUP) {
 433                                 Group newGroup = (Group) role;
 434                                 Shell shell = getViewer().getControl().getShell();
 435                                 // Sanity checks
 436                                 if (myGroup == newGroup) { // Equality
 437                                         MessageDialog.openError(shell, "Forbidden addition ", "A group cannot be a member of itself.");
 438                                         return;
 439                                 }
 440
 441                                 // Cycle
 442                                 String myName = myGroup.getName();
 443                                 List<User> myMemberships = editor.getFlatGroups(myGroup);
 444                                 if (myMemberships.contains(newGroup)) {
 445                                         MessageDialog.openError(shell, "Forbidden addition: cycle",
 446                                                         "Cannot add " + newUserName + " to group " + myName + ". This would create a cycle");
 447                                         return;
 448                                 }
 449
 450                                 // Already member
 451                                 List<User> newGroupMemberships = editor.getFlatGroups(newGroup);
 452                                 if (newGroupMemberships.contains(myGroup)) {
 453                                         MessageDialog.openError(shell, "Forbidden addition",
 454                                                         "Cannot add " + newUserName + " to group " + myName + ", this membership already exists");
 455                                         return;
 456                                 }
 457                                 userAdminWrapper.beginTransactionIfNeeded();
 458                                 myGroup.addMember(newGroup);
 459                                 userAdminWrapper.commitOrNotifyTransactionStateChange();
 460                                 userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, myGroup));
 461                         } else if (role.getType() == Role.USER) {
 462                                 // TODO check if the group is already member of this group
 463                                 UserTransaction transaction = userAdminWrapper.beginTransactionIfNeeded();
 464                                 User user = (User) role;
 465                                 myGroup.addMember(user);
 466                                 if (UserAdminWrapper.COMMIT_ON_SAVE)
 467                                         try {
 468                                                 transaction.commit();
 469                                         } catch (Exception e) {
 470                                                 throw new CmsException("Cannot commit transaction " + "after user group membership update", e);
 471                                         }
 472                                 userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, myGroup));
 473                         }
 474                         super.drop(event);
 475                 }
 476
 477                 @Override
 478                 public boolean performDrop(Object data) {
 479                         // myUserViewerCmp.refresh();
 480                         return true;
 481                 }
 482         }
 483
 484         // LOCAL HELPERS
 485         private Composite addSection(FormToolkit tk, Composite parent) {
 486                 Section section = tk.createSection(parent, SWT.NO_FOCUS);
 487                 section.setLayoutData(EclipseUiUtils.fillWidth());
 488                 Composite body = tk.createComposite(section, SWT.WRAP);
 489                 body.setLayoutData(EclipseUiUtils.fillAll());
 490                 section.setClient(body);
 491                 return body;
 492         }
 493
 494         /** Creates label and text. */
 495         // private Text createLT(Composite parent, String label, String value) {
 496         // FormToolkit toolkit = getManagedForm().getToolkit();
 497         // Label lbl = toolkit.createLabel(parent, label);
 498         // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
 499         // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
 500         // Text text = toolkit.createText(parent, value, SWT.BORDER);
 501         // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
 502         // CmsUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
 503         // return text;
 504         // }
 505         //
 506         Text createReadOnlyLT(Composite parent, String label, String value) {
 507                 FormToolkit toolkit = getManagedForm().getToolkit();
 508                 Label lbl = toolkit.createLabel(parent, label);
 509                 lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
 510                 lbl.setFont(EclipseUiUtils.getBoldFont(parent));
 511                 Text text = toolkit.createText(parent, value, SWT.NONE);
 512                 text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
 513                 text.setEditable(false);
 514                 CmsUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
 515                 return text;
 516         }
 517
 518 }