org.argeo.cms.ui.workbench/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.cms.CmsException;
  22 import org.argeo.cms.util.useradmin.UserAdminUtils;
  23 import org.argeo.osgi.useradmin.LdifName;
  24 import org.argeo.security.ui.SecurityUiPlugin;
  25 import org.argeo.security.ui.admin.internal.UiUserAdminListener;
  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 = SecurityUiPlugin.PLUGIN_ID
  48                         + ".userEditor";
  49         public final static String GROUP_EDITOR_ID = SecurityUiPlugin.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 CmsException("Cannot add pages", e);
 117                 }
 118         }
 119
 120         @Override
 121         public void doSave(IProgressMonitor monitor) {
 122                 userAdminWrapper.beginTransactionIfNeeded();
 123                 commitPages(true);
 124                 userAdminWrapper.commitOrNotifyTransactionStateChange();
 125                 firePropertyChange(PROP_DIRTY);
 126                 userAdminWrapper.notifyListeners(new UserAdminEvent(null,
 127                                 UserAdminEvent.ROLE_REMOVED, user));
 128         }
 129
 130         @Override
 131         public void doSaveAs() {
 132         }
 133
 134         @Override
 135         public boolean isSaveAsAllowed() {
 136                 return false;
 137         }
 138
 139         @Override
 140         public void dispose() {
 141                 userAdminWrapper.removeListener(listener);
 142                 super.dispose();
 143         }
 144
 145         // CONTROLERS FOR THIS EDITOR AND ITS PAGES
 146
 147         private class NameChangeListener extends UiUserAdminListener {
 148
 149                 private final User user;
 150
 151                 public NameChangeListener(Display display, User user) {
 152                         super(display);
 153                         this.user = user;
 154                 }
 155
 156                 @Override
 157                 public void roleChangedToUiThread(UserAdminEvent event) {
 158                         Role changedRole = event.getRole();
 159                         if (changedRole == null || changedRole.equals(user))
 160                                 updateEditorTitle(null);
 161                 }
 162         }
 163
 164         class MainInfoListener extends UiUserAdminListener {
 165                 private final AbstractFormPart part;
 166
 167                 public MainInfoListener(Display display, AbstractFormPart part) {
 168                         super(display);
 169                         this.part = part;
 170                 }
 171
 172                 @Override
 173                 public void roleChangedToUiThread(UserAdminEvent event) {
 174                         // Rollback
 175                         if (event.getRole() == null)
 176                                 part.markStale();
 177                 }
 178         }
 179
 180         class GroupChangeListener extends UiUserAdminListener {
 181                 private final AbstractFormPart part;
 182
 183                 public GroupChangeListener(Display display, AbstractFormPart part) {
 184                         super(display);
 185                         this.part = part;
 186                 }
 187
 188                 @Override
 189                 public void roleChangedToUiThread(UserAdminEvent event) {
 190                         // always mark as stale
 191                         part.markStale();
 192                 }
 193         }
 194
 195         /** Registers a listener that will notify this part */
 196         class FormPartML implements ModifyListener {
 197                 private static final long serialVersionUID = 6299808129505381333L;
 198                 private AbstractFormPart formPart;
 199
 200                 public FormPartML(AbstractFormPart generalPart) {
 201                         this.formPart = generalPart;
 202                 }
 203
 204                 public void modifyText(ModifyEvent e) {
 205                         // Discard event when the control does not have the focus, typically
 206                         // to avoid all editors being marked as dirty during a Rollback
 207                         if (((Control) e.widget).isFocusControl())
 208                                 formPart.markDirty();
 209                 }
 210         }
 211
 212         /* DEPENDENCY INJECTION */
 213         public void setUserAdminWrapper(UserAdminWrapper userAdminWrapper) {
 214                 this.userAdminWrapper = userAdminWrapper;
 215                 this.userAdmin = userAdminWrapper.getUserAdmin();
 216         }
 217 }