/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.hadoop.hbase.util;

import java.io.UnsupportedEncodingException;
import java.net.InetAddress;
import java.net.URI;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.apache.hadoop.conf.Configuration;
import org.apache.yetus.audience.InterfaceAudience;

import org.apache.hbase.thirdparty.com.google.common.base.Joiner;
import org.apache.hbase.thirdparty.com.google.common.base.Splitter;
import org.apache.hbase.thirdparty.com.google.common.net.InetAddresses;

/**
 * Utility for Strings.
 */
@InterfaceAudience.Private
public final class Strings {
  public static final String DEFAULT_SEPARATOR = "=";
  public static final String DEFAULT_KEYVALUE_SEPARATOR = ", ";

  public static final Joiner JOINER = Joiner.on(",");
  public static final Splitter SPLITTER = Splitter.on(",");

  private Strings() {
  }

  /**
   * Append to a StringBuilder a key/value. Uses default separators.
   * @param sb    StringBuilder to use
   * @param key   Key to append.
   * @param value Value to append.
   * @return Passed <code>sb</code> populated with key/value.
   */
  public static StringBuilder appendKeyValue(final StringBuilder sb, final String key,
    final Object value) {
    return appendKeyValue(sb, key, value, DEFAULT_SEPARATOR, DEFAULT_KEYVALUE_SEPARATOR);
  }

  /**
   * Append to a StringBuilder a key/value. Uses default separators.
   * @param sb                StringBuilder to use
   * @param key               Key to append.
   * @param value             Value to append.
   * @param separator         Value to use between key and value.
   * @param keyValueSeparator Value to use between key/value sets.
   * @return Passed <code>sb</code> populated with key/value.
   */
  public static StringBuilder appendKeyValue(final StringBuilder sb, final String key,
    final Object value, final String separator, final String keyValueSeparator) {
    if (sb.length() > 0) {
      sb.append(keyValueSeparator);
    }
    return sb.append(key).append(separator).append(value);
  }

  /**
   * Given a PTR string generated via reverse DNS lookup, return everything except the trailing
   * period. Example for host.example.com., return host.example.com
   * @param dnPtr a domain name pointer (PTR) string.
   * @return Sanitized hostname with last period stripped off.
   */
  public static String domainNamePointerToHostName(String dnPtr) {
    if (dnPtr == null) {
      return null;
    }

    return dnPtr.endsWith(".") ? dnPtr.substring(0, dnPtr.length() - 1) : dnPtr;
  }

  /**
   * Returns whether the given string is an IP address, including bracketed IPv6 URI form.
   * @param host hostname or IP
   * @return {@code true} if {@code host} is an IP address
   * @throws NullPointerException if {@code host} is {@code null}
   */
  public static boolean isInetAddress(String host) {
    Objects.requireNonNull(host, "Hostname or IP cannot be null");
    host = host.trim();
    if (host.startsWith("[") && host.endsWith("]")) {
      return InetAddresses.isUriInetAddress(host);
    }
    return InetAddresses.isInetAddress(host);
  }

  private static InetAddress parseInetAddress(String host) {
    host = host.trim();
    if (host.startsWith("[") && host.endsWith("]")) {
      return InetAddresses.forUriString(host);
    }
    return InetAddresses.forString(host);
  }

  /**
   * Compare two host identifiers for equality. DNS hostnames are compared case-insensitively
   * because DNS labels are case-insensitive. IP address literals are compared by numeric address.
   * @param left  first hostname or IP
   * @param right second hostname or IP
   * @return {@code true} if both refer to the same host identifier
   * @throws NullPointerException if either argument is {@code null}
   */
  public static boolean hostnamesEqual(String left, String right) {
    Objects.requireNonNull(left, "Hostname or IP cannot be null");
    Objects.requireNonNull(right, "Hostname or IP cannot be null");
    boolean leftIsIp = isInetAddress(left);
    boolean rightIsIp = isInetAddress(right);
    if (leftIsIp != rightIsIp) {
      return false;
    }
    if (leftIsIp) {
      return parseInetAddress(left).equals(parseInetAddress(right));
    }
    return left.equalsIgnoreCase(right);
  }

  /**
   * Push the input string to the right by appending a character before it, usually a space.
   * @param input   the string to pad
   * @param padding the character to repeat to the left of the input string
   * @param length  the desired total length including the padding
   * @return padding characters + input
   */
  public static String padFront(String input, char padding, int length) {
    if (input.length() > length) {
      throw new IllegalArgumentException("input \"" + input + "\" longer than maxLength=" + length);
    }
    int numPaddingCharacters = length - input.length();
    return StringUtils.repeat(padding, numPaddingCharacters) + input;
  }

  /**
   * Parse the query string of an URI to a key value map. If a single key occurred multiple times,
   * only the first one will take effect.
   */
  public static Map<String, String> parseURIQueries(URI uri) {
    if (StringUtils.isBlank(uri.getRawQuery())) {
      return Collections.emptyMap();
    }
    return Splitter.on('&').trimResults().splitToStream(uri.getRawQuery()).map(kv -> {
      int idx = kv.indexOf('=');
      try {
        if (idx > 0) {
          return Pair.newPair(
            URLDecoder.decode(kv.substring(0, idx), StandardCharsets.UTF_8.name()),
            URLDecoder.decode(kv.substring(idx + 1), StandardCharsets.UTF_8.name()));
        } else {
          return Pair.newPair(URLDecoder.decode(kv, StandardCharsets.UTF_8.name()), "");
        }
      } catch (UnsupportedEncodingException e) {
        // should not happen
        throw new AssertionError(e);
      }
    }).collect(Collectors.toMap(Pair::getFirst, Pair::getSecond, (v1, v2) -> v1));
  }

  /**
   * Apply the key value pairs in the query string of the given URI to the given Configuration. If a
   * single key occurred multiple times, only the first one will take effect.
   */
  public static void applyURIQueriesToConf(URI uri, Configuration conf) {
    parseURIQueries(uri).forEach(conf::set);
  }

  /**
   * Note: This method was taken from org.apache.hadoop.util.StringUtils.humanReadableInt(long).
   * Reason: that method got deprecated and this method provides an easy-to-understand usage of
   * StringUtils.TraditionalBinaryPrefix.long2String. Given an integer, return a string that is in
   * an approximate, but human readable format.
   * @param number the number to format
   * @return a human readable form of the integer
   */
  public static String humanReadableInt(long number) {
    return org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix.long2String(number, "", 1);
  }
}