Changeset 1434 for trunk/src/org/expeditee/gui/FrameUtils.java

Timestamp:

10/02/19 14:19:48 (5 years ago)

Author:

bln4

Message:

Implementation of ProfileManager. Refactor + additional content for how new profiles are created. The refactoring split out the creation of the default profile from user profiles. Refactoring revealed a long term bug that was causing user profiles to generate with incorrect information. The additional content fixed this bug by introducing the ${USER.NAME} variable, so that the default profile frameset can specify resource locations located in the users resource directory.

org.expeditee.auth.AuthenticatorBrowser
org.expeditee.auth.account.Create
org.expeditee.gui.Browser
org.expeditee.gui.management.ProfileManager
org.expeditee.setting.DirectoryListSetting
org.expeditee.setting.ListSetting
org.expeditee.settings.UserSettings

Implementation of ResourceManager as a core location to get resources from the file system. Also the additional variable ${CURRENT_FRAMESET} to represent the current frameset, so that images can be stored in the directory of the current frameset. This increases portability of framesets.

org.expeditee.gui.FrameIO
org.expeditee.gui.management.ResourceManager
org.expeditee.gui.management.ResourceUtil
Audio:

#NB: Audio used to only operate on a single directory. This has been updated to work in a same way as images. That is: when you ask for a specific resouce, it looks to the user settings to find a sequence of directories to look at in order until it manages to find the desired resource.

There is still need however for a single(ish) source of truth for the .banks and .mastermix file. Therefore these files are now always located in resource-<username>\audio.
org.apollo.agents.MelodySearch
org.apollo.audio.structure.AudioStructureModel
org.apollo.audio.util.MultiTrackPlaybackController
org.apollo.audio.util.SoundDesk
org.apollo.gui.FrameLayoutDaemon
org.apollo.io.AudioPathManager
org.apollo.util.AudioPurger
org.apollo.widgets.FramePlayer
org.apollo.widgets.SampledTrack

Images:

org.expeditee.items.ItemUtils

Frames:

org.expeditee.gui.FrameIO

Fixed a error in the FramePlayer class caused by an incorrect use of toArray().

org.apollo.widgets.FramePlayer

Added several short cut keys to allow for the Play/Pause (Ctrl + P), mute (Ctrl + M) and volume up/down (Ctrl + +/-) when hovering over SampledTrack widgets.

org.apollo.widgets.SampledTrack

Changed the way that Authenticate.login parses the new users profile to be more consistance with other similar places in code.

org.expeditee.auth.account.Authenticate

Encapsulated _body, _surrogateItemsBody and _primaryItemsBody in Frame class. Also changed getBody function to take a boolean flag as to if it should respect the current surrogate mode. If it should then it makes sure that labels have not changed since last time getBody was called.

org.expeditee.gui.Frame

File:

• trunk/src/org/expeditee/gui/FrameUtils.java (modified) (12 diffs)

trunk/src/org/expeditee/gui/FrameUtils.java

@@ -63 +63 @@
 import org.expeditee.gio.EcosystemManager;
 import org.expeditee.gio.gesture.StandardGestureActions;
+import org.expeditee.gui.management.ResourceManager;
+import org.expeditee.gui.management.ResourceUtil;
 import org.expeditee.items.Circle;
 import org.expeditee.items.Dot;
@@ -86 +88 @@
 import org.expeditee.settings.Settings;
 import org.expeditee.settings.UserSettings;
-import org.expeditee.settings.templates.TemplateSettings;
 import org.expeditee.stats.Logger;
 import org.expeditee.stats.SessionStats;
@@ -666 +667 @@
         
         private static boolean createPictureInBody(Frame frame, Text txt) {
-                return createPicture(frame, txt, frame.getBody());
+                return createPicture(frame, txt, frame.getBody(false));
         }
 
@@ -726 +727 @@
         
         private static boolean createWidgetInBody(Frame frame, Text txt) {
-                return createWidget(frame, txt, frame.getBody());
-        }
-
-        public static List<String> ParseProfile(Frame profile) {
+                return createWidget(frame, txt, frame.getBody(false));
+        }
+
+        public static List<String> ParseProfile(Frame profile) {                
                 List<String> errors = new LinkedList<String>();
 
                 if (profile == null) {
+                        return errors;
+                }
+                
+                if (profile.getFramesetName().equals(UserSettings.DEFAULT_PROFILE_NAME)) {
                         return errors;
                 }
@@ -771 +776 @@
                 }
 
+                // Tell the resource manager that it needs to refresh its context.
+                ResourceManager.invalidateAllResourceDirectories();
+                
                 return errors;
         }
@@ -792 +800 @@
                         DisplayController.setCurrentFrame(firstFrame, true);
                 }
-
         }
 
@@ -843 +850 @@
                 throw new RuntimeException("Missing value for profile attribute" + name);
         }
-
-        public static ArrayList<String> getDirs(Item item) {
-                ArrayList<String> dirsToAdd = new ArrayList<String>();
+        
+        public static List<String> getDirs(Item item) {
+                List<String> dirsToAdd = new ArrayList<String>();
+                String currentFramesetFlag = ResourceUtil.CURRENT_FRAMESET_FLAG;
+                boolean need_file_sep_replace = (!File.separator.equals("/"));
+                
                 String dirListFrameName = item.getAbsoluteLink();
-                if (dirListFrameName != null) {
-                        Frame dirListFrame = FrameIO.LoadFrame(dirListFrameName);
-                        if (dirListFrame != null) {
-                                for (Text t : dirListFrame.getBodyTextItems(false)) {
-                                        String dirName = t.getText().trim();
-                                        File tester = new File(dirName);
-                                        if (tester.exists() && tester.isDirectory()) {
-                                                if (dirName.endsWith(File.separator)) {
-                                                        dirsToAdd.add(dirName);
-                                                } else {
-                                                        dirsToAdd.add(dirName + File.separator);
-                                                }
-                                        }
-                                }
-                        }
-                }
-
+                if (dirListFrameName == null) {
+                        return dirsToAdd;
+                }
+                Frame dirListFrame = FrameIO.LoadFrame(dirListFrameName);
+                if (dirListFrame == null) {
+                        return dirsToAdd;
+                }
+                
+                List<Text> bodyTextItems = dirListFrame.getBodyTextItems(false);
+                for (Text t: bodyTextItems) {
+                        String dirName = t.getText().trim();
+                        
+                        if (need_file_sep_replace) {
+                                dirName = dirName.replace("/",File.separator);
+                        }
+                        
+                        boolean isSpecialCase = dirName.startsWith(currentFramesetFlag);
+                        File filePath = Paths.get(FrameIO.PARENT_FOLDER).resolve(dirName).toFile();
+                        boolean locationExists = filePath.exists() && filePath.isDirectory();
+                        if (isSpecialCase || locationExists) {
+                                if (dirName.endsWith(File.separator)) {
+                                        dirsToAdd.add(dirName);
+                                } else {
+                                        dirsToAdd.add(dirName + File.separator);
+                                }
+                        }
+                }
+                
                 return dirsToAdd;
         }
@@ -1140 +1161 @@
          */     
         public static void Parse(Frame toParse, boolean firstParse, boolean ignoreAnnotations) { 
-                List<String> accessList = Label.getAccessibleLabelsNames(new ItemsList(toParse.getPrimaryBody()));
+                List<String> accessList = Label.getAccessibleLabelsNames(toParse.getPrimaryBody());
                 
                 ItemsList primaries = toParse.getPrimaryBody();
@@ -1150 +1171 @@
                 toParse.getInteractableItems().clear();
                 List<Item> newBody = parseFromPrimary(primaries, accessList);
-                toParse.getBody().clear();
-                toParse.getBody().addAll(newBody);
-                generatingSupportingItems(toParse, toParse.getBody(), ignoreAnnotations);
+                toParse.setBody(newBody, accessList);
+                generatingSupportingItems(toParse, toParse.getBody(false), ignoreAnnotations);
                 
                 if (firstParse) {
@@ -1587 +1607 @@
                 CreateDefaultProfile(profileFor, profile, null, null);
         }
-
+                
         /**
          * Copies the content from the default profile to the specified profile.
@@ -1610 +1630 @@
                                 try {
                                         // If we do not have a default to copy, create one.
+                                        String existingUsername = UserSettings.UserName.get();
+                                        UserSettings.UserName.set("default");
+                                        FrameIO.changeParentAndSubFolders(FrameIO.PARENT_FOLDER);
+                                        UserSettings.setupDefaultFolders();
                                         defaultFrame = FrameIO.CreateNewProfile(UserSettings.DEFAULT_PROFILE_NAME, null, null);
+                                        UserSettings.UserName.set(existingUsername);
+                                        FrameIO.changeParentAndSubFolders(FrameIO.PARENT_FOLDER);
+                                        UserSettings.setupDefaultFolders();
                                 } catch (InvalidFramesetNameException invalidNameEx) {
                                         MessageBay.errorMessage("Failed to create default profile named: "
@@ -1685 +1712 @@
                         }
                         MessageBay.suppressMessages(false);
-                } else {
-                        title.setText("Default Profile Frame");
-                        int xPos = 300;
-                        int yPos = 100;
-                        Text t;
-                        
-                        // Add documentation links
-                        File helpDirectory = new File(FrameIO.HELP_PATH);
-                        if (helpDirectory != null) {
-                                File[] helpFramesets = helpDirectory.listFiles();
-                                if (helpFramesets != null) {
-
-                                        // Add the title for the help index
-                                        Text help = profile.addText(xPos, yPos, "@Expeditee Help", null);
-                                        help.setSize(25);
-                                        help.setFontStyle("Bold");
-                                        help.setFamily("SansSerif");
-                                        help.setColor(TemplateSettings.ColorWheel.get()[3]);
-
-                                        xPos += 25;
-                                        System.out.println("Installing frameset: ");
-
-                                        boolean first_item = true;
-                                        for (File helpFrameset : helpFramesets) {
-                                                String framesetName = helpFrameset.getName();
-                                                if (!FrameIO.isValidFramesetName(framesetName)) {
-                                                        continue;
-                                                }
-
-                                                if (first_item) {
-                                                        System.out.print("  " + framesetName);
-                                                        first_item = false;
-                                                } else {
-                                                        System.out.print(", " + framesetName);
-                                                }
-                                                System.out.flush();
-
-                                                Frame indexFrame = FrameIO.LoadFrame(framesetName + '1');
-                                                // Look through the folder for help index pages
-                                                if (indexFrame != null && ItemUtils.FindTag(indexFrame.getSortedItems(), "@HelpIndex") != null) {
-                                                        // yPos += spacing;
-                                                        yPos += 30;
-                                                        t = profile.addText(xPos, yPos, '@' + indexFrame.getFramesetName(), null);
-                                                        t.setLink(indexFrame.getName());
-                                                        t.setColor(Colour.GREY);
-                                                }
-                                        }
-                                        System.out.println();
-                                }
-                        }
-
-                        xPos = 50;
-                        yPos = 100;
-
-                        // Populate Start Pages and Settings
-                        File framesetDirectory = new File(FrameIO.FRAME_PATH);
-
-                        if (framesetDirectory.exists()) {
-                                File[] startpagesFramesets = framesetDirectory.listFiles();
-
-                                if (startpagesFramesets != null) {
-                                        // Add Start Page title
-                                        Text templates = profile.addText(xPos, yPos, "@Start Pages", null);
-                                        templates.setSize(25);
-                                        templates.setFontStyle("Bold");
-                                        templates.setFamily("SansSerif");
-                                        templates.setColor(TemplateSettings.ColorWheel.get()[3]);
-
-                                        xPos += 25;
-
-                                        // Start Pages should be the first frame in its own frameset +
-                                        // frameset name should be present in FrameUtils.startPages[].
-                                        for (File startpagesFrameset : startpagesFramesets) {
-                                                String framesetName = startpagesFrameset.getName();
-
-                                                // Only add link if frameset is a startpage
-                                                for (int i = 0; i < startPages.length; i++) {
-                                                        if (framesetName.equals(startPages[i])) {
-                                                                Frame indexFrame = FrameIO.LoadFrame(framesetName + '1');
-
-                                                                // Add start page link
-                                                                if (indexFrame != null) {
-                                                                        yPos += 30;
-                                                                        t = profile.addText(xPos, yPos, '@' + indexFrame.getFramesetName(), null);
-                                                                        t.setLink(indexFrame.getName());
-                                                                        t.setColor(Colour.GREY);
-                                                                }
-                                                        }
-                                                }
-                                        }
-                                }
-                        }
-
-                        FrameIO.SaveFrame(profile);
-
-                        // Populate settings frameset
-                        Settings.Init();
-                        t = profile.addText(550, 100, "@Settings", null);
-                        t.setSize((float) 25.0);
-                        t.setFamily("SansSerif");
-                        t.setFontStyle("Bold");
-                        t.setColor(Colour.GREY);
-                        Settings.generateSettingsTree(t);
-                        System.out.println("@Settings: Default settings generation complete.");
-
-                        FrameIO.SaveFrame(profile);
-                }
+                } 
         }