1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.io;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.io.BufferedReader;
|
---|
7 | import java.io.IOException;
|
---|
8 | import java.io.InputStream;
|
---|
9 | import java.io.InputStreamReader;
|
---|
10 | import java.net.HttpURLConnection;
|
---|
11 | import java.net.MalformedURLException;
|
---|
12 | import java.net.URL;
|
---|
13 | import java.nio.charset.StandardCharsets;
|
---|
14 | import java.util.List;
|
---|
15 | import java.util.Map;
|
---|
16 | import java.util.zip.GZIPInputStream;
|
---|
17 | import java.util.zip.Inflater;
|
---|
18 | import java.util.zip.InflaterInputStream;
|
---|
19 |
|
---|
20 | import org.openstreetmap.josm.Main;
|
---|
21 | import org.openstreetmap.josm.data.gpx.GpxData;
|
---|
22 | import org.openstreetmap.josm.data.notes.Note;
|
---|
23 | import org.openstreetmap.josm.data.osm.DataSet;
|
---|
24 | import org.openstreetmap.josm.gui.progress.ProgressMonitor;
|
---|
25 | import org.openstreetmap.josm.tools.Utils;
|
---|
26 |
|
---|
27 | /**
|
---|
28 | * This DataReader reads directly from the REST API of the osm server.
|
---|
29 | *
|
---|
30 | * It supports plain text transfer as well as gzip or deflate encoded transfers;
|
---|
31 | * if compressed transfers are unwanted, set property osm-server.use-compression
|
---|
32 | * to false.
|
---|
33 | *
|
---|
34 | * @author imi
|
---|
35 | */
|
---|
36 | public abstract class OsmServerReader extends OsmConnection {
|
---|
37 | private final OsmApi api = OsmApi.getOsmApi();
|
---|
38 | private boolean doAuthenticate;
|
---|
39 | protected boolean gpxParsedProperly;
|
---|
40 |
|
---|
41 | /**
|
---|
42 | * Open a connection to the given url and return a reader on the input stream
|
---|
43 | * from that connection. In case of user cancel, return <code>null</code>.
|
---|
44 | * Relative URL's are directed to API base URL.
|
---|
45 | * @param urlStr The url to connect to.
|
---|
46 | * @param progressMonitor progress monitoring and abort handler
|
---|
47 | * @return A reader reading the input stream (servers answer) or <code>null</code>.
|
---|
48 | * @throws OsmTransferException if data transfer errors occur
|
---|
49 | */
|
---|
50 | protected InputStream getInputStream(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
51 | return getInputStream(urlStr, progressMonitor, null);
|
---|
52 | }
|
---|
53 |
|
---|
54 | /**
|
---|
55 | * Open a connection to the given url and return a reader on the input stream
|
---|
56 | * from that connection. In case of user cancel, return <code>null</code>.
|
---|
57 | * Relative URL's are directed to API base URL.
|
---|
58 | * @param urlStr The url to connect to.
|
---|
59 | * @param progressMonitor progress monitoring and abort handler
|
---|
60 | * @param reason The reason to show on console. Can be {@code null} if no reason is given
|
---|
61 | * @return A reader reading the input stream (servers answer) or <code>null</code>.
|
---|
62 | * @throws OsmTransferException if data transfer errors occur
|
---|
63 | */
|
---|
64 | protected InputStream getInputStream(String urlStr, ProgressMonitor progressMonitor, String reason) throws OsmTransferException {
|
---|
65 | try {
|
---|
66 | api.initialize(progressMonitor);
|
---|
67 | String url = urlStr.startsWith("http") ? urlStr : (getBaseUrl() + urlStr);
|
---|
68 | return getInputStreamRaw(url, progressMonitor, reason);
|
---|
69 | } finally {
|
---|
70 | progressMonitor.invalidate();
|
---|
71 | }
|
---|
72 | }
|
---|
73 |
|
---|
74 | /**
|
---|
75 | * Return the base URL for relative URL requests
|
---|
76 | * @return base url of API
|
---|
77 | */
|
---|
78 | protected String getBaseUrl() {
|
---|
79 | return api.getBaseUrl();
|
---|
80 | }
|
---|
81 |
|
---|
82 | /**
|
---|
83 | * Open a connection to the given url and return a reader on the input stream
|
---|
84 | * from that connection. In case of user cancel, return <code>null</code>.
|
---|
85 | * @param urlStr The exact url to connect to.
|
---|
86 | * @param progressMonitor progress monitoring and abort handler
|
---|
87 | * @return An reader reading the input stream (servers answer) or <code>null</code>.
|
---|
88 | * @throws OsmTransferException if data transfer errors occur
|
---|
89 | */
|
---|
90 | protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
91 | return getInputStreamRaw(urlStr, progressMonitor, null);
|
---|
92 | }
|
---|
93 |
|
---|
94 | /**
|
---|
95 | * Open a connection to the given url and return a reader on the input stream
|
---|
96 | * from that connection. In case of user cancel, return <code>null</code>.
|
---|
97 | * @param urlStr The exact url to connect to.
|
---|
98 | * @param progressMonitor progress monitoring and abort handler
|
---|
99 | * @param reason The reason to show on console. Can be {@code null} if no reason is given
|
---|
100 | * @return An reader reading the input stream (servers answer) or <code>null</code>.
|
---|
101 | * @throws OsmTransferException if data transfer errors occur
|
---|
102 | */
|
---|
103 | protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor, String reason) throws OsmTransferException {
|
---|
104 | return getInputStreamRaw(urlStr, progressMonitor, reason, false);
|
---|
105 | }
|
---|
106 |
|
---|
107 | /**
|
---|
108 | * Open a connection to the given url and return a reader on the input stream
|
---|
109 | * from that connection. In case of user cancel, return <code>null</code>.
|
---|
110 | * @param urlStr The exact url to connect to.
|
---|
111 | * @param progressMonitor progress monitoring and abort handler
|
---|
112 | * @param reason The reason to show on console. Can be {@code null} if no reason is given
|
---|
113 | * @param uncompressAccordingToContentDisposition Whether to inspect the HTTP header {@code Content-Disposition}
|
---|
114 | * for {@code filename} and uncompress a gzip/bzip2 stream.
|
---|
115 | * @return An reader reading the input stream (servers answer) or <code>null</code>.
|
---|
116 | * @throws OsmTransferException if data transfer errors occur
|
---|
117 | */
|
---|
118 | @SuppressWarnings("resource")
|
---|
119 | protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor, String reason,
|
---|
120 | boolean uncompressAccordingToContentDisposition) throws OsmTransferException {
|
---|
121 | try {
|
---|
122 | OnlineResource.JOSM_WEBSITE.checkOfflineAccess(urlStr, Main.getJOSMWebsite());
|
---|
123 | OnlineResource.OSM_API.checkOfflineAccess(urlStr, Main.pref.get("osm-server.url", OsmApi.DEFAULT_API_URL));
|
---|
124 |
|
---|
125 | URL url = null;
|
---|
126 | try {
|
---|
127 | url = new URL(urlStr.replace(" ", "%20"));
|
---|
128 | } catch (MalformedURLException e) {
|
---|
129 | throw new OsmTransferException(e);
|
---|
130 | }
|
---|
131 | try {
|
---|
132 | // fix #7640, see http://www.tikalk.com/java/forums/httpurlconnection-disable-keep-alive
|
---|
133 | activeConnection = Utils.openHttpConnection(url, false);
|
---|
134 | } catch (Exception e) {
|
---|
135 | throw new OsmTransferException(tr("Failed to open connection to API {0}.", url.toExternalForm()), e);
|
---|
136 | }
|
---|
137 | Utils.setupURLConnection(activeConnection);
|
---|
138 | if (cancel) {
|
---|
139 | activeConnection.disconnect();
|
---|
140 | return null;
|
---|
141 | }
|
---|
142 |
|
---|
143 | if (doAuthenticate) {
|
---|
144 | addAuth(activeConnection);
|
---|
145 | }
|
---|
146 | if (cancel)
|
---|
147 | throw new OsmTransferCanceledException("Operation canceled");
|
---|
148 | if (Main.pref.getBoolean("osm-server.use-compression", true)) {
|
---|
149 | activeConnection.setRequestProperty("Accept-Encoding", "gzip, deflate");
|
---|
150 | }
|
---|
151 |
|
---|
152 | try {
|
---|
153 | if (reason != null && !reason.isEmpty()) {
|
---|
154 | Main.info("GET " + url + " (" + reason + ')');
|
---|
155 | } else {
|
---|
156 | Main.info("GET " + url);
|
---|
157 | }
|
---|
158 | activeConnection.connect();
|
---|
159 | } catch (Exception e) {
|
---|
160 | Main.error(e);
|
---|
161 | OsmTransferException ote = new OsmTransferException(
|
---|
162 | tr("Could not connect to the OSM server. Please check your internet connection."), e);
|
---|
163 | ote.setUrl(url.toString());
|
---|
164 | throw ote;
|
---|
165 | }
|
---|
166 | try {
|
---|
167 | if (Main.isDebugEnabled()) {
|
---|
168 | Main.debug("RESPONSE: "+activeConnection.getHeaderFields());
|
---|
169 | }
|
---|
170 | if (activeConnection.getResponseCode() == HttpURLConnection.HTTP_UNAUTHORIZED)
|
---|
171 | throw new OsmApiException(HttpURLConnection.HTTP_UNAUTHORIZED, null, null);
|
---|
172 |
|
---|
173 | if (activeConnection.getResponseCode() == HttpURLConnection.HTTP_PROXY_AUTH)
|
---|
174 | throw new OsmTransferCanceledException("Proxy Authentication Required");
|
---|
175 |
|
---|
176 | String encoding = activeConnection.getContentEncoding();
|
---|
177 | if (activeConnection.getResponseCode() != HttpURLConnection.HTTP_OK) {
|
---|
178 | String errorHeader = activeConnection.getHeaderField("Error");
|
---|
179 | StringBuilder errorBody = new StringBuilder();
|
---|
180 | try {
|
---|
181 | InputStream i = fixEncoding(activeConnection.getErrorStream(), encoding);
|
---|
182 | if (i != null) {
|
---|
183 | BufferedReader in = new BufferedReader(new InputStreamReader(i, StandardCharsets.UTF_8));
|
---|
184 | String s;
|
---|
185 | while ((s = in.readLine()) != null) {
|
---|
186 | errorBody.append(s);
|
---|
187 | errorBody.append('\n');
|
---|
188 | }
|
---|
189 | }
|
---|
190 | } catch (Exception e) {
|
---|
191 | errorBody.append(tr("Reading error text failed."));
|
---|
192 | }
|
---|
193 |
|
---|
194 | throw new OsmApiException(activeConnection.getResponseCode(), errorHeader, errorBody.toString(), url.toString());
|
---|
195 | }
|
---|
196 |
|
---|
197 | InputStream in = new ProgressInputStream(activeConnection, progressMonitor);
|
---|
198 | if (uncompressAccordingToContentDisposition) {
|
---|
199 | in = uncompressAccordingToContentDisposition(in, activeConnection.getHeaderFields());
|
---|
200 | }
|
---|
201 | return fixEncoding(in, encoding);
|
---|
202 | } catch (OsmTransferException e) {
|
---|
203 | throw e;
|
---|
204 | } catch (Exception e) {
|
---|
205 | throw new OsmTransferException(e);
|
---|
206 | }
|
---|
207 | } finally {
|
---|
208 | progressMonitor.invalidate();
|
---|
209 | }
|
---|
210 | }
|
---|
211 |
|
---|
212 | private static InputStream fixEncoding(InputStream stream, String encoding) throws IOException {
|
---|
213 | if ("gzip".equalsIgnoreCase(encoding)) {
|
---|
214 | stream = new GZIPInputStream(stream);
|
---|
215 | } else if ("deflate".equalsIgnoreCase(encoding)) {
|
---|
216 | stream = new InflaterInputStream(stream, new Inflater(true));
|
---|
217 | }
|
---|
218 | return stream;
|
---|
219 | }
|
---|
220 |
|
---|
221 | private InputStream uncompressAccordingToContentDisposition(InputStream stream, Map<String, List<String>> headerFields) throws IOException {
|
---|
222 | List<String> field = headerFields.get("Content-Disposition");
|
---|
223 | if (field != null && field.toString().contains(".gz\"")) {
|
---|
224 | return Compression.GZIP.getUncompressedInputStream(stream);
|
---|
225 | } else if (field != null && field.toString().contains(".bz2\"")) {
|
---|
226 | return Compression.BZIP2.getUncompressedInputStream(stream);
|
---|
227 | } else {
|
---|
228 | return stream;
|
---|
229 | }
|
---|
230 | }
|
---|
231 |
|
---|
232 | /**
|
---|
233 | * Download OSM files from somewhere
|
---|
234 | * @param progressMonitor The progress monitor
|
---|
235 | * @return The corresponding dataset
|
---|
236 | * @throws OsmTransferException if any error occurs
|
---|
237 | */
|
---|
238 | public abstract DataSet parseOsm(final ProgressMonitor progressMonitor) throws OsmTransferException;
|
---|
239 |
|
---|
240 | /**
|
---|
241 | * Download OSM Change files from somewhere
|
---|
242 | * @param progressMonitor The progress monitor
|
---|
243 | * @return The corresponding dataset
|
---|
244 | * @throws OsmTransferException if any error occurs
|
---|
245 | */
|
---|
246 | public DataSet parseOsmChange(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
247 | return null;
|
---|
248 | }
|
---|
249 |
|
---|
250 | /**
|
---|
251 | * Download BZip2-compressed OSM Change files from somewhere
|
---|
252 | * @param progressMonitor The progress monitor
|
---|
253 | * @return The corresponding dataset
|
---|
254 | * @throws OsmTransferException if any error occurs
|
---|
255 | */
|
---|
256 | public DataSet parseOsmChangeBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
257 | return null;
|
---|
258 | }
|
---|
259 |
|
---|
260 | /**
|
---|
261 | * Download GZip-compressed OSM Change files from somewhere
|
---|
262 | * @param progressMonitor The progress monitor
|
---|
263 | * @return The corresponding dataset
|
---|
264 | * @throws OsmTransferException if any error occurs
|
---|
265 | */
|
---|
266 | public DataSet parseOsmChangeGzip(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
267 | return null;
|
---|
268 | }
|
---|
269 |
|
---|
270 | /**
|
---|
271 | * Retrieve raw gps waypoints from the server API.
|
---|
272 | * @param progressMonitor The progress monitor
|
---|
273 | * @return The corresponding GPX tracks
|
---|
274 | * @throws OsmTransferException if any error occurs
|
---|
275 | */
|
---|
276 | public GpxData parseRawGps(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
277 | return null;
|
---|
278 | }
|
---|
279 |
|
---|
280 | /**
|
---|
281 | * Retrieve BZip2-compressed GPX files from somewhere.
|
---|
282 | * @param progressMonitor The progress monitor
|
---|
283 | * @return The corresponding GPX tracks
|
---|
284 | * @throws OsmTransferException if any error occurs
|
---|
285 | * @since 6244
|
---|
286 | */
|
---|
287 | public GpxData parseRawGpsBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
288 | return null;
|
---|
289 | }
|
---|
290 |
|
---|
291 | /**
|
---|
292 | * Download BZip2-compressed OSM files from somewhere
|
---|
293 | * @param progressMonitor The progress monitor
|
---|
294 | * @return The corresponding dataset
|
---|
295 | * @throws OsmTransferException if any error occurs
|
---|
296 | */
|
---|
297 | public DataSet parseOsmBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
298 | return null;
|
---|
299 | }
|
---|
300 |
|
---|
301 | /**
|
---|
302 | * Download GZip-compressed OSM files from somewhere
|
---|
303 | * @param progressMonitor The progress monitor
|
---|
304 | * @return The corresponding dataset
|
---|
305 | * @throws OsmTransferException if any error occurs
|
---|
306 | */
|
---|
307 | public DataSet parseOsmGzip(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
308 | return null;
|
---|
309 | }
|
---|
310 |
|
---|
311 | /**
|
---|
312 | * Download Zip-compressed OSM files from somewhere
|
---|
313 | * @param progressMonitor The progress monitor
|
---|
314 | * @return The corresponding dataset
|
---|
315 | * @throws OsmTransferException if any error occurs
|
---|
316 | * @since 6882
|
---|
317 | */
|
---|
318 | public DataSet parseOsmZip(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
319 | return null;
|
---|
320 | }
|
---|
321 |
|
---|
322 | /**
|
---|
323 | * Returns true if this reader is adding authentication credentials to the read
|
---|
324 | * request sent to the server.
|
---|
325 | *
|
---|
326 | * @return true if this reader is adding authentication credentials to the read
|
---|
327 | * request sent to the server
|
---|
328 | */
|
---|
329 | public boolean isDoAuthenticate() {
|
---|
330 | return doAuthenticate;
|
---|
331 | }
|
---|
332 |
|
---|
333 | /**
|
---|
334 | * Sets whether this reader adds authentication credentials to the read
|
---|
335 | * request sent to the server.
|
---|
336 | *
|
---|
337 | * @param doAuthenticate true if this reader adds authentication credentials to the read
|
---|
338 | * request sent to the server
|
---|
339 | */
|
---|
340 | public void setDoAuthenticate(boolean doAuthenticate) {
|
---|
341 | this.doAuthenticate = doAuthenticate;
|
---|
342 | }
|
---|
343 |
|
---|
344 | /**
|
---|
345 | * Determines if the GPX data has been parsed properly.
|
---|
346 | * @return true if the GPX data has been parsed properly, false otherwise
|
---|
347 | * @see GpxReader#parse
|
---|
348 | */
|
---|
349 | public final boolean isGpxParsedProperly() {
|
---|
350 | return gpxParsedProperly;
|
---|
351 | }
|
---|
352 |
|
---|
353 | /**
|
---|
354 | * Downloads notes from the API, given API limit parameters
|
---|
355 | *
|
---|
356 | * @param noteLimit How many notes to download.
|
---|
357 | * @param daysClosed Return notes closed this many days in the past. -1 means all notes, ever. 0 means only unresolved notes.
|
---|
358 | * @param progressMonitor Progress monitor for user feedback
|
---|
359 | * @return List of notes returned by the API
|
---|
360 | * @throws OsmTransferException if any errors happen
|
---|
361 | */
|
---|
362 | public List<Note> parseNotes(int noteLimit, int daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
363 | return null;
|
---|
364 | }
|
---|
365 |
|
---|
366 | /**
|
---|
367 | * Downloads notes from a given raw URL. The URL is assumed to be complete and no API limits are added
|
---|
368 | *
|
---|
369 | * @param progressMonitor progress monitor
|
---|
370 | * @return A list of notes parsed from the URL
|
---|
371 | * @throws OsmTransferException if any error occurs during dialog with OSM API
|
---|
372 | */
|
---|
373 | public List<Note> parseRawNotes(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
374 | return null;
|
---|
375 | }
|
---|
376 |
|
---|
377 | /**
|
---|
378 | * Download notes from a URL that contains a bzip2 compressed notes dump file
|
---|
379 | * @param progressMonitor progress monitor
|
---|
380 | * @return A list of notes parsed from the URL
|
---|
381 | * @throws OsmTransferException if any error occurs during dialog with OSM API
|
---|
382 | */
|
---|
383 | public List<Note> parseRawNotesBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
|
---|
384 | return null;
|
---|
385 | }
|
---|
386 | }
|
---|