2 * Copyright (C) 2016 - 2020 Free Software Foundation
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Affero General Public License as
6 * published by the Free Software Foundation, either version 3 of the
7 * License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Affero General Public License for more details.
14 * You should have received a copy of the GNU Affero General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.jjobs.beans.user;
19 import java.text.MessageFormat;
20 import java.util.Locale;
21 import java.util.Objects;
23 import javax.enterprise.context.RequestScoped;
24 import javax.enterprise.event.Event;
25 import javax.enterprise.event.Observes;
26 import javax.enterprise.inject.Any;
27 import javax.faces.FacesException;
28 import javax.faces.application.FacesMessage;
29 import javax.faces.context.FacesContext;
30 import javax.faces.view.facelets.FaceletException;
31 import javax.inject.Inject;
32 import javax.inject.Named;
33 import org.mxchange.jcontacts.model.contact.Contact;
34 import org.mxchange.jcoreee.utils.FacesUtils;
35 import org.mxchange.jjobs.beans.BaseJobsBean;
36 import org.mxchange.jjobs.beans.contact.JobsAdminContactWebRequestController;
37 import org.mxchange.jjobs.beans.contact.JobsContactWebRequestController;
38 import org.mxchange.jjobs.beans.features.JobsFeaturesWebApplicationController;
39 import org.mxchange.jusercore.events.user.add.AdminAddedUserEvent;
40 import org.mxchange.jusercore.events.user.add.ObservableAdminAddedUserEvent;
41 import org.mxchange.jusercore.events.user.created.ObservableCreatedUserEvent;
42 import org.mxchange.jusercore.events.user.delete.AdminDeletedUserEvent;
43 import org.mxchange.jusercore.events.user.delete.ObservableAdminDeletedUserEvent;
44 import org.mxchange.jusercore.events.user.linked.AdminLinkedUserEvent;
45 import org.mxchange.jusercore.events.user.linked.ObservableAdminLinkedUserEvent;
46 import org.mxchange.jusercore.events.user.locked.AdminLockedUserEvent;
47 import org.mxchange.jusercore.events.user.locked.ObservableAdminLockedUserEvent;
48 import org.mxchange.jusercore.events.user.unlocked.AdminUnlockedUserEvent;
49 import org.mxchange.jusercore.events.user.unlocked.ObservableAdminUnlockedUserEvent;
50 import org.mxchange.jusercore.events.user.update.AdminUpdatedUserDataEvent;
51 import org.mxchange.jusercore.events.user.update.ObservableAdminUpdatedUserDataEvent;
52 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
53 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
54 import org.mxchange.jusercore.exceptions.UserNotFoundException;
55 import org.mxchange.jusercore.exceptions.UserStatusConfirmedException;
56 import org.mxchange.jusercore.exceptions.UserStatusLockedException;
57 import org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException;
58 import org.mxchange.jusercore.model.user.AdminUserSessionBeanRemote;
59 import org.mxchange.jusercore.model.user.LoginUser;
60 import org.mxchange.jusercore.model.user.User;
61 import org.mxchange.jusercore.model.user.UserSessionBeanRemote;
62 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
63 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
64 import org.mxchange.juserlogincore.container.login.UserLoginContainer;
65 import org.mxchange.juserlogincore.events.registration.ObservableUserRegisteredEvent;
66 import org.mxchange.juserlogincore.exceptions.UserPasswordRepeatMismatchException;
67 import org.mxchange.juserlogincore.login.UserLoginUtils;
70 * A user controller (bean)
72 * @author Roland Häder<roland@mxchange.org>
74 @Named ("adminUserController")
76 public class JobsAdminUserWebRequestBean extends BaseJobsBean implements JobsAdminUserWebRequestController {
81 private static final long serialVersionUID = 542_145_347_916L;
84 * An event fired when the administrator has added a new user
88 private Event<ObservableAdminAddedUserEvent> addedUserEvent;
91 * Regular contact controller
94 private JobsAdminContactWebRequestController adminContactController;
97 * Administrative user EJB
99 @EJB (lookup = "java:global/jjobs-ejb/adminUser!org.mxchange.jusercore.model.user.AdminUserSessionBeanRemote")
100 private AdminUserSessionBeanRemote adminUserBean;
105 private Contact contact;
108 * Regular contact controller
111 private JobsContactWebRequestController contactController;
114 * Event being fired when admin has deleted user
118 private Event<ObservableAdminDeletedUserEvent> deleteUserEvent;
121 * Features controller
124 private JobsFeaturesWebApplicationController featureController;
127 * An event fired when the administrator has updated a new user
131 private Event<ObservableAdminUpdatedUserDataEvent> updatedUserDataEvent;
141 @EJB (lookup = "java:global/jjobs-ejb/user!org.mxchange.jusercore.model.user.UserSessionBeanRemote")
142 private UserSessionBeanRemote userBean;
145 * Regular user controller
148 private JobsUserWebRequestController userController;
153 private String userDeleteReason;
156 * An event fired when the administrator has linked a user with existing
161 private Event<ObservableAdminLinkedUserEvent> userLinkedEvent;
164 * Regular user controller
167 private JobsUserListWebViewController userListController;
172 private String userLockReason;
175 * Event being fired when an administrator has locked a user
179 private Event<ObservableAdminLockedUserEvent> userLockedEvent;
182 * Flag whether user must change password after login
184 private Boolean userMustChangePassword;
189 private String userName;
192 * User password (clear-text from web form)
194 private String userPassword;
197 * User password repeated (clear-text from web form)
199 private String userPasswordRepeat;
202 * Whether the user wants a public profile
204 private ProfileMode userProfileMode;
207 * Event being fired when administrator unlocks an account
211 private Event<ObservableAdminUnlockedUserEvent> userUnlockedEvent;
214 * Default constructor
216 public JobsAdminUserWebRequestBean () {
217 // Call super constructor
222 * Adds user instance to database by preparing a complete user instance and
223 * sending it to the EJB. The data set in the controller is being verified,
224 * e.g. if the user name or email address is not used yet.
227 public void addUser () {
228 // As the form cannot validate the data (required="true"), check it here
229 if (this.getUserName() == null) {
231 throw new NullPointerException("userName is null"); //NOI18N
232 } else if (this.getUserName().isEmpty()) {
234 throw new IllegalArgumentException("userName is null"); //NOI18N
235 } else if (this.getContact() == null) {
236 // No contact instance set, so test required fields: gender, first name and family name
237 this.adminContactController.validateContactData();
240 // Create new user instance
241 final User newUser = this.createUserInstance();
243 // Is the user name or email address used already?
244 // @TODO Add password length check
245 if ((this.featureController.isFeatureEnabled("user_login_require_user_name")) && (this.userListController.isUserNameRegistered(newUser))) {
246 // User name is already used
247 throw new FaceletException(new UserNameAlreadyRegisteredException(newUser));
248 } else if ((this.getContact() == null) && (this.contactController.isEmailAddressRegistered(newUser.getUserContact()))) {
249 // Email address is already used
250 this.showFacesMessage("admin_add_user:emailAddress", "ERROR_EMAIL_ADDRESS_ALREADY_USED", FacesMessage.SEVERITY_WARN); //NOI18N
252 // Always clear password
253 this.setUserPassword(null);
254 this.setUserPasswordRepeat(null);
261 // Now, that all is set, call EJB
262 if (this.getContact() instanceof Contact) {
263 // Link contact with this user
264 final User updatedUser = this.adminUserBean.linkUser(newUser);
267 this.userLinkedEvent.fire(new AdminLinkedUserEvent(updatedUser));
270 final User updatedUser = this.adminUserBean.addUser(newUser);
273 this.addedUserEvent.fire(new AdminAddedUserEvent(updatedUser));
275 } catch (final UserNameAlreadyRegisteredException | EmailAddressAlreadyRegisteredException ex) {
277 throw new FaceletException(ex);
281 this.setContact(null);
288 * Event observer for when a bean helper has successfully created a user
289 * instance, means the user exists. If the user does not exist, this event
290 * should not fire but instead a proper exception must be thrown.
292 * @param event User created event
294 public void afterCreatedUserEvent (@Observes final ObservableCreatedUserEvent event) {
295 // Is the instance valid?
298 throw new NullPointerException("event is null"); //NOI18N
299 } else if (event.getCreatedUser() == null) {
301 throw new NullPointerException("event.createdUser is null"); //NOI18N
302 } else if (event.getCreatedUser().getUserId() == null) {
304 throw new NullPointerException("event.createdUser.userId is null"); //NOI18N
305 } else if (event.getCreatedUser().getUserId() < 1) {
307 throw new NullPointerException(MessageFormat.format("event.createdUser.userId={0} is not valid", event.getCreatedUser().getUserId())); //NOI18N
311 this.setUser(event.getCreatedUser());
315 * Event observer for new user registrations
317 * @param event User registration event
319 public void afterUserRegistrationEvent (@Observes final ObservableUserRegisteredEvent event) {
320 // Event and contained entity instance should not be null
323 throw new NullPointerException("event is null"); //NOI18N
324 } else if (event.getRegisteredUser() == null) {
326 throw new NullPointerException("event.user is null"); //NOI18N
327 } else if (event.getRegisteredUser().getUserId() == null) {
329 throw new NullPointerException("event.user.userId is null"); //NOI18N
330 } else if (event.getRegisteredUser().getUserId() < 1) {
332 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getRegisteredUser(), event.getRegisteredUser().getUserId())); //NOI18N
336 final User registeredUser = event.getRegisteredUser();
338 // @TODO Nothing to do with the user here?
344 * Deletes given user account
346 public void deleteUserData () {
347 // Is the user instance valid and CONFIRMED?
348 if (this.getUser() == null) {
350 throw new NullPointerException("user is null"); //NOI18N
351 } else if (this.getUser().getUserId() == null) {
353 throw new NullPointerException("user.userId is null"); //NOI18N
354 } else if (this.getUser().getUserId() < 1) {
356 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
360 // All fine, delete it
361 this.adminUserBean.deleteUser(this.getUser(), this.getUserDeleteReason());
362 } catch (final UserNotFoundException ex) {
363 // Should not happen, so throw again
364 throw new FaceletException(ex);
368 this.deleteUserEvent.fire(new AdminDeletedUserEvent(this.getUser(), this.getUserDeleteReason()));
372 * Edits currently loaded user's data in database.
374 public void editUserData () {
375 // Null password means not setting it
376 String encryptedPassword = null;
378 // Check if user instance is in helper and valid
379 if (this.getUser() == null) {
381 throw new NullPointerException("beanHelper.user is null"); //NOI18N
382 } else if (this.getUser().getUserId() == null) {
384 throw new NullPointerException("beanHelper.user.userId is null"); //NOI18N
385 } else if (this.getUser().getUserId() < 1) {
387 throw new IllegalStateException(MessageFormat.format("beanHelper.user.userId={0} is invalid", this.getUser().getUserId())); //NOI18N
388 } else if (this.getUserName() == null) {
389 // Not all required fields are set
390 throw new NullPointerException("this.userName is null"); //NOI18N
391 } else if (this.getUserName().isEmpty()) {
392 // Not all required fields are set
393 throw new IllegalArgumentException("this.userName is empty"); //NOI18N
394 } else if (((!this.getUserPassword().isEmpty()) || (!this.getUserPasswordRepeat().isEmpty())) && (!this.isSamePasswordEntered())) {
395 // Clear password fields
396 this.setUserPassword(null);
397 this.setUserPasswordRepeat(null);
399 // Not same password entered
400 this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_PASSWORD_REPEAT_DIFFERENT", FacesMessage.SEVERITY_INFO); //NOI18N
402 } else if ((!Objects.equals(this.getUser().getUserName(), this.getUserName())) && (this.userBean.ifUserNameExists(this.getUserName()))) {
406 // User name already exists
407 this.showFacesMessage("form_edit_user:userName", "ADMIN_USER_NAME_ALREADY_EXISTS", FacesMessage.SEVERITY_WARN); //NOI18N
409 } else if (this.isSamePasswordEntered()) {
410 // Same password entered, create container
411 if ((Objects.equals(this.getUser().getUserMustChangePassword(), this.getUserMustChangePassword())) && (UserLoginUtils.ifPasswordMatches(new UserLoginContainer(this.getUser(), this.getUserPassword())))) {
412 // Clear password fields
413 this.setUserPassword(null);
414 this.setUserPasswordRepeat(null);
416 // Same password entered
417 this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_ENTERED_SAME_AS_OLD_PASSWORD", FacesMessage.SEVERITY_WARN); //NOI18N
422 encryptedPassword = UserLoginUtils.encryptPassword(this.getUserPassword());
425 // Set user name and flag
426 this.getUser().setUserName(this.getUserName());
427 this.getUser().setUserMustChangePassword(this.getUserMustChangePassword());
429 // Is a password set?
430 if (encryptedPassword != null) {
432 this.getUser().setUserEncryptedPassword(encryptedPassword);
435 // Call EJB for updating user data
436 final User updatedUser = this.userBean.updateUserData(this.getUser());
439 this.updatedUserDataEvent.fire(new AdminUpdatedUserDataEvent(updatedUser));
443 * Getter for contact instance
445 * @return Contact instance
447 public Contact getContact () {
452 * Setter for contact instance
454 * @param contact Contact instance
456 public void setContact (final Contact contact) {
457 this.contact = contact;
461 * Getter for user instance
463 * @return User instance
465 public User getUser () {
470 * Setter for user instance
472 * @param user User instance
474 public void setUser (final User user) {
479 * Getter for user delete reason
481 * @return User delete reason
483 public String getUserDeleteReason () {
484 return this.userDeleteReason;
488 * Setter for user delete reason
490 * @param userDeleteReason User delete reason
492 public void setUserDeleteReason (final String userDeleteReason) {
493 this.userDeleteReason = userDeleteReason;
497 * Getter for user lock reason
499 * @return User lock reason
501 public String getUserLockReason () {
502 return this.userLockReason;
506 * Setter for user lock reason
508 * @param userLockReason User lock reason
510 public void setUserLockReason (final String userLockReason) {
511 this.userLockReason = userLockReason;
515 * Getter for flag if user needs to change password
517 * @return Flag if user needs to change password
519 public Boolean getUserMustChangePassword () {
520 return this.userMustChangePassword;
524 * Setter for flag if user needs to change password
526 * @param userMustChangePassword Flag if user needs to change password
528 public void setUserMustChangePassword (final Boolean userMustChangePassword) {
529 this.userMustChangePassword = userMustChangePassword;
533 * Getter for user name
537 public String getUserName () {
538 return this.userName;
542 * Setter for user name
544 * @param userName User name
546 public void setUserName (final String userName) {
547 this.userName = userName;
551 * Getter for clear-text user password
553 * @return Clear-text user password
555 public String getUserPassword () {
556 return this.userPassword;
560 * Setter for clear-text user password
562 * @param userPassword Clear-text user password
564 public void setUserPassword (final String userPassword) {
565 this.userPassword = userPassword;
569 * Getter for clear-text user password repeated
571 * @return Clear-text user password repeated
573 public String getUserPasswordRepeat () {
574 return this.userPasswordRepeat;
578 * Setter for clear-text user password repeated
580 * @param userPasswordRepeat Clear-text user password repeated
582 public void setUserPasswordRepeat (final String userPasswordRepeat) {
583 this.userPasswordRepeat = userPasswordRepeat;
587 * Getter for user profile mode
589 * @return User profile mode
591 public ProfileMode getUserProfileMode () {
592 return this.userProfileMode;
596 * Setter for user profile mode
598 * @param userProfileMode User profile mode
600 public void setUserProfileMode (final ProfileMode userProfileMode) {
601 this.userProfileMode = userProfileMode;
605 * Locks selected user's account. This method makes sure that a lock reason
606 * is provided that th user later can read on login attempts.
608 * @return Redirect outcome
610 public String lockUserAccount () {
611 // Is the user instance valid and CONFIRMED?
612 if (this.getUser() == null) {
614 throw new NullPointerException("this.user is null"); //NOI18N
615 } else if (this.getUser().getUserId() == null) {
617 throw new NullPointerException("this.user.userId is null"); //NOI18N
618 } else if (this.getUser().getUserId() < 1) {
620 throw new IllegalArgumentException(MessageFormat.format("this.user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
621 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.LOCKED) {
622 // User account is locked
623 throw new FacesException(new UserStatusLockedException(this.getUser()));
624 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
625 // User account is locked
626 throw new FaceletException(new UserStatusUnconfirmedException(this.getUser()));
627 } else if (this.getUserLockReason() == null) {
629 throw new NullPointerException("this.userLockReason is null"); //NOI18N
630 } else if (this.getUserLockReason().isEmpty()) {
632 throw new IllegalArgumentException("this.userLockReason is empty"); //NOI18N
635 // Init updated user instance
636 final User updatedUser;
640 final String baseUrl = FacesUtils.generateBaseUrl();
642 // Call EJB to lock account
643 updatedUser = this.adminUserBean.lockUserAccount(this.getUser(), this.getUserLockReason(), baseUrl);
644 } catch (final UserStatusLockedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
646 throw new FaceletException(ex);
650 this.userLockedEvent.fire(new AdminLockedUserEvent(updatedUser));
655 // Should go fine at this point, redirect to user profile
656 return "admin_show_user"; //NOI18N
660 * Unlocks selected user's account. This method makes sure that the account
663 * @return Redirect outcome
665 public String unlockUserAccount () {
666 // Is the user instance valid and CONFIRMED?
667 if (this.getUser() == null) {
669 throw new NullPointerException("this.user is null"); //NOI18N
670 } else if (this.getUser().getUserId() == null) {
672 throw new NullPointerException("this.user.userId is null"); //NOI18N
673 } else if (this.getUser().getUserId() < 1) {
675 throw new IllegalArgumentException(MessageFormat.format("this.user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
676 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.CONFIRMED) {
677 // User account is locked
678 throw new FacesException(new UserStatusConfirmedException(this.getUser()));
679 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
680 // User account is locked
681 throw new FaceletException(new UserStatusUnconfirmedException(this.getUser()));
684 // Init updated user instance
685 final User updatedUser;
689 final String baseUrl = FacesUtils.generateBaseUrl();
691 // Call EJB to unlock account
692 updatedUser = this.adminUserBean.unlockUserAccount(this.getUser(), baseUrl);
693 } catch (final UserStatusConfirmedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
695 throw new FaceletException(ex);
699 this.userUnlockedEvent.fire(new AdminUnlockedUserEvent(updatedUser));
704 // Should go fine at this point, redirect to user profile
705 return "admin_show_user"; //NOI18N
711 private void clear () {
713 this.setContact(null);
714 this.setUserDeleteReason(null);
716 this.setUserLockReason(null);
717 this.setUserMustChangePassword(null);
718 this.setUserName(null);
719 this.setUserPassword(null);
720 this.setUserPasswordRepeat(null);
721 this.setUserProfileMode(null);
726 * Creates a new user instance from all currently saved data from this bean
728 * @return New user instance
730 private User createUserInstance () {
731 // Init variable for password
732 String password = null;
735 final Contact userContact;
737 // Is a contact instance in helper set?
738 if ((this.getUserPassword() == null && (this.getUserPasswordRepeat() == null)) || ((this.getUserPassword().isEmpty()) && (this.getUserPasswordRepeat().isEmpty()))) {
739 // Empty password entered, then generate one
740 password = UserLoginUtils.createRandomPassword(JobsUserWebRequestController.MINIMUM_PASSWORD_LENGTH);
741 } else if (!this.isSamePasswordEntered()) {
742 // Both passwords don't match
743 throw new FaceletException(new UserPasswordRepeatMismatchException());
745 // Both match, so get it from this bean
746 password = this.getUserPassword();
749 // The password should not be null and at least 5 characters long
750 assert (password != null) : "password is null"; //NOI18N
751 assert (password.length() >= JobsUserWebRequestController.MINIMUM_PASSWORD_LENGTH) : "Password is not long enough."; //NOI18N
753 // Is contact instance given? Else create one
754 if (this.getContact() instanceof Contact) {
755 // Then use it for contact linking
756 userContact = this.getContact();
758 // Create contact instance
759 userContact = this.contactController.createContactInstance();
762 // Create new instance
763 final User newUser = new LoginUser(this.getUserName(), this.getUserProfileMode(), this.getUserMustChangePassword(), UserLoginUtils.encryptPassword(password), UserAccountStatus.CONFIRMED, userContact);
765 // Get locale from view-root
766 final Locale locale = FacesContext.getCurrentInstance().getViewRoot().getLocale();
769 newUser.setUserLocale(locale);
776 * Checks if same password is entered and that they are not empty.
778 * @return Whether the same password was entered
780 private boolean isSamePasswordEntered () {
781 return ((!this.getUserPassword().isEmpty()) && (Objects.equals(this.getUserPassword(), this.getUserPasswordRepeat())));