/*-----------------------------------------------------------------------+
 | com.teamscale.index
 |                                                                       |
   $Id$            
 |                                                                       |
 | Copyright (c)  2009-2013 CQSE GmbH                                 |
 +-----------------------------------------------------------------------*/
package org.conqat.engine.service.shared.data;

import java.io.Serializable;
import java.util.Objects;

import javax.annotation.Nullable;

import org.conqat.lib.commons.js_export.ExportToJavaScript;
import org.conqat.lib.commons.string.StringUtils;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.teamscale.commons.lang.ToStringHelpers;

/**
 * Information about a blacklisted finding.
 *
 * <strong>This class is used for communication with IDE clients (via the @link
 * {@link org.conqat.engine.service.shared.client.IdeServiceClient}, special
 * care has to be taken when changing its signature!</strong>
 */
@ExportToJavaScript
public class FindingBlacklistInfo implements Serializable {

        /** Serial version UID. */
        private static final long serialVersionUID = 1;

        /** The name of the JSON property name for {@link #findingId}. */
        private static final String FINDING_ID_PROPERTY = "findingId";

        /** The name of the JSON property name for {@link #timestamp}. */
        private static final String TIMESTAMP_PROPERTY = "timestamp";

        /** The name of the JSON property name for {@link #user}. */
        private static final String USER_PROPERTY = "user";

        /** The name of the JSON property name for {@link #rationale}. */
        private static final String RATIONALE_PROPERTY = "rationale";

        /** The name of the JSON property name for {@link #type}. */
        private static final String TYPE_PROPERTY = "type";

        /** The ID of the blacklisted finding */
        @JsonProperty(FINDING_ID_PROPERTY)
        private final String findingId;

        /** The time when the finding was blacklisted */
        @JsonProperty(TIMESTAMP_PROPERTY)
        private final long timestamp;

        /** The name of the user who blacklisted the finding */
        @JsonProperty(USER_PROPERTY)
        private final String user;

        /** A rationale why the finding was blacklisted */
        @JsonProperty(RATIONALE_PROPERTY)
        private final String rationale;

        @JsonProperty(TYPE_PROPERTY)
        @Nullable
        private final EFindingBlacklistType type;

        /** Copy constructor. */
        public FindingBlacklistInfo(FindingBlacklistInfo info) {
                this.findingId = info.findingId;
                this.timestamp = info.timestamp;
                this.user = info.user;
                this.rationale = info.rationale;
                this.type = info.type;
        }

        /** Constructor. */
        @JsonCreator
        public FindingBlacklistInfo(@JsonProperty(FINDING_ID_PROPERTY) String findingId,
                        @JsonProperty(TIMESTAMP_PROPERTY) long timestamp, @JsonProperty(USER_PROPERTY) String user,
                        @JsonProperty(RATIONALE_PROPERTY) String rationale,
                        @JsonProperty(TYPE_PROPERTY) EFindingBlacklistType type) {
                this.findingId = findingId;
                this.timestamp = timestamp;
                this.user = user;
                this.rationale = rationale;
                this.type = type;
        }

        /** Clones this FindingBlacklistInfo but uses the given findingId. */
        public FindingBlacklistInfo cloneWithNewFindingId(String findingId) {
                return new FindingBlacklistInfo(findingId, timestamp, user, rationale, type);
        }

        /** Clones this FindingBlacklistInfo but uses the given findingId. */
        public FindingBlacklistInfo cloneWithNewType(EFindingBlacklistType newType) {
                return new FindingBlacklistInfo(findingId, timestamp, user, rationale, newType);
        }

        /**
         * Ensures that the type of blacklisting is set. If it is null it is tried to
         * heuristically derive the type from the rationale. The default is
         * {@link EFindingBlacklistType#TOLERATION}.
         */
        public static FindingBlacklistInfo ensureBlacklistTypeSet(FindingBlacklistInfo blacklistInfo) {
                if (blacklistInfo.getType() != null) {
                        return blacklistInfo;
                }
                String rationale = blacklistInfo.getRationale();
                if (!StringUtils.isEmpty(rationale) && rationale.toLowerCase().contains("false")
                                && rationale.toLowerCase().contains("positive")) {
                        return blacklistInfo.cloneWithNewType(EFindingBlacklistType.FALSE_POSITIVE);
                }
                return blacklistInfo.cloneWithNewType(EFindingBlacklistType.TOLERATION);
        }

        /** Returns the finding id. */
        public String getFindingId() {
                return findingId;
        }

        /** Returns the timestamp. */
        public long getTimestamp() {
                return timestamp;
        }

        /** Returns the user who blacklisted the finding. */
        public String getUser() {
                return user;
        }

        /** Returns the rationale. */
        public String getRationale() {
                return rationale;
        }

        /**
         * Returns the blacklist type. This can be <code>null</code> for backwards
         * compatibility
         */
        public EFindingBlacklistType getType() {
                return type;
        }

        @Override
        public final boolean equals(Object obj) {
                if (obj instanceof FindingBlacklistInfo) {
                        FindingBlacklistInfo other = (FindingBlacklistInfo) obj;
                        return Objects.equals(findingId, other.findingId) && Objects.equals(rationale, other.rationale)
                                        && timestamp == other.timestamp && Objects.equals(user, other.user)
                                        && Objects.equals(type, other.type);
                }
                return false;
        }

        @Override
        public final int hashCode() {
                return Objects.hash(findingId, rationale, timestamp, user, type);
        }

        @Override
        public String toString() {
                return ToStringHelpers.toReflectiveStringHelper(this).toString();
        }
}