package org.unitedfront2.domain.communication;
   
   import java.io.Serializable;
   import java.util.ArrayList;
   import java.util.Collections;
   import java.util.Date;
   import java.util.List;
   import java.util.Locale;
   
  import org.apache.commons.lang.RandomStringUtils;
  import org.apache.commons.lang.builder.EqualsBuilder;
  import org.apache.commons.lang.builder.HashCodeBuilder;
  import org.apache.commons.lang.builder.ToStringBuilder;
  import org.apache.commons.logging.LogFactory;
  import org.unitedfront2.dao.DateDao;
  import org.unitedfront2.dao.MailDao;
  import org.unitedfront2.domain.AccountTable;
  import org.unitedfront2.domain.Domain;
  import org.unitedfront2.domain.Identifiable;
  import org.unitedfront2.domain.SimpleUser;
  import org.unitedfront2.domain.SimpleUserTable;
  import org.unitedfront2.domain.Storable;
  import org.unitedfront2.domain.User;
  
  /**
   * メールクラスです。メールは１対１のコミュニケーション用のツールです。親メールに対して返信していくことで、リスト
   * 構造を持つ一連のメール群を形成できます。これをメールのスレッドと呼びます。
   *
   * @author kurokkie
   *
   */
  public class Mail implements Identifiable<Mail>, Storable, Serializable,
      Domain {
  
      /** ランダムで生成されるときのコードの長さ (32) */
      public static final int GENERATED_CODE_LENGTH = 32;
  
      /** シリアル番号 */
      private static final long serialVersionUID = -8522418960016784969L;
  
      /** ランダム生成コードが重複した際に、再生成して再チャレンジする回数 (10) */
      private static final int MAX_CHALLENGE_COUNT = 10;
  
      /** ID */
      private Integer id;
  
      /** コード */
      private String code;
  
      /** 宛先のユーザ ID */
      private Integer toId;
  
      /** 差出人のユーザ ID */
      private Integer fromId;
  
      /** 送信日時 */
      private Date sentDate;
  
      /** 件名 */
      private String subject;
  
      /** 本文 */
      private String body;
  
      /** 宛先ユーザが既読の場合は true 、そうでなければ false */
      private boolean read;
  
      /** 宛先ユーザ */
      private transient SimpleUser to;
  
      /** 差出人ユーザ */
      private transient SimpleUser from;
  
      /** 宛先のメールアドレス。実際にメールを送信するための変数。 */
      private transient String toMailAddr;
  
      /** このメールに対して返信したメール */
      private transient Mail next;
  
      /** 日時データアクセスオブジェクト */
      private transient DateDao dateDao;
  
      /** メールデータアクセスオブジェクト **/
      private transient MailDao mailDao;
  
      /** ユーザテーブル */
      private transient SimpleUserTable simpleUserTable;
  
      /** アカウントテーブル */
      private transient AccountTable accountTable;
  
      public Mail() {
          super();
      }
  
      public Mail(Integer toId, Integer fromId, String subject, String body) {
          super();
          this.toId = toId;
          this.fromId = fromId;
         this.subject = subject;
         this.body = body;
     }
 
     public Mail(Integer id, String code, Integer toId, Integer fromId,
             String subject, String body, Date sentDate, boolean read) {
         this(toId, fromId, subject, body);
         this.id = id;
         this.code = code;
         this.sentDate = (Date) sentDate.clone();
         this.read = read;
     }
 
     @Override
     public String toString() {
         ToStringBuilder tsb = new ToStringBuilder(this)
             .append("id", id)
             .append("code", code)
             .append("toId", toId)
             .append("fromId", fromId)
             .append("sentDate", sentDate)
             .append("subject", subject)
             .append("body", body)
             .append("read", read)
             .append("next", next);
         return tsb.toString();
     }
 
     @Override
     public boolean equals(final Object other) {
         if (!(other instanceof Mail)) {
             return false;
         }
         Mail castOther = (Mail) other;
         return new EqualsBuilder()
             .append(id, castOther.id)
             .append(code, castOther.code)
             .append(toId, castOther.toId)
             .append(fromId, castOther.fromId)
             .append(sentDate, castOther.sentDate)
             .append(subject, castOther.subject)
             .append(body, castOther.body)
             .append(read, castOther.read).isEquals();
     }
 
     @Override
     public int hashCode() {
         return new HashCodeBuilder()
             .append(id)
             .append(code)
             .append(toId)
             .append(fromId)
             .append(sentDate)
             .append(subject)
             .append(body)
             .append(read).toHashCode();
     }
 
     @Override
     public boolean identify(Mail other) {
         if (id == null || other.getId() == null) {
             return false;
         }
         return id.equals(other.getId());
     }
 
     /**
      * {@link #send()} と同様の処理です。
      *
      * @see Storable#store()
      */
     @Override
     public void store() {
         send();
     }
 
     /**
      * このメールを送信します。コードは自動で発行されます。送信日時は現在日時が設定されます。
      *
      * @require ${this.toId} is not null.
      * @ensure ${this.code} is auto generated.
      * @ensure ${this.lastUpdateDate} is current date.
      * @return 自身を返します
      */
     public Mail send() {
         if (toId == null) {
             String message = "The toId must not be null. Mail[" + this + "]";
             LogFactory.getLog(getClass()).error(message);
             throw new IllegalStateException(message);
         }
         this.code = generateCode();
         this.sentDate = dateDao.getCurrentDate();
         mailDao.register(this);
         return this;
     }
 
     private String generateCode() {
         for (int i = 0; i < MAX_CHALLENGE_COUNT; i++) {
             String code = RandomStringUtils.randomAlphanumeric(
                     GENERATED_CODE_LENGTH).toLowerCase(Locale.ENGLISH);
             if (mailDao.findByCode(code) == null) {
                 return code;
             }
         }
         String message = "Failed to generate code.";
         LogFactory.getLog(getClass()).error(message);
         throw new IllegalStateException(message);
     }
 
     /**
      * メールを返信します。コードは自動で発行されます。送信日時は現在日時が設定されます。
      *
      * @param parentId 親メール ID
      * @require ${this.toId} is not null.
      * @require ${this.fromId} is not null.
      * @ensure ${this.code} is auto generated.
      * @ensure ${this.lastUpdateDate} is current date.
      * @see #store()
      */
     public void send(int parentId) {
         if (toId == null) {
             String message = "The To must not be null. Mail[" + this + "]";
             LogFactory.getLog(getClass()).error(message);
             throw new IllegalStateException(message);
         }
         if (fromId == null) {
             String message = "The from must not be null. Mail[" + this + "]";
             LogFactory.getLog(getClass()).error(message);
             throw new IllegalStateException(message);
         }
         this.code = generateCode();
         this.sentDate = dateDao.getCurrentDate();
         mailDao.register(this, parentId);
     }
 
     /**
      * このメールが ${userId} 宛の場合、このメールを既読にします。
      *
      * @param userId 閲覧ユーザの ID
      * @ensure このメールが ${userId} 宛の場合、このメールの既読/未読状態がデータベースと同期する
      */
     public void read(int userId) {
         if (userId == toId.intValue()) {
             read = true;
             mailDao.updateRead(id, true);
         }
     }
 
     /**
      * このメールスレッド中の全ての ${userId} 宛のメールを既読にします。
      *
      * @param userId 閲覧ユーザの ID
      * @ensure このメールスレッド中の全ての ${userId} 宛のメールの既読/未読状態がデータベースと同
      * 期する
      */
     public void readAll(int userId) {
         read(userId);
         if (next != null) {
             next.readAll(userId);
         }
     }
 
     /**
      * このメールが ${userId} 宛の場合、このメールを未読にします。
      *
      * @param userId 閲覧ユーザの ID
      * @ensure このメールが ${userId} 宛の場合、このメールの既読/未読状態がデータベースと同期する
      */
     public void unread(int userId) {
         if (userId == toId.intValue()) {
             read = false;
             mailDao.updateRead(id, false);
         }
     }
 
     /**
      * このメールスレッド中の全ての ${userId} 宛のメールを未読にします。
      *
      * @param userId 閲覧ユーザの ID
      * @ensure このメールスレッド中の全ての ${userId} 宛のメールの既読/未読状態がデータベースと同
      * 期する
      */
     public void unreadAll(int userId) {
         unread(userId);
         if (next != null) {
             next.unreadAll(userId);
         }
     }
 
     /**
      * メールスレッド中に未読メールがあるかどうか判定します。
      *
      * @param toId 宛先ユーザ ID
      * @return 未読のメールがあれば <code>true</code> 、なければ <code>false</code>
      */
     public boolean hasUnread(int toId) {
         if (toId == this.toId && !isRead()) {
             return true;
         } else {
             return next != null && next.hasUnread(toId);
         }
     }
 
     /**
      * スレッド内のメール数を取得します。
      *
      * @return スレッド内のメール数
      */
     public int getCount() {
         int count = 1;
         if (next != null) {
             count += next.getCount();
         }
         return count;
     }
 
     /**
      * メールスレッドを親から順のリストとして返します。
      *
      * @return メールリスト
      */
     public List<Mail> asList() {
         List<Mail> list = new ArrayList<Mail>(getCount());
         addToList(list, this);
         return list;
     }
 
     private void addToList(List<Mail> list, Mail mail) {
         list.add(mail);
         if (mail.next != null) {
             addToList(list, mail.next);
         }
     }
 
     /**
      * メールスレッドを子から順のリストとして返します。
      *
      * @return メールリスト
      */
     public List<Mail> asListDesc() {
         List<Mail> list = asList();
         Collections.reverse(list);
         return list;
     }
 
     /**
      * 末端に位置するサブメールを返します。サブメールが設定されていない場合は自身が返ります。
      *
      * @return 末端のメール
      */
     public Mail getTail() {
         Mail mail = this;
         while (mail.getNext() != null) {
             mail = mail.getNext();
         }
         return mail;
     }
 
     /**
      * <code>user</code> にとっての通信相手を返します。<code>user</code> はこのメールの宛先
      * または差出人に含まれている必要があります。
      *
      * @param user ユーザ
      * @require ${this.to} not null.
      * @require ${this.from} not null.
      * @return 通信相手
      */
     public SimpleUser other(User user) {
         if (user.identify(getTo())) {
             return getFrom();
         } else if (user.identify(getFrom())) {
             return getTo();
         } else {
             throw new IllegalArgumentException("The user '" + user
                 + "' is neither TO or FROM.");
         }
     }
 
     public Integer getId() {
         return id;
     }
 
     public void setId(Integer id) {
         this.id = id;
     }
 
     public String getCode() {
         return code;
     }
 
     public void setCode(String code) {
         this.code = code;
     }
 
     public Integer getToId() {
         return toId;
     }
 
     public void setToId(Integer toId) {
         this.toId = toId;
     }
 
     public Integer getFromId() {
         return fromId;
     }
 
     public void setFromId(Integer fromId) {
         this.fromId = fromId;
     }
 
     public Date getSentDate() {
         if (sentDate == null) {
             return null;
         } else {
             return (Date) sentDate.clone();
         }
     }
 
     public void setSentDate(Date sentDate) {
         if (sentDate == null) {
             this.sentDate = null;
         } else {
             this.sentDate = (Date) sentDate.clone();
         }
     }
 
     public String getSubject() {
         return subject;
     }
 
     public void setSubject(String subject) {
         this.subject = subject;
     }
 
     public String getBody() {
         return body;
     }
 
     public void setBody(String body) {
         this.body = body;
     }
 
     public boolean isRead() {
         return read;
     }
 
     public void setRead(boolean read) {
         this.read = read;
     }
 
     public SimpleUser getTo() {
         if (to == null && this.toId != null && simpleUserTable != null) {
             this.to = simpleUserTable.find(this.toId);
         }
         return to;
     }
 
     public void setTo(SimpleUser to) {
         this.to = to;
         if (to != null) {
             this.toId = to.getId();
         }
     }
 
     public SimpleUser getFrom() {
         if (from == null && this.fromId != null && simpleUserTable != null) {
             this.from = simpleUserTable.find(this.fromId);
         }
         return from;
     }
 
     public void setFrom(SimpleUser from) {
         this.from = from;
         if (from != null) {
             this.fromId = from.getId();
         }
     }
 
     public String getToName() {
         if (to == null) {
             return null;
         } else {
             return to.getName();
         }
     }
 
     public void setToName(String toName) {
         if (to != null) {
             to.setName(toName);
         }
     }
 
     public String getToMailAddr() {
         if (toMailAddr == null && accountTable != null && getTo() != null
                 && getTo().getId() != null) {
             this.toMailAddr = accountTable.find(getTo().getId()).getMailAddr();
         }
         return toMailAddr;
     }
 
     public void setToMailAddr(String toMailAddr) {
         this.toMailAddr = toMailAddr;
     }
 
     public Mail getNext() {
         return next;
     }
 
     public void setNext(Mail next) {
         this.next = next;
     }
 
     public void setDateDao(DateDao dateDao) {
         this.dateDao = dateDao;
     }
 
     public void setMailDao(MailDao mailDao) {
         this.mailDao = mailDao;
     }
 
     public void setSimpleUserTable(SimpleUserTable simpleUserTable) {
         this.simpleUserTable = simpleUserTable;
     }
 
     public void setAccountTable(AccountTable accountTable) {
         this.accountTable = accountTable;
     }
 }