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
 115
 116         /** Initialise the default properties */
 117         static
 118         {
 119                 _configValues = getDefaultProperties();
 120         }
 121
 122         /**
 123          * Load the default configuration file
 124          */
 125         public static void loadDefaultFile()
 126         {
 127                 if (DEFAULT_CONFIG_FILE.exists())
 128                 {
 129                         try {
 130                                 loadFile(DEFAULT_CONFIG_FILE);
 131                                 return;
 132                         }
 133                         catch (ConfigException ce) {} // ignore
 134                 }
 135                 if (HOME_CONFIG_FILE.exists())
 136                 {
 137                         try {
 138                                 loadFile(HOME_CONFIG_FILE);
 139                         }
 140                         catch (ConfigException ce) {} // ignore
 141                 }
 142         }
 143
 144
 145         /**
 146          * Load configuration from file
 147          * @param inFile file to load
 148          * @throws ConfigException if specified file couldn't be read
 149          */
 150         public static void loadFile(File inFile) throws ConfigException
 151         {
 152                 // Start with default properties
 153                 Properties props = getDefaultProperties();
 154                 // Try to load the file into a properties object
 155                 boolean loadFailed = false;
 156                 FileInputStream fis = null;
 157                 try
 158                 {
 159                         fis = new FileInputStream(inFile);
 160                         props.load(fis);
 161                 }
 162                 catch (Exception e) {
 163                         loadFailed = true;
 164                 }
 165                 finally {
 166                         if (fis != null) try {
 167                                 fis.close();
 168                         }
 169                         catch (Exception e) {}
 170                 }
 171                 // Save all properties from file
 172                 _configValues.putAll(props);
 173                 _colourScheme.loadFromHex(_configValues.getProperty(KEY_COLOUR_SCHEME));
 174                 _pointColourer = ColourerFactory.createColourer(_configValues.getProperty(KEY_POINT_COLOURER));
 175                 _recentFiles = new RecentFileList(_configValues.getProperty(KEY_RECENT_FILES));
 176                 _unitSet = UnitSetLibrary.getUnitSet(_configValues.getProperty(KEY_UNITSET_KEY));
 177                 // Adjust map source index if necessary
 178                 adjustSelectedMap();
 179                 // Reset coord display format
 180                 setConfigInt(KEY_COORD_DISPLAY_FORMAT, 0);
 181
 182                 if (loadFailed) {
 183                         throw new ConfigException();
 184                 }
 185                 // Store location of successfully loaded config file
 186                 _configFile = inFile;
 187         }
 188
 189         /**
 190          * @return Properties object containing default values
 191          */
 192         private static Properties getDefaultProperties()
 193         {
 194                 Properties props = new Properties();
 195                 // Fill in defaults
 196                 props.put(KEY_GPS_DEVICE, "usb:");
 197                 props.put(KEY_GPS_FORMAT, "garmin");
 198                 props.put(KEY_POVRAY_FONT, "crystal.ttf"); // alternative: DejaVuSans-Bold.ttf
 199                 props.put(KEY_SHOW_MAP, "1"); // show by default
 200                 props.put(KEY_EXIFTOOL_PATH, "exiftool");
 201                 props.put(KEY_GNUPLOT_PATH, "gnuplot");
 202                 props.put(KEY_GPSBABEL_PATH, "gpsbabel");
 203                 props.put(KEY_IMPORT_FILE_FORMAT, "-1"); // no file format selected
 204                 props.put(KEY_KMZ_IMAGE_SIZE, "240");
 205                 props.put(KEY_ANTIALIAS, "1"); // antialias on by default
 206                 props.put(KEY_AUTOSAVE_SETTINGS, "1"); // autosave by default
 207                 props.put(KEY_UNITSET_KEY, "unitset.kilometres"); // metric by default
 208                 props.put(KEY_COORD_DISPLAY_FORMAT, "0"); // original
 209                 props.put(KEY_HEIGHT_EXAGGERATION, "100"); // 100%, no exaggeration
 210                 props.put(KEY_TERRAIN_GRID_SIZE, "50");
 211                 props.put(KEY_ALTITUDE_TOLERANCE, "0"); // 0, all exact as before
 212                 props.put(KEY_WAYPOINT_ICON_SIZE, "1"); // medium size
 213                 return props;
 214         }
 215
 216         /**
 217          * Adjust the index of the selected map
 218          * (only required if config was loaded from a previous version of GpsPrune)
 219          */
 220         private static void adjustSelectedMap()
 221         {
 222                 int sourceNum = getConfigInt(Config.KEY_MAPSOURCE_INDEX);
 223                 int prevNumFixed = getConfigInt(Config.KEY_NUM_FIXED_MAPS);
 224                 // Number of fixed maps not specified in version <=13, default to 6
 225                 if (prevNumFixed == 0) prevNumFixed = 6;
 226                 int currNumFixed = MapSourceLibrary.getNumFixedSources();
 227                 // Only need to do something if the number has changed
 228                 if (currNumFixed != prevNumFixed && (sourceNum >= prevNumFixed || sourceNum >= currNumFixed))
 229                 {
 230                         sourceNum += (currNumFixed - prevNumFixed);
 231                         setConfigInt(Config.KEY_MAPSOURCE_INDEX, sourceNum);
 232                 }
 233                 setConfigInt(Config.KEY_NUM_FIXED_MAPS, currNumFixed);
 234         }
 235
 236         /**
 237          * @param inString String to parse
 238          * @return int value of String, or 0 if unparseable
 239          */
 240         private static int parseInt(String inString)
 241         {
 242                 int val = 0;
 243                 try {
 244                         val = Integer.parseInt(inString);
 245                 }
 246                 catch (Exception e) {} // ignore, value stays zero
 247                 return val;
 248         }
 249
 250         /**
 251          * @return File from which config was loaded (or null)
 252          */
 253         public static File getConfigFile()
 254         {
 255                 return _configFile;
 256         }
 257
 258         /**
 259          * Set the file to which config was saved
 260          */
 261         public static void setConfigFile(File inFile)
 262         {
 263                 _configFile = inFile;
 264         }
 265
 266         /**
 267          * @return config Properties object to allow all config values to be saved
 268          */
 269         public static Properties getAllConfig()
 270         {
 271                 // Update recently-used files
 272                 _configValues.setProperty(KEY_RECENT_FILES, _recentFiles.getConfigString());
 273                 return _configValues;
 274         }
 275
 276         /**
 277          * @return the current colour scheme
 278          */
 279         public static ColourScheme getColourScheme()
 280         {
 281                 return _colourScheme;
 282         }
 283
 284         /**
 285          * @return the current point colourer, if any
 286          */
 287         public static PointColourer getPointColourer()
 288         {
 289                 return _pointColourer;
 290         }
 291
 292         /**
 293          * @return list of recently used files
 294          */
 295         public static RecentFileList getRecentFileList()
 296         {
 297                 return _recentFiles;
 298         }
 299
 300         /**
 301          * Store the given configuration setting
 302          * @param inKey key (from constants)
 303          * @param inValue value as string
 304          */
 305         public static void setConfigString(String inKey, String inValue)
 306         {
 307                 if (inValue == null || inValue.equals("")) {
 308                         _configValues.remove(inKey);
 309                 }
 310                 else {
 311                         _configValues.put(inKey, inValue);
 312                 }
 313         }
 314
 315         /**
 316          * Store the given configuration setting
 317          * @param inKey key (from constants)
 318          * @param inValue value as boolean
 319          */
 320         public static void setConfigBoolean(String inKey, boolean inValue)
 321         {
 322                 if (inKey != null && !inKey.equals(""))
 323                 {
 324                         _configValues.put(inKey, (inValue?"1":"0"));
 325                 }
 326         }
 327
 328         /**
 329          * Store the given configuration setting
 330          * @param inKey key (from constants)
 331          * @param inValue value as int
 332          */
 333         public static void setConfigInt(String inKey, int inValue)
 334         {
 335                 if (inKey != null && !inKey.equals(""))
 336                 {
 337                         _configValues.put(inKey, "" + inValue);
 338                 }
 339         }
 340
 341         /**
 342          * Get the given configuration setting as a String
 343          * @param inKey key
 344          * @return configuration setting as a String
 345          */
 346         public static String getConfigString(String inKey)
 347         {
 348                 return _configValues.getProperty(inKey);
 349         }
 350
 351         /**
 352          * Get the given configuration setting as a boolean
 353          * @param inKey key
 354          * @return configuration setting as a boolean (default to true)
 355          */
 356         public static boolean getConfigBoolean(String inKey)
 357         {
 358                 String val = _configValues.getProperty(inKey);
 359                 return (val == null || val.equals("1"));
 360         }
 361
 362         /**
 363          * Get the given configuration setting as an int
 364          * @param inKey key
 365          * @return configuration setting as an int
 366          */
 367         public static int getConfigInt(String inKey)
 368         {
 369                 return parseInt(_configValues.getProperty(inKey));
 370         }
 371
 372         /**
 373          * Check whether the given key corresponds to a boolean property
 374          * @param inKey key to check
 375          * @return true if corresponding property is boolean
 376          */
 377         public static boolean isKeyBoolean(String inKey)
 378         {
 379                 return inKey != null && (
 380                         inKey.equals(KEY_SHOW_MAP) || inKey.equals(KEY_AUTOSAVE_SETTINGS) || inKey.equals(KEY_ONLINE_MODE)
 381                         || inKey.equals(KEY_ANTIALIAS));
 382         }
 383
 384         /**
 385          * Update the colour scheme property from the current settings
 386          */
 387         public static void updateColourScheme()
 388         {
 389                 setConfigString(KEY_COLOUR_SCHEME, _colourScheme.toString());
 390         }
 391
 392         /**
 393          * Update the point colourer from the given colourer
 394          * @param inColourer point colourer object, or null
 395          */
 396         public static void updatePointColourer(PointColourer inColourer)
 397         {
 398                 _pointColourer = inColourer;
 399                 setConfigString(KEY_POINT_COLOURER, ColourerFactory.pointColourerToString(_pointColourer));
 400         }
 401
 402         /**
 403          * @return the current unit set
 404          */
 405         public static UnitSet getUnitSet() {
 406                 return _unitSet;
 407         }
 408
 409         /**
 410          * @param inIndex index of unit set to select
 411          */
 412         public static void selectUnitSet(int inIndex)
 413         {
 414                 _unitSet = UnitSetLibrary.getUnitSet(inIndex);
 415                 // Set name of set in config
 416                 setConfigString(KEY_UNITSET_KEY, _unitSet.getNameKey());
 417         }
 418 }