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 static org
.argeo
.cms
.util
.UserAdminUtils
.setProperty
;
19 import static org
.argeo
.naming
.LdapAttrs
.businessCategory
;
20 import static org
.argeo
.naming
.LdapAttrs
.description
;
21 import static org
.argeo
.node
.NodeInstance
.WORKGROUP
;
23 import java
.util
.ArrayList
;
24 import java
.util
.Iterator
;
25 import java
.util
.List
;
27 import javax
.jcr
.Node
;
28 import javax
.jcr
.Repository
;
29 import javax
.jcr
.RepositoryException
;
30 import javax
.jcr
.Session
;
31 import javax
.naming
.InvalidNameException
;
32 import javax
.naming
.ldap
.LdapName
;
33 import javax
.transaction
.UserTransaction
;
35 import org
.argeo
.cms
.ArgeoNames
;
36 import org
.argeo
.cms
.CmsException
;
37 import org
.argeo
.cms
.ui
.workbench
.CmsWorkbenchStyles
;
38 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.SecurityAdminImages
;
39 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.UserAdminWrapper
;
40 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
.UserEditor
.GroupChangeListener
;
41 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.parts
.UserEditor
.MainInfoListener
;
42 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.CommonNameLP
;
43 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.MailLP
;
44 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.RoleIconLP
;
45 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserFilter
;
46 import org
.argeo
.cms
.ui
.workbench
.internal
.useradmin
.providers
.UserTableDefaultDClickListener
;
47 import org
.argeo
.cms
.util
.CmsUtils
;
48 import org
.argeo
.cms
.util
.UserAdminUtils
;
49 import org
.argeo
.eclipse
.ui
.ColumnDefinition
;
50 import org
.argeo
.eclipse
.ui
.EclipseUiUtils
;
51 import org
.argeo
.eclipse
.ui
.parts
.LdifUsersTable
;
52 import org
.argeo
.jcr
.JcrUtils
;
53 import org
.argeo
.naming
.LdapAttrs
;
54 import org
.argeo
.node
.NodeInstance
;
55 import org
.argeo
.node
.NodeUtils
;
56 import org
.eclipse
.jface
.action
.Action
;
57 import org
.eclipse
.jface
.action
.ToolBarManager
;
58 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
59 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
60 import org
.eclipse
.jface
.viewers
.ISelection
;
61 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
62 import org
.eclipse
.jface
.viewers
.TableViewer
;
63 import org
.eclipse
.jface
.viewers
.ViewerDropAdapter
;
64 import org
.eclipse
.swt
.SWT
;
65 import org
.eclipse
.swt
.dnd
.DND
;
66 import org
.eclipse
.swt
.dnd
.DropTargetEvent
;
67 import org
.eclipse
.swt
.dnd
.TextTransfer
;
68 import org
.eclipse
.swt
.dnd
.Transfer
;
69 import org
.eclipse
.swt
.dnd
.TransferData
;
70 import org
.eclipse
.swt
.events
.DisposeEvent
;
71 import org
.eclipse
.swt
.events
.DisposeListener
;
72 import org
.eclipse
.swt
.events
.ModifyListener
;
73 import org
.eclipse
.swt
.events
.SelectionAdapter
;
74 import org
.eclipse
.swt
.events
.SelectionEvent
;
75 import org
.eclipse
.swt
.graphics
.Cursor
;
76 import org
.eclipse
.swt
.layout
.GridData
;
77 import org
.eclipse
.swt
.layout
.GridLayout
;
78 import org
.eclipse
.swt
.widgets
.Composite
;
79 import org
.eclipse
.swt
.widgets
.Label
;
80 import org
.eclipse
.swt
.widgets
.Link
;
81 import org
.eclipse
.swt
.widgets
.Shell
;
82 import org
.eclipse
.swt
.widgets
.Text
;
83 import org
.eclipse
.swt
.widgets
.ToolBar
;
84 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
85 import org
.eclipse
.ui
.forms
.IManagedForm
;
86 import org
.eclipse
.ui
.forms
.SectionPart
;
87 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
88 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
89 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
90 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
91 import org
.eclipse
.ui
.forms
.widgets
.Section
;
92 import org
.osgi
.service
.useradmin
.Group
;
93 import org
.osgi
.service
.useradmin
.Role
;
94 import org
.osgi
.service
.useradmin
.User
;
95 import org
.osgi
.service
.useradmin
.UserAdmin
;
96 import org
.osgi
.service
.useradmin
.UserAdminEvent
;
98 /** Display/edit main properties of a given group */
99 public class GroupMainPage
extends FormPage
implements ArgeoNames
{
100 final static String ID
= "GroupEditor.mainPage";
102 private final UserEditor editor
;
103 private final NodeInstance nodeInstance
;
104 private final UserAdminWrapper userAdminWrapper
;
105 private final Session session
;
107 public GroupMainPage(FormEditor editor
, UserAdminWrapper userAdminWrapper
, Repository repository
,
108 NodeInstance nodeInstance
) {
109 super(editor
, ID
, "Main");
111 session
= repository
.login();
112 } catch (RepositoryException e
) {
113 throw new CmsException("Cannot retrieve session of in MainGroupPage constructor", e
);
115 this.editor
= (UserEditor
) editor
;
116 this.userAdminWrapper
= userAdminWrapper
;
117 this.nodeInstance
= nodeInstance
;
120 protected void createFormContent(final IManagedForm mf
) {
121 ScrolledForm form
= mf
.getForm();
122 Composite body
= form
.getBody();
123 GridLayout mainLayout
= new GridLayout();
124 body
.setLayout(mainLayout
);
125 Group group
= (Group
) editor
.getDisplayedUser();
126 appendOverviewPart(body
, group
);
127 appendMembersPart(body
, group
);
131 public void dispose() {
132 JcrUtils
.logoutQuietly(session
);
136 /** Creates the general section */
137 protected void appendOverviewPart(final Composite parent
, final Group group
) {
138 FormToolkit tk
= getManagedForm().getToolkit();
139 Composite body
= addSection(tk
, parent
);
140 // GridLayout layout = new GridLayout(5, false);
141 GridLayout layout
= new GridLayout(2, false);
142 body
.setLayout(layout
);
144 String cn
= UserAdminUtils
.getProperty(group
, LdapAttrs
.cn
.name());
145 createReadOnlyLT(body
, "Name", cn
);
146 // Text dnTxt = createReadOnlyLT(body, "DN", group.getName());
147 createReadOnlyLT(body
, "Domain", UserAdminUtils
.getDomainName(group
));
150 Label descLbl
= new Label(body
, SWT
.LEAD
);
151 descLbl
.setFont(EclipseUiUtils
.getBoldFont(body
));
152 descLbl
.setText("Description");
153 descLbl
.setLayoutData(new GridData(SWT
.LEAD
, SWT
.CENTER
, false, false, 2, 1));
154 final Text descTxt
= new Text(body
, SWT
.LEAD
| SWT
.MULTI
| SWT
.WRAP
| SWT
.BORDER
);
155 GridData gd
= EclipseUiUtils
.fillAll();
157 gd
.horizontalSpan
= 2;
158 descTxt
.setLayoutData(gd
);
161 Link markAsWorkgroupLk
= new Link(body
, SWT
.NONE
);
162 markAsWorkgroupLk
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, false, false, 2, 1));
164 // create form part (controller)
165 final AbstractFormPart part
= new SectionPart((Section
) body
.getParent()) {
167 private MainInfoListener listener
;
170 public void initialize(IManagedForm form
) {
171 super.initialize(form
);
172 listener
= editor
.new MainInfoListener(parent
.getDisplay(), this);
173 userAdminWrapper
.addListener(listener
);
177 public void dispose() {
178 userAdminWrapper
.removeListener(listener
);
182 public void commit(boolean onSave
) {
183 // group.getProperties().put(LdapAttrs.description.name(), descTxt.getText());
184 setProperty(group
, description
, descTxt
.getText());
185 super.commit(onSave
);
189 public void refresh() {
190 // dnTxt.setText(group.getName());
191 // cnTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.cn.name()));
192 descTxt
.setText(UserAdminUtils
.getProperty(group
, LdapAttrs
.description
.name()));
193 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
194 if (workgroupHome
== null)
195 markAsWorkgroupLk
.setText("<a>Mark as workgroup</a>");
197 markAsWorkgroupLk
.setText("Configured as workgroup");
198 parent
.layout(true, true);
203 markAsWorkgroupLk
.addSelectionListener(new SelectionAdapter() {
204 private static final long serialVersionUID
= -6439340898096365078L;
207 public void widgetSelected(SelectionEvent e
) {
209 boolean confirmed
= MessageDialog
.openConfirm(parent
.getShell(), "Mark as workgroup",
210 "Are you sure you want to mark " + cn
+ " as being a workgroup? ");
212 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
213 if (workgroupHome
!= null)
214 return; // already marked as workgroup, do nothing
217 // improve transaction management
218 userAdminWrapper
.beginTransactionIfNeeded();
219 nodeInstance
.createWorkgroup(new LdapName(group
.getName()));
220 setProperty(group
, businessCategory
, WORKGROUP
);
221 userAdminWrapper
.commitOrNotifyTransactionStateChange();
223 .notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, group
));
225 } catch (InvalidNameException e1
) {
226 throw new CmsException("Cannot create Workgroup for " + group
.toString(), e1
);
233 ModifyListener defaultListener
= editor
.new FormPartML(part
);
234 descTxt
.addModifyListener(defaultListener
);
235 getManagedForm().addPart(part
);
238 /** Filtered table with members. Has drag and drop ability */
239 protected void appendMembersPart(Composite parent
, Group group
) {
240 FormToolkit tk
= getManagedForm().getToolkit();
241 Section section
= tk
.createSection(parent
, Section
.TITLE_BAR
);
242 section
.setText("Members");
243 section
.setLayoutData(EclipseUiUtils
.fillAll());
245 Composite body
= new Composite(section
, SWT
.NO_FOCUS
);
246 section
.setClient(body
);
247 body
.setLayoutData(EclipseUiUtils
.fillAll());
249 LdifUsersTable userTableViewerCmp
= createMemberPart(body
, group
);
251 SectionPart part
= new GroupMembersPart(section
, userTableViewerCmp
);
252 getManagedForm().addPart(part
);
253 addRemoveAbitily(part
, userTableViewerCmp
.getTableViewer(), group
);
256 public LdifUsersTable
createMemberPart(Composite parent
, Group group
) {
257 parent
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
259 // Define the displayed columns
260 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
261 columnDefs
.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
262 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
263 columnDefs
.add(new ColumnDefinition(new MailLP(), "Mail", 150));
264 // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name",
267 // Create and configure the table
268 LdifUsersTable userViewerCmp
= new MyUserTableViewer(parent
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
,
269 userAdminWrapper
.getUserAdmin());
271 userViewerCmp
.setColumnDefinitions(columnDefs
);
272 userViewerCmp
.populate(true, false);
273 userViewerCmp
.setLayoutData(EclipseUiUtils
.fillAll());
276 TableViewer userViewer
= userViewerCmp
.getTableViewer();
277 userViewer
.addDoubleClickListener(new UserTableDefaultDClickListener());
278 int operations
= DND
.DROP_COPY
| DND
.DROP_MOVE
;
279 Transfer
[] tt
= new Transfer
[] { TextTransfer
.getInstance() };
280 userViewer
.addDropSupport(operations
, tt
,
281 new GroupDropListener(userAdminWrapper
, userViewerCmp
, (Group
) editor
.getDisplayedUser()));
283 return userViewerCmp
;
287 private class MyUserTableViewer
extends LdifUsersTable
{
288 private static final long serialVersionUID
= 8467999509931900367L;
290 private final UserFilter userFilter
;
292 public MyUserTableViewer(Composite parent
, int style
, UserAdmin userAdmin
) {
293 super(parent
, style
, true);
294 userFilter
= new UserFilter();
299 protected List
<User
> listFilteredElements(String filter
) {
300 // reload user and set it in the editor
301 Group group
= (Group
) editor
.getDisplayedUser();
302 Role
[] roles
= group
.getMembers();
303 List
<User
> users
= new ArrayList
<User
>();
304 userFilter
.setSearchText(filter
);
305 // userFilter.setShowSystemRole(true);
306 for (Role role
: roles
)
307 // if (role.getType() == Role.GROUP)
308 if (userFilter
.select(null, null, role
))
309 users
.add((User
) role
);
314 private void addRemoveAbitily(SectionPart sectionPart
, TableViewer userViewer
, Group group
) {
315 Section section
= sectionPart
.getSection();
316 ToolBarManager toolBarManager
= new ToolBarManager(SWT
.FLAT
);
317 ToolBar toolbar
= toolBarManager
.createControl(section
);
318 final Cursor handCursor
= new Cursor(section
.getDisplay(), SWT
.CURSOR_HAND
);
319 toolbar
.setCursor(handCursor
);
320 toolbar
.addDisposeListener(new DisposeListener() {
321 private static final long serialVersionUID
= 3882131405820522925L;
323 public void widgetDisposed(DisposeEvent e
) {
324 if ((handCursor
!= null) && (handCursor
.isDisposed() == false)) {
325 handCursor
.dispose();
330 Action action
= new RemoveMembershipAction(userViewer
, group
, "Remove selected items from this group",
331 SecurityAdminImages
.ICON_REMOVE_DESC
);
332 toolBarManager
.add(action
);
333 toolBarManager
.update(true);
334 section
.setTextClient(toolbar
);
337 private class RemoveMembershipAction
extends Action
{
338 private static final long serialVersionUID
= -1337713097184522588L;
340 private final TableViewer userViewer
;
341 private final Group group
;
343 RemoveMembershipAction(TableViewer userViewer
, Group group
, String name
, ImageDescriptor img
) {
345 this.userViewer
= userViewer
;
351 ISelection selection
= userViewer
.getSelection();
352 if (selection
.isEmpty())
355 @SuppressWarnings("unchecked")
356 Iterator
<User
> it
= ((IStructuredSelection
) selection
).iterator();
357 List
<User
> users
= new ArrayList
<User
>();
358 while (it
.hasNext()) {
359 User currUser
= it
.next();
363 userAdminWrapper
.beginTransactionIfNeeded();
364 for (User user
: users
) {
365 group
.removeMember(user
);
367 userAdminWrapper
.commitOrNotifyTransactionStateChange();
368 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, group
));
373 private class GroupMembersPart
extends SectionPart
{
374 private final LdifUsersTable userViewer
;
375 // private final Group group;
377 private GroupChangeListener listener
;
379 public GroupMembersPart(Section section
, LdifUsersTable userViewer
) {
381 this.userViewer
= userViewer
;
382 // this.group = group;
386 public void initialize(IManagedForm form
) {
387 super.initialize(form
);
388 listener
= editor
.new GroupChangeListener(userViewer
.getDisplay(), GroupMembersPart
.this);
389 userAdminWrapper
.addListener(listener
);
393 public void dispose() {
394 userAdminWrapper
.removeListener(listener
);
399 public void refresh() {
400 userViewer
.refresh();
406 * Defines this table as being a potential target to add group membership
407 * (roles) to this group
409 private class GroupDropListener
extends ViewerDropAdapter
{
410 private static final long serialVersionUID
= 2893468717831451621L;
412 private final UserAdminWrapper userAdminWrapper
;
413 // private final LdifUsersTable myUserViewerCmp;
414 private final Group myGroup
;
416 public GroupDropListener(UserAdminWrapper userAdminWrapper
, LdifUsersTable userTableViewerCmp
, Group group
) {
417 super(userTableViewerCmp
.getTableViewer());
418 this.userAdminWrapper
= userAdminWrapper
;
419 this.myGroup
= group
;
420 // this.myUserViewerCmp = userTableViewerCmp;
424 public boolean validateDrop(Object target
, int operation
, TransferData transferType
) {
425 // Target is always OK in a list only view
426 // TODO check if not a string
427 boolean validDrop
= true;
432 public void drop(DropTargetEvent event
) {
433 // TODO Is there an opportunity to perform the check before?
434 String newUserName
= (String
) event
.data
;
435 UserAdmin myUserAdmin
= userAdminWrapper
.getUserAdmin();
436 Role role
= myUserAdmin
.getRole(newUserName
);
437 if (role
.getType() == Role
.GROUP
) {
438 Group newGroup
= (Group
) role
;
439 Shell shell
= getViewer().getControl().getShell();
441 if (myGroup
== newGroup
) { // Equality
442 MessageDialog
.openError(shell
, "Forbidden addition ", "A group cannot be a member of itself.");
447 String myName
= myGroup
.getName();
448 List
<User
> myMemberships
= editor
.getFlatGroups(myGroup
);
449 if (myMemberships
.contains(newGroup
)) {
450 MessageDialog
.openError(shell
, "Forbidden addition: cycle",
451 "Cannot add " + newUserName
+ " to group " + myName
+ ". This would create a cycle");
456 List
<User
> newGroupMemberships
= editor
.getFlatGroups(newGroup
);
457 if (newGroupMemberships
.contains(myGroup
)) {
458 MessageDialog
.openError(shell
, "Forbidden addition",
459 "Cannot add " + newUserName
+ " to group " + myName
+ ", this membership already exists");
462 userAdminWrapper
.beginTransactionIfNeeded();
463 myGroup
.addMember(newGroup
);
464 userAdminWrapper
.commitOrNotifyTransactionStateChange();
465 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
466 } else if (role
.getType() == Role
.USER
) {
467 // TODO check if the group is already member of this group
468 UserTransaction transaction
= userAdminWrapper
.beginTransactionIfNeeded();
469 User user
= (User
) role
;
470 myGroup
.addMember(user
);
471 if (UserAdminWrapper
.COMMIT_ON_SAVE
)
473 transaction
.commit();
474 } catch (Exception e
) {
475 throw new CmsException("Cannot commit transaction " + "after user group membership update", e
);
477 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
483 public boolean performDrop(Object data
) {
484 // myUserViewerCmp.refresh();
490 private Composite
addSection(FormToolkit tk
, Composite parent
) {
491 Section section
= tk
.createSection(parent
, SWT
.NO_FOCUS
);
492 section
.setLayoutData(EclipseUiUtils
.fillWidth());
493 Composite body
= tk
.createComposite(section
, SWT
.WRAP
);
494 body
.setLayoutData(EclipseUiUtils
.fillAll());
495 section
.setClient(body
);
499 /** Creates label and text. */
500 // private Text createLT(Composite parent, String label, String value) {
501 // FormToolkit toolkit = getManagedForm().getToolkit();
502 // Label lbl = toolkit.createLabel(parent, label);
503 // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
504 // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
505 // Text text = toolkit.createText(parent, value, SWT.BORDER);
506 // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
507 // CmsUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
511 Text
createReadOnlyLT(Composite parent
, String label
, String value
) {
512 FormToolkit toolkit
= getManagedForm().getToolkit();
513 Label lbl
= toolkit
.createLabel(parent
, label
);
514 lbl
.setLayoutData(new GridData(SWT
.LEAD
, SWT
.CENTER
, false, false));
515 lbl
.setFont(EclipseUiUtils
.getBoldFont(parent
));
516 Text text
= toolkit
.createText(parent
, value
, SWT
.NONE
);
517 text
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, false));
518 text
.setEditable(false);
519 CmsUtils
.style(text
, CmsWorkbenchStyles
.WORKBENCH_FORM_TEXT
);