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