]> git.argeo.org Git - lgpl/argeo-commons.git/blob - org.argeo.cms.e4/src/org/argeo/cms/e4/users/GroupEditor.java
[maven-release-plugin] prepare for next development iteration
[lgpl/argeo-commons.git] / org.argeo.cms.e4 / src / org / argeo / cms / e4 / users / GroupEditor.java
1 package org.argeo.cms.e4.users;
2
3 import static org.argeo.api.NodeInstance.WORKGROUP;
4 import static org.argeo.cms.auth.UserAdminUtils.setProperty;
5 import static org.argeo.naming.LdapAttrs.businessCategory;
6 import static org.argeo.naming.LdapAttrs.description;
7
8 import java.util.ArrayList;
9 import java.util.Iterator;
10 import java.util.List;
11
12 import javax.annotation.PreDestroy;
13 import javax.inject.Inject;
14 import javax.jcr.Node;
15 import javax.jcr.Repository;
16 import javax.jcr.RepositoryException;
17 import javax.jcr.Session;
18 import javax.naming.InvalidNameException;
19 import javax.naming.ldap.LdapName;
20 import javax.transaction.UserTransaction;
21
22 import org.argeo.api.NodeConstants;
23 import org.argeo.api.NodeInstance;
24 import org.argeo.api.NodeUtils;
25 import org.argeo.cms.CmsException;
26 import org.argeo.cms.auth.UserAdminUtils;
27 import org.argeo.cms.e4.users.providers.CommonNameLP;
28 import org.argeo.cms.e4.users.providers.MailLP;
29 import org.argeo.cms.e4.users.providers.RoleIconLP;
30 import org.argeo.cms.e4.users.providers.UserFilter;
31 import org.argeo.cms.ui.eclipse.forms.AbstractFormPart;
32 import org.argeo.cms.ui.eclipse.forms.IManagedForm;
33 import org.argeo.cms.ui.util.CmsUiUtils;
34 import org.argeo.eclipse.ui.ColumnDefinition;
35 import org.argeo.eclipse.ui.EclipseUiUtils;
36 import org.argeo.eclipse.ui.parts.LdifUsersTable;
37 import org.argeo.jcr.JcrUtils;
38 import org.argeo.naming.LdapAttrs;
39 import org.eclipse.e4.ui.workbench.modeling.EPartService;
40 import org.eclipse.jface.action.Action;
41 import org.eclipse.jface.action.ToolBarManager;
42 import org.eclipse.jface.dialogs.MessageDialog;
43 import org.eclipse.jface.resource.ImageDescriptor;
44 import org.eclipse.jface.viewers.ISelection;
45 import org.eclipse.jface.viewers.IStructuredSelection;
46 import org.eclipse.jface.viewers.TableViewer;
47 import org.eclipse.jface.viewers.ViewerDropAdapter;
48 import org.eclipse.swt.SWT;
49 import org.eclipse.swt.dnd.DND;
50 import org.eclipse.swt.dnd.DropTargetEvent;
51 import org.eclipse.swt.dnd.TextTransfer;
52 import org.eclipse.swt.dnd.Transfer;
53 import org.eclipse.swt.dnd.TransferData;
54 import org.eclipse.swt.events.ModifyListener;
55 import org.eclipse.swt.events.SelectionAdapter;
56 import org.eclipse.swt.events.SelectionEvent;
57 import org.eclipse.swt.layout.GridData;
58 import org.eclipse.swt.layout.GridLayout;
59 import org.eclipse.swt.widgets.Composite;
60 import org.eclipse.swt.widgets.Label;
61 import org.eclipse.swt.widgets.Link;
62 import org.eclipse.swt.widgets.Shell;
63 import org.eclipse.swt.widgets.Text;
64 import org.eclipse.swt.widgets.ToolBar;
65 import org.osgi.service.useradmin.Group;
66 import org.osgi.service.useradmin.Role;
67 //import org.eclipse.ui.forms.AbstractFormPart;
68 //import org.eclipse.ui.forms.IManagedForm;
69 //import org.eclipse.ui.forms.SectionPart;
70 //import org.eclipse.ui.forms.editor.FormEditor;
71 //import org.eclipse.ui.forms.editor.FormPage;
72 //import org.eclipse.ui.forms.widgets.FormToolkit;
73 //import org.eclipse.ui.forms.widgets.ScrolledForm;
74 //import org.eclipse.ui.forms.widgets.Section;
75 import org.osgi.service.useradmin.User;
76 import org.osgi.service.useradmin.UserAdmin;
77 import org.osgi.service.useradmin.UserAdminEvent;
78
79 /** Display/edit main properties of a given group */
80 public class GroupEditor extends AbstractRoleEditor {
81 // final static String ID = "GroupEditor.mainPage";
82
83 @Inject
84 private EPartService partService;
85
86 // private final UserEditor editor;
87 @Inject
88 private Repository repository;
89 @Inject
90 private NodeInstance nodeInstance;
91 // private final UserAdminWrapper userAdminWrapper;
92 private Session groupsSession;
93
94 // public GroupMainPage(FormEditor editor, UserAdminWrapper userAdminWrapper,
95 // Repository repository,
96 // NodeInstance nodeInstance) {
97 // super(editor, ID, "Main");
98 // try {
99 // session = repository.login();
100 // } catch (RepositoryException e) {
101 // throw new CmsException("Cannot retrieve session of in MainGroupPage
102 // constructor", e);
103 // }
104 // this.editor = (UserEditor) editor;
105 // this.userAdminWrapper = userAdminWrapper;
106 // this.nodeInstance = nodeInstance;
107 // }
108
109 // protected void createFormContent(final IManagedForm mf) {
110 // ScrolledForm form = mf.getForm();
111 // Composite body = form.getBody();
112 // GridLayout mainLayout = new GridLayout();
113 // body.setLayout(mainLayout);
114 // Group group = (Group) editor.getDisplayedUser();
115 // appendOverviewPart(body, group);
116 // appendMembersPart(body, group);
117 // }
118
119 @Override
120 protected void createUi(Composite parent) {
121 try {
122 groupsSession = repository.login(NodeConstants.SRV_WORKSPACE);
123 } catch (RepositoryException e) {
124 throw new CmsException("Cannot retrieve session", e);
125 }
126 // ScrolledForm form = mf.getForm();
127 // Composite body = form.getBody();
128 // Composite body = new Composite(parent, SWT.NONE);
129 Composite body = parent;
130 GridLayout mainLayout = new GridLayout();
131 body.setLayout(mainLayout);
132 Group group = (Group) getDisplayedUser();
133 appendOverviewPart(body, group);
134 appendMembersPart(body, group);
135 }
136
137 @PreDestroy
138 public void dispose() {
139 JcrUtils.logoutQuietly(groupsSession);
140 super.dispose();
141 }
142
143 /** Creates the general section */
144 protected void appendOverviewPart(final Composite parent, final Group group) {
145 Composite body = new Composite(parent, SWT.NONE);
146 // GridLayout layout = new GridLayout(5, false);
147 GridLayout layout = new GridLayout(2, false);
148 body.setLayout(layout);
149 body.setLayoutData(CmsUiUtils.fillWidth());
150
151 String cn = UserAdminUtils.getProperty(group, LdapAttrs.cn.name());
152 createReadOnlyLT(body, "Name", cn);
153 createReadOnlyLT(body, "DN", group.getName());
154 createReadOnlyLT(body, "Domain", UserAdminUtils.getDomainName(group));
155
156 // Description
157 Label descLbl = new Label(body, SWT.LEAD);
158 descLbl.setFont(EclipseUiUtils.getBoldFont(body));
159 descLbl.setText("Description");
160 descLbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, true, false, 2, 1));
161 final Text descTxt = new Text(body, SWT.LEAD | SWT.MULTI | SWT.WRAP | SWT.BORDER);
162 GridData gd = EclipseUiUtils.fillWidth();
163 gd.heightHint = 50;
164 gd.horizontalSpan = 2;
165 descTxt.setLayoutData(gd);
166
167 // Mark as workgroup
168 Link markAsWorkgroupLk = new Link(body, SWT.NONE);
169 markAsWorkgroupLk.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false, 2, 1));
170
171 // create form part (controller)
172 final AbstractFormPart part = new AbstractFormPart() {
173
174 private MainInfoListener listener;
175
176 @Override
177 public void initialize(IManagedForm form) {
178 super.initialize(form);
179 listener = new MainInfoListener(parent.getDisplay(), this);
180 userAdminWrapper.addListener(listener);
181 }
182
183 @Override
184 public void dispose() {
185 userAdminWrapper.removeListener(listener);
186 super.dispose();
187 }
188
189 public void commit(boolean onSave) {
190 // group.getProperties().put(LdapAttrs.description.name(), descTxt.getText());
191 setProperty(group, description, descTxt.getText());
192 super.commit(onSave);
193 }
194
195 @Override
196 public void refresh() {
197 // dnTxt.setText(group.getName());
198 // cnTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.cn.name()));
199 descTxt.setText(UserAdminUtils.getProperty(group, LdapAttrs.description.name()));
200 Node workgroupHome = NodeUtils.getGroupHome(groupsSession, cn);
201 if (workgroupHome == null)
202 markAsWorkgroupLk.setText("<a>Mark as workgroup</a>");
203 else
204 markAsWorkgroupLk.setText("Configured as workgroup");
205 parent.layout(true, true);
206 super.refresh();
207 }
208 };
209
210 markAsWorkgroupLk.addSelectionListener(new SelectionAdapter() {
211 private static final long serialVersionUID = -6439340898096365078L;
212
213 @Override
214 public void widgetSelected(SelectionEvent e) {
215
216 boolean confirmed = MessageDialog.openConfirm(parent.getShell(), "Mark as workgroup",
217 "Are you sure you want to mark " + cn + " as being a workgroup? ");
218 if (confirmed) {
219 Node workgroupHome = NodeUtils.getGroupHome(groupsSession, cn);
220 if (workgroupHome != null)
221 return; // already marked as workgroup, do nothing
222 else
223 try {
224 // improve transaction management
225 userAdminWrapper.beginTransactionIfNeeded();
226 nodeInstance.createWorkgroup(new LdapName(group.getName()));
227 setProperty(group, businessCategory, WORKGROUP);
228 userAdminWrapper.commitOrNotifyTransactionStateChange();
229 userAdminWrapper
230 .notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, group));
231 part.refresh();
232 } catch (InvalidNameException e1) {
233 throw new CmsException("Cannot create Workgroup for " + group.toString(), e1);
234 }
235
236 }
237 }
238 });
239
240 ModifyListener defaultListener = new FormPartML(part);
241 descTxt.addModifyListener(defaultListener);
242 getManagedForm().addPart(part);
243 }
244
245 /** Filtered table with members. Has drag and drop ability */
246 protected void appendMembersPart(Composite parent, Group group) {
247 // Section section = tk.createSection(parent, Section.TITLE_BAR);
248 // section.setText("Members");
249 // section.setLayoutData(EclipseUiUtils.fillAll());
250
251 Composite body = new Composite(parent, SWT.BORDER);
252 body.setLayout(new GridLayout());
253 // section.setClient(body);
254 body.setLayoutData(EclipseUiUtils.fillAll());
255
256 // Define the displayed columns
257 List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
258 columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
259 columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
260 columnDefs.add(new ColumnDefinition(new MailLP(), "Mail", 150));
261 // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished Name",
262 // 240));
263
264 // Create and configure the table
265 LdifUsersTable userViewerCmp = new MyUserTableViewer(body, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL,
266 userAdminWrapper.getUserAdmin());
267
268 userViewerCmp.setColumnDefinitions(columnDefs);
269 userViewerCmp.populate(true, false);
270 userViewerCmp.setLayoutData(EclipseUiUtils.fillAll());
271
272 // Controllers
273 TableViewer userViewer = userViewerCmp.getTableViewer();
274 userViewer.addDoubleClickListener(new UserTableDefaultDClickListener(partService));
275 int operations = DND.DROP_COPY | DND.DROP_MOVE;
276 Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
277 userViewer.addDropSupport(operations, tt,
278 new GroupDropListener(userAdminWrapper, userViewerCmp, (Group) getDisplayedUser()));
279
280 AbstractFormPart part = new GroupMembersPart(userViewerCmp);
281 getManagedForm().addPart(part);
282
283 // remove button
284 // addRemoveAbility(toolBarManager, userViewerCmp.getTableViewer(), group);
285 Action action = new RemoveMembershipAction(userViewer, group, "Remove selected items from this group",
286 SecurityAdminImages.ICON_REMOVE_DESC);
287
288 ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
289 ToolBar toolBar = toolBarManager.createControl(body);
290 toolBar.setLayoutData(CmsUiUtils.fillWidth());
291
292 toolBarManager.add(action);
293 toolBarManager.update(true);
294
295 }
296
297 // private LdifUsersTable createMemberPart(Composite parent, Group group) {
298 //
299 // // Define the displayed columns
300 // List<ColumnDefinition> columnDefs = new ArrayList<ColumnDefinition>();
301 // columnDefs.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
302 // columnDefs.add(new ColumnDefinition(new CommonNameLP(), "Name", 150));
303 // columnDefs.add(new ColumnDefinition(new MailLP(), "Mail", 150));
304 // // columnDefs.add(new ColumnDefinition(new UserNameLP(), "Distinguished
305 // Name",
306 // // 240));
307 //
308 // // Create and configure the table
309 // LdifUsersTable userViewerCmp = new MyUserTableViewer(parent, SWT.MULTI |
310 // SWT.H_SCROLL | SWT.V_SCROLL,
311 // userAdminWrapper.getUserAdmin());
312 //
313 // userViewerCmp.setColumnDefinitions(columnDefs);
314 // userViewerCmp.populate(true, false);
315 // userViewerCmp.setLayoutData(EclipseUiUtils.fillAll());
316 //
317 // // Controllers
318 // TableViewer userViewer = userViewerCmp.getTableViewer();
319 // userViewer.addDoubleClickListener(new
320 // UserTableDefaultDClickListener(partService));
321 // int operations = DND.DROP_COPY | DND.DROP_MOVE;
322 // Transfer[] tt = new Transfer[] { TextTransfer.getInstance() };
323 // userViewer.addDropSupport(operations, tt,
324 // new GroupDropListener(userAdminWrapper, userViewerCmp, (Group)
325 // getDisplayedUser()));
326 //
327 // // userViewerCmp.refresh();
328 // return userViewerCmp;
329 // }
330
331 // Local viewers
332 private class MyUserTableViewer extends LdifUsersTable {
333 private static final long serialVersionUID = 8467999509931900367L;
334
335 private final UserFilter userFilter;
336
337 public MyUserTableViewer(Composite parent, int style, UserAdmin userAdmin) {
338 super(parent, style, true);
339 userFilter = new UserFilter();
340
341 }
342
343 @Override
344 protected List<User> listFilteredElements(String filter) {
345 // reload user and set it in the editor
346 Group group = (Group) getDisplayedUser();
347 Role[] roles = group.getMembers();
348 List<User> users = new ArrayList<User>();
349 userFilter.setSearchText(filter);
350 // userFilter.setShowSystemRole(true);
351 for (Role role : roles)
352 // if (role.getType() == Role.GROUP)
353 if (userFilter.select(null, null, role))
354 users.add((User) role);
355 return users;
356 }
357 }
358
359 // private void addRemoveAbility(ToolBarManager toolBarManager, TableViewer
360 // userViewer, Group group) {
361 // // Section section = sectionPart.getSection();
362 // // ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
363 // // ToolBar toolbar = toolBarManager.createControl(parent);
364 // // ToolBar toolbar = toolBarManager.getControl();
365 // // final Cursor handCursor = new Cursor(toolbar.getDisplay(),
366 // SWT.CURSOR_HAND);
367 // // toolbar.setCursor(handCursor);
368 // // toolbar.addDisposeListener(new DisposeListener() {
369 // // private static final long serialVersionUID = 3882131405820522925L;
370 // //
371 // // public void widgetDisposed(DisposeEvent e) {
372 // // if ((handCursor != null) && (handCursor.isDisposed() == false)) {
373 // // handCursor.dispose();
374 // // }
375 // // }
376 // // });
377 //
378 // Action action = new RemoveMembershipAction(userViewer, group, "Remove
379 // selected items from this group",
380 // SecurityAdminImages.ICON_REMOVE_DESC);
381 // toolBarManager.add(action);
382 // toolBarManager.update(true);
383 // // section.setTextClient(toolbar);
384 // }
385
386 private class RemoveMembershipAction extends Action {
387 private static final long serialVersionUID = -1337713097184522588L;
388
389 private final TableViewer userViewer;
390 private final Group group;
391
392 RemoveMembershipAction(TableViewer userViewer, Group group, String name, ImageDescriptor img) {
393 super(name, img);
394 this.userViewer = userViewer;
395 this.group = group;
396 }
397
398 @Override
399 public void run() {
400 ISelection selection = userViewer.getSelection();
401 if (selection.isEmpty())
402 return;
403
404 @SuppressWarnings("unchecked")
405 Iterator<User> it = ((IStructuredSelection) selection).iterator();
406 List<User> users = new ArrayList<User>();
407 while (it.hasNext()) {
408 User currUser = it.next();
409 users.add(currUser);
410 }
411
412 userAdminWrapper.beginTransactionIfNeeded();
413 for (User user : users) {
414 group.removeMember(user);
415 }
416 userAdminWrapper.commitOrNotifyTransactionStateChange();
417 userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, group));
418 }
419 }
420
421 // LOCAL CONTROLLERS
422 private class GroupMembersPart extends AbstractFormPart {
423 private final LdifUsersTable userViewer;
424 // private final Group group;
425
426 private GroupChangeListener listener;
427
428 public GroupMembersPart(LdifUsersTable userViewer) {
429 // super(section);
430 this.userViewer = userViewer;
431 // this.group = group;
432 }
433
434 @Override
435 public void initialize(IManagedForm form) {
436 super.initialize(form);
437 listener = new GroupChangeListener(userViewer.getDisplay(), GroupMembersPart.this);
438 userAdminWrapper.addListener(listener);
439 }
440
441 @Override
442 public void dispose() {
443 userAdminWrapper.removeListener(listener);
444 super.dispose();
445 }
446
447 @Override
448 public void refresh() {
449 userViewer.refresh();
450 super.refresh();
451 }
452 }
453
454 /**
455 * Defines this table as being a potential target to add group membership
456 * (roles) to this group
457 */
458 private class GroupDropListener extends ViewerDropAdapter {
459 private static final long serialVersionUID = 2893468717831451621L;
460
461 private final UserAdminWrapper userAdminWrapper;
462 // private final LdifUsersTable myUserViewerCmp;
463 private final Group myGroup;
464
465 public GroupDropListener(UserAdminWrapper userAdminWrapper, LdifUsersTable userTableViewerCmp, Group group) {
466 super(userTableViewerCmp.getTableViewer());
467 this.userAdminWrapper = userAdminWrapper;
468 this.myGroup = group;
469 // this.myUserViewerCmp = userTableViewerCmp;
470 }
471
472 @Override
473 public boolean validateDrop(Object target, int operation, TransferData transferType) {
474 // Target is always OK in a list only view
475 // TODO check if not a string
476 boolean validDrop = true;
477 return validDrop;
478 }
479
480 @Override
481 public void drop(DropTargetEvent event) {
482 // TODO Is there an opportunity to perform the check before?
483 String newUserName = (String) event.data;
484 UserAdmin myUserAdmin = userAdminWrapper.getUserAdmin();
485 Role role = myUserAdmin.getRole(newUserName);
486 if (role.getType() == Role.GROUP) {
487 Group newGroup = (Group) role;
488 Shell shell = getViewer().getControl().getShell();
489 // Sanity checks
490 if (myGroup == newGroup) { // Equality
491 MessageDialog.openError(shell, "Forbidden addition ", "A group cannot be a member of itself.");
492 return;
493 }
494
495 // Cycle
496 String myName = myGroup.getName();
497 List<User> myMemberships = getFlatGroups(myGroup);
498 if (myMemberships.contains(newGroup)) {
499 MessageDialog.openError(shell, "Forbidden addition: cycle",
500 "Cannot add " + newUserName + " to group " + myName + ". This would create a cycle");
501 return;
502 }
503
504 // Already member
505 List<User> newGroupMemberships = getFlatGroups(newGroup);
506 if (newGroupMemberships.contains(myGroup)) {
507 MessageDialog.openError(shell, "Forbidden addition",
508 "Cannot add " + newUserName + " to group " + myName + ", this membership already exists");
509 return;
510 }
511 userAdminWrapper.beginTransactionIfNeeded();
512 myGroup.addMember(newGroup);
513 userAdminWrapper.commitOrNotifyTransactionStateChange();
514 userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, myGroup));
515 } else if (role.getType() == Role.USER) {
516 // TODO check if the group is already member of this group
517 UserTransaction transaction = userAdminWrapper.beginTransactionIfNeeded();
518 User user = (User) role;
519 myGroup.addMember(user);
520 if (UserAdminWrapper.COMMIT_ON_SAVE)
521 try {
522 transaction.commit();
523 } catch (Exception e) {
524 throw new CmsException("Cannot commit transaction " + "after user group membership update", e);
525 }
526 userAdminWrapper.notifyListeners(new UserAdminEvent(null, UserAdminEvent.ROLE_CHANGED, myGroup));
527 }
528 super.drop(event);
529 }
530
531 @Override
532 public boolean performDrop(Object data) {
533 // myUserViewerCmp.refresh();
534 return true;
535 }
536 }
537
538 // LOCAL HELPERS
539 // private Composite addSection(FormToolkit tk, Composite parent) {
540 // Section section = tk.createSection(parent, SWT.NO_FOCUS);
541 // section.setLayoutData(EclipseUiUtils.fillWidth());
542 // Composite body = tk.createComposite(section, SWT.WRAP);
543 // body.setLayoutData(EclipseUiUtils.fillAll());
544 // section.setClient(body);
545 // return body;
546 // }
547
548 /** Creates label and text. */
549 // private Text createLT(Composite parent, String label, String value) {
550 // FormToolkit toolkit = getManagedForm().getToolkit();
551 // Label lbl = toolkit.createLabel(parent, label);
552 // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
553 // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
554 // Text text = toolkit.createText(parent, value, SWT.BORDER);
555 // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
556 // CmsUiUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
557 // return text;
558 // }
559 //
560 // Text createReadOnlyLT(Composite parent, String label, String value) {
561 // FormToolkit toolkit = getManagedForm().getToolkit();
562 // Label lbl = toolkit.createLabel(parent, label);
563 // lbl.setLayoutData(new GridData(SWT.LEAD, SWT.CENTER, false, false));
564 // lbl.setFont(EclipseUiUtils.getBoldFont(parent));
565 // Text text = toolkit.createText(parent, value, SWT.NONE);
566 // text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
567 // text.setEditable(false);
568 // CmsUiUtils.style(text, CmsWorkbenchStyles.WORKBENCH_FORM_TEXT);
569 // return text;
570 // }
571
572 }