osmcb.program.EnvironmentSetup.java Source code

Introduction

Here is the source code for osmcb.program.EnvironmentSetup.java

Source

/*******************************************************************************
 * Copyright (c) OSMCB developers
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package osmcb.program;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.util.Locale;

import javax.swing.JOptionPane;

import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;

import osmb.utilities.GUIExceptionHandler;
import osmb.utilities.file.FileExtFilter;
import osmb.utilities.file.NamePatternFileFilter;
import osmcb.OSMCBSettings;
import osmcb.OSMCBStrs;
import osmcb.utilities.OSMCBUtilities;

/**
 * Creates the necessary files on first time OpenSeaMap ChartBundler is started or tries to update the environment if the version has changed.
 */
public class EnvironmentSetup {
    @SuppressWarnings("unused") // W #unused
    private static boolean FIRST_START = false;

    public static Logger log = Logger.getLogger(EnvironmentSetup.class);

    public static void checkMemory() {
        Runtime r = Runtime.getRuntime();
        long maxHeap = r.maxMemory();
        String heapMBFormatted = String.format(Locale.ENGLISH, "%3.2f MiB", maxHeap / 1048576d);
        log.info("Total available memory to OSMCB: " + heapMBFormatted);
        if (maxHeap < 200000000) {
            String msg = String.format(OSMCBStrs.RStr("msg_environment_lack_memory"), heapMBFormatted);
            JOptionPane.showMessageDialog(null, msg, OSMCBStrs.RStr("msg_environment_lack_memory_title"),
                    JOptionPane.WARNING_MESSAGE);
        }
    }

    /**
     * adjusts 'old' tac filenames of catalogs from tac- to osmcb-
     */
    public static void upgrade() {
        FileFilter ff = new NamePatternFileFilter("tac-profile-.*.xml");
        File profilesDir = DirectoryManager.currentDir;
        File[] files = profilesDir.listFiles(ff);
        for (File f : files) {
            File dest = new File(profilesDir, f.getName().replaceFirst("tac-", "osmcd-"));
            f.renameTo(dest);
        }
    }

    /**
     * In case the <tt>mapsources</tt> directory has been moved by configuration (directories.ini or settings.xml) we need to copy the existing map packs into
     * the configured directory
     * 
     * userMapSourcesDir is the target directory
     */
    public static void copyMapPacks() {
        File userMapSourcesDir = OSMCBSettings.getInstance().getMapSourcesDirectory();
        File progMapSourcesDir = new File(DirectoryManager.programDir, "mapsources");
        if (userMapSourcesDir.equals(progMapSourcesDir))
            return; // no user specific directory configured
        if (userMapSourcesDir.isDirectory())
            return; // directory already exists - map packs should have been already copied
        try {
            OSMCBUtilities.mkDirs(userMapSourcesDir);
            FileUtils.copyDirectory(progMapSourcesDir, userMapSourcesDir, new FileExtFilter(".jar"));
        } catch (IOException e) {
            log.error(e);
            JOptionPane.showMessageDialog(null,
                    OSMCBStrs.RStr("msg_environment_error_init_mapsrc_dir") + e.getMessage(),
                    OSMCBStrs.RStr("Error"), JOptionPane.ERROR_MESSAGE);
            System.exit(1);
        }
    }

    /**
     * Note: This method has to be called before {@link OSMCBSettings#loadOrQuit()}. Therefore no localization is available at this point.
     */
    public static void checkSettingsSetup() {
        checkDirectory(DirectoryManager.userSettingsDir, "user settings", true);
        if (!OSMCBSettings.getFile().exists()) {
            try {
                FIRST_START = true;
                OSMCBSettings.save();
            } catch (Exception e) {
                log.error("Error while creating settings.xml: " + e.getMessage(), e);
                String[] options = { "Exit", "Show error report" };
                int a = JOptionPane.showOptionDialog(null,
                        "Could not create file settings.xml - program will exit.", "Error", 0,
                        JOptionPane.ERROR_MESSAGE, null, options, options[0]);
                if (a == 1)
                    GUIExceptionHandler.showExceptionDialog(e);
                System.exit(1);
            }
        }
    }

    /**
     * This expects the paths and dirs to be modified by settimgs-xml, so it is called after OSMCBSettings.loadOrQuit()
     */
    public static void checkFileSetup() {

        checkDirectory(OSMCBSettings.getInstance().getCatalogsDirectory(), "catalog profile", true);
        checkDirectory(OSMCBSettings.getInstance().getTileStoreDirectory(), "tile store", true);
    }

    protected static void checkDirectory(File dir, String dirName, boolean checkIsWriteable) {
        try {
            OSMCBUtilities.mkDirs(dir);
        } catch (IOException e) {
            GUIExceptionHandler.processFatalExceptionSimpleDialog(String
                    .format(OSMCBStrs.RStr("msg_environment_error_create_dir"), dirName, dir.getAbsolutePath()), e);
        }
        if (!checkIsWriteable)
            return;
        try {
            // test if we can write into that directory
            File testFile = File.createTempFile("OSMCB", "", dir);
            testFile.createNewFile();
            testFile.deleteOnExit();
            testFile.delete();
        } catch (IOException e) {
            GUIExceptionHandler.processFatalExceptionSimpleDialog(String
                    .format(OSMCBStrs.RStr("msg_environment_error_write_file"), dirName, dir.getAbsolutePath()), e);
        }
    }
}