bundles/org.simantics/src/org/simantics/SimanticsPlatform.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   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
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics;
  13
  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;
  19
  20 import java.io.File;
  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;
  29 import java.util.Map;
  30 import java.util.Map.Entry;
  31 import java.util.Properties;
  32 import java.util.Set;
  33 import java.util.TreeMap;
  34 import java.util.UUID;
  35
  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;
  46 import org.ini4j.Ini;
  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;
 119
 120 /**
 121  * SimanticsPlatform performs procedures required in order to get simantics
 122  * workbench into operational state. This consists of the following steps:
 123  * <ul>
 124  *     <li> Asserting there is Database
 125  *     </li>
 126  *     <li> Starting Database process
 127  *     </li>
 128  *     <li> Opening a session to Database process
 129  *     </li>
 130  *     <li> Asserting required ontologies or other transferable graphs are installed in the database
 131  *     </li>
 132  *     <li> Asserting required project is installed in the database
 133  *     </li>
 134  *     <li> Asserting Simantics Features are installed in the database
 135  *     </li>
 136  *     <li> Asserting Simantics Features are installed to the project
 137  *     </li>
 138  *     <li> Shutdown: Save Session, Close session, Kill Database process
 139  *     </li>
 140  * </ul>
 141  *
 142  * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
 143  */
 144 public class SimanticsPlatform implements LifecycleListener {
 145
 146     private static final Logger LOGGER = LoggerFactory.getLogger(SimanticsPlatform.class);
 147
 148     /**
 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.
 152      */
 153     public static enum OntologyRecoveryPolicy { ThrowError, Merge, ReinstallDatabase }
 154
 155     /**
 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.
 160      */
 161     public static enum RecoveryPolicy { ThrowError, FixError }
 162
 163     /** Singleton instance, started in SimanticsWorkbenchAdvisor */
 164     public static final SimanticsPlatform INSTANCE = new SimanticsPlatform();
 165
 166     /** Set to true when the Simantics Platform is in good-and-go condition */
 167     public boolean running;
 168
 169     /** ID of the database driver that the platform is currently using */
 170     private String currentDatabaseDriver;
 171
 172     /** Database Session */
 173     public Session session;
 174     private Management databasebManagement;
 175
 176     /** Database session context */
 177     public SessionContext sessionContext;
 178
 179     /** Project identifier in Database */
 180     public String projectURI;
 181
 182     /** Project name */
 183     public String projectName;
 184
 185     /** Project resource */
 186     public Resource projectResource;
 187
 188     /** Session specific bindings */
 189     public SimanticsBindings simanticsBindings;
 190     public SimanticsBindings simanticsBindings2;
 191
 192     public Thread mainThread;
 193
 194     private Thread shutdownHook = new Thread() {
 195         @Override
 196         public void run() {
 197             try {
 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));
 203             }
 204         }
 205     };
 206
 207     /**
 208      * The {@link IProject} activated by
 209      * {@link #startUp(IProgressMonitor, RecoveryPolicy, OntologyRecoveryPolicy, ServerAddress, PlatformUserAgent)}
 210      */
 211     private IProject project;
 212
 213     protected ILog log;
 214
 215     /**
 216      * Create a new simantics plaform manager in uninitialized state and
 217      * with default policies. <p>
 218      */
 219     public SimanticsPlatform() {
 220         log = Platform.getLog(Activator.getBundleContext().getBundle());
 221         mainThread = Thread.currentThread();
 222     }
 223
 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();
 229     }
 230
 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;
 240         try {
 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);
 246         }
 247         progressMonitor.beginTask("Setting up Simantics Database", 100);
 248         progressMonitor.setTaskName("Asserting Database is installed.");
 249         String msg = "Failed to initialize Simantics database.";
 250         try {
 251             // Create 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;
 257             // Create layer0.
 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);
 263         } finally {
 264             progressMonitor.worked(20);
 265         }
 266     }
 267
 268     public void synchronizeOntologies(IProgressMonitor progressMonitor, OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize) throws PlatformException {
 269
 270         SubMonitor monitor = SubMonitor.convert(progressMonitor, 100);
 271
 272         monitor.setTaskName("Compile dynamic ontologies");
 273         PlatformUtil.compileAllDynamicOntologies();
 274
 275         String message = "Asserting all ontologies are installed";
 276         LOGGER.info(message);
 277         monitor.setTaskName(message);
 278
 279         DatabaseManagement mgmt = new DatabaseManagement();
 280         Map<GraphBundleRef, GraphBundleEx> platformTGs = new HashMap<>();
 281         try {
 282
 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));
 290             }
 291
 292             if(!requireSynchronize && installedTGs.size() > 1 && !Platform.inDevelopmentMode()) return;
 293 //            if(installedTGs.size() > 1) return;
 294
 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             System.err.println("getAllGraphs " + tgs.size());
 301             message = "extend bundles to compile versions";
 302             monitor.subTask(message);
 303             LOGGER.info(message);
 304             for (GraphBundle b : tgs) {
 305                 GraphBundleEx gbe = GraphBundleEx.extend(b);
 306                 gbe.build();
 307                 platformTGs.put(GraphBundleRef.of(b), gbe);
 308             }
 309
 310             // Compile a list of TGs that need to be installed or reinstalled in the database
 311             message = "check bundle reinstallation demand";
 312             monitor.subTask(message);
 313             LOGGER.info(message);
 314             List<GraphBundleEx> installTGs = new ArrayList<>();
 315             // Create list of TGs to update, <newTg, oldTg>
 316             Map<GraphBundleEx,GraphBundleEx> reinstallTGs = new TreeMap<>();
 317             for (Entry<GraphBundleRef, GraphBundleEx> e : platformTGs.entrySet()) {
 318                 GraphBundleRef key = e.getKey();
 319                 GraphBundleEx platformBundle = e.getValue();
 320                 GraphBundleEx existingBundle = installedTGs.get(key);
 321
 322 //                System.out.println("GraphBundleRef key=" + key.toString());
 323
 324                 if (existingBundle == null) {
 325                     // Bundle did not exist in the database, put it into list of bundles to install
 326                     installTGs.add(platformBundle);
 327                 }
 328                 else {
 329                     // Bundle exists in the database
 330                     boolean platformBundleIsNewer = existingBundle.getVersion().compareTo(platformBundle.getVersion())<0;
 331                     if (!platformBundleIsNewer)
 332                         continue;
 333                     // Check hash of transferable graph to know whether to update or not.
 334                     if (platformBundle.getHashcode() == existingBundle.getHashcode())
 335                         continue;
 336                     //System.out.println("Ontology hashcodes do not match: platform bundle="
 337                     //        + platformBundle.getVersionedId() + ", hash=" + platformBundle.getHashcode()
 338                     //        + "; existing bundle=" + existingBundle.getVersionedId() + ", hash=" + existingBundle.getHashcode());
 339                     reinstallTGs.put(platformBundle, existingBundle);
 340                 }
 341             }
 342             // INSTALL
 343             // Database is missing graphs
 344             if (!installTGs.isEmpty() || !reinstallTGs.isEmpty()) {
 345                 session.getService(XSupport.class).setServiceMode(true, true);
 346
 347                 // Throw error
 348                 if (ontologyPolicy == OntologyRecoveryPolicy.ThrowError) {
 349                     StringBuilder sb = new StringBuilder("The following graphs are not installed in the database: ");
 350                     if (!installTGs.isEmpty()) {
 351                         int i = 0;
 352                         for (GraphBundleEx e : installTGs) {
 353                             if (i>0) sb.append(", ");
 354                             i++;
 355                             sb.append(e.toString());
 356                         }
 357                         sb.append(" is missing from the database.\n");
 358                     }
 359                     if (!reinstallTGs.isEmpty()) {
 360                         int i = 0;
 361                         for (Entry<GraphBundleEx, GraphBundleEx> e : reinstallTGs.entrySet()) {
 362                             if (i>0) sb.append(", ");
 363                             i++;
 364                             sb.append(e.getKey().toString());
 365                         }
 366                         sb.append(" Database/Platform Bundle version mismatch.\n");
 367                     }
 368                     sb.append("Hint: Use -fixErrors to install the graphs.");
 369                     throw new PlatformException(sb.toString());
 370                 }
 371                 // Reinstall database
 372                 if (ontologyPolicy == OntologyRecoveryPolicy.ReinstallDatabase) {
 373                     log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Reinstalling the database."));
 374                     // TODO Install DB
 375                     // Stop Session
 376                     // Kill Process
 377                     // Delete Database
 378                     // Create Database
 379                     // Start Database
 380                     // Open Session
 381                     // Install TGs
 382                     throw new PlatformException("Reinstalling Database, NOT IMPLEMENTED");
 383                 }
 384
 385                 if (ontologyPolicy == OntologyRecoveryPolicy.Merge) {
 386                     message = "Merging ontology changes";
 387                     monitor.subTask(message);
 388                     LOGGER.info(message);
 389                     // Sort missing TGs into install order
 390                     GraphDependencyAnalyzer<GraphBundle> analyzer = new GraphDependencyAnalyzer<GraphBundle>();
 391                     for(GraphBundle tg : installTGs) analyzer.addGraph(tg, tg.getGraph());
 392                     for(GraphBundle tg : reinstallTGs.keySet()) analyzer.addGraph(tg, tg.getGraph());
 393                     if(!analyzer.analyzeDependency()) {
 394                         Collection<Pair<GraphBundle, GraphBundle>> problems = analyzer.getConflicts();
 395                         StringBuilder sb = new StringBuilder();
 396                         for (Pair<GraphBundle, GraphBundle> problem : problems) {
 397                             sb.append("Conflict with "+problem.first+" and "+problem.second+".\n");
 398                         }
 399                         throw new PlatformException(sb.toString());
 400                     }
 401                     else if(!session.syncRequest( analyzer.queryExternalDependenciesSatisfied )) {
 402                         Collection<IdentityNode> unsatisfiedDependencies = analyzer.getUnsatisfiedDependencies();
 403                         StringBuilder sb = new StringBuilder();
 404                         for (IdentityNode dep: unsatisfiedDependencies) {
 405                             sb.append("Unsatisfied Dependency "+dep+". Required by\n");
 406                             for(IU iu : GraphDependencyAnalyzer.toCollection(dep.getRequires())) {
 407                                 sb.append("    " + ((GraphBundle)iu.getId()).getId() + "\n");
 408                             }
 409                         }
 410                         throw new PlatformException(sb.toString());
 411                     }
 412
 413                     List<GraphBundle> sortedBundles = analyzer.getSortedGraphs();
 414                     if(!sortedBundles.isEmpty()) {
 415
 416                         session.syncRequest((Write) graph -> {
 417                             try {
 418                                 graph.newClusterSet(graph.getRootLibrary());
 419                             } catch (ClusterSetExistException e) {
 420                                 // Cluster set exist already, no problem.
 421                             }
 422                             graph.setClusterSet4NewResource(graph.getRootLibrary());
 423                             graph.flushCluster();
 424                         });
 425
 426                         boolean mergedOntologies = false;
 427
 428                         // Install TGs
 429                         for(final GraphBundle tg : sortedBundles) {
 430
 431                                 final IImportAdvisor advisor = new OntologyImportAdvisor(tg, mgmt);
 432                                 final GraphBundle oldTG = reinstallTGs.get(tg);
 433
 434                                 boolean createImmutable = tg.getImmutable();
 435
 436                                 if (oldTG==null) {
 437
 438                                 session.getService(XSupport.class).setServiceMode(true, createImmutable);
 439
 440                                         // Install TG
 441                                         log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Installing "+tg.toString()+" - "+tg.getName()));
 442                                         ImportResult result = TransferableGraphs.importGraph1(session, new TGTransferableGraphSource(tg.getGraph()), advisor, null);
 443                                         if (!result.missingExternals.isEmpty()) {
 444                                                 log.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Import of " + tg.toString() + " was missing the following external entities:\n" + EString.implode(result.missingExternals)));
 445                                         }
 446                                 } else {
 447                                         if(!createImmutable)
 448                                                 continue;
 449
 450                                         // Merge TG
 451                                         startTransaction(session, false);
 452                                         TransferableGraphDelta1 delta = new Diff(oldTG.getGraph(), tg.getGraph()).diff();
 453                                         final long[] oldResources = oldTG.getResourceArray();
 454                                         boolean changes = TransferableGraphs.hasChanges(readGraph(), oldResources, delta);
 455                                         endTransaction();
 456                                         if (!changes) {
 457                                             //log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Nothing to merge for "+tg.toString()));
 458                                             continue;
 459                                         }
 460
 461                                 log.log(new Status(IStatus.INFO, Activator.PLUGIN_ID, "Merging new version of "+tg.toString()));
 462
 463                                         startTransaction(session, true);
 464
 465                                         //delta.print();
 466                                         try {
 467                                                 long[] resourceArray = TransferableGraphs.applyDelta(writeGraph(), oldResources, delta);
 468                                                 tg.setResourceArray(resourceArray);
 469                                                 mgmt.setGraphBundleEntry(tg);
 470                                                 commit();
 471                                                 mergedOntologies = true;
 472                                         } catch (Throwable t) {
 473                                                 throw new PlatformException(t);
 474                                         } finally {
 475                                                 endTransaction();
 476                                         }
 477                                 }
 478                         }
 479
 480                         session.syncRequest((Write) graph -> {
 481                             graph.setClusterSet4NewResource(graph.getRootLibrary());
 482                             graph.flushCluster();
 483                         });
 484
 485                         if (mergedOntologies)
 486                             DatabaseIndexing.deleteAllIndexes();
 487                     }
 488                 }
 489                 session.getService(XSupport.class).setServiceMode(false, false);
 490             }
 491             monitor.worked(100);
 492         } catch (IOException e) {
 493             throw new PlatformException(e);
 494         } catch (DatabaseException e) {
 495             throw new PlatformException(e);
 496         }
 497
 498     }
 499
 500     public boolean assertConfiguration(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy) throws PlatformException {
 501
 502         if (progressMonitor == null) progressMonitor = new NullProgressMonitor();
 503
 504         File workspaceLocation = Platform.getLocation().toFile();
 505
 506         boolean installProject = false;
 507         progressMonitor.setTaskName("Asserting simantics.cfg is installed");
 508         try {
 509             File propertyFile = new File(workspaceLocation, "simantics.cfg");
 510             Properties properties;
 511             try {
 512                 properties = WorkspaceUtil.readProperties(propertyFile);
 513             } catch (IOException e) {
 514                 if (workspacePolicy == RecoveryPolicy.ThrowError) throw new PlatformException("Could not load "+propertyFile);
 515
 516                 // Create a project and write Property file
 517                 properties = new Properties();
 518                 properties.setProperty("project_uri", "http://Projects/Development%20Project");
 519                 properties.setProperty("project_name", "Development Project");
 520                 WorkspaceUtil.writeProperties(propertyFile, properties);
 521                 installProject |= true;
 522             }
 523             projectURI = properties.getProperty("project_uri");
 524             projectName = properties.getProperty("project_name");
 525             progressMonitor.worked(10);
 526         } catch (IOException e) {
 527             throw new PlatformException(e);
 528         }
 529
 530         return installProject;
 531
 532     }
 533
 534     public boolean assertProject(IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy, boolean installProject) throws PlatformException {
 535
 536         SubMonitor monitor = SubMonitor.convert(progressMonitor, 10);
 537
 538         final DatabaseManagement mgmt = new DatabaseManagement();
 539
 540         monitor.setTaskName("Asserting project resource exists in the database");
 541         try {
 542             projectResource = session.syncRequest( Queries.resource( projectURI ) );
 543         } catch (ResourceNotFoundException nfe) {
 544             // Project was not found
 545             if (workspacePolicy == RecoveryPolicy.ThrowError)
 546                 throw new PlatformException("Project Resource "+projectURI+" is not found in the database.");
 547             // Create empty project with no features
 548             try {
 549                 Transaction.startTransaction(session, true);
 550                 try {
 551                     // The project needs to be created mutable.
 552                     session.getService(XSupport.class).setServiceMode(true, false);
 553
 554                     ArrayList<String> empty = new ArrayList<String>();
 555                     projectResource = mgmt.createProject(projectName, empty);
 556                     installProject |= true;
 557
 558                     session.getService(XSupport.class).setServiceMode(false, false);
 559                     Transaction.commit();
 560                 } finally {
 561                     Transaction.endTransaction();
 562                 }
 563                 //session.getService( LifecycleSupport.class ).save();
 564             } catch (DatabaseException e) {
 565                 throw new PlatformException("Failed to create "+projectURI, e);
 566             }
 567         } catch (DatabaseException e) {
 568             throw new PlatformException("Failed to create "+projectURI, e);
 569         }
 570         monitor.worked(10);
 571
 572         return installProject;
 573
 574     }
 575
 576     public void updateInstalledGroups(IProgressMonitor progressMonitor, boolean installProject) throws PlatformException {
 577
 578         if (installProject)
 579         {
 580             // Attach all feature groups available in platform to created project
 581             progressMonitor.setTaskName("Install all features");
 582             Set<GroupReference> publishedFeatureGroups = ProjectFeatures.getInstallGroupsOfPublishedFeatures();
 583             Collection<GroupReference> groupsWithoutVersion = GroupReference.stripVersions(publishedFeatureGroups);
 584
 585             try {
 586                 session.syncRequest(
 587                         (Write) graph ->
 588                         Projects.setProjectInstalledGroups(graph, projectResource, groupsWithoutVersion));
 589             } catch (DatabaseException ae) {
 590                 throw new PlatformException("Failed to install features", ae);
 591             }
 592             progressMonitor.worked(10);
 593         }
 594
 595     }
 596
 597     public void assertSessionModel(IProgressMonitor progressMonitor) throws PlatformException {
 598
 599         Properties properties = session.getService(Properties.class);
 600         final String clientId = properties.getProperty("clientId");
 601
 602         try {
 603
 604             // Currently this needs to be done before data becomes available
 605             VirtualGraphSupport support = session.getService(VirtualGraphSupport.class);
 606             VirtualGraph activations = support.getWorkspacePersistent("activations");
 607
 608             Resource sessionModel = session.syncRequest(new Read<Resource>() {
 609
 610                 @Override
 611                 public Resource perform(ReadGraph graph) throws DatabaseException {
 612
 613                     Layer0X L0X = Layer0X.getInstance(graph);
 614                     for(Resource sessionModel : graph.syncRequest(new ObjectsWithType(graph.getRootLibrary(), L0X.HasSession, L0X.Session))) {
 615                         String id = graph.getPossibleRelatedValue(sessionModel, L0X.Session_HasClientId);
 616                         if(id != null && id.equals(clientId)) return sessionModel;
 617                     }
 618                     return null;
 619
 620                 }
 621
 622             });
 623
 624             if(sessionModel == null) {
 625
 626                 sessionModel = session.syncRequest(new WriteResultRequest<Resource>(activations) {
 627
 628                     @Override
 629                     public Resource perform(WriteGraph graph) throws DatabaseException {
 630                         Layer0 L0 = Layer0.getInstance(graph);
 631                         Layer0X L0X = Layer0X.getInstance(graph);
 632                         Resource session = graph.newResource();
 633                         graph.claim(session, L0.InstanceOf, null, L0X.Session);
 634                         graph.claim(session, L0X.Session_HasUser, null, graph.getResource("http://Users/AdminUser"));
 635                         graph.addLiteral(session, L0X.Session_HasClientId, L0X.Session_HasClientId_Inverse, clientId, Bindings.STRING);
 636                         graph.claim(graph.getRootLibrary(), L0X.HasSession, session);
 637                         return session;
 638                     }
 639                 });
 640
 641             }
 642
 643             session.registerService(SessionModel.class, new PlatformSessionModel(sessionModel));
 644         } catch (DatabaseException e) {
 645             throw new PlatformException(e);
 646         }
 647
 648     }
 649
 650     static class PlatformSessionModel implements SessionModel {
 651         private final Resource sessionModel;
 652
 653         public PlatformSessionModel(Resource model) {
 654             this.sessionModel = model;
 655         }
 656
 657         @Override
 658         public Resource getResource() {
 659             return sessionModel;
 660         }
 661     }
 662
 663     public void resetDatabase(IProgressMonitor monitor) throws PlatformException {
 664         File dbLocation = Platform.getLocation().append("db").toFile();
 665         if(!dbLocation.exists()) return;
 666         try { // Load driver
 667             Driver driver = Manager.getDriver("procore");
 668             Management management = driver.getManagement(dbLocation.getAbsolutePath(), null);
 669             management.delete();
 670         } catch (DatabaseException e) {
 671             throw new PlatformException("Failed to remove database at " + dbLocation.getAbsolutePath(), e);
 672         }
 673         // We have created extra files to database folder which have to be deleted also.
 674         // This is an awful idea! Do not create extra files to database folder!
 675         Throwable t = null;
 676         for (int i=0; i<10; ++i) {
 677             try {
 678                 FileUtils.deleteAll(dbLocation);
 679                 t = null;
 680                 break;
 681             } catch (IOException e) {
 682                 // Assuming this has been thrown because delete file/folder failed.
 683                 t = e;
 684             }
 685             try {
 686                 Thread.sleep(200);
 687             } catch (InterruptedException e) {
 688                 // Ignoring interrupted exception.
 689             }
 690         }
 691         if (null != t)
 692             throw new PlatformException("Failed to remove database folder at " + dbLocation.getAbsolutePath(), t);
 693     }
 694     public void resetWorkspace(IProgressMonitor monitor, ArrayList<String> fileFilter) throws PlatformException, IllegalStateException, IOException {
 695         File file = Platform.getLocation().toFile();
 696         if (null != fileFilter)
 697             FileUtils.deleteAllWithFilter(file , fileFilter);
 698         resetDatabase(monitor);
 699     }
 700
 701     private static Path tryGetInstallLocation() {
 702         Location l = Platform.getInstallLocation();
 703         return l == null ? null : new File(l.getURL().getPath()).toPath();
 704     }
 705
 706     private Path resolveBaselineFile() throws PlatformException {
 707         String dbBaselineArchive = System.getProperty("org.simantics.db.baseline", null);
 708         if (dbBaselineArchive == null)
 709             return null;
 710
 711         Path baseline = Paths.get(dbBaselineArchive);
 712         if (baseline.isAbsolute()) {
 713             if (!Files.isRegularFile(baseline))
 714                 throw new PlatformException("Specified database baseline archive " + baseline
 715                         + " does not exist. Cannot initialize workspace database from baseline.");
 716             return baseline;
 717         }
 718
 719         // Relative path resolution order:
 720         // 1. from the platform "install location"
 721         // 2. from working directory
 722         Path installLocation = tryGetInstallLocation();
 723         if (installLocation != null) {
 724             Path installedBaseline = installLocation.resolve(dbBaselineArchive);
 725             if (Files.isRegularFile(installedBaseline))
 726                 return installedBaseline;
 727         }
 728         if (!Files.isRegularFile(baseline))
 729             throw new PlatformException("Specified database baseline archive " + baseline
 730                     + " does not exist in either the install location (" + installLocation
 731                     + ") or the working directory (" + Paths.get(".").toAbsolutePath()
 732                     + "). Cannot initialize workspace database.");
 733         return null;
 734     }
 735
 736     private boolean handleBaselineDatabase() throws PlatformException {
 737         Path workspaceLocation = Platform.getLocation().toFile().toPath();
 738         Path baselineIndicatorFile = workspaceLocation.resolve(".baselined");
 739         if (Files.isRegularFile(baselineIndicatorFile)) {
 740             // This means that the workspace has already been initialized from
 741             // a database baseline and further initialization is not necessary.
 742             return true;
 743         }
 744
 745         Path baseline = resolveBaselineFile();
 746         if (baseline == null)
 747             return false;
 748
 749         DatabaseBaselines.validateBaselineFile(baseline);
 750         DatabaseBaselines.validateWorkspaceForBaselineInitialization(workspaceLocation);
 751         DatabaseBaselines.initializeWorkspaceWithBaseline(baseline, workspaceLocation, baselineIndicatorFile);
 752         return true;
 753     }
 754
 755     /**
 756      * Start-up the platform. The procedure consists of 8 steps. Once everything
 757      * is up and running, all fields are set property.
 758      * <p>
 759      *
 760      * If workspacePolicy is FixErrors, there is an attempt to fix unexpected
 761      * errors. It includes installing database files, installing ontologies, and
 762      * installing project features.
 763      * <p>
 764      *
 765      * In Simantics Workbench this is handled in
 766      * <code>SimanticsWorkbenchAdvisor#openWindows()</code>.
 767      * <p>
 768      *
 769      * If remote server is given, simantics plaform takes connection there
 770      * instead of local server at "db/".
 771      *
 772      * @param workspacePolicy action to take on workspace/database related
 773      *        errors
 774      * @param ontologyPolicy action to take on ontology mismatch
 775      * @param progressMonitor optional progress monitor
 776      * @param userAgent interface for resorting to user feedback during platform
 777      *        startup or <code>null</code> to resort to default measures
 778      * @throws PlatformException
 779      */
 780     public synchronized SessionContext startUp(String databaseDriverId, IProgressMonitor progressMonitor, RecoveryPolicy workspacePolicy,
 781             OntologyRecoveryPolicy ontologyPolicy, boolean requireSynchronize, PlatformUserAgent userAgent)
 782     throws PlatformException
 783     {
 784
 785         assert(!running);
 786         TimeLogger.log("Beginning of SimanticsPlatform.startUp");
 787
 788         LOGGER.info("Beginning of SimanticsPlatform.startUp");
 789
 790         SubMonitor monitor = SubMonitor.convert(progressMonitor, 1000);
 791
 792         // For debugging on what kind of platform automatic tests are running in
 793         // case there are problems.
 794         if ("true".equals(System.getProperty("org.simantics.dumpBundleState")))
 795             dumpPlatformBundleState();
 796
 797         // 0. Consult all startup extensions before doing anything with the workspace.
 798         StartupExtensions.consultStartupExtensions();
 799         TimeLogger.log("Consulted platform pre-startup extensions");
 800
 801         // 0.1. Clear all temporary files
 802         Simantics.clearTemporaryDirectory();
 803         TimeLogger.log("Cleared temporary directory");
 804
 805         // 0.2 Clear VariableRepository.repository static map which holds references to SessionImplDb
 806         VariableRepository.clear();
 807
 808         // 0.3 Handle baseline database before opening db
 809         @SuppressWarnings("unused")
 810         boolean usingBaseline = handleBaselineDatabase();
 811
 812         // 1. Assert there is a database at <workspace>/db
 813         SessionDescriptor sessionDescriptor = setupDatabase(databaseDriverId, monitor.newChild(200, SubMonitor.SUPPRESS_NONE), workspacePolicy, userAgent);
 814         session = sessionDescriptor.getSession();
 815         TimeLogger.log("Database setup complete");
 816
 817         // 2. Delete all indexes if we cannot be certain they are up-to-date
 818         //    A full index rebuild will be done later, before project activation.
 819         XSupport support = session.getService(XSupport.class);
 820         if (support.rolledback()) {
 821             try {
 822                 DatabaseIndexing.deleteAllIndexes();
 823             } catch (IOException e) {
 824                 throw new PlatformException(e);
 825             }
 826         }
 827
 828         // 3. Assert all graphs, and correct versions, are installed to the database
 829         synchronizeOntologies(monitor.newChild(400, SubMonitor.SUPPRESS_NONE), ontologyPolicy, requireSynchronize);
 830         TimeLogger.log("Synchronized ontologies");
 831
 832         // 4. Assert simantics.cfg exists
 833         boolean installProject = assertConfiguration(monitor.newChild(25, SubMonitor.SUPPRESS_NONE),workspacePolicy);
 834
 835         // 5. Assert Project Resource is installed in the database
 836         installProject = assertProject(monitor.newChild(25, SubMonitor.SUPPRESS_NONE), workspacePolicy, installProject);
 837
 838         // 6. Install all features into project, if in debug mode
 839         updateInstalledGroups(monitor.newChild(25), true); //installProject);
 840         TimeLogger.log("Installed all features into project");
 841
 842         // 7. Assert L0.Session in database for this session
 843         assertSessionModel(monitor.newChild(25, SubMonitor.SUPPRESS_NONE));
 844
 845         session.getService(XSupport.class).setServiceMode(false, false);
 846
 847         try {
 848             monitor.setTaskName("Flush query cache");
 849             session.syncRequest((Write) graph -> {
 850                 QueryControl qc = graph.getService(QueryControl.class);
 851                 qc.flush(graph);
 852             });
 853             TimeLogger.log("Flushed queries");
 854         } catch (DatabaseException e) {
 855             LOGGER.error("Flushing queries failed.", e);
 856         }
 857         boolean loadProject = true;
 858         try {
 859
 860             monitor.setTaskName("Open database session");
 861                 sessionContext = SimanticsPlatform.INSTANCE.createSessionContext(true);
 862                 // This must be before setSessionContext since some listeners might query this
 863             sessionContext.setHint(SimanticsKeys.KEY_PROJECT, SimanticsPlatform.INSTANCE.projectResource);
 864
 865             Simantics.setSessionContext(sessionContext);
 866
 867             // 1. Put ResourceBinding that throws an exception to General Bindings
 868             simanticsBindings = new SimanticsBindings( null );
 869             Bindings.classBindingFactory.addFactory( simanticsBindings );
 870
 871
 872             // 2. Create session-specific second Binding context (Databoard) and
 873             //    put that to Session as a service
 874             Session session = sessionContext.getSession();
 875             Databoard sessionDataboard = new Databoard();
 876             session.registerService(Databoard.class, sessionDataboard);
 877             simanticsBindings2 = new SimanticsBindings( session );
 878             sessionDataboard.classBindingFactory.addFactory( simanticsBindings2 );
 879
 880             // Register datatype bindings
 881             Bindings.defaultBindingFactory.getRepository().put(RGB.Integer.BINDING.type(), RGB.Integer.BINDING);
 882             Bindings.defaultBindingFactory.getRepository().put(Font.BINDING.type(), Font.BINDING);
 883
 884             if (support.rolledback() || sessionDescriptor.isFreshDatabase()) {
 885                 monitor.setTaskName("Rebuilding all indexes");
 886                 try {
 887                     session.getService(IndexedRelations.class).fullRebuild(monitor.newChild(100), session);
 888                 } catch (IndexException e) {
 889                     LOGGER.error("Failed to re-build all indexes", e);
 890                 }
 891             } else {
 892                 monitor.worked(100);
 893             }
 894
 895             if(loadProject) {
 896                 TimeLogger.log("Load project");
 897                 monitor.setTaskName("Load project");
 898                 project = Projects.loadProject(sessionContext.getSession(), SimanticsPlatform.INSTANCE.projectResource);
 899                 sessionContext.setHint(ProjectKeys.KEY_PROJECT, project);
 900                 monitor.worked(100);
 901                 TimeLogger.log("Loading projects complete");
 902
 903                 monitor.setTaskName("Activate project");
 904                 project.activate();
 905                 monitor.worked(100);
 906                 TimeLogger.log("Project activated");
 907             }
 908
 909         } catch (DatabaseException e) {
 910             LOGGER.error("Platform startup failed.", e);
 911             throw new PlatformException(e);
 912         } catch (ProjectException e) {
 913             boolean hasStackTrace = e.getStackTrace().length > 0;
 914             if (!hasStackTrace)
 915                 throw new PlatformException(e.getMessage(), hasStackTrace);
 916             throw new PlatformException(e, hasStackTrace);
 917         }
 918
 919         running = true;
 920
 921         // #7650: improve shutdown robustness in all applications that use the platform
 922         Runtime.getRuntime().addShutdownHook(shutdownHook);
 923
 924         // Discard database session undo history at this point to prevent
 925         // the user from undoing any initialization operations performed
 926         // by the platform startup.
 927         SimanticsPlatform.INSTANCE.discardSessionUndoHistory();
 928         TimeLogger.log("Discarded session undo history");
 929
 930         return sessionContext;
 931
 932     }
 933
 934     public SessionContext createSessionContext(boolean init) throws PlatformException {
 935         try {
 936             // Construct and initialize SessionContext from Session.
 937             SessionContext sessionContext = SessionContext.create(session, init);
 938             TimeLogger.log("Session context created");
 939             if (init) {
 940                 sessionContext.registerServices();
 941                 TimeLogger.log("Session services registered");
 942             }
 943             return sessionContext;
 944         } catch (DatabaseException e) {
 945             throw new PlatformException(e);
 946         }
 947     }
 948
 949     /**
 950      * Perform normal shutdown for the Simantics Platform.
 951      *
 952      * @param progressMonitor optional progress monitor
 953      * @throws PlatformException
 954      * @see {@link #shutdown(IProgressMonitor, boolean)}
 955      */
 956     public synchronized void shutdown(IProgressMonitor progressMonitor) throws PlatformException {
 957         shutdown(progressMonitor, true);
 958     }
 959
 960     /**
 961      * Shutdown Simantics Platform.
 962      *
 963      * In Simantics Workbench this is handled in
 964      * <code>SimanticsWorkbenchAdvisor#disconnectFromWorkspace</code>.
 965      *
 966      * @param progressMonitor
 967      *            optional progress monitor
 968      * @param clearTemporaryFiles
 969      *            allow or prevent deletion of temporary files at the end of the
 970      *            shutdown procedure
 971      * @throws PlatformException
 972      */
 973     public synchronized void shutdown(IProgressMonitor progressMonitor, boolean clearTemporaryFiles) throws PlatformException
 974     {
 975         SubMonitor progress = SubMonitor.convert(progressMonitor, 100);
 976         PlatformException platformException = null;
 977         try {
 978             progress.subTask("Close Project");
 979             if (project != null) {
 980                 project.safeDispose();
 981             }
 982             progress.worked(10);
 983
 984             running = false;
 985             progress.subTask("Close Database Session");
 986             Databoard databoard = null;
 987             if (sessionContext != null) {
 988                 Session s = sessionContext.peekSession();
 989                 if (s != null) {
 990                     databoard = s.peekService(Databoard.class);
 991
 992                     progress.subTask("Flushing Index Caches");
 993                     try {
 994                         Simantics.flushIndexCaches(progress.newChild(20), s);
 995                     } catch (Throwable t) {
 996                         LOGGER.error("Failed to flush index caches.", t);
 997                     }
 998                 }
 999
1000                 progress.subTask("Close Database Session");
1001                 sessionContext.safeDispose();
1002                 sessionContext = null;
1003                 Simantics.setSessionContext(null);
1004             }
1005             if (simanticsBindings != null) {
1006                 Bindings.classBindingFactory.removeFactory( simanticsBindings );
1007                 simanticsBindings = null;
1008             }
1009             if (databoard != null) {
1010                 if (simanticsBindings2 != null) {
1011                         databoard.classBindingFactory.removeFactory( simanticsBindings2 );
1012                         simanticsBindings2 = null;
1013                 }
1014                 databoard.clear();
1015             }
1016
1017             // Make sure Simantics clipboard doesn't store unwanted session data references.
1018             Simantics.setClipboard(new SimanticsClipboardImpl());
1019
1020             progress.worked(30);
1021
1022             session = null;
1023             projectResource = null;
1024             currentDatabaseDriver = null;
1025
1026             DependenciesRelation.assertFinishedTracking();
1027
1028         } catch (Exception e) {
1029             platformException = new PlatformException("Failed to shutdown Simantics Platform", e);
1030         }
1031
1032         progress.worked(10);
1033         progress.subTask("Shutting down database");
1034         try {
1035             if (null != databasebManagement)
1036                 databasebManagement.shutdown();
1037         } catch (Throwable t) {
1038             LOGGER.error("Database shutdown failed.", t);
1039         }
1040         progress.worked(10);
1041
1042         if (clearTemporaryFiles) {
1043             progress.subTask("Clearing Workspace Temporary Directory");
1044             try {
1045                 Simantics.clearTemporaryDirectory();
1046             } catch (Throwable t) {
1047                 LOGGER.error("Failed to clear the temporary directory.", t);
1048             }
1049         }
1050         progress.worked(10);
1051         if (null != platformException)
1052             throw platformException;
1053
1054         // #7650: improve shutdown robustness in all applications that use the platform
1055         Runtime.getRuntime().removeShutdownHook(shutdownHook);
1056     }
1057
1058     // TODO: consider removing this in the future ??
1059     @Override
1060     public void stateChanged(LifecycleState newState) {
1061         if(newState == LifecycleState.CLOSED) {
1062             if(running) {
1063                 if(Platform.isRunning()) {
1064                     mainThread.interrupt();
1065                 }
1066             }
1067         }
1068     }
1069
1070     /**
1071      * @return <code>true</code> if discard was successful, <code>false</code>
1072      *         if there was no session, {@link UndoRedoSupport} or
1073      *         {@link UndoContext} to discard through
1074      */
1075     public boolean discardSessionUndoHistory() {
1076         Session s = session;
1077         if (s != null) {
1078             UndoRedoSupport urs = s.peekService(UndoRedoSupport.class);
1079             if (urs != null) {
1080                 UndoContext uc = urs.getUndoContext(s);
1081                 if (uc != null) {
1082                     uc.clear();
1083                     return true;
1084                 }
1085             }
1086         }
1087         return false;
1088     }
1089
1090     public void reconnect(String databaseDriverId) throws Exception {
1091         // Starts database server.
1092         if (currentDatabaseDriver != null)
1093             databaseDriverId = currentDatabaseDriver;
1094         SimanticsPlatform.INSTANCE.startUp(databaseDriverId, null, RecoveryPolicy.ThrowError, OntologyRecoveryPolicy.ThrowError, true, null);
1095     }
1096
1097     private void dumpPlatformBundleState() {
1098         BundleDescription[] bs = Platform.getPlatformAdmin().getState().getBundles();
1099         System.out.println("Total bundles: " + bs.length);
1100         for (BundleDescription b : bs) {
1101             System.out.format("%-80s @ %s\n", b.toString(), b.getLocation());
1102         }
1103     }
1104
1105     private Ini loadOrCreateDatabaseIni(Path path, String databaseDriverId)
1106             throws InvalidFileFormatException, IOException
1107     {
1108         File f = path.toFile();
1109         Ini dbIni = Files.isRegularFile(path) ? new Ini(f) : new Ini();
1110         String iniId = dbIni != null ? dbIni.get("driver", "id") : null;
1111         if (iniId == null) {
1112             dbIni.put("driver", "id", databaseDriverId);
1113             dbIni.store(f);
1114         }
1115         return dbIni;
1116     }
1117
1118 }