/**
* UserSettings.java
* Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
*
* 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 3 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 .
*/
package org.expeditee.settings;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import org.expeditee.agents.SearchGreenstone;
import org.expeditee.agents.mail.MailSession;
import org.expeditee.agents.wordprocessing.JSpellChecker;
import org.expeditee.auth.AuthenticatorBrowser;
import org.expeditee.gui.Frame;
import org.expeditee.gui.FrameIO;
import org.expeditee.gui.FrameUtils;
import org.expeditee.gui.MessageBay;
import org.expeditee.items.Text;
import org.expeditee.setting.BooleanSetting;
import org.expeditee.setting.FloatSetting;
import org.expeditee.setting.FrameSetting;
import org.expeditee.setting.FunctionSetting;
import org.expeditee.setting.IntegerSetting;
import org.expeditee.setting.ListSetting;
import org.expeditee.setting.StringSetting;
import org.expeditee.settings.folders.FolderSettings;
/**
* Central class to contain all values that can be set by the user on their
* profile frame. These values should be updated only by
* FrameUtils.ParseProfile.
*/
public abstract class UserSettings {
public static String DEFAULT_PROFILE_NAME = "default";
public static Boolean PublicAndPrivateResources;
public static final IntegerSetting Gravity = new IntegerSetting("Distance the cursor has to be from a text item to select the text item", "Gravity", 3);
public static final StringSetting StartFrame = new StringSetting("The frame to go to when Expeditee is started (defaults to the profile frame)", null);
/*
* Stuff that goes first
*/
public static final StringSetting HomeFrame = new StringSetting("The home frame", null) {
@Override
public boolean setSetting(Text text) {
if(text.getText().indexOf(':') == -1 || !text.hasLink()) {
text.setLink(UserSettings.ProfileName.get() + "1");
//text.setLink(FrameIO.LoadProfile(UserSettings.ProfileName.get()).getName());
}
String first = FrameUtils.getLink(text, UserSettings.HomeFrame.get());
// do not use non-existent frames as the first frame
if (FrameIO.isValidFrameName(first)) {
_value = first;
}
// warn the user
else {
// MessageBay.warningMessage("Home frame: " + first
// + " is not a valid frame.");
_value = FrameIO.LoadProfile(UserSettings.ProfileName.get()).getName();
}
return true;
}
};
public static final IntegerSetting InitialWidth = new IntegerSetting("Initial width of Expeditee window", "InitialWidth", 1024);
public static final IntegerSetting InitialHeight = new IntegerSetting("Initial height of Expeditee window", "InitialHeight", 768);
/*
* General settings (no setter functions)
*/
public static final FloatSetting ScaleFactor = new FloatSetting("Scale Factor for drawing (TODO: does this even do anything?)", "ScaleFactor", 1F);
public static final FloatSetting FormatSpacingMin = new FloatSetting("Minimum spacing ratio", "FormatSpacingMin", null);
public static final FloatSetting FormatSpacingMax = new FloatSetting("Maximum spacing ratio", "FormatSpacingMax", null);
public static final IntegerSetting LineStraightenThreshold = new IntegerSetting("Threshold for straightening a line (TODO: does this even do anything?)", "LineStraightenThreshold", 15);
public static final IntegerSetting NoOpThreshold = new IntegerSetting("Distance the cursor may be dragged before Gestures must be reinterpreted. E.g. Copy becomes range.", "NoOpThreshold", 10);
public static final IntegerSetting TitlePosition = new IntegerSetting("Position of title item in frame (TODO: find whether this is x-offset or y-offset)", "TitlePosition", 150);
public static final StringSetting UserName = new StringSetting("Profile name", FrameIO.ConvertToValidFramesetName(System.getProperty("user.name")));
public static final StringSetting ProfileName = new StringSetting("Profile name", UserName.get());
public static final BooleanSetting AntiAlias = new BooleanSetting("Whether anti-aliasing should be enabled", "AntiAlias", false);
public static final BooleanSetting LineHighlight = new BooleanSetting("Whether lines should be highlighted", "LineHighlight", false);
public static final BooleanSetting Logging = new BooleanSetting("Whether logging should be enabled", "Logging", false);
public static final BooleanSetting LogStats = new BooleanSetting("Whether stats should be logged", "LogStats", true);
public static final BooleanSetting Threading = new BooleanSetting("Whether threading should be enabled", "Threading", true);
/*
* Frames
*/
public static final StringSetting StatisticsFrameset = new StringSetting("The statistics frameset", null);
public static final StringSetting MenuFrame = new StringSetting("The menu frame", null);
/*
* Other
*/
public static final ListSetting Style = new ListSetting("Set the style (TODO: what does this do?)", "Style") {
@Override
public boolean setSetting(Text text) {
Frame child = text.getChild();
if (child == null) {
_value = new LinkedList();
return true;
}
List style = new ArrayList(8);
for (int i = 0; i < 10; i++) {
style.add(null);
}
for (Text t : child.getBodyTextItems(false)) {
String type = t.getText();
char lastChar = type.charAt(type.length() - 1);
if (Character.isDigit(lastChar)) {
style.set(lastChar - '0', t);
} else {
style.set(0, t);
}
}
_value = style;
return true;
}
};
public static final FunctionSetting SpellChecker = new FunctionSetting("Enables the dictionary with the default dictionary", "SpellChecker") {
@Override
public void run() {
try {
JSpellChecker.create();
} catch (FileNotFoundException e) {
MessageBay.errorMessage("Could not find dictionary: " + e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}
}
};
public static final FrameSetting Spelling = new FrameSetting("Enables the dictionary and adds the items in the child frame to the dictionary", "Spelling") {
@Override
public void run(Frame frame) {
try {
JSpellChecker.create(frame);
} catch (Exception e) {
e.printStackTrace();
}
}
};
public static final FrameSetting GreenstoneSettings = new FrameSetting("Greenstone settings (TODO: What are these for?)", "GreenstoneSettings") {
@Override
public void run(Frame frame) {
SearchGreenstone.init(frame);
}
};
public static final FrameSetting Reminders = new FrameSetting("Reminders (TODO: What are these for?)", "Reminders") {
@Override
public void run(Frame frame) {
org.expeditee.gui.Reminders.init(frame);
}
};
public static final FrameSetting MailSettings = new FrameSetting("Mail Settings (TODO: How does this work?)", "MailSettings") {
@Override
public void run(Frame frame) {
MailSession.init(frame);
}
};
// add default values
static {
// Are we in the new regime or the old regime?
File resFile = Paths.get(getExpediteeHome()).resolve(".res").toFile();
File resourcesPrivateFile = Paths.get(getExpediteeHome() + "resources-private" + File.separator).toFile();
if (resourcesPrivateFile.exists()) {
// If resources-private exists then this is a good sign we have new regime available.
PublicAndPrivateResources = Boolean.TRUE;
} else if (resFile.exists()) {
// If we do not, but do have the .res file then this is a good sign we are in old regime.
PublicAndPrivateResources = Boolean.FALSE;
} else {
// If we have neither then we are unpacking and therefore will have new regime available once unpacked.
PublicAndPrivateResources = Boolean.TRUE;
}
setupDefaultFolders();
}
public static void setupDefaultFolders() {
String expeditee_home = getExpediteeHome();
FrameIO.changeParentAndSubFolders(expeditee_home);
FolderSettings.FrameDirs.get().clear();
FolderSettings.ImageDirs.get().clear();
FolderSettings.AudioDirs.get().clear();
appendDefaultFolders();
}
private static String getExpediteeHome() {
String home_property = System.getProperty("expeditee.home");
String expeditee_home = (home_property != null) ? home_property + File.separator : getSaveLocation();
return expeditee_home;
}
public static void appendDefaultFolders() {
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PUBLIC_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.TRASH_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PROFILE_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.GROUP_PATH);
if (PublicAndPrivateResources) {
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.HELP_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.HELP_PRIVATE_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PRIVATE_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MESSAGES_PATH);
if (AuthenticatorBrowser.isAuthenticated()) {
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.SHARED_FRAMESETS_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MAIL_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.CONTACTS_PATH);
}
FolderSettings.FrameDirs.setDefault(FolderSettings.FrameDirs.get());
FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PATH);
FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PRIVATE_PATH);
FolderSettings.ImageDirs.setDefault(FolderSettings.ImageDirs.get());
FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PATH);
FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PRIVATE_PATH);
FolderSettings.AudioDirs.setDefault(FolderSettings.AudioDirs.get());
} else {
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.HELP_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MESSAGES_PATH);
if (AuthenticatorBrowser.isAuthenticated()) {
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.SHARED_FRAMESETS_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MAIL_PATH);
FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.CONTACTS_PATH);
}
FolderSettings.FrameDirs.setDefault(FolderSettings.FrameDirs.get());
FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PATH);
FolderSettings.ImageDirs.setDefault(FolderSettings.ImageDirs.get());
FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PATH);
FolderSettings.AudioDirs.setDefault(FolderSettings.AudioDirs.get());
}
}
// public static void appendDefaultFolders() {
// if (PublicAndPrivateResources && AuthenticatorBrowser.isAuthenticated()) {
// // The comments here explain how things have changed with the new regime.
// // FrameDirs
// // 1. PROFILE_PATH Still points to same place.
// // 2. SHARED_FRAMESETS_PATH Still points to same place. (encryption stops just anyone reading it)
// // 3. framesets- Generated on user account creation and must be refreshed on user switching. Also gives access to tutorial stuffs.
// // 4. FRAME_PATH \resources-public\framesets.
// // 5. HELP_PUBLIC_PATH \resources-public\documentation.
// // 6. MESSAGES_PATH Still points to same place. Should these be per user and encrypted?
// // 7. PUBLIC_PATH Still points to same place. Kept for compatibility.
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PROFILE_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PRIVATE_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.SHARED_FRAMESETS_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.RESOURCES_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MESSAGES_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PUBLIC_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.HELP_PRIVATE_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MAIL_PATH);
// FolderSettings.FrameDirs.setDefault(FolderSettings.FrameDirs.get());
//
// // ImageDirs
// // 1. resources-\images Generated on user account creation and must be refreshed on user switching.
// // 2. IMAGES_PATH \resources-public\images
// FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PRIVATE_PATH);
// FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PATH);
// FolderSettings.ImageDirs.setDefault(FolderSettings.ImageDirs.get());
//
// FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PRIVATE_PATH);
// FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PATH);
// FolderSettings.AudioDirs.setDefault(FolderSettings.AudioDirs.get());
// } else {
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PUBLIC_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.PROFILE_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.HELP_PATH);
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.MESSAGES_PATH);
// if (FrameIO.FRAME_PRIVATE_PATH != null) {
// FolderSettings.FrameDirs.addAbsoluteDir(FrameIO.FRAME_PRIVATE_PATH);
// }
// FolderSettings.FrameDirs.setDefault(FolderSettings.FrameDirs.get());
//
// FolderSettings.ImageDirs.addAbsoluteDir(FrameIO.IMAGES_PATH);
// FolderSettings.ImageDirs.setDefault(FolderSettings.ImageDirs.get());
//
// FolderSettings.AudioDirs.addAbsoluteDir(FrameIO.AUDIO_PATH);
// FolderSettings.AudioDirs.setDefault(FolderSettings.AudioDirs.get());
// }
// }
/**
* Find the appropriate directory to store application settings in for
* the current OS.
* This has only been tested on Linux so far, so if it doesn't work it
* may need to be modified or reverted. Should return:
* Linux: ~/.expeditee
* Windows: %appdata%\.expeditee
* Mac: ~/Library/Application\ Support/.expeditee
* @return the path to store expeditee's settings
*/
public static String getSaveLocation() {
String OS=System.getProperty("os.name").toLowerCase();
if(OS.indexOf("win")>=0) { //windoze
return System.getenv("APPDATA")+File.separator+".expeditee"+File.separator;
} else if(OS.indexOf("mac")>=0) { //mac
return System.getProperty("user.home")+File.separator+"Library"+File.separator+"Application Support"+File.separator+".expeditee"+File.separator;
} else { //linux or other
return System.getProperty("user.home")+File.separator+".expeditee"+File.separator;
}
}
}