2 * Copyright (C) 2007-2012 Argeo GmbH
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
;
18 import java
.util
.ArrayList
;
19 import java
.util
.Iterator
;
20 import java
.util
.List
;
22 import javax
.jcr
.Node
;
23 import javax
.jcr
.Repository
;
24 import javax
.jcr
.RepositoryException
;
25 import javax
.jcr
.Session
;
26 import javax
.naming
.InvalidNameException
;
27 import javax
.naming
.ldap
.LdapName
;
28 import javax
.transaction
.UserTransaction
;
30 import org
.argeo
.cms
.ArgeoNames
;
31 import org
.argeo
.cms
.CmsException
;
32 import org
.argeo
.cms
.ui
.workbench
.CmsWorkbenchStyles
;
33 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.SecurityAdminImages
;
34 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.UserAdminWrapper
;
35 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
.UserEditor
.GroupChangeListener
;
36 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
.UserEditor
.MainInfoListener
;
37 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.CommonNameLP
;
38 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.MailLP
;
39 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.RoleIconLP
;
40 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserFilter
;
41 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserNameLP
;
42 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserTableDefaultDClickListener
;
43 import org
.argeo
.cms
.util
.CmsUtils
;
44 import org
.argeo
.cms
.util
.UserAdminUtils
;
45 import org
.argeo
.eclipse
.ui
.ColumnDefinition
;
46 import org
.argeo
.eclipse
.ui
.EclipseUiUtils
;
47 import org
.argeo
.eclipse
.ui
.parts
.LdifUsersTable
;
48 import org
.argeo
.jcr
.JcrUtils
;
49 import org
.argeo
.naming
.LdapAttrs
;
50 import org
.argeo
.node
.NodeInstance
;
51 import org
.argeo
.node
.NodeUtils
;
52 import org
.eclipse
.jface
.action
.Action
;
53 import org
.eclipse
.jface
.action
.ToolBarManager
;
54 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
55 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
56 import org
.eclipse
.jface
.viewers
.ISelection
;
57 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
58 import org
.eclipse
.jface
.viewers
.TableViewer
;
59 import org
.eclipse
.jface
.viewers
.ViewerDropAdapter
;
60 import org
.eclipse
.swt
.SWT
;
61 import org
.eclipse
.swt
.dnd
.DND
;
62 import org
.eclipse
.swt
.dnd
.DropTargetEvent
;
63 import org
.eclipse
.swt
.dnd
.TextTransfer
;
64 import org
.eclipse
.swt
.dnd
.Transfer
;
65 import org
.eclipse
.swt
.dnd
.TransferData
;
66 import org
.eclipse
.swt
.events
.DisposeEvent
;
67 import org
.eclipse
.swt
.events
.DisposeListener
;
68 import org
.eclipse
.swt
.events
.SelectionAdapter
;
69 import org
.eclipse
.swt
.events
.SelectionEvent
;
70 import org
.eclipse
.swt
.graphics
.Cursor
;
71 import org
.eclipse
.swt
.layout
.GridData
;
72 import org
.eclipse
.swt
.layout
.GridLayout
;
73 import org
.eclipse
.swt
.widgets
.Composite
;
74 import org
.eclipse
.swt
.widgets
.Label
;
75 import org
.eclipse
.swt
.widgets
.Link
;
76 import org
.eclipse
.swt
.widgets
.Shell
;
77 import org
.eclipse
.swt
.widgets
.Text
;
78 import org
.eclipse
.swt
.widgets
.ToolBar
;
79 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
80 import org
.eclipse
.ui
.forms
.IManagedForm
;
81 import org
.eclipse
.ui
.forms
.SectionPart
;
82 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
83 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
84 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
85 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
86 import org
.eclipse
.ui
.forms
.widgets
.Section
;
87 import org
.osgi
.service
.useradmin
.Group
;
88 import org
.osgi
.service
.useradmin
.Role
;
89 import org
.osgi
.service
.useradmin
.User
;
90 import org
.osgi
.service
.useradmin
.UserAdmin
;
91 import org
.osgi
.service
.useradmin
.UserAdminEvent
;
93 /** Display/edit main properties of a given group */
94 public class GroupMainPage
extends FormPage
implements ArgeoNames
{
95 final static String ID
= "GroupEditor.mainPage";
97 private final UserEditor editor
;
98 private final NodeInstance nodeInstance
;
99 private final UserAdminWrapper userAdminWrapper
;
100 private final Session session
;
102 public GroupMainPage(FormEditor editor
, UserAdminWrapper userAdminWrapper
, Repository repository
,
103 NodeInstance nodeInstance
) {
104 super(editor
, ID
, "Main");
106 session
= repository
.login();
107 } catch (RepositoryException e
) {
108 throw new CmsException("Cannot retrieve session of in MainGroupPage constructor", e
);
110 this.editor
= (UserEditor
) editor
;
111 this.userAdminWrapper
= userAdminWrapper
;
112 this.nodeInstance
= nodeInstance
;
115 protected void createFormContent(final IManagedForm mf
) {
116 ScrolledForm form
= mf
.getForm();
117 Composite body
= form
.getBody();
118 GridLayout mainLayout
= new GridLayout();
119 body
.setLayout(mainLayout
);
120 Group group
= (Group
) editor
.getDisplayedUser();
121 appendOverviewPart(body
, group
);
122 appendMembersPart(body
, group
);
126 public void dispose() {
127 JcrUtils
.logoutQuietly(session
);
131 /** Creates the general section */
132 protected void appendOverviewPart(final Composite parent
, final Group group
) {
133 FormToolkit tk
= getManagedForm().getToolkit();
134 Composite body
= addSection(tk
, parent
);
135 GridLayout layout
= new GridLayout(5, false);
136 body
.setLayout(layout
);
138 final Text dnTxt
= createLT(body
, "DN", group
.getName());
139 dnTxt
.setEnabled(false);
141 final String cn
= UserAdminUtils
.getProperty(group
, LdapAttrs
.cn
.name());
142 final Text cnTxt
= createLT(body
, "Common Name", cn
);
143 cnTxt
.setEnabled(false);
145 final Link markAsWorkgroupLk
= new Link(body
, SWT
.NONE
);
146 markAsWorkgroupLk
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, false));
148 // Label descLbl = new Label(body, SWT.LEAD);
149 // descLbl.setText("Description");
150 // descLbl.setLayoutData(new GridData(SWT.RIGHT, SWT.TOP, false,
152 // final Text descTxt = new Text(body, SWT.LEAD | SWT.MULTI | SWT.WRAP
154 // GridData gd = EclipseUiUtils.fillAll();
155 // gd.heightHint = 100;
156 // descTxt.setLayoutData(gd);
158 // create form part (controller)
159 final AbstractFormPart part
= new SectionPart((Section
) body
.getParent()) {
161 private MainInfoListener listener
;
164 public void initialize(IManagedForm form
) {
165 super.initialize(form
);
166 listener
= editor
.new MainInfoListener(parent
.getDisplay(), this);
167 userAdminWrapper
.addListener(listener
);
171 public void dispose() {
172 userAdminWrapper
.removeListener(listener
);
176 public void commit(boolean onSave
) {
177 // group.getProperties().put(LdapAttrs.description.name(),
178 // descTxt.getText());
179 super.commit(onSave
);
183 public void refresh() {
184 dnTxt
.setText(group
.getName());
185 cnTxt
.setText(UserAdminUtils
.getProperty(group
, LdapAttrs
.cn
.name()));
186 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
187 if (workgroupHome
== null)
188 markAsWorkgroupLk
.setText("<a>Mark as workgroup</a>");
190 markAsWorkgroupLk
.setText(cn
+ " is already marked as being a workgroup");
191 parent
.layout(true, true);
196 markAsWorkgroupLk
.addSelectionListener(new SelectionAdapter() {
197 private static final long serialVersionUID
= -6439340898096365078L;
200 public void widgetSelected(SelectionEvent e
) {
202 boolean confirmed
= MessageDialog
.openConfirm(parent
.getShell(), "Mark as workgroup",
203 "Are you sure you want to mark " + cn
+ " as being a workgroup? ");
205 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
206 if (workgroupHome
!= null)
207 return; // already marked as workgroup, do nothing
210 nodeInstance
.createWorkgroup(new LdapName(group
.getName()));
212 } catch (InvalidNameException e1
) {
213 throw new CmsException("Cannot create Workgroup for " + group
.toString(), e1
);
220 // ModifyListener defaultListener = editor.new FormPartML(part);
221 // descTxt.addModifyListener(defaultListener);
222 getManagedForm().addPart(part
);
225 /** Filtered table with members. Has drag and drop ability */
226 protected void appendMembersPart(Composite parent
, Group group
) {
228 FormToolkit tk
= getManagedForm().getToolkit();
229 Section section
= tk
.createSection(parent
, Section
.TITLE_BAR
);
230 section
.setLayoutData(EclipseUiUtils
.fillAll());
232 Composite body
= new Composite(section
, SWT
.NO_FOCUS
);
233 section
.setClient(body
);
234 body
.setLayoutData(EclipseUiUtils
.fillAll());
236 LdifUsersTable userTableViewerCmp
= createMemberPart(body
, group
);
238 SectionPart part
= new GroupMembersPart(section
, userTableViewerCmp
, group
);
239 getManagedForm().addPart(part
);
240 addRemoveAbitily(part
, userTableViewerCmp
.getTableViewer(), group
);
243 public LdifUsersTable
createMemberPart(Composite parent
, Group group
) {
244 parent
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
246 // Define the displayed columns
247 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
248 columnDefs
.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
249 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Common Name", 150));
250 columnDefs
.add(new ColumnDefinition(new MailLP(), "Primary Mail", 150));
251 columnDefs
.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name", 240));
253 // Create and configure the table
254 LdifUsersTable userViewerCmp
= new MyUserTableViewer(parent
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
,
255 userAdminWrapper
.getUserAdmin());
257 userViewerCmp
.setColumnDefinitions(columnDefs
);
258 userViewerCmp
.populate(true, false);
259 userViewerCmp
.setLayoutData(EclipseUiUtils
.fillAll());
262 TableViewer userViewer
= userViewerCmp
.getTableViewer();
263 userViewer
.addDoubleClickListener(new UserTableDefaultDClickListener());
264 int operations
= DND
.DROP_COPY
| DND
.DROP_MOVE
;
265 Transfer
[] tt
= new Transfer
[] { TextTransfer
.getInstance() };
266 userViewer
.addDropSupport(operations
, tt
,
267 new GroupDropListener(userAdminWrapper
, userViewerCmp
, (Group
) editor
.getDisplayedUser()));
269 return userViewerCmp
;
273 private class MyUserTableViewer
extends LdifUsersTable
{
274 private static final long serialVersionUID
= 8467999509931900367L;
276 private final UserFilter userFilter
;
278 public MyUserTableViewer(Composite parent
, int style
, UserAdmin userAdmin
) {
279 super(parent
, style
, true);
280 userFilter
= new UserFilter();
285 protected List
<User
> listFilteredElements(String filter
) {
286 Group group
= (Group
) editor
.getDisplayedUser();
287 Role
[] roles
= group
.getMembers();
288 List
<User
> users
= new ArrayList
<User
>();
289 userFilter
.setSearchText(filter
);
290 for (Role role
: roles
)
291 // if (role.getType() == Role.GROUP)
292 if (userFilter
.select(null, null, role
))
293 users
.add((User
) role
);
298 private void addRemoveAbitily(SectionPart sectionPart
, TableViewer userViewer
, Group group
) {
299 Section section
= sectionPart
.getSection();
300 ToolBarManager toolBarManager
= new ToolBarManager(SWT
.FLAT
);
301 ToolBar toolbar
= toolBarManager
.createControl(section
);
302 final Cursor handCursor
= new Cursor(section
.getDisplay(), SWT
.CURSOR_HAND
);
303 toolbar
.setCursor(handCursor
);
304 toolbar
.addDisposeListener(new DisposeListener() {
305 private static final long serialVersionUID
= 3882131405820522925L;
307 public void widgetDisposed(DisposeEvent e
) {
308 if ((handCursor
!= null) && (handCursor
.isDisposed() == false)) {
309 handCursor
.dispose();
314 Action action
= new RemoveMembershipAction(userViewer
, group
, "Remove selected items from this group",
315 SecurityAdminImages
.ICON_REMOVE_DESC
);
316 toolBarManager
.add(action
);
317 toolBarManager
.update(true);
318 section
.setTextClient(toolbar
);
321 private class RemoveMembershipAction
extends Action
{
322 private static final long serialVersionUID
= -1337713097184522588L;
324 private final TableViewer userViewer
;
325 private final Group group
;
327 RemoveMembershipAction(TableViewer userViewer
, Group group
, String name
, ImageDescriptor img
) {
329 this.userViewer
= userViewer
;
335 ISelection selection
= userViewer
.getSelection();
336 if (selection
.isEmpty())
339 @SuppressWarnings("unchecked")
340 Iterator
<User
> it
= ((IStructuredSelection
) selection
).iterator();
341 List
<User
> users
= new ArrayList
<User
>();
342 while (it
.hasNext()) {
343 User currUser
= it
.next();
347 userAdminWrapper
.beginTransactionIfNeeded();
348 for (User user
: users
) {
349 group
.removeMember(user
);
351 userAdminWrapper
.commitOrNotifyTransactionStateChange();
352 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, group
));
357 private class GroupMembersPart
extends SectionPart
{
358 private final LdifUsersTable userViewer
;
359 private final Group group
;
361 private GroupChangeListener listener
;
363 public GroupMembersPart(Section section
, LdifUsersTable userViewer
, Group group
) {
365 this.userViewer
= userViewer
;
370 public void initialize(IManagedForm form
) {
371 super.initialize(form
);
372 listener
= editor
.new GroupChangeListener(userViewer
.getDisplay(), GroupMembersPart
.this);
373 userAdminWrapper
.addListener(listener
);
377 public void dispose() {
378 userAdminWrapper
.removeListener(listener
);
383 public void refresh() {
384 getSection().setText("Members of group " + UserAdminUtils
.getProperty(group
, LdapAttrs
.cn
.name()));
385 userViewer
.refresh();
391 * Defines this table as being a potential target to add group membership
392 * (roles) to this group
394 private class GroupDropListener
extends ViewerDropAdapter
{
395 private static final long serialVersionUID
= 2893468717831451621L;
397 private final UserAdminWrapper userAdminWrapper
;
398 // private final LdifUsersTable myUserViewerCmp;
399 private final Group myGroup
;
401 public GroupDropListener(UserAdminWrapper userAdminWrapper
, LdifUsersTable userTableViewerCmp
, Group group
) {
402 super(userTableViewerCmp
.getTableViewer());
403 this.userAdminWrapper
= userAdminWrapper
;
404 this.myGroup
= group
;
405 // this.myUserViewerCmp = userTableViewerCmp;
409 public boolean validateDrop(Object target
, int operation
, TransferData transferType
) {
410 // Target is always OK in a list only view
411 // TODO check if not a string
412 boolean validDrop
= true;
417 public void drop(DropTargetEvent event
) {
418 // TODO Is there an opportunity to perform the check before?
419 String newUserName
= (String
) event
.data
;
420 UserAdmin myUserAdmin
= userAdminWrapper
.getUserAdmin();
421 Role role
= myUserAdmin
.getRole(newUserName
);
422 if (role
.getType() == Role
.GROUP
) {
423 Group newGroup
= (Group
) role
;
424 Shell shell
= getViewer().getControl().getShell();
426 if (myGroup
== newGroup
) { // Equality
427 MessageDialog
.openError(shell
, "Forbidden addition ", "A group cannot be a member of itself.");
432 String myName
= myGroup
.getName();
433 List
<User
> myMemberships
= editor
.getFlatGroups(myGroup
);
434 if (myMemberships
.contains(newGroup
)) {
435 MessageDialog
.openError(shell
, "Forbidden addition: cycle",
436 "Cannot add " + newUserName
+ " to group " + myName
+ ". This would create a cycle");
441 List
<User
> newGroupMemberships
= editor
.getFlatGroups(newGroup
);
442 if (newGroupMemberships
.contains(myGroup
)) {
443 MessageDialog
.openError(shell
, "Forbidden addition",
444 "Cannot add " + newUserName
+ " to group " + myName
+ ", this membership already exists");
447 userAdminWrapper
.beginTransactionIfNeeded();
448 myGroup
.addMember(newGroup
);
449 userAdminWrapper
.commitOrNotifyTransactionStateChange();
450 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
451 } else if (role
.getType() == Role
.USER
) {
452 // TODO check if the group is already member of this group
453 UserTransaction transaction
= userAdminWrapper
.beginTransactionIfNeeded();
454 User user
= (User
) role
;
455 myGroup
.addMember(user
);
456 if (UserAdminWrapper
.COMMIT_ON_SAVE
)
458 transaction
.commit();
459 } catch (Exception e
) {
460 throw new CmsException("Cannot commit transaction " + "after user group membership update", e
);
462 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
468 public boolean performDrop(Object data
) {
469 // myUserViewerCmp.refresh();
475 private Composite
addSection(FormToolkit tk
, Composite parent
) {
476 Section section
= tk
.createSection(parent
, SWT
.NO_FOCUS
);
477 section
.setLayoutData(EclipseUiUtils
.fillWidth());
478 Composite body
= tk
.createComposite(section
, SWT
.WRAP
);
479 body
.setLayoutData(EclipseUiUtils
.fillAll());
480 section
.setClient(body
);
484 /** Creates label and text. */
485 private Text
createLT(Composite parent
, String label
, String value
) {
486 FormToolkit toolkit
= getManagedForm().getToolkit();
487 Label lbl
= toolkit
.createLabel(parent
, label
);
488 lbl
.setLayoutData(new GridData(SWT
.END
, SWT
.CENTER
, false, false));
489 lbl
.setFont(EclipseUiUtils
.getBoldFont(parent
));
490 Text text
= toolkit
.createText(parent
, value
, SWT
.BORDER
);
491 text
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, false));
492 CmsUtils
.style(text
, CmsWorkbenchStyles
.WORKBENCH_FORM_TEXT
);