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
.e4
.users
;
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
.annotation
.PreDestroy
;
28 import javax
.inject
.Inject
;
29 import javax
.jcr
.Node
;
30 import javax
.jcr
.Repository
;
31 import javax
.jcr
.RepositoryException
;
32 import javax
.jcr
.Session
;
33 import javax
.naming
.InvalidNameException
;
34 import javax
.naming
.ldap
.LdapName
;
35 import javax
.transaction
.UserTransaction
;
37 import org
.argeo
.cms
.ArgeoNames
;
38 import org
.argeo
.cms
.CmsException
;
39 import org
.argeo
.cms
.e4
.users
.providers
.CommonNameLP
;
40 import org
.argeo
.cms
.e4
.users
.providers
.MailLP
;
41 import org
.argeo
.cms
.e4
.users
.providers
.RoleIconLP
;
42 import org
.argeo
.cms
.e4
.users
.providers
.UserFilter
;
43 import org
.argeo
.cms
.ui
.eclipse
.forms
.AbstractFormPart
;
44 import org
.argeo
.cms
.ui
.eclipse
.forms
.IManagedForm
;
45 import org
.argeo
.cms
.util
.CmsUtils
;
46 import org
.argeo
.cms
.util
.UserAdminUtils
;
47 import org
.argeo
.eclipse
.ui
.ColumnDefinition
;
48 import org
.argeo
.eclipse
.ui
.EclipseUiUtils
;
49 import org
.argeo
.eclipse
.ui
.parts
.LdifUsersTable
;
50 import org
.argeo
.jcr
.JcrUtils
;
51 import org
.argeo
.naming
.LdapAttrs
;
52 import org
.argeo
.node
.NodeInstance
;
53 import org
.argeo
.node
.NodeUtils
;
54 import org
.eclipse
.e4
.ui
.workbench
.modeling
.EPartService
;
55 import org
.eclipse
.jface
.action
.Action
;
56 import org
.eclipse
.jface
.action
.ToolBarManager
;
57 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
58 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
59 import org
.eclipse
.jface
.viewers
.ISelection
;
60 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
61 import org
.eclipse
.jface
.viewers
.TableViewer
;
62 import org
.eclipse
.jface
.viewers
.ViewerDropAdapter
;
63 import org
.eclipse
.swt
.SWT
;
64 import org
.eclipse
.swt
.dnd
.DND
;
65 import org
.eclipse
.swt
.dnd
.DropTargetEvent
;
66 import org
.eclipse
.swt
.dnd
.TextTransfer
;
67 import org
.eclipse
.swt
.dnd
.Transfer
;
68 import org
.eclipse
.swt
.dnd
.TransferData
;
69 import org
.eclipse
.swt
.events
.ModifyListener
;
70 import org
.eclipse
.swt
.events
.SelectionAdapter
;
71 import org
.eclipse
.swt
.events
.SelectionEvent
;
72 import org
.eclipse
.swt
.layout
.GridData
;
73 import org
.eclipse
.swt
.layout
.GridLayout
;
74 import org
.eclipse
.swt
.widgets
.Composite
;
75 import org
.eclipse
.swt
.widgets
.Label
;
76 import org
.eclipse
.swt
.widgets
.Link
;
77 import org
.eclipse
.swt
.widgets
.Shell
;
78 import org
.eclipse
.swt
.widgets
.Text
;
79 import org
.eclipse
.swt
.widgets
.ToolBar
;
80 import org
.osgi
.service
.useradmin
.Group
;
81 import org
.osgi
.service
.useradmin
.Role
;
82 //import org.eclipse.ui.forms.AbstractFormPart;
83 //import org.eclipse.ui.forms.IManagedForm;
84 //import org.eclipse.ui.forms.SectionPart;
85 //import org.eclipse.ui.forms.editor.FormEditor;
86 //import org.eclipse.ui.forms.editor.FormPage;
87 //import org.eclipse.ui.forms.widgets.FormToolkit;
88 //import org.eclipse.ui.forms.widgets.ScrolledForm;
89 //import org.eclipse.ui.forms.widgets.Section;
90 import org
.osgi
.service
.useradmin
.User
;
91 import org
.osgi
.service
.useradmin
.UserAdmin
;
92 import org
.osgi
.service
.useradmin
.UserAdminEvent
;
94 /** Display/edit main properties of a given group */
95 public class GroupEditor
extends AbstractRoleEditor
implements ArgeoNames
{
96 // final static String ID = "GroupEditor.mainPage";
99 private EPartService partService
;
101 // private final UserEditor editor;
103 private Repository repository
;
105 private NodeInstance nodeInstance
;
106 // private final UserAdminWrapper userAdminWrapper;
107 private Session session
;
109 // public GroupMainPage(FormEditor editor, UserAdminWrapper userAdminWrapper,
110 // Repository repository,
111 // NodeInstance nodeInstance) {
112 // super(editor, ID, "Main");
114 // session = repository.login();
115 // } catch (RepositoryException e) {
116 // throw new CmsException("Cannot retrieve session of in MainGroupPage
119 // this.editor = (UserEditor) editor;
120 // this.userAdminWrapper = userAdminWrapper;
121 // this.nodeInstance = nodeInstance;
124 // protected void createFormContent(final IManagedForm mf) {
125 // ScrolledForm form = mf.getForm();
126 // Composite body = form.getBody();
127 // GridLayout mainLayout = new GridLayout();
128 // body.setLayout(mainLayout);
129 // Group group = (Group) editor.getDisplayedUser();
130 // appendOverviewPart(body, group);
131 // appendMembersPart(body, group);
135 protected void createUi(Composite parent
) {
137 session
= repository
.login();
138 } catch (RepositoryException e
) {
139 throw new CmsException("Cannot retrieve session", e
);
141 // ScrolledForm form = mf.getForm();
142 // Composite body = form.getBody();
143 // Composite body = new Composite(parent, SWT.NONE);
144 Composite body
= parent
;
145 GridLayout mainLayout
= new GridLayout();
146 body
.setLayout(mainLayout
);
147 Group group
= (Group
) getDisplayedUser();
148 appendOverviewPart(body
, group
);
149 appendMembersPart(body
, group
);
153 public void dispose() {
154 JcrUtils
.logoutQuietly(session
);
158 /** Creates the general section */
159 protected void appendOverviewPart(final Composite parent
, final Group group
) {
160 Composite body
= new Composite(parent
, SWT
.NONE
);
161 // GridLayout layout = new GridLayout(5, false);
162 GridLayout layout
= new GridLayout(2, false);
163 body
.setLayout(layout
);
164 body
.setLayoutData(CmsUtils
.fillWidth());
166 String cn
= UserAdminUtils
.getProperty(group
, LdapAttrs
.cn
.name());
167 createReadOnlyLT(body
, "Name", cn
);
168 createReadOnlyLT(body
, "DN", group
.getName());
169 createReadOnlyLT(body
, "Domain", UserAdminUtils
.getDomainName(group
));
172 Label descLbl
= new Label(body
, SWT
.LEAD
);
173 descLbl
.setFont(EclipseUiUtils
.getBoldFont(body
));
174 descLbl
.setText("Description");
175 descLbl
.setLayoutData(new GridData(SWT
.LEAD
, SWT
.CENTER
, true, false, 2, 1));
176 final Text descTxt
= new Text(body
, SWT
.LEAD
| SWT
.MULTI
| SWT
.WRAP
| SWT
.BORDER
);
177 GridData gd
= EclipseUiUtils
.fillWidth();
179 gd
.horizontalSpan
= 2;
180 descTxt
.setLayoutData(gd
);
183 Link markAsWorkgroupLk
= new Link(body
, SWT
.NONE
);
184 markAsWorkgroupLk
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, false, false, 2, 1));
186 // create form part (controller)
187 final AbstractFormPart part
= new AbstractFormPart() {
189 private MainInfoListener listener
;
192 public void initialize(IManagedForm form
) {
193 super.initialize(form
);
194 listener
= new MainInfoListener(parent
.getDisplay(), this);
195 userAdminWrapper
.addListener(listener
);
199 public void dispose() {
200 userAdminWrapper
.removeListener(listener
);
204 public void commit(boolean onSave
) {
205 // group.getProperties().put(LdapAttrs.description.name(), descTxt.getText());
206 setProperty(group
, description
, descTxt
.getText());
207 super.commit(onSave
);
211 public void refresh() {
212 // dnTxt.setText(group.getName());
213 // cnTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.cn.name()));
214 descTxt
.setText(UserAdminUtils
.getProperty(group
, LdapAttrs
.description
.name()));
215 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
216 if (workgroupHome
== null)
217 markAsWorkgroupLk
.setText("<a>Mark as workgroup</a>");
219 markAsWorkgroupLk
.setText("Configured as workgroup");
220 parent
.layout(true, true);
225 markAsWorkgroupLk
.addSelectionListener(new SelectionAdapter() {
226 private static final long serialVersionUID
= -6439340898096365078L;
229 public void widgetSelected(SelectionEvent e
) {
231 boolean confirmed
= MessageDialog
.openConfirm(parent
.getShell(), "Mark as workgroup",
232 "Are you sure you want to mark " + cn
+ " as being a workgroup? ");
234 Node workgroupHome
= NodeUtils
.getGroupHome(session
, cn
);
235 if (workgroupHome
!= null)
236 return; // already marked as workgroup, do nothing
239 // improve transaction management
240 userAdminWrapper
.beginTransactionIfNeeded();
241 nodeInstance
.createWorkgroup(new LdapName(group
.getName()));
242 setProperty(group
, businessCategory
, WORKGROUP
);
243 userAdminWrapper
.commitOrNotifyTransactionStateChange();
245 .notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, group
));
247 } catch (InvalidNameException e1
) {
248 throw new CmsException("Cannot create Workgroup for " + group
.toString(), e1
);
255 ModifyListener defaultListener
= new FormPartML(part
);
256 descTxt
.addModifyListener(defaultListener
);
257 getManagedForm().addPart(part
);
260 /** Filtered table with members. Has drag and drop ability */
261 protected void appendMembersPart(Composite parent
, Group group
) {
262 // Section section = tk.createSection(parent, Section.TITLE_BAR);
263 // section.setText("Members");
264 // section.setLayoutData(EclipseUiUtils.fillAll());
266 Composite body
= new Composite(parent
, SWT
.BORDER
);
267 body
.setLayout(new GridLayout());
268 // section.setClient(body);
269 body
.setLayoutData(EclipseUiUtils
.fillAll());
271 // Define the displayed columns
272 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
273 columnDefs
.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
274 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
275 columnDefs
.add(new ColumnDefinition(new MailLP(), "Mail", 150));
276 // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name",
279 // Create and configure the table
280 LdifUsersTable userViewerCmp
= new MyUserTableViewer(body
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
,
281 userAdminWrapper
.getUserAdmin());
283 userViewerCmp
.setColumnDefinitions(columnDefs
);
284 userViewerCmp
.populate(true, false);
285 userViewerCmp
.setLayoutData(EclipseUiUtils
.fillAll());
288 TableViewer userViewer
= userViewerCmp
.getTableViewer();
289 userViewer
.addDoubleClickListener(new UserTableDefaultDClickListener(partService
));
290 int operations
= DND
.DROP_COPY
| DND
.DROP_MOVE
;
291 Transfer
[] tt
= new Transfer
[] { TextTransfer
.getInstance() };
292 userViewer
.addDropSupport(operations
, tt
,
293 new GroupDropListener(userAdminWrapper
, userViewerCmp
, (Group
) getDisplayedUser()));
295 AbstractFormPart part
= new GroupMembersPart(userViewerCmp
);
296 getManagedForm().addPart(part
);
299 // addRemoveAbility(toolBarManager, userViewerCmp.getTableViewer(), group);
300 Action action
= new RemoveMembershipAction(userViewer
, group
, "Remove selected items from this group",
301 SecurityAdminImages
.ICON_REMOVE_DESC
);
303 ToolBarManager toolBarManager
= new ToolBarManager(SWT
.FLAT
);
304 ToolBar toolBar
= toolBarManager
.createControl(body
);
305 toolBar
.setLayoutData(CmsUtils
.fillWidth());
307 toolBarManager
.add(action
);
308 toolBarManager
.update(true);
312 // private LdifUsersTable createMemberPart(Composite parent, Group group) {
314 // // Define the displayed columns
315 // List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
316 // columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
317 // columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
318 // columnDefs.add(new ColumnDefinition(new MailLP(), "Mail", 150));
319 // // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished
323 // // Create and configure the table
324 // LdifUsersTable userViewerCmp = new MyUserTableViewer(parent, SWT.MULTI |
325 // SWT.H_SCROLL | SWT.V_SCROLL,
326 // userAdminWrapper.getUserAdmin());
328 // userViewerCmp.setColumnDefinitions(columnDefs);
329 // userViewerCmp.populate(true, false);
330 // userViewerCmp.setLayoutData(EclipseUiUtils.fillAll());
333 // TableViewer userViewer = userViewerCmp.getTableViewer();
334 // userViewer.addDoubleClickListener(new
335 // UserTableDefaultDClickListener(partService));
336 // int operations = DND.DROP_COPY | DND.DROP_MOVE;
337 // Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
338 // userViewer.addDropSupport(operations, tt,
339 // new GroupDropListener(userAdminWrapper, userViewerCmp, (Group)
340 // getDisplayedUser()));
342 // // userViewerCmp.refresh();
343 // return userViewerCmp;
347 private class MyUserTableViewer
extends LdifUsersTable
{
348 private static final long serialVersionUID
= 8467999509931900367L;
350 private final UserFilter userFilter
;
352 public MyUserTableViewer(Composite parent
, int style
, UserAdmin userAdmin
) {
353 super(parent
, style
, true);
354 userFilter
= new UserFilter();
359 protected List
<User
> listFilteredElements(String filter
) {
360 // reload user and set it in the editor
361 Group group
= (Group
) getDisplayedUser();
362 Role
[] roles
= group
.getMembers();
363 List
<User
> users
= new ArrayList
<User
>();
364 userFilter
.setSearchText(filter
);
365 // userFilter.setShowSystemRole(true);
366 for (Role role
: roles
)
367 // if (role.getType() == Role.GROUP)
368 if (userFilter
.select(null, null, role
))
369 users
.add((User
) role
);
374 // private void addRemoveAbility(ToolBarManager toolBarManager, TableViewer
375 // userViewer, Group group) {
376 // // Section section = sectionPart.getSection();
377 // // ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
378 // // ToolBar toolbar = toolBarManager.createControl(parent);
379 // // ToolBar toolbar = toolBarManager.getControl();
380 // // final Cursor handCursor = new Cursor(toolbar.getDisplay(),
382 // // toolbar.setCursor(handCursor);
383 // // toolbar.addDisposeListener(new DisposeListener() {
384 // // private static final long serialVersionUID = 3882131405820522925L;
386 // // public void widgetDisposed(DisposeEvent e) {
387 // // if ((handCursor != null) && (handCursor.isDisposed() == false)) {
388 // // handCursor.dispose();
393 // Action action = new RemoveMembershipAction(userViewer, group, "Remove
394 // selected items from this group",
395 // SecurityAdminImages.ICON_REMOVE_DESC);
396 // toolBarManager.add(action);
397 // toolBarManager.update(true);
398 // // section.setTextClient(toolbar);
401 private class RemoveMembershipAction
extends Action
{
402 private static final long serialVersionUID
= -1337713097184522588L;
404 private final TableViewer userViewer
;
405 private final Group group
;
407 RemoveMembershipAction(TableViewer userViewer
, Group group
, String name
, ImageDescriptor img
) {
409 this.userViewer
= userViewer
;
415 ISelection selection
= userViewer
.getSelection();
416 if (selection
.isEmpty())
419 @SuppressWarnings("unchecked")
420 Iterator
<User
> it
= ((IStructuredSelection
) selection
).iterator();
421 List
<User
> users
= new ArrayList
<User
>();
422 while (it
.hasNext()) {
423 User currUser
= it
.next();
427 userAdminWrapper
.beginTransactionIfNeeded();
428 for (User user
: users
) {
429 group
.removeMember(user
);
431 userAdminWrapper
.commitOrNotifyTransactionStateChange();
432 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, group
));
437 private class GroupMembersPart
extends AbstractFormPart
{
438 private final LdifUsersTable userViewer
;
439 // private final Group group;
441 private GroupChangeListener listener
;
443 public GroupMembersPart(LdifUsersTable userViewer
) {
445 this.userViewer
= userViewer
;
446 // this.group = group;
450 public void initialize(IManagedForm form
) {
451 super.initialize(form
);
452 listener
= new GroupChangeListener(userViewer
.getDisplay(), GroupMembersPart
.this);
453 userAdminWrapper
.addListener(listener
);
457 public void dispose() {
458 userAdminWrapper
.removeListener(listener
);
463 public void refresh() {
464 userViewer
.refresh();
470 * Defines this table as being a potential target to add group membership
471 * (roles) to this group
473 private class GroupDropListener
extends ViewerDropAdapter
{
474 private static final long serialVersionUID
= 2893468717831451621L;
476 private final UserAdminWrapper userAdminWrapper
;
477 // private final LdifUsersTable myUserViewerCmp;
478 private final Group myGroup
;
480 public GroupDropListener(UserAdminWrapper userAdminWrapper
, LdifUsersTable userTableViewerCmp
, Group group
) {
481 super(userTableViewerCmp
.getTableViewer());
482 this.userAdminWrapper
= userAdminWrapper
;
483 this.myGroup
= group
;
484 // this.myUserViewerCmp = userTableViewerCmp;
488 public boolean validateDrop(Object target
, int operation
, TransferData transferType
) {
489 // Target is always OK in a list only view
490 // TODO check if not a string
491 boolean validDrop
= true;
496 public void drop(DropTargetEvent event
) {
497 // TODO Is there an opportunity to perform the check before?
498 String newUserName
= (String
) event
.data
;
499 UserAdmin myUserAdmin
= userAdminWrapper
.getUserAdmin();
500 Role role
= myUserAdmin
.getRole(newUserName
);
501 if (role
.getType() == Role
.GROUP
) {
502 Group newGroup
= (Group
) role
;
503 Shell shell
= getViewer().getControl().getShell();
505 if (myGroup
== newGroup
) { // Equality
506 MessageDialog
.openError(shell
, "Forbidden addition ", "A group cannot be a member of itself.");
511 String myName
= myGroup
.getName();
512 List
<User
> myMemberships
= getFlatGroups(myGroup
);
513 if (myMemberships
.contains(newGroup
)) {
514 MessageDialog
.openError(shell
, "Forbidden addition: cycle",
515 "Cannot add " + newUserName
+ " to group " + myName
+ ". This would create a cycle");
520 List
<User
> newGroupMemberships
= getFlatGroups(newGroup
);
521 if (newGroupMemberships
.contains(myGroup
)) {
522 MessageDialog
.openError(shell
, "Forbidden addition",
523 "Cannot add " + newUserName
+ " to group " + myName
+ ", this membership already exists");
526 userAdminWrapper
.beginTransactionIfNeeded();
527 myGroup
.addMember(newGroup
);
528 userAdminWrapper
.commitOrNotifyTransactionStateChange();
529 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
530 } else if (role
.getType() == Role
.USER
) {
531 // TODO check if the group is already member of this group
532 UserTransaction transaction
= userAdminWrapper
.beginTransactionIfNeeded();
533 User user
= (User
) role
;
534 myGroup
.addMember(user
);
535 if (UserAdminWrapper
.COMMIT_ON_SAVE
)
537 transaction
.commit();
538 } catch (Exception e
) {
539 throw new CmsException("Cannot commit transaction " + "after user group membership update", e
);
541 userAdminWrapper
.notifyListeners(new UserAdminEvent(null, UserAdminEvent
.ROLE_CHANGED
, myGroup
));
547 public boolean performDrop(Object data
) {
548 // myUserViewerCmp.refresh();
554 // private Composite addSection(FormToolkit tk, Composite parent) {
555 // Section section = tk.createSection(parent, SWT.NO_FOCUS);
556 // section.setLayoutData(EclipseUiUtils.fillWidth());
557 // Composite body = tk.createComposite(section, SWT.WRAP);
558 // body.setLayoutData(EclipseUiUtils.fillAll());
559 // section.setClient(body);
563 /** Creates label and text. */
564 // private Text createLT(Composite parent, String label, String value) {
565 // FormToolkit toolkit = getManagedForm().getToolkit();
566 // Label lbl = toolkit.createLabel(parent, label);
567 // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
568 // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
569 // Text text = toolkit.createText(parent, value, SWT.BORDER);
570 // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
571 // CmsUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
575 // Text createReadOnlyLT(Composite parent, String label, String value) {
576 // FormToolkit toolkit = getManagedForm().getToolkit();
577 // Label lbl = toolkit.createLabel(parent, label);
578 // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
579 // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
580 // Text text = toolkit.createText(parent, value, SWT.NONE);
581 // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
582 // text.setEditable(false);
583 // CmsUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);