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