source: josm/trunk/src/org/openstreetmap/josm/io/MultiFetchServerObjectReader.java@ 9296

Last change on this file since 9296 was 9242, checked in by simon04, 8 years ago

fix #7670 - Add Overpass settings to main preference
  • Property svn:eol-style set to native
File size: 24.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.io;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trn;
6
7import java.io.IOException;
8import java.io.InputStream;
9import java.net.HttpURLConnection;
10import java.util.ArrayList;
11import java.util.Collection;
12import java.util.Collections;
13import java.util.HashSet;
14import java.util.Iterator;
15import java.util.LinkedHashSet;
16import java.util.List;
17import java.util.Set;
18import java.util.concurrent.Callable;
19import java.util.concurrent.CompletionService;
20import java.util.concurrent.ExecutionException;
21import java.util.concurrent.Executor;
22import java.util.concurrent.ExecutorCompletionService;
23import java.util.concurrent.Executors;
24import java.util.concurrent.Future;
25
26import org.openstreetmap.josm.Main;
27import org.openstreetmap.josm.data.osm.DataSet;
28import org.openstreetmap.josm.data.osm.DataSetMerger;
29import org.openstreetmap.josm.data.osm.Node;
30import org.openstreetmap.josm.data.osm.OsmPrimitive;
31import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
32import org.openstreetmap.josm.data.osm.PrimitiveId;
33import org.openstreetmap.josm.data.osm.Relation;
34import org.openstreetmap.josm.data.osm.RelationMember;
35import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
36import org.openstreetmap.josm.data.osm.Way;
37import org.openstreetmap.josm.gui.preferences.server.OverpassServerPreference;
38import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
39import org.openstreetmap.josm.gui.progress.ProgressMonitor;
40import org.openstreetmap.josm.tools.Utils;
41
42/**
43 * Retrieves a set of {@link OsmPrimitive}s from an OSM server using the so called
44 * Multi Fetch API.
45 *
46 * Usage:
47 * <pre>
48 * MultiFetchServerObjectReader reader = MultiFetchServerObjectReader()
49 * .append(2345,2334,4444)
50 * .append(new Node(72343));
51 * reader.parseOsm();
52 * if (!reader.getMissingPrimitives().isEmpty()) {
53 * Main.info("There are missing primitives: " + reader.getMissingPrimitives());
54 * }
55 * if (!reader.getSkippedWays().isEmpty()) {
56 * Main.info("There are skipped ways: " + reader.getMissingPrimitives());
57 * }
58 * </pre>
59 */
60public class MultiFetchServerObjectReader extends OsmServerReader {
61 /**
62 * the max. number of primitives retrieved in one step. Assuming IDs with 7 digits,
63 * this leads to a max. request URL of ~ 1600 Bytes ((7 digits + 1 Separator) * 200),
64 * which should be safe according to the
65 * <a href="http://www.boutell.com/newfaq/misc/urllength.html">WWW FAQ</a>.
66 */
67 private static final int MAX_IDS_PER_REQUEST = 200;
68
69 private final Set<Long> nodes;
70 private final Set<Long> ways;
71 private final Set<Long> relations;
72 private Set<PrimitiveId> missingPrimitives;
73 private final DataSet outputDataSet;
74
75 /**
76 * Constructs a {@code MultiFetchServerObjectReader}.
77 */
78 protected MultiFetchServerObjectReader() {
79 nodes = new LinkedHashSet<>();
80 ways = new LinkedHashSet<>();
81 relations = new LinkedHashSet<>();
82 this.outputDataSet = new DataSet();
83 this.missingPrimitives = new LinkedHashSet<>();
84 }
85
86 /**
87 * Creates a new instance of {@link MultiFetchServerObjectReader} or {@link MultiFetchOverpassObjectReader}
88 * depending on the {@link OverpassServerPreference#useForMultiFetch preference}.
89 *
90 * @return a new instance
91 * @since 9241
92 */
93 public static MultiFetchServerObjectReader create() {
94 return create(OverpassServerPreference.useForMultiFetch());
95 }
96
97 /**
98 * Creates a new instance of {@link MultiFetchServerObjectReader} or {@link MultiFetchOverpassObjectReader}
99 * depending on the {@code fromMirror} parameter.
100 *
101 * @param fromMirror {@code false} for {@link MultiFetchServerObjectReader}, {@code true} for {@link MultiFetchOverpassObjectReader}
102 * @return a new instance
103 * @since 9241
104 */
105 static MultiFetchServerObjectReader create(final boolean fromMirror) {
106 if (fromMirror) {
107 return new MultiFetchOverpassObjectReader();
108 } else {
109 return new MultiFetchServerObjectReader();
110 }
111 }
112
113 /**
114 * Remembers an {@link OsmPrimitive}'s id. The id will
115 * later be fetched as part of a Multi Get request.
116 *
117 * Ignore the id if it represents a new primitives.
118 *
119 * @param id the id
120 */
121 protected void remember(PrimitiveId id) {
122 if (id.isNew()) return;
123 switch(id.getType()) {
124 case NODE: nodes.add(id.getUniqueId()); break;
125 case WAY: ways.add(id.getUniqueId()); break;
126 case RELATION: relations.add(id.getUniqueId()); break;
127 }
128 }
129
130 /**
131 * appends a {@link OsmPrimitive} id to the list of ids which will be fetched from the server.
132 *
133 * @param ds the {@link DataSet} to which the primitive belongs
134 * @param id the primitive id
135 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
136 * {@link OsmPrimitiveType#RELATION RELATION}
137 * @return this
138 */
139 public MultiFetchServerObjectReader append(DataSet ds, long id, OsmPrimitiveType type) {
140 OsmPrimitive p = ds.getPrimitiveById(id, type);
141 switch(type) {
142 case NODE:
143 return appendNode((Node) p);
144 case WAY:
145 return appendWay((Way) p);
146 case RELATION:
147 return appendRelation((Relation) p);
148 }
149 return this;
150 }
151
152 /**
153 * appends a {@link Node} id to the list of ids which will be fetched from the server.
154 *
155 * @param node the node (ignored, if null)
156 * @return this
157 */
158 public MultiFetchServerObjectReader appendNode(Node node) {
159 if (node == null) return this;
160 remember(node.getPrimitiveId());
161 return this;
162 }
163
164 /**
165 * appends a {@link Way} id and the list of ids of nodes the way refers to the list of ids which will be fetched from the server.
166 *
167 * @param way the way (ignored, if null)
168 * @return this
169 */
170 public MultiFetchServerObjectReader appendWay(Way way) {
171 if (way == null) return this;
172 if (way.isNew()) return this;
173 for (Node node: way.getNodes()) {
174 if (!node.isNew()) {
175 remember(node.getPrimitiveId());
176 }
177 }
178 remember(way.getPrimitiveId());
179 return this;
180 }
181
182 /**
183 * appends a {@link Relation} id to the list of ids which will be fetched from the server.
184 *
185 * @param relation the relation (ignored, if null)
186 * @return this
187 */
188 protected MultiFetchServerObjectReader appendRelation(Relation relation) {
189 if (relation == null) return this;
190 if (relation.isNew()) return this;
191 remember(relation.getPrimitiveId());
192 for (RelationMember member : relation.getMembers()) {
193 if (OsmPrimitiveType.from(member.getMember()).equals(OsmPrimitiveType.RELATION)) {
194 // avoid infinite recursion in case of cyclic dependencies in relations
195 //
196 if (relations.contains(member.getMember().getId())) {
197 continue;
198 }
199 }
200 if (!member.getMember().isIncomplete()) {
201 append(member.getMember());
202 }
203 }
204 return this;
205 }
206
207 /**
208 * appends an {@link OsmPrimitive} to the list of ids which will be fetched from the server.
209 * @param primitive the primitive
210 * @return this
211 */
212 public MultiFetchServerObjectReader append(OsmPrimitive primitive) {
213 if (primitive != null) {
214 switch (OsmPrimitiveType.from(primitive)) {
215 case NODE: return appendNode((Node) primitive);
216 case WAY: return appendWay((Way) primitive);
217 case RELATION: return appendRelation((Relation) primitive);
218 }
219 }
220 return this;
221 }
222
223 /**
224 * appends a list of {@link OsmPrimitive} to the list of ids which will be fetched from the server.
225 *
226 * @param primitives the list of primitives (ignored, if null)
227 * @return this
228 *
229 * @see #append(OsmPrimitive)
230 */
231 public MultiFetchServerObjectReader append(Collection<? extends OsmPrimitive> primitives) {
232 if (primitives == null) return this;
233 for (OsmPrimitive primitive : primitives) {
234 append(primitive);
235 }
236 return this;
237 }
238
239 /**
240 * extracts a subset of max {@link #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
241 * replies the subset. The extracted subset is removed from <code>ids</code>.
242 *
243 * @param ids a set of ids
244 * @return the subset of ids
245 */
246 protected Set<Long> extractIdPackage(Set<Long> ids) {
247 Set<Long> pkg = new HashSet<>();
248 if (ids.isEmpty())
249 return pkg;
250 if (ids.size() > MAX_IDS_PER_REQUEST) {
251 Iterator<Long> it = ids.iterator();
252 for (int i = 0; i < MAX_IDS_PER_REQUEST; i++) {
253 pkg.add(it.next());
254 }
255 ids.removeAll(pkg);
256 } else {
257 pkg.addAll(ids);
258 ids.clear();
259 }
260 return pkg;
261 }
262
263 /**
264 * builds the Multi Get request string for a set of ids and a given {@link OsmPrimitiveType}.
265 *
266 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
267 * {@link OsmPrimitiveType#RELATION RELATION}
268 * @param idPackage the package of ids
269 * @return the request string
270 */
271 protected String buildRequestString(final OsmPrimitiveType type, Set<Long> idPackage) {
272 return type.getAPIName() + "s?" + type.getAPIName() + "s=" + Utils.join(",", idPackage);
273 }
274
275 @Override
276 protected String getBaseUrl() {
277 return super.getBaseUrl();
278 }
279
280 protected void rememberNodesOfIncompleteWaysToLoad(DataSet from) {
281 for (Way w: from.getWays()) {
282 if (w.hasIncompleteNodes()) {
283 for (Node n: w.getNodes()) {
284 if (n.isIncomplete()) {
285 nodes.add(n.getId());
286 }
287 }
288 }
289 }
290 }
291
292 /**
293 * merges the dataset <code>from</code> to {@link #outputDataSet}.
294 *
295 * @param from the other dataset
296 */
297 protected void merge(DataSet from) {
298 final DataSetMerger visitor = new DataSetMerger(outputDataSet, from);
299 visitor.merge();
300 }
301
302 /**
303 * fetches a set of ids of a given {@link OsmPrimitiveType} from the server
304 *
305 * @param ids the set of ids
306 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
307 * {@link OsmPrimitiveType#RELATION RELATION}
308 * @param progressMonitor progress monitor
309 * @throws OsmTransferException if an error occurs while communicating with the API server
310 */
311 protected void fetchPrimitives(Set<Long> ids, OsmPrimitiveType type, ProgressMonitor progressMonitor) throws OsmTransferException {
312 String msg = "";
313 final String baseUrl = getBaseUrl();
314 switch (type) {
315 case NODE: msg = tr("Fetching a package of nodes from ''{0}''", baseUrl); break;
316 case WAY: msg = tr("Fetching a package of ways from ''{0}''", baseUrl); break;
317 case RELATION: msg = tr("Fetching a package of relations from ''{0}''", baseUrl); break;
318 }
319 progressMonitor.setTicksCount(ids.size());
320 progressMonitor.setTicks(0);
321 // The complete set containing all primitives to fetch
322 Set<Long> toFetch = new HashSet<>(ids);
323 // Build a list of fetchers that will download smaller sets containing only MAX_IDS_PER_REQUEST (200) primitives each.
324 // we will run up to MAX_DOWNLOAD_THREADS concurrent fetchers.
325 int threadsNumber = Main.pref.getInteger("osm.download.threads", OsmApi.MAX_DOWNLOAD_THREADS);
326 threadsNumber = Math.min(Math.max(threadsNumber, 1), OsmApi.MAX_DOWNLOAD_THREADS);
327 Executor exec = Executors.newFixedThreadPool(threadsNumber, Utils.newThreadFactory(getClass() + "-%d", Thread.NORM_PRIORITY));
328 CompletionService<FetchResult> ecs = new ExecutorCompletionService<>(exec);
329 List<Future<FetchResult>> jobs = new ArrayList<>();
330 while (!toFetch.isEmpty()) {
331 jobs.add(ecs.submit(new Fetcher(type, extractIdPackage(toFetch), progressMonitor)));
332 }
333 // Run the fetchers
334 for (int i = 0; i < jobs.size() && !isCanceled(); i++) {
335 progressMonitor.subTask(msg + "... " + progressMonitor.getTicks() + '/' + progressMonitor.getTicksCount());
336 try {
337 FetchResult result = ecs.take().get();
338 if (result.missingPrimitives != null) {
339 missingPrimitives.addAll(result.missingPrimitives);
340 }
341 if (result.dataSet != null && !isCanceled()) {
342 rememberNodesOfIncompleteWaysToLoad(result.dataSet);
343 merge(result.dataSet);
344 }
345 } catch (InterruptedException | ExecutionException e) {
346 Main.error(e);
347 }
348 }
349 // Cancel requests if the user choosed to
350 if (isCanceled()) {
351 for (Future<FetchResult> job : jobs) {
352 job.cancel(true);
353 }
354 }
355 }
356
357 /**
358 * invokes one or more Multi Gets to fetch the {@link OsmPrimitive}s and replies
359 * the dataset of retrieved primitives. Note that the dataset includes non visible primitives too!
360 * In contrast to a simple Get for a node, a way, or a relation, a Multi Get always replies
361 * the latest version of the primitive (if any), even if the primitive is not visible (i.e. if
362 * visible==false).
363 *
364 * Invoke {@link #getMissingPrimitives()} to get a list of primitives which have not been
365 * found on the server (the server response code was 404)
366 *
367 * @return the parsed data
368 * @throws OsmTransferException if an error occurs while communicating with the API server
369 * @see #getMissingPrimitives()
370 *
371 */
372 @Override
373 public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
374 int n = nodes.size() + ways.size() + relations.size();
375 progressMonitor.beginTask(trn("Downloading {0} object from ''{1}''",
376 "Downloading {0} objects from ''{1}''", n, n, OsmApi.getOsmApi().getBaseUrl()));
377 try {
378 missingPrimitives = new HashSet<>();
379 if (isCanceled()) return null;
380 fetchPrimitives(ways, OsmPrimitiveType.WAY, progressMonitor);
381 if (isCanceled()) return null;
382 fetchPrimitives(nodes, OsmPrimitiveType.NODE, progressMonitor);
383 if (isCanceled()) return null;
384 fetchPrimitives(relations, OsmPrimitiveType.RELATION, progressMonitor);
385 if (outputDataSet != null) {
386 outputDataSet.deleteInvisible();
387 }
388 return outputDataSet;
389 } finally {
390 progressMonitor.finishTask();
391 }
392 }
393
394 /**
395 * replies the set of ids of all primitives for which a fetch request to the
396 * server was submitted but which are not available from the server (the server
397 * replied a return code of 404)
398 *
399 * @return the set of ids of missing primitives
400 */
401 public Set<PrimitiveId> getMissingPrimitives() {
402 return missingPrimitives;
403 }
404
405 /**
406 * The class holding the results given by {@link Fetcher}.
407 * It is only a wrapper of the resulting {@link DataSet} and the collection of {@link PrimitiveId} that could not have been loaded.
408 */
409 protected static class FetchResult {
410
411 /**
412 * The resulting data set
413 */
414 public final DataSet dataSet;
415
416 /**
417 * The collection of primitive ids that could not have been loaded
418 */
419 public final Set<PrimitiveId> missingPrimitives;
420
421 /**
422 * Constructs a {@code FetchResult}
423 * @param dataSet The resulting data set
424 * @param missingPrimitives The collection of primitive ids that could not have been loaded
425 */
426 public FetchResult(DataSet dataSet, Set<PrimitiveId> missingPrimitives) {
427 this.dataSet = dataSet;
428 this.missingPrimitives = missingPrimitives;
429 }
430 }
431
432 /**
433 * The class that actually download data from OSM API.
434 * Several instances of this class are used by {@link MultiFetchServerObjectReader} (one per set of primitives to fetch).
435 * The inheritance of {@link OsmServerReader} is only explained by the need to have a distinct OSM connection by {@code Fetcher} instance.
436 * @see FetchResult
437 */
438 protected class Fetcher extends OsmServerReader implements Callable<FetchResult> {
439
440 private final Set<Long> pkg;
441 private final OsmPrimitiveType type;
442 private final ProgressMonitor progressMonitor;
443
444 /**
445 * Constructs a {@code Fetcher}
446 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
447 * {@link OsmPrimitiveType#RELATION RELATION}
448 * @param idsPackage The set of primitives ids to fetch
449 * @param progressMonitor The progress monitor
450 */
451 public Fetcher(OsmPrimitiveType type, Set<Long> idsPackage, ProgressMonitor progressMonitor) {
452 this.pkg = idsPackage;
453 this.type = type;
454 this.progressMonitor = progressMonitor;
455 }
456
457 @Override
458 public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
459 // This method is implemented because of the OsmServerReader inheritance, but not used,
460 // as the main target of this class is the call() method.
461 return fetch(progressMonitor).dataSet;
462 }
463
464 @Override
465 public FetchResult call() throws Exception {
466 return fetch(progressMonitor);
467 }
468
469 /**
470 * fetches the requested primitives and updates the specified progress monitor.
471 * @param progressMonitor the progress monitor
472 * @return the {@link FetchResult} of this operation
473 * @throws OsmTransferException if an error occurs while communicating with the API server
474 */
475 protected FetchResult fetch(ProgressMonitor progressMonitor) throws OsmTransferException {
476 try {
477 return multiGetIdPackage(type, pkg, progressMonitor);
478 } catch (OsmApiException e) {
479 if (e.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
480 Main.info(tr("Server replied with response code 404, retrying with an individual request for each object."));
481 return singleGetIdPackage(type, pkg, progressMonitor);
482 } else {
483 throw e;
484 }
485 }
486 }
487
488 @Override
489 protected String getBaseUrl() {
490 return MultiFetchServerObjectReader.this.getBaseUrl();
491 }
492
493 /**
494 * invokes a Multi Get for a set of ids and a given {@link OsmPrimitiveType}.
495 * The retrieved primitives are merged to {@link #outputDataSet}.
496 *
497 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
498 * {@link OsmPrimitiveType#RELATION RELATION}
499 * @param pkg the package of ids
500 * @param progressMonitor progress monitor
501 * @return the {@link FetchResult} of this operation
502 * @throws OsmTransferException if an error occurs while communicating with the API server
503 */
504 protected FetchResult multiGetIdPackage(OsmPrimitiveType type, Set<Long> pkg, ProgressMonitor progressMonitor)
505 throws OsmTransferException {
506 String request = buildRequestString(type, pkg);
507 FetchResult result = null;
508 try (InputStream in = getInputStream(request, NullProgressMonitor.INSTANCE)) {
509 if (in == null) return null;
510 progressMonitor.subTask(tr("Downloading OSM data..."));
511 try {
512 result = new FetchResult(OsmReader.parseDataSet(in, progressMonitor.createSubTaskMonitor(pkg.size(), false)), null);
513 } catch (Exception e) {
514 throw new OsmTransferException(e);
515 }
516 } catch (IOException ex) {
517 Main.warn(ex);
518 }
519 return result;
520 }
521
522 /**
523 * invokes a Multi Get for a single id and a given {@link OsmPrimitiveType}.
524 * The retrieved primitive is merged to {@link #outputDataSet}.
525 *
526 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
527 * {@link OsmPrimitiveType#RELATION RELATION}
528 * @param id the id
529 * @param progressMonitor progress monitor
530 * @return the {@link DataSet} resulting of this operation
531 * @throws OsmTransferException if an error occurs while communicating with the API server
532 */
533 protected DataSet singleGetId(OsmPrimitiveType type, long id, ProgressMonitor progressMonitor) throws OsmTransferException {
534 String request = buildRequestString(type, Collections.singleton(id));
535 DataSet result = null;
536 try (InputStream in = getInputStream(request, NullProgressMonitor.INSTANCE)) {
537 if (in == null) return null;
538 progressMonitor.subTask(tr("Downloading OSM data..."));
539 try {
540 result = OsmReader.parseDataSet(in, progressMonitor.createSubTaskMonitor(1, false));
541 } catch (Exception e) {
542 throw new OsmTransferException(e);
543 }
544 } catch (IOException ex) {
545 Main.warn(ex);
546 }
547 return result;
548 }
549
550 /**
551 * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@link OsmPrimitiveType}.
552 * The retrieved primitives are merged to {@link #outputDataSet}.
553 *
554 * This method is used if one of the ids in pkg doesn't exist (the server replies with return code 404).
555 * If the set is fetched with this method it is possible to find out which of the ids doesn't exist.
556 * Unfortunately, the server does not provide an error header or an error body for a 404 reply.
557 *
558 * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE}, {@link OsmPrimitiveType#WAY WAY},
559 * {@link OsmPrimitiveType#RELATION RELATION}
560 * @param pkg the set of ids
561 * @param progressMonitor progress monitor
562 * @return the {@link FetchResult} of this operation
563 * @throws OsmTransferException if an error occurs while communicating with the API server
564 */
565 protected FetchResult singleGetIdPackage(OsmPrimitiveType type, Set<Long> pkg, ProgressMonitor progressMonitor)
566 throws OsmTransferException {
567 FetchResult result = new FetchResult(new DataSet(), new HashSet<PrimitiveId>());
568 String baseUrl = OsmApi.getOsmApi().getBaseUrl();
569 for (long id : pkg) {
570 try {
571 String msg = "";
572 switch (type) {
573 case NODE: msg = tr("Fetching node with id {0} from ''{1}''", id, baseUrl); break;
574 case WAY: msg = tr("Fetching way with id {0} from ''{1}''", id, baseUrl); break;
575 case RELATION: msg = tr("Fetching relation with id {0} from ''{1}''", id, baseUrl); break;
576 }
577 progressMonitor.setCustomText(msg);
578 result.dataSet.mergeFrom(singleGetId(type, id, progressMonitor));
579 } catch (OsmApiException e) {
580 if (e.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
581 Main.info(tr("Server replied with response code 404 for id {0}. Skipping.", Long.toString(id)));
582 result.missingPrimitives.add(new SimplePrimitiveId(id, type));
583 } else {
584 throw e;
585 }
586 }
587 }
588 return result;
589 }
590 }
591}
Note: See TracBrowser for help on using the repository browser.