org.argeo.security.ui.admin/src/org/argeo/security/ui/admin/internal/parts/GroupsView.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.List;
  20
  21 import org.apache.commons.logging.Log;
  22 import org.apache.commons.logging.LogFactory;
  23 import org.argeo.ArgeoException;
  24 import org.argeo.cms.auth.AuthConstants;
  25 import org.argeo.eclipse.ui.ColumnDefinition;
  26 import org.argeo.eclipse.ui.EclipseUiUtils;
  27 import org.argeo.eclipse.ui.parts.LdifUsersTable;
  28 import org.argeo.jcr.ArgeoNames;
  29 import org.argeo.osgi.useradmin.LdifName;
  30 import org.argeo.security.ui.admin.SecurityAdminPlugin;
  31 import org.argeo.security.ui.admin.internal.UiUserAdminListener;
  32 import org.argeo.security.ui.admin.internal.UserAdminUtils;
  33 import org.argeo.security.ui.admin.internal.UserAdminWrapper;
  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.UserDragListener;
  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.viewers.TableViewer;
  41 import org.eclipse.swt.SWT;
  42 import org.eclipse.swt.dnd.DND;
  43 import org.eclipse.swt.dnd.TextTransfer;
  44 import org.eclipse.swt.dnd.Transfer;
  45 import org.eclipse.swt.events.SelectionAdapter;
  46 import org.eclipse.swt.events.SelectionEvent;
  47 import org.eclipse.swt.layout.GridLayout;
  48 import org.eclipse.swt.widgets.Button;
  49 import org.eclipse.swt.widgets.Composite;
  50 import org.eclipse.swt.widgets.Display;
  51 import org.eclipse.ui.part.ViewPart;
  52 import org.osgi.framework.InvalidSyntaxException;
  53 import org.osgi.service.useradmin.Role;
  54 import org.osgi.service.useradmin.User;
  55 import org.osgi.service.useradmin.UserAdminEvent;
  56 import org.osgi.service.useradmin.UserAdminListener;
  57
  58 /** List all groups with filter */
  59 public class GroupsView extends ViewPart implements ArgeoNames {
  60         private final static Log log = LogFactory.getLog(GroupsView.class);
  61         public final static String ID = SecurityAdminPlugin.PLUGIN_ID
  62                         + ".groupsView";
  63
  64         /* DEPENDENCY INJECTION */
  65         private UserAdminWrapper userAdminWrapper;
  66
  67         // UI Objects
  68         private LdifUsersTable groupTableViewerCmp;
  69         private TableViewer userViewer;
  70         private List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
  71
  72         private UserAdminListener listener;
  73
  74         @Override
  75         public void createPartControl(Composite parent) {
  76                 parent.setLayout(EclipseUiUtils.noSpaceGridLayout());
  77
  78                 boolean isAdmin = UserAdminUtils.isUserInRole(AuthConstants.ROLE_ADMIN);
  79
  80                 // Define the displayed columns
  81                 columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 26));
  82                 columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Common Name",
  83                                 150));
  84                 columnDefs.add(new ColumnDefinition(new DomainNameLP(), "Domain", 200));
  85                 // Only show technical DN to admin
  86                 if (isAdmin)
  87                         columnDefs.add(new ColumnDefinition(new UserNameLP(),
  88                                         "Distinguished Name", 300));
  89
  90                 // Create and configure the table
  91                 groupTableViewerCmp = new MyUserTableViewer(parent, SWT.MULTI
  92                                 | SWT.H_SCROLL | SWT.V_SCROLL);
  93
  94                 groupTableViewerCmp.setColumnDefinitions(columnDefs);
  95                 if (isAdmin)
  96                         groupTableViewerCmp.populateWithStaticFilters(false, false);
  97                 else
  98                         groupTableViewerCmp.populate(true, false);
  99
 100                 groupTableViewerCmp.setLayoutData(EclipseUiUtils.fillAll());
 101
 102                 // Links
 103                 userViewer = groupTableViewerCmp.getTableViewer();
 104                 userViewer.addDoubleClickListener(new UserTableDefaultDClickListener());
 105                 getViewSite().setSelectionProvider(userViewer);
 106
 107                 // Really?
 108                 groupTableViewerCmp.refresh();
 109
 110                 // Drag and drop
 111                 int operations = DND.DROP_COPY | DND.DROP_MOVE;
 112                 Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
 113                 userViewer.addDragSupport(operations, tt, new UserDragListener(
 114                                 userViewer));
 115
 116                 // // Register a useradmin listener
 117                 // listener = new UserAdminListener() {
 118                 // @Override
 119                 // public void roleChanged(UserAdminEvent event) {
 120                 // if (userViewer != null && !userViewer.getTable().isDisposed())
 121                 // refresh();
 122                 // }
 123                 // };
 124                 // userAdminWrapper.addListener(listener);
 125                 // }
 126
 127                 // Register a useradmin listener
 128                 listener = new MyUiUAListener(parent.getDisplay());
 129                 userAdminWrapper.addListener(listener);
 130         }
 131
 132         private class MyUiUAListener extends UiUserAdminListener {
 133                 public MyUiUAListener(Display display) {
 134                         super(display);
 135                 }
 136
 137                 @Override
 138                 public void roleChangedToUiThread(UserAdminEvent event) {
 139                         if (userViewer != null && !userViewer.getTable().isDisposed())
 140                                 refresh();
 141                 }
 142         }
 143
 144         private class MyUserTableViewer extends LdifUsersTable {
 145                 private static final long serialVersionUID = 8467999509931900367L;
 146
 147                 private boolean showSystemRoles = false;
 148
 149                 private final String[] knownProps = { LdifName.uid.name(),
 150                                 LdifName.cn.name(), LdifName.dn.name() };
 151
 152                 public MyUserTableViewer(Composite parent, int style) {
 153                         super(parent, style);
 154                 }
 155
 156                 protected void populateStaticFilters(Composite staticFilterCmp) {
 157                         staticFilterCmp.setLayout(new GridLayout());
 158                         final Button showSystemRoleBtn = new Button(staticFilterCmp,
 159                                         SWT.CHECK);
 160                         showSystemRoleBtn.setText("Show system roles");
 161                         showSystemRoleBtn.addSelectionListener(new SelectionAdapter() {
 162                                 private static final long serialVersionUID = -7033424592697691676L;
 163
 164                                 @Override
 165                                 public void widgetSelected(SelectionEvent e) {
 166                                         showSystemRoles = showSystemRoleBtn.getSelection();
 167                                         refresh();
 168                                 }
 169
 170                         });
 171                 }
 172
 173                 @Override
 174                 protected List<User> listFilteredElements(String filter) {
 175                         Role[] roles;
 176                         try {
 177                                 StringBuilder builder = new StringBuilder();
 178                                 StringBuilder tmpBuilder = new StringBuilder();
 179                                 if (EclipseUiUtils.notEmpty(filter))
 180                                         for (String prop : knownProps) {
 181                                                 tmpBuilder.append("(");
 182                                                 tmpBuilder.append(prop);
 183                                                 tmpBuilder.append("=*");
 184                                                 tmpBuilder.append(filter);
 185                                                 tmpBuilder.append("*)");
 186                                         }
 187                                 if (tmpBuilder.length() > 1) {
 188                                         builder.append("(&(").append(LdifName.objectClass.name())
 189                                                         .append("=").append(LdifName.groupOfNames.name())
 190                                                         .append(")");
 191                                         if (!showSystemRoles)
 192                                                 builder.append("(!(").append(LdifName.dn.name())
 193                                                                 .append("=*")
 194                                                                 .append(AuthConstants.ROLES_BASEDN)
 195                                                                 .append("))");
 196                                         builder.append("(|");
 197                                         builder.append(tmpBuilder.toString());
 198                                         builder.append("))");
 199                                 } else {
 200                                         if (!showSystemRoles)
 201                                                 builder.append("(&(")
 202                                                                 .append(LdifName.objectClass.name())
 203                                                                 .append("=")
 204                                                                 .append(LdifName.groupOfNames.name())
 205                                                                 .append(")(!(").append(LdifName.dn.name())
 206                                                                 .append("=*")
 207                                                                 .append(AuthConstants.ROLES_BASEDN)
 208                                                                 .append(")))");
 209                                         else
 210                                                 builder.append("(").append(LdifName.objectClass.name())
 211                                                                 .append("=")
 212                                                                 .append(LdifName.groupOfNames.name())
 213                                                                 .append(")");
 214
 215                                 }
 216                                 roles = userAdminWrapper.getUserAdmin().getRoles(
 217                                                 builder.toString());
 218                         } catch (InvalidSyntaxException e) {
 219                                 throw new ArgeoException("Unable to get roles with filter: "
 220                                                 + filter, e);
 221                         }
 222                         List<User> users = new ArrayList<User>();
 223                         for (Role role : roles)
 224                                 if (!users.contains(role))
 225                                         users.add((User) role);
 226                                 else
 227                                         log.warn("Duplicated role: " + role);
 228
 229                         return users;
 230                 }
 231         }
 232
 233         public void refresh() {
 234                 groupTableViewerCmp.refresh();
 235         }
 236
 237         // Override generic view methods
 238         @Override
 239         public void dispose() {
 240                 userAdminWrapper.removeListener(listener);
 241                 super.dispose();
 242         }
 243
 244         @Override
 245         public void setFocus() {
 246                 groupTableViewerCmp.setFocus();
 247         }
 248
 249         /* DEPENDENCY INJECTION */
 250         public void setUserAdminWrapper(UserAdminWrapper userAdminWrapper) {
 251                 this.userAdminWrapper = userAdminWrapper;
 252         }
 253 }