add ResourceOpenedListener so interested parties can find out what caused a file to be opened

Author: daykin

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/ActionUtil.java

@@ -31,6 +31,7 @@
 import org.phoebus.framework.macros.MacroOrSystemProvider;
 import org.phoebus.framework.macros.MacroValueProvider;
 import org.phoebus.framework.macros.Macros;
+import org.phoebus.ui.application.ResourceOpenedNotifierService;
 
 /** Action Helper
  *  @author Kay Kasemir

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DisplayNavigation.java

@@ -13,6 +13,7 @@
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.stream.Collectors;
 
+import org.phoebus.ui.application.ResourceOpenedNotifierService;
 import org.phoebus.ui.undo.SizeLimitedStack;
 
 /** Navigate backward/forward between displays
@@ -99,6 +100,7 @@ public DisplayInfo goBackward(int count)
             if (current != null)
                 forwardStack.push(current);
             current = backwardStack.pop();
+            ResourceOpenedNotifierService.notifyListeners(current.getPath(), "BackButton");
         }
         notifyListeners();
         return current;
@@ -115,6 +117,7 @@ public DisplayInfo goForward(int count)
             if (current != null)
                 backwardStack.push(current);
             current = forwardStack.pop();
+            ResourceOpenedNotifierService.notifyListeners(current.getPath(), "ForwardButton");
         }
         notifyListeners();
         return current;

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DisplayRuntimeInstance.java

@@ -35,6 +35,7 @@
 import org.phoebus.framework.persistence.Memento;
 import org.phoebus.framework.spi.AppDescriptor;
 import org.phoebus.framework.spi.AppInstance;
+import org.phoebus.ui.application.ResourceOpenedNotifierService;
 import org.phoebus.ui.dialog.ExceptionDetailsErrorDialog;
 import org.phoebus.ui.docking.DockItem;
 import org.phoebus.ui.docking.DockItemWithInput;
@@ -67,6 +68,7 @@ public class DisplayRuntimeInstance implements AppInstance
     /** Memento tags */
     private static final String TAG_ZOOM = "ZOOM";
     private static final String TAG_TOOLBAR = "toolbar";
+    private static final String RESTORED = "restored";
 
     /** Global tracker of last user's decision to show toolbar.
      *  Used when opening new display
@@ -237,6 +239,7 @@ public void restore(final Memento memento)
             zoom_action.getOnAction().handle(null);
         });
         memento.getBoolean(TAG_TOOLBAR).ifPresent(this::showToolbar);
+        ResourceOpenedNotifierService.notifyListeners(dock_item.getInput().toString(), RESTORED);
     }
 
     @Override

app/filebrowser/src/main/java/org/phoebus/applications/filebrowser/FileBrowserController.java

@@ -34,6 +34,7 @@
 import org.phoebus.ui.application.ApplicationLauncherService;
 import org.phoebus.ui.application.ContextMenuService;
 import org.phoebus.ui.application.PhoebusApplication;
+import org.phoebus.ui.application.ResourceOpenedNotifierService;
 import org.phoebus.ui.dialog.DialogHelper;
 import org.phoebus.ui.javafx.ImageCache;
 import org.phoebus.ui.spi.ContextMenuEntry;
@@ -179,14 +180,17 @@ private void assertTreeDoesntContain(final TreeItem<FileInfo> item, final Path f
     }
 
     /**
-     * Try to open resource, show error dialog on failure
+     * Try to open resource, tell listeners on success, show error dialog on failure
      *
      * @param file  Resource to open
      * @param stage Stage to use to prompt for specific app.
      *              Otherwise <code>null</code> to use default app.
      */
     private void openResource(final File file, final Stage stage) {
-        if (!ApplicationLauncherService.openFile(file, stage != null, stage)) {
+        if (ApplicationLauncherService.openFile(file, stage != null, stage)) {
+            Platform.runLater(() -> ResourceOpenedNotifierService.notifyListeners(file.getAbsolutePath(), FileBrowserApp.Name));
+        }
+        else{
             final Alert alert = new Alert(AlertType.ERROR);
             alert.setHeaderText(Messages.OpenAlert1 + file + Messages.OpenAlert2);
             DialogHelper.positionDialog(alert, treeView, -300, -200);

app/ux-analytics/monitor/pom.xml

@@ -69,6 +69,12 @@
             <version>4.7.4-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.phoebus</groupId>
+            <artifactId>app-filebrowser</artifactId>
+            <version>4.7.4-SNAPSHOT</version>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>

core/ui/src/main/java/org/phoebus/ui/application/PhoebusApplication.java

@@ -885,7 +885,10 @@ private void createTopResourcesMenu() {
                 final URI resource = tops.getResource(i);
 
                 menu_items[i] = new MenuItem(description);
-                menu_items[i].setOnAction(event -> openResource(resource, false));
+                menu_items[i].setOnAction(event -> {
+                    openResource(resource, false);
+                    ResourceOpenedNotifierService.notifyListeners(resource.getPath(),"TopResources");
+                });
 
                 toolbar_items[i] = new MenuItem(description);
                 toolbar_items[i].setOnAction(event -> openResource(resource, false));

core/ui/src/main/java/org/phoebus/ui/application/ResourceOpenedListener.java

@@ -0,0 +1,7 @@
+package org.phoebus.ui.application;
+
+public interface ResourceOpenedListener {
+
+    public void notifyResourceOpened(String resourceName, String fromWho);
+
+}

core/ui/src/main/java/org/phoebus/ui/application/ResourceOpenedNotifierService.java

@@ -0,0 +1,25 @@
+package org.phoebus.ui.application;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.List;
+
+public class ResourceOpenedNotifierService {
+
+    static final List<ResourceOpenedListener> listeners = new ArrayList<>();
+
+    public static void addListener(ResourceOpenedListener listener) {
+        listeners.add(listener);
+    }
+
+    public static void removeListener(ResourceOpenedListener listener) {
+        listeners.remove(listener);
+    }
+
+    public static void notifyListeners(String resourceName, String fromWho) {
+        for (ResourceOpenedListener listener : listeners) {
+            listener.notifyResourceOpened(resourceName, fromWho);
+        }
+    }
+
+}