Use weak references to UIs and regular clean-up
[gpl/argeo-suite.git] / swt / org.argeo.app.swt / src / org / argeo / app / swt / ux / SwtArgeoApp.java
index 6d2dfcedbedaec9f072587020185287ff666bad7..ef3bb8c330e1018de0b63c29cafa10124e9662d0 100644 (file)
@@ -2,6 +2,7 @@ package org.argeo.app.swt.ux;
 
 import static org.argeo.api.cms.ux.CmsView.CMS_VIEW_UID_PROPERTY;
 
+import java.lang.ref.WeakReference;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -10,6 +11,8 @@ import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
+import java.util.Timer;
+import java.util.TimerTask;
 import java.util.TreeMap;
 import java.util.TreeSet;
 
@@ -36,7 +39,6 @@ import org.argeo.app.ux.AppUi;
 import org.argeo.app.ux.SuiteUxEvent;
 import org.argeo.cms.LocaleUtils;
 import org.argeo.cms.Localized;
-import org.argeo.cms.acr.ContentUtils;
 import org.argeo.cms.swt.CmsSwtUtils;
 import org.argeo.cms.swt.acr.SwtUiProvider;
 import org.argeo.cms.swt.dialogs.CmsFeedback;
@@ -44,6 +46,8 @@ import org.argeo.cms.util.LangUtils;
 import org.argeo.cms.ux.CmsUxUtils;
 import org.argeo.eclipse.ui.specific.UiContext;
 import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.DisposeEvent;
+import org.eclipse.swt.events.DisposeListener;
 import org.eclipse.swt.widgets.Composite;
 import org.osgi.framework.Constants;
 
@@ -62,6 +66,7 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
 
        private String publicBasePath = null;
 
+       private String appPid;
        private String pidPrefix;
        private String sharedPidPrefix;
 
@@ -89,7 +94,8 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
 //     private CmsUserManager cmsUserManager;
 
        // TODO make more optimal or via CmsSession/CmsView
-       private Map<String, SwtAppUi> managedUis = new HashMap<>();
+       private static Timer janitorTimer = new Timer(true);
+       private Map<String, WeakReference<SwtAppUi>> managedUis = new HashMap<>();
 
        // ACR
        private ContentRepository contentRepository;
@@ -102,9 +108,6 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                        getCmsContext().getCmsEventBus().addEventSubscriber(event.topic(), this);
                }
 
-               if (log.isDebugEnabled())
-                       log.info("Argeo Suite App started");
-
                if (properties.containsKey(DEFAULT_UI_NAME_PROPERTY))
                        defaultUiName = LangUtils.get(properties, DEFAULT_UI_NAME_PROPERTY);
                if (properties.containsKey(DEFAULT_THEME_ID_PROPERTY))
@@ -115,28 +118,49 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                publicBasePath = LangUtils.get(properties, PUBLIC_BASE_PATH_PROPERTY);
 
                if (properties.containsKey(Constants.SERVICE_PID)) {
-                       String servicePid = properties.get(Constants.SERVICE_PID).toString();
-                       int lastDotIndex = servicePid.lastIndexOf('.');
+                       appPid = properties.get(Constants.SERVICE_PID).toString();
+                       int lastDotIndex = appPid.lastIndexOf('.');
                        if (lastDotIndex >= 0) {
-                               pidPrefix = servicePid.substring(0, lastDotIndex);
+                               pidPrefix = appPid.substring(0, lastDotIndex);
                        }
+               } else {
+                       // TODO does it make sense to accept that?
+                       appPid = "<unknown>";
                }
+               if (log.isDebugEnabled())
+                       log.info("Argeo Suite App " + appPid + " started");
+
+               Objects.requireNonNull(contentRepository, "Content repository must be provided");
+               Objects.requireNonNull(appUserState, "App user state must be provided");
+               
+               long janitorPeriod = 12 * 60 * 60 * 1000;// 12h
+               janitorTimer.schedule(new TimerTask() {
+
+                       @Override
+                       public void run() {
+                               refs: for (WeakReference<SwtAppUi> uiRef : managedUis.values()) {
+                                       SwtAppUi ui = uiRef.get();
+                                       if (ui == null)
+                                               continue refs;
+                                       ui.disposeIfTimedout();
+                               }
+                               if (log.isDebugEnabled())
+                                       log.debug(managedUis.size() + " UIs being managed by app " + appPid);
+                       }
+               }, janitorPeriod, janitorPeriod);
 
-//             if (pidPrefix == null)
-//                     throw new IllegalArgumentException("PID prefix must be set.");
-
-//             headerPid = pidPrefix + "header";
-//             footerPid = pidPrefix + "footer";
-//             leadPanePid = pidPrefix + "leadPane";
-//             adminLeadPanePid = pidPrefix + "adminLeadPane";
-//             loginScreenPid = pidPrefix + "loginScreen";
        }
 
        public void stop(Map<String, Object> properties) {
-               for (SwtAppUi ui : managedUis.values())
-                       if (!ui.isDisposed()) {
+               refs: for (WeakReference<SwtAppUi> uiRef : managedUis.values()) {
+                       SwtAppUi ui = uiRef.get();
+                       if (ui == null)
+                               continue refs;
+                       if (!ui.isDisposed() && !ui.getDisplay().isDisposed()) {
                                ui.getDisplay().syncExec(() -> ui.dispose());
                        }
+               }
+               managedUis.clear();
                if (log.isDebugEnabled())
                        log.info("Argeo Suite App stopped");
 
@@ -162,13 +186,11 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                if (theme != null)
                        CmsSwtUtils.registerCmsTheme(uiParent.getShell(), theme);
                SwtAppUi argeoSuiteUi = new SwtAppUi(uiParent, SWT.INHERIT_DEFAULT);
+               // TODO make timeout configurable
+               argeoSuiteUi.setUiTimeout(12 * 60 * 60 * 1000);// 12 hours
                String uid = cmsView.getUid();
-               managedUis.put(uid, argeoSuiteUi);
-               argeoSuiteUi.addDisposeListener((e) -> {
-                       managedUis.remove(uid);
-                       if (log.isDebugEnabled())
-                               log.debug("Suite UI " + uid + " has been disposed.");
-               });
+               argeoSuiteUi.addDisposeListener(new CleanUpUi(uid));
+               managedUis.put(uid, new WeakReference<>(argeoSuiteUi));
                return argeoSuiteUi;
        }
 
@@ -185,6 +207,7 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                try {
                        Content context = null;
                        SwtAppUi ui = (SwtAppUi) cmsUi;
+                       ui.updateLastAccess();
 
                        String uiName = Objects.toString(ui.getParent().getData(UI_NAME_PROPERTY), null);
                        if (uiName == null)
@@ -232,10 +255,10 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                                        if (cmsSession == null || cmsView.isAnonymous()) {
                                                assert publicBasePath != null;
                                                Content userDir = contentSession
-                                                               .get(ContentUtils.SLASH + CmsConstants.SYS_WORKSPACE + publicBasePath);
+                                                               .get(Content.ROOT_PATH + CmsConstants.SYS_WORKSPACE + publicBasePath);
                                                ui.setUserDir(userDir);
                                        } else {
-                                               Content userDir = appUserState.getOrCreateSessionDir(contentSession, cmsSession);
+                                               Content userDir = appUserState.getOrCreateSessionDir(cmsSession);
                                                ui.setUserDir(userDir);
 //                                             Node userDirNode = jcrContentProvider.doInAdminSession((adminSession) -> {
 //                                                     Node node = SuiteUtils.getOrCreateCmsSessionNode(adminSession, cmsSession);
@@ -452,7 +475,7 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
        }
 
        // TODO move it to an internal package?
-       public static String nodeToState(Content node) {
+       private static String nodeToState(Content node) {
                return node.getPath();
        }
 
@@ -480,11 +503,12 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                SwtAppUi ui = getRelatedUi(event);
                if (ui == null)
                        return;
+               ui.updateLastAccess();
                ui.getCmsView().runAs(() -> {
                        try {
                                String appTitle = "";
                                if (ui.getTitle() != null)
-                                       appTitle = ui.getTitle().lead() + " - ";
+                                       appTitle = ui.getTitle().lead();
 
                                if (isTopic(topic, SuiteUxEvent.refreshPart)) {
                                        Content node = getContentFromEvent(ui, event);
@@ -494,7 +518,7 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                                        SwtAppLayer layer = findByType(layersByType, node);
                                        ui.switchToLayer(layer, node);
                                        layer.view(uiProvider, ui.getCurrentWorkArea(), node);
-                                       ui.getCmsView().stateChanged(nodeToState(node), appTitle + CmsUxUtils.getTitle(node));
+                                       ui.getCmsView().stateChanged(nodeToState(node), stateTitle(appTitle, CmsUxUtils.getTitle(node)));
                                } else if (isTopic(topic, SuiteUxEvent.openNewPart)) {
                                        Content node = getContentFromEvent(ui, event);
                                        if (node == null)
@@ -503,7 +527,7 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                                        SwtAppLayer layer = findByType(layersByType, node);
                                        ui.switchToLayer(layer, node);
                                        layer.open(uiProvider, ui.getCurrentWorkArea(), node);
-                                       ui.getCmsView().stateChanged(nodeToState(node), appTitle + CmsUxUtils.getTitle(node));
+                                       ui.getCmsView().stateChanged(nodeToState(node), stateTitle(appTitle, CmsUxUtils.getTitle(node)));
                                } else if (isTopic(topic, SuiteUxEvent.switchLayer)) {
                                        String layerId = get(event, SuiteUxEvent.LAYER);
                                        if (layerId != null) {
@@ -520,17 +544,17 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                                                if (nodeFromState != null && nodeFromState.getPath().equals(ui.getUserDir().getPath())) {
                                                        // default layer view is forced
                                                        String state = defaultLayerPid.equals(layerId) ? "~" : layerId;
-                                                       ui.getCmsView().stateChanged(state, appTitle + title);
+                                                       ui.getCmsView().stateChanged(state, stateTitle(appTitle, title));
                                                        suiteLayer.view(null, workArea, nodeFromState);
                                                } else {
                                                        Content layerCurrentContext = suiteLayer.getCurrentContext(workArea);
                                                        if (layerCurrentContext != null && !layerCurrentContext.equals(ui.getUserDir())) {
                                                                // layer was already showing a context so we set the state to it
                                                                ui.getCmsView().stateChanged(nodeToState(layerCurrentContext),
-                                                                               appTitle + CmsUxUtils.getTitle(layerCurrentContext));
+                                                                               stateTitle(appTitle, CmsUxUtils.getTitle(layerCurrentContext)));
                                                        } else {
                                                                // no context was shown
-                                                               ui.getCmsView().stateChanged(layerId, appTitle + title);
+                                                               ui.getCmsView().stateChanged(layerId, stateTitle(appTitle, title));
                                                        }
                                                }
                                        } else {
@@ -548,6 +572,10 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                });
        }
 
+       private String stateTitle(String appTitle, String additionalTitle) {
+               return additionalTitle == null ? appTitle : appTitle + " - " + additionalTitle;
+       }
+
        private boolean isTopic(String topic, CmsEvent cmsEvent) {
                Objects.requireNonNull(topic);
                return topic.equals(cmsEvent.topic());
@@ -579,7 +607,10 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
        }
 
        private SwtAppUi getRelatedUi(Map<String, Object> eventProperties) {
-               return managedUis.get(get(eventProperties, CMS_VIEW_UID_PROPERTY));
+               WeakReference<SwtAppUi> uiRef = managedUis.get(get(eventProperties, CMS_VIEW_UID_PROPERTY));
+               if (uiRef == null)
+                       return null;
+               return uiRef.get();
        }
 
        public static String get(Map<String, Object> eventProperties, String key) {
@@ -661,14 +692,6 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                }
        }
 
-//     public void setCmsUserManager(CmsUserManager cmsUserManager) {
-//             this.cmsUserManager = cmsUserManager;
-//     }
-
-//     protected ContentRepository getContentRepository() {
-//             return contentRepository;
-//     }
-
        public void setContentRepository(ContentRepository contentRepository) {
                this.contentRepository = contentRepository;
        }
@@ -677,4 +700,26 @@ public class SwtArgeoApp extends AbstractArgeoApp implements CmsEventSubscriber
                this.appUserState = appUserState;
        }
 
+       /**
+        * Dedicated class to clean up the UI in order to avoid illegal access issues
+        * with lambdas.
+        */
+       private class CleanUpUi implements DisposeListener {
+               private static final long serialVersionUID = 1905900302262082463L;
+               final String uid;
+
+               public CleanUpUi(String uid) {
+                       this.uid = uid;
+               }
+
+               @Override
+               public void widgetDisposed(DisposeEvent e) {
+                       managedUis.remove(uid);
+                       if (log.isDebugEnabled())
+                               log.debug("App " + appPid + " - Suite UI " + uid + " has been disposed (" + managedUis.size()
+                                               + " UIs still being managed).");
+               }
+
+       }
+
 }