1 /*******************************************************************************
2 * Copyright (c) 2007, 2018 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.scl.compiler.module.repository.ModuleRepository;
114 import org.simantics.scl.osgi.SCLOsgi;
115 import org.simantics.utils.FileUtils;
116 import org.simantics.utils.datastructures.Pair;
117 import org.simantics.utils.strings.EString;
118 import org.slf4j.Logger;
119 import org.slf4j.LoggerFactory;
122 * SimanticsPlatform performs procedures required in order to get simantics
123 * workbench into operational state. This consists of the following steps:
125 * <li> Asserting there is Database
127 * <li> Starting Database process
129 * <li> Opening a session to Database process
131 * <li> Asserting required ontologies or other transferable graphs are installed in the database
133 * <li> Asserting required project is installed in the database
135 * <li> Asserting Simantics Features are installed in the database
137 * <li> Asserting Simantics Features are installed to the project
139 * <li> Shutdown: Save Session, Close session, Kill Database process
143 * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
145 public class SimanticsPlatform implements LifecycleListener {
147 private static final Logger LOGGER = LoggerFactory.getLogger(SimanticsPlatform.class);
150 * The policy is relevant when developing Simantics from Eclipse IDE.
151 * It is applied when the ontology in the database of a workspace doesn't match
152 * a newer ontology in the Eclipse workspace.
154 public static enum OntologyRecoveryPolicy { ThrowError, Merge, ReinstallDatabase }
157 * This policy dictates how the Simantics platform startup should react if
158 * the started workspace is not set up properly. The alternatives are to
159 * just throw an error and fail or to attempt all possible measures to fix
160 * the encountered problems.
162 public static enum RecoveryPolicy { ThrowError, FixError }
164 /** Singleton instance, started in SimanticsWorkbenchAdvisor */
165 public static final SimanticsPlatform INSTANCE = new SimanticsPlatform();
167 /** Set to true when the Simantics Platform is in good-and-go condition */
168 public boolean running;
170 /** ID of the database driver that the platform is currently using */
171 private String currentDatabaseDriver;
173 /** Database Session */
174 public Session session;
175 private Management databasebManagement;
177 /** Database session context */
178 public SessionContext sessionContext;
180 /** Project identifier in Database */
181 public String projectURI;
184 public String projectName;
186 /** Project resource */
187 public Resource projectResource;
189 /** Session specific bindings */
190 public SimanticsBindings simanticsBindings;
192 public Thread mainThread;
194 private Thread shutdownHook = new Thread() {
198 LOGGER.warn("Simantics platform was not properly shut down. Executing safety shutdown hook.");
199 shutdown(null, false);
200 } catch (PlatformException e) {
201 LOGGER.error("Simantics Platform shutdown hook execution failed.", e);
202 log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Simantics Platform shutdown hook execution failed.", e));
208 * The {@link IProject} activated by
209 * {@link #startUp(IProgressMonitor, RecoveryPolicy, OntologyRecoveryPolicy, ServerAddress, PlatformUserAgent)}
211 private IProject project;
216 * Create a new simantics plaform manager in uninitialized state and
217 * with default policies. <p>
219 public SimanticsPlatform() {
220 log = Platform.getLog(Activator.getBundleContext().getBundle());
221 mainThread = Thread.currentThread();
224 public String getApplicationClientId() {
225 IProduct product = Platform.getProduct();
226 if(product == null) return "noProduct";//UUID.randomUUID().toString();
227 String application = product.getApplication();
228 return application != null ? application : UUID.randomUUID().toString();
231 private SessionDescriptor setupDatabase(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy, PlatformUserAgent userAgent) throws PlatformException {
232 if (progressMonitor == null)
233 progressMonitor = new NullProgressMonitor();
234 Path workspaceLocation = Platform.getLocation().toFile().toPath();
235 Path dbLocation = workspaceLocation.resolve("db");
236 Path dbIniPath = workspaceLocation.resolve("db.ini");
237 // The driver file overrides any command line arguments to prevent
238 // using the wrong driver for an existing database directory.
239 ServerManager serverManager;
241 Ini dbIni = loadOrCreateDatabaseIni(dbIniPath, databaseDriverId);
242 databaseDriverId = dbIni.get("driver", "id");
243 serverManager = ServerManagerFactory.create(databaseDriverId, dbLocation.toAbsolutePath().toString());
244 } catch (DatabaseException | IOException e) {
245 throw new PlatformException("Failed to initialize database ServerManager with driver " + databaseDriverId, e);
247 progressMonitor.beginTask("Setting up Simantics Database", 100);
248 progressMonitor.setTaskName("Asserting Database is installed.");
249 String msg = "Failed to initialize Simantics database.";
252 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Initializing database at " + dbLocation + " with driver " + databaseDriverId));
253 progressMonitor.setTaskName("Creating database at " + dbLocation);
254 databasebManagement = serverManager.getManagement(dbLocation.toFile());
255 databasebManagement.create();
256 currentDatabaseDriver = databaseDriverId;
258 return serverManager.createDatabase(dbLocation.toFile());
259 } catch (DatabaseException e) {
260 throw new PlatformException(msg, e);
261 } catch (Throwable e) {
262 throw new PlatformException(msg, e);
264 progressMonitor.worked(20);
268 public void synchronizeOntologies(IProgressMonitor progressMonitor, OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize) throws PlatformException {
270 SubMonitor monitor = SubMonitor.convert(progressMonitor, 100);
272 monitor.setTaskName("Compile dynamic ontologies");
273 PlatformUtil.compileAllDynamicOntologies();
275 String message = "Asserting all ontologies are installed";
276 LOGGER.info(message);
277 monitor.setTaskName(message);
279 DatabaseManagement mgmt = new DatabaseManagement();
280 Map<GraphBundleRef, GraphBundleEx> platformTGs = new HashMap<>();
283 // Get a list of bundles installed into the database
284 message = "find installed bundles from database";
285 monitor.subTask(message);
286 LOGGER.info(message);
287 Map<GraphBundleRef, GraphBundleEx> installedTGs = new HashMap<>();
288 for (GraphBundle b : session.syncRequest( mgmt.GraphBundleQuery )) {
289 installedTGs.put(GraphBundleRef.of(b), GraphBundleEx.extend(b));
292 if(!requireSynchronize && installedTGs.size() > 1 && !Platform.inDevelopmentMode()) return;
293 // if(installedTGs.size() > 1) return;
295 // Get a list of all bundles in the platform (Bundle Context)
296 message = "load all transferable graphs from platform";
297 monitor.subTask(message);
298 LOGGER.info(message);
299 Collection<GraphBundle> tgs = PlatformUtil.getAllGraphs();
300 message = "extend bundles to compile versions";
301 monitor.subTask(message);
302 LOGGER.info(message);
303 for (GraphBundle b : tgs) {
304 GraphBundleEx gbe = GraphBundleEx.extend(b);
306 platformTGs.put(GraphBundleRef.of(b), gbe);
309 // Compile a list of TGs that need to be installed or reinstalled in the database
310 message = "check bundle reinstallation demand";
311 monitor.subTask(message);
312 LOGGER.info(message);
313 List<GraphBundleEx> installTGs = new ArrayList<>();
314 // Create list of TGs to update, <newTg, oldTg>
315 Map<GraphBundleEx,GraphBundleEx> reinstallTGs = new TreeMap<>();
316 for (Entry<GraphBundleRef, GraphBundleEx> e : platformTGs.entrySet()) {
317 GraphBundleRef key = e.getKey();
318 GraphBundleEx platformBundle = e.getValue();
319 GraphBundleEx existingBundle = installedTGs.get(key);
321 // System.out.println("GraphBundleRef key=" + key.toString());
323 if (existingBundle == null) {
324 // Bundle did not exist in the database, put it into list of bundles to install
325 installTGs.add(platformBundle);
328 // Bundle exists in the database
329 boolean platformBundleIsNewer = existingBundle.getVersion().compareTo(platformBundle.getVersion())<0;
330 if (!platformBundleIsNewer)
332 // Check hash of transferable graph to know whether to update or not.
333 if (platformBundle.getHashcode() == existingBundle.getHashcode())
335 //System.out.println("Ontology hashcodes do not match: platform bundle="
336 // + platformBundle.getVersionedId() + ", hash=" + platformBundle.getHashcode()
337 // + "; existing bundle=" + existingBundle.getVersionedId() + ", hash=" + existingBundle.getHashcode());
338 reinstallTGs.put(platformBundle, existingBundle);
342 // Database is missing graphs
343 if (!installTGs.isEmpty() || !reinstallTGs.isEmpty()) {
344 session.getService(XSupport.class).setServiceMode(true, true);
347 if (ontologyPolicy == OntologyRecoveryPolicy.ThrowError) {
348 StringBuilder sb = new StringBuilder("The following graphs are not installed in the database: ");
349 if (!installTGs.isEmpty()) {
351 for (GraphBundleEx e : installTGs) {
352 if (i>0) sb.append(", ");
354 sb.append(e.toString());
356 sb.append(" is missing from the database.\n");
358 if (!reinstallTGs.isEmpty()) {
360 for (Entry<GraphBundleEx, GraphBundleEx> e : reinstallTGs.entrySet()) {
361 if (i>0) sb.append(", ");
363 sb.append(e.getKey().toString());
365 sb.append(" Database/Platform Bundle version mismatch.\n");
367 sb.append("Hint: Use -fixErrors to install the graphs.");
368 throw new PlatformException(sb.toString());
370 // Reinstall database
371 if (ontologyPolicy == OntologyRecoveryPolicy.ReinstallDatabase) {
372 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Reinstalling the database."));
381 throw new PlatformException("Reinstalling Database, NOT IMPLEMENTED");
384 if (ontologyPolicy == OntologyRecoveryPolicy.Merge) {
385 message = "Merging ontology changes";
386 monitor.subTask(message);
387 LOGGER.info(message);
388 // Sort missing TGs into install order
389 GraphDependencyAnalyzer<GraphBundle> analyzer = new GraphDependencyAnalyzer<GraphBundle>();
390 for(GraphBundle tg : installTGs) analyzer.addGraph(tg, tg.getGraph());
391 for(GraphBundle tg : reinstallTGs.keySet()) analyzer.addGraph(tg, tg.getGraph());
392 if(!analyzer.analyzeDependency()) {
393 Collection<Pair<GraphBundle, GraphBundle>> problems = analyzer.getConflicts();
394 StringBuilder sb = new StringBuilder();
395 for (Pair<GraphBundle, GraphBundle> problem : problems) {
396 sb.append("Conflict with "+problem.first+" and "+problem.second+".\n");
398 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 message = "Analyzed graph bundles";
412 monitor.subTask(message);
413 LOGGER.info(message);
415 List<GraphBundle> sortedBundles = analyzer.getSortedGraphs();
416 if(!sortedBundles.isEmpty()) {
418 session.syncRequest((Write) graph -> {
420 graph.newClusterSet(graph.getRootLibrary());
421 } catch (ClusterSetExistException e) {
422 // Cluster set exist already, no problem.
424 graph.setClusterSet4NewResource(graph.getRootLibrary());
425 graph.flushCluster();
428 boolean mergedOntologies = false;
431 for(final GraphBundle tg : sortedBundles) {
433 final IImportAdvisor advisor = new OntologyImportAdvisor(tg, mgmt);
434 final GraphBundle oldTG = reinstallTGs.get(tg);
436 boolean createImmutable = tg.getImmutable();
440 session.getService(XSupport.class).setServiceMode(true, createImmutable);
443 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Installing "+tg.toString()+" - "+tg.getName()));
444 ImportResult result = TransferableGraphs.importGraph1(session, new TGTransferableGraphSource(tg.getGraph()), advisor, null);
445 if (!result.missingExternals.isEmpty()) {
446 log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Import of " + tg.toString() + " was missing the following external entities:\n" + EString.implode(result.missingExternals)));
453 startTransaction(session, false);
454 TransferableGraphDelta1 delta = new Diff(oldTG.getGraph(), tg.getGraph()).diff();
455 final long[] oldResources = oldTG.getResourceArray();
456 boolean changes = TransferableGraphs.hasChanges(readGraph(), oldResources, delta);
459 //log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Nothing to merge for "+tg.toString()));
463 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Merging new version of "+tg.toString()));
465 startTransaction(session, true);
469 long[] resourceArray = TransferableGraphs.applyDelta(writeGraph(), oldResources, delta);
470 tg.setResourceArray(resourceArray);
471 mgmt.setGraphBundleEntry(tg);
473 mergedOntologies = true;
474 } catch (Throwable t) {
475 throw new PlatformException(t);
482 session.syncRequest((Write) graph -> {
483 graph.setClusterSet4NewResource(graph.getRootLibrary());
484 graph.flushCluster();
487 if (mergedOntologies)
488 DatabaseIndexing.deleteAllIndexes();
491 session.getService(XSupport.class).setServiceMode(false, false);
493 message = "Ontologies synchronized";
494 monitor.subTask(message);
495 LOGGER.info(message);
497 } catch (IOException e) {
498 throw new PlatformException(e);
499 } catch (DatabaseException e) {
500 throw new PlatformException(e);
505 public boolean assertConfiguration(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy) throws PlatformException {
507 if (progressMonitor == null) progressMonitor = new NullProgressMonitor();
509 File workspaceLocation = Platform.getLocation().toFile();
511 boolean installProject = false;
512 progressMonitor.setTaskName("Asserting simantics.cfg is installed");
514 File propertyFile = new File(workspaceLocation, "simantics.cfg");
515 Properties properties;
517 properties = WorkspaceUtil.readProperties(propertyFile);
518 } catch (IOException e) {
519 if (workspacePolicy == RecoveryPolicy.ThrowError) throw new PlatformException("Could not load "+propertyFile);
521 // Create a project and write Property file
522 properties = new Properties();
523 properties.setProperty("project_uri", "http://Projects/Development%20Project");
524 properties.setProperty("project_name", "Development Project");
525 WorkspaceUtil.writeProperties(propertyFile, properties);
526 installProject |= true;
528 projectURI = properties.getProperty("project_uri");
529 projectName = properties.getProperty("project_name");
530 progressMonitor.worked(10);
531 } catch (IOException e) {
532 throw new PlatformException(e);
535 return installProject;
539 public boolean assertProject(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy, boolean installProject) throws PlatformException {
541 SubMonitor monitor = SubMonitor.convert(progressMonitor, 10);
543 final DatabaseManagement mgmt = new DatabaseManagement();
545 monitor.setTaskName("Asserting project resource exists in the database");
547 projectResource = session.syncRequest( Queries.resource( projectURI ) );
548 } catch (ResourceNotFoundException nfe) {
549 // Project was not found
550 if (workspacePolicy == RecoveryPolicy.ThrowError)
551 throw new PlatformException("Project Resource "+projectURI+" is not found in the database.");
552 // Create empty project with no features
554 Transaction.startTransaction(session, true);
556 // The project needs to be created mutable.
557 session.getService(XSupport.class).setServiceMode(true, false);
559 ArrayList<String> empty = new ArrayList<String>();
560 projectResource = mgmt.createProject(projectName, empty);
561 installProject |= true;
563 session.getService(XSupport.class).setServiceMode(false, false);
564 Transaction.commit();
566 Transaction.endTransaction();
568 //session.getService( LifecycleSupport.class ).save();
569 } catch (DatabaseException e) {
570 throw new PlatformException("Failed to create "+projectURI, e);
572 } catch (DatabaseException e) {
573 throw new PlatformException("Failed to create "+projectURI, e);
577 return installProject;
581 public void updateInstalledGroups(IProgressMonitor progressMonitor, boolean installProject) throws PlatformException {
585 // Attach all feature groups available in platform to created project
586 progressMonitor.setTaskName("Install all features");
587 Set<GroupReference> publishedFeatureGroups = ProjectFeatures.getInstallGroupsOfPublishedFeatures();
588 Collection<GroupReference> groupsWithoutVersion = GroupReference.stripVersions(publishedFeatureGroups);
593 Projects.setProjectInstalledGroups(graph, projectResource, groupsWithoutVersion));
594 } catch (DatabaseException ae) {
595 throw new PlatformException("Failed to install features", ae);
597 progressMonitor.worked(10);
602 public void assertSessionModel(IProgressMonitor progressMonitor) throws PlatformException {
604 Properties properties = session.getService(Properties.class);
605 final String clientId = properties.getProperty("clientId");
609 // Currently this needs to be done before data becomes available
610 VirtualGraphSupport support = session.getService(VirtualGraphSupport.class);
611 VirtualGraph activations = support.getWorkspacePersistent("activations");
613 Resource sessionModel = session.syncRequest(new Read<Resource>() {
616 public Resource perform(ReadGraph graph) throws DatabaseException {
618 Layer0X L0X = Layer0X.getInstance(graph);
619 for(Resource sessionModel : graph.syncRequest(new ObjectsWithType(graph.getRootLibrary(), L0X.HasSession, L0X.Session))) {
620 String id = graph.getPossibleRelatedValue(sessionModel, L0X.Session_HasClientId);
621 if(id != null && id.equals(clientId)) return sessionModel;
629 if(sessionModel == null) {
631 sessionModel = session.syncRequest(new WriteResultRequest<Resource>(activations) {
634 public Resource perform(WriteGraph graph) throws DatabaseException {
635 Layer0 L0 = Layer0.getInstance(graph);
636 Layer0X L0X = Layer0X.getInstance(graph);
637 Resource session = graph.newResource();
638 graph.claim(session, L0.InstanceOf, null, L0X.Session);
639 graph.claim(session, L0X.Session_HasUser, null, graph.getResource("http://Users/AdminUser"));
640 graph.addLiteral(session, L0X.Session_HasClientId, L0X.Session_HasClientId_Inverse, clientId, Bindings.STRING);
641 graph.claim(graph.getRootLibrary(), L0X.HasSession, session);
648 session.registerService(SessionModel.class, new PlatformSessionModel(sessionModel));
649 } catch (DatabaseException e) {
650 throw new PlatformException(e);
655 static class PlatformSessionModel implements SessionModel {
656 private final Resource sessionModel;
658 public PlatformSessionModel(Resource model) {
659 this.sessionModel = model;
663 public Resource getResource() {
668 public void resetDatabase(IProgressMonitor monitor) throws PlatformException {
669 File dbLocation = Platform.getLocation().append("db").toFile();
670 if(!dbLocation.exists()) return;
672 Driver driver = Manager.getDriver("procore");
673 Management management = driver.getManagement(dbLocation.getAbsolutePath(), null);
675 } catch (DatabaseException e) {
676 throw new PlatformException("Failed to remove database at " + dbLocation.getAbsolutePath(), e);
678 // We have created extra files to database folder which have to be deleted also.
679 // This is an awful idea! Do not create extra files to database folder!
681 for (int i=0; i<10; ++i) {
683 FileUtils.deleteAll(dbLocation);
686 } catch (IOException e) {
687 // Assuming this has been thrown because delete file/folder failed.
692 } catch (InterruptedException e) {
693 // Ignoring interrupted exception.
697 throw new PlatformException("Failed to remove database folder at " + dbLocation.getAbsolutePath(), t);
699 public void resetWorkspace(IProgressMonitor monitor, ArrayList<String> fileFilter) throws PlatformException, IllegalStateException, IOException {
700 File file = Platform.getLocation().toFile();
701 if (null != fileFilter)
702 FileUtils.deleteAllWithFilter(file , fileFilter);
703 resetDatabase(monitor);
706 private static Path tryGetInstallLocation() {
707 Location l = Platform.getInstallLocation();
708 return l == null ? null : new File(l.getURL().getPath()).toPath();
711 private Path resolveBaselineFile() throws PlatformException {
712 String dbBaselineArchive = System.getProperty("org.simantics.db.baseline", null);
713 if (dbBaselineArchive == null)
716 Path baseline = Paths.get(dbBaselineArchive);
717 if (baseline.isAbsolute()) {
718 if (!Files.isRegularFile(baseline))
719 throw new PlatformException("Specified database baseline archive " + baseline
720 + " does not exist. Cannot initialize workspace database from baseline.");
724 // Relative path resolution order:
725 // 1. from the platform "install location"
726 // 2. from working directory
727 Path installLocation = tryGetInstallLocation();
728 if (installLocation != null) {
729 Path installedBaseline = installLocation.resolve(dbBaselineArchive);
730 if (Files.isRegularFile(installedBaseline))
731 return installedBaseline;
733 if (!Files.isRegularFile(baseline))
734 throw new PlatformException("Specified database baseline archive " + baseline
735 + " does not exist in either the install location (" + installLocation
736 + ") or the working directory (" + Paths.get(".").toAbsolutePath()
737 + "). Cannot initialize workspace database.");
741 private boolean handleBaselineDatabase() throws PlatformException {
742 Path workspaceLocation = Platform.getLocation().toFile().toPath();
743 Path baselineIndicatorFile = workspaceLocation.resolve(".baselined");
744 if (Files.isRegularFile(baselineIndicatorFile)) {
745 // This means that the workspace has already been initialized from
746 // a database baseline and further initialization is not necessary.
750 Path baseline = resolveBaselineFile();
751 if (baseline == null)
754 DatabaseBaselines.validateBaselineFile(baseline);
755 DatabaseBaselines.validateWorkspaceForBaselineInitialization(workspaceLocation);
756 DatabaseBaselines.initializeWorkspaceWithBaseline(baseline, workspaceLocation, baselineIndicatorFile);
761 * Start-up the platform. The procedure consists of 8 steps. Once everything
762 * is up and running, all fields are set property.
765 * If workspacePolicy is FixErrors, there is an attempt to fix unexpected
766 * errors. It includes installing database files, installing ontologies, and
767 * installing project features.
770 * In Simantics Workbench this is handled in
771 * <code>SimanticsWorkbenchAdvisor#openWindows()</code>.
774 * If remote server is given, simantics plaform takes connection there
775 * instead of local server at "db/".
777 * @param workspacePolicy action to take on workspace/database related
779 * @param ontologyPolicy action to take on ontology mismatch
780 * @param progressMonitor optional progress monitor
781 * @param userAgent interface for resorting to user feedback during platform
782 * startup or <code>null</code> to resort to default measures
783 * @throws PlatformException
785 public synchronized SessionContext startUp(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy,
786 OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize, PlatformUserAgent userAgent)
787 throws PlatformException
791 LOGGER.info("Beginning of SimanticsPlatform.startUp");
793 SubMonitor monitor = SubMonitor.convert(progressMonitor, 1000);
795 // For debugging on what kind of platform automatic tests are running in
796 // case there are problems.
797 if ("true".equals(System.getProperty("org.simantics.dumpBundleState")))
798 dumpPlatformBundleState();
800 // 0. Consult all startup extensions before doing anything with the workspace.
801 StartupExtensions.consultStartupExtensions();
802 LOGGER.info("Consulted platform pre-startup extensions");
804 // 0.1. Clear all temporary files
805 Simantics.clearTemporaryDirectory();
806 LOGGER.info("Cleared temporary directory");
808 // 0.2 Clear VariableRepository.repository static map which holds references to SessionImplDb
809 VariableRepository.clear();
811 // 0.2.1 Activate org.simantics.scl.osgi to prime the SCL compiler early.
812 @SuppressWarnings("unused")
813 ModuleRepository modRepo = SCLOsgi.MODULE_REPOSITORY;
815 // 0.3 Handle baseline database before opening db
816 @SuppressWarnings("unused")
817 boolean usingBaseline = handleBaselineDatabase();
819 // 1. Assert there is a database at <workspace>/db
820 SessionDescriptor sessionDescriptor = setupDatabase(databaseDriverId, monitor.newChild(200, SubMonitor.SUPPRESS_NONE), workspacePolicy, userAgent);
821 session = sessionDescriptor.getSession();
822 LOGGER.info("Database setup complete");
824 // 2. Delete all indexes if we cannot be certain they are up-to-date
825 // A full index rebuild will be done later, before project activation.
826 XSupport support = session.getService(XSupport.class);
827 if (support.rolledback()) {
829 DatabaseIndexing.deleteAllIndexes();
830 } catch (IOException e) {
831 throw new PlatformException(e);
835 // 3. Assert all graphs, and correct versions, are installed to the database
836 synchronizeOntologies(monitor.newChild(400, SubMonitor.SUPPRESS_NONE), ontologyPolicy, requireSynchronize);
838 // 4. Assert simantics.cfg exists
839 boolean installProject = assertConfiguration(monitor.newChild(25, SubMonitor.SUPPRESS_NONE),workspacePolicy);
841 // 5. Assert Project Resource is installed in the database
842 installProject = assertProject(monitor.newChild(25, SubMonitor.SUPPRESS_NONE), workspacePolicy, installProject);
844 // 6. Install all features into project, if in debug mode
845 updateInstalledGroups(monitor.newChild(25), true); //installProject);
846 LOGGER.info("Installed all features into project");
848 // 7. Assert L0.Session in database for this session
849 assertSessionModel(monitor.newChild(25, SubMonitor.SUPPRESS_NONE));
851 session.getService(XSupport.class).setServiceMode(false, false);
854 String message = "Flush query cache";
855 monitor.setTaskName(message);
856 LOGGER.info(message);
857 session.syncRequest((Write) graph -> {
858 QueryControl qc = graph.getService(QueryControl.class);
861 } catch (DatabaseException e) {
862 LOGGER.error("Flushing queries failed.", e);
864 boolean loadProject = true;
866 String message = "Open database session";
867 monitor.setTaskName(message);
868 LOGGER.info(message);
869 sessionContext = SimanticsPlatform.INSTANCE.createSessionContext(true);
870 // This must be before setSessionContext since some listeners might query this
871 sessionContext.setHint(SimanticsKeys.KEY_PROJECT, SimanticsPlatform.INSTANCE.projectResource);
873 Simantics.setSessionContext(sessionContext);
875 // 1. Put ResourceBinding that throws an exception to General Bindings
876 message = "Put ResourceBinding that throws an exception to General Bindings";
877 LOGGER.info(message);
878 simanticsBindings = new SimanticsBindings();
879 Bindings.classBindingFactory.addFactory( simanticsBindings );
881 Session session = sessionContext.getSession();
882 session.registerService(Databoard.class, Bindings.databoard);
884 // Register datatype bindings
885 message = "Register datatype bindings";
886 LOGGER.info(message);
887 Bindings.defaultBindingFactory.getRepository().put(RGB.Integer.BINDING.type(), RGB.Integer.BINDING);
888 Bindings.defaultBindingFactory.getRepository().put(Font.BINDING.type(), Font.BINDING);
890 if (support.rolledback() || sessionDescriptor.isFreshDatabase()) {
891 message = "Rebuilding all indexes";
892 LOGGER.info(message);
893 monitor.setTaskName(message);
895 session.getService(IndexedRelations.class).fullRebuild(monitor.newChild(100), session);
896 } catch (IndexException e) {
897 LOGGER.error("Failed to re-build all indexes", e);
904 message = "Load project";
905 monitor.setTaskName(message);
906 LOGGER.info(message);
907 project = Projects.loadProject(sessionContext.getSession(), SimanticsPlatform.INSTANCE.projectResource);
908 sessionContext.setHint(ProjectKeys.KEY_PROJECT, project);
910 message = "Loading projects complete";
911 LOGGER.info(message);
913 message = "Activate project";
914 monitor.setTaskName(message);
915 LOGGER.info(message);
918 LOGGER.info("Project activated");
921 } catch (DatabaseException e) {
922 LOGGER.error("Platform startup failed.", e);
923 throw new PlatformException(e);
924 } catch (ProjectException e) {
925 boolean hasStackTrace = e.getStackTrace().length > 0;
927 throw new PlatformException(e.getMessage(), hasStackTrace);
928 throw new PlatformException(e, hasStackTrace);
933 // #7650: improve shutdown robustness in all applications that use the platform
934 Runtime.getRuntime().addShutdownHook(shutdownHook);
936 // Discard database session undo history at this point to prevent
937 // the user from undoing any initialization operations performed
938 // by the platform startup.
939 SimanticsPlatform.INSTANCE.discardSessionUndoHistory();
940 LOGGER.info("Discarded session undo history");
942 return sessionContext;
946 public SessionContext createSessionContext(boolean init) throws PlatformException {
948 // Construct and initialize SessionContext from Session.
949 SessionContext sessionContext = SessionContext.create(session, init);
950 String message = "Session context created";
951 LOGGER.info(message);
953 sessionContext.registerServices();
954 message = "Session services registered";
955 LOGGER.info(message);
957 return sessionContext;
958 } catch (DatabaseException e) {
959 throw new PlatformException(e);
964 * Perform normal shutdown for the Simantics Platform.
966 * @param progressMonitor optional progress monitor
967 * @throws PlatformException
968 * @see {@link #shutdown(IProgressMonitor, boolean)}
970 public synchronized void shutdown(IProgressMonitor progressMonitor) throws PlatformException {
971 shutdown(progressMonitor, true);
975 * Shutdown Simantics Platform.
977 * In Simantics Workbench this is handled in
978 * <code>SimanticsWorkbenchAdvisor#disconnectFromWorkspace</code>.
980 * @param progressMonitor
981 * optional progress monitor
982 * @param clearTemporaryFiles
983 * allow or prevent deletion of temporary files at the end of the
985 * @throws PlatformException
987 public synchronized void shutdown(IProgressMonitor progressMonitor, boolean clearTemporaryFiles) throws PlatformException
989 SubMonitor progress = SubMonitor.convert(progressMonitor, 100);
990 PlatformException platformException = null;
992 progress.subTask("Close Project");
993 if (project != null) {
994 project.safeDispose();
999 progress.subTask("Close Database Session");
1000 if (sessionContext != null) {
1001 Session s = sessionContext.peekSession();
1003 progress.subTask("Flushing Index Caches");
1005 Simantics.flushIndexCaches(progress.newChild(20), s);
1006 } catch (Throwable t) {
1007 LOGGER.error("Failed to flush index caches.", t);
1011 progress.subTask("Close Database Session");
1012 sessionContext.safeDispose();
1013 sessionContext = null;
1014 Simantics.setSessionContext(null);
1016 if (simanticsBindings != null) {
1017 Bindings.classBindingFactory.removeFactory( simanticsBindings );
1018 simanticsBindings = null;
1021 // Make sure Simantics clipboard doesn't store unwanted session data references.
1022 Simantics.setClipboard(new SimanticsClipboardImpl());
1024 progress.worked(30);
1027 projectResource = null;
1028 currentDatabaseDriver = null;
1030 DependenciesRelation.assertFinishedTracking();
1032 } catch (Exception e) {
1033 platformException = new PlatformException("Failed to shutdown Simantics Platform", e);
1036 progress.worked(10);
1037 progress.subTask("Shutting down database");
1039 if (null != databasebManagement)
1040 databasebManagement.shutdown();
1041 } catch (Throwable t) {
1042 LOGGER.error("Database shutdown failed.", t);
1044 progress.worked(10);
1046 if (clearTemporaryFiles) {
1047 progress.subTask("Clearing Workspace Temporary Directory");
1049 Simantics.clearTemporaryDirectory();
1050 } catch (Throwable t) {
1051 LOGGER.error("Failed to clear the temporary directory.", t);
1054 progress.worked(10);
1055 if (null != platformException)
1056 throw platformException;
1058 // #7650: improve shutdown robustness in all applications that use the platform
1059 Runtime.getRuntime().removeShutdownHook(shutdownHook);
1062 // TODO: consider removing this in the future ??
1064 public void stateChanged(LifecycleState newState) {
1065 if(newState == LifecycleState.CLOSED) {
1067 if(Platform.isRunning()) {
1068 mainThread.interrupt();
1075 * @return <code>true</code> if discard was successful, <code>false</code>
1076 * if there was no session, {@link UndoRedoSupport} or
1077 * {@link UndoContext} to discard through
1079 public boolean discardSessionUndoHistory() {
1080 Session s = session;
1082 UndoRedoSupport urs = s.peekService(UndoRedoSupport.class);
1084 UndoContext uc = urs.getUndoContext(s);
1094 public void reconnect(String databaseDriverId) throws Exception {
1095 // Starts database server.
1096 if (currentDatabaseDriver != null)
1097 databaseDriverId = currentDatabaseDriver;
1098 SimanticsPlatform.INSTANCE.startUp(databaseDriverId, null, RecoveryPolicy.ThrowError, OntologyRecoveryPolicy.ThrowError, true, null);
1101 private void dumpPlatformBundleState() {
1102 BundleDescription[] bs = Platform.getPlatformAdmin().getState().getBundles();
1103 System.out.println("Total bundles: " + bs.length);
1104 for (BundleDescription b : bs) {
1105 System.out.format("%-80s @ %s\n", b.toString(), b.getLocation());
1109 private Ini loadOrCreateDatabaseIni(Path path, String databaseDriverId)
1110 throws InvalidFileFormatException, IOException
1112 File f = path.toFile();
1113 Ini dbIni = Files.isRegularFile(path) ? new Ini(f) : new Ini();
1114 String iniId = dbIni != null ? dbIni.get("driver", "id") : null;
1115 if (iniId == null) {
1116 dbIni.put("driver", "id", databaseDriverId);