All Downloads are FREE. Search and download functionalities are using the official Maven repository.

play.utils.OrderSafeProperties Maven / Gradle / Ivy

Go to download

RePlay is a fork of the Play1 framework, created by Codeborne.

There is a newer version: 2.6.2
Show newest version
package play.utils;

import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.stream.Collectors.joining;
import static org.apache.commons.io.IOUtils.readLines;
import static org.apache.commons.text.StringEscapeUtils.escapeJava;

import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.util.Collections;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import javax.annotation.Nonnull;

/**
 * Custom impl of java.util.properties that preserves the key-order from the file and that reads the
 * properties-file in utf-8
 */
public class OrderSafeProperties extends java.util.Properties {

  private static final Pattern ESCAPED_DOUBLE_QUOTE = Pattern.compile("\\\\\"");
  private static final Pattern ESCAPED_SINGLE_QUOTE = Pattern.compile("(^|[^\\\\])(\\\\')");
  private static final Pattern BACKSLASH = Pattern.compile("\\\\\\\\");

  // set used to preserve key order
  private final LinkedHashSet keys = new LinkedHashSet<>();

  /**
   * escapes "special-chars" (to utf-16 on the format \\uxxxx) in lines and store as iso-8859-1. see
   * info about escaping: - ... -
   * "public void load(InputStream inStream)"
   */
  @Override
  public void load(InputStream inputStream) throws IOException {
    String propertiesAsIso8859 =
        readLines(inputStream, UTF_8)
            .stream()
            .map(line -> removeEscapedBackslashes(escapeJava(unescapeQuotes(line))))
            .collect(joining("\n"));
    super.load(new StringReader(propertiesAsIso8859));
  }

  /**
   * There is a rule: "...by the rule above, single and double quote characters preceded by a
   * backslash still yield single and double quote characters, respectively."
   *
   * 
According to this rule, we must transform \" => " and \' => ' before escaping to prevent
   * escaping the backslash
   */
  static String unescapeQuotes(String line) {
    return ESCAPED_SINGLE_QUOTE
        .matcher(ESCAPED_DOUBLE_QUOTE.matcher(line).replaceAll("\""))
        .replaceAll("$1'");
  }

  static String removeEscapedBackslashes(String line) {
    return BACKSLASH.matcher(line).replaceAll("\\\\");
  }

  @Override
  public Enumeration keys() {
    return Collections.enumeration(keys);
  }

  @Override
  @Nonnull
  public Set keySet() {
    return keys;
  }

  @Override
  public Object put(Object key, Object value) {
    keys.add(key);
    return super.put(key, value);
  }

  @Override
  public Object remove(Object o) {
    keys.remove(o);
    return super.remove(o);
  }

  @Override
  public void clear() {
    keys.clear();
    super.clear();
  }

  @Override
  public void putAll(Map map) {
    keys.addAll(map.keySet());
    super.putAll(map);
  }

  @Override
  @Nonnull
  public Set> entrySet() {
    Set> entrySet = new LinkedHashSet<>(keys.size());
    for (Object key : keys) {
      entrySet.add(Map.entry(key, get(key)));
    }

    return entrySet;
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy