]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics/src/org/simantics/SimanticsPlatform.java
SimanticsPlatform.startUp ensures updateness of installed feature groups
[simantics/platform.git] / bundles / org.simantics / src / org / simantics / SimanticsPlatform.java
index 961dfc71899d8a872d8941dda396f95a8ab2f0ca..54b96054719e993986a7ab6ad2e938b67fc0e430 100644 (file)
@@ -49,8 +49,6 @@ import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.osgi.service.resolver.BundleDescription;
 import org.ini4j.Ini;
 import org.ini4j.InvalidFileFormatException;
-import org.simantics.SimanticsPlatform.OntologyRecoveryPolicy;
-import org.simantics.SimanticsPlatform.RecoveryPolicy;
 import org.simantics.databoard.Bindings;
 import org.simantics.databoard.Databoard;
 import org.simantics.datatypes.literal.Font;
@@ -81,6 +79,7 @@ import org.simantics.db.layer0.util.TGTransferableGraphSource;
 import org.simantics.db.layer0.variable.VariableRepository;
 import org.simantics.db.management.SessionContext;
 import org.simantics.db.request.Read;
+import org.simantics.db.request.Write;
 import org.simantics.db.service.LifecycleSupport.LifecycleListener;
 import org.simantics.db.service.LifecycleSupport.LifecycleState;
 import org.simantics.db.service.QueryControl;
@@ -194,6 +193,19 @@ public class SimanticsPlatform implements LifecycleListener {
 
     public Thread mainThread;
 
+    private Thread shutdownHook = new Thread() {
+        @Override
+        public void run() {
+            try {
+                LOGGER.warn("Simantics platform was not properly shut down. Executing safety shutdown hook.");
+                shutdown(null, false);
+            } catch (PlatformException e) {
+                LOGGER.error("Simantics Platform shutdown hook execution failed.", e);
+                log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Simantics Platform shutdown hook execution failed.", e));
+            }
+        }
+    };
+
     /**
      * The {@link IProject} activated by
      * {@link #startUp(IProgressMonitor, RecoveryPolicy, OntologyRecoveryPolicy, ServerAddress, PlatformUserAgent)}
@@ -386,21 +398,18 @@ public class SimanticsPlatform implements LifecycleListener {
                         }
                         throw new PlatformException(sb.toString());
                     }
-                    
+
                     List<GraphBundle> sortedBundles = analyzer.getSortedGraphs();
                     if(!sortedBundles.isEmpty()) {
-                       
-                        session.syncRequest(new WriteRequest() {
-                            @Override
-                            public void perform(WriteGraph graph) throws DatabaseException {
-                                try {
-                                    graph.newClusterSet(graph.getRootLibrary());
-                                } catch (ClusterSetExistException e) {
-                                    // Cluster set exist already, no problem.
-                                }
-                                graph.setClusterSet4NewResource(graph.getRootLibrary());
-                                graph.flushCluster();
+
+                        session.syncRequest((Write) graph -> {
+                            try {
+                                graph.newClusterSet(graph.getRootLibrary());
+                            } catch (ClusterSetExistException e) {
+                                // Cluster set exist already, no problem.
                             }
+                            graph.setClusterSet4NewResource(graph.getRootLibrary());
+                            graph.flushCluster();
                         });
 
                         boolean mergedOntologies = false;
@@ -458,13 +467,10 @@ public class SimanticsPlatform implements LifecycleListener {
                                        }
                                }
                         }
-                        
-                        session.syncRequest(new WriteRequest() {
-                            @Override
-                            public void perform(WriteGraph graph) throws DatabaseException {
-                                graph.setClusterSet4NewResource(graph.getRootLibrary());
-                                graph.flushCluster();
-                            }
+
+                        session.syncRequest((Write) graph -> {
+                            graph.setClusterSet4NewResource(graph.getRootLibrary());
+                            graph.flushCluster();
                         });
 
                         if (mergedOntologies)
@@ -570,38 +576,11 @@ public class SimanticsPlatform implements LifecycleListener {
             Set<GroupReference> publishedFeatureGroups = ProjectFeatures.getInstallGroupsOfPublishedFeatures();
             Collection<GroupReference> groupsWithoutVersion = GroupReference.stripVersions(publishedFeatureGroups);
 
-    //        final List<String> Platform_Features = new ArrayList<String>();
-    //
-    //        // Convert graph instances
-    //        Collection<TransferableGraph1> platformGraphs = new ArrayList<TransferableGraph1>();
-    //        for (GraphBundleEx e : platformTGs.values()) platformGraphs.add( e.getGraph() );
-    //        IGraph graph = Graphs.createGraph(platformGraphs);
-    //
-    //        Res    PublishedProjectFeatures = UriUtils.uriToPath( ProjectResource.URIs.PublishedProjectFeatures );
-    //        Path   HasFeature = UriUtils.uriToPath( ProjectResource.URIs.HasFeature );
-    //        for(Res feature : graph.getObjects(PublishedProjectFeatures, HasFeature)) {
-    //            System.out.println("Installing Project Feature: "+feature.toString());
-    //            Platform_Features.add( feature.toString() );
-    //        }
-
             try {
-                Transaction.startTransaction(session, true);
-                try {
-    //                for (String feature : Platform_Features) {
-    //                    try {
-    //                        getResource(feature);
-    //                    } catch(ResourceNotFoundException e) {
-    //                        System.out.println(feature+" not found");
-    //                    }
-    //                    mgmt.installFeature(projectResource, feature);
-    //                }
-                    Projects.setProjectInstalledGroups(writeGraph(), projectResource, groupsWithoutVersion);
-                    Transaction.commit();
-                } finally {
-                    Transaction.endTransaction();
-                }
-                //session.getService( LifecycleSupport.class ).save();
-            } catch(DatabaseException ae) {
+                session.syncRequest(
+                        (Write) graph ->
+                        Projects.setProjectInstalledGroups(graph, projectResource, groupsWithoutVersion));
+            } catch (DatabaseException ae) {
                 throw new PlatformException("Failed to install features", ae);
             }
             progressMonitor.worked(10);
@@ -792,7 +771,8 @@ public class SimanticsPlatform implements LifecycleListener {
      * installing project features.
      * <p>
      *
-     * In SWB this is handled in SimanticsWorkbenchAdvisor#openWindows().
+     * In Simantics Workbench this is handled in
+     * <code>SimanticsWorkbenchAdvisor#openWindows()</code>.
      * <p>
      *
      * If remote server is given, simantics plaform takes connection there
@@ -806,7 +786,7 @@ public class SimanticsPlatform implements LifecycleListener {
      *        startup or <code>null</code> to resort to default measures
      * @throws PlatformException
      */
-    public SessionContext startUp(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy,
+    public synchronized SessionContext startUp(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy,
             OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize, PlatformUserAgent userAgent)
     throws PlatformException
     {
@@ -864,7 +844,7 @@ public class SimanticsPlatform implements LifecycleListener {
         installProject = assertProject(progressMonitor, workspacePolicy, installProject);
 
         // 6. Install all features into project, if in debug mode
-        updateInstalledGroups(progressMonitor, installProject);
+        updateInstalledGroups(progressMonitor, true); //installProject);
         TimeLogger.log("Installed all features into project");
 
         // 7. Assert L0.Session in database for this session
@@ -873,14 +853,9 @@ public class SimanticsPlatform implements LifecycleListener {
         session.getService(XSupport.class).setServiceMode(false, false);
 
         try {
-            session.sync(new WriteRequest() {
-
-                @Override
-                public void perform(WriteGraph graph) throws DatabaseException {
-                    QueryControl qc = graph.getService(QueryControl.class);
-                    qc.flush(graph);
-                }
-
+            session.syncRequest((Write) graph -> {
+                QueryControl qc = graph.getService(QueryControl.class);
+                qc.flush(graph);
             });
             TimeLogger.log("Flushed queries");
         } catch (DatabaseException e) {
@@ -936,6 +911,9 @@ public class SimanticsPlatform implements LifecycleListener {
 
         running = true;
 
+        // #7650: improve shutdown robustness in all applications that use the platform
+        Runtime.getRuntime().addShutdownHook(shutdownHook);
+
         return sessionContext;
 
     }
@@ -955,79 +933,31 @@ public class SimanticsPlatform implements LifecycleListener {
         }
     }
 
-//    private static File getIgnorePrerequisitesFile(URL workspaceUrl) {
-//        if (workspaceUrl == null)
-//            return null;
-//        return new File(workspaceUrl.getPath(), ".ignorePrerequisites");
-//    }
-//
-//    private void ensurePrerequisites(IProgressMonitor progressMonitor, PlatformUserAgent userAgent) throws PlatformException {
-//        Location loc = Platform.getInstanceLocation();
-//        File ignorePrerequisites = getIgnorePrerequisitesFile(loc.getURL());
-//        if (loc.isSet() && ignorePrerequisites != null) {
-//            if (ignorePrerequisites.exists() || ignorePrerequisites.isFile())
-//                return;
-//        }
-//
-//        try {
-//            ServerEnvironment.ensureServerDependenciesMet();
-//        } catch (ExecutionEnvironmentException e) {
-//            // Not installed properly, ask user whether to try installation.
-//            try {
-//                StringBuilder msg = new StringBuilder();
-//                msg.append("Your system seems to be missing the following prerequisites for running this application:\n\n");
-//                for (Product product : e.requiredProducts)
-//                    msg.append("\t" + product.getDescription() + "\n");
-//                msg.append("\nYou can either install the missing components now or ignore and attempt to start the application without them. Ignore Always will ignore this question for this workspace.");
-//                msg.append("\n\nSelecting Cancel will close the application.");
-//
-//                int selection = 0;
-//                if (userAgent != null) {
-//                    selection = userAgent.showPrompt("Missing Prerequisites", msg.toString(), new String[] {
-//                        "Install Pre-requisites",
-//                        "Ignore Now",
-//                        "Ignore Always",
-//                        "Cancel"
-//                    }, selection);
-//                }
-//                boolean tryInstall = false;
-//                switch (selection) {
-//                    case 0:
-//                        tryInstall = true;
-//                        break;
-//                    case 2:
-//                        ignorePrerequisites.createNewFile();
-//                    case 1:
-//                        break;
-//                    case 3:
-//                    case -1:
-//                        throw new CancelStartupException();
-//                }
-//
-//                if (tryInstall) {
-//                    // Try to install it and check for success afterwards.
-//                    ServerEnvironment.tryInstallDependencies(progressMonitor);
-//                    ServerEnvironment.ensureServerDependenciesMet();
-//                }
-//            } catch (InstallException ie) {
-//                throw new PlatformException(ie);
-//            } catch (ExecutionEnvironmentException eee) {
-//                throw new PlatformException(eee);
-//            } catch (IOException ie) {
-//                throw new PlatformException(ie);
-//            }
-//        }
-//    }
+    /**
+     * Perform normal shutdown for the Simantics Platform.
+     *
+     * @param progressMonitor optional progress monitor
+     * @throws PlatformException
+     * @see {@link #shutdown(IProgressMonitor, boolean)}
+     */
+    public synchronized void shutdown(IProgressMonitor progressMonitor) throws PlatformException {
+        shutdown(progressMonitor, true);
+    }
 
     /**
      * Shutdown Simantics Platform.
      *
-     * In SWB this is handled in SimanticsWorkbenchAdvisor#disconnectFromWorkspace.
+     * In Simantics Workbench this is handled in
+     * <code>SimanticsWorkbenchAdvisor#disconnectFromWorkspace</code>.
      *
-     * @param progressMonitor optional progress monitor
+     * @param progressMonitor
+     *            optional progress monitor
+     * @param clearTemporaryFiles
+     *            allow or prevent deletion of temporary files at the end of the
+     *            shutdown procedure
      * @throws PlatformException
      */
-    public void shutdown(IProgressMonitor progressMonitor) throws PlatformException
+    public synchronized void shutdown(IProgressMonitor progressMonitor, boolean clearTemporaryFiles) throws PlatformException
     {
         SubMonitor progress = SubMonitor.convert(progressMonitor, 100);
         PlatformException platformException = null;
@@ -1096,15 +1026,20 @@ public class SimanticsPlatform implements LifecycleListener {
         }
         progress.worked(10);
 
-        progress.subTask("Clearing Workspace Temporary Directory");
-        try {
-            Simantics.clearTemporaryDirectory();
-        } catch (Throwable t) {
-            LOGGER.error("Failed to clear the temporary directory.", t);
+        if (clearTemporaryFiles) {
+            progress.subTask("Clearing Workspace Temporary Directory");
+            try {
+                Simantics.clearTemporaryDirectory();
+            } catch (Throwable t) {
+                LOGGER.error("Failed to clear the temporary directory.", t);
+            }
         }
         progress.worked(10);
         if (null != platformException)
             throw platformException;
+
+        // #7650: improve shutdown robustness in all applications that use the platform
+        Runtime.getRuntime().removeShutdownHook(shutdownHook);
     }
 
     // TODO: consider removing this in the future ??