1 /*******************************************************************************
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics;
14 import static org.simantics.db.common.utils.Transaction.commit;
15 import static org.simantics.db.common.utils.Transaction.endTransaction;
16 import static org.simantics.db.common.utils.Transaction.readGraph;
17 import static org.simantics.db.common.utils.Transaction.startTransaction;
18 import static org.simantics.db.common.utils.Transaction.writeGraph;
21 import java.io.IOException;
22 import java.nio.file.Files;
23 import java.nio.file.Path;
24 import java.nio.file.Paths;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.HashMap;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import java.util.Properties;
33 import java.util.TreeMap;
34 import java.util.UUID;
36 import org.eclipse.core.runtime.ILog;
37 import org.eclipse.core.runtime.IProduct;
38 import org.eclipse.core.runtime.IProgressMonitor;
39 import org.eclipse.core.runtime.IStatus;
40 import org.eclipse.core.runtime.NullProgressMonitor;
41 import org.eclipse.core.runtime.Platform;
42 import org.eclipse.core.runtime.Status;
43 import org.eclipse.core.runtime.SubMonitor;
44 import org.eclipse.osgi.service.datalocation.Location;
45 import org.eclipse.osgi.service.resolver.BundleDescription;
47 import org.ini4j.InvalidFileFormatException;
48 import org.simantics.databoard.Bindings;
49 import org.simantics.databoard.Databoard;
50 import org.simantics.datatypes.literal.Font;
51 import org.simantics.datatypes.literal.RGB;
52 import org.simantics.db.Driver;
53 import org.simantics.db.Driver.Management;
54 import org.simantics.db.Manager;
55 import org.simantics.db.ReadGraph;
56 import org.simantics.db.Resource;
57 import org.simantics.db.Session;
58 import org.simantics.db.SessionModel;
59 import org.simantics.db.UndoContext;
60 import org.simantics.db.VirtualGraph;
61 import org.simantics.db.WriteGraph;
62 import org.simantics.db.common.request.ObjectsWithType;
63 import org.simantics.db.common.request.Queries;
64 import org.simantics.db.common.request.WriteResultRequest;
65 import org.simantics.db.common.utils.Transaction;
66 import org.simantics.db.exception.ClusterSetExistException;
67 import org.simantics.db.exception.DatabaseException;
68 import org.simantics.db.exception.ResourceNotFoundException;
69 import org.simantics.db.indexing.DatabaseIndexing;
70 import org.simantics.db.layer0.genericrelation.DependenciesRelation;
71 import org.simantics.db.layer0.genericrelation.IndexException;
72 import org.simantics.db.layer0.genericrelation.IndexedRelations;
73 import org.simantics.db.layer0.util.SimanticsClipboardImpl;
74 import org.simantics.db.layer0.util.SimanticsKeys;
75 import org.simantics.db.layer0.util.TGTransferableGraphSource;
76 import org.simantics.db.layer0.variable.VariableRepository;
77 import org.simantics.db.management.SessionContext;
78 import org.simantics.db.request.Read;
79 import org.simantics.db.request.Write;
80 import org.simantics.db.service.LifecycleSupport.LifecycleListener;
81 import org.simantics.db.service.LifecycleSupport.LifecycleState;
82 import org.simantics.db.service.QueryControl;
83 import org.simantics.db.service.UndoRedoSupport;
84 import org.simantics.db.service.VirtualGraphSupport;
85 import org.simantics.db.service.XSupport;
86 import org.simantics.graph.db.GraphDependencyAnalyzer;
87 import org.simantics.graph.db.GraphDependencyAnalyzer.IU;
88 import org.simantics.graph.db.GraphDependencyAnalyzer.IdentityNode;
89 import org.simantics.graph.db.IImportAdvisor;
90 import org.simantics.graph.db.ImportResult;
91 import org.simantics.graph.db.TransferableGraphs;
92 import org.simantics.graph.diff.Diff;
93 import org.simantics.graph.diff.TransferableGraphDelta1;
94 import org.simantics.internal.Activator;
95 import org.simantics.internal.startup.StartupExtensions;
96 import org.simantics.layer0.Layer0;
97 import org.simantics.operation.Layer0X;
98 import org.simantics.project.IProject;
99 import org.simantics.project.ProjectFeatures;
100 import org.simantics.project.ProjectKeys;
101 import org.simantics.project.Projects;
102 import org.simantics.project.SessionDescriptor;
103 import org.simantics.project.exception.ProjectException;
104 import org.simantics.project.features.registry.GroupReference;
105 import org.simantics.project.management.DatabaseManagement;
106 import org.simantics.project.management.GraphBundle;
107 import org.simantics.project.management.GraphBundleEx;
108 import org.simantics.project.management.GraphBundleRef;
109 import org.simantics.project.management.PlatformUtil;
110 import org.simantics.project.management.ServerManager;
111 import org.simantics.project.management.ServerManagerFactory;
112 import org.simantics.project.management.WorkspaceUtil;
113 import org.simantics.utils.FileUtils;
114 import org.simantics.utils.datastructures.Pair;
115 import org.simantics.utils.logging.TimeLogger;
116 import org.simantics.utils.strings.EString;
117 import org.slf4j.Logger;
118 import org.slf4j.LoggerFactory;
121 * SimanticsPlatform performs procedures required in order to get simantics
122 * workbench into operational state. This consists of the following steps:
124 * <li> Asserting there is Database
126 * <li> Starting Database process
128 * <li> Opening a session to Database process
130 * <li> Asserting required ontologies or other transferable graphs are installed in the database
132 * <li> Asserting required project is installed in the database
134 * <li> Asserting Simantics Features are installed in the database
136 * <li> Asserting Simantics Features are installed to the project
138 * <li> Shutdown: Save Session, Close session, Kill Database process
142 * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
144 public class SimanticsPlatform implements LifecycleListener {
146 private static final Logger LOGGER = LoggerFactory.getLogger(SimanticsPlatform.class);
149 * The policy is relevant when developing Simantics from Eclipse IDE.
150 * It is applied when the ontology in the database of a workspace doesn't match
151 * a newer ontology in the Eclipse workspace.
153 public static enum OntologyRecoveryPolicy { ThrowError, Merge, ReinstallDatabase }
156 * This policy dictates how the Simantics platform startup should react if
157 * the started workspace is not set up properly. The alternatives are to
158 * just throw an error and fail or to attempt all possible measures to fix
159 * the encountered problems.
161 public static enum RecoveryPolicy { ThrowError, FixError }
163 /** Singleton instance, started in SimanticsWorkbenchAdvisor */
164 public static final SimanticsPlatform INSTANCE = new SimanticsPlatform();
166 /** Set to true when the Simantics Platform is in good-and-go condition */
167 public boolean running;
169 /** ID of the database driver that the platform is currently using */
170 private String currentDatabaseDriver;
172 /** Database Session */
173 public Session session;
174 private Management databasebManagement;
176 /** Database session context */
177 public SessionContext sessionContext;
179 /** Project identifier in Database */
180 public String projectURI;
183 public String projectName;
185 /** Project resource */
186 public Resource projectResource;
188 /** Session specific bindings */
189 public SimanticsBindings simanticsBindings;
191 public Thread mainThread;
193 private Thread shutdownHook = new Thread() {
197 LOGGER.warn("Simantics platform was not properly shut down. Executing safety shutdown hook.");
198 shutdown(null, false);
199 } catch (PlatformException e) {
200 LOGGER.error("Simantics Platform shutdown hook execution failed.", e);
201 log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Simantics Platform shutdown hook execution failed.", e));
207 * The {@link IProject} activated by
208 * {@link #startUp(IProgressMonitor, RecoveryPolicy, OntologyRecoveryPolicy, ServerAddress, PlatformUserAgent)}
210 private IProject project;
215 * Create a new simantics plaform manager in uninitialized state and
216 * with default policies. <p>
218 public SimanticsPlatform() {
219 log = Platform.getLog(Activator.getBundleContext().getBundle());
220 mainThread = Thread.currentThread();
223 public String getApplicationClientId() {
224 IProduct product = Platform.getProduct();
225 if(product == null) return "noProduct";//UUID.randomUUID().toString();
226 String application = product.getApplication();
227 return application != null ? application : UUID.randomUUID().toString();
230 private SessionDescriptor setupDatabase(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy, PlatformUserAgent userAgent) throws PlatformException {
231 if (progressMonitor == null)
232 progressMonitor = new NullProgressMonitor();
233 Path workspaceLocation = Platform.getLocation().toFile().toPath();
234 Path dbLocation = workspaceLocation.resolve("db");
235 Path dbIniPath = workspaceLocation.resolve("db.ini");
236 // The driver file overrides any command line arguments to prevent
237 // using the wrong driver for an existing database directory.
238 ServerManager serverManager;
240 Ini dbIni = loadOrCreateDatabaseIni(dbIniPath, databaseDriverId);
241 databaseDriverId = dbIni.get("driver", "id");
242 serverManager = ServerManagerFactory.create(databaseDriverId, dbLocation.toAbsolutePath().toString());
243 } catch (DatabaseException | IOException e) {
244 throw new PlatformException("Failed to initialize database ServerManager with driver " + databaseDriverId, e);
246 progressMonitor.beginTask("Setting up Simantics Database", 100);
247 progressMonitor.setTaskName("Asserting Database is installed.");
248 String msg = "Failed to initialize Simantics database.";
251 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Initializing database at " + dbLocation + " with driver " + databaseDriverId));
252 progressMonitor.setTaskName("Creating database at " + dbLocation);
253 databasebManagement = serverManager.getManagement(dbLocation.toFile());
254 databasebManagement.create();
255 currentDatabaseDriver = databaseDriverId;
257 return serverManager.createDatabase(dbLocation.toFile());
258 } catch (DatabaseException e) {
259 throw new PlatformException(msg, e);
260 } catch (Throwable e) {
261 throw new PlatformException(msg, e);
263 progressMonitor.worked(20);
267 public void synchronizeOntologies(IProgressMonitor progressMonitor, OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize) throws PlatformException {
269 SubMonitor monitor = SubMonitor.convert(progressMonitor, 100);
271 monitor.setTaskName("Compile dynamic ontologies");
272 PlatformUtil.compileAllDynamicOntologies();
274 String message = "Asserting all ontologies are installed";
275 LOGGER.info(message);
276 monitor.setTaskName(message);
278 DatabaseManagement mgmt = new DatabaseManagement();
279 Map<GraphBundleRef, GraphBundleEx> platformTGs = new HashMap<>();
282 // Get a list of bundles installed into the database
283 message = "find installed bundles from database";
284 monitor.subTask(message);
285 LOGGER.info(message);
286 Map<GraphBundleRef, GraphBundleEx> installedTGs = new HashMap<>();
287 for (GraphBundle b : session.syncRequest( mgmt.GraphBundleQuery )) {
288 installedTGs.put(GraphBundleRef.of(b), GraphBundleEx.extend(b));
291 if(!requireSynchronize && installedTGs.size() > 1 && !Platform.inDevelopmentMode()) return;
292 // if(installedTGs.size() > 1) return;
294 // Get a list of all bundles in the platform (Bundle Context)
295 message = "load all transferable graphs from platform";
296 monitor.subTask(message);
297 LOGGER.info(message);
298 Collection<GraphBundle> tgs = PlatformUtil.getAllGraphs();
299 message = "extend bundles to compile versions";
300 monitor.subTask(message);
301 LOGGER.info(message);
302 for (GraphBundle b : tgs) {
303 GraphBundleEx gbe = GraphBundleEx.extend(b);
305 platformTGs.put(GraphBundleRef.of(b), gbe);
308 // Compile a list of TGs that need to be installed or reinstalled in the database
309 message = "check bundle reinstallation demand";
310 monitor.subTask(message);
311 LOGGER.info(message);
312 List<GraphBundleEx> installTGs = new ArrayList<>();
313 // Create list of TGs to update, <newTg, oldTg>
314 Map<GraphBundleEx,GraphBundleEx> reinstallTGs = new TreeMap<>();
315 for (Entry<GraphBundleRef, GraphBundleEx> e : platformTGs.entrySet()) {
316 GraphBundleRef key = e.getKey();
317 GraphBundleEx platformBundle = e.getValue();
318 GraphBundleEx existingBundle = installedTGs.get(key);
320 // System.out.println("GraphBundleRef key=" + key.toString());
322 if (existingBundle == null) {
323 // Bundle did not exist in the database, put it into list of bundles to install
324 installTGs.add(platformBundle);
327 // Bundle exists in the database
328 boolean platformBundleIsNewer = existingBundle.getVersion().compareTo(platformBundle.getVersion())<0;
329 if (!platformBundleIsNewer)
331 // Check hash of transferable graph to know whether to update or not.
332 if (platformBundle.getHashcode() == existingBundle.getHashcode())
334 //System.out.println("Ontology hashcodes do not match: platform bundle="
335 // + platformBundle.getVersionedId() + ", hash=" + platformBundle.getHashcode()
336 // + "; existing bundle=" + existingBundle.getVersionedId() + ", hash=" + existingBundle.getHashcode());
337 reinstallTGs.put(platformBundle, existingBundle);
341 // Database is missing graphs
342 if (!installTGs.isEmpty() || !reinstallTGs.isEmpty()) {
343 session.getService(XSupport.class).setServiceMode(true, true);
346 if (ontologyPolicy == OntologyRecoveryPolicy.ThrowError) {
347 StringBuilder sb = new StringBuilder("The following graphs are not installed in the database: ");
348 if (!installTGs.isEmpty()) {
350 for (GraphBundleEx e : installTGs) {
351 if (i>0) sb.append(", ");
353 sb.append(e.toString());
355 sb.append(" is missing from the database.\n");
357 if (!reinstallTGs.isEmpty()) {
359 for (Entry<GraphBundleEx, GraphBundleEx> e : reinstallTGs.entrySet()) {
360 if (i>0) sb.append(", ");
362 sb.append(e.getKey().toString());
364 sb.append(" Database/Platform Bundle version mismatch.\n");
366 sb.append("Hint: Use -fixErrors to install the graphs.");
367 throw new PlatformException(sb.toString());
369 // Reinstall database
370 if (ontologyPolicy == OntologyRecoveryPolicy.ReinstallDatabase) {
371 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Reinstalling the database."));
380 throw new PlatformException("Reinstalling Database, NOT IMPLEMENTED");
383 if (ontologyPolicy == OntologyRecoveryPolicy.Merge) {
384 message = "Merging ontology changes";
385 monitor.subTask(message);
386 LOGGER.info(message);
387 // Sort missing TGs into install order
388 GraphDependencyAnalyzer<GraphBundle> analyzer = new GraphDependencyAnalyzer<GraphBundle>();
389 for(GraphBundle tg : installTGs) analyzer.addGraph(tg, tg.getGraph());
390 for(GraphBundle tg : reinstallTGs.keySet()) analyzer.addGraph(tg, tg.getGraph());
391 if(!analyzer.analyzeDependency()) {
392 Collection<Pair<GraphBundle, GraphBundle>> problems = analyzer.getConflicts();
393 StringBuilder sb = new StringBuilder();
394 for (Pair<GraphBundle, GraphBundle> problem : problems) {
395 sb.append("Conflict with "+problem.first+" and "+problem.second+".\n");
397 throw new PlatformException(sb.toString());
399 else if(!session.syncRequest( analyzer.queryExternalDependenciesSatisfied )) {
400 Collection<IdentityNode> unsatisfiedDependencies = analyzer.getUnsatisfiedDependencies();
401 StringBuilder sb = new StringBuilder();
402 for (IdentityNode dep: unsatisfiedDependencies) {
403 sb.append("Unsatisfied Dependency "+dep+". Required by\n");
404 for(IU iu : GraphDependencyAnalyzer.toCollection(dep.getRequires())) {
405 sb.append(" " + ((GraphBundle)iu.getId()).getId() + "\n");
408 throw new PlatformException(sb.toString());
411 List<GraphBundle> sortedBundles = analyzer.getSortedGraphs();
412 if(!sortedBundles.isEmpty()) {
414 session.syncRequest((Write) graph -> {
416 graph.newClusterSet(graph.getRootLibrary());
417 } catch (ClusterSetExistException e) {
418 // Cluster set exist already, no problem.
420 graph.setClusterSet4NewResource(graph.getRootLibrary());
421 graph.flushCluster();
424 boolean mergedOntologies = false;
427 for(final GraphBundle tg : sortedBundles) {
429 final IImportAdvisor advisor = new OntologyImportAdvisor(tg, mgmt);
430 final GraphBundle oldTG = reinstallTGs.get(tg);
432 boolean createImmutable = tg.getImmutable();
436 session.getService(XSupport.class).setServiceMode(true, createImmutable);
439 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Installing "+tg.toString()+" - "+tg.getName()));
440 ImportResult result = TransferableGraphs.importGraph1(session, new TGTransferableGraphSource(tg.getGraph()), advisor, null);
441 if (!result.missingExternals.isEmpty()) {
442 log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Import of " + tg.toString() + " was missing the following external entities:\n" + EString.implode(result.missingExternals)));
449 startTransaction(session, false);
450 TransferableGraphDelta1 delta = new Diff(oldTG.getGraph(), tg.getGraph()).diff();
451 final long[] oldResources = oldTG.getResourceArray();
452 boolean changes = TransferableGraphs.hasChanges(readGraph(), oldResources, delta);
455 //log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Nothing to merge for "+tg.toString()));
459 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Merging new version of "+tg.toString()));
461 startTransaction(session, true);
465 long[] resourceArray = TransferableGraphs.applyDelta(writeGraph(), oldResources, delta);
466 tg.setResourceArray(resourceArray);
467 mgmt.setGraphBundleEntry(tg);
469 mergedOntologies = true;
470 } catch (Throwable t) {
471 throw new PlatformException(t);
478 session.syncRequest((Write) graph -> {
479 graph.setClusterSet4NewResource(graph.getRootLibrary());
480 graph.flushCluster();
483 if (mergedOntologies)
484 DatabaseIndexing.deleteAllIndexes();
487 session.getService(XSupport.class).setServiceMode(false, false);
490 } catch (IOException e) {
491 throw new PlatformException(e);
492 } catch (DatabaseException e) {
493 throw new PlatformException(e);
498 public boolean assertConfiguration(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy) throws PlatformException {
500 if (progressMonitor == null) progressMonitor = new NullProgressMonitor();
502 File workspaceLocation = Platform.getLocation().toFile();
504 boolean installProject = false;
505 progressMonitor.setTaskName("Asserting simantics.cfg is installed");
507 File propertyFile = new File(workspaceLocation, "simantics.cfg");
508 Properties properties;
510 properties = WorkspaceUtil.readProperties(propertyFile);
511 } catch (IOException e) {
512 if (workspacePolicy == RecoveryPolicy.ThrowError) throw new PlatformException("Could not load "+propertyFile);
514 // Create a project and write Property file
515 properties = new Properties();
516 properties.setProperty("project_uri", "http://Projects/Development%20Project");
517 properties.setProperty("project_name", "Development Project");
518 WorkspaceUtil.writeProperties(propertyFile, properties);
519 installProject |= true;
521 projectURI = properties.getProperty("project_uri");
522 projectName = properties.getProperty("project_name");
523 progressMonitor.worked(10);
524 } catch (IOException e) {
525 throw new PlatformException(e);
528 return installProject;
532 public boolean assertProject(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy, boolean installProject) throws PlatformException {
534 SubMonitor monitor = SubMonitor.convert(progressMonitor, 10);
536 final DatabaseManagement mgmt = new DatabaseManagement();
538 monitor.setTaskName("Asserting project resource exists in the database");
540 projectResource = session.syncRequest( Queries.resource( projectURI ) );
541 } catch (ResourceNotFoundException nfe) {
542 // Project was not found
543 if (workspacePolicy == RecoveryPolicy.ThrowError)
544 throw new PlatformException("Project Resource "+projectURI+" is not found in the database.");
545 // Create empty project with no features
547 Transaction.startTransaction(session, true);
549 // The project needs to be created mutable.
550 session.getService(XSupport.class).setServiceMode(true, false);
552 ArrayList<String> empty = new ArrayList<String>();
553 projectResource = mgmt.createProject(projectName, empty);
554 installProject |= true;
556 session.getService(XSupport.class).setServiceMode(false, false);
557 Transaction.commit();
559 Transaction.endTransaction();
561 //session.getService( LifecycleSupport.class ).save();
562 } catch (DatabaseException e) {
563 throw new PlatformException("Failed to create "+projectURI, e);
565 } catch (DatabaseException e) {
566 throw new PlatformException("Failed to create "+projectURI, e);
570 return installProject;
574 public void updateInstalledGroups(IProgressMonitor progressMonitor, boolean installProject) throws PlatformException {
578 // Attach all feature groups available in platform to created project
579 progressMonitor.setTaskName("Install all features");
580 Set<GroupReference> publishedFeatureGroups = ProjectFeatures.getInstallGroupsOfPublishedFeatures();
581 Collection<GroupReference> groupsWithoutVersion = GroupReference.stripVersions(publishedFeatureGroups);
586 Projects.setProjectInstalledGroups(graph, projectResource, groupsWithoutVersion));
587 } catch (DatabaseException ae) {
588 throw new PlatformException("Failed to install features", ae);
590 progressMonitor.worked(10);
595 public void assertSessionModel(IProgressMonitor progressMonitor) throws PlatformException {
597 Properties properties = session.getService(Properties.class);
598 final String clientId = properties.getProperty("clientId");
602 // Currently this needs to be done before data becomes available
603 VirtualGraphSupport support = session.getService(VirtualGraphSupport.class);
604 VirtualGraph activations = support.getWorkspacePersistent("activations");
606 Resource sessionModel = session.syncRequest(new Read<Resource>() {
609 public Resource perform(ReadGraph graph) throws DatabaseException {
611 Layer0X L0X = Layer0X.getInstance(graph);
612 for(Resource sessionModel : graph.syncRequest(new ObjectsWithType(graph.getRootLibrary(), L0X.HasSession, L0X.Session))) {
613 String id = graph.getPossibleRelatedValue(sessionModel, L0X.Session_HasClientId);
614 if(id != null && id.equals(clientId)) return sessionModel;
622 if(sessionModel == null) {
624 sessionModel = session.syncRequest(new WriteResultRequest<Resource>(activations) {
627 public Resource perform(WriteGraph graph) throws DatabaseException {
628 Layer0 L0 = Layer0.getInstance(graph);
629 Layer0X L0X = Layer0X.getInstance(graph);
630 Resource session = graph.newResource();
631 graph.claim(session, L0.InstanceOf, null, L0X.Session);
632 graph.claim(session, L0X.Session_HasUser, null, graph.getResource("http://Users/AdminUser"));
633 graph.addLiteral(session, L0X.Session_HasClientId, L0X.Session_HasClientId_Inverse, clientId, Bindings.STRING);
634 graph.claim(graph.getRootLibrary(), L0X.HasSession, session);
641 session.registerService(SessionModel.class, new PlatformSessionModel(sessionModel));
642 } catch (DatabaseException e) {
643 throw new PlatformException(e);
648 static class PlatformSessionModel implements SessionModel {
649 private final Resource sessionModel;
651 public PlatformSessionModel(Resource model) {
652 this.sessionModel = model;
656 public Resource getResource() {
661 public void resetDatabase(IProgressMonitor monitor) throws PlatformException {
662 File dbLocation = Platform.getLocation().append("db").toFile();
663 if(!dbLocation.exists()) return;
665 Driver driver = Manager.getDriver("procore");
666 Management management = driver.getManagement(dbLocation.getAbsolutePath(), null);
668 } catch (DatabaseException e) {
669 throw new PlatformException("Failed to remove database at " + dbLocation.getAbsolutePath(), e);
671 // We have created extra files to database folder which have to be deleted also.
672 // This is an awful idea! Do not create extra files to database folder!
674 for (int i=0; i<10; ++i) {
676 FileUtils.deleteAll(dbLocation);
679 } catch (IOException e) {
680 // Assuming this has been thrown because delete file/folder failed.
685 } catch (InterruptedException e) {
686 // Ignoring interrupted exception.
690 throw new PlatformException("Failed to remove database folder at " + dbLocation.getAbsolutePath(), t);
692 public void resetWorkspace(IProgressMonitor monitor, ArrayList<String> fileFilter) throws PlatformException, IllegalStateException, IOException {
693 File file = Platform.getLocation().toFile();
694 if (null != fileFilter)
695 FileUtils.deleteAllWithFilter(file , fileFilter);
696 resetDatabase(monitor);
699 private static Path tryGetInstallLocation() {
700 Location l = Platform.getInstallLocation();
701 return l == null ? null : new File(l.getURL().getPath()).toPath();
704 private Path resolveBaselineFile() throws PlatformException {
705 String dbBaselineArchive = System.getProperty("org.simantics.db.baseline", null);
706 if (dbBaselineArchive == null)
709 Path baseline = Paths.get(dbBaselineArchive);
710 if (baseline.isAbsolute()) {
711 if (!Files.isRegularFile(baseline))
712 throw new PlatformException("Specified database baseline archive " + baseline
713 + " does not exist. Cannot initialize workspace database from baseline.");
717 // Relative path resolution order:
718 // 1. from the platform "install location"
719 // 2. from working directory
720 Path installLocation = tryGetInstallLocation();
721 if (installLocation != null) {
722 Path installedBaseline = installLocation.resolve(dbBaselineArchive);
723 if (Files.isRegularFile(installedBaseline))
724 return installedBaseline;
726 if (!Files.isRegularFile(baseline))
727 throw new PlatformException("Specified database baseline archive " + baseline
728 + " does not exist in either the install location (" + installLocation
729 + ") or the working directory (" + Paths.get(".").toAbsolutePath()
730 + "). Cannot initialize workspace database.");
734 private boolean handleBaselineDatabase() throws PlatformException {
735 Path workspaceLocation = Platform.getLocation().toFile().toPath();
736 Path baselineIndicatorFile = workspaceLocation.resolve(".baselined");
737 if (Files.isRegularFile(baselineIndicatorFile)) {
738 // This means that the workspace has already been initialized from
739 // a database baseline and further initialization is not necessary.
743 Path baseline = resolveBaselineFile();
744 if (baseline == null)
747 DatabaseBaselines.validateBaselineFile(baseline);
748 DatabaseBaselines.validateWorkspaceForBaselineInitialization(workspaceLocation);
749 DatabaseBaselines.initializeWorkspaceWithBaseline(baseline, workspaceLocation, baselineIndicatorFile);
754 * Start-up the platform. The procedure consists of 8 steps. Once everything
755 * is up and running, all fields are set property.
758 * If workspacePolicy is FixErrors, there is an attempt to fix unexpected
759 * errors. It includes installing database files, installing ontologies, and
760 * installing project features.
763 * In Simantics Workbench this is handled in
764 * <code>SimanticsWorkbenchAdvisor#openWindows()</code>.
767 * If remote server is given, simantics plaform takes connection there
768 * instead of local server at "db/".
770 * @param workspacePolicy action to take on workspace/database related
772 * @param ontologyPolicy action to take on ontology mismatch
773 * @param progressMonitor optional progress monitor
774 * @param userAgent interface for resorting to user feedback during platform
775 * startup or <code>null</code> to resort to default measures
776 * @throws PlatformException
778 public synchronized SessionContext startUp(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy,
779 OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize, PlatformUserAgent userAgent)
780 throws PlatformException
784 TimeLogger.log("Beginning of SimanticsPlatform.startUp");
786 LOGGER.info("Beginning of SimanticsPlatform.startUp");
788 SubMonitor monitor = SubMonitor.convert(progressMonitor, 1000);
790 // For debugging on what kind of platform automatic tests are running in
791 // case there are problems.
792 if ("true".equals(System.getProperty("org.simantics.dumpBundleState")))
793 dumpPlatformBundleState();
795 // 0. Consult all startup extensions before doing anything with the workspace.
796 StartupExtensions.consultStartupExtensions();
797 TimeLogger.log("Consulted platform pre-startup extensions");
799 // 0.1. Clear all temporary files
800 Simantics.clearTemporaryDirectory();
801 TimeLogger.log("Cleared temporary directory");
803 // 0.2 Clear VariableRepository.repository static map which holds references to SessionImplDb
804 VariableRepository.clear();
806 // 0.3 Handle baseline database before opening db
807 @SuppressWarnings("unused")
808 boolean usingBaseline = handleBaselineDatabase();
810 // 1. Assert there is a database at <workspace>/db
811 SessionDescriptor sessionDescriptor = setupDatabase(databaseDriverId, monitor.newChild(200, SubMonitor.SUPPRESS_NONE), workspacePolicy, userAgent);
812 session = sessionDescriptor.getSession();
813 TimeLogger.log("Database setup complete");
815 // 2. Delete all indexes if we cannot be certain they are up-to-date
816 // A full index rebuild will be done later, before project activation.
817 XSupport support = session.getService(XSupport.class);
818 if (support.rolledback()) {
820 DatabaseIndexing.deleteAllIndexes();
821 } catch (IOException e) {
822 throw new PlatformException(e);
826 // 3. Assert all graphs, and correct versions, are installed to the database
827 synchronizeOntologies(monitor.newChild(400, SubMonitor.SUPPRESS_NONE), ontologyPolicy, requireSynchronize);
828 TimeLogger.log("Synchronized ontologies");
830 // 4. Assert simantics.cfg exists
831 boolean installProject = assertConfiguration(monitor.newChild(25, SubMonitor.SUPPRESS_NONE),workspacePolicy);
833 // 5. Assert Project Resource is installed in the database
834 installProject = assertProject(monitor.newChild(25, SubMonitor.SUPPRESS_NONE), workspacePolicy, installProject);
836 // 6. Install all features into project, if in debug mode
837 updateInstalledGroups(monitor.newChild(25), true); //installProject);
838 TimeLogger.log("Installed all features into project");
840 // 7. Assert L0.Session in database for this session
841 assertSessionModel(monitor.newChild(25, SubMonitor.SUPPRESS_NONE));
843 session.getService(XSupport.class).setServiceMode(false, false);
846 monitor.setTaskName("Flush query cache");
847 session.syncRequest((Write) graph -> {
848 QueryControl qc = graph.getService(QueryControl.class);
851 TimeLogger.log("Flushed queries");
852 } catch (DatabaseException e) {
853 LOGGER.error("Flushing queries failed.", e);
855 boolean loadProject = true;
858 monitor.setTaskName("Open database session");
859 sessionContext = SimanticsPlatform.INSTANCE.createSessionContext(true);
860 // This must be before setSessionContext since some listeners might query this
861 sessionContext.setHint(SimanticsKeys.KEY_PROJECT, SimanticsPlatform.INSTANCE.projectResource);
863 Simantics.setSessionContext(sessionContext);
865 // 1. Put ResourceBinding that throws an exception to General Bindings
866 simanticsBindings = new SimanticsBindings();
867 Bindings.classBindingFactory.addFactory( simanticsBindings );
869 Session session = sessionContext.getSession();
870 session.registerService(Databoard.class, Bindings.databoard);
872 // Register datatype bindings
873 Bindings.defaultBindingFactory.getRepository().put(RGB.Integer.BINDING.type(), RGB.Integer.BINDING);
874 Bindings.defaultBindingFactory.getRepository().put(Font.BINDING.type(), Font.BINDING);
876 if (support.rolledback() || sessionDescriptor.isFreshDatabase()) {
877 monitor.setTaskName("Rebuilding all indexes");
879 session.getService(IndexedRelations.class).fullRebuild(monitor.newChild(100), session);
880 } catch (IndexException e) {
881 LOGGER.error("Failed to re-build all indexes", e);
888 TimeLogger.log("Load project");
889 monitor.setTaskName("Load project");
890 project = Projects.loadProject(sessionContext.getSession(), SimanticsPlatform.INSTANCE.projectResource);
891 sessionContext.setHint(ProjectKeys.KEY_PROJECT, project);
893 TimeLogger.log("Loading projects complete");
895 monitor.setTaskName("Activate project");
898 TimeLogger.log("Project activated");
901 } catch (DatabaseException e) {
902 LOGGER.error("Platform startup failed.", e);
903 throw new PlatformException(e);
904 } catch (ProjectException e) {
905 boolean hasStackTrace = e.getStackTrace().length > 0;
907 throw new PlatformException(e.getMessage(), hasStackTrace);
908 throw new PlatformException(e, hasStackTrace);
913 // #7650: improve shutdown robustness in all applications that use the platform
914 Runtime.getRuntime().addShutdownHook(shutdownHook);
916 // Discard database session undo history at this point to prevent
917 // the user from undoing any initialization operations performed
918 // by the platform startup.
919 SimanticsPlatform.INSTANCE.discardSessionUndoHistory();
920 TimeLogger.log("Discarded session undo history");
922 return sessionContext;
926 public SessionContext createSessionContext(boolean init) throws PlatformException {
928 // Construct and initialize SessionContext from Session.
929 SessionContext sessionContext = SessionContext.create(session, init);
930 TimeLogger.log("Session context created");
932 sessionContext.registerServices();
933 TimeLogger.log("Session services registered");
935 return sessionContext;
936 } catch (DatabaseException e) {
937 throw new PlatformException(e);
942 * Perform normal shutdown for the Simantics Platform.
944 * @param progressMonitor optional progress monitor
945 * @throws PlatformException
946 * @see {@link #shutdown(IProgressMonitor, boolean)}
948 public synchronized void shutdown(IProgressMonitor progressMonitor) throws PlatformException {
949 shutdown(progressMonitor, true);
953 * Shutdown Simantics Platform.
955 * In Simantics Workbench this is handled in
956 * <code>SimanticsWorkbenchAdvisor#disconnectFromWorkspace</code>.
958 * @param progressMonitor
959 * optional progress monitor
960 * @param clearTemporaryFiles
961 * allow or prevent deletion of temporary files at the end of the
963 * @throws PlatformException
965 public synchronized void shutdown(IProgressMonitor progressMonitor, boolean clearTemporaryFiles) throws PlatformException
967 SubMonitor progress = SubMonitor.convert(progressMonitor, 100);
968 PlatformException platformException = null;
970 progress.subTask("Close Project");
971 if (project != null) {
972 project.safeDispose();
977 progress.subTask("Close Database Session");
978 if (sessionContext != null) {
979 Session s = sessionContext.peekSession();
981 progress.subTask("Flushing Index Caches");
983 Simantics.flushIndexCaches(progress.newChild(20), s);
984 } catch (Throwable t) {
985 LOGGER.error("Failed to flush index caches.", t);
989 progress.subTask("Close Database Session");
990 sessionContext.safeDispose();
991 sessionContext = null;
992 Simantics.setSessionContext(null);
994 if (simanticsBindings != null) {
995 Bindings.classBindingFactory.removeFactory( simanticsBindings );
996 simanticsBindings = null;
999 // Make sure Simantics clipboard doesn't store unwanted session data references.
1000 Simantics.setClipboard(new SimanticsClipboardImpl());
1002 progress.worked(30);
1005 projectResource = null;
1006 currentDatabaseDriver = null;
1008 DependenciesRelation.assertFinishedTracking();
1010 } catch (Exception e) {
1011 platformException = new PlatformException("Failed to shutdown Simantics Platform", e);
1014 progress.worked(10);
1015 progress.subTask("Shutting down database");
1017 if (null != databasebManagement)
1018 databasebManagement.shutdown();
1019 } catch (Throwable t) {
1020 LOGGER.error("Database shutdown failed.", t);
1022 progress.worked(10);
1024 if (clearTemporaryFiles) {
1025 progress.subTask("Clearing Workspace Temporary Directory");
1027 Simantics.clearTemporaryDirectory();
1028 } catch (Throwable t) {
1029 LOGGER.error("Failed to clear the temporary directory.", t);
1032 progress.worked(10);
1033 if (null != platformException)
1034 throw platformException;
1036 // #7650: improve shutdown robustness in all applications that use the platform
1037 Runtime.getRuntime().removeShutdownHook(shutdownHook);
1040 // TODO: consider removing this in the future ??
1042 public void stateChanged(LifecycleState newState) {
1043 if(newState == LifecycleState.CLOSED) {
1045 if(Platform.isRunning()) {
1046 mainThread.interrupt();
1053 * @return <code>true</code> if discard was successful, <code>false</code>
1054 * if there was no session, {@link UndoRedoSupport} or
1055 * {@link UndoContext} to discard through
1057 public boolean discardSessionUndoHistory() {
1058 Session s = session;
1060 UndoRedoSupport urs = s.peekService(UndoRedoSupport.class);
1062 UndoContext uc = urs.getUndoContext(s);
1072 public void reconnect(String databaseDriverId) throws Exception {
1073 // Starts database server.
1074 if (currentDatabaseDriver != null)
1075 databaseDriverId = currentDatabaseDriver;
1076 SimanticsPlatform.INSTANCE.startUp(databaseDriverId, null, RecoveryPolicy.ThrowError, OntologyRecoveryPolicy.ThrowError, true, null);
1079 private void dumpPlatformBundleState() {
1080 BundleDescription[] bs = Platform.getPlatformAdmin().getState().getBundles();
1081 System.out.println("Total bundles: " + bs.length);
1082 for (BundleDescription b : bs) {
1083 System.out.format("%-80s @ %s\n", b.toString(), b.getLocation());
1087 private Ini loadOrCreateDatabaseIni(Path path, String databaseDriverId)
1088 throws InvalidFileFormatException, IOException
1090 File f = path.toFile();
1091 Ini dbIni = Files.isRegularFile(path) ? new Ini(f) : new Ini();
1092 String iniId = dbIni != null ? dbIni.get("driver", "id") : null;
1093 if (iniId == null) {
1094 dbIni.put("driver", "id", databaseDriverId);