1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.data.imagery;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.io.ByteArrayInputStream;
|
---|
7 | import java.io.IOException;
|
---|
8 | import java.net.URL;
|
---|
9 | import java.net.URLConnection;
|
---|
10 | import java.util.HashSet;
|
---|
11 | import java.util.List;
|
---|
12 | import java.util.Map;
|
---|
13 | import java.util.Map.Entry;
|
---|
14 | import java.util.Set;
|
---|
15 | import java.util.concurrent.ConcurrentHashMap;
|
---|
16 | import java.util.concurrent.ConcurrentMap;
|
---|
17 | import java.util.concurrent.ThreadPoolExecutor;
|
---|
18 | import java.util.logging.Level;
|
---|
19 | import java.util.logging.Logger;
|
---|
20 |
|
---|
21 | import org.apache.commons.jcs.access.behavior.ICacheAccess;
|
---|
22 | import org.openstreetmap.gui.jmapviewer.FeatureAdapter;
|
---|
23 | import org.openstreetmap.gui.jmapviewer.Tile;
|
---|
24 | import org.openstreetmap.gui.jmapviewer.interfaces.TileJob;
|
---|
25 | import org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener;
|
---|
26 | import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;
|
---|
27 | import org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource;
|
---|
28 | import org.openstreetmap.josm.data.cache.BufferedImageCacheEntry;
|
---|
29 | import org.openstreetmap.josm.data.cache.CacheEntry;
|
---|
30 | import org.openstreetmap.josm.data.cache.CacheEntryAttributes;
|
---|
31 | import org.openstreetmap.josm.data.cache.ICachedLoaderListener;
|
---|
32 | import org.openstreetmap.josm.data.cache.JCSCachedTileLoaderJob;
|
---|
33 |
|
---|
34 | /**
|
---|
35 | * @author Wiktor Niesiobędzki
|
---|
36 | *
|
---|
37 | * Class bridging TMS requests to JCS cache requests
|
---|
38 | * @since 8168
|
---|
39 | */
|
---|
40 | public class TMSCachedTileLoaderJob extends JCSCachedTileLoaderJob<String, BufferedImageCacheEntry> implements TileJob, ICachedLoaderListener {
|
---|
41 | private static final Logger LOG = FeatureAdapter.getLogger(TMSCachedTileLoaderJob.class.getCanonicalName());
|
---|
42 | private static final long MAXIMUM_EXPIRES = 30 /*days*/ * 24 /*hours*/ * 60 /*minutes*/ * 60 /*seconds*/ *1000L /*milliseconds*/;
|
---|
43 | private static final long MINIMUM_EXPIRES = 1 /*hour*/ * 60 /*minutes*/ * 60 /*seconds*/ *1000L /*milliseconds*/;
|
---|
44 | private Tile tile;
|
---|
45 | private volatile URL url;
|
---|
46 |
|
---|
47 | // we need another deduplication of Tile Loader listeners, as for each submit, new TMSCachedTileLoaderJob was created
|
---|
48 | // that way, we reduce calls to tileLoadingFinished, and general CPU load due to surplus Map repaints
|
---|
49 | private static final ConcurrentMap<String, Set<TileLoaderListener>> inProgress = new ConcurrentHashMap<>();
|
---|
50 |
|
---|
51 | /**
|
---|
52 | * Constructor for creating a job, to get a specific tile from cache
|
---|
53 | * @param listener Tile loader listener
|
---|
54 | * @param tile to be fetched from cache
|
---|
55 | * @param cache object
|
---|
56 | * @param connectTimeout when connecting to remote resource
|
---|
57 | * @param readTimeout when connecting to remote resource
|
---|
58 | * @param headers HTTP headers to be sent together with request
|
---|
59 | * @param downloadExecutor that will be executing the jobs
|
---|
60 | */
|
---|
61 | public TMSCachedTileLoaderJob(TileLoaderListener listener, Tile tile,
|
---|
62 | ICacheAccess<String, BufferedImageCacheEntry> cache,
|
---|
63 | int connectTimeout, int readTimeout, Map<String, String> headers,
|
---|
64 | ThreadPoolExecutor downloadExecutor) {
|
---|
65 | super(cache, connectTimeout, readTimeout, headers, downloadExecutor);
|
---|
66 | this.tile = tile;
|
---|
67 | if (listener != null) {
|
---|
68 | String deduplicationKey = getCacheKey();
|
---|
69 | synchronized (inProgress) {
|
---|
70 | Set<TileLoaderListener> newListeners = inProgress.get(deduplicationKey);
|
---|
71 | if (newListeners == null) {
|
---|
72 | newListeners = new HashSet<>();
|
---|
73 | inProgress.put(deduplicationKey, newListeners);
|
---|
74 | }
|
---|
75 | newListeners.add(listener);
|
---|
76 | }
|
---|
77 | }
|
---|
78 | }
|
---|
79 |
|
---|
80 | @Override
|
---|
81 | public Tile getTile() {
|
---|
82 | return getCachedTile();
|
---|
83 | }
|
---|
84 |
|
---|
85 | @Override
|
---|
86 | public String getCacheKey() {
|
---|
87 | if (tile != null) {
|
---|
88 | TileSource tileSource = tile.getTileSource();
|
---|
89 | String tsName = tileSource.getName();
|
---|
90 | if (tsName == null) {
|
---|
91 | tsName = "";
|
---|
92 | }
|
---|
93 | return tsName.replace(":", "_") + ":" + tileSource.getTileId(tile.getZoom(), tile.getXtile(), tile.getYtile());
|
---|
94 | }
|
---|
95 | return null;
|
---|
96 | }
|
---|
97 |
|
---|
98 | /*
|
---|
99 | * this doesn't needs to be synchronized, as it's not that costly to keep only one execution
|
---|
100 | * in parallel, but URL creation and Tile.getUrl() are costly and are not needed when fetching
|
---|
101 | * data from cache, that's why URL creation is postponed until it's needed
|
---|
102 | *
|
---|
103 | * We need to have static url value for TileLoaderJob, as for some TileSources we might get different
|
---|
104 | * URL's each call we made (servers switching), and URL's are used below as a key for duplicate detection
|
---|
105 | *
|
---|
106 | */
|
---|
107 | @Override
|
---|
108 | public URL getUrl() {
|
---|
109 | if (url == null) {
|
---|
110 | try {
|
---|
111 | synchronized (this) {
|
---|
112 | if (url == null)
|
---|
113 | url = new URL(tile.getUrl());
|
---|
114 | }
|
---|
115 | } catch (IOException e) {
|
---|
116 | LOG.log(Level.WARNING, "JCS TMS Cache - error creating URL for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
|
---|
117 | LOG.log(Level.INFO, "Exception: ", e);
|
---|
118 | }
|
---|
119 | }
|
---|
120 | return url;
|
---|
121 | }
|
---|
122 |
|
---|
123 | @Override
|
---|
124 | public boolean isObjectLoadable() {
|
---|
125 | if (cacheData != null) {
|
---|
126 | byte[] content = cacheData.getContent();
|
---|
127 | try {
|
---|
128 | return content != null || cacheData.getImage() != null || isNoTileAtZoom();
|
---|
129 | } catch (IOException e) {
|
---|
130 | LOG.log(Level.WARNING, "JCS TMS - error loading from cache for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
|
---|
131 | }
|
---|
132 | }
|
---|
133 | return false;
|
---|
134 | }
|
---|
135 |
|
---|
136 | @Override
|
---|
137 | protected boolean isResponseLoadable(Map<String, List<String>> headers, int statusCode, byte[] content) {
|
---|
138 | attributes.setMetadata(tile.getTileSource().getMetadata(headers));
|
---|
139 | if (tile.getTileSource().isNoTileAtZoom(headers, statusCode, content)) {
|
---|
140 | attributes.setNoTileAtZoom(true);
|
---|
141 | return false; // do no try to load data from no-tile at zoom, cache empty object instead
|
---|
142 | }
|
---|
143 | return super.isResponseLoadable(headers, statusCode, content);
|
---|
144 | }
|
---|
145 |
|
---|
146 | @Override
|
---|
147 | protected boolean cacheAsEmpty() {
|
---|
148 | return isNoTileAtZoom() || super.cacheAsEmpty();
|
---|
149 | }
|
---|
150 |
|
---|
151 | @Override
|
---|
152 | public void submit(boolean force) {
|
---|
153 | tile.initLoading();
|
---|
154 | super.submit(this, force);
|
---|
155 | }
|
---|
156 |
|
---|
157 | @Override
|
---|
158 | public void loadingFinished(CacheEntry object, CacheEntryAttributes attributes, LoadResult result) {
|
---|
159 | this.attributes = attributes; // as we might get notification from other object than our selfs, pass attributes along
|
---|
160 | Set<TileLoaderListener> listeners;
|
---|
161 | synchronized (inProgress) {
|
---|
162 | listeners = inProgress.remove(getCacheKey());
|
---|
163 | }
|
---|
164 | boolean status = result.equals(LoadResult.SUCCESS);
|
---|
165 |
|
---|
166 | try {
|
---|
167 | if (!tile.isLoaded()) { //if someone else already loaded tile, skip all the handling
|
---|
168 | tile.finishLoading(); // whatever happened set that loading has finished
|
---|
169 | // set tile metadata
|
---|
170 | if (this.attributes != null) {
|
---|
171 | for (Entry<String, String> e: this.attributes.getMetadata().entrySet()) {
|
---|
172 | tile.putValue(e.getKey(), e.getValue());
|
---|
173 | }
|
---|
174 | }
|
---|
175 |
|
---|
176 | switch(result) {
|
---|
177 | case SUCCESS:
|
---|
178 | handleNoTileAtZoom();
|
---|
179 | if (object != null) {
|
---|
180 | byte[] content = object.getContent();
|
---|
181 | if (content != null && content.length > 0) {
|
---|
182 | tile.loadImage(new ByteArrayInputStream(content));
|
---|
183 | if (tile.getImage() == null) {
|
---|
184 | tile.setError(tr("Could not load image from tile server"));
|
---|
185 | status = false;
|
---|
186 | }
|
---|
187 | }
|
---|
188 | }
|
---|
189 | int httpStatusCode = attributes.getResponseCode();
|
---|
190 | if (!isNoTileAtZoom() && httpStatusCode >= 400) {
|
---|
191 | if (attributes.getErrorMessage() == null) {
|
---|
192 | tile.setError(tr("HTTP error {0} when loading tiles", httpStatusCode));
|
---|
193 | } else {
|
---|
194 | tile.setError(tr("Error downloading tiles: {0}", attributes.getErrorMessage()));
|
---|
195 | }
|
---|
196 | status = false;
|
---|
197 | }
|
---|
198 | break;
|
---|
199 | case FAILURE:
|
---|
200 | tile.setError("Problem loading tile");
|
---|
201 | // no break intentional here
|
---|
202 | case CANCELED:
|
---|
203 | // do nothing
|
---|
204 | }
|
---|
205 | }
|
---|
206 |
|
---|
207 | // always check, if there is some listener interested in fact, that tile has finished loading
|
---|
208 | if (listeners != null) { // listeners might be null, if some other thread notified already about success
|
---|
209 | for (TileLoaderListener l: listeners) {
|
---|
210 | l.tileLoadingFinished(tile, status);
|
---|
211 | }
|
---|
212 | }
|
---|
213 | } catch (IOException e) {
|
---|
214 | LOG.log(Level.WARNING, "JCS TMS - error loading object for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
|
---|
215 | tile.setError(e.toString());
|
---|
216 | tile.setLoaded(false);
|
---|
217 | if (listeners != null) { // listeners might be null, if some other thread notified already about success
|
---|
218 | for (TileLoaderListener l: listeners) {
|
---|
219 | l.tileLoadingFinished(tile, false);
|
---|
220 | }
|
---|
221 | }
|
---|
222 | }
|
---|
223 | }
|
---|
224 |
|
---|
225 | /**
|
---|
226 | * For TMS use BaseURL as settings discovery, so for different paths, we will have different settings (useful for developer servers)
|
---|
227 | *
|
---|
228 | * @return base URL of TMS or server url as defined in super class
|
---|
229 | */
|
---|
230 | @Override
|
---|
231 | protected String getServerKey() {
|
---|
232 | TileSource ts = tile.getSource();
|
---|
233 | if (ts instanceof AbstractTMSTileSource) {
|
---|
234 | return ((AbstractTMSTileSource) ts).getBaseUrl();
|
---|
235 | }
|
---|
236 | return super.getServerKey();
|
---|
237 | }
|
---|
238 |
|
---|
239 | @Override
|
---|
240 | protected BufferedImageCacheEntry createCacheEntry(byte[] content) {
|
---|
241 | return new BufferedImageCacheEntry(content);
|
---|
242 | }
|
---|
243 |
|
---|
244 | @Override
|
---|
245 | public void submit() {
|
---|
246 | submit(false);
|
---|
247 | }
|
---|
248 |
|
---|
249 | @Override
|
---|
250 | protected CacheEntryAttributes parseHeaders(URLConnection urlConn) {
|
---|
251 | CacheEntryAttributes ret = super.parseHeaders(urlConn);
|
---|
252 | // keep the expiration time between MINIMUM_EXPIRES and MAXIMUM_EXPIRES, so we will cache the tiles
|
---|
253 | // at least for some short period of time, but not too long
|
---|
254 | if (ret.getExpirationTime() < now + MINIMUM_EXPIRES) {
|
---|
255 | ret.setExpirationTime(now + MINIMUM_EXPIRES);
|
---|
256 | }
|
---|
257 | if (ret.getExpirationTime() > now + MAXIMUM_EXPIRES) {
|
---|
258 | ret.setExpirationTime(now + MAXIMUM_EXPIRES);
|
---|
259 | }
|
---|
260 | return ret;
|
---|
261 | }
|
---|
262 |
|
---|
263 | /**
|
---|
264 | * Method for getting the tile from cache only, without trying to reach remote resource
|
---|
265 | * @return tile or null, if nothing (useful) was found in cache
|
---|
266 | */
|
---|
267 | public Tile getCachedTile() {
|
---|
268 | BufferedImageCacheEntry data = get();
|
---|
269 | if (isObjectLoadable() && isCacheElementValid()) {
|
---|
270 | try {
|
---|
271 | // set tile metadata
|
---|
272 | if (this.attributes != null) {
|
---|
273 | for (Entry<String, String> e: this.attributes.getMetadata().entrySet()) {
|
---|
274 | tile.putValue(e.getKey(), e.getValue());
|
---|
275 | }
|
---|
276 | }
|
---|
277 |
|
---|
278 | if (data != null) {
|
---|
279 | if (data.getImage() != null) {
|
---|
280 | tile.setImage(data.getImage());
|
---|
281 | tile.finishLoading();
|
---|
282 | } else {
|
---|
283 | // we had some data, but we didn't get any image. Malformed image?
|
---|
284 | tile.setError(tr("Could not load image from tile server"));
|
---|
285 | }
|
---|
286 | }
|
---|
287 | if (isNoTileAtZoom()) {
|
---|
288 | handleNoTileAtZoom();
|
---|
289 | tile.finishLoading();
|
---|
290 | }
|
---|
291 | if (attributes != null && attributes.getResponseCode() >= 400) {
|
---|
292 | if (attributes.getErrorMessage() == null) {
|
---|
293 | tile.setError(tr("HTTP error {0} when loading tiles", attributes.getResponseCode()));
|
---|
294 | } else {
|
---|
295 | tile.setError(tr("Error downloading tiles: {0}", attributes.getErrorMessage()));
|
---|
296 | }
|
---|
297 | }
|
---|
298 | return tile;
|
---|
299 | } catch (IOException e) {
|
---|
300 | LOG.log(Level.WARNING, "JCS TMS - error loading object for tile {0}: {1}", new Object[] {tile.getKey(), e.getMessage()});
|
---|
301 | return null;
|
---|
302 | }
|
---|
303 |
|
---|
304 | } else {
|
---|
305 | return tile;
|
---|
306 | }
|
---|
307 | }
|
---|
308 |
|
---|
309 | private boolean handleNoTileAtZoom() {
|
---|
310 | if (isNoTileAtZoom()) {
|
---|
311 | LOG.log(Level.FINE, "JCS TMS - Tile valid, but no file, as no tiles at this level {0}", tile);
|
---|
312 | tile.setError("No tile at this zoom level");
|
---|
313 | tile.putValue("tile-info", "no-tile");
|
---|
314 | return true;
|
---|
315 | }
|
---|
316 | return false;
|
---|
317 | }
|
---|
318 |
|
---|
319 | private boolean isNoTileAtZoom() {
|
---|
320 | if (attributes == null) {
|
---|
321 | LOG.warning("Cache attributes are null");
|
---|
322 | }
|
---|
323 | return attributes != null && attributes.isNoTileAtZoom();
|
---|
324 | }
|
---|
325 |
|
---|
326 |
|
---|
327 | }
|
---|