]> git.mxchange.org Git - jjobs-war.git/blob - src/java/org/mxchange/jjobs/beans/user/JobsAdminUserWebRequestBean.java
385502439aca34ee435628e56f6d03dbc1ce7052
[jjobs-war.git] / src / java / org / mxchange / jjobs / beans / user / JobsAdminUserWebRequestBean.java
1 /*
2  * Copyright (C) 2016 Roland Haeder
3  *
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.
8  *
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.
13  *
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/>.
16  */
17 package org.mxchange.jjobs.beans.user;
18
19 import java.text.MessageFormat;
20 import java.util.Objects;
21 import javax.enterprise.context.RequestScoped;
22 import javax.enterprise.event.Event;
23 import javax.enterprise.event.Observes;
24 import javax.enterprise.inject.Any;
25 import javax.faces.FacesException;
26 import javax.faces.view.facelets.FaceletException;
27 import javax.inject.Inject;
28 import javax.inject.Named;
29 import javax.naming.Context;
30 import javax.naming.InitialContext;
31 import javax.naming.NamingException;
32 import org.mxchange.jcontacts.contact.Contact;
33 import org.mxchange.jcoreee.utils.FacesUtils;
34 import org.mxchange.jjobs.beans.BaseJobsController;
35 import org.mxchange.jjobs.beans.contact.JobsAdminContactWebRequestController;
36 import org.mxchange.jjobs.beans.contact.JobsContactWebSessionController;
37 import org.mxchange.jjobs.beans.helper.JobsWebViewHelperController;
38 import org.mxchange.jjobs.beans.localization.JobsLocalizationSessionController;
39 import org.mxchange.jusercore.container.login.UserLoginContainer;
40 import org.mxchange.jusercore.events.registration.UserRegisteredEvent;
41 import org.mxchange.jusercore.events.user.add.AdminAddedUserEvent;
42 import org.mxchange.jusercore.events.user.add.AdminUserAddedEvent;
43 import org.mxchange.jusercore.events.user.delete.AdminDeletedUserEvent;
44 import org.mxchange.jusercore.events.user.delete.AdminUserDeletedEvent;
45 import org.mxchange.jusercore.events.user.linked.AdminLinkedUserEvent;
46 import org.mxchange.jusercore.events.user.linked.AdminUserLinkedEvent;
47 import org.mxchange.jusercore.events.user.locked.AdminLockedUserEvent;
48 import org.mxchange.jusercore.events.user.locked.AdminUserLockedEvent;
49 import org.mxchange.jusercore.events.user.unlocked.AdminUnlockedUserEvent;
50 import org.mxchange.jusercore.events.user.unlocked.AdminUserUnlockedEvent;
51 import org.mxchange.jusercore.events.user.update.AdminUpdatedUserDataEvent;
52 import org.mxchange.jusercore.events.user.update.AdminUserDataUpdatedEvent;
53 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
54 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
55 import org.mxchange.jusercore.exceptions.UserNotFoundException;
56 import org.mxchange.jusercore.exceptions.UserPasswordRepeatMismatchException;
57 import org.mxchange.jusercore.exceptions.UserStatusConfirmedException;
58 import org.mxchange.jusercore.exceptions.UserStatusLockedException;
59 import org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException;
60 import org.mxchange.jusercore.model.user.AdminUserSessionBeanRemote;
61 import org.mxchange.jusercore.model.user.LoginUser;
62 import org.mxchange.jusercore.model.user.User;
63 import org.mxchange.jusercore.model.user.UserSessionBeanRemote;
64 import org.mxchange.jusercore.model.user.UserUtils;
65 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
66 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
67
68 /**
69  * A user controller (bean)
70  * <p>
71  * @author Roland Haeder<roland@mxchange.org>
72  */
73 @Named ("adminUserController")
74 @RequestScoped
75 public class JobsAdminUserWebRequestBean extends BaseJobsController implements JobsAdminUserWebRequestController {
76
77         /**
78          * Serial number
79          */
80         private static final long serialVersionUID = 542_145_347_916L;
81
82         /**
83          * An event fired when the administrator has added a new user
84          */
85         @Inject
86         @Any
87         private Event<AdminAddedUserEvent> addedUserEvent;
88
89         /**
90          * Regular contact controller
91          */
92         @Inject
93         private JobsAdminContactWebRequestController adminContactController;
94
95         /**
96          * Administrative user EJB
97          */
98         private final AdminUserSessionBeanRemote adminUserBean;
99
100         /**
101          * Bean helper
102          */
103         @Inject
104         private JobsWebViewHelperController beanHelper;
105
106         /**
107          * Regular contact controller
108          */
109         @Inject
110         private JobsContactWebSessionController contactController;
111
112         /**
113          * Event being fired when admin has deleted user
114          */
115         @Inject
116         @Any
117         private Event<AdminDeletedUserEvent> deleteUserEvent;
118
119         /**
120          * Localization controller
121          */
122         @Inject
123         private JobsLocalizationSessionController localizationController;
124
125         /**
126          * An event fired when the administrator has updated a new user
127          */
128         @Inject
129         @Any
130         private Event<AdminUpdatedUserDataEvent> updatedUserDataEvent;
131
132         /**
133          * General user EJB
134          */
135         private final UserSessionBeanRemote userBean;
136
137         /**
138          * Regular user controller
139          */
140         @Inject
141         private JobsUserWebSessionController userController;
142
143         /**
144          * Delete reason
145          */
146         private String userDeleteReason;
147
148         /**
149          * An event fired when the administrator has linked a user with existing
150          * contact data.
151          */
152         @Inject
153         @Any
154         private Event<AdminLinkedUserEvent> userLinkedEvent;
155
156         /**
157          * User lock reason
158          */
159         private String userLockReason;
160
161         /**
162          * Event being fired when an administrator has locked a user
163          */
164         @Inject
165         @Any
166         private Event<AdminLockedUserEvent> userLockedEvent;
167
168         /**
169          * Flag whether user must change password after login
170          */
171         private Boolean userMustChangePassword;
172
173         /**
174          * User name
175          */
176         private String userName;
177
178         /**
179          * User password (unencrypted from web form)
180          */
181         private String userPassword;
182
183         /**
184          * User password repeated (unencrypted from web form)
185          */
186         private String userPasswordRepeat;
187
188         /**
189          * Event being fired when admin unlocks an account
190          */
191         @Inject
192         @Any
193         private Event<AdminUnlockedUserEvent> userUnlockedEvent;
194
195         /**
196          * Default constructor
197          */
198         public JobsAdminUserWebRequestBean () {
199                 // Try it
200                 try {
201                         // Get initial context
202                         Context context = new InitialContext();
203
204                         // Try to lookup
205                         this.userBean = (UserSessionBeanRemote) context.lookup("java:global/jjobs-ejb/user!org.mxchange.jusercore.model.user.UserSessionBeanRemote"); //NOI18N
206                         this.adminUserBean = (AdminUserSessionBeanRemote) context.lookup("java:global/jjobs-ejb/user!org.mxchange.jusercore.model.user.AdminUserSessionBeanRemote"); //NOI18N
207                 } catch (final NamingException e) {
208                         // Throw again
209                         throw new FaceletException(e);
210                 }
211         }
212
213         @Override
214         public String addUser () {
215                 // As the form cannot validate the data (required="true"), check it here
216                 if (this.getUserName() == null) {
217                         // Throw NPE
218                         throw new NullPointerException("userName is null"); //NOI18N
219                 } else if (this.getUserName().isEmpty()) {
220                         // Is empty
221                         throw new IllegalArgumentException("userName is null"); //NOI18N
222                 } else if (this.beanHelper.getContact() == null) {
223                         // No contact instance set, so test required fields: gender, first name and family name
224                         if (this.contactController.getGender() == null) {
225                                 // Throw NPE again
226                                 throw new NullPointerException("contactController.gender is null"); //NOI18N
227                         } else if (this.contactController.getFirstName() == null) {
228                                 // ... and again
229                                 throw new NullPointerException("contactController.firstName is null"); //NOI18N
230                         } else if (this.adminContactController.getFirstName().isEmpty()) {
231                                 // ... and again
232                                 throw new IllegalArgumentException("contactController.firstName is empty"); //NOI18N
233                         } else if (this.adminContactController.getFamilyName() == null) {
234                                 // ... and again
235                                 throw new NullPointerException("contactController.familyName is null"); //NOI18N
236                         } else if (this.contactController.getFamilyName().isEmpty()) {
237                                 // ... and again
238                                 throw new IllegalArgumentException("contactController.familyName is empty"); //NOI18N
239                         } else if (this.adminContactController.getEmailAddress() == null) {
240                                 // ... and again
241                                 throw new NullPointerException("contactController.emailAddress is null"); //NOI18N
242                         } else if (this.adminContactController.getEmailAddress().isEmpty()) {
243                                 // ... and again
244                                 throw new IllegalArgumentException("contactController.emailAddress is empty"); //NOI18N
245                         }
246                 }
247
248                 // Create new user instance
249                 User user = new LoginUser();
250
251                 // Set user name, CONFIRMED and INVISIBLE
252                 user.setUserName(this.getUserName());
253                 user.setUserAccountStatus(UserAccountStatus.CONFIRMED);
254                 user.setUserProfileMode(ProfileMode.INVISIBLE);
255
256                 // Init instance
257                 Contact contact;
258
259                 // Is a contact instance in helper set?
260                 if (this.beanHelper.getContact() instanceof Contact) {
261                         // Then use it for contact linking
262                         contact = this.beanHelper.getContact();
263                 } else {
264                         // Create contact instance
265                         contact = this.contactController.createContactInstance();
266                 }
267
268                 // Set contact in user
269                 user.setUserContact(contact);
270
271                 // Init variable for password
272                 String password = null;
273
274                 // Is the user name or email address used already?
275                 // @TODO Add password length check
276                 if (this.userController.isUserNameRegistered(user)) {
277                         // User name is already used
278                         throw new FaceletException(new UserNameAlreadyRegisteredException(user));
279                 } else if ((this.beanHelper.getContact() == null) && (this.contactController.isEmailAddressRegistered(user.getUserContact()))) {
280                         // Email address is already used
281                         throw new FaceletException(new EmailAddressAlreadyRegisteredException(user));
282                 } else if ((this.getUserPassword() == null && (this.getUserPasswordRepeat() == null)) || ((this.getUserPassword().isEmpty()) && (this.getUserPasswordRepeat().isEmpty()))) {
283                         // Empty password entered, then generate one
284                         password = UserUtils.createRandomPassword(JobsUserWebSessionController.MINIMUM_PASSWORD_LENGTH);
285                 } else if (!this.isSamePasswordEntered()) {
286                         // Both passwords don't match
287                         throw new FaceletException(new UserPasswordRepeatMismatchException(user));
288                 } else {
289                         // Both match, so get it from this bean
290                         password = this.getUserPassword();
291                 }
292
293                 // The password should not be null and at least 5 characters long
294                 assert (password != null) : "password is null"; //NOI18N
295                 assert (password.length() >= JobsUserWebSessionController.MINIMUM_PASSWORD_LENGTH) : "Password is not long enough."; //NOI18N
296
297                 // Encrypt password and set it
298                 user.setUserEncryptedPassword(UserUtils.encryptPassword(password));
299
300                 try {
301                         // Now, that all is set, call EJB
302                         if (this.beanHelper.getContact() instanceof Contact) {
303                                 // Link contact with this user
304                                 User updatedUser = this.adminUserBean.linkUser(user);
305
306                                 // Fire event
307                                 this.userLinkedEvent.fire(new AdminUserLinkedEvent(updatedUser));
308
309                                 // Remove contact instance
310                                 this.beanHelper.setContact(null);
311                         } else {
312                                 // Add new contact
313                                 User updatedUser = this.adminUserBean.addUser(user);
314
315                                 // Fire event
316                                 this.addedUserEvent.fire(new AdminUserAddedEvent(updatedUser));
317                         }
318                 } catch (final UserNameAlreadyRegisteredException | EmailAddressAlreadyRegisteredException ex) {
319                         // Throw again
320                         throw new FaceletException(ex);
321                 }
322
323                 // Clear helper
324                 this.beanHelper.setContact(null);
325
326                 // Clear this bean
327                 this.clear();
328
329                 // Return to user list (for now)
330                 return "admin_list_user"; //NOI18N
331         }
332
333         @Override
334         public void afterUserRegistrationEvent (@Observes final UserRegisteredEvent event) {
335                 // event should not be null
336                 if (null == event) {
337                         // Throw NPE
338                         throw new NullPointerException("event is null"); //NOI18N
339                 } else if (event.getRegisteredUser() == null) {
340                         // Throw NPE again
341                         throw new NullPointerException("event.user is null"); //NOI18N
342                 } else if (event.getRegisteredUser().getUserId() == null) {
343                         // userId is null
344                         throw new NullPointerException("event.user.userId is null"); //NOI18N
345                 } else if (event.getRegisteredUser().getUserId() < 1) {
346                         // Not avalid id
347                         throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getRegisteredUser(), event.getRegisteredUser().getUserId())); //NOI18N
348                 }
349
350                 // Get user instance
351                 User registeredUser = event.getRegisteredUser();
352
353                 // Debug message
354                 //* NOISY-DEBUG: */ System.out.println(MessageFormat.format("UserWebBean:afterRegistration: registeredUser={0}", registeredUser)); //NOI18N
355                 // Clear all data
356                 this.clear();
357
358                 // Trace message
359                 //* NOISY-DEBUG: */ System.out.println("UserWebBean:afterRegistration: EXIT!"); //NOI18N
360         }
361
362         @Override
363         public String deleteUserData (final User user) {
364                 // Is the user instance valid and CONFIRMED?
365                 if (null == user) {
366                         // Throw NPE
367                         throw new NullPointerException("user is null"); //NOI18N
368                 } else if (user.getUserId() == null) {
369                         // Throw again
370                         throw new NullPointerException("user.userId is null"); //NOI18N
371                 } else if (user.getUserId() < 1) {
372                         // Invalid id number
373                         throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
374                 }
375
376                 try {
377                         // All fine, delete it
378                         this.adminUserBean.deleteUser(user, this.getUserDeleteReason());
379                 } catch (final UserNotFoundException ex) {
380                         // Should not happen, so throw again
381                         throw new FaceletException(ex);
382                 }
383
384                 // Fire event
385                 this.deleteUserEvent.fire(new AdminUserDeletedEvent(user, this.getUserDeleteReason()));
386
387                 // Redirect
388                 return "admin_list_user"; //NOI18N
389         }
390
391         @Override
392         public String editUserData () {
393                 // Get user instance
394                 User user = this.beanHelper.getUser();
395
396                 // Null password means not setting it
397                 String encryptedPassword = null;
398
399                 // Check if user instance is in helper and valid
400                 if (null == user) {
401                         // Throw NPE
402                         throw new NullPointerException("beanHelper.user is null"); //NOI18N
403                 } else if (user.getUserId() == null) {
404                         // Throw NPE again
405                         throw new NullPointerException("beanHelper.user.userId is null"); //NOI18N
406                 } else if (user.getUserId() < 1) {
407                         // Invalid id
408                         throw new IllegalStateException(MessageFormat.format("beanHelper.user.userId={0} is invalid", user.getUserId())); //NOI18N
409                 } else if (this.getUserName() == null) {
410                         // Not all required fields are set
411                         throw new NullPointerException("this.userName is null"); //NOI18N
412                 } else if (this.getUserName().isEmpty()) {
413                         // Not all required fields are set
414                         throw new IllegalArgumentException("this.userName is empty"); //NOI18N
415                 } else if (((!this.getUserPassword().isEmpty()) || (!this.getUserPasswordRepeat().isEmpty())) && (!this.isSamePasswordEntered())) {
416                         // Clear password fields
417                         this.setUserPassword(null);
418                         this.setUserPasswordRepeat(null);
419
420                         // Not same password entered
421                         this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_PASSWORD_REPEAT_DIFFERENT"); //NOI18N
422                         return ""; //NOI18N
423                 } else if ((!Objects.equals(user.getUserName(), this.getUserName())) && (this.userBean.ifUserNameExists(this.getUserName()))) {
424                         // Clear all fields
425                         this.clear();
426
427                         // User name already exists
428                         this.showFacesMessage("form_edit_user:userName", "ADMIN_USER_NAME_ALREADY_EXISTS"); //NOI18N
429                         return ""; //NOI18N
430                 } else if (this.isSamePasswordEntered()) {
431                         // Same password entered, create container
432                         if ((Objects.equals(user.getUserMustChangePassword(), this.getUserMustChangePassword())) && (UserUtils.ifPasswordMatches(new UserLoginContainer(user, this.getUserPassword())))) {
433                                 // Clear password fields
434                                 this.setUserPassword(null);
435                                 this.setUserPasswordRepeat(null);
436
437                                 // Same password entered
438                                 this.showFacesMessage("form_edit_user:userPassword", "ADMIN_USER_ENTERED_SAME_AS_OLD_PASSWORD"); //NOI18N
439                                 return ""; //NOI18N
440                         }
441
442                         // Encrypt password
443                         encryptedPassword = UserUtils.encryptPassword(this.getUserPassword());
444                 }
445
446                 // Set user name and flag
447                 user.setUserName(this.getUserName());
448                 user.setUserMustChangePassword(this.getUserMustChangePassword());
449
450                 // Is a password set?
451                 if (encryptedPassword != null) {
452                         // Set it as well
453                         user.setUserEncryptedPassword(encryptedPassword);
454                 }
455
456                 // Call EJB for updating user data
457                 User updatedUser = this.userBean.updateUserData(user);
458
459                 // Fire event
460                 this.updatedUserDataEvent.fire(new AdminUserDataUpdatedEvent(updatedUser));
461
462                 // Return to user list (for now)
463                 return "admin_list_user"; //NOI18N
464         }
465
466         @Override
467         public String getUserDeleteReason () {
468                 return this.userDeleteReason;
469         }
470
471         @Override
472         public void setUserDeleteReason (final String userDeleteReason) {
473                 this.userDeleteReason = userDeleteReason;
474         }
475
476         @Override
477         public String getUserLockReason () {
478                 return this.userLockReason;
479         }
480
481         @Override
482         public void setUserLockReason (final String userLockReason) {
483                 this.userLockReason = userLockReason;
484         }
485
486         @Override
487         public Boolean getUserMustChangePassword () {
488                 return this.userMustChangePassword;
489         }
490
491         @Override
492         public void setUserMustChangePassword (final Boolean userMustChangePassword) {
493                 this.userMustChangePassword = userMustChangePassword;
494         }
495
496         @Override
497         public String getUserName () {
498                 return this.userName;
499         }
500
501         @Override
502         public void setUserName (final String userName) {
503                 this.userName = userName;
504         }
505
506         @Override
507         public String getUserPassword () {
508                 return this.userPassword;
509         }
510
511         @Override
512         public void setUserPassword (final String userPassword) {
513                 this.userPassword = userPassword;
514         }
515
516         @Override
517         public String getUserPasswordRepeat () {
518                 return this.userPasswordRepeat;
519         }
520
521         @Override
522         public void setUserPasswordRepeat (final String userPasswordRepeat) {
523                 this.userPasswordRepeat = userPasswordRepeat;
524         }
525
526         @Override
527         public String lockUserAccount (final User user) {
528                 // Is the user instance valid and CONFIRMED?
529                 if (null == user) {
530                         // Throw NPE
531                         throw new NullPointerException("user is null"); //NOI18N
532                 } else if (user.getUserId() == null) {
533                         // Throw again
534                         throw new NullPointerException("user.userId is null"); //NOI18N
535                 } else if (user.getUserId() < 1) {
536                         // Invalid id number
537                         throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
538                 } else if (user.getUserAccountStatus() == UserAccountStatus.LOCKED) {
539                         // User account is locked
540                         throw new FacesException(new UserStatusLockedException(user));
541                 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
542                         // User account is locked
543                         throw new FaceletException(new UserStatusUnconfirmedException(user));
544                 } else if (this.getUserLockReason() == null) {
545                         // Throw NPE again
546                         throw new NullPointerException("this.userLockReason is null"); //NOI18N
547                 } else if (this.getUserLockReason().isEmpty()) {
548                         // Empty lock reason
549                         throw new IllegalArgumentException("this.userLockReason is empty"); //NOI18N
550                 }
551
552                 // Init updated user instance
553                 User updatedUser;
554
555                 try {
556                         // Get base URL
557                         String baseUrl = FacesUtils.generateBaseUrl();
558
559                         // Call EJB to lock account
560                         updatedUser = this.adminUserBean.lockUserAccount(user, this.getUserLockReason(), baseUrl);
561                 } catch (final UserStatusLockedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
562                         // Throw again
563                         throw new FaceletException(ex);
564                 }
565
566                 // Fire event
567                 this.userLockedEvent.fire(new AdminUserLockedEvent(updatedUser));
568
569                 // Clear bean
570                 this.clear();
571
572                 // Should go fine at this point, redirect to user profile
573                 return "admin_show_user"; //NOI18N
574         }
575
576         @Override
577         public String unlockUserAccount (final User user) {
578                 // Is the user instance valid and CONFIRMED?
579                 if (null == user) {
580                         // Throw NPE
581                         throw new NullPointerException("user is null"); //NOI18N
582                 } else if (user.getUserId() == null) {
583                         // Throw again
584                         throw new NullPointerException("user.userId is null"); //NOI18N
585                 } else if (user.getUserId() < 1) {
586                         // Invalid id number
587                         throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
588                 } else if (user.getUserAccountStatus() == UserAccountStatus.CONFIRMED) {
589                         // User account is locked
590                         throw new FacesException(new UserStatusConfirmedException(user));
591                 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
592                         // User account is locked
593                         throw new FaceletException(new UserStatusUnconfirmedException(user));
594                 }
595
596                 // Init updated user instance
597                 User updatedUser;
598
599                 try {
600                         // Get base URL
601                         String baseUrl = FacesUtils.generateBaseUrl();
602
603                         // Call EJB to unlock account
604                         updatedUser = this.adminUserBean.unlockUserAccount(user, baseUrl);
605                 } catch (final UserStatusConfirmedException | UserStatusUnconfirmedException | UserNotFoundException ex) {
606                         // Throw again
607                         throw new FaceletException(ex);
608                 }
609
610                 // Fire event
611                 this.userUnlockedEvent.fire(new AdminUserUnlockedEvent(updatedUser));
612
613                 // Clear bean
614                 this.clear();
615
616                 // Should go fine at this point, redirect to user profile
617                 return "admin_show_user"; //NOI18N
618         }
619
620         /**
621          * Clears this bean
622          */
623         private void clear () {
624                 // Clear all data
625                 // - other data
626                 this.setUserName(null);
627                 this.setUserPassword(null);
628                 this.setUserPasswordRepeat(null);
629                 this.setUserMustChangePassword(null);
630         }
631
632         /**
633          * Checks if same password is entered and that they are not empty.
634          * <p>
635          * @return Whether the same password was entered
636          */
637         private boolean isSamePasswordEntered () {
638                 return ((!this.getUserPassword().isEmpty()) && (Objects.equals(this.getUserPassword(), this.getUserPasswordRepeat())));
639         }
640
641 }