/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.query;

import com.google.common.base.Enums;
import com.google.common.collect.Lists;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.persistence.TypedQuery;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import org.hisp.dhis.schema.Property;
import org.hisp.dhis.schema.Schema;
import org.hisp.dhis.util.DateUtils;
import org.hisp.dhis.webapi.controller.event.mapper.OrderParam;
import org.hisp.dhis.webapi.controller.event.webrequest.OrderCriteria;

/**
 * @author Morten Olav Hansen <mortenoh@gmail.com>
 */
public final class QueryUtils {

  private static final String UNABLE_TO_PARSE = "Unable to parse `";

  private QueryUtils() {
    throw new UnsupportedOperationException("util");
  }

  public static <T> T parseValue(Class<?> klass, Object objectValue) {
    return parseValue(klass, null, objectValue);
  }

  @SuppressWarnings("unchecked")
  public static <T> T parseValue(Class<?> klass, Class<?> secondaryKlass, Object objectValue) {
    if (klass.isInstance(objectValue)) {
      return (T) objectValue;
    }

    if (!(objectValue instanceof String)) {
      return (T) objectValue;
    }

    String value = (String) objectValue;

    if (Integer.class.isAssignableFrom(klass)) {
      try {
        return (T) Integer.valueOf(value);
      } catch (Exception ex) {
        throw new QueryParserException(UNABLE_TO_PARSE + value + "` as `Integer`.");
      }
    }
    if (Boolean.class.isAssignableFrom(klass)) {
      try {
        return (T) Boolean.valueOf(value);
      } catch (Exception ex) {
        throw new QueryParserException(UNABLE_TO_PARSE + value + "` as `Boolean`.");
      }
    }
    if (Float.class.isAssignableFrom(klass)) {
      try {
        return (T) Float.valueOf(value);
      } catch (Exception ex) {
        throw new QueryParserException(UNABLE_TO_PARSE + value + "` as `Float`.");
      }
    }
    if (Double.class.isAssignableFrom(klass)) {
      try {
        return (T) Double.valueOf(value);
      } catch (Exception ex) {
        throw new QueryParserException(UNABLE_TO_PARSE + value + "` as `Double`.");
      }
    }
    if (Date.class.isAssignableFrom(klass)) {
      try {
        Date date = DateUtils.parseDate(value);
        return (T) date;
      } catch (Exception ex) {
        throw new QueryParserException(UNABLE_TO_PARSE + value + "` as `Date`.");
      }
    }
    if (Enum.class.isAssignableFrom(klass)) {
      T enumValue = getEnumValue(klass, value);

      if (enumValue != null) {
        return enumValue;
      }
    } else if (Collection.class.isAssignableFrom(klass)) {
      if (!value.startsWith("[") || !value.endsWith("]")) {
        try {
          return (T) Integer.valueOf(value);
        } catch (NumberFormatException e) {
          throw new QueryParserException("Collection size must be integer `" + value + "`");
        }
      }

      String[] split = value.substring(1, value.length() - 1).split(",");
      List<String> items = Lists.newArrayList(split);

      if (secondaryKlass != null) {
        List<Object> convertedList = new ArrayList<>();

        for (String item : items) {
          Object convertedValue = parseValue(secondaryKlass, null, item);

          if (convertedValue != null) {
            convertedList.add(convertedValue);
          }
        }

        return (T) convertedList;
      }

      return (T) items;
    }

    throw new QueryParserException(
        UNABLE_TO_PARSE + value + "` to `" + klass.getSimpleName() + "`.");
  }

  /**
   * Try and parse `value` as Enum. Throws `QueryException` if invalid value.
   *
   * @param klass the Enum class.
   * @param value the enum value.
   */
  @SuppressWarnings({"unchecked", "rawtypes"})
  public static <T> T getEnumValue(Class<?> klass, String value) {
    Optional<? extends Enum<?>> enumValue =
        Enums.getIfPresent((Class<? extends Enum>) klass, value).toJavaUtil();

    if (enumValue.isPresent()) {
      return (T) enumValue.get();
    }
    Object[] possibleValues = klass.getEnumConstants();
    throw new QueryParserException(
        UNABLE_TO_PARSE
            + value
            + "` as `"
            + klass
            + "`, available values are: "
            + Arrays.toString(possibleValues));
  }

  public static Object parseValue(String value) {
    if (value == null || StringUtils.isEmpty(value)) {
      return null;
    }
    if (NumberUtils.isCreatable(value)) {
      return value;
    }
    return "'" + value + "'";
  }

  /**
   * Convert a List of select fields into a string as in SQL select query.
   *
   * <p>If input is null, return "*" means the query will select all fields.
   *
   * @param fields list of fields in a select query.
   * @return a string which is concatenated of list fields, separate by comma.
   */
  public static String parseSelectFields(List<String> fields) {
    if (fields == null || fields.isEmpty()) {
      return " * ";
    }
    StringBuilder str = new StringBuilder(StringUtils.EMPTY);
    for (int i = 0; i < fields.size(); i++) {
      str.append(fields.get(i));
      if (i < fields.size() - 1) {
        str.append(",");
      }
    }
    return str.toString();
  }

  /**
   * Converts a String with JSON format [x,y,z] into an SQL query collection format (x,y,z).
   *
   * @param value a string contains a collection with JSON format [x,y,z].
   * @return a string contains a collection with SQL query format (x,y,z).
   */
  public static String convertCollectionValue(String value) {
    if (StringUtils.isEmpty(value)) {
      throw new QueryParserException("Value is null");
    }

    if (!value.startsWith("[") || !value.endsWith("]")) {
      throw new QueryParserException("Invalid query value");
    }

    String[] split = value.substring(1, value.length() - 1).split(",");
    List<String> items = Lists.newArrayList(split);
    StringBuilder str = new StringBuilder("(");

    for (int i = 0; i < items.size(); i++) {
      Object item = QueryUtils.parseValue(items.get(i));
      if (item != null) {
        str.append(item);
        if (i < items.size() - 1) {
          str.append(",");
        }
      }
    }

    str.append(")");

    return str.toString();
  }

  /**
   * Converts a filter operator into an SQL operator.
   *
   * <p>Example: {@code parseFilterOperator('eq', 5)} will return "=5".
   *
   * @param operator the filter operator.
   * @param value value of the current SQL query condition.
   * @return a string contains an SQL expression with operator and value.
   */
  public static String parseFilterOperator(String operator, String value) {

    if (StringUtils.isEmpty(operator)) {
      throw new QueryParserException("Filter Operator is null");
    }

    return switch (operator) {
      case "eq" -> "= " + QueryUtils.parseValue(value);
      case "ieq" -> " ilike '" + value + "'";
      case "!eq", "ne", "neq" -> "!= " + QueryUtils.parseValue(value);
      case "gt" -> "> " + QueryUtils.parseValue(value);
      case "lt" -> "< " + QueryUtils.parseValue(value);
      case "gte", "ge" -> ">= " + QueryUtils.parseValue(value);
      case "lte", "le" -> "<= " + QueryUtils.parseValue(value);
      case "like" -> "like '%" + value + "%'";
      case "!like" -> "not like '%" + value + "%'";
      case "^like" -> " like '" + value + "%'";
      case "!^like" -> " not like '" + value + "%'";
      case "$like" -> " like '%" + value + "'";
      case "!$like" -> " not like '%" + value + "'";
      case "ilike" -> " ilike '%" + value + "%'";
      case "!ilike" -> " not ilike '%" + value + "%'";
      case "^ilike" -> " ilike '" + value + "%'";
      case "!^ilike" -> " not ilike '" + value + "%'";
      case "$ilike" -> " ilike '%" + value + "'";
      case "!$ilike" -> " not ilike '%" + value + "'";
      case "in" -> "in " + QueryUtils.convertCollectionValue(value);
      case "!in" -> " not in " + QueryUtils.convertCollectionValue(value);
      case "null" -> "is null";
      case "!null" -> "is not null";
      default -> throw new QueryParserException("`" + operator + "` is not a valid operator.");
    };
  }

  /**
   * converts the specified orders to OrderParams, filtered by schema
   *
   * @param orders the orderCriterias to convert.
   * @param schema the schema to use to perform the conversion.
   * @return the converted order.
   */
  @Nonnull
  public static List<OrderParam> filteredBySchema(
      @Nullable Collection<OrderCriteria> orders, @Nonnull Schema schema) {
    if (orders == null) {
      return Collections.emptyList();
    }

    return orders.stream()
        .filter(orderCriteria -> isValid(orderCriteria, schema))
        .distinct()
        .map(OrderCriteria::toOrderParam)
        .toList();
  }

  private static boolean isValid(OrderCriteria orderCriteria, Schema schema) {
    Property property = schema.getProperty(orderCriteria.getField());
    return schema.hasProperty(orderCriteria.getField()) && validProperty(property);
  }

  /**
   * Converts the specified string orders (e.g. <code>name:asc</code>) to order objects.
   *
   * @param orders the order strings that should be converted.
   * @param schema the schema that should be used to perform the conversion.
   * @return the converted order.
   */
  @Nonnull
  public static List<Order> convertOrderStrings(
      @Nullable Collection<String> orders, @Nonnull Schema schema) {
    if (orders == null) {
      return Collections.emptyList();
    }

    final Map<String, Order> result = new LinkedHashMap<>();
    for (String o : orders) {
      String[] split = o.split(":");

      String direction = "asc";

      if (split.length < 1) {
        continue;
      }
      if (split.length == 2) {
        direction = split[1].toLowerCase();
      }

      String propertyName = split[0];
      Property property = schema.getProperty(propertyName);

      if (result.containsKey(propertyName)
          || !schema.hasProperty(propertyName)
          || !validProperty(property)
          || !validDirection(direction)) {
        continue;
      }

      result.put(propertyName, Order.from(direction, property));
    }

    return new ArrayList<>(result.values());
  }

  private static boolean validProperty(Property property) {
    return property.isSimple()
        || (property.getPropertyType() != null && property.getPropertyType().isSimple());
  }

  private static boolean validDirection(String direction) {
    return "asc".equals(direction)
        || "desc".equals(direction)
        || "iasc".equals(direction)
        || "idesc".equals(direction);
  }

  /**
   * Returns a single result from the given {@link TypedQuery}. Returns null if no objects could be
   * found (without throwing an exception).
   *
   * @param query the query.
   * @return an object.
   */
  public static <T> T getSingleResult(TypedQuery<T> query) {
    query.setMaxResults(1);

    List<T> list = query.getResultList();

    if (list == null || list.isEmpty()) {
      return null;
    }

    return list.get(0);
  }
}
