src/tim/prune/config/Config.java

   1 package tim.prune.config;
   2
   3 import java.io.File;
   4 import java.io.FileInputStream;
   5 import java.util.Properties;
   6
   7 import tim.prune.data.RecentFileList;
   8 import tim.prune.data.UnitSet;
   9 import tim.prune.data.UnitSetLibrary;
  10 import tim.prune.gui.colour.ColourerFactory;
  11 import tim.prune.gui.colour.PointColourer;
  12 import tim.prune.gui.map.MapSourceLibrary;
  13
  14
  15 /**
  16  * Abstract class to hold application-wide configuration
  17  */
  18 public abstract class Config
  19 {
  20         /** File from which Config was loaded */
  21         private static File _configFile = null;
  22
  23         /** Hashtable containing all config values */
  24         private static Properties _configValues = null;
  25         /** Colour scheme object is also part of config */
  26         private static ColourScheme _colourScheme = new ColourScheme();
  27         /** Point colourer object, if any */
  28         private static PointColourer _pointColourer = null;
  29         /** Recently-used file list */
  30         private static RecentFileList _recentFiles = new RecentFileList();
  31         /** Current unit set */
  32         private static UnitSet _unitSet = UnitSetLibrary.getUnitSet(null);
  33
  34         /** Default config file */
  35         public static final File DEFAULT_CONFIG_FILE = new File(".pruneconfig");
  36         public static final File HOME_CONFIG_FILE = new File(System.getProperty("user.home"), ".pruneconfig");
  37
  38         /** Key for track directory */
  39         public static final String KEY_TRACK_DIR = "prune.trackdirectory";
  40         /** Key for photo directory */
  41         public static final String KEY_PHOTO_DIR = "prune.photodirectory";
  42         /** Key for language code */
  43         public static final String KEY_LANGUAGE_CODE = "prune.languagecode";
  44         /** Key for language file */
  45         public static final String KEY_LANGUAGE_FILE = "prune.languagefile";
  46         /** Key for GPS device */
  47         public static final String KEY_GPS_DEVICE = "prune.gpsdevice";
  48         /** Key for GPS format */
  49         public static final String KEY_GPS_FORMAT = "prune.gpsformat";
  50         /** Key for GPSBabel filter string */
  51         public static final String KEY_GPSBABEL_FILTER = "prune.gpsbabelfilter";
  52         /** Key for GPSBabel import file format */
  53         public static final String KEY_IMPORT_FILE_FORMAT = "prune.lastimportfileformat";
  54         /** Key for Povray font */
  55         public static final String KEY_POVRAY_FONT = "prune.povrayfont";
  56         /** Key for the selected unit set */
  57         public static final String KEY_UNITSET_KEY  = "prune.unitsetkey";
  58         /** Key for the selected coordinate display format */
  59         public static final String KEY_COORD_DISPLAY_FORMAT  = "prune.coorddisplay";
  60         /** Key for index of map source */
  61         public static final String KEY_MAPSOURCE_INDEX = "prune.mapsource";
  62         /** Key for number of fixed map sources */
  63         public static final String KEY_NUM_FIXED_MAPS = "prune.numfixedmapsources";
  64         /** Key for String containing custom map sources */
  65         public static final String KEY_MAPSOURCE_LIST = "prune.mapsourcelist";
  66         /** Key for show map flag */
  67         public static final String KEY_SHOW_MAP = "prune.showmap";
  68         /** Key for window position */
  69         public static final String KEY_WINDOW_BOUNDS = "prune.windowbounds";
  70         /** Key for path to disk cache */
  71         public static final String KEY_DISK_CACHE = "prune.diskcache";
  72         /** Key for working online flag */
  73         public static final String KEY_ONLINE_MODE = "prune.onlinemode";
  74         /** Key for width of thumbnails in kmz */
  75         public static final String KEY_KMZ_IMAGE_SIZE = "prune.kmzimagewidth";
  76         /** Key for gpsbabel path */
  77         public static final String KEY_GPSBABEL_PATH = "prune.gpsbabelpath";
  78         /** Key for gnuplot path */
  79         public static final String KEY_GNUPLOT_PATH = "prune.gnuplotpath";
  80         /** Key for exiftool path */
  81         public static final String KEY_EXIFTOOL_PATH = "prune.exiftoolpath";
  82         /** Key for colour scheme */
  83         public static final String KEY_COLOUR_SCHEME = "prune.colourscheme";
  84         /** Key for point colourer */
  85         public static final String KEY_POINT_COLOURER = "prune.pointcolourer";
  86         /** Key for line width used for drawing */
  87         public static final String KEY_LINE_WIDTH = "prune.linewidth";
  88         /** Key for whether to use antialiasing or not */
  89         public static final String KEY_ANTIALIAS = "prune.antialias";
  90         /** Key for kml track colour */
  91         public static final String KEY_KML_TRACK_COLOUR = "prune.kmltrackcolour";
  92         /** Key for window style (name of look-and-feel) */
  93         public static final String KEY_WINDOW_STYLE = "prune.windowstyle";
  94         /** Key for autosaving settings */
  95         public static final String KEY_AUTOSAVE_SETTINGS = "prune.autosavesettings";
  96         /** Key for recently used files */
  97         public static final String KEY_RECENT_FILES = "prune.recentfiles";
  98         /** Key for estimation parameters */
  99         public static final String KEY_ESTIMATION_PARAMS = "prune.estimationparams";
 100         /** Key for 3D exaggeration factor */
 101         public static final String KEY_HEIGHT_EXAGGERATION = "prune.heightexaggeration";
 102         /** Key for terrain grid size */
 103         public static final String KEY_TERRAIN_GRID_SIZE = "prune.terraingridsize";
 104         /** Key for altitude tolerance */
 105         public static final String KEY_ALTITUDE_TOLERANCE = "prune.altitudetolerance";
 106         /** Key for waypoint icons to use */
 107         public static final String KEY_WAYPOINT_ICONS = "prune.waypointicons";
 108         /** Size of waypoint icons to use */
 109         public static final String KEY_WAYPOINT_ICON_SIZE = "prune.waypointiconsize";
 110         /** Id of selected timezone */
 111         public static final String KEY_TIMEZONE_ID = "prune.timezoneid";
 112         /** Last used latlon range */
 113         public static final String KEY_LATLON_RANGE = "prune.latlonrange";
 114         /** Username/password to the Earthdata server for SRTM 1-arcsecond tiles */
 115         public static final String KEY_EARTHDATA_AUTH = "prune.earthdataauth";
 116
 117         /** Initialise the default properties */
 118         static
 119         {
 120                 _configValues = getDefaultProperties();
 121         }
 122
 123         /**
 124          * Load the default configuration file
 125          */
 126         public static void loadDefaultFile()
 127         {
 128                 if (DEFAULT_CONFIG_FILE.exists())
 129                 {
 130                         try {
 131                                 loadFile(DEFAULT_CONFIG_FILE);
 132                                 return;
 133                         }
 134                         catch (ConfigException ce) {} // ignore
 135                 }
 136                 if (HOME_CONFIG_FILE.exists())
 137                 {
 138                         try {
 139                                 loadFile(HOME_CONFIG_FILE);
 140                         }
 141                         catch (ConfigException ce) {} // ignore
 142                 }
 143         }
 144
 145
 146         /**
 147          * Load configuration from file
 148          * @param inFile file to load
 149          * @throws ConfigException if specified file couldn't be read
 150          */
 151         public static void loadFile(File inFile) throws ConfigException
 152         {
 153                 // Start with default properties
 154                 Properties props = getDefaultProperties();
 155                 // Try to load the file into a properties object
 156                 boolean loadFailed = false;
 157                 FileInputStream fis = null;
 158                 try
 159                 {
 160                         fis = new FileInputStream(inFile);
 161                         props.load(fis);
 162                 }
 163                 catch (Exception e) {
 164                         loadFailed = true;
 165                 }
 166                 finally {
 167                         if (fis != null) try {
 168                                 fis.close();
 169                         }
 170                         catch (Exception e) {}
 171                 }
 172                 // Save all properties from file
 173                 _configValues.putAll(props);
 174                 _colourScheme.loadFromHex(_configValues.getProperty(KEY_COLOUR_SCHEME));
 175                 _pointColourer = ColourerFactory.createColourer(_configValues.getProperty(KEY_POINT_COLOURER));
 176                 _recentFiles = new RecentFileList(_configValues.getProperty(KEY_RECENT_FILES));
 177                 _unitSet = UnitSetLibrary.getUnitSet(_configValues.getProperty(KEY_UNITSET_KEY));
 178                 // Adjust map source index if necessary
 179                 adjustSelectedMap();
 180                 // Reset coord display format
 181                 setConfigInt(KEY_COORD_DISPLAY_FORMAT, 0);
 182
 183                 if (loadFailed) {
 184                         throw new ConfigException();
 185                 }
 186                 // Store location of successfully loaded config file
 187                 _configFile = inFile;
 188         }
 189
 190         /**
 191          * @return Properties object containing default values
 192          */
 193         private static Properties getDefaultProperties()
 194         {
 195                 Properties props = new Properties();
 196                 // Fill in defaults
 197                 props.put(KEY_GPS_DEVICE, "usb:");
 198                 props.put(KEY_GPS_FORMAT, "garmin");
 199                 props.put(KEY_POVRAY_FONT, "crystal.ttf"); // alternative: DejaVuSans-Bold.ttf
 200                 props.put(KEY_SHOW_MAP, "1"); // show by default
 201                 props.put(KEY_EXIFTOOL_PATH, "exiftool");
 202                 props.put(KEY_GNUPLOT_PATH, "gnuplot");
 203                 props.put(KEY_GPSBABEL_PATH, "gpsbabel");
 204                 props.put(KEY_IMPORT_FILE_FORMAT, "-1"); // no file format selected
 205                 props.put(KEY_KMZ_IMAGE_SIZE, "240");
 206                 props.put(KEY_ANTIALIAS, "1"); // antialias on by default
 207                 props.put(KEY_AUTOSAVE_SETTINGS, "1"); // autosave by default
 208                 props.put(KEY_UNITSET_KEY, "unitset.kilometres"); // metric by default
 209                 props.put(KEY_COORD_DISPLAY_FORMAT, "0"); // original
 210                 props.put(KEY_HEIGHT_EXAGGERATION, "100"); // 100%, no exaggeration
 211                 props.put(KEY_TERRAIN_GRID_SIZE, "50");
 212                 props.put(KEY_ALTITUDE_TOLERANCE, "0"); // 0, all exact as before
 213                 props.put(KEY_WAYPOINT_ICON_SIZE, "1"); // medium size
 214                 return props;
 215         }
 216
 217         /**
 218          * Adjust the index of the selected map
 219          * (only required if config was loaded from a previous version of GpsPrune)
 220          */
 221         private static void adjustSelectedMap()
 222         {
 223                 int sourceNum = getConfigInt(Config.KEY_MAPSOURCE_INDEX);
 224                 int prevNumFixed = getConfigInt(Config.KEY_NUM_FIXED_MAPS);
 225                 // Number of fixed maps not specified in version <=13, default to 6
 226                 if (prevNumFixed == 0) prevNumFixed = 6;
 227                 int currNumFixed = MapSourceLibrary.getNumFixedSources();
 228                 // Only need to do something if the number has changed
 229                 if (currNumFixed != prevNumFixed && (sourceNum >= prevNumFixed || sourceNum >= currNumFixed))
 230                 {
 231                         sourceNum += (currNumFixed - prevNumFixed);
 232                         setConfigInt(Config.KEY_MAPSOURCE_INDEX, sourceNum);
 233                 }
 234                 setConfigInt(Config.KEY_NUM_FIXED_MAPS, currNumFixed);
 235         }
 236
 237         /**
 238          * @param inString String to parse
 239          * @return int value of String, or 0 if unparseable
 240          */
 241         private static int parseInt(String inString)
 242         {
 243                 int val = 0;
 244                 try {
 245                         val = Integer.parseInt(inString);
 246                 }
 247                 catch (Exception e) {} // ignore, value stays zero
 248                 return val;
 249         }
 250
 251         /**
 252          * @return File from which config was loaded (or null)
 253          */
 254         public static File getConfigFile()
 255         {
 256                 return _configFile;
 257         }
 258
 259         /**
 260          * Set the file to which config was saved
 261          */
 262         public static void setConfigFile(File inFile)
 263         {
 264                 _configFile = inFile;
 265         }
 266
 267         /**
 268          * @return config Properties object to allow all config values to be saved
 269          */
 270         public static Properties getAllConfig()
 271         {
 272                 // Update recently-used files
 273                 _configValues.setProperty(KEY_RECENT_FILES, _recentFiles.getConfigString());
 274                 return _configValues;
 275         }
 276
 277         /**
 278          * @return the current colour scheme
 279          */
 280         public static ColourScheme getColourScheme()
 281         {
 282                 return _colourScheme;
 283         }
 284
 285         /**
 286          * @return the current point colourer, if any
 287          */
 288         public static PointColourer getPointColourer()
 289         {
 290                 return _pointColourer;
 291         }
 292
 293         /**
 294          * @return list of recently used files
 295          */
 296         public static RecentFileList getRecentFileList()
 297         {
 298                 return _recentFiles;
 299         }
 300
 301         /**
 302          * Store the given configuration setting
 303          * @param inKey key (from constants)
 304          * @param inValue value as string
 305          */
 306         public static void setConfigString(String inKey, String inValue)
 307         {
 308                 if (inValue == null || inValue.equals("")) {
 309                         _configValues.remove(inKey);
 310                 }
 311                 else {
 312                         _configValues.put(inKey, inValue);
 313                 }
 314         }
 315
 316         /**
 317          * Store the given configuration setting
 318          * @param inKey key (from constants)
 319          * @param inValue value as boolean
 320          */
 321         public static void setConfigBoolean(String inKey, boolean inValue)
 322         {
 323                 if (inKey != null && !inKey.equals(""))
 324                 {
 325                         _configValues.put(inKey, (inValue?"1":"0"));
 326                 }
 327         }
 328
 329         /**
 330          * Store the given configuration setting
 331          * @param inKey key (from constants)
 332          * @param inValue value as int
 333          */
 334         public static void setConfigInt(String inKey, int inValue)
 335         {
 336                 if (inKey != null && !inKey.equals(""))
 337                 {
 338                         _configValues.put(inKey, "" + inValue);
 339                 }
 340         }
 341
 342         /**
 343          * Get the given configuration setting as a String
 344          * @param inKey key
 345          * @return configuration setting as a String
 346          */
 347         public static String getConfigString(String inKey)
 348         {
 349                 return _configValues.getProperty(inKey);
 350         }
 351
 352         /**
 353          * Get the given configuration setting as a boolean
 354          * @param inKey key
 355          * @return configuration setting as a boolean (default to true)
 356          */
 357         public static boolean getConfigBoolean(String inKey)
 358         {
 359                 String val = _configValues.getProperty(inKey);
 360                 return (val == null || val.equals("1"));
 361         }
 362
 363         /**
 364          * Get the given configuration setting as an int
 365          * @param inKey key
 366          * @return configuration setting as an int
 367          */
 368         public static int getConfigInt(String inKey)
 369         {
 370                 return parseInt(_configValues.getProperty(inKey));
 371         }
 372
 373         /**
 374          * Check whether the given key corresponds to a boolean property
 375          * @param inKey key to check
 376          * @return true if corresponding property is boolean
 377          */
 378         public static boolean isKeyBoolean(String inKey)
 379         {
 380                 return inKey != null && (
 381                         inKey.equals(KEY_SHOW_MAP) || inKey.equals(KEY_AUTOSAVE_SETTINGS) || inKey.equals(KEY_ONLINE_MODE)
 382                         || inKey.equals(KEY_ANTIALIAS));
 383         }
 384
 385         /**
 386          * Update the colour scheme property from the current settings
 387          */
 388         public static void updateColourScheme()
 389         {
 390                 setConfigString(KEY_COLOUR_SCHEME, _colourScheme.toString());
 391         }
 392
 393         /**
 394          * Update the point colourer from the given colourer
 395          * @param inColourer point colourer object, or null
 396          */
 397         public static void updatePointColourer(PointColourer inColourer)
 398         {
 399                 _pointColourer = inColourer;
 400                 setConfigString(KEY_POINT_COLOURER, ColourerFactory.pointColourerToString(_pointColourer));
 401         }
 402
 403         /**
 404          * @return the current unit set
 405          */
 406         public static UnitSet getUnitSet() {
 407                 return _unitSet;
 408         }
 409
 410         /**
 411          * @param inIndex index of unit set to select
 412          */
 413         public static void selectUnitSet(int inIndex)
 414         {
 415                 _unitSet = UnitSetLibrary.getUnitSet(inIndex);
 416                 // Set name of set in config
 417                 setConfigString(KEY_UNITSET_KEY, _unitSet.getNameKey());
 418         }
 419 }