001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.actions.downloadtasks; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.io.IOException; 007import java.net.URL; 008import java.util.concurrent.Future; 009import java.util.regex.Matcher; 010import java.util.regex.Pattern; 011 012import org.openstreetmap.josm.Main; 013import org.openstreetmap.josm.data.Bounds; 014import org.openstreetmap.josm.data.Bounds.ParseMethod; 015import org.openstreetmap.josm.data.gpx.GpxData; 016import org.openstreetmap.josm.gui.PleaseWaitRunnable; 017import org.openstreetmap.josm.gui.layer.GpxLayer; 018import org.openstreetmap.josm.gui.layer.Layer; 019import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer; 020import org.openstreetmap.josm.gui.progress.ProgressMonitor; 021import org.openstreetmap.josm.gui.progress.ProgressTaskId; 022import org.openstreetmap.josm.gui.progress.ProgressTaskIds; 023import org.openstreetmap.josm.io.BoundingBoxDownloader; 024import org.openstreetmap.josm.io.GpxImporter; 025import org.openstreetmap.josm.io.GpxImporter.GpxImporterData; 026import org.openstreetmap.josm.io.OsmServerLocationReader; 027import org.openstreetmap.josm.io.OsmServerReader; 028import org.openstreetmap.josm.io.OsmTransferException; 029import org.openstreetmap.josm.tools.CheckParameterUtil; 030import org.xml.sax.SAXException; 031 032/** 033 * Task allowing to download GPS data. 034 */ 035public class DownloadGpsTask extends AbstractDownloadTask { 036 037 private DownloadTask downloadTask; 038 039 private static final String PATTERN_TRACE_ID = "https?://.*(osm|openstreetmap).org/trace/\\p{Digit}+/data"; 040 041 private static final String PATTERN_TRACKPOINTS_BBOX = "https?://.*/api/0.6/trackpoints\\?bbox=.*,.*,.*,.*"; 042 043 private static final String PATTERN_EXTERNAL_GPX_SCRIPT = "https?://.*exportgpx.*"; 044 private static final String PATTERN_EXTERNAL_GPX_FILE = "https?://.*/(.*\\.gpx)"; 045 046 protected String newLayerName = null; 047 048 @Override 049 public String[] getPatterns() { 050 return new String[] {PATTERN_EXTERNAL_GPX_FILE, PATTERN_EXTERNAL_GPX_SCRIPT, PATTERN_TRACE_ID, PATTERN_TRACKPOINTS_BBOX}; 051 } 052 053 @Override 054 public String getTitle() { 055 return tr("Download GPS"); 056 } 057 058 @Override 059 public Future<?> download(boolean newLayer, Bounds downloadArea, ProgressMonitor progressMonitor) { 060 downloadTask = new DownloadTask(newLayer, 061 new BoundingBoxDownloader(downloadArea), progressMonitor); 062 // We need submit instead of execute so we can wait for it to finish and get the error 063 // message if necessary. If no one calls getErrorMessage() it just behaves like execute. 064 return Main.worker.submit(downloadTask); 065 } 066 067 @Override 068 public Future<?> loadUrl(boolean newLayer, String url, ProgressMonitor progressMonitor) { 069 CheckParameterUtil.ensureParameterNotNull(url, "url"); 070 if (url.matches(PATTERN_TRACE_ID) || url.matches(PATTERN_EXTERNAL_GPX_SCRIPT) || url.matches(PATTERN_EXTERNAL_GPX_FILE)) { 071 downloadTask = new DownloadTask(newLayer, 072 new OsmServerLocationReader(url), progressMonitor); 073 // Extract .gpx filename from URL to set the new layer name 074 Matcher matcher = Pattern.compile(PATTERN_EXTERNAL_GPX_FILE).matcher(url); 075 newLayerName = matcher.matches() ? matcher.group(1) : null; 076 // We need submit instead of execute so we can wait for it to finish and get the error 077 // message if necessary. If no one calls getErrorMessage() it just behaves like execute. 078 return Main.worker.submit(downloadTask); 079 080 } else if (url.matches(PATTERN_TRACKPOINTS_BBOX)) { 081 String[] table = url.split("\\?|=|&"); 082 for (int i = 0; i<table.length; i++) { 083 if ("bbox".equals(table[i]) && i<table.length-1 ) 084 return download(newLayer, new Bounds(table[i+1], ",", ParseMethod.LEFT_BOTTOM_RIGHT_TOP), progressMonitor); 085 } 086 } 087 return null; 088 } 089 090 @Override 091 public void cancel() { 092 if (downloadTask != null) { 093 downloadTask.cancel(); 094 } 095 } 096 097 class DownloadTask extends PleaseWaitRunnable { 098 private OsmServerReader reader; 099 private GpxData rawData; 100 private final boolean newLayer; 101 102 public DownloadTask(boolean newLayer, OsmServerReader reader, ProgressMonitor progressMonitor) { 103 super(tr("Downloading GPS data")); 104 this.reader = reader; 105 this.newLayer = newLayer; 106 } 107 108 @Override public void realRun() throws IOException, SAXException, OsmTransferException { 109 try { 110 if (isCanceled()) 111 return; 112 ProgressMonitor subMonitor = progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false); 113 rawData = reader.parseRawGps(subMonitor); 114 } catch(Exception e) { 115 if (isCanceled()) 116 return; 117 if (e instanceof OsmTransferException) { 118 rememberException(e); 119 } else { 120 rememberException(new OsmTransferException(e)); 121 } 122 } 123 } 124 125 @Override protected void finish() { 126 if (isCanceled() || isFailed()) 127 return; 128 if (rawData == null) 129 return; 130 String name = newLayerName != null ? newLayerName : tr("Downloaded GPX Data"); 131 132 GpxImporterData layers = GpxImporter.loadLayers(rawData, reader.isGpxParsedProperly(), name, tr("Markers from {0}", name)); 133 134 GpxLayer gpxLayer = addOrMergeLayer(layers.getGpxLayer(), findGpxMergeLayer()); 135 addOrMergeLayer(layers.getMarkerLayer(), findMarkerMergeLayer(gpxLayer)); 136 137 layers.getPostLayerTask().run(); 138 } 139 140 private <L extends Layer> L addOrMergeLayer(L layer, L mergeLayer) { 141 if (layer == null) return null; 142 if (newLayer || mergeLayer == null) { 143 Main.main.addLayer(layer); 144 return layer; 145 } else { 146 mergeLayer.mergeFrom(layer); 147 Main.map.repaint(); 148 return mergeLayer; 149 } 150 } 151 152 private GpxLayer findGpxMergeLayer() { 153 if (!Main.isDisplayingMapView()) 154 return null; 155 boolean merge = Main.pref.getBoolean("download.gps.mergeWithLocal", false); 156 Layer active = Main.map.mapView.getActiveLayer(); 157 if (active instanceof GpxLayer && (merge || ((GpxLayer)active).data.fromServer)) 158 return (GpxLayer) active; 159 for (GpxLayer l : Main.map.mapView.getLayersOfType(GpxLayer.class)) { 160 if (merge || l.data.fromServer) 161 return l; 162 } 163 return null; 164 } 165 166 private MarkerLayer findMarkerMergeLayer(GpxLayer fromLayer) { 167 if (!Main.isDisplayingMapView()) 168 return null; 169 for (MarkerLayer l : Main.map.mapView.getLayersOfType(MarkerLayer.class)) { 170 if (fromLayer != null && l.fromLayer == fromLayer) 171 return l; 172 } 173 return null; 174 } 175 176 @Override protected void cancel() { 177 setCanceled(true); 178 if (reader != null) { 179 reader.cancel(); 180 } 181 } 182 183 @Override 184 public ProgressTaskId canRunInBackground() { 185 return ProgressTaskIds.DOWNLOAD_GPS; 186 } 187 } 188 189 @Override 190 public String getConfirmationMessage(URL url) { 191 // TODO 192 return null; 193 } 194 195 /** 196 * Determines if the given URL denotes an OSM gpx-related API call. 197 * @param url The url to check 198 * @return true if the url matches "Trace ID" API call or "Trackpoints bbox" API call, false otherwise 199 * @see GpxData#fromServer 200 * @since 5745 201 */ 202 public static final boolean isFromServer(String url) { 203 return url != null && (url.matches(PATTERN_TRACE_ID) || url.matches(PATTERN_TRACKPOINTS_BBOX)); 204 } 205}