]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.graph.db/src/org/simantics/graph/db/StreamingTransferableGraphImportProcess.java
Fixed URI problems related to EnternalEntities during import
[simantics/platform.git] / bundles / org.simantics.graph.db / src / org / simantics / graph / db / StreamingTransferableGraphImportProcess.java
1 /*******************************************************************************
2  * Copyright (c) 2012, 2017 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  *     Semantum Oy - e.g. #7016
12  *******************************************************************************/
13 package org.simantics.graph.db;
14
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;
22 import java.util.Map;
23 import java.util.Set;
24 import java.util.TreeMap;
25
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;
63
64 import gnu.trove.map.TIntObjectMap;
65 import gnu.trove.map.hash.TIntObjectHashMap;
66
67 public class StreamingTransferableGraphImportProcess implements TransferableGraphImporter {
68
69         private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(StreamingTransferableGraphImportProcess.class);
70
71         Resource indexRoot;
72         TransferableGraphSource tg;
73         VirtualGraph vg;
74         IImportAdvisor2 advisor;
75         TGStatusMonitor monitor;
76         ClusterBuilder2 builder;
77         final TGResourceUtil resourceUtil = new TGResourceUtil();
78
79         int[] handles;
80
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<>();
85
86         int resourceCount;
87         Identity[] identities;
88         TreeMap<String, Variant> extensions;
89
90         // Builtins
91         Resource RootLibrary;
92         Resource String;
93         Resource ExternalEntity;
94         Resource Library;
95
96         Resource InstanceOf;
97         Resource ConsistsOf;
98         Resource PartOf;
99         Resource HasName;
100         Resource NameOf;        
101
102         public StreamingTransferableGraphImportProcess(Session session, VirtualGraph vg, TransferableGraphSource tg, IImportAdvisor2 advisor) {
103                 this(session, vg, tg, advisor, null);
104         }
105
106         public StreamingTransferableGraphImportProcess(Session session, VirtualGraph vg, TransferableGraphSource tg, IImportAdvisor2 advisor, TGStatusMonitor monitor) {
107                 this.tg = tg;
108                 this.vg = vg;
109                 this.advisor = advisor;
110                 this.monitor = monitor;
111         }
112
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);
119                         }
120                 }
121                 return percentage;
122         }
123
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>() {
129                         
130                         int counter = 0;
131                         
132                         @Override
133                         public void execute(Identity value) throws Exception {
134                                 identities[counter++] = value;
135                         }
136                 });
137         }
138
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");
149         }
150
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");
161         }
162
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);
170         }
171
172         void prepare(ReadGraph graph) throws Exception {
173
174                 Resource target = advisor.getTarget();
175                 if(target != null)
176                         indexRoot = graph.syncRequest(new PossibleIndexRoot(target));
177                 
178                 findBuiltins(graph);
179                 readIdentities(graph);
180                 
181 //              System.err.println("ext: " + extensions);
182 //              System.err.println("rc: " + resourceCount);
183 //              System.err.println("ic: " + identities.length);
184                 
185                 ClusterBuilderFactory factory = graph.getService(ClusterBuilderFactory.class);
186                 ClusterBuilder2 builder = factory.create(vg, false);
187                 
188                 this.handles = new int[resourceCount];
189                 TIntObjectMap<Identity> identityMap = TransferableGraphUtils.mapIdentities(identities);
190                 
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);
197                                 } else {
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;
202                                         } else {
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
206                                                 if(parent != null) {
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); 
212                                                         if(child == null) {
213                                                                 addMissing(identity.resource, graph.getURI(parent) + "/" + def.name);
214                                                         } else {
215                                                                 handles[identity.resource] = builder.handle(child);
216                                                         }
217                                                 } else {
218                                                     addMissing(identity.resource, TransferableGraphUtils.getURI(resourceCount, identityMap, def.parent) + "/" + def.name);
219                                                 }
220                                         }
221                                 }
222                         }
223                         else if(definition instanceof Internal) {
224                                 String uri = TransferableGraphUtils.getTrueURI(resourceCount, identityMap, identity.resource);
225                                 Resource existing = graph.getPossibleResource(uri);
226                                 if(existing != null) {
227                                         existingInternalMap.put(identity.resource, existing);
228                                 }
229                         }
230                         else if(definition instanceof Root) {
231                                 Root root = (Root)definition;
232                                 if(root.name.equals(""))
233                                     handles[identity.resource] = builder.handle(RootLibrary);
234                                 else  {
235                                         Resource existing = advisor.analyzeRoot(graph, root);
236                                         if(existing != null)
237                                             handles[identity.resource] = builder.handle(existing);
238                                 }
239                         }
240                         else if(definition instanceof Optional) {
241                                 External def = (External)definition;
242                                 Resource parent = builder.resource(handles[def.parent]);
243                                 if(parent != null)
244                                         handles[identity.resource] = builder.handle(graph.syncRequest(new UnescapedChildMapOfResource(parent)).get(def.name));                          
245                         }
246                 }               
247                 
248                 //if(!missingExternals.isEmpty()) throw new MissingDependencyException(this);
249                 
250         }
251
252         @Override
253         public Resource createChild(WriteOnlyGraph graph, Resource parent, Resource child, String name) throws DatabaseException {
254             if(child == null) child = graph.newResource();
255                 Resource nameResource = graph.newResource();
256                 graph.claim(nameResource, InstanceOf, null, String);
257                 graph.claimValue(nameResource, name, WriteBindings.STRING);
258                 graph.claim(child, HasName, NameOf, nameResource);
259                 return child;
260         }
261
262         int[] getClustering() {
263                 Variant v = extensions.get(Extensions.CLUSTERING);
264                 if(v == null) return null;
265                 try {
266                         return (int[])v.getValue(Bindings.INT_ARRAY);
267                 } catch (AdaptException e) {
268                         Logger.defaultLogError(e);
269                         return null;
270                 }
271         }
272
273         int[] getClusterSets() {
274                 Variant v = extensions.get(Extensions.CLUSTER_SETS);
275                 if(v == null) return null;
276                 try {
277                         return (int[])v.getValue(Bindings.INT_ARRAY);
278                 } catch (AdaptException e) {
279                         Logger.defaultLogError(e);
280                         return null;
281                 }
282         }
283
284         boolean needTranslation(Datatype type) {
285             return resourceUtil.mayHaveResource(type);
286         }
287
288         void findClusterSet(WriteOnlyGraph graph, Resource rootLibrary, int[] clustering, int[] clusterSets, long[] clusters, int id) throws DatabaseException {
289                 ClusteringSupport support = graph.getService(ClusteringSupport.class);
290                 if(id == Extensions.ROOT_LIBRARY_CLUSTER_SET || id == Extensions.INDEX_ROOT_CLUSTER_SET) return;
291                 for(int pos=0,index=0;index<clustering.length;index++) {
292                         pos += clustering[index];
293                         if(id < pos) {
294                                 int cs = clusterSets[index]; 
295                                 if(handles[id] == 0) {
296                                         int csHandle = 0;
297                                         if(cs == Extensions.ROOT_LIBRARY_CLUSTER_SET) csHandle = builder.handle(rootLibrary);
298                                         else if(cs == Extensions.INDEX_ROOT_CLUSTER_SET) {
299                                                 if(indexRoot == null) throw new DatabaseException("No index root was available in TG import.");
300                                                 csHandle = builder.handle(indexRoot);
301                                         }
302                                         else {
303                                                 findClusterSet(graph, rootLibrary, clustering, clusterSets, clusters, cs);
304                                                 csHandle = handles[cs];
305                                         }
306                                         
307                                         if(clusters[index] != 0)
308                                                 builder.selectCluster(clusters[index]);
309                                         else if(cs >= 0)
310                                                 builder.newCluster(csHandle);
311                                         
312                                         handles[id] = builder.newResource(csHandle);
313                                         clusters[index] = support.getCluster(builder.resource(handles[id]));
314                                                         
315                                         builder.createClusterSet(handles[id]);
316                                 }
317                                 return;
318                         }
319                 }
320         }
321
322         void createMissing(final WriteOnlyGraph graph) throws Exception {
323                 
324                 if(allMissingExternals.isEmpty()) return;
325                 
326                 XSupport xs = graph.getService(XSupport.class);
327                 Pair<Boolean,Boolean> serviceMode = xs.getServiceMode();
328                 xs.setServiceMode(true, false);
329                 try {
330                         ArrayList<String> missing = new ArrayList<>(allMissingExternals.keySet());
331                         Collections.sort(missing);
332                         for(String uri : missing) {
333                                 String[] parts = URIStringUtils.splitURI(uri);
334
335                                 Resource parent = resolvedParents.get(parts[0]);
336                                 // TODO: proper exception message
337                                 if(parent == null) {
338                                         throw new IllegalStateException("!!");
339                                 }
340
341                                 Resource childResource = graph.newResource();
342                                 graph.claim(childResource, InstanceOf, null, ExternalEntity);
343
344                                 Resource nameResource = graph.newResource();
345                                 graph.claim(nameResource, InstanceOf, null, String);
346                                 graph.claimValue(nameResource, parts[1], WriteBindings.STRING);
347                                 graph.claim(childResource, HasName, NameOf, nameResource);
348
349                                 graph.claim(parent, ConsistsOf, PartOf, childResource);
350
351                                 resolvedParents.put(uri, childResource);
352
353                                 handles[allMissingExternals.get(uri)] = builder.handle(childResource);
354                         }
355                 } finally {
356                         xs.setServiceMode(serviceMode.first, serviceMode.second);
357                 }
358         }
359
360         void write(final WriteOnlyGraph graph) throws Exception {
361         
362         final SerialisationSupport ss = graph.getService(SerialisationSupport.class);
363         
364         ClusterBuilderFactory factory = graph.getService(ClusterBuilderFactory.class);
365         if(advisor instanceof IImportAdvisor2) {
366             boolean allowImmutable = ((IImportAdvisor2)advisor).allowImmutableModifications();
367             builder = factory.create(vg, allowImmutable);
368         } else {
369             builder = factory.create(vg, false);
370         }
371         
372         createMissing(graph);
373         
374                 final int[] handles = this.handles; 
375                 
376                 int[] clustering = getClustering();
377                 if(clustering != null) {
378                         
379                         int[] clusterSets = getClusterSets();
380                         if(clusterSets != null) {
381
382                                 assert(clustering.length == clusterSets.length);
383
384                                 long[] clusters = new long[clustering.length];
385                                 
386                                 // Create clustering
387                                 for(int i=0;i<clusterSets.length;i++) {
388                                         findClusterSet(graph, graph.getRootLibrary(), clustering, clusterSets, clusters, clusterSets[i]);
389                                 }
390                                 
391                                 // Then create all resources
392                                 int i=0;
393                             for(int j=0;j<clustering.length;j++) {
394                                 int c = clustering[j];
395                                 int s = clusterSets[j];
396                                 int setHandle = 0;
397                                         if(s == Extensions.ROOT_LIBRARY_CLUSTER_SET)
398                                                 setHandle = builder.handle(graph.getRootLibrary());
399                                         else if(s == Extensions.INDEX_ROOT_CLUSTER_SET) {
400                                                 if(indexRoot == null) throw new DatabaseException("No index root was available in TG import.");
401                                                 setHandle = builder.handle(indexRoot);
402                                         }
403                                         else setHandle = handles[s];
404                                         // Preserve clustering only for internal resources
405                                         if(clusters[j] != 0)
406                                                 builder.selectCluster(clusters[j]);
407                                         else if(s >= 0)
408                                                 builder.newCluster(setHandle);
409                                         for(int r=0;r<c;r++, i++)
410                                                 if(handles[i] == 0) handles[i] = builder.newResource();
411                                 }
412
413                                 for(;i<handles.length;++i)
414                                         if(handles[i] == 0) handles[i] = builder.newResource();
415                                 
416                         } else {
417
418                         int i = 0;
419                                 for(int c : clustering) {
420                                         builder.newCluster();
421                                         for(int r=0;r<c;r++, i++)
422                                                 if(handles[i] == 0) handles[i] = builder.newResource();
423                                 }
424
425                                 for(;i<handles.length;++i)
426                                         if(handles[i] == 0) handles[i] = builder.newResource();
427                                 
428                         }
429                         
430                 } else {
431                 
432                         // Create blank resources
433                         for(int i=0;i<handles.length;++i)
434                                 if(handles[i] == 0) handles[i] = builder.newResource();
435
436                 }
437                 
438                 // Internal identities          
439                 for(Identity identity : identities) {
440                         IdentityDefinition definition = identity.definition;
441 //                      if(handles[identity.resource] != 0)
442 //                              continue;
443                         if(definition instanceof External) {
444                                 // Already done everything
445                         }
446                         else if(definition instanceof Internal) {
447                                 Internal def = (Internal)definition;
448                                 
449                                 Resource external = existingInternalMap.get(identity.resource);
450                                 if(external != null) {
451                                         handles[identity.resource] = builder.handle(external);
452                                 } else {
453                                         if(handles[identity.resource] != 0)
454                                                 handles[identity.resource] = builder.handle(advisor.createChild(graph, this, builder.resource(handles[def.parent]), builder.resource(handles[identity.resource]), def.name));
455                                         else
456                                                 handles[identity.resource] = builder.handle(advisor.createChild(graph, this, builder.resource(handles[def.parent]), null, def.name));
457                                 }
458                                 
459                         }
460                         else if(definition instanceof Root) {
461                                 
462                                 Root root = (Root)definition;
463                                 if(handles[identity.resource] != 0)
464                                         handles[identity.resource] = builder.handle(advisor.createRoot(graph, root, builder.resource(handles[identity.resource])));
465                                 else
466                                         handles[identity.resource] = builder.handle(advisor.createRoot(graph, root, null));
467                         }
468                         else if(definition instanceof Optional) {
469                                 Optional def = (Optional)definition;
470                                 if(handles[identity.resource] != 0) {
471                                         Resource child = advisor.createChild(graph, this, builder.resource(handles[def.parent]), builder.resource(handles[identity.resource]), def.name);
472                                         graph.claim(child, InstanceOf, null, Library); // ???
473                                         handles[identity.resource] = builder.handle(child);
474                                 } else {
475                                         Resource child = advisor.createChild(graph, this, builder.resource(handles[def.parent]), null, def.name);
476                                         graph.claim(child, InstanceOf, null, Library); // ???
477                                         handles[identity.resource] = builder.handle(child);
478                                 }
479                         }
480                 }               
481
482                 int[] done = { 0 };
483                 int[] percentage = { 0 };
484
485                 int statementCount = tg.getStatementCount();
486                 tg.forStatements(null, new TransferableGraphSourceProcedure<int[]>() {
487
488                         @Override
489                         public void execute(int[] value) throws Exception {
490                                 
491                                 int sub = value[0];
492                                 int pred = value[1];
493                                 int inv = value[2];
494                                 int obj = value[3];
495
496                                 int subject = handles[sub];
497                                 int predicate = handles[pred];
498                                 int object = handles[obj];
499
500                                 builder.addStatement(graph, subject, predicate, object);        
501                                 if(inv >= 0) {
502                                     int inverse = handles[inv];
503                                     builder.addStatement(graph, object, inverse, subject);    
504                                 }
505
506                                 // Count from 0% -> 50% => total = statementCount*2
507                                 percentage[0] = updatePercentage(percentage[0], done[0]++, statementCount*2);
508                 
509                         }
510                         
511                 }); 
512                 
513                 int valueCount = tg.getValueCount();
514                 done[0] = 0;
515
516                 class ValueProcedure extends InputStream implements TransferableGraphSourceValueProcedure {
517
518             private TGResourceUtil util = new TGResourceUtil();
519                     private DataInput source;
520
521             @Override
522             public void execute(int _resource, Datatype type, DataInput stream) throws Exception {
523
524                 source = stream;
525
526                 //int file = _resource & 0x80000000;
527                 int resource = _resource & 0x7FFFFFFF;
528
529                 Binding binding = Bindings.getBinding(type);
530                 Serializer s = Bindings.getSerializer(binding);
531
532                 builder.beginValue(handles[resource]);
533                 if(util.mayHaveResource(type)) {
534                     Object value = s.deserialize(stream);
535                     util.adaptValue( binding,  value, new LongAdapter() {
536                                 @Override
537                                 public long adapt(long in) {
538                                     try {
539                                         return ss.getRandomAccessId(handles[(int)in]);
540                                     } catch (DatabaseException e) {
541                                         throw new IllegalStateException(e);
542                                     }
543                                 }
544                             });
545                     byte[] bytes = s.serialize(value);
546                     for(byte b : bytes) {
547                         int val = b;
548                         if(val < 0) val += 256;
549                         builder.appendValue(val);
550                     }
551                 } else {
552                     s.skip(this);
553                 }
554                 builder.endValue();
555                 work();
556
557             }
558
559             @Override
560             public int read() throws IOException {
561                 int value = source.readUnsignedByte();
562                 try {
563                     builder.appendValue(value);
564                 } catch (DatabaseException e) {
565                     LOGGER.error("Failed to write value into database", e);
566                 }
567                 return value;
568             }
569
570             @Override
571             public void rawCopy(int resource, int length, DataInput input) throws Exception {
572                 builder.beginValue(handles[resource]);
573                 for (int i = 0; i < length; ++i)
574                     builder.appendValue(input.readUnsignedByte());
575                 builder.endValue();
576                 work();
577             }
578
579             private void work() {
580                 // Count from 50% -> 100% => [valueCount, valueCount*2)
581                 percentage[0] = updatePercentage(percentage[0], valueCount + done[0]++, valueCount*2);
582             }
583                 };
584                 
585                 tg.forValues2(null, new ValueProcedure());
586                 
587                 for(Resource r : existingInternalMap.valueCollection()) {
588                         graph.deny(r, InstanceOf, null, ExternalEntity, null);
589                 }
590                 
591         }
592
593         @Override
594         public long[] getResourceIds(SerialisationSupport serializer) throws DatabaseException {
595                 final int count = handles.length;
596                 long[] resourceIds = new long[count];
597                 for(int i=0;i<count;++i)
598                     resourceIds[i] = serializer.getRandomAccessId(handles[i]);
599                 return resourceIds;
600         }
601 }