/*
    * Licensed to The Apereo Foundation under one or more contributor license
    * agreements. See the NOTICE file distributed with this work for additional
    * information regarding copyright ownership.
    *
    *
    * The Apereo Foundation licenses this file to you under the Educational
    * Community License, Version 2.0 (the "License"); you may not use this file
    * except in compliance with the License. You may obtain a copy of the License
   * at:
   *
   *   http://opensource.org/licenses/ecl2.txt
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
   * License for the specific language governing permissions and limitations under
   * the License.
   *
   */
  
  package org.opencastproject.event.comment;
  
  import static org.opencastproject.util.RequireUtil.notEmpty;
  import static org.opencastproject.util.RequireUtil.notNull;
  
  import org.opencastproject.security.api.User;
  import org.opencastproject.util.DateTimeSupport;
  import org.opencastproject.util.EqualsUtil;
  import org.opencastproject.util.Jsons;
  import org.opencastproject.util.Jsons.Obj;
  import org.opencastproject.util.Jsons.Val;
  import org.opencastproject.util.data.Option;
  
  import org.apache.commons.lang3.StringUtils;
  
  import java.util.ArrayList;
  import java.util.Date;
  import java.util.List;
  
  /**
   * Business object for comments.
   */
  public final class EventComment {
  
    /** The key for the reason that the video needs cutting */
    public static final String REASON_NEEDS_CUTTING = "EVENTS.EVENTS.DETAILS.COMMENTS.REASONS.CUTTING";
  
    /** The comment identifier */
    private Option<Long> id;
  
    /** The event identifier */
    private String eventId;
  
    /** The organization */
    private String organization;
  
    /** The comment text */
    private String text;
  
    /** The creation date */
    private Date creationDate;
  
    /** The modification date */
    private Date modificationDate;
  
    /** The comment author */
    private User author;
  
    /** The comment reason */
    private String reason;
  
    /** The comment resolve status */
    private boolean resolvedStatus = false;
  
    /** The comment replies */
    private List<EventCommentReply> replies = new ArrayList<EventCommentReply>();
  
    /**
     * Creates a simple comment
     *
     * @param id
     *          the optional identifier
     * @param text
     *          the text
     * @param author
     *          the author of the comment
     * @throws IllegalArgumentException
     *           if id, text or author is not set
     */
    public static EventComment create(Option<Long> id, String eventId, String organization, String text, User author) {
      return create(id, eventId, organization, text, author, null, false);
    }
  
    /**
     * Creates a complex comment
     *
     * @param id
     *          the optional identifier
    * @param text
    *          the text
    * @param author
    *          the author of the comment
    * @param reason
    *          the comment reason
    * @param resolvedStatus
    *          whether the comment is resolved
    * @throws IllegalArgumentException
    *           if id, text, or author is not set
    */
   public static EventComment create(
       Option<Long> id,
       String eventId,
       String organization,
       String text,
       User author,
       String reason,
       boolean resolvedStatus
   ) {
     Date creationDate = new Date();
     return create(
         id, eventId, organization, text, author, reason, resolvedStatus,
         creationDate, creationDate, new ArrayList<EventCommentReply>()
     );
   }
 
   /**
    * Creates a complex comment
    *
    * @param id
    *          the optional identifier
    * @param text
    *          the text
    * @param author
    *          the author of the comment
    * @param reason
    *          the comment reason
    * @param resolvedStatus
    *          whether the comment is resolved
    * @param resolvedStatus
    *          whether the comment is resolved
    * @param creationDate
    *          the creation date
    * @param modificationDate
    *          the modification date
    * @throws IllegalArgumentException
    *           if id, text, author, creation date or modification date is not set
    */
   public static EventComment create(
       Option<Long> id,
       String eventId,
       String organization,
       String text,
       User author,
       String reason,
       boolean resolvedStatus,
       Date creationDate,
       Date modificationDate
   ) {
     return new EventComment(
         id, eventId, organization, text, author, reason, resolvedStatus,
         creationDate, modificationDate, new ArrayList<EventCommentReply>());
   }
 
   /**
    * Creates a complex comment
    *
    * @param id
    *          the optional identifier
    * @param text
    *          the text
    * @param author
    *          the author of the comment
    * @param reason
    *          the comment reason
    * @param resolvedStatus
    *          whether the comment is resolved
    * @param resolvedStatus
    *          whether the comment is resolved
    * @param creationDate
    *          the creation date
    * @param modificationDate
    *          the modification date
    * @param replies
    *          the replies
    * @throws IllegalArgumentException
    *           if id, text, author, creation date, modification date or replies is not set
    */
   public static EventComment create(
       Option<Long> id,
       String eventId,
       String organization,
       String text,
       User author,
       String reason,
       boolean resolvedStatus,
       Date creationDate,
       Date modificationDate,
       List<EventCommentReply> replies
   ) {
     return new EventComment(id, eventId, organization, text, author, reason,
         resolvedStatus, creationDate, modificationDate, replies);
   }
 
   private EventComment(
       Option<Long> id,
       String eventId,
       String organization,
       String text,
       User author,
       String reason,
       boolean resolvedStatus,
       Date creationDate,
       Date modificationDate,
       List<EventCommentReply> replies
   ) {
     this.id = notNull(id, "id");
     this.eventId = notEmpty(eventId, "eventId");
     this.organization = notEmpty(organization, "organization");
     this.text = notEmpty(text, "text");
     this.author = notNull(author, "author");
     this.reason = reason;
     this.resolvedStatus = resolvedStatus;
     this.creationDate = notNull(creationDate, "creationDate");
     this.modificationDate = notNull(modificationDate, "modificationDate");
     this.replies = notNull(replies, "replies");
   }
 
   /**
    * Returns the comment id
    *
    * @return the id
    */
   public Option<Long> getId() {
     return id;
   }
 
   public String getEventId() {
     return eventId;
   }
 
   public void setEventId(String eventId) {
     this.eventId = eventId;
   }
 
   public String getOrganization() {
     return organization;
   }
 
   public void setOrganization(String organization) {
     this.organization = organization;
   }
 
   /**
    * Returns the text
    *
    * @return the text
    */
   public String getText() {
     return text;
   }
 
   /**
    * Returns the creation date
    *
    * @return the creation date
    */
   public Date getCreationDate() {
     return creationDate;
   }
 
   /**
    * Returns the modification date
    *
    * @return the modification date
    */
   public Date getModificationDate() {
     return modificationDate;
   }
 
   /**
    * Returns the author
    *
    * @return the author
    */
   public User getAuthor() {
     return author;
   }
 
   /**
    * Returns the reason
    *
    * @return the reason
    */
   public String getReason() {
     return reason;
   }
 
   /**
    * Returns whether the status is resolved
    *
    * @return whether the status is resolved
    */
   public boolean isResolvedStatus() {
     return resolvedStatus;
   }
 
   /**
    * Returns the comment replies
    *
    * @return the comment replies
    */
   public List<EventCommentReply> getReplies() {
     return replies;
   }
 
   /**
    * Add a reply to the comment
    *
    * @param reply
    *          the reply to add to this comment
    *
    * @return true if this collection changed as a result of the call
    */
   public boolean addReply(EventCommentReply reply) {
     return replies.add(notNull(reply, "reply"));
   }
 
   /**
    * Remove a reply from the comment
    *
    * @param reply
    *          the reply to remove from this comment
    *
    * @return true if this collection changed as a result of the call
    */
   public boolean removeReply(EventCommentReply reply) {
     return replies.remove(notNull(reply, "reply"));
   }
 
   @Override
   public boolean equals(Object o) {
     if (this == o) {
       return true;
     }
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
     EventComment comment = (EventComment) o;
 
     return text.equals(comment.getText()) && creationDate.equals(comment.getCreationDate())
         && modificationDate.equals(comment.getModificationDate()) && author.equals(comment.getAuthor())
         && (reason == null ? comment.getReason() == null : reason.equals(comment.getReason()))
         && resolvedStatus == comment.isResolvedStatus();
   }
 
   @Override
   public int hashCode() {
     return EqualsUtil.hash(text, creationDate, modificationDate, author, reason, resolvedStatus);
   }
 
   @Override
   public String toString() {
     return "Comment:" + id + "|" + StringUtils.abbreviate(text, 25);
   }
 
   public Obj toJson() {
     Obj authorObj = Jsons.obj(Jsons.p("name", author.getName()), Jsons.p("username", author.getUsername()),
             Jsons.p("email", author.getEmail()));
 
     List<Val> replyArr = new ArrayList<Val>();
     for (EventCommentReply reply : replies) {
       replyArr.add(reply.toJson());
     }
 
     Val idValue = Jsons.ZERO_VAL;
     if (id.isSome()) {
       idValue = Jsons.v(id.get());
     }
 
     return Jsons.obj(
         Jsons.p("id", idValue),
         Jsons.p("text", text),
         Jsons.p("creationDate", DateTimeSupport.toUTC(creationDate.getTime())),
         Jsons.p("modificationDate", DateTimeSupport.toUTC(modificationDate.getTime())),
         Jsons.p("author", authorObj), Jsons.p("reason", reason), Jsons.p("resolvedStatus", resolvedStatus),
         Jsons.p("replies", Jsons.arr(replyArr))
     );
   }
 
 }