org.argeo.cms.ui.workbench/src/org/argeo/cms/ui/workbench/internal/useradmin/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.cms.ui.workbench.internal.useradmin.parts;
  17
  18 import java.util.ArrayList;
  19 import java.util.List;
  20
  21 import javax.jcr.Repository;
  22
  23 import org.argeo.cms.CmsException;
  24 import org.argeo.cms.ui.workbench.WorkbenchUiPlugin;
  25 import org.argeo.cms.ui.workbench.internal.useradmin.UiUserAdminListener;
  26 import org.argeo.cms.ui.workbench.internal.useradmin.UserAdminWrapper;
  27 import org.argeo.cms.util.UserAdminUtils;
  28 import org.argeo.naming.LdapAttrs;
  29 import org.eclipse.core.runtime.IProgressMonitor;
  30 import org.eclipse.swt.events.ModifyEvent;
  31 import org.eclipse.swt.events.ModifyListener;
  32 import org.eclipse.swt.widgets.Control;
  33 import org.eclipse.swt.widgets.Display;
  34 import org.eclipse.ui.IEditorInput;
  35 import org.eclipse.ui.IEditorSite;
  36 import org.eclipse.ui.PartInitException;
  37 import org.eclipse.ui.forms.AbstractFormPart;
  38 import org.eclipse.ui.forms.editor.FormEditor;
  39 import org.osgi.service.useradmin.Authorization;
  40 import org.osgi.service.useradmin.Role;
  41 import org.osgi.service.useradmin.User;
  42 import org.osgi.service.useradmin.UserAdmin;
  43 import org.osgi.service.useradmin.UserAdminEvent;
  44
  45 /** Editor for a user, might be a user or a group. */
  46 public class UserEditor extends FormEditor {
  47         private static final long serialVersionUID = 8357851520380820241L;
  48
  49         public final static String USER_EDITOR_ID = WorkbenchUiPlugin.PLUGIN_ID + ".userEditor";
  50         public final static String GROUP_EDITOR_ID = WorkbenchUiPlugin.PLUGIN_ID + ".groupEditor";
  51
  52         /* DEPENDENCY INJECTION */
  53         private Repository repository;
  54         private UserAdminWrapper userAdminWrapper;
  55         private UserAdmin userAdmin;
  56
  57
  58         // Context
  59         private User user;
  60         private String username;
  61
  62         private NameChangeListener listener;
  63
  64         public void init(IEditorSite site, IEditorInput input) throws PartInitException {
  65                 super.init(site, input);
  66                 this.userAdmin = userAdminWrapper.getUserAdmin();
  67                 username = ((UserEditorInput) getEditorInput()).getUsername();
  68                 user = (User) userAdmin.getRole(username);
  69
  70                 listener = new NameChangeListener(site.getShell().getDisplay(), user);
  71                 userAdminWrapper.addListener(listener);
  72                 updateEditorTitle(null);
  73         }
  74
  75         /**
  76          * returns the list of all authorization for the given user or of the
  77          * current displayed user if parameter is null
  78          */
  79         protected List<User> getFlatGroups(User aUser) {
  80                 Authorization currAuth;
  81                 if (aUser == null)
  82                         currAuth = userAdmin.getAuthorization(this.user);
  83                 else
  84                         currAuth = userAdmin.getAuthorization(aUser);
  85
  86                 String[] roles = currAuth.getRoles();
  87
  88                 List<User> groups = new ArrayList<User>();
  89                 for (String roleStr : roles) {
  90                         User currRole = (User) userAdmin.getRole(roleStr);
  91                         if (!groups.contains(currRole))
  92                                 groups.add(currRole);
  93                 }
  94                 return groups;
  95         }
  96
  97         /** Exposes the user (or group) that is displayed by the current editor */
  98         protected User getDisplayedUser() {
  99                 return user;
 100         }
 101
 102         void updateEditorTitle(String title) {
 103                 if (title == null) {
 104                         String commonName = UserAdminUtils.getProperty(user, LdapAttrs.cn.name());
 105                         title = "".equals(commonName) ? user.getName() : commonName;
 106                 }
 107                 setPartName(title);
 108         }
 109
 110         protected void addPages() {
 111                 try {
 112                         if (user.getType() == Role.GROUP)
 113                                 addPage(new GroupMainPage(this, userAdminWrapper, repository));
 114                         else
 115                                 addPage(new UserMainPage(this, userAdminWrapper));
 116                 } catch (Exception e) {
 117                         throw new CmsException("Cannot add pages", e);
 118                 }
 119         }
 120
 121         @Override
 122         public void doSave(IProgressMonitor monitor) {
 123                 userAdminWrapper.beginTransactionIfNeeded();
 124                 commitPages(true);
 125                 userAdminWrapper.commitOrNotifyTransactionStateChange();
 126                 firePropertyChange(PROP_DIRTY);
 127                 userAdminWrapper.notifyListeners(new UserAdminEvent(null, 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         }
 216
 217         public void setRepository(Repository repository) {
 218                 this.repository = repository;
 219         }
 220
 221 }