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.inject.Inject;
31 import javax.inject.Named;
32 import org.mxchange.jcontacts.model.contact.Contact;
33 import org.mxchange.jcoreee.utils.FacesUtils;
34 import org.mxchange.jjobs.beans.BaseJobsBean;
35 import org.mxchange.jjobs.beans.contact.JobsAdminContactWebRequestController;
36 import org.mxchange.jjobs.beans.contact.JobsContactWebRequestController;
37 import org.mxchange.jjobs.beans.features.JobsFeaturesWebApplicationController;
38 import org.mxchange.jjobs.beans.user.list.JobsUserListWebViewController;
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.post.AdminPostUserDataUpdatedEvent;
51 import org.mxchange.jusercore.events.user.update.post.ObservableAdminPostUserDataUpdatedEvent;
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<ObservableAdminPostUserDataUpdatedEvent> 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 FacesException(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 final User updatedUser;
264 // Now, that all is set, call EJB
265 if (this.getContact() instanceof Contact) {
266 // Link contact with this user
267 updatedUser = this.adminUserBean.linkUser(newUser);
270 updatedUser = this.adminUserBean.addUser(newUser);
272 } catch (final UserNameAlreadyRegisteredException | EmailAddressAlreadyRegisteredException ex) {
274 throw new FacesException(ex);
277 // Now, that all is set, call EJB
278 if (this.getContact() instanceof Contact) {
280 this.userLinkedEvent.fire(new AdminLinkedUserEvent(updatedUser));
283 this.addedUserEvent.fire(new AdminAddedUserEvent(updatedUser));
286 this.setContact(null);
293 * Event observer for when a bean helper has successfully created a user
294 * instance, means the user exists. If the user does not exist, this event
295 * should not fire but instead a proper exception must be thrown.
297 * @param event User created event
299 public void afterCreatedUserEvent (@Observes final ObservableCreatedUserEvent event) {
300 // Is the instance valid?
303 throw new NullPointerException("event is null"); //NOI18N
304 } else if (event.getCreatedUser() == null) {
306 throw new NullPointerException("event.createdUser is null"); //NOI18N
307 } else if (event.getCreatedUser().getUserId() == null) {
309 throw new NullPointerException("event.createdUser.userId is null"); //NOI18N
310 } else if (event.getCreatedUser().getUserId() < 1) {
312 throw new NullPointerException(MessageFormat.format("event.createdUser.userId={0} is not valid", event.getCreatedUser().getUserId())); //NOI18N
316 this.setUser(event.getCreatedUser());
320 * Event observer for new user registrations
322 * @param event User registration event
324 public void afterUserRegistrationEvent (@Observes final ObservableUserRegisteredEvent event) {
325 // Event and contained entity instance should not be null
328 throw new NullPointerException("event is null"); //NOI18N
329 } else if (event.getRegisteredUser() == null) {
331 throw new NullPointerException("event.user is null"); //NOI18N
332 } else if (event.getRegisteredUser().getUserId() == null) {
334 throw new NullPointerException("event.user.userId is null"); //NOI18N
335 } else if (event.getRegisteredUser().getUserId() < 1) {
337 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getRegisteredUser(), event.getRegisteredUser().getUserId())); //NOI18N
341 final User registeredUser = event.getRegisteredUser();
343 // @TODO Nothing to do with the user here?
349 * Deletes given user account
351 public void deleteUserData () {
352 // Is the user instance valid and CONFIRMED?
353 if (this.getUser() == null) {
355 throw new NullPointerException("user is null"); //NOI18N
356 } else if (this.getUser().getUserId() == null) {
358 throw new NullPointerException("user.userId is null"); //NOI18N
359 } else if (this.getUser().getUserId() < 1) {
361 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
365 // All fine, delete it
366 this.adminUserBean.deleteUser(this.getUser(), this.getUserDeleteReason());
367 } catch (final UserNotFoundException ex) {
368 // Should not happen, so throw again
369 throw new FacesException(ex);
373 this.deleteUserEvent.fire(new AdminDeletedUserEvent(this.getUser(), this.getUserDeleteReason()));
377 * Edits currently loaded user's data in database.
379 public void editUserData () {
380 // Null password means not setting it
381 String encryptedPassword = null;
383 // Check if user instance is in helper and valid
384 if (this.getUser() == null) {
386 throw new NullPointerException("beanHelper.user is null"); //NOI18N
387 } else if (this.getUser().getUserId() == null) {
389 throw new NullPointerException("beanHelper.user.userId is null"); //NOI18N
390 } else if (this.getUser().getUserId() < 1) {
392 throw new IllegalStateException(MessageFormat.format("beanHelper.user.userId={0} is invalid", this.getUser().getUserId())); //NOI18N
393 } else if (this.getUserName() == null) {
394 // Not all required fields are set
395 throw new NullPointerException("this.userName is null"); //NOI18N
396 } else if (this.getUserName().isEmpty()) {
397 // Not all required fields are set
398 throw new IllegalArgumentException("this.userName is empty"); //NOI18N
399 } else if (((!this.getUserPassword().isEmpty()) || (!this.getUserPasswordRepeat().isEmpty())) && (!this.isSamePasswordEntered())) {
400 // Clear password fields
401 this.setUserPassword(null);
402 this.setUserPasswordRepeat(null);
404 // Not same password entered
405 this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_PASSWORD_REPEAT_DIFFERENT", FacesMessage.SEVERITY_INFO); //NOI18N
407 } else if ((!Objects.equals(this.getUser().getUserName(), this.getUserName())) && (this.userBean.ifUserNameExists(this.getUserName()))) {
411 // User name already exists
412 this.showFacesMessage("form_edit_user:userName", "ADMIN_USER_NAME_ALREADY_EXISTS", FacesMessage.SEVERITY_WARN); //NOI18N
414 } else if (this.isSamePasswordEntered()) {
415 // Same password entered, create container
416 if ((Objects.equals(this.getUser().getUserMustChangePassword(), this.getUserMustChangePassword())) && (UserLoginUtils.ifPasswordMatches(new UserLoginContainer(this.getUser(), this.getUserPassword())))) {
417 // Clear password fields
418 this.setUserPassword(null);
419 this.setUserPasswordRepeat(null);
421 // Same password entered
422 this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_ENTERED_SAME_AS_OLD_PASSWORD", FacesMessage.SEVERITY_WARN); //NOI18N
427 encryptedPassword = UserLoginUtils.encryptPassword(this.getUserPassword());
430 // Set user name and flag
431 this.getUser().setUserName(this.getUserName());
432 this.getUser().setUserMustChangePassword(this.getUserMustChangePassword());
434 // Is a password set?
435 if (encryptedPassword != null) {
437 this.getUser().setUserEncryptedPassword(encryptedPassword);
440 // Init updated User instance
441 final User updatedUser;
444 // Call EJB for updating user data
445 updatedUser = this.userBean.updateUserData(this.getUser());
446 } catch (final UserNotFoundException ex) {
448 throw new FacesException(ex);
452 this.updatedUserDataEvent.fire(new AdminPostUserDataUpdatedEvent(updatedUser));
456 * Getter for contact instance
458 * @return Contact instance
460 public Contact getContact () {
465 * Setter for contact instance
467 * @param contact Contact instance
469 public void setContact (final Contact contact) {
470 this.contact = contact;
474 * Getter for user instance
476 * @return User instance
478 public User getUser () {
483 * Setter for user instance
485 * @param user User instance
487 public void setUser (final User user) {
492 * Getter for user delete reason
494 * @return User delete reason
496 public String getUserDeleteReason () {
497 return this.userDeleteReason;
501 * Setter for user delete reason
503 * @param userDeleteReason User delete reason
505 public void setUserDeleteReason (final String userDeleteReason) {
506 this.userDeleteReason = userDeleteReason;
510 * Getter for user lock reason
512 * @return User lock reason
514 public String getUserLockReason () {
515 return this.userLockReason;
519 * Setter for user lock reason
521 * @param userLockReason User lock reason
523 public void setUserLockReason (final String userLockReason) {
524 this.userLockReason = userLockReason;
528 * Getter for flag if user needs to change password
530 * @return Flag if user needs to change password
532 public Boolean getUserMustChangePassword () {
533 return this.userMustChangePassword;
537 * Setter for flag if user needs to change password
539 * @param userMustChangePassword Flag if user needs to change password
541 public void setUserMustChangePassword (final Boolean userMustChangePassword) {
542 this.userMustChangePassword = userMustChangePassword;
546 * Getter for user name
550 public String getUserName () {
551 return this.userName;
555 * Setter for user name
557 * @param userName User name
559 public void setUserName (final String userName) {
560 this.userName = userName;
564 * Getter for clear-text user password
566 * @return Clear-text user password
568 public String getUserPassword () {
569 return this.userPassword;
573 * Setter for clear-text user password
575 * @param userPassword Clear-text user password
577 public void setUserPassword (final String userPassword) {
578 this.userPassword = userPassword;
582 * Getter for clear-text user password repeated
584 * @return Clear-text user password repeated
586 public String getUserPasswordRepeat () {
587 return this.userPasswordRepeat;
591 * Setter for clear-text user password repeated
593 * @param userPasswordRepeat Clear-text user password repeated
595 public void setUserPasswordRepeat (final String userPasswordRepeat) {
596 this.userPasswordRepeat = userPasswordRepeat;
600 * Getter for user profile mode
602 * @return User profile mode
604 public ProfileMode getUserProfileMode () {
605 return this.userProfileMode;
609 * Setter for user profile mode
611 * @param userProfileMode User profile mode
613 public void setUserProfileMode (final ProfileMode userProfileMode) {
614 this.userProfileMode = userProfileMode;
618 * Locks selected user's account. This method makes sure that a lock reason
619 * is provided that th user later can read on login attempts.
621 * @return Redirect outcome
623 public String lockUserAccount () {
624 // Is the user instance valid and CONFIRMED?
625 if (this.getUser() == null) {
627 throw new NullPointerException("this.user is null"); //NOI18N
628 } else if (this.getUser().getUserId() == null) {
630 throw new NullPointerException("this.user.userId is null"); //NOI18N
631 } else if (this.getUser().getUserId() < 1) {
633 throw new IllegalArgumentException(MessageFormat.format("this.user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
634 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.LOCKED) {
635 // User account is locked
636 throw new FacesException(new UserStatusLockedException(this.getUser()));
637 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
638 // User account is locked
639 throw new FacesException(new UserStatusUnconfirmedException(this.getUser()));
640 } else if (this.getUserLockReason() == null) {
642 throw new NullPointerException("this.userLockReason is null"); //NOI18N
643 } else if (this.getUserLockReason().isEmpty()) {
645 throw new IllegalArgumentException("this.userLockReason is empty"); //NOI18N
648 // Init updated user instance
649 final User updatedUser;
653 final String baseUrl = FacesUtils.generateBaseUrl();
655 // Call EJB to lock account
656 updatedUser = this.adminUserBean.lockUserAccount(this.getUser(), this.getUserLockReason(), baseUrl);
657 } catch (final UserStatusLockedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
659 throw new FacesException(ex);
663 this.userLockedEvent.fire(new AdminLockedUserEvent(updatedUser));
668 // Should go fine at this point, redirect to user profile
669 return "admin_show_user"; //NOI18N
673 * Unlocks selected user's account. This method makes sure that the account
676 * @return Redirect outcome
678 public String unlockUserAccount () {
679 // Is the user instance valid and CONFIRMED?
680 if (this.getUser() == null) {
682 throw new NullPointerException("this.user is null"); //NOI18N
683 } else if (this.getUser().getUserId() == null) {
685 throw new NullPointerException("this.user.userId is null"); //NOI18N
686 } else if (this.getUser().getUserId() < 1) {
688 throw new IllegalArgumentException(MessageFormat.format("this.user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
689 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.CONFIRMED) {
690 // User account is locked
691 throw new FacesException(new UserStatusConfirmedException(this.getUser()));
692 } else if (this.getUser().getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
693 // User account is locked
694 throw new FacesException(new UserStatusUnconfirmedException(this.getUser()));
697 // Init updated user instance
698 final User updatedUser;
702 final String baseUrl = FacesUtils.generateBaseUrl();
704 // Call EJB to unlock account
705 updatedUser = this.adminUserBean.unlockUserAccount(this.getUser(), baseUrl);
706 } catch (final UserStatusConfirmedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
708 throw new FacesException(ex);
712 this.userUnlockedEvent.fire(new AdminUnlockedUserEvent(updatedUser));
717 // Should go fine at this point, redirect to user profile
718 return "admin_show_user"; //NOI18N
724 private void clear () {
726 this.setContact(null);
727 this.setUserDeleteReason(null);
729 this.setUserLockReason(null);
730 this.setUserMustChangePassword(null);
731 this.setUserName(null);
732 this.setUserPassword(null);
733 this.setUserPasswordRepeat(null);
734 this.setUserProfileMode(null);
739 * Creates a new user instance from all currently saved data from this bean
741 * @return New user instance
743 private User createUserInstance () {
744 // Init variable for password
745 String password = null;
748 final Contact userContact;
750 // Is a contact instance in helper set?
751 if ((this.getUserPassword() == null && (this.getUserPasswordRepeat() == null)) || ((this.getUserPassword().isEmpty()) && (this.getUserPasswordRepeat().isEmpty()))) {
752 // Empty password entered, then generate one
753 password = UserLoginUtils.createRandomPassword(JobsUserWebRequestController.MINIMUM_PASSWORD_LENGTH);
754 } else if (!this.isSamePasswordEntered()) {
755 // Both passwords don't match
756 throw new FacesException(new UserPasswordRepeatMismatchException());
758 // Both match, so get it from this bean
759 password = this.getUserPassword();
762 // The password should not be null and at least 5 characters long
763 assert (password != null) : "password is null"; //NOI18N
764 assert (password.length() >= JobsUserWebRequestController.MINIMUM_PASSWORD_LENGTH) : "Password is not long enough."; //NOI18N
766 // Is contact instance given? Else create one
767 if (this.getContact() instanceof Contact) {
768 // Then use it for contact linking
769 userContact = this.getContact();
771 // Create contact instance
772 userContact = this.contactController.createContactInstance();
775 // Create new instance
776 final User newUser = new LoginUser(
778 this.getUserProfileMode(),
779 this.getUserMustChangePassword(),
780 UserLoginUtils.encryptPassword(password),
781 UserAccountStatus.CONFIRMED,
785 // Get locale from view-root
786 final Locale locale = FacesContext.getCurrentInstance().getViewRoot().getLocale();
789 newUser.setUserLocale(locale);
796 * Checks if same password is entered and that they are not empty.
798 * @return Whether the same password was entered
800 private boolean isSamePasswordEntered () {
801 return ((!this.getUserPassword().isEmpty()) && (Objects.equals(this.getUserPassword(), this.getUserPasswordRepeat())));