]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.modeling/src/org/simantics/modeling/UserComponentMigration.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.modeling / src / org / simantics / modeling / UserComponentMigration.java
diff --git a/bundles/org.simantics.modeling/src/org/simantics/modeling/UserComponentMigration.java b/bundles/org.simantics.modeling/src/org/simantics/modeling/UserComponentMigration.java
new file mode 100644 (file)
index 0000000..6cb08dd
--- /dev/null
@@ -0,0 +1,290 @@
+/*******************************************************************************\r
+ * Copyright (c) 2014, 2015 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     Semantum Oy - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.modeling;\r
+\r
+import gnu.trove.set.hash.THashSet;\r
+\r
+import java.util.ArrayList;\r
+import java.util.Collection;\r
+import java.util.Collections;\r
+import java.util.Comparator;\r
+import java.util.Set;\r
+\r
+import org.simantics.Simantics;\r
+import org.simantics.databoard.Bindings;\r
+import org.simantics.databoard.util.URIStringUtils;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.WriteGraph;\r
+import org.simantics.db.common.NamedResource;\r
+import org.simantics.db.common.request.ObjectsWithType;\r
+import org.simantics.db.common.request.PossibleIndexRoot;\r
+import org.simantics.db.common.utils.NameUtils;\r
+import org.simantics.db.common.utils.VersionMap;\r
+import org.simantics.db.common.utils.Versions;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.layer0.adapter.Instances;\r
+import org.simantics.db.layer0.request.ActiveModels;\r
+import org.simantics.db.layer0.util.Layer0Utils;\r
+import org.simantics.diagram.stubs.DiagramResource;\r
+import org.simantics.layer0.Layer0;\r
+import org.simantics.modeling.MigrateModel.MigrationOperation;\r
+import org.simantics.modeling.migration.UserComponentPostMigrationAction;\r
+import org.simantics.simulation.ontology.SimulationResource;\r
+import org.simantics.structural.stubs.StructuralResource2;\r
+import org.simantics.utils.datastructures.MapList;\r
+import org.simantics.utils.datastructures.Pair;\r
+import org.simantics.utils.datastructures.Triple;\r
+import org.simantics.utils.strings.AlphanumComparator;\r
+\r
+/**\r
+ * @author Antti Villberg\r
+ * @author Tuukka Lehtonen\r
+ */\r
+public class UserComponentMigration {\r
+\r
+    public static void migrateUserComponents(WriteGraph graph, Resource source, Resource target, Collection<Resource> components) throws DatabaseException {\r
+        MigrateModel model = getComponentTypeModel(graph, source, target, null);\r
+        if (model.instances.isEmpty())\r
+            return;\r
+        Triple<String, NamedResource, Collection<MigrationOperation>> instances = model.instances.get(0);\r
+        ArrayList<MigrationOperation> result = new ArrayList<>();\r
+        \r
+        for (MigrationOperation instance : instances.third) {\r
+            if (components.contains(instance.instanceToMigrate.getResource())) {\r
+               result.add(instance); \r
+            }\r
+        }\r
+        if (!result.isEmpty())\r
+            doMigration(graph, result);\r
+    }\r
+\r
+    public static String doMigration(WriteGraph graph, final ArrayList<MigrationOperation> result) throws DatabaseException {\r
+        graph.markUndoPoint();\r
+        StringBuilder b = new StringBuilder();\r
+        int success = 0;\r
+        int problem = 0;\r
+        for(MigrationOperation op : result) {\r
+            String problems = op.perform(graph);\r
+            if(problems != null) {\r
+                b.insert(0, problems);\r
+                b.insert(0, op.getDescription(graph) + "\n");\r
+                problem++;\r
+            } else {\r
+                b.append(op.getDescription(graph) + "\n");\r
+                b.append(" success\n");\r
+                success++;\r
+            }\r
+        }\r
+        int total = success + problem;\r
+        b.insert(0, "---------------------\n");\r
+        b.insert(0, "Details:\n");\r
+        b.insert(0, "\n");\r
+        b.insert(0, "  OK: " + success + "\n"); \r
+        b.insert(0, "  Failure: " + problem + "\n"); \r
+        b.insert(0, "---------------------\n");\r
+        b.insert(0, "Performed migration for " + total + " instances:\n");\r
+\r
+        Layer0Utils.addCommentMetadata(graph, "Migrated " + total + " instances");\r
+        return b.toString();\r
+    }\r
+\r
+    public static void doPostMigration(WriteGraph graph, ArrayList<MigrationOperation> result) throws DatabaseException {\r
+        THashSet<Resource> roots = new THashSet<>();\r
+        for(MigrationOperation op : result) {\r
+            Resource root = graph.syncRequest(new PossibleIndexRoot(op.instanceToMigrate.getResource()));\r
+            if(root != null)\r
+                roots.add(root);\r
+        }\r
+        for(Resource root : roots) {\r
+            UserComponentPostMigrationAction action = graph.getPossibleAdapter(root, UserComponentPostMigrationAction.class);\r
+            if(action != null)\r
+                action.perform(graph);\r
+        }\r
+    }\r
+\r
+    public static MigrateModel getComponentTypeModel(ReadGraph graph, Resource source, Resource target, Resource symbol) throws DatabaseException {\r
+        MigrateModel model = newMigrateModel(graph);\r
+\r
+        MapList<NamedResource, MigrationOperation> list = new MapList<>(); \r
+\r
+        Layer0 L0 = Layer0.getInstance(graph);\r
+        DiagramResource DIA = DiagramResource.getInstance(graph);\r
+        Instances query = graph.adapt(source, Instances.class);\r
+        Set<Resource> instances = new THashSet<>();\r
+        for(NamedResource nr : getLocations(graph, Simantics.getProjectResource())) {\r
+            Collection<Resource> found = query.find(graph, nr.getResource());\r
+            instances.addAll(found);\r
+        }\r
+\r
+        model.instanceCount = instances.size();\r
+        for(Resource instance : instances) {\r
+\r
+            String uri = graph.getPossibleURI(instance);\r
+\r
+            Resource element = ModelingUtils.getPossibleElement(graph, instance);\r
+            if(element == null) {\r
+                MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), null);\r
+                addInstance(list, graph, instance, op);\r
+                continue;\r
+            }\r
+\r
+            Resource instanceSymbol = graph.getPossibleType(element, DIA.Element);\r
+            if(instanceSymbol == null) continue;\r
+\r
+            if(symbol != null) {\r
+                if(!symbol.equals(instanceSymbol)) {\r
+                    MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), new NamedResource("", symbol));\r
+                    addInstance(list, graph, instance, op);\r
+                }\r
+            } else {\r
+                String instanceSymbolName = graph.getRelatedValue(instanceSymbol, L0.HasName, Bindings.STRING);\r
+                Resource targetSymbol = Layer0Utils.getPossibleChild(graph, target, DIA.ElementClass, instanceSymbolName); \r
+                if(targetSymbol != null && !targetSymbol.equals(instanceSymbol)) {\r
+                    MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), new NamedResource("", target), new NamedResource("", targetSymbol));\r
+                    addInstance(list, graph, instance, op);\r
+                }\r
+            }\r
+\r
+        }\r
+\r
+        sortInstances(model, list);\r
+\r
+        return model;\r
+    }\r
+\r
+    public static MigrateModel getSharedOntologyModel(ReadGraph graph, Resource sourceOntology, Resource targetOntology) throws DatabaseException {\r
+        MigrateModel model = newMigrateModel(graph);\r
+\r
+        MapList<NamedResource, MigrationOperation> list = new MapList<>(); \r
+\r
+        Layer0 L0 = Layer0.getInstance(graph);\r
+        DiagramResource DIA = DiagramResource.getInstance(graph);\r
+        StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
+        Instances query = graph.adapt(STR.ComponentType, Instances.class);\r
+\r
+        Set<Resource> types = new THashSet<>();\r
+        for(Resource type : query.find(graph, sourceOntology)) {\r
+            // TODO: haxx\r
+            if(graph.isInheritedFrom(type, DIA.Element)) continue;\r
+            Resource root = graph.syncRequest(new PossibleIndexRoot(type));\r
+            if(sourceOntology.equals(root)) types.add(type);\r
+        }\r
+\r
+        Set<Resource> instances = new THashSet<>();\r
+        Collection<NamedResource> locations = getLocations(graph, Simantics.getProjectResource()); \r
+\r
+        for(Resource type : types) {\r
+            Instances query2 = graph.adapt(type, Instances.class);\r
+            for(NamedResource nr : locations) {\r
+                Collection<Resource> found = query2.find(graph, nr.getResource());\r
+                instances.addAll(found);\r
+            }\r
+        }\r
+\r
+        model.instanceCount = instances.size();\r
+        for(Resource instance : instances) {\r
+            Resource type = graph.getPossibleType(instance, STR.Component);\r
+            String uri = graph.getPossibleURI(instance);\r
+            if (type == null || uri == null) {\r
+                System.err.println("CANNOT MIGRATE INSTANCE DUE TO TYPING PROBLEM: " + NameUtils.getURIOrSafeNameInternal(graph, instance));\r
+                continue;\r
+            }\r
+            NamedResource best = matchBest(graph, type, targetOntology);\r
+            if(best != null) {\r
+\r
+                Resource element = ModelingUtils.getPossibleElement(graph, instance);\r
+                if(element == null) {\r
+                    MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), best, null);\r
+                    addInstance(list, graph, instance, op);\r
+                    continue;\r
+                }\r
+\r
+                Resource instanceSymbol = graph.getPossibleType(element, DIA.Element);\r
+                if(instanceSymbol == null) continue;\r
+\r
+                String instanceSymbolName = graph.getRelatedValue(instanceSymbol, L0.HasName, Bindings.STRING);\r
+                Resource targetSymbol = Layer0Utils.getPossibleChild(graph, best.getResource(), DIA.ElementClass, instanceSymbolName); \r
+                if(targetSymbol != null && !targetSymbol.equals(instanceSymbol)) {\r
+                    MigrationOperation op = new MigrationOperation(new NamedResource(uri, instance), best, new NamedResource("", targetSymbol));\r
+                    addInstance(list, graph, instance, op);\r
+                }\r
+\r
+            }\r
+        }\r
+\r
+        sortInstances(model, list);\r
+\r
+        return model;\r
+    }\r
+\r
+    private static Collection<NamedResource> getLocations(ReadGraph graph, final Resource project) throws DatabaseException {\r
+        Layer0 L0 = Layer0.getInstance(graph);\r
+        SimulationResource SIMU = SimulationResource.getInstance(graph);\r
+        Collection<NamedResource> libraries = new ArrayList<>();\r
+        for (Resource r : graph.syncRequest(new ObjectsWithType(project, L0.ConsistsOf, SIMU.Model))) {\r
+            String name = Versions.getStandardNameString(graph, r);\r
+            libraries.add(new NamedResource(name, r));\r
+        }\r
+        Collection<Resource> ontologies = Simantics.applySCL("Simantics/SharedOntologies", "traverseSharedOntologies", graph, graph.getRootLibrary());\r
+        for (Resource r : ontologies) {\r
+            String name = Versions.getStandardNameString(graph, r);\r
+            libraries.add(new NamedResource(name, r));\r
+        }\r
+        return libraries;\r
+    }\r
+\r
+    private static final Comparator<NamedResource> NAMED_RESOURCE_COMPARATOR = new Comparator<NamedResource>() {\r
+        @Override\r
+        public int compare(NamedResource o1, NamedResource o2) {\r
+            return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getName(), o2.getName());\r
+        }\r
+    };\r
+\r
+    private static void sortInstances(MigrateModel model, MapList<NamedResource, MigrationOperation> list) {\r
+        ArrayList<NamedResource> keys = new ArrayList<>(list.getKeys());\r
+        Collections.sort(keys, NAMED_RESOURCE_COMPARATOR);\r
+        for(NamedResource key : keys) {\r
+            Collection<MigrationOperation> ops = list.getValuesSnapshot(key);\r
+            String[] parts = key.getName().split("#");\r
+            //System.out.println("Parts: " + Arrays.toString(parts));\r
+            model.instances.add(Triple.make(parts[0], new NamedResource(URIStringUtils.unescape(parts[1]), key.getResource()), ops));\r
+        }\r
+    }\r
+\r
+    private static Pair<String,Integer> addInstance(MapList<NamedResource, MigrationOperation> list, ReadGraph graph, Resource instance, MigrationOperation op) throws DatabaseException {\r
+        Layer0 L0 = Layer0.getInstance(graph);\r
+        if(graph.isInstanceOf(instance, L0.IndexRoot)) return Pair.make("", 0);\r
+        instance = graph.getPossibleObject(instance, L0.PartOf);\r
+        if(instance == null) return Pair.make("", 0);\r
+        String name = Versions.getStandardNameString(graph, instance);\r
+        String escapedName = URIStringUtils.escape(name);\r
+        Pair<String,Integer> parent = addInstance(list, graph, instance, op);\r
+        StringBuilder code = new StringBuilder(parent.first).append('/').append(escapedName).append('#');\r
+        for(int i=0;i<parent.second;i++) code.append(' ');\r
+        code.append(escapedName);\r
+        list.add(new NamedResource(code.toString(), instance), op);\r
+        return Pair.make(parent.first + "/" + escapedName, parent.second + 4);\r
+    }\r
+\r
+    private static NamedResource matchBest(ReadGraph graph, Resource type, Resource newOntology) throws DatabaseException {\r
+        VersionMap versions = Versions.match(graph, type, newOntology);\r
+        return versions.getNewest(graph, Versions.getBaseName(graph, type));\r
+    }\r
+\r
+    private static MigrateModel newMigrateModel(ReadGraph graph) throws DatabaseException {\r
+        MigrateModel model = new MigrateModel();\r
+        model.activeModels.addAll( graph.syncRequest(new ActiveModels(Simantics.getProjectResource())) );\r
+        return model;\r
+    }\r
+\r
+}\r