/**
 * This file is part of Eclipse Steady.
 *
 * Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * SPDX-FileCopyrightText: Copyright (c) 2018-2020 SAP SE or an SAP affiliate company and Eclipse Steady contributors
 */
/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package org.eclipse.steady.cg;

import java.net.URL;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.steady.shared.json.JacksonUtil;
import org.eclipse.steady.shared.json.model.ConstructId;

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import com.ibm.wala.ipa.callgraph.CallGraph;

/**
 * This class represent the MetaInformation that a node in the {@link CallGraph} can carry with himself
 */
public class NodeMetaInformation {
  private ConstructId originalConstructId = null;
  private ConstructId modifiedConstructId = null;
  private String jarUrl = null;
  private String archiveID = null;

  /**
   * Used for the attackSurface detection in {@link ReachabilityAnalyzer#identifyTouchPoints()}
   */
  private List<NodeMetaInformation> attackSurface = null;

  /**
   * <p>Constructor for NodeMetaInformation.</p>
   *
   * @param _originalConstructId a {@link org.eclipse.steady.shared.json.model.ConstructId} object.
   * @param _modifiedConstructId a {@link org.eclipse.steady.shared.json.model.ConstructId} object.
   * @param _jar_url a {@link java.net.URL} object.
   * @param _archiveID a {@link java.lang.String} object.
   */
  public NodeMetaInformation(
      ConstructId _originalConstructId,
      ConstructId _modifiedConstructId,
      URL _jar_url,
      String _archiveID) {
    this.originalConstructId = _originalConstructId;
    this.modifiedConstructId = _modifiedConstructId;
    this.jarUrl = (_jar_url == null ? null : _jar_url.toString());
    this.archiveID = _archiveID;
  }

  /**
   * <p>Constructor for NodeMetaInformation.</p>
   *
   * @param _originalConstructId a {@link org.eclipse.steady.shared.json.model.ConstructId} object.
   */
  public NodeMetaInformation(ConstructId _originalConstructId) {
    this.originalConstructId = _originalConstructId;
  }

  /**
   * Used for the attackSurface detection in {@link ReachabilityAnalyzer#identifyTouchPoints()}
   *
   * @param _rs a {@link org.eclipse.steady.cg.NodeMetaInformation} object.
   */
  public void addToList(NodeMetaInformation _rs) {
    if (this.attackSurface == null) {
      this.attackSurface = new ArrayList<NodeMetaInformation>();
    }
    this.attackSurface.add(_rs);
  }

  /**
   * Used for the attackSurface detection in {@link ReachabilityAnalyzer#identifyTouchPoints()}
   *
   * @return a int.
   */
  public int getListSize() {
    return attackSurface != null ? attackSurface.size() : 0;
  }

  /**
   * Compares the construct with the given construct by comparing their qualified name.
   *
   * @param _c a {@link org.eclipse.steady.cg.NodeMetaInformation} object.
   * @return a int.
   */
  public final int compareTo(NodeMetaInformation _c) {
    return this.getOriginalConstructId().compareTo(_c.getOriginalConstructId());
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    final StringBuilder b = new StringBuilder();
    b.append("[oc=").append(this.originalConstructId.getQname());
    if (this.modifiedConstructId != null)
      b.append(", mc=").append(this.modifiedConstructId.getQname());
    b.append(", jarUrl=").append(this.jarUrl).append("]");
    return b.toString();
  }

  /** {@inheritDoc} */
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + this.getOriginalConstructId().hashCode();
    return result;
  }

  /**
   * {@inheritDoc}
   *
   * Returns true if the qualified name of the two constructs are equal, false otherwise.
   */
  @Override
  public boolean equals(Object obj) {
    if (this == obj) return true;
    if (obj == null) return false;
    if (getClass() != obj.getClass()) return false;
    NodeMetaInformation other = (NodeMetaInformation) obj;
    return this.getOriginalConstructId().equals(other.getOriginalConstructId());
  }

  private ConstructId getOriginalConstructId() {
    return this.originalConstructId;
  }

  /**
   * <p>getConstructId.</p>
   *
   * @return a {@link org.eclipse.steady.shared.json.model.ConstructId} object.
   */
  public ConstructId getConstructId() {
    return this.modifiedConstructId != null ? this.modifiedConstructId : this.originalConstructId;
  }

  /**
   * <p>Getter for the field <code>jarUrl</code>.</p>
   *
   * @return a {@link java.lang.String} object.
   */
  public String getJarUrl() {
    return this.jarUrl;
  }

  /**
   * <p>toJSON.</p>
   *
   * @return a {@link com.google.gson.JsonObject} object.
   */
  public JsonObject toJSON() {
    return this.toJSON(false);
  }

  /**
   * <p>toJSON.</p>
   *
   * @param _addAlsoAttackSurface a boolean.
   * @return a {@link com.google.gson.JsonObject} object.
   */
  public JsonObject toJSON(boolean _addAlsoAttackSurface) {
    // create GSON object with the right constructID
    final JsonObject rootObj =
        new JsonParser().parse(JacksonUtil.asJsonString(this.getConstructId())).getAsJsonObject();
    // add JAR URL
    if (this.jarUrl != null) rootObj.addProperty("jarUrl", this.jarUrl);
    // add JAR ID
    if (this.archiveID != null) rootObj.addProperty("archiveID", this.archiveID);
    // add list
    if (_addAlsoAttackSurface && this.getListSize() > 0) {
      JsonArray myArray = new JsonArray();
      for (NodeMetaInformation element : this.attackSurface) {
        JsonObject child = element.toJSON(_addAlsoAttackSurface);
        myArray.add(child);
      }
      rootObj.add("attackSurface", myArray);
    }
    return rootObj;
  }

  /**
   * <p>getArchiveId.</p>
   *
   * @return a {@link java.lang.String} object.
   */
  public String getArchiveId() {
    return this.archiveID;
  }
}
