getdown/src/getdown/core/src/main/java/com/threerings/getdown/util/Config.java

   1 //
   2 // Getdown - application installer, patcher and launcher
   3 // Copyright (C) 2004-2018 Getdown authors
   4 // https://github.com/threerings/getdown/blob/master/LICENSE
   5
   6 package com.threerings.getdown.util;
   7
   8 import static java.nio.charset.StandardCharsets.UTF_8;
   9
  10 import java.io.BufferedReader;
  11 import java.io.File;
  12 import java.io.FileInputStream;
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.io.InputStreamReader;
  16 import java.io.Reader;
  17 import java.net.MalformedURLException;
  18 import java.net.URL;
  19 import java.nio.charset.StandardCharsets;
  20 import java.util.ArrayList;
  21 import java.util.Arrays;
  22 import java.util.HashMap;
  23 import java.util.List;
  24 import java.util.Locale;
  25 import java.util.Map;
  26
  27 import static com.threerings.getdown.Log.log;
  28
  29 /**
  30  * Handles parsing and runtime access for Getdown's config files (mainly {@code getdown.txt}).
  31  * These files contain zero or more mappings for a particular string key. Config values can be
  32  * fetched as single strings, lists of strings, or parsed into primitives or compound data types
  33  * like colors and rectangles.
  34  */
  35 public class Config
  36 {
  37     /** Empty configuration. */
  38     public static final Config EMPTY = new Config(new HashMap<String, Object>());
  39
  40     /** Options that control the {@link #parsePairs} function. */
  41     public static class ParseOpts {
  42         // these should be tweaked as desired by the caller
  43         public boolean biasToKey = false;
  44         public boolean strictComments = false;
  45
  46         // these are filled in by parseConfig
  47         public String osname = null;
  48         public String osarch = null;
  49     }
  50
  51     /**
  52      * Creates a parse configuration, filling in the platform filters (or not) depending on the
  53      * value of {@code checkPlatform}.
  54      */
  55     public static ParseOpts createOpts (boolean checkPlatform) {
  56         ParseOpts opts = new ParseOpts();
  57         if (checkPlatform) {
  58             opts.osname = StringUtil.deNull(System.getProperty("os.name")).toLowerCase(Locale.ROOT);
  59             opts.osarch = StringUtil.deNull(System.getProperty("os.arch")).toLowerCase(Locale.ROOT);
  60         }
  61         return opts;
  62     }
  63
  64     /**
  65      * Parses a configuration file containing key/value pairs. The file must be in the UTF-8
  66      * encoding.
  67      *
  68      * @param opts options that influence the parsing. See {@link #createOpts}.
  69      *
  70      * @return a list of <code>String[]</code> instances containing the key/value pairs in the
  71      * order they were parsed from the file.
  72      */
  73     public static List<String[]> parsePairs (File source, ParseOpts opts)
  74         throws IOException
  75     {
  76         // annoyingly FileReader does not allow encoding to be specified (uses platform default)
  77         try (FileInputStream fis = new FileInputStream(source);
  78              InputStreamReader input = new InputStreamReader(fis, StandardCharsets.UTF_8)) {
  79             return parsePairs(input, opts);
  80         }
  81     }
  82
  83     /**
  84      * See {@link #parsePairs(File,ParseOpts)}.
  85      */
  86     public static List<String[]> parsePairs (Reader source, ParseOpts opts) throws IOException
  87     {
  88         List<String[]> pairs = new ArrayList<>();
  89         for (String line : FileUtil.readLines(source)) {
  90             // nix comments
  91             int cidx = line.indexOf("#");
  92             if (opts.strictComments ? cidx == 0 : cidx != -1) {
  93                 line = line.substring(0, cidx);
  94             }
  95
  96             // trim whitespace and skip blank lines
  97             line = line.trim();
  98             if (StringUtil.isBlank(line)) {
  99                 continue;
 100             }
 101
 102             // parse our key/value pair
 103             String[] pair = new String[2];
 104             // if we're biasing toward key, put all the extra = in the key rather than the value
 105             int eidx = opts.biasToKey ? line.lastIndexOf("=") : line.indexOf("=");
 106             if (eidx != -1) {
 107                 pair[0] = line.substring(0, eidx).trim();
 108                 pair[1] = line.substring(eidx+1).trim();
 109             } else {
 110                 pair[0] = line;
 111                 pair[1] = "";
 112             }
 113
 114             // if the pair has an os qualifier, we need to process it
 115             if (pair[1].startsWith("[")) {
 116                 int qidx = pair[1].indexOf("]");
 117                 if (qidx == -1) {
 118                     log.warning("Bogus platform specifier", "key", pair[0], "value", pair[1]);
 119                     continue; // omit the pair entirely
 120                 }
 121                 // if we're checking qualifiers and the os doesn't match this qualifier, skip it
 122                 String quals = pair[1].substring(1, qidx);
 123                 if (opts.osname != null && !checkQualifiers(quals, opts.osname, opts.osarch)) {
 124                     log.debug("Skipping", "quals", quals,
 125                               "osname", opts.osname, "osarch", opts.osarch,
 126                               "key", pair[0], "value", pair[1]);
 127                     continue;
 128                 }
 129                 // otherwise filter out the qualifier text
 130                 pair[1] = pair[1].substring(qidx+1).trim();
 131             }
 132
 133             pairs.add(pair);
 134         }
 135
 136         return pairs;
 137     }
 138
 139     /**
 140      * Takes a comma-separated String of four integers and returns a rectangle using those ints as
 141      * the its x, y, width, and height.
 142      */
 143     public static Rectangle parseRect (String name, String value)
 144     {
 145         if (!StringUtil.isBlank(value)) {
 146             int[] v = StringUtil.parseIntArray(value);
 147             if (v != null && v.length == 4) {
 148                 return new Rectangle(v[0], v[1], v[2], v[3]);
 149             }
 150             log.warning("Ignoring invalid rect '" + name + "' config '" + value + "'.");
 151         }
 152         return null;
 153     }
 154
 155     /**
 156      * Parses the given hex color value (e.g. FFCC99) and returns an {@code Integer} with that
 157      * value. If the given value is null or not a valid hexadecimal number, this will return null.
 158      */
 159     public static Integer parseColor (String hexValue)
 160     {
 161         if (!StringUtil.isBlank(hexValue)) {
 162             try {
 163                 // if no alpha channel is specified, use 255 (full alpha)
 164                 int alpha = hexValue.length() > 6 ? 0 : 0xFF000000;
 165                 return Integer.parseInt(hexValue, 16) | alpha;
 166             } catch (NumberFormatException e) {
 167                 log.warning("Ignoring invalid color", "hexValue", hexValue, "exception", e);
 168             }
 169         }
 170         return null;
 171     }
 172
 173     /**
 174      * Parses a configuration file containing key/value pairs. The file must be in the UTF-8
 175      * encoding.
 176      *
 177      * @return a map from keys to values, where a value will be an array of strings if more than
 178      * one key/value pair in the config file was associated with the same key.
 179      */
 180     public static Config parseConfig (File source, ParseOpts opts)
 181             throws IOException
 182         {
 183             Map<String, Object> data = new HashMap<>();
 184
 185             // I thought that we could use HashMap<String, String[]> and put new String[] {pair[1]} for
 186             // the null case, but it mysteriously dies on launch, so leaving it as HashMap<String,
 187             // Object> for now
 188             for (String[] pair : parsePairs(source, opts)) {
 189                 Object value = data.get(pair[0]);
 190                 if (value == null) {
 191                     data.put(pair[0], pair[1]);
 192                 } else if (value instanceof String) {
 193                     data.put(pair[0], new String[] { (String)value, pair[1] });
 194                 } else if (value instanceof String[]) {
 195                     String[] values = (String[])value;
 196                     String[] nvalues = new String[values.length+1];
 197                     System.arraycopy(values, 0, nvalues, 0, values.length);
 198                     nvalues[values.length] = pair[1];
 199                     data.put(pair[0], nvalues);
 200                 }
 201             }
 202
 203             // special magic for the getdown.txt config: if the parsed data contains 'strict_comments =
 204             // true' then we reparse the file with strict comments (i.e. # is only assumed to start a
 205             // comment in column 0)
 206             if (!opts.strictComments && Boolean.parseBoolean((String)data.get("strict_comments"))) {
 207                 opts.strictComments = true;
 208                 return parseConfig(source, opts);
 209             }
 210
 211             return new Config(data);
 212         }
 213
 214     public static Config parseConfig (Reader source, ParseOpts opts)
 215             throws IOException
 216         {
 217             Map<String, Object> data = new HashMap<>();
 218
 219             // I thought that we could use HashMap<String, String[]> and put new String[] {pair[1]} for
 220             // the null case, but it mysteriously dies on launch, so leaving it as HashMap<String,
 221             // Object> for now
 222             for (String[] pair : parsePairs(source, opts)) {
 223                 Object value = data.get(pair[0]);
 224                 if (value == null) {
 225                     data.put(pair[0], pair[1]);
 226                 } else if (value instanceof String) {
 227                     data.put(pair[0], new String[] { (String)value, pair[1] });
 228                 } else if (value instanceof String[]) {
 229                     String[] values = (String[])value;
 230                     String[] nvalues = new String[values.length+1];
 231                     System.arraycopy(values, 0, nvalues, 0, values.length);
 232                     nvalues[values.length] = pair[1];
 233                     data.put(pair[0], nvalues);
 234                 }
 235             }
 236
 237             // special magic for the getdown.txt config: if the parsed data contains 'strict_comments =
 238             // true' then we reparse the file with strict comments (i.e. # is only assumed to start a
 239             // comment in column 0)
 240             if (!opts.strictComments && Boolean.parseBoolean((String)data.get("strict_comments"))) {
 241                 opts.strictComments = true;
 242                 source.reset();
 243                 return parseConfig(source, opts);
 244             }
 245
 246             return new Config(data);
 247         }
 248
 249     public Config (Map<String,  Object> data) {
 250         _data = data;
 251     }
 252
 253     /**
 254      * Returns whether {@code name} has a value in this config.
 255      */
 256     public boolean hasValue (String name) {
 257         return _data.containsKey(name);
 258     }
 259
 260     /**
 261      * Returns the raw-value for {@code name}. This may be a {@code String}, {@code String[]}, or
 262      * {@code null}.
 263      */
 264     public Object getRaw (String name) {
 265         return _data.get(name);
 266     }
 267
 268     /**
 269      * Returns the specified config value as a string, or {@code null}.
 270      */
 271     public String getString (String name) {
 272         return (String)_data.get(name);
 273     }
 274
 275     /**
 276      * Returns the specified config value as a string, or {@code def}.
 277      */
 278     public String getString (String name, String def) {
 279         String value = (String)_data.get(name);
 280         return value == null ? def : value;
 281     }
 282
 283     /**
 284      * Returns the specified config value as a boolean.
 285      */
 286     public boolean getBoolean (String name) {
 287         return Boolean.parseBoolean(getString(name));
 288     }
 289
 290     /**
 291      * Massages a single string into an array and leaves existing array values as is. Simplifies
 292      * access to parameters that are expected to be arrays.
 293      */
 294     public String[] getMultiValue (String name)
 295     {
 296         Object value = _data.get(name);
 297         if (value == null) {
 298           return new String[] {};
 299         }
 300         if (value instanceof String) {
 301             return new String[] { (String)value };
 302         } else {
 303             return (String[])value;
 304         }
 305     }
 306
 307     /** Used to parse rectangle specifications from the config file. */
 308     public Rectangle getRect (String name, Rectangle def)
 309     {
 310         String value = getString(name);
 311         Rectangle rect = parseRect(name, value);
 312         return (rect == null) ? def : rect;
 313     }
 314
 315     /**
 316      * Parses and returns the config value for {@code name} as an int. If no value is provided,
 317      * {@code def} is returned. If the value is invalid, a warning is logged and {@code def} is
 318      * returned.
 319      */
 320     public int getInt (String name, int def) {
 321         String value = getString(name);
 322         try {
 323             return value == null ? def : Integer.parseInt(value);
 324         } catch (Exception e) {
 325             log.warning("Ignoring invalid int '" + name + "' config '" + value + "',");
 326             return def;
 327         }
 328     }
 329
 330     /**
 331      * Parses and returns the config value for {@code name} as a long. If no value is provided,
 332      * {@code def} is returned. If the value is invalid, a warning is logged and {@code def} is
 333      * returned.
 334      */
 335     public long getLong (String name, long def) {
 336         String value = getString(name);
 337         try {
 338             return value == null ? def : Long.parseLong(value);
 339         } catch (Exception e) {
 340             log.warning("Ignoring invalid long '" + name + "' config '" + value + "',");
 341             return def;
 342         }
 343     }
 344
 345     /** Used to parse color specifications from the config file. */
 346     public int getColor (String name, int def)
 347     {
 348         String value = getString(name);
 349         Integer color = parseColor(value);
 350         return (color == null) ? def : color;
 351     }
 352
 353     /** Parses a list of strings from the config file. */
 354     public String[] getList (String name)
 355     {
 356         String value = getString(name);
 357         return (value == null) ? new String[0] : StringUtil.parseStringArray(value);
 358     }
 359
 360     /**
 361      * Parses a URL from the config file, checking first for a localized version.
 362      */
 363     public String getUrl (String name, String def)
 364     {
 365         String value = getString(name + "." + Locale.getDefault().getLanguage());
 366         if (StringUtil.isBlank(value)) {
 367             value = getString(name);
 368         }
 369         if (StringUtil.isBlank(value)) {
 370             value = def;
 371         }
 372         if (!StringUtil.isBlank(value)) {
 373             try {
 374                 HostWhitelist.verify(new URL(value));
 375             } catch (MalformedURLException e) {
 376                 log.warning("Invalid URL.", "url", value, e);
 377                 value = null;
 378             }
 379         }
 380         return value;
 381     }
 382
 383     /**
 384      * A helper function for {@link #parsePairs(Reader,ParseOpts)}. Qualifiers have the following
 385      * form:
 386      * <pre>
 387      * id = os[-arch]
 388      * ids = id | id,ids
 389      * quals = !id | ids
 390      * </pre>
 391      * Examples: [linux-amd64,linux-x86_64], [windows], [mac os x], [!windows]. Negative qualifiers
 392      * must appear alone, they cannot be used with other qualifiers (positive or negative).
 393      */
 394     protected static boolean checkQualifiers (String quals, String osname, String osarch)
 395     {
 396         if (quals.startsWith("!")) {
 397             if (quals.indexOf(",") != -1) { // sanity check
 398                 log.warning("Multiple qualifiers cannot be used when one of the qualifiers " +
 399                             "is negative", "quals", quals);
 400                 return false;
 401             }
 402             return !checkQualifier(quals.substring(1), osname, osarch);
 403         }
 404         for (String qual : quals.split(",")) {
 405             if (checkQualifier(qual, osname, osarch)) {
 406                 return true; // if we have a positive match, we can immediately return true
 407             }
 408         }
 409         return false; // we had no positive matches, so return false
 410     }
 411
 412     /** A helper function for {@link #checkQualifiers}. */
 413     protected static boolean checkQualifier (String qual, String osname, String osarch)
 414     {
 415         String[] bits = qual.trim().toLowerCase(Locale.ROOT).split("-");
 416         String os = bits[0], arch = (bits.length > 1) ? bits[1] : "";
 417         return (osname.indexOf(os) != -1) && (osarch.indexOf(arch) != -1);
 418     }
 419
 420     public void mergeConfig(Config newValues, boolean merge) {
 421
 422       for (Map.Entry<String, Object> entry : newValues.getData().entrySet()) {
 423
 424         String key = entry.getKey();
 425         Object nvalue = entry.getValue();
 426
 427         String mkey = key.indexOf('.') > -1 ? key.substring(key.indexOf('.') + 1) : key;
 428         if (merge && allowedMergeKeys.contains(mkey)) {
 429
 430           // merge multi values
 431
 432           Object value = _data.get(key);
 433
 434           if (value == null) {
 435             _data.put(key, nvalue);
 436           } else if (value instanceof String) {
 437             if (nvalue instanceof String) {
 438
 439               // value is String, nvalue is String
 440               _data.put(key, new String[] { (String)value, (String)nvalue });
 441
 442             } else if (nvalue instanceof String[]) {
 443
 444               // value is String, nvalue is String[]
 445               String[] nvalues = (String[])nvalue;
 446               String[] newvalues = new String[nvalues.length+1];
 447               newvalues[0] = (String)value;
 448               System.arraycopy(nvalues, 0, newvalues, 1, nvalues.length);
 449               _data.put(key, newvalues);
 450
 451             }
 452           } else if (value instanceof String[]) {
 453             if (nvalue instanceof String) {
 454
 455               // value is String[], nvalue is String
 456               String[] values = (String[])value;
 457               String[] newvalues = new String[values.length+1];
 458               System.arraycopy(values, 0, newvalues, 0, values.length);
 459               newvalues[values.length] = (String)nvalue;
 460               _data.put(key, newvalues);
 461
 462             } else if (nvalue instanceof String[]) {
 463
 464               // value is String[], nvalue is String[]
 465               String[] values = (String[])value;
 466               String[] nvalues = (String[])nvalue;
 467               String[] newvalues = new String[values.length + nvalues.length];
 468               System.arraycopy(values, 0, newvalues, 0, values.length);
 469               System.arraycopy(nvalues, 0, newvalues, values.length, newvalues.length);
 470               _data.put(key, newvalues);
 471
 472             }
 473           }
 474
 475         } else if (allowedReplaceKeys.contains(mkey)){
 476
 477           // replace value
 478           _data.put(key, nvalue);
 479
 480         } else {
 481           log.warning("Not merging key '"+key+"' into config");
 482         }
 483
 484       }
 485
 486     }
 487
 488     public String toString() {
 489       StringBuilder sb = new StringBuilder();
 490       for (Map.Entry<String, Object> entry : getData().entrySet()) {
 491         String key = entry.getKey();
 492         Object val = entry.getValue();
 493         sb.append(key);
 494         sb.append("=");
 495         if (val instanceof String) {
 496           sb.append((String)val);
 497         } else if (val instanceof String[]) {
 498           sb.append(Arrays.toString((String[])val));
 499         } else {
 500           sb.append("Value not String or String[]");
 501         }
 502         sb.append("\n");
 503       }
 504       return sb.toString();
 505     }
 506
 507     public Map<String, Object> getData() {
 508       return _data;
 509     }
 510
 511     private final Map<String, Object> _data;
 512
 513     public static final List<String> allowedReplaceKeys = Arrays.asList("appbase","apparg","jvmarg","jvmmempc","jvmmemmax"); // these are the ones we might use
 514     public static final List<String> allowedMergeKeys = Arrays.asList("apparg","jvmarg"); // these are the ones we might use
 515     //private final List<String> allowedMergeKeys = Arrays.asList("apparg","jvmarg","resource","code","java_location"); // (not exhaustive list here)
 516 }