bundles/org.simantics.modeling/src/org/simantics/modeling/UserComponentMigration.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014, 2015 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  *     Semantum Oy - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.modeling;
  13
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.Comparator;
  18 import java.util.Set;
  19
  20 import org.eclipse.core.runtime.IProgressMonitor;
  21 import org.eclipse.core.runtime.NullProgressMonitor;
  22 import org.simantics.Simantics;
  23 import org.simantics.databoard.Bindings;
  24 import org.simantics.databoard.util.URIStringUtils;
  25 import org.simantics.db.ReadGraph;
  26 import org.simantics.db.Resource;
  27 import org.simantics.db.WriteGraph;
  28 import org.simantics.db.common.NamedResource;
  29 import org.simantics.db.common.request.PossibleIndexRoot;
  30 import org.simantics.db.common.utils.NameUtils;
  31 import org.simantics.db.common.utils.VersionMap;
  32 import org.simantics.db.common.utils.Versions;
  33 import org.simantics.db.exception.CancelTransactionException;
  34 import org.simantics.db.exception.DatabaseException;
  35 import org.simantics.db.layer0.adapter.Instances;
  36 import org.simantics.db.layer0.request.ActiveModels;
  37 import org.simantics.db.layer0.request.ListIndexRoots;
  38 import org.simantics.db.layer0.util.Layer0Utils;
  39 import org.simantics.diagram.stubs.DiagramResource;
  40 import org.simantics.layer0.Layer0;
  41 import org.simantics.modeling.MigrateModel.MigrationOperation;
  42 import org.simantics.modeling.migration.UserComponentPostMigrationAction;
  43 import org.simantics.structural.stubs.StructuralResource2;
  44 import org.simantics.utils.datastructures.MapList;
  45 import org.simantics.utils.datastructures.Pair;
  46 import org.simantics.utils.datastructures.Triple;
  47 import org.simantics.utils.strings.AlphanumComparator;
  48
  49 import gnu.trove.set.hash.THashSet;
  50
  51 /**
  52  * @author Antti Villberg
  53  * @author Tuukka Lehtonen
  54  */
  55 public class UserComponentMigration {
  56
  57     public static void migrateUserComponents(WriteGraph graph, Resource source, Resource target, Collection<Resource> components) throws DatabaseException {
  58         MigrateModel model = getComponentTypeModel(graph, source, target, null);
  59         if (model.instances.isEmpty())
  60             return;
  61         Triple<String, NamedResource, Collection<MigrationOperation>> instances = model.instances.get(0);
  62         ArrayList<MigrationOperation> result = new ArrayList<>();
  63
  64         for (MigrationOperation instance : instances.third) {
  65             if (components.contains(instance.instanceToMigrate.getResource())) {
  66                result.add(instance);
  67             }
  68         }
  69         if (!result.isEmpty())
  70             doMigration(new NullProgressMonitor(), graph, result);
  71     }
  72
  73     public static String doMigration(IProgressMonitor monitor, WriteGraph graph, final ArrayList<MigrationOperation> operations) throws DatabaseException {
  74         graph.markUndoPoint();
  75         StringBuilder b = new StringBuilder();
  76         int success = 0;
  77         int problem = 0;
  78         int no = 1;
  79         int count = operations.size();
  80         monitor.setTaskName("Migrating " + count + " User Components");
  81         for(MigrationOperation op : operations) {
  82             if (monitor.isCanceled())
  83                 throw new CancelTransactionException();
  84             monitor.subTask("(" + (no++) + "/" + count + ") " + op.toString());
  85             String problems = op.perform(graph);
  86             if(problems != null) {
  87                 b.insert(0, problems);
  88                 b.insert(0, op.getDescription(graph) + "\n");
  89                 problem++;
  90             } else {
  91                 b.append(op.getDescription(graph) + "\n");
  92                 b.append(" success\n");
  93                 success++;
  94             }
  95         }
  96         int total = success + problem;
  97         b.insert(0, "---------------------\n");
  98         b.insert(0, "Details:\n");
  99         b.insert(0, "\n");
 100         b.insert(0, "  OK: " + success + "\n");
 101         b.insert(0, "  Failure: " + problem + "\n");
 102         b.insert(0, "---------------------\n");
 103         b.insert(0, "Performed migration for " + total + " instances:\n");
 104
 105         Layer0Utils.addCommentMetadata(graph, "Migrated " + total + " instances");
 106         return b.toString();
 107     }
 108
 109     public static void doPostMigration(IProgressMonitor monitor, WriteGraph graph, ArrayList<MigrationOperation> result) throws DatabaseException {
 110         THashSet<Resource> roots = new THashSet<>();
 111         for(MigrationOperation op : result) {
 112             Resource root = graph.syncRequest(new PossibleIndexRoot(op.instanceToMigrate.getResource()));
 113             if(root != null)
 114                 roots.add(root);
 115         }
 116         if (monitor.isCanceled())
 117             throw new CancelTransactionException();
 118         for(Resource root : roots) {
 119             UserComponentPostMigrationAction action = graph.getPossibleAdapter(root, UserComponentPostMigrationAction.class);
 120             if(action != null)
 121                 action.perform(monitor, graph);
 122         }
 123     }
 124
 125     public static MigrateModel getComponentTypeModel(ReadGraph graph, Resource source, Resource target, Resource symbol) throws DatabaseException {
 126         MigrateModel model = newMigrateModel(graph);
 127
 128         MapList<NamedResource, MigrationOperation> list = new MapList<>();
 129
 130         Layer0 L0 = Layer0.getInstance(graph);
 131         DiagramResource DIA = DiagramResource.getInstance(graph);
 132         Instances query = graph.adapt(source, Instances.class);
 133         Set<Resource> instances = new THashSet<>();
 134         for(NamedResource nr : getLocations(graph, Simantics.getProjectResource())) {
 135             Collection<Resource> found = query.find(graph, nr.getResource());
 136             instances.addAll(found);
 137         }
 138
 139         model.instanceCount = instances.size();
 140         for(Resource instance : instances) {
 141
 142             String uri = graph.getPossibleURI(instance);
 143
 144             Resource element = ModelingUtils.getPossibleElement(graph, instance);
 145             if(element == null) {
 146                 MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), null);
 147                 addInstance(list, graph, instance, op);
 148                 continue;
 149             }
 150
 151             Resource instanceSymbol = graph.getPossibleType(element, DIA.Element);
 152             if(instanceSymbol == null) continue;
 153
 154             if(symbol != null) {
 155                 if(!symbol.equals(instanceSymbol)) {
 156                     MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), new NamedResource("", symbol));
 157                     addInstance(list, graph, instance, op);
 158                 }
 159             } else {
 160                 String instanceSymbolName = graph.getRelatedValue(instanceSymbol, L0.HasName, Bindings.STRING);
 161                 Resource targetSymbol = Layer0Utils.getPossibleChild(graph, target, DIA.ElementClass, instanceSymbolName);
 162                 if(targetSymbol != null && !targetSymbol.equals(instanceSymbol)) {
 163                     MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), new NamedResource("", targetSymbol));
 164                     addInstance(list, graph, instance, op);
 165                 }
 166             }
 167
 168         }
 169
 170         sortInstances(model, list);
 171
 172         return model;
 173     }
 174
 175     public static MigrateModel getSharedOntologyModel(ReadGraph graph, Resource sourceOntology, Resource targetOntology) throws DatabaseException {
 176         MigrateModel model = newMigrateModel(graph);
 177
 178         MapList<NamedResource, MigrationOperation> list = new MapList<>();
 179
 180         Layer0 L0 = Layer0.getInstance(graph);
 181         DiagramResource DIA = DiagramResource.getInstance(graph);
 182         StructuralResource2 STR = StructuralResource2.getInstance(graph);
 183         Instances query = graph.adapt(STR.ComponentType, Instances.class);
 184
 185         Set<Resource> types = new THashSet<>();
 186         for(Resource type : query.find(graph, sourceOntology)) {
 187             // TODO: haxx
 188             if(graph.isInheritedFrom(type, DIA.Element)) continue;
 189             Resource root = graph.syncRequest(new PossibleIndexRoot(type));
 190             if(sourceOntology.equals(root)) types.add(type);
 191         }
 192
 193         Set<Resource> instances = new THashSet<>();
 194         Collection<NamedResource> locations = getLocations(graph, Simantics.getProjectResource());
 195
 196         for(Resource type : types) {
 197             Instances query2 = graph.adapt(type, Instances.class);
 198             for(NamedResource nr : locations) {
 199                 Collection<Resource> found = query2.find(graph, nr.getResource());
 200                 instances.addAll(found);
 201             }
 202         }
 203
 204         model.instanceCount = instances.size();
 205         for(Resource instance : instances) {
 206             Resource type = graph.getPossibleType(instance, STR.Component);
 207             String uri = graph.getPossibleURI(instance);
 208             if (type == null || uri == null) {
 209                 System.err.println("CANNOT MIGRATE INSTANCE DUE TO TYPING PROBLEM: " + NameUtils.getURIOrSafeNameInternal(graph, instance));
 210                 continue;
 211             }
 212             NamedResource best = matchBest(graph, type, targetOntology);
 213             if(best != null) {
 214
 215                 Resource element = ModelingUtils.getPossibleElement(graph, instance);
 216                 if(element == null) {
 217                     MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), best, null);
 218                     addInstance(list, graph, instance, op);
 219                     continue;
 220                 }
 221
 222                 Resource instanceSymbol = graph.getPossibleType(element, DIA.Element);
 223                 if(instanceSymbol == null) continue;
 224
 225                 String instanceSymbolName = graph.getRelatedValue(instanceSymbol, L0.HasName, Bindings.STRING);
 226                 Resource targetSymbol = Layer0Utils.getPossibleChild(graph, best.getResource(), DIA.ElementClass, instanceSymbolName);
 227                 if(targetSymbol != null && !targetSymbol.equals(instanceSymbol)) {
 228                     MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), best, new NamedResource("", targetSymbol));
 229                     addInstance(list, graph, instance, op);
 230                 }
 231
 232             }
 233         }
 234
 235         sortInstances(model, list);
 236
 237         return model;
 238     }
 239
 240     private static Collection<NamedResource> getLocations(ReadGraph graph, final Resource project) throws DatabaseException {
 241         Collection<NamedResource> libraries = new ArrayList<>();
 242         for (Resource r : graph.syncRequest(new ListIndexRoots())) {
 243             String name = Versions.getStandardNameString(graph, r);
 244             libraries.add(new NamedResource(name, r));
 245         }
 246 //        Collection<Resource> ontologies = Simantics.applySCL("Simantics/SharedOntologies", "traverseSharedOntologies", graph, graph.getRootLibrary());
 247 //        for (Resource r : ontologies) {
 248 //            String name = Versions.getStandardNameString(graph, r);
 249 //            libraries.add(new NamedResource(name, r));
 250 //        }
 251         return libraries;
 252     }
 253
 254     private static final Comparator<NamedResource> NAMED_RESOURCE_COMPARATOR = new Comparator<NamedResource>() {
 255         @Override
 256         public int compare(NamedResource o1, NamedResource o2) {
 257             return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getName(), o2.getName());
 258         }
 259     };
 260
 261     private static void sortInstances(MigrateModel model, MapList<NamedResource, MigrationOperation> list) {
 262         ArrayList<NamedResource> keys = new ArrayList<>(list.getKeys());
 263         Collections.sort(keys, NAMED_RESOURCE_COMPARATOR);
 264         for(NamedResource key : keys) {
 265             Collection<MigrationOperation> ops = list.getValuesSnapshot(key);
 266             String[] parts = key.getName().split("#");
 267             //System.out.println("Parts: " + Arrays.toString(parts));
 268             model.instances.add(Triple.make(parts[0], new NamedResource(URIStringUtils.unescape(parts[1]), key.getResource()), ops));
 269         }
 270     }
 271
 272     private static Pair<String,Integer> addInstance(MapList<NamedResource, MigrationOperation> list, ReadGraph graph, Resource instance, MigrationOperation op) throws DatabaseException {
 273         Layer0 L0 = Layer0.getInstance(graph);
 274         if(graph.isInstanceOf(instance, L0.IndexRoot)) return Pair.make("", 0);
 275         instance = graph.getPossibleObject(instance, L0.PartOf);
 276         if(instance == null) return Pair.make("", 0);
 277         String name = Versions.getStandardNameString(graph, instance);
 278         String escapedName = URIStringUtils.escape(name);
 279         Pair<String,Integer> parent = addInstance(list, graph, instance, op);
 280         StringBuilder code = new StringBuilder(parent.first).append('/').append(escapedName).append('#');
 281         for(int i=0;i<parent.second;i++) code.append(' ');
 282         code.append(escapedName);
 283         list.add(new NamedResource(code.toString(), instance), op);
 284         return Pair.make(parent.first + "/" + escapedName, parent.second + 4);
 285     }
 286
 287     private static NamedResource matchBest(ReadGraph graph, Resource type, Resource newOntology) throws DatabaseException {
 288         VersionMap versions = Versions.match(graph, type, newOntology);
 289         return versions.getNewest(graph, Versions.getBaseName(graph, type));
 290     }
 291
 292     private static MigrateModel newMigrateModel(ReadGraph graph) throws DatabaseException {
 293         MigrateModel model = new MigrateModel();
 294         model.activeModels.addAll( graph.syncRequest(new ActiveModels(Simantics.getProjectResource())) );
 295         return model;
 296     }
 297
 298 }