src/java/org/mxchange/jusercore/model/user/email_address/PizzaUserEmailChangeSessionBean.java

   1 /*
   2  * Copyright (C) 2016 - 2022 Free Software Foundation
   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.jusercore.model.user.email_address;
  18
  19 import java.text.MessageFormat;
  20 import java.util.Date;
  21 import java.util.List;
  22 import javax.ejb.EJB;
  23 import javax.ejb.EJBException;
  24 import javax.ejb.Stateless;
  25 import javax.persistence.NoResultException;
  26 import javax.persistence.Query;
  27 import org.mxchange.jusercore.model.email_address.ChangeableEmailAddress;
  28 import org.mxchange.jusercore.model.email_address.EmailAddressChange;
  29 import org.mxchange.jusercore.model.user.UserSessionBeanRemote;
  30 import org.mxchange.juserlogincore.login.UserLoginUtils;
  31 import org.mxchange.pizzaaplication.enterprise.BasePizzaEnterpriseBean;
  32
  33 /**
  34  * A session-scoped bean for changing email addresses
  35  * <p>
  36  * @author Roland Häder<roland@mxchange.org>
  37  */
  38 @Stateless (name = "userEmailChange", description = "A bean handling user email changes")
  39 public class PizzaUserEmailChangeSessionBean extends BasePizzaEnterpriseBean implements UserEmailChangeSessionBeanRemote {
  40
  41         /**
  42          * Serial number
  43          */
  44         private static final long serialVersionUID = 182_698_165_971_548L;
  45
  46         /**
  47          * User bean
  48          */
  49         @EJB (lookup = "java:global/pizzaservice-ejb/user!org.mxchange.jusercore.model.user.UserSessionBeanRemote")
  50         private UserSessionBeanRemote userBean;
  51
  52         /**
  53          * Default constructor
  54          */
  55         public PizzaUserEmailChangeSessionBean () {
  56                 // Call super constructor
  57                 super("jms/pizzaservice-queue-factory", "jms/pizzaservice-email-queue"); //NOI18N
  58         }
  59
  60         @Override
  61         public void enqueueEmailAddressForChange (final ChangeableEmailAddress emailChange, final String baseUrl) {
  62                 // Trace message
  63                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange: emailChange={1},baseUrl={2} - CALLED!", this.getClass().getSimpleName(), emailChange, baseUrl)); //NOI18N
  64
  65                 // Email address change should be valid
  66                 if (null == emailChange) {
  67                         // Abort here
  68                         throw new NullPointerException("emailChange is null"); //NOI18N
  69                 } else if (emailChange.getEmailChangeUser() == null) {
  70                         // Throw NPE again
  71                         throw new NullPointerException("emailChange.emailChangeUser is null"); //NOI18N
  72                 } else if (emailChange.getEmailChangeUser().getUserId() == null) {
  73                         // Throw NPE again
  74                         throw new NullPointerException("emailChange.emailChangeUser.userId is null"); //NOI18N
  75                 } else if (emailChange.getEmailChangeUser().getUserId() < 1) {
  76                         // Not valid id
  77                         throw new IllegalArgumentException(MessageFormat.format("emailChange.emailChangeUser.userId={0} is invalid.", emailChange.getEmailChangeUser().getUserId())); //NOI18N
  78                 } else if (emailChange.getEmailAddress().trim().isEmpty()) {
  79                         // Email address is empty
  80                         throw new IllegalArgumentException("emailChange.emaiLAddress is empty."); //NOI18N
  81                 } else if (this.isEmailAddressEnqueued(emailChange.getEmailAddress())) {
  82                         // Email address is already enqueued
  83                         throw new EJBException(MessageFormat.format("Email address {0} is already enqueued.", emailChange.getEmailAddress())); //NOI18N
  84                 } else if (null == baseUrl) {
  85                         // Throw NPE again
  86                         throw new NullPointerException("baseUrl is null"); //NOI18N
  87                 } else if (baseUrl.isEmpty()) {
  88                         // Throw IAE
  89                         throw new IllegalArgumentException("baseUrl is empty"); //NOI18N
  90                 }
  91
  92                 // The email change is not (yet) there, add secure hash and "created" timestamp
  93                 emailChange.setEmailChangeCreated(new Date());
  94                 this.generateSecureHash(emailChange);
  95
  96                 // Make user managed
  97                 emailChange.setEmailChangeUser(this.createManaged(emailChange.getEmailChangeUser()));
  98
  99                 // Persist it
 100                 //@TODO Fix email delivery then allow this: this.getEntityManager().persist(emailChange);
 101                 // Send email
 102                 this.sendEmail("User email change", "user_email_change", emailChange.getEmailChangeUser(), baseUrl, null); //NOI18N
 103
 104                 // Trace message
 105                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange - EXIT!", this.getClass().getSimpleName())); //NOI18N
 106         }
 107
 108         @Override
 109         @SuppressWarnings ("unchecked")
 110         public List<ChangeableEmailAddress> fetchAllQueuedAddressChanges () {
 111                 // Trace message
 112                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: CALLED!", this.getClass().getSimpleName())); //NOI18N
 113
 114                 // Get named query
 115                 final Query query = this.getEntityManager().createNamedQuery("AllEmailAddressChanges", ChangeableEmailAddress.class); //NOI18N
 116
 117                 // Get all entries
 118                 final List<ChangeableEmailAddress> emailAddresses = query.getResultList();
 119
 120                 // Trace message
 121                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: emailAddresses.size()={1} - EXIT!", this.getClass().getSimpleName(), emailAddresses.size())); //NOI18N
 122
 123                 // Return it
 124                 return emailAddresses;
 125         }
 126
 127         @Override
 128         public void updateEmailAddress (final ChangeableEmailAddress emailAddress) {
 129                 // Trace message
 130                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.updateEmailAddress: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
 131
 132                 // Email address change should be valid
 133                 if (null == emailAddress) {
 134                         // Abort here
 135                         throw new NullPointerException("emailAddress is null"); //NOI18N
 136                 } else if (emailAddress.getEmailChangeId() == null) {
 137                         // Throw NPE again
 138                         throw new NullPointerException("emailAddress.emailChangeId is null"); //NOI18N
 139                 } else if (emailAddress.getEmailChangeId() < 1) {
 140                         // Not valid
 141                         throw new IllegalArgumentException(MessageFormat.format("emailAddress.emailChangeId={0} is not valid.", emailAddress.getEmailChangeId())); //NOI18N
 142                 } else if (emailAddress.getEmailAddress().trim().isEmpty()) {
 143                         // Email address is empty
 144                         throw new IllegalArgumentException("emailAddress.emaiLAddress is empty."); //NOI18N
 145                 } else if (!this.isEmailAddressEnqueued(emailAddress.getEmailAddress())) {
 146                         // Email address is not enqueued
 147                         throw new EJBException(MessageFormat.format("Email address {0} is not enqueued.", emailAddress.getEmailAddress())); //NOI18N
 148                 }
 149
 150                 throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
 151         }
 152
 153         /**
 154          * Generates a secure, unique hash for given email address change. This
 155          * requires to check if the hash is really not there.
 156          * <p>
 157          * @param emailAddressChange Email address change
 158          */
 159         private void generateSecureHash (final ChangeableEmailAddress emailAddressChange) {
 160                 // Email address change should be valid
 161                 if (null == emailAddressChange) {
 162                         // Abort here
 163                         throw new NullPointerException("emailAddressChange is null"); //NOI18N
 164                 } else if (emailAddressChange.getEmailAddress().trim().isEmpty()) {
 165                         // Email address is empty
 166                         throw new IllegalArgumentException("emailAddressChange.emaiLAddress is empty."); //NOI18N
 167                 }
 168
 169                 // Initialize loop with null
 170                 String hash = null;
 171
 172                 // Default is not used
 173                 boolean isUsed = true;
 174
 175                 // Search for free hash
 176                 while (isUsed) {
 177                         // Generate hash, there is already in UserUtils a nice method that can be used for this purpose.
 178                         hash = UserLoginUtils.encryptPassword(String.format("%s:%s", emailAddressChange.getEmailAddress(), emailAddressChange.toString())); //NOI18N
 179
 180                         // The hash *may* be unique, better test it
 181                         final Query query = this.getEntityManager().createNamedQuery("SearchEmailChangeByHash", EmailAddressChange.class); //NOI18N
 182
 183                         // Set hash as parameter
 184                         query.setParameter("hash", hash); //NOI18N
 185
 186                         // Try to get single result
 187                         try {
 188                                 // Get single result
 189                                 final ChangeableEmailAddress dummy = (ChangeableEmailAddress) query.getSingleResult();
 190                         } catch (final NoResultException ex) {
 191                                 // Not found
 192                                 isUsed = false;
 193                         }
 194                 }
 195
 196                 // hash should not be null and set
 197                 assert (hash != null) : "hash is null"; //NOI18N
 198                 assert (!hash.isEmpty()) : "hash is empty"; //NOI18N
 199
 200                 // Set it in email change
 201                 emailAddressChange.setEmailChangeHash(hash);
 202         }
 203
 204         /**
 205          * Checks whether given email address is already enqueued
 206          * <p>
 207          * @param emailAddress Email address to check
 208          * <p>
 209          * @return Whether the email address has already been enqueued
 210          */
 211         private boolean isEmailAddressEnqueued (final String emailAddress) {
 212                 // Trace message
 213                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
 214
 215                 // Default is not found
 216                 boolean isFound = false;
 217
 218                 // Fetch all records
 219                 for (final ChangeableEmailAddress address : this.fetchAllQueuedAddressChanges()) {
 220                         // Is it found?
 221                         if (address.getEmailAddress().equals(emailAddress)) {
 222                                 // Yes, set flag, skip further iterations
 223                                 isFound = true;
 224                                 break;
 225                         }
 226                 }
 227
 228                 // Trace message
 229                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: isFound={1} - EXIT!", this.getClass().getSimpleName(), isFound)); //NOI18N
 230
 231                 // Return it
 232                 return isFound;
 233         }
 234
 235 }