-
Notifications
You must be signed in to change notification settings - Fork 258
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4986 from kwvanderlinde/refactor/4985-app-prefere…
…nces Clean up AppPreferences
- Loading branch information
Showing
82 changed files
with
1,183 additions
and
2,133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2,133 changes: 464 additions & 1,669 deletions
2,133
src/main/java/net/rptools/maptool/client/AppPreferences.java
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
224 changes: 224 additions & 0 deletions
224
src/main/java/net/rptools/maptool/client/AppStatePersisted.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| /* | ||
| * This software Copyright by the RPTools.net development team, and | ||
| * licensed under the Affero GPL Version 3 or, at your option, any later | ||
| * version. | ||
| * | ||
| * MapTool Source Code 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. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public | ||
| * License * along with this source Code. If not, please visit | ||
| * <http://www.gnu.org/licenses/> and specifically the Affero license | ||
| * text at <http://www.gnu.org/licenses/agpl.html>. | ||
| */ | ||
| package net.rptools.maptool.client; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.prefs.Preferences; | ||
| import net.rptools.maptool.model.Zone; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
|
|
||
| /** | ||
| * Keeps track of application state between runs. | ||
| * | ||
| * <p>This started as an offshoot of {@link net.rptools.maptool.client.AppPreferences}, hence why | ||
| * the same node is used. But these keys do not represent preferences of the user, rather they are | ||
| * application state such as MRU lists the need to be remembered between runs. This also makes it | ||
| * different from {@link net.rptools.maptool.client.AppState} which is application state that is not | ||
| * preserved between runs. | ||
| */ | ||
| public class AppStatePersisted { | ||
| private static final Logger log = LogManager.getLogger(AppStatePersisted.class); | ||
| private static final Preferences prefs = | ||
| Preferences.userRoot().node(AppConstants.APP_NAME + "/prefs"); | ||
|
|
||
| /** | ||
| * Defines the key constant for retrieving asset roots. | ||
| * | ||
| * <p>This constant is used to define the key for accessing asset roots in a configuration file or | ||
| * a data source. Asset roots represent the directories or paths where application assets are | ||
| * stored. | ||
| * | ||
| * <p>The asset roots can be used to locate and load files, images, or other resources required by | ||
| * the application at runtime. By convention, the asset root directories are organized in a | ||
| * structured manner to facilitate easy retrieval of assets. | ||
| */ | ||
| private static final String KEY_ASSET_ROOTS = "assetRoots"; | ||
|
|
||
| /** Represents the key used to access the most recently used campaigns for the menu option. */ | ||
| private static final String KEY_MRU_CAMPAIGNS = "mruCampaigns"; | ||
|
|
||
| // When hill VBL was introduced, older versions of MapTool were unable to read the new topology | ||
| // modes. So we use a different preference key than in the past so older versions would not | ||
| // unexpectedly break. | ||
| private static final String KEY_TOPOLOGY_TYPES = "topologyTypes"; | ||
| private static final String KEY_OLD_TOPOLOGY_DRAWING_MODE = "topologyDrawingMode"; | ||
| private static final String DEFAULT_TOPOLOGY_TYPE = "VBL"; | ||
|
|
||
| /** Represents the key used to save the paint textures to the preferences. */ | ||
| private static final String KEY_SAVED_PAINT_TEXTURES = "savedTextures"; | ||
|
|
||
| public static void clearAssetRoots() { | ||
| prefs.put(KEY_ASSET_ROOTS, ""); | ||
| } | ||
|
|
||
| public static void addAssetRoot(File root) { | ||
| String list = prefs.get(KEY_ASSET_ROOTS, ""); | ||
| if (!list.isEmpty()) { | ||
| // Add the new one and then remove all duplicates. | ||
| list += ";" + root.getPath(); | ||
| String[] roots = list.split(";"); | ||
| var result = new StringBuilder(list.length() + root.getPath().length() + 10); | ||
| var rootList = new HashSet<String>(roots.length); | ||
|
|
||
| // This loop ensures that each path only appears once. If there are currently | ||
| // duplicates in the list, only the first one is kept. | ||
| for (String r : roots) { | ||
| if (!rootList.contains(r)) { | ||
| result.append(';').append(r); | ||
| rootList.add(r); | ||
| } | ||
| } | ||
| list = result.substring(1); | ||
| } else { | ||
| list += root.getPath(); | ||
| } | ||
| prefs.put(KEY_ASSET_ROOTS, list); | ||
| } | ||
|
|
||
| public static Set<File> getAssetRoots() { | ||
| String list = prefs.get(KEY_ASSET_ROOTS, ""); | ||
| String[] roots = list.split(";"); // FJE Probably should be File.path_separator ... | ||
|
|
||
| var rootList = new HashSet<File>(); | ||
| for (String root : roots) { | ||
| File file = new File(root); | ||
|
|
||
| // LATER: Should this actually remove it from the pref list ? | ||
| if (!file.exists()) { | ||
| continue; | ||
| } | ||
| rootList.add(file); | ||
| } | ||
| return rootList; | ||
| } | ||
|
|
||
| public static void removeAssetRoot(File root) { | ||
| String list = prefs.get(KEY_ASSET_ROOTS, ""); | ||
| if (!list.isEmpty()) { | ||
| // Add the new one and then remove all duplicates. | ||
| String[] roots = list.split(";"); | ||
| var result = new StringBuilder(list.length()); | ||
| var rootList = new HashSet<String>(roots.length); | ||
| String rootPath = root.getPath(); | ||
|
|
||
| // This loop ensures that each path only appears once. If there are | ||
| // duplicates in the list, only the first one is kept. | ||
| for (String r : roots) { | ||
| if (!r.equals(rootPath) && !rootList.contains(r)) { | ||
| result.append(';').append(r); | ||
| rootList.add(r); | ||
| } | ||
| } | ||
| list = result.substring(result.isEmpty() ? 0 : 1); | ||
| prefs.put(KEY_ASSET_ROOTS, list); | ||
| } | ||
| } | ||
|
|
||
| public static void setMruCampaigns(List<File> mruCampaigns) { | ||
| StringBuilder combined = new StringBuilder(); | ||
| for (File file : mruCampaigns) { | ||
| String path; | ||
| try { | ||
| path = file.getCanonicalPath(); | ||
| } catch (IOException e) { | ||
| // Probably pretty rare, but we want to know about it | ||
| log.info("unexpected during file.getCanonicalPath()", e); // $NON-NLS-1$ | ||
| path = file.getPath(); | ||
| } | ||
| // It's important that '%3A' is done last. Note that the pathSeparator may not be a colon on | ||
| // the current platform, but it doesn't matter since it will be reconverted when read back in | ||
| // again. | ||
| // THink of the '%3A' as a symbol of the separator, not an encoding of the character. | ||
| combined.append(path.replaceAll("%", "%25").replaceAll(File.pathSeparator, "%3A")); | ||
| combined.append(File.pathSeparator); | ||
| } | ||
| prefs.put(KEY_MRU_CAMPAIGNS, combined.toString()); | ||
| } | ||
|
|
||
| public static List<File> getMruCampaigns() { | ||
| var mruCampaigns = new ArrayList<File>(); | ||
| String combined = prefs.get(KEY_MRU_CAMPAIGNS, null); | ||
| if (combined != null) { | ||
| // It's important that '%3A' is done first | ||
| combined = combined.replaceAll("%3A", File.pathSeparator).replaceAll("%25", "%"); | ||
| String[] all = combined.split(File.pathSeparator); | ||
| for (String s : all) { | ||
| mruCampaigns.add(new File(s)); | ||
| } | ||
| } | ||
| return mruCampaigns; | ||
| } | ||
|
|
||
| public static Zone.TopologyTypeSet getTopologyTypes() { | ||
| try { | ||
| String typeNames = prefs.get(KEY_TOPOLOGY_TYPES, ""); | ||
| if ("".equals(typeNames)) { | ||
| // Fallback to the key used prior to the introduction of various VBL types. | ||
| String oldDrawingMode = prefs.get(KEY_OLD_TOPOLOGY_DRAWING_MODE, DEFAULT_TOPOLOGY_TYPE); | ||
| return switch (oldDrawingMode) { | ||
| case "VBL" -> new Zone.TopologyTypeSet(Zone.TopologyType.WALL_VBL); | ||
| case "MBL" -> new Zone.TopologyTypeSet(Zone.TopologyType.MBL); | ||
| case "COMBINED" -> new Zone.TopologyTypeSet( | ||
| Zone.TopologyType.WALL_VBL, Zone.TopologyType.MBL); | ||
| default -> new Zone.TopologyTypeSet(Zone.TopologyType.WALL_VBL); | ||
| }; | ||
| } else { | ||
| return Zone.TopologyTypeSet.valueOf(typeNames); | ||
| } | ||
| } catch (Exception exc) { | ||
| return new Zone.TopologyTypeSet(Zone.TopologyType.WALL_VBL); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the selected topology modes. | ||
| * | ||
| * @param types the topology types. A value of null resets to default. | ||
| */ | ||
| public static void setTopologyTypes(Zone.TopologyTypeSet types) { | ||
| if (types == null) { | ||
| prefs.remove(KEY_TOPOLOGY_TYPES); | ||
| } else { | ||
| prefs.put(KEY_TOPOLOGY_TYPES, types.toString()); | ||
| } | ||
| } | ||
|
|
||
| public static void setSavedPaintTextures(List<File> savedTextures) { | ||
| StringBuilder combined = new StringBuilder(); | ||
| for (File savedTexture : savedTextures) { | ||
| combined.append(savedTexture.getPath()); | ||
| combined.append(File.pathSeparator); | ||
| } | ||
| prefs.put(KEY_SAVED_PAINT_TEXTURES, combined.toString()); | ||
| } | ||
|
|
||
| public static List<File> getSavedPaintTextures() { | ||
| var savedTextures = new ArrayList<File>(); | ||
| String combined = prefs.get(KEY_SAVED_PAINT_TEXTURES, null); | ||
| if (combined != null) { | ||
| String[] all = combined.split(File.pathSeparator); | ||
| for (String s : all) { | ||
| savedTextures.add(new File(s)); | ||
| } | ||
| } | ||
| return savedTextures; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.