NbTmcSettings.java

package fi.helsinki.cs.tmc.model;

import com.google.common.base.Optional;
import fi.helsinki.cs.tmc.events.TmcEvent;
import fi.helsinki.cs.tmc.events.TmcEventBus;
import fi.helsinki.cs.tmc.tailoring.SelectedTailoring;
import fi.helsinki.cs.tmc.tailoring.Tailoring;
import fi.helsinki.cs.tmc.core.configuration.TmcSettings;
import fi.helsinki.cs.tmc.core.domain.Course;

import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Locale;

/**
 * A transient saveable collection of all settings of the TMC plugin.
 */
public class NbTmcSettings implements TmcSettings {
    private static final String PREF_BASE_URL = "baseUrl";
    private static final String PREF_USERNAME = "username";
    private static final String PREF_PASSWORD = "password";
    private static final String PREF_PROJECT_ROOT_DIR = "projectRootDir";
    private static final String PREF_CHECK_FOR_UPDATES_IN_BACKGROUND =
            "checkForUpdatesInBackground";
    private static final String PREF_CHECK_FOR_UNOPENED_AT_STARTUP = "checkForUnopenedAtStartup";
    private static final String PREF_SPYWARE_ENABLED = "spywareEnabled";
    private static final String PREF_DETAILED_SPYWARE_ENABLED = "detailedSpywareEnabled";
    private static final String PREF_ERROR_MSG_LOCALE = "errorMsgLocale";

    private static final NbTmcSettings defaultInstance =
            new NbTmcSettings(
                    PersistableSettings.forModule(NbTmcSettings.class),
                    SelectedTailoring.get(),
                    TmcEventBus.getDefault());

    private PersistableSettings settings;
    private Tailoring tailoring;
    private TmcEventBus eventBus;
    private final String api_version = "7";

    private String unsavedPassword;

    @Override
    public boolean userDataExists() {
        return !(this.getUsername().isEmpty() || this.getPassword().isEmpty());
    }

    @Override
    public Optional<Course> getCurrentCourse() {
        if (CourseDb.getInstance().getCurrentCourse() == null) {
            return Optional.absent();
        } else {
            return Optional.of(CourseDb.getInstance().getCurrentCourse());
        }
    }

    @Override
    public String apiVersion() {
        return this.api_version;
    }

    @Override
    public String getFormattedUserData() {
        return this.getUsername() + ":" + this.getPassword();
    }

    @Override
    public String clientName() {
        return "netbeans_plugin";
    }

    @Override
    public String clientVersion() {
        return "0.8.8";
    }

    public static class SavedEvent implements TmcEvent {}

    public static NbTmcSettings getDefault() {
        return defaultInstance;
    }

    public static NbTmcSettings getTransient() {
        return new NbTmcSettings(
                PersistableSettings.forModule(NbTmcSettings.class),
                SelectedTailoring.get(),
                TmcEventBus.getDefault());
    }

    /*package*/ NbTmcSettings(
            PersistableSettings settings, Tailoring tailoring, TmcEventBus eventBus) {
        this.settings = settings;
        this.tailoring = tailoring;
        this.eventBus = eventBus;

        this.unsavedPassword = settings.get(PREF_PASSWORD, "");
    }

    public void save() {
        if (this != defaultInstance) {
            throw new IllegalStateException("May only save the default instance of TmcSettings.");
        }
        settings.saveAll();
        eventBus.post(new SavedEvent());
    }

    @Override
    public String getServerAddress() {
        return settings.get(PREF_BASE_URL, tailoring.getDefaultServerUrl());
    }

    public void setServerBaseUrl(String baseUrl) {
        baseUrl = stripTrailingSlashes(baseUrl);
        settings.put(PREF_BASE_URL, baseUrl);
    }

    private String stripTrailingSlashes(String s) {
        while (s.endsWith("/")) {
            s = s.substring(0, s.length() - 1);
        }
        return s;
    }

    @Override
    public String getUsername() {
        return settings.get(PREF_USERNAME, tailoring.getDefaultUsername());
    }

    public void setUsername(String username) {
        settings.put(PREF_USERNAME, username);
    }

    @Override
    public String getPassword() {
        return unsavedPassword;
    }

    public void setPassword(String password) {
        unsavedPassword = password;
        if (isSavingPassword()) {
            settings.put(PREF_PASSWORD, password);
        }
    }

    public void setSavingPassword(boolean shouldSave) {
        if (shouldSave) {
            settings.put(PREF_PASSWORD, unsavedPassword);
        } else {
            settings.remove(PREF_PASSWORD);
        }
    }

    public boolean isSavingPassword() {
        return settings.get(PREF_PASSWORD, null) != null;
    }

    @Override
    public String getTmcMainDirectory() {
        String target = settings.get(PREF_PROJECT_ROOT_DIR, null);
        //TODO: Change String to Path in TmcSettings
        if (target != null) {
            return target;
        } else {
            // Can sometimes take a while. That's why we don't pass it as a default above.
            return ProjectMediator.getDefaultProjectRootDir();
        }
    }

    public void setProjectRootDir(String value) {
        settings.put(PREF_PROJECT_ROOT_DIR, value);
    }

    public boolean isCheckingForUpdatesInTheBackground() {
        return settings.get(PREF_CHECK_FOR_UPDATES_IN_BACKGROUND, "1").equals("1");
    }

    public void setCheckingForUpdatesInTheBackground(boolean value) {
        settings.put(PREF_CHECK_FOR_UPDATES_IN_BACKGROUND, value ? "1" : "0");
    }

    public boolean isCheckingForUnopenedAtStartup() {
        return settings.get(PREF_CHECK_FOR_UNOPENED_AT_STARTUP, "1").equals("1");
    }

    public void setCheckingForUnopenedAtStartup(boolean value) {
        settings.put(PREF_CHECK_FOR_UNOPENED_AT_STARTUP, value ? "1" : "0");
    }

    public boolean isSpywareEnabled() {
        String defaultValue = tailoring.isSpywareEnabledByDefault() ? "1" : "0";
        return settings.get(PREF_SPYWARE_ENABLED, defaultValue).equals("1");
    }

    public void setIsSpywareEnabled(boolean value) {
        settings.put(PREF_SPYWARE_ENABLED, value ? "1" : "0");
    }

    public boolean isDetailedSpywareEnabled() {
        String defaultValue = tailoring.isDetailedSpywareEnabledByDefault() ? "1" : "0";
        return settings.get(PREF_DETAILED_SPYWARE_ENABLED, defaultValue).equals("1");
    }

    public Locale getErrorMsgLocale() {
        Locale dflt = tailoring.getDefaultErrorMsgLocale();
        return parseLocale(settings.get(PREF_ERROR_MSG_LOCALE, ""), dflt);
    }

    public void setErrorMsgLocale(Locale locale) {
        settings.put(PREF_ERROR_MSG_LOCALE, locale.toString());
    }

    private Locale parseLocale(String s, Locale dflt) {
        if (s.isEmpty()) {
            return dflt;
        }
        String[] parts = s.split("_");
        switch (parts.length) {
            case 1:
                return new Locale(parts[0]);
            case 2:
                return new Locale(parts[0], parts[1]);
            case 3:
                return new Locale(parts[0], parts[1], parts[2]);
            default:
                return dflt;
        }
    }
}