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