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
.security
.ui
.admin
.internal
.parts
;
18 import java
.util
.ArrayList
;
19 import java
.util
.Iterator
;
20 import java
.util
.List
;
22 import org
.argeo
.cms
.CmsException
;
23 import org
.argeo
.cms
.auth
.AuthConstants
;
24 import org
.argeo
.cms
.util
.useradmin
.UserAdminUtils
;
25 import org
.argeo
.eclipse
.ui
.ColumnDefinition
;
26 import org
.argeo
.eclipse
.ui
.EclipseUiUtils
;
27 import org
.argeo
.eclipse
.ui
.parts
.LdifUsersTable
;
28 import org
.argeo
.jcr
.ArgeoNames
;
29 import org
.argeo
.osgi
.useradmin
.LdifName
;
30 import org
.argeo
.security
.ui
.admin
.SecurityAdminImages
;
31 import org
.argeo
.security
.ui
.admin
.internal
.UserAdminWrapper
;
32 import org
.argeo
.security
.ui
.admin
.internal
.parts
.UserEditor
.GroupChangeListener
;
33 import org
.argeo
.security
.ui
.admin
.internal
.parts
.UserEditor
.MainInfoListener
;
34 import org
.argeo
.security
.ui
.admin
.internal
.providers
.CommonNameLP
;
35 import org
.argeo
.security
.ui
.admin
.internal
.providers
.DomainNameLP
;
36 import org
.argeo
.security
.ui
.admin
.internal
.providers
.RoleIconLP
;
37 import org
.argeo
.security
.ui
.admin
.internal
.providers
.UserFilter
;
38 import org
.argeo
.security
.ui
.admin
.internal
.providers
.UserNameLP
;
39 import org
.argeo
.security
.ui
.admin
.internal
.providers
.UserTableDefaultDClickListener
;
40 import org
.eclipse
.jface
.action
.Action
;
41 import org
.eclipse
.jface
.action
.ToolBarManager
;
42 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
43 import org
.eclipse
.jface
.viewers
.ISelection
;
44 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
45 import org
.eclipse
.jface
.viewers
.TableViewer
;
46 import org
.eclipse
.jface
.viewers
.Viewer
;
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
.DisposeEvent
;
55 import org
.eclipse
.swt
.events
.DisposeListener
;
56 import org
.eclipse
.swt
.events
.ModifyEvent
;
57 import org
.eclipse
.swt
.events
.ModifyListener
;
58 import org
.eclipse
.swt
.events
.SelectionAdapter
;
59 import org
.eclipse
.swt
.events
.SelectionEvent
;
60 import org
.eclipse
.swt
.graphics
.Cursor
;
61 import org
.eclipse
.swt
.layout
.GridData
;
62 import org
.eclipse
.swt
.layout
.GridLayout
;
63 import org
.eclipse
.swt
.widgets
.Button
;
64 import org
.eclipse
.swt
.widgets
.Composite
;
65 import org
.eclipse
.swt
.widgets
.Label
;
66 import org
.eclipse
.swt
.widgets
.Text
;
67 import org
.eclipse
.swt
.widgets
.ToolBar
;
68 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
69 import org
.eclipse
.ui
.forms
.IManagedForm
;
70 import org
.eclipse
.ui
.forms
.SectionPart
;
71 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
72 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
73 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
74 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
75 import org
.eclipse
.ui
.forms
.widgets
.Section
;
76 import org
.osgi
.service
.useradmin
.Group
;
77 import org
.osgi
.service
.useradmin
.Role
;
78 import org
.osgi
.service
.useradmin
.User
;
79 import org
.osgi
.service
.useradmin
.UserAdmin
;
80 import org
.osgi
.service
.useradmin
.UserAdminEvent
;
82 /** Display/edit the properties of a given user */
83 public class UserMainPage
extends FormPage
implements ArgeoNames
{
84 final static String ID
= "UserEditor.mainPage";
86 private final UserEditor editor
;
87 private UserAdminWrapper userAdminWrapper
;
89 // Local configuration
90 private final int PRE_TITLE_INDENT
= 10;
92 public UserMainPage(FormEditor editor
, UserAdminWrapper userAdminWrapper
) {
93 super(editor
, ID
, "Main");
94 this.editor
= (UserEditor
) editor
;
95 this.userAdminWrapper
= userAdminWrapper
;
98 protected void createFormContent(final IManagedForm mf
) {
99 ScrolledForm form
= mf
.getForm();
100 Composite body
= form
.getBody();
101 GridLayout mainLayout
= new GridLayout();
102 // mainLayout.marginRight = 10;
103 body
.setLayout(mainLayout
);
104 User user
= editor
.getDisplayedUser();
105 appendOverviewPart(body
, user
);
106 // Remove to ability to force the password for his own user. The user
107 // must then use the change pwd feature
108 if (!UserAdminUtils
.isCurrentUser(user
))
109 appendPasswordPart(body
, user
);
110 appendMemberOfPart(body
, user
);
113 /** Creates the general section */
114 private void appendOverviewPart(final Composite parent
, final User user
) {
115 FormToolkit tk
= getManagedForm().getToolkit();
117 Section section
= addSection(tk
, parent
, "Main information");
118 Composite body
= (Composite
) section
.getClient();
119 body
.setLayout(new GridLayout(2, false));
121 final Text distinguishedName
= createLT(tk
, body
, "User Name",
122 UserAdminUtils
.getProperty(user
, LdifName
.uid
.name()));
123 distinguishedName
.setEnabled(false);
125 final Text commonName
= createLT(tk
, body
, "Common Name",
126 UserAdminUtils
.getProperty(user
, LdifName
.cn
.name()));
127 commonName
.setEnabled(false);
129 final Text firstName
= createLT(tk
, body
, "First name",
130 UserAdminUtils
.getProperty(user
, LdifName
.givenName
.name()));
132 final Text lastName
= createLT(tk
, body
, "Last name",
133 UserAdminUtils
.getProperty(user
, LdifName
.sn
.name()));
135 final Text email
= createLT(tk
, body
, "Email",
136 UserAdminUtils
.getProperty(user
, LdifName
.mail
.name()));
138 // create form part (controller)
139 AbstractFormPart part
= new SectionPart((Section
) body
.getParent()) {
140 private MainInfoListener listener
;
143 public void initialize(IManagedForm form
) {
144 super.initialize(form
);
145 listener
= editor
.new MainInfoListener(parent
.getDisplay(),
147 userAdminWrapper
.addListener(listener
);
151 public void dispose() {
152 userAdminWrapper
.removeListener(listener
);
156 @SuppressWarnings("unchecked")
157 public void commit(boolean onSave
) {
158 // TODO Sanity checks (mail validity...)
159 user
.getProperties().put(LdifName
.givenName
.name(),
160 firstName
.getText());
162 .put(LdifName
.sn
.name(), lastName
.getText());
163 user
.getProperties().put(LdifName
.cn
.name(),
164 commonName
.getText());
165 user
.getProperties().put(LdifName
.mail
.name(), email
.getText());
166 super.commit(onSave
);
170 public void refresh() {
171 distinguishedName
.setText(UserAdminUtils
.getProperty(user
,
172 LdifName
.uid
.name()));
173 commonName
.setText(UserAdminUtils
.getProperty(user
,
174 LdifName
.cn
.name()));
175 firstName
.setText(UserAdminUtils
.getProperty(user
,
176 LdifName
.givenName
.name()));
177 lastName
.setText(UserAdminUtils
.getProperty(user
,
178 LdifName
.sn
.name()));
179 email
.setText(UserAdminUtils
.getProperty(user
,
180 LdifName
.mail
.name()));
181 refreshFormTitle(user
);
186 // Improve this: automatically generate CN when first or last name
188 ModifyListener cnML
= new ModifyListener() {
189 private static final long serialVersionUID
= 4298649222869835486L;
192 public void modifyText(ModifyEvent event
) {
193 String first
= firstName
.getText();
194 String last
= lastName
.getText();
195 String cn
= first
.trim() + " " + last
.trim() + " ";
197 commonName
.setText(cn
);
198 getManagedForm().getForm().setText(cn
);
199 editor
.updateEditorTitle(cn
);
202 firstName
.addModifyListener(cnML
);
203 lastName
.addModifyListener(cnML
);
205 ModifyListener defaultListener
= editor
.new FormPartML(part
);
206 firstName
.addModifyListener(defaultListener
);
207 lastName
.addModifyListener(defaultListener
);
208 email
.addModifyListener(defaultListener
);
209 getManagedForm().addPart(part
);
212 /** Creates the password section */
213 private void appendPasswordPart(Composite parent
, final User user
) {
214 FormToolkit tk
= getManagedForm().getToolkit();
215 Section section
= addSection(tk
, parent
, "Password");
216 Composite body
= (Composite
) section
.getClient();
217 body
.setLayout(new GridLayout(2, false));
219 // add widgets (view)
220 final Text password1
= createLP(tk
, body
, "New password", "");
221 final Text password2
= createLP(tk
, body
, "Repeat password", "");
223 // create form part (controller)
224 AbstractFormPart part
= new SectionPart((Section
) body
.getParent()) {
225 @SuppressWarnings("unchecked")
226 public void commit(boolean onSave
) {
227 if (!password1
.getText().equals("")
228 || !password2
.getText().equals("")) {
229 if (password1
.getText().equals(password2
.getText())) {
230 char[] newPassword
= password1
.getText().toCharArray();
231 // userAdminWrapper.beginTransactionIfNeeded();
232 user
.getCredentials().put(null, newPassword
);
233 password1
.setText("");
234 password2
.setText("");
235 super.commit(onSave
);
237 password1
.setText("");
238 password2
.setText("");
239 throw new CmsException("Passwords are not equals");
244 ModifyListener defaultListener
= editor
.new FormPartML(part
);
245 password1
.addModifyListener(defaultListener
);
246 password2
.addModifyListener(defaultListener
);
247 getManagedForm().addPart(part
);
250 private LdifUsersTable
appendMemberOfPart(final Composite parent
, User user
) {
251 FormToolkit tk
= getManagedForm().getToolkit();
252 Section section
= addSection(tk
, parent
, "Roles");
253 Composite body
= (Composite
) section
.getClient();
254 body
.setLayout(EclipseUiUtils
.noSpaceGridLayout());
256 boolean isAdmin
= UserAdminUtils
.isUserInRole(AuthConstants
.ROLE_ADMIN
);
259 List
<ColumnDefinition
> columnDefs
= new ArrayList
<ColumnDefinition
>();
260 columnDefs
.add(new ColumnDefinition(new RoleIconLP(), "", 0, 24));
261 columnDefs
.add(new ColumnDefinition(new CommonNameLP(), "Common Name",
263 columnDefs
.add(new ColumnDefinition(new DomainNameLP(), "Domain Name",
265 // Only show technical DN to administrators
267 columnDefs
.add(new ColumnDefinition(new UserNameLP(),
268 "Distinguished Name", 120));
270 // Create and configure the table
271 final LdifUsersTable userViewerCmp
= new MyUserTableViewer(body
,
272 SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
, user
);
274 userViewerCmp
.setColumnDefinitions(columnDefs
);
276 userViewerCmp
.populateWithStaticFilters(false, false);
278 userViewerCmp
.populate(true, false);
279 GridData gd
= EclipseUiUtils
.fillAll();
281 userViewerCmp
.setLayoutData(gd
);
284 TableViewer userViewer
= userViewerCmp
.getTableViewer();
285 userViewer
.addDoubleClickListener(new UserTableDefaultDClickListener());
286 int operations
= DND
.DROP_COPY
| DND
.DROP_MOVE
;
287 Transfer
[] tt
= new Transfer
[] { TextTransfer
.getInstance() };
288 GroupDropListener dropL
= new GroupDropListener(userAdminWrapper
,
290 userViewer
.addDropSupport(operations
, tt
, dropL
);
292 SectionPart part
= new SectionPart((Section
) body
.getParent()) {
294 private GroupChangeListener listener
;
297 public void initialize(IManagedForm form
) {
298 super.initialize(form
);
299 listener
= editor
.new GroupChangeListener(parent
.getDisplay(),
301 userAdminWrapper
.addListener(listener
);
304 public void commit(boolean onSave
) {
305 super.commit(onSave
);
309 public void dispose() {
310 userAdminWrapper
.removeListener(listener
);
315 public void refresh() {
316 userViewerCmp
.refresh();
320 getManagedForm().addPart(part
);
321 addRemoveAbitily(part
, userViewer
, user
);
322 return userViewerCmp
;
325 private class MyUserTableViewer
extends LdifUsersTable
{
326 private static final long serialVersionUID
= 2653790051461237329L;
328 private Button showSystemRoleBtn
;
330 private final User user
;
331 private final UserFilter userFilter
;
333 public MyUserTableViewer(Composite parent
, int style
, User user
) {
334 super(parent
, style
, true);
336 userFilter
= new UserFilter();
337 userFilter
.setShowSystemRole(false);
340 protected void populateStaticFilters(Composite staticFilterCmp
) {
341 staticFilterCmp
.setLayout(new GridLayout());
342 showSystemRoleBtn
= new Button(staticFilterCmp
, SWT
.CHECK
);
343 showSystemRoleBtn
.setText("Show system roles");
344 showSystemRoleBtn
.addSelectionListener(new SelectionAdapter() {
345 private static final long serialVersionUID
= -7033424592697691676L;
348 public void widgetSelected(SelectionEvent e
) {
349 userFilter
.setShowSystemRole(showSystemRoleBtn
357 protected List
<User
> listFilteredElements(String filter
) {
358 List
<User
> users
= (List
<User
>) editor
.getFlatGroups(null);
359 List
<User
> filteredUsers
= new ArrayList
<User
>();
360 if (users
.contains(user
))
362 userFilter
.setSearchText(filter
);
363 for (User user
: users
)
364 if (userFilter
.select(null, null, user
))
365 filteredUsers
.add(user
);
366 return filteredUsers
;
370 private void addRemoveAbitily(SectionPart sectionPart
,
371 TableViewer userViewer
, User user
) {
372 Section section
= sectionPart
.getSection();
373 ToolBarManager toolBarManager
= new ToolBarManager(SWT
.FLAT
);
374 ToolBar toolbar
= toolBarManager
.createControl(section
);
375 final Cursor handCursor
= new Cursor(section
.getDisplay(),
377 toolbar
.setCursor(handCursor
);
378 toolbar
.addDisposeListener(new DisposeListener() {
379 private static final long serialVersionUID
= 3882131405820522925L;
381 public void widgetDisposed(DisposeEvent e
) {
382 if ((handCursor
!= null) && (handCursor
.isDisposed() == false)) {
383 handCursor
.dispose();
388 String tooltip
= "Remove " + UserAdminUtils
.getUsername(user
)
389 + " from the below selected groups";
390 Action action
= new RemoveMembershipAction(userViewer
, user
, tooltip
,
391 SecurityAdminImages
.ICON_REMOVE_DESC
);
392 toolBarManager
.add(action
);
393 toolBarManager
.update(true);
394 section
.setTextClient(toolbar
);
397 private class RemoveMembershipAction
extends Action
{
398 private static final long serialVersionUID
= -1337713097184522588L;
400 private final TableViewer userViewer
;
401 private final User user
;
403 RemoveMembershipAction(TableViewer userViewer
, User user
, String name
,
404 ImageDescriptor img
) {
406 this.userViewer
= userViewer
;
412 ISelection selection
= userViewer
.getSelection();
413 if (selection
.isEmpty())
416 @SuppressWarnings("unchecked")
417 Iterator
<Group
> it
= ((IStructuredSelection
) selection
).iterator();
418 List
<Group
> groups
= new ArrayList
<Group
>();
419 while (it
.hasNext()) {
420 Group currGroup
= it
.next();
421 groups
.add(currGroup
);
424 userAdminWrapper
.beginTransactionIfNeeded();
425 for (Group group
: groups
) {
426 group
.removeMember(user
);
428 userAdminWrapper
.commitOrNotifyTransactionStateChange();
429 for (Group group
: groups
) {
430 userAdminWrapper
.notifyListeners(new UserAdminEvent(null,
431 UserAdminEvent
.ROLE_CHANGED
, group
));
437 * Defines the table as being a potential target to add group memberships
438 * (roles) to this user
440 private class GroupDropListener
extends ViewerDropAdapter
{
441 private static final long serialVersionUID
= 2893468717831451621L;
443 private final UserAdminWrapper myUserAdminWrapper
;
444 private final User myUser
;
446 public GroupDropListener(UserAdminWrapper userAdminWrapper
,
447 Viewer userViewer
, User user
) {
449 this.myUserAdminWrapper
= userAdminWrapper
;
454 public boolean validateDrop(Object target
, int operation
,
455 TransferData transferType
) {
456 // Target is always OK in a list only view
457 // TODO check if not a string
458 boolean validDrop
= true;
463 public void drop(DropTargetEvent event
) {
464 String name
= (String
) event
.data
;
465 UserAdmin myUserAdmin
= myUserAdminWrapper
.getUserAdmin();
466 Role role
= myUserAdmin
.getRole(name
);
467 // TODO this check should be done before.
468 if (role
.getType() == Role
.GROUP
) {
469 // TODO check if the user is already member of this group
471 myUserAdminWrapper
.beginTransactionIfNeeded();
472 Group group
= (Group
) role
;
473 group
.addMember(myUser
);
474 userAdminWrapper
.commitOrNotifyTransactionStateChange();
475 myUserAdminWrapper
.notifyListeners(new UserAdminEvent(null,
476 UserAdminEvent
.ROLE_CHANGED
, group
));
482 public boolean performDrop(Object data
) {
483 // userTableViewerCmp.refresh();
489 private void refreshFormTitle(User group
) {
490 getManagedForm().getForm().setText(
491 UserAdminUtils
.getProperty(group
, LdifName
.cn
.name()));
494 /** Appends a section with a title */
495 private Section
addSection(FormToolkit tk
, Composite parent
, String title
) {
496 Section section
= tk
.createSection(parent
, Section
.TITLE_BAR
);
497 GridData gd
= EclipseUiUtils
.fillWidth();
498 gd
.verticalAlignment
= PRE_TITLE_INDENT
;
499 section
.setLayoutData(gd
);
500 section
.setText(title
);
501 // section.getMenu().setVisible(true);
503 Composite body
= tk
.createComposite(section
, SWT
.WRAP
);
504 body
.setLayoutData(EclipseUiUtils
.fillAll());
505 section
.setClient(body
);
510 /** Creates label and multiline text. */
511 Text
createLMT(FormToolkit toolkit
, Composite body
, String label
,
513 Label lbl
= toolkit
.createLabel(body
, label
);
514 lbl
.setLayoutData(new GridData(SWT
.RIGHT
, SWT
.CENTER
, false, false));
515 Text text
= toolkit
.createText(body
, value
, SWT
.BORDER
| SWT
.MULTI
);
516 text
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, true));
520 /** Creates label and password. */
521 Text
createLP(FormToolkit toolkit
, Composite body
, String label
,
523 Label lbl
= toolkit
.createLabel(body
, label
);
524 lbl
.setLayoutData(new GridData(SWT
.RIGHT
, SWT
.CENTER
, false, false));
525 Text text
= toolkit
.createText(body
, value
, SWT
.BORDER
| SWT
.PASSWORD
);
526 text
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, false));
530 /** Creates label and text. */
531 Text
createLT(FormToolkit toolkit
, Composite body
, String label
,
533 Label lbl
= toolkit
.createLabel(body
, label
);
534 lbl
.setLayoutData(new GridData(SWT
.RIGHT
, SWT
.CENTER
, false, false));
535 Text text
= toolkit
.createText(body
, value
, SWT
.BORDER
);
536 text
.setLayoutData(new GridData(SWT
.FILL
, SWT
.CENTER
, true, false));