/*
 *  Copyright (C) 2012 maartenl
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package mmud.database.entities.game;

import java.io.Serializable;
import java.util.Date;
import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import mmud.database.entities.characters.User;
import org.eclipse.persistence.annotations.AdditionalCriteria;

/**
 *
 * @author maartenl
 */
@Entity
@Table(name = "mm_boardmessages")
@NamedQueries(
        {
          @NamedQuery(name = "BoardMessage.findAll", query = "SELECT b FROM BoardMessage b")
          ,
            @NamedQuery(name = "BoardMessage.findByName", query = "SELECT b FROM BoardMessage b WHERE b.user = :person")
          ,
            @NamedQuery(name = "BoardMessage.news", query = "SELECT b FROM BoardMessage b WHERE b.board.name = 'logonmessage' order by b.id desc")
        })
@AdditionalCriteria("FUNCTION('yearweek', this.posttime) = FUNCTION('yearweek', current_date) "
        + "and this.removed = 0)")
public class BoardMessage implements Serializable
{

  private static final long serialVersionUID = 1L;
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  @JoinColumn(name = "boardid", referencedColumnName = "id")
  @ManyToOne(optional = false)
  private Board board;
  @JoinColumn(name = "name", referencedColumnName = "name")
  @ManyToOne(optional = false)
  private User user;
  @Basic(optional = false)
  @NotNull
  @Column(name = "posttime")
  @Temporal(TemporalType.TIMESTAMP)
  private Date posttime;
  @Basic(optional = false)
  @NotNull
  @Lob
  @Size(min = 1, max = 65535)
  @Column(name = "message")
  private String message;
  @Column(name = "removed")
  private Boolean removed;

  public BoardMessage()
  {
  }

  /**
   * Returns the contents of the message as posted. If the message has been
   * removed, it will return the message "Message has been removed due to offensive
   * content.".
   *
   * @return the contents of the message on the board.
   * @see #getRemoved()
   */
  public String getMessage()
  {
    if (getRemoved())
    {
      return "<FONT COLOR=red>[Message has been removed due to offensive content.]</FONT>";
    }
    return message;
  }

  public void setMessage(String message)
  {
    this.message = message;
  }

  /**
   * Indicates that the message has been removed. (possibly due to bad content)
   *
   * @return true if removed, false otherwise.
   */
  public Boolean getRemoved()
  {
    return removed;
  }

  /**
   *
   * @param removed true if the message needs be removed, fals otherwise.
   */
  public void setRemoved(Boolean removed)
  {
    this.removed = removed;
  }

  public Board getBoard()
  {
    return board;
  }

  public void setBoard(Board board)
  {
    this.board = board;
  }

  public Integer getId()
  {
    return id;
  }

  public void setId(Integer id)
  {
    this.id = id;
  }

  public User getPerson()
  {
    return user;
  }

  public void setPerson(User user)
  {
    this.user = user;
  }

  public Date getPosttime()
  {
    return posttime;
  }

  public void setPosttime(Date posttime)
  {
    this.posttime = posttime;
  }

  @Override
  public int hashCode()
  {
    int hash = 0;
    if (id == null)
    {
      return -1;
    }
    hash += id.hashCode();
    return hash;
  }

  @Override
  public boolean equals(Object object)
  {
    // TODO: Warning - this method won't work in the case the id fields are not set
    if (!(object instanceof BoardMessage))
    {
      return false;
    }
    BoardMessage other = (BoardMessage) object;
    if ((this.id == null && other.id != null) || (this.id != null && !this.id.equals(other.id)))
    {
      return false;
    }
    return true;
  }

  @Override
  public String toString()
  {
    return "mmud.database.entities.game.BoardMessage[ id=" + id + " ]";
  }
}