org.argeo.security.ui.admin/src/org/argeo/security/ui/admin/internal/parts/UserEditor.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.argeo.ArgeoException;
  22 import org.argeo.osgi.useradmin.LdifName;
  23 import org.argeo.security.ui.admin.SecurityAdminPlugin;
  24 import org.argeo.security.ui.admin.internal.UiUserAdminListener;
  25 import org.argeo.security.ui.admin.internal.UserAdminUtils;
  26 import org.argeo.security.ui.admin.internal.UserAdminWrapper;
  27 import org.eclipse.core.runtime.IProgressMonitor;
  28 import org.eclipse.swt.events.ModifyEvent;
  29 import org.eclipse.swt.events.ModifyListener;
  30 import org.eclipse.swt.widgets.Control;
  31 import org.eclipse.swt.widgets.Display;
  32 import org.eclipse.ui.IEditorInput;
  33 import org.eclipse.ui.IEditorSite;
  34 import org.eclipse.ui.PartInitException;
  35 import org.eclipse.ui.forms.AbstractFormPart;
  36 import org.eclipse.ui.forms.editor.FormEditor;
  37 import org.osgi.service.useradmin.Authorization;
  38 import org.osgi.service.useradmin.Role;
  39 import org.osgi.service.useradmin.User;
  40 import org.osgi.service.useradmin.UserAdmin;
  41 import org.osgi.service.useradmin.UserAdminEvent;
  42
  43 /** Editor for a user, might be a user or a group. */
  44 public class UserEditor extends FormEditor {
  45         private static final long serialVersionUID = 8357851520380820241L;
  46
  47         public final static String USER_EDITOR_ID = SecurityAdminPlugin.PLUGIN_ID
  48                         + ".userEditor";
  49         public final static String GROUP_EDITOR_ID = SecurityAdminPlugin.PLUGIN_ID
  50                         + ".groupEditor";
  51
  52         /* DEPENDENCY INJECTION */
  53         private UserAdminWrapper userAdminWrapper;
  54         private UserAdmin userAdmin;
  55
  56         // Context
  57         private User user;
  58         private String username;
  59
  60         private NameChangeListener listener;
  61
  62         public void init(IEditorSite site, IEditorInput input)
  63                         throws PartInitException {
  64                 super.init(site, input);
  65                 username = ((UserEditorInput) getEditorInput()).getUsername();
  66                 user = (User) userAdmin.getRole(username);
  67
  68                 listener = new NameChangeListener(site.getShell().getDisplay(), user);
  69                 userAdminWrapper.addListener(listener);
  70                 updateEditorTitle(null);
  71         }
  72
  73         /**
  74          * returns the list of all authorization for the given user or of the
  75          * current displayed user if parameter is null
  76          */
  77         protected List<User> getFlatGroups(User aUser) {
  78                 Authorization currAuth;
  79                 if (aUser == null)
  80                         currAuth = userAdmin.getAuthorization(this.user);
  81                 else
  82                         currAuth = userAdmin.getAuthorization(aUser);
  83
  84                 String[] roles = currAuth.getRoles();
  85
  86                 List<User> groups = new ArrayList<User>();
  87                 for (String roleStr : roles) {
  88                         User currRole = (User) userAdmin.getRole(roleStr);
  89                         if (!groups.contains(currRole))
  90                                 groups.add(currRole);
  91                 }
  92                 return groups;
  93         }
  94
  95         /** Exposes the user (or group) that is displayed by the current editor */
  96         protected User getDisplayedUser() {
  97                 return user;
  98         }
  99
 100         void updateEditorTitle(String title) {
 101                 if (title == null) {
 102                         String commonName = UserAdminUtils.getProperty(user,
 103                                         LdifName.cn.name());
 104                         title = "".equals(commonName) ? user.getName() : commonName;
 105                 }
 106                 setPartName(title);
 107         }
 108
 109         protected void addPages() {
 110                 try {
 111                         if (user.getType() == Role.GROUP)
 112                                 addPage(new GroupMainPage(this, userAdminWrapper));
 113                         else
 114                                 addPage(new UserMainPage(this, userAdminWrapper));
 115                 } catch (Exception e) {
 116                         throw new ArgeoException("Cannot add pages", e);
 117                 }
 118         }
 119
 120         @Override
 121         public void doSave(IProgressMonitor monitor) {
 122                 userAdminWrapper.beginTransactionIfNeeded();
 123                 commitPages(true);
 124                 firePropertyChange(PROP_DIRTY);
 125                 userAdminWrapper.notifyListeners(new UserAdminEvent(null,
 126                                 UserAdminEvent.ROLE_REMOVED, user));
 127         }
 128
 129         @Override
 130         public void doSaveAs() {
 131         }
 132
 133         @Override
 134         public boolean isSaveAsAllowed() {
 135                 return false;
 136         }
 137
 138         @Override
 139         public void dispose() {
 140                 userAdminWrapper.removeListener(listener);
 141                 super.dispose();
 142         }
 143
 144         // CONTROLERS FOR THIS EDITOR AND ITS PAGES
 145
 146         private class NameChangeListener extends UiUserAdminListener {
 147
 148                 private final User user;
 149
 150                 public NameChangeListener(Display display, User user) {
 151                         super(display);
 152                         this.user = user;
 153                 }
 154
 155                 @Override
 156                 public void roleChangedToUiThread(UserAdminEvent event) {
 157                         Role changedRole = event.getRole();
 158                         if (changedRole == null || changedRole.equals(user))
 159                                 updateEditorTitle(null);
 160                 }
 161         }
 162
 163         class MainInfoListener extends UiUserAdminListener {
 164                 private final AbstractFormPart part;
 165
 166                 public MainInfoListener(Display display, AbstractFormPart part) {
 167                         super(display);
 168                         this.part = part;
 169                 }
 170
 171                 @Override
 172                 public void roleChangedToUiThread(UserAdminEvent event) {
 173                         // Rollback
 174                         if (event.getRole() == null)
 175                                 part.markStale();
 176                 }
 177         }
 178
 179         class GroupChangeListener extends UiUserAdminListener {
 180                 private final AbstractFormPart part;
 181
 182                 public GroupChangeListener(Display display, AbstractFormPart part) {
 183                         super(display);
 184                         this.part = part;
 185                 }
 186
 187                 @Override
 188                 public void roleChangedToUiThread(UserAdminEvent event) {
 189                         // always mark as stale
 190                         part.markStale();
 191                 }
 192         }
 193
 194         /** Registers a listener that will notify this part */
 195         class FormPartML implements ModifyListener {
 196                 private static final long serialVersionUID = 6299808129505381333L;
 197                 private AbstractFormPart formPart;
 198
 199                 public FormPartML(AbstractFormPart generalPart) {
 200                         this.formPart = generalPart;
 201                 }
 202
 203                 public void modifyText(ModifyEvent e) {
 204                         // Discard event when the control does not have the focus, typically
 205                         // to avoid all editors being marked as dirty during a Rollback
 206                         if (((Control) e.widget).isFocusControl())
 207                                 formPart.markDirty();
 208                 }
 209         }
 210
 211         /* DEPENDENCY INJECTION */
 212         public void setUserAdminWrapper(UserAdminWrapper userAdminWrapper) {
 213                 this.userAdminWrapper = userAdminWrapper;
 214                 this.userAdmin = userAdminWrapper.getUserAdmin();
 215         }
 216 }