1 /*******************************************************************************
2 * Copyright (c) 2012, 2017 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 * Semantum Oy - e.g. #7016
12 *******************************************************************************/
13 package org.simantics.graph.db;
15 import java.io.DataInput;
16 import java.io.IOException;
17 import java.io.InputStream;
18 import java.util.ArrayList;
19 import java.util.Collections;
20 import java.util.HashMap;
21 import java.util.HashSet;
24 import java.util.TreeMap;
26 import org.simantics.databoard.Bindings;
27 import org.simantics.databoard.adapter.AdaptException;
28 import org.simantics.databoard.binding.Binding;
29 import org.simantics.databoard.binding.mutable.Variant;
30 import org.simantics.databoard.serialization.Serializer;
31 import org.simantics.databoard.type.Datatype;
32 import org.simantics.databoard.util.URIStringUtils;
33 import org.simantics.db.ReadGraph;
34 import org.simantics.db.Resource;
35 import org.simantics.db.Session;
36 import org.simantics.db.VirtualGraph;
37 import org.simantics.db.WriteOnlyGraph;
38 import org.simantics.db.common.WriteBindings;
39 import org.simantics.db.common.procedure.adapter.TransientCacheAsyncListener;
40 import org.simantics.db.common.request.PossibleIndexRoot;
41 import org.simantics.db.common.uri.UnescapedChildMapOfResource;
42 import org.simantics.db.common.utils.Logger;
43 import org.simantics.db.exception.DatabaseException;
44 import org.simantics.db.service.ClusterBuilder2;
45 import org.simantics.db.service.ClusterBuilderFactory;
46 import org.simantics.db.service.ClusteringSupport;
47 import org.simantics.db.service.SerialisationSupport;
48 import org.simantics.db.service.XSupport;
49 import org.simantics.graph.db.TransferableGraphSource.TransferableGraphSourceProcedure;
50 import org.simantics.graph.db.TransferableGraphSource.TransferableGraphSourceValueProcedure;
51 import org.simantics.graph.representation.Extensions;
52 import org.simantics.graph.representation.External;
53 import org.simantics.graph.representation.Identity;
54 import org.simantics.graph.representation.IdentityDefinition;
55 import org.simantics.graph.representation.Internal;
56 import org.simantics.graph.representation.Optional;
57 import org.simantics.graph.representation.Root;
58 import org.simantics.graph.representation.TransferableGraphUtils;
59 import org.simantics.graph.utils.TGResourceUtil;
60 import org.simantics.graph.utils.TGResourceUtil.LongAdapter;
61 import org.simantics.utils.datastructures.Pair;
62 import org.slf4j.LoggerFactory;
64 import gnu.trove.map.TIntObjectMap;
65 import gnu.trove.map.hash.TIntObjectHashMap;
67 public class StreamingTransferableGraphImportProcess implements TransferableGraphImporter {
69 private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(StreamingTransferableGraphImportProcess.class);
72 TransferableGraphSource tg;
74 IImportAdvisor2 advisor;
75 TGStatusMonitor monitor;
76 ClusterBuilder2 builder;
77 final TGResourceUtil resourceUtil = new TGResourceUtil();
81 Map<String,Integer> allMissingExternals = new HashMap<>();
82 Set<String> missingExternals = new HashSet<>();
83 Map<String,Resource> resolvedParents = new HashMap<>();
84 TIntObjectHashMap<Resource> existingInternalMap = new TIntObjectHashMap<>();
87 Identity[] identities;
88 TreeMap<String, Variant> extensions;
93 Resource ExternalEntity;
102 public StreamingTransferableGraphImportProcess(Session session, VirtualGraph vg, TransferableGraphSource tg, IImportAdvisor2 advisor) {
103 this(session, vg, tg, advisor, null);
106 public StreamingTransferableGraphImportProcess(Session session, VirtualGraph vg, TransferableGraphSource tg, IImportAdvisor2 advisor, TGStatusMonitor monitor) {
109 this.advisor = advisor;
110 this.monitor = monitor;
113 private int updatePercentage(int percentage, int done, int total) {
114 if (monitor != null && (done & 63) == 0) {
115 int current = 100*done / total;
116 if (current > percentage) {
117 percentage = current;
118 monitor.status(percentage);
124 public void readIdentities(ReadGraph g) throws Exception {
125 extensions = tg.getExtensions();
126 resourceCount = tg.getResourceCount();
127 identities = new Identity[tg.getIdentityCount()];
128 tg.forIdentities(g, new TransferableGraphSourceProcedure<Identity>() {
133 public void execute(Identity value) throws Exception {
134 identities[counter++] = value;
139 public void findBuiltins(WriteOnlyGraph g) throws DatabaseException {
140 RootLibrary = g.getBuiltin("http:/");
141 String = g.getBuiltin(CoreInitialization.LAYER0 + "String");
142 Library = g.getBuiltin(CoreInitialization.LAYER0 + "Library");
143 InstanceOf = g.getBuiltin(CoreInitialization.LAYER0 + "InstanceOf");
144 ConsistsOf = g.getBuiltin(CoreInitialization.LAYER0 + "ConsistsOf");
145 PartOf = g.getBuiltin(CoreInitialization.LAYER0 + "PartOf");
146 HasName = g.getBuiltin(CoreInitialization.LAYER0 + "HasName");
147 NameOf = g.getBuiltin(CoreInitialization.LAYER0 + "NameOf");
148 ExternalEntity = g.getBuiltin(CoreInitialization.LAYER0 + "ExternalEntity");
151 public void findBuiltins(ReadGraph g) throws DatabaseException {
152 RootLibrary = g.getBuiltin("http:/");
153 String = g.getBuiltin(CoreInitialization.LAYER0 + "String");
154 Library = g.getBuiltin(CoreInitialization.LAYER0 + "Library");
155 InstanceOf = g.getBuiltin(CoreInitialization.LAYER0 + "InstanceOf");
156 ConsistsOf = g.getBuiltin(CoreInitialization.LAYER0 + "ConsistsOf");
157 PartOf = g.getBuiltin(CoreInitialization.LAYER0 + "PartOf");
158 HasName = g.getBuiltin(CoreInitialization.LAYER0 + "HasName");
159 NameOf = g.getBuiltin(CoreInitialization.LAYER0 + "NameOf");
160 ExternalEntity = g.getBuiltin(CoreInitialization.LAYER0 + "ExternalEntity");
163 void addMissing(int handleIndex, String external) {
164 allMissingExternals.put(external, handleIndex);
165 Set<String> removals = new HashSet<>();
166 for(String ext : missingExternals) if(ext.startsWith(external + "/")) return;
167 for(String ext : missingExternals) if(external.startsWith(ext + "/")) removals.add(ext);
168 missingExternals.removeAll(removals);
169 missingExternals.add(external);
172 void prepare(ReadGraph graph) throws Exception {
174 Resource target = advisor.getTarget();
176 indexRoot = graph.syncRequest(new PossibleIndexRoot(target));
179 readIdentities(graph);
181 // System.err.println("ext: " + extensions);
182 // System.err.println("rc: " + resourceCount);
183 // System.err.println("ic: " + identities.length);
185 ClusterBuilderFactory factory = graph.getService(ClusterBuilderFactory.class);
186 ClusterBuilder2 builder = factory.create(vg, false);
188 this.handles = new int[resourceCount];
189 TIntObjectMap<Identity> identityMap = TransferableGraphUtils.mapIdentities(identities);
191 for(Identity identity : identities) {
192 IdentityDefinition definition = identity.definition;
193 if(definition instanceof External) {
194 External def = (External)definition;
195 if(def.parent == -1) {
196 handles[identity.resource] = builder.handle(RootLibrary);
198 if("@inverse".equals(def.name)) {
199 int parent = handles[def.parent];
200 int child = builder.handle(graph.getInverse(builder.resource(parent)));
201 handles[identity.resource] = child;
203 int handle = handles[def.parent];
204 Resource parent = handle != 0 ? builder.resource(handle) : null;
205 // TODO: escape should be removed when names become well-behaving
207 resolvedParents.put(graph.getURI(parent), parent);
208 Map<String,Resource> childMap = graph
209 .syncRequest(new UnescapedChildMapOfResource(parent),
210 TransientCacheAsyncListener.instance());
211 Resource child = childMap.get(def.name);
213 addMissing(identity.resource, graph.getURI(parent) + "/" + URIStringUtils.escape(def.name));
215 handles[identity.resource] = builder.handle(child);
218 addMissing(identity.resource, TransferableGraphUtils.getURI(resourceCount, identityMap, def.parent) + "/" + URIStringUtils.escape(def.name));
223 else if(definition instanceof Internal) {
224 String uri = TransferableGraphUtils.getURI(resourceCount, identityMap, identity.resource);
225 Resource existing = graph.getPossibleResource(uri);
226 if(existing != null) {
227 existingInternalMap.put(identity.resource, existing);
230 else if(definition instanceof Root) {
231 Root root = (Root)definition;
232 if(root.name.equals(""))
233 handles[identity.resource] = builder.handle(RootLibrary);
235 Resource existing = advisor.analyzeRoot(graph, root);
237 handles[identity.resource] = builder.handle(existing);
240 else if(definition instanceof Optional) {
241 External def = (External)definition;
242 Resource parent = builder.resource(handles[def.parent]);
244 handles[identity.resource] = builder.handle(graph.syncRequest(new UnescapedChildMapOfResource(parent)).get(def.name));
248 //if(!missingExternals.isEmpty()) throw new MissingDependencyException(this);
253 public Resource createChild(WriteOnlyGraph graph, Resource parent, Resource child, String name) throws DatabaseException {
254 //System.err.println("child " + parent + " - " + child + " = " + name);
255 if(child == null) child = graph.newResource();
256 Resource nameResource = graph.newResource();
257 graph.claim(nameResource, InstanceOf, null, String);
258 graph.claimValue(nameResource, name, WriteBindings.STRING);
259 graph.claim(child, HasName, NameOf, nameResource);
260 graph.claim(parent, ConsistsOf, PartOf, child);
264 int[] getClustering() {
265 Variant v = extensions.get(Extensions.CLUSTERING);
266 if(v == null) return null;
268 return (int[])v.getValue(Bindings.INT_ARRAY);
269 } catch (AdaptException e) {
270 Logger.defaultLogError(e);
275 int[] getClusterSets() {
276 Variant v = extensions.get(Extensions.CLUSTER_SETS);
277 if(v == null) return null;
279 return (int[])v.getValue(Bindings.INT_ARRAY);
280 } catch (AdaptException e) {
281 Logger.defaultLogError(e);
286 boolean needTranslation(Datatype type) {
287 return resourceUtil.mayHaveResource(type);
290 void findClusterSet(WriteOnlyGraph graph, Resource rootLibrary, int[] clustering, int[] clusterSets, long[] clusters, int id) throws DatabaseException {
291 ClusteringSupport support = graph.getService(ClusteringSupport.class);
292 if(id == Extensions.ROOT_LIBRARY_CLUSTER_SET || id == Extensions.INDEX_ROOT_CLUSTER_SET) return;
293 Resource indexRootClusterSetResource = rootLibrary;
294 if(indexRoot != null && support.isClusterSet(indexRoot)) {
295 indexRootClusterSetResource = indexRoot;
297 graph.setClusterSet4NewResource(rootLibrary);
298 graph.flushCluster();
300 int indexRootCsHandle = builder.handle(indexRootClusterSetResource);
301 for(int pos=0,index=0;index<clustering.length;index++) {
302 pos += clustering[index];
304 int cs = clusterSets[index];
305 if(handles[id] == 0) {
307 if(cs == Extensions.ROOT_LIBRARY_CLUSTER_SET) csHandle = builder.handle(rootLibrary);
308 else if(cs == Extensions.INDEX_ROOT_CLUSTER_SET) {
309 if(indexRoot == null) throw new DatabaseException("No index root was available in TG import.");
310 csHandle = indexRootCsHandle;
313 findClusterSet(graph, rootLibrary, clustering, clusterSets, clusters, cs);
314 csHandle = handles[cs];
317 if(clusters[index] != 0)
318 builder.selectCluster(clusters[index]);
320 builder.newCluster(csHandle);
322 handles[id] = builder.newResource(csHandle);
323 clusters[index] = support.getCluster(builder.resource(handles[id]));
325 builder.createClusterSet(handles[id]);
332 void createMissing(final WriteOnlyGraph graph) throws Exception {
334 if(allMissingExternals.isEmpty()) return;
336 XSupport xs = graph.getService(XSupport.class);
337 Pair<Boolean,Boolean> serviceMode = xs.getServiceMode();
338 xs.setServiceMode(true, false);
340 ArrayList<String> missing = new ArrayList<>(allMissingExternals.keySet());
341 Collections.sort(missing);
342 for(String uri : missing) {
343 String[] parts = URIStringUtils.splitURI(uri);
344 // URIStringUtils.splitURI returns root URI in non-standard format, so fix it manually as a workaround
345 if (parts[0].equals("http://")) {
349 Resource parent = resolvedParents.get(parts[0]);
350 // TODO: proper exception message
352 throw new IllegalStateException("Missing URI: " + uri);
355 Resource childResource = graph.newResource();
356 graph.claim(childResource, InstanceOf, null, ExternalEntity);
358 Resource nameResource = graph.newResource();
359 graph.claim(nameResource, InstanceOf, null, String);
360 graph.claimValue(nameResource, URIStringUtils.unescape(parts[1]), WriteBindings.STRING);
361 graph.claim(childResource, HasName, NameOf, nameResource);
363 graph.claim(parent, ConsistsOf, PartOf, childResource);
365 resolvedParents.put(uri, childResource);
367 handles[allMissingExternals.get(uri)] = builder.handle(childResource);
370 xs.setServiceMode(serviceMode.first, serviceMode.second);
374 void write(final WriteOnlyGraph graph) throws Exception {
376 final SerialisationSupport ss = graph.getService(SerialisationSupport.class);
378 ClusterBuilderFactory factory = graph.getService(ClusterBuilderFactory.class);
379 if(advisor instanceof IImportAdvisor2) {
380 boolean allowImmutable = ((IImportAdvisor2)advisor).allowImmutableModifications();
381 builder = factory.create(vg, allowImmutable);
383 builder = factory.create(vg, false);
386 createMissing(graph);
388 final int[] handles = this.handles;
390 int[] clustering = getClustering();
391 if(clustering != null) {
393 int[] clusterSets = getClusterSets();
394 if(clusterSets != null) {
396 assert(clustering.length == clusterSets.length);
398 long[] clusters = new long[clustering.length];
401 for(int i=0;i<clusterSets.length;i++) {
402 findClusterSet(graph, graph.getRootLibrary(), clustering, clusterSets, clusters, clusterSets[i]);
405 // Then create all resources
407 for(int j=0;j<clustering.length;j++) {
408 int c = clustering[j];
409 int s = clusterSets[j];
411 if(s == Extensions.ROOT_LIBRARY_CLUSTER_SET)
412 setHandle = builder.handle(graph.getRootLibrary());
413 else if(s == Extensions.INDEX_ROOT_CLUSTER_SET) {
414 if(indexRoot == null) throw new DatabaseException("No index root was available in TG import.");
415 setHandle = builder.handle(indexRoot);
417 else setHandle = handles[s];
418 // Preserve clustering only for internal resources
420 builder.selectCluster(clusters[j]);
422 builder.newCluster(setHandle);
423 for(int r=0;r<c;r++, i++)
424 if(handles[i] == 0) handles[i] = builder.newResource();
427 for(;i<handles.length;++i)
428 if(handles[i] == 0) handles[i] = builder.newResource();
433 for(int c : clustering) {
434 builder.newCluster();
435 for(int r=0;r<c;r++, i++)
436 if(handles[i] == 0) handles[i] = builder.newResource();
439 for(;i<handles.length;++i)
440 if(handles[i] == 0) handles[i] = builder.newResource();
446 // Create blank resources
447 for(int i=0;i<handles.length;++i)
448 if(handles[i] == 0) handles[i] = builder.newResource();
452 // Internal identities
453 for(Identity identity : identities) {
454 IdentityDefinition definition = identity.definition;
455 // if(handles[identity.resource] != 0)
457 if(definition instanceof External) {
458 // Already done everything
460 else if(definition instanceof Internal) {
461 Internal def = (Internal)definition;
462 Resource external = existingInternalMap.get(identity.resource);
463 if(external != null) {
464 handles[identity.resource] = builder.handle(external);
466 if(handles[identity.resource] != 0)
467 handles[identity.resource] = builder.handle(advisor.createChild(graph, this, builder.resource(handles[def.parent]), builder.resource(handles[identity.resource]), def.name));
469 handles[identity.resource] = builder.handle(advisor.createChild(graph, this, builder.resource(handles[def.parent]), null, def.name));
473 else if(definition instanceof Root) {
475 Root root = (Root)definition;
476 if(handles[identity.resource] != 0)
477 handles[identity.resource] = builder.handle(advisor.createRoot(graph, root, builder.resource(handles[identity.resource])));
479 handles[identity.resource] = builder.handle(advisor.createRoot(graph, root, null));
481 else if(definition instanceof Optional) {
482 Optional def = (Optional)definition;
483 if(handles[identity.resource] != 0) {
484 Resource child = advisor.createChild(graph, this, builder.resource(handles[def.parent]), builder.resource(handles[identity.resource]), def.name);
485 graph.claim(child, InstanceOf, null, Library); // ???
486 handles[identity.resource] = builder.handle(child);
488 Resource child = advisor.createChild(graph, this, builder.resource(handles[def.parent]), null, def.name);
489 graph.claim(child, InstanceOf, null, Library); // ???
490 handles[identity.resource] = builder.handle(child);
496 int[] percentage = { 0 };
498 int statementCount = tg.getStatementCount();
499 tg.forStatements(null, new TransferableGraphSourceProcedure<int[]>() {
502 public void execute(int[] value) throws Exception {
509 int subject = handles[sub];
510 int predicate = handles[pred];
511 int object = handles[obj];
513 builder.addStatement(graph, subject, predicate, object);
515 int inverse = handles[inv];
516 builder.addStatement(graph, object, inverse, subject);
519 // Count from 0% -> 50% => total = statementCount*2
520 percentage[0] = updatePercentage(percentage[0], done[0]++, statementCount*2);
526 int valueCount = tg.getValueCount();
529 class ValueProcedure extends InputStream implements TransferableGraphSourceValueProcedure {
531 private TGResourceUtil util = new TGResourceUtil();
532 private DataInput source;
535 public void execute(int _resource, Datatype type, DataInput stream) throws Exception {
539 //int file = _resource & 0x80000000;
540 int resource = _resource & 0x7FFFFFFF;
542 Binding binding = Bindings.getBinding(type);
543 Serializer s = Bindings.getSerializer(binding);
545 builder.beginValue(handles[resource]);
546 if(util.mayHaveResource(type)) {
547 Object value = s.deserialize(stream);
548 util.adaptValue( binding, value, new LongAdapter() {
550 public long adapt(long in) {
552 return ss.getRandomAccessId(handles[(int)in]);
553 } catch (DatabaseException e) {
554 throw new IllegalStateException(e);
558 byte[] bytes = s.serialize(value);
559 for(byte b : bytes) {
561 if(val < 0) val += 256;
562 builder.appendValue(val);
573 public int read() throws IOException {
574 int value = source.readUnsignedByte();
576 builder.appendValue(value);
577 } catch (DatabaseException e) {
578 LOGGER.error("Failed to write value into database", e);
584 public void rawCopy(int resource, int length, DataInput input) throws Exception {
585 builder.beginValue(handles[resource]);
586 for (int i = 0; i < length; ++i)
587 builder.appendValue(input.readUnsignedByte());
592 private void work() {
593 // Count from 50% -> 100% => [valueCount, valueCount*2)
594 percentage[0] = updatePercentage(percentage[0], valueCount + done[0]++, valueCount*2);
598 tg.forValues2(null, new ValueProcedure());
600 for(Resource r : existingInternalMap.valueCollection()) {
601 graph.deny(r, InstanceOf, null, ExternalEntity, null);
607 public long[] getResourceIds(SerialisationSupport serializer) throws DatabaseException {
608 final int count = handles.length;
609 long[] resourceIds = new long[count];
610 for(int i=0;i<count;++i)
611 resourceIds[i] = serializer.getRandomAccessId(handles[i]);