/*
    * 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.runtimeinfo.rest;
  
  import org.opencastproject.util.JaxbXmlSchemaGenerator;
  import org.opencastproject.util.doc.DocData;
  import org.opencastproject.util.doc.rest.RestParameter;
  
  import org.apache.commons.lang3.StringEscapeUtils;
  
  import java.util.HashMap;
  import java.util.Map;
  
  /**
   * Represents a single parameter for an endpoint.
   */
  public final class RestParamData {
    public enum Type {
      BOOLEAN, FILE, STRING, TEXT, INTEGER, FLOAT, LONG
    };
  
    private String name; // unique key
    private String defaultValue;
    private String type;
    private String description;
    private String xmlSchema;
    private boolean required = false;
    private boolean path = false; // This will be true for a path parameter.
  
    /**
     * Attributes are used for adjusting how the input field of this parameter is rendered in the test form. Currently,
     * the template uses 3 attribute values. "rows" and "cols" are used to control the size of text box for a TEXT type
     * parameter. "size" is used to control the size of text box for other types of parameter. Please look at the template
     * to see how this is used.
     */
    private Map<String, String> attributes = new HashMap<>();
  
    /**
     * Convenient constructor: take a RestParameter annotation and create a RestParamData from it.
     *
     * @param restParam
     *          the RestParameter annotation type that is to be transformed to RestParamData
     */
    public RestParamData(RestParameter restParam) {
      this(restParam.name(),
              Type.valueOf(restParam.type().name()),
              restParam.defaultValue(),
              restParam.description(),
              JaxbXmlSchemaGenerator.getXmlSchema(restParam.jaxbClass()));
    }
  
    /**
     * Create a parameter for this endpoint, the thing you are adding it to indicates if required or optional
     *
     * @param name
     *          the parameter name (this is the parameter itself)
     * @param type
     *          [optional] the type of this parameter
     * @param defaultValue
     *          [optional] the default value which is used if this param is missing
     * @param description
     *          [optional] the description to display with this param
     * @param xmlSchema
     *          [optional] the XML schema to display for this param
     * @throws IllegalArgumentException
     *           when name is null or non-alphanumeric
     */
    public RestParamData(String name, Type type, String defaultValue, String description, String xmlSchema)
            throws IllegalArgumentException {
      if (!DocData.isValidName(name)) {
        throw new IllegalArgumentException("Name must not be null and must be alphanumeric.");
      }
      if (type == null) {
        type = Type.STRING;
      }
      this.name = name;
      this.type = type.name().toLowerCase();
      if ((defaultValue == null) || (defaultValue.isEmpty())) {
        if ((type == Type.INTEGER) || (type == Type.FLOAT) || (type == Type.LONG)) {
          this.defaultValue = "0";
       } else {
         this.defaultValue = null;
       }
     } else {
       this.defaultValue = defaultValue;
     }
     if ((description == null) || (description.isEmpty())) {
       this.description = null;
     } else {
       this.description = description;
     }
     this.xmlSchema = xmlSchema;
   }
 
   /**
    * Attributes are used for adjusting rendering of form elements related to this parameter.
    *
    * @param key
    *          the attribute key (e.g. size)
    * @param value
    *          the attribute value (e.g. 80)
    * @throws IllegalArgumentException
    *           when key is null
    */
   public void setAttribute(String key, String value) throws IllegalArgumentException {
     if (key == null) {
       throw new IllegalArgumentException("Key must not be null.");
     }
     if (value == null) {
       attributes.remove(key);
     } else {
       attributes.put(key, value);
     }
   }
 
   /**
    * Get the value indexed by key in attributes.
    *
    * @param key
    *          the attribute key (e.g. size)
    * @return the value indexed by the key or null if that value does not exists
    */
   public String getAttribute(String key) {
     if (key == null) {
       return null;
     }
     return attributes.get(key);
   }
 
   /**
    * Get the name of this parameter.
    *
    * @return name of this parameter
    */
   public String getName() {
     return name;
   }
 
   /**
    * Get the default value of this parameter.
    *
    * @return default value of this parameter
    */
   public String getDefaultValue() {
     return defaultValue;
   }
 
   /**
    * @return an HTML formatted version of the default value for display
    */
   public String getEscapedDefaultValue() {
     return StringEscapeUtils.escapeHtml4(defaultValue);
   }
 
   /**
    * @return an HTML formatted version of the xml schema for display
    */
   public String getEscapedXmlSchema() {
     return StringEscapeUtils.escapeXml(xmlSchema);
   }
 
   /**
    * Get the type of this parameter.
    *
    * @return type of this parameter
    */
   public String getType() {
     return type;
   }
 
   /**
    * Get the description of this parameter.
    *
    * @return description of this parameter
    */
   public String getDescription() {
     return description;
   }
 
   /**
    * Get the attributes used for adjusting rendering of form elements related to this parameter.
    *
    * @return the attributes used for adjusting rendering of form elements related to this parameter
    */
   public Map<String, String> getAttributes() {
     return attributes;
   }
 
   /**
    * Return whether this parameter is required.
    *
    * @return a boolean indicating whether this parameter is required.
    */
   public boolean isRequired() {
     return required;
   }
 
   /**
    * Return whether this parameter is a path parameter.
    *
    * @return a boolean indicating whether this parameter is a path parameter.
    */
   public boolean isPath() {
     return path;
   }
 
   /**
    * Set whether this parameter is a path parameter.
    *
    * @param path
    *          a boolean specifying whether this parameter is a path parameter.
    */
   public void setPath(boolean path) {
     this.path = path;
   }
 
   /**
    * Set whether this parameter is required.
    *
    * @param required
    *          if true then this parameter is require, otherwise it is optional
    */
   public void setRequired(boolean required) {
     this.required = required;
   }
 
   /**
    * Return a string representation of this RestParamData object.
    *
    * @return a string representation of this RestParamData object
    */
   @Override
   public String toString() {
     return "PAR:" + name + ":(" + type + "):" + defaultValue;
   }
 
   /**
    * @return the xmlSchema
    */
   public String getXmlSchema() {
     return xmlSchema;
   }
 
   /**
    * @param xmlSchema
    *          the xmlSchema to set
    */
   public void setXmlSchema(String xmlSchema) {
     this.xmlSchema = xmlSchema;
   }
 }