/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero 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 for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.engine.function;

import java.net.URI;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;

import nz.org.riskscape.config.ConfigString;
import nz.org.riskscape.engine.bind.ParameterField;
import nz.org.riskscape.engine.function.IdentifiedFunction.Category;
import nz.org.riskscape.engine.resource.Resource;
import nz.org.riskscape.engine.types.Type;

/**
 * Defines what parameters a INI file function definition can accept, i.e. this
 * defines the metadata associated with a function.
 */
public class MetadataParams {

  private static final String LOCATION_KEY = "location";

  public static boolean locationEndsWith(Map<String, List<?>> unbound, String suffix) {
    List<?> locationValues = unbound.getOrDefault(LOCATION_KEY, Collections.emptyList());
    if (!locationValues.isEmpty()) {
      String location = (String) locationValues.get(0);
      return location.endsWith(suffix);
    }
    return false;
  }

  /**
   * The location of a file containing the function definition.
   */
  @ParameterField
  public Optional<URI> location;

  @ParameterField
  public Optional<ConfigString> source;

  /**
   * The {@link Type} of the result returned by this function.
   */
  @ParameterField
  public Type returnType;

  /**
   * The {@link Type}(s) of arguments that this function accepts.
   */
  @ParameterField(scalarOverride = true)
  public ArgumentList argumentTypes;

  /**
   * An optional description of what this function does.
   */
  @ParameterField
  public Optional<String> description = Optional.empty();

  /**
   * Optionally assigns a category to the function, e.g. 'language'
   */
  @ParameterField
  public Optional<Category> category = Optional.empty();

  /**
   * Explicitly specify the framework that the function will use, i.e. classifier,
   * jython, or python. If omitted, a suitable default will be chosen based on the
   * `location` file extension.
   */
  @ParameterField
  public Optional<String> framework = Optional.empty();

  /**
   * Turns the given parameters into a {@link FunctionMetadata}.
   */
  public FunctionMetadata toFunctionMetadata(String functionName) {
    return new FunctionMetadata(
      functionName,
      argumentTypes,
      returnType,
      description.orElse(FunctionMetadata.NO_DESCRIPTION),
      category.orElse(FunctionMetadata.UNCATEGORIZED),
      // the source will be the given location, or the source's location (if given)
      location.orElse(source.map(ConfigString::getLocation).orElse(Resource.UNKNOWN_URI)));
  }
}
