Changeset 7434 in josm for trunk/src/org/openstreetmap/josm/io/CachedFile.java

Timestamp:

2014-08-20T03:07:15+02:00 (12 years ago)

Author:

Don-vip

Message:

fix #8885 (see #4614) - add offline mode with new command line argument --offline which can take one of several of these values (comma separated):

• josm_website: to disable all accesses to JOSM website (when not cached, disables Getting Started page, help, plugin list, styles, imagery, presets, rules)
• osm_api: to disable all accesses to OSM API (disables download, upload, changeset queries, history, user message notification)
• all: alias to disable all values. Currently equivalent to "josm_website,osm_api"

Plus improved javadoc, fixed EDT violations, and fixed a bug with HTTP redirection sent without "Location" header

File:

• trunk/src/org/openstreetmap/josm/io/CachedFile.java (modified) (22 diffs)

trunk/src/org/openstreetmap/josm/io/CachedFile.java

@@ -24 +24 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.Pair;
 import org.openstreetmap.josm.tools.Utils;
@@ -29 +30 @@
 /**
  * Downloads a file and caches it on disk in order to reduce network load.
- * 
+ *
  * Supports URLs, local files, and a custom scheme (<code>resource:</code>) to get
  * resources from the current *.jar file. (Local caching is only done for URLs.)
@@ -49 +50 @@
          * consider the cache stale and try to download the file again.
          */
-        MaxAge, 
+        MaxAge,
         /**
          * Similar to MaxAge, considers the cache stale when a certain age is
@@ -56 +57 @@
          * as a full download.
          */
-        IfModifiedSince 
+        IfModifiedSince
     }
     protected String name;
@@ -63 +64 @@
     protected String httpAccept;
     protected CachingStrategy cachingStrategy;
-    
+
     protected File cacheFile = null;
     boolean initialized = false;
@@ -98 +99 @@
         return this;
     }
-    
+
     /**
      * Set maximum age of cache file. Only applies to URLs.
@@ -201 +202 @@
                 cacheFile = checkLocal(url);
             }
-        } catch (java.net.MalformedURLException e) {
+        } catch (MalformedURLException e) {
             if (name.startsWith("resource://")) {
                 return null;
@@ -211 +212 @@
         }
         if (cacheFile == null)
-            throw new IOException();
+            throw new IOException("Unable to get cache file for "+name);
         return cacheFile;
     }
-    
+
     /**
      * Looks for a certain entry inside a zip file and returns the entry path.
@@ -292 +293 @@
      * Clear the cache for the given resource.
      * This forces a fresh download.
-     * @param name the URL 
+     * @param name the URL
      */
     public static void cleanup(String name) {
@@ -341 +342 @@
     private File checkLocal(URL url) throws IOException {
         String prefKey = getPrefKey(url, destDir);
+        String urlStr = url.toExternalForm();
         long age = 0L;
         long lMaxAge = maxAge;
@@ -346 +348 @@
         File localFile = null;
         List<String> localPathEntry = new ArrayList<>(Main.pref.getCollection(prefKey));
+        boolean offline = false;
+        try {
+            checkOfflineAccess(urlStr);
+        } catch (OfflineAccessException e) {
+            offline = true;
+        }
         if (localPathEntry.size() == 2) {
             localFile = new File(localPathEntry.get(1));
-            if(!localFile.exists())
+            if (!localFile.exists()) {
                 localFile = null;
-            else {
+            } else {
                 if ( maxAge == DEFAULT_MAXTIME
                         || maxAge <= 0 // arbitrary value <= 0 is deprecated
@@ -357 +365 @@
                 }
                 age = System.currentTimeMillis() - Long.parseLong(localPathEntry.get(0));
-                if (age < lMaxAge*1000) {
+                if (offline || age < lMaxAge*1000) {
                     return localFile;
                 }
@@ -373 +381 @@
             destDirFile.mkdirs();
         }
-        
-        String a = url.toString().replaceAll("[^A-Za-z0-9_.-]", "_");
+
+        // No local file + offline => nothing to do
+        if (offline) {
+            return null;
+        }
+
+        String a = urlStr.replaceAll("[^A-Za-z0-9_.-]", "_");
         String localPath = "mirror_" + a;
         destDirFile = new File(destDir, localPath + ".tmp");
@@ -380 +393 @@
             HttpURLConnection con = connectFollowingRedirect(url, httpAccept, ifModifiedSince);
             if (ifModifiedSince != null && con.getResponseCode() == HttpURLConnection.HTTP_NOT_MODIFIED) {
-                Main.debug("304 Not Modified ("+url+")");
-                if (localFile == null) throw new AssertionError();
-                Main.pref.putCollection(prefKey, 
+                if (Main.isDebugEnabled()) {
+                    Main.debug("304 Not Modified ("+urlStr+")");
+                }
+                if (localFile == null)
+                    throw new AssertionError();
+                Main.pref.putCollection(prefKey,
                         Arrays.asList(Long.toString(System.currentTimeMillis()), localPathEntry.get(1)));
                 return localFile;
-            } 
+            }
             try (
                 InputStream bis = new BufferedInputStream(con.getInputStream());
@@ -398 +414 @@
             }
             localFile = new File(destDir, localPath);
-            if(Main.platform.rename(destDirFile, localFile)) {
-                Main.pref.putCollection(prefKey, 
+            if (Main.platform.rename(destDirFile, localFile)) {
+                Main.pref.putCollection(prefKey,
                         Arrays.asList(Long.toString(System.currentTimeMillis()), localFile.toString()));
             } else {
@@ -407 +423 @@
         } catch (IOException e) {
             if (age >= lMaxAge*1000 && age < lMaxAge*1000*2) {
-                Main.warn(tr("Failed to load {0}, use cached file and retry next time: {1}", url, e));
+                Main.warn(tr("Failed to load {0}, use cached file and retry next time: {1}", urlStr, e));
                 return localFile;
             } else {
@@ -415 +431 @@
 
         return localFile;
+    }
+
+    private static void checkOfflineAccess(String urlString) {
+        OnlineResource.JOSM_WEBSITE.checkOfflineAccess(urlString, Main.getJOSMWebsite());
+        OnlineResource.OSM_API.checkOfflineAccess(urlString, Main.pref.get("osm-server.url", OsmApi.DEFAULT_API_URL));
     }
 
@@ -424 +445 @@
      * is going from a http to a https URL, see <a href="https://bugs.openjdk.java.net/browse/JDK-4620571">bug report</a>.
      * <p>
-     * This can causes problems when downloading from certain GitHub URLs.
+     * This can cause problems when downloading from certain GitHub URLs.
      *
      * @param downloadUrl The resource URL to download
@@ -432 +453 @@
      * @throws MalformedURLException If a redirected URL is wrong
      * @throws IOException If any I/O operation goes wrong
+     * @throws OfflineAccessException if resource is accessed in offline mode, in any protocol
      * @since 6867
      */
     public static HttpURLConnection connectFollowingRedirect(URL downloadUrl, String httpAccept, Long ifModifiedSince) throws MalformedURLException, IOException {
+        CheckParameterUtil.ensureParameterNotNull(downloadUrl, "downloadUrl");
+        String downloadString = downloadUrl.toExternalForm();
+
+        checkOfflineAccess(downloadString);
+
         HttpURLConnection con = null;
         int numRedirects = 0;
         while(true) {
             con = Utils.openHttpConnection(downloadUrl);
+            if (con == null) {
+                throw new IOException("Cannot open http connection to "+downloadString);
+            }
             if (ifModifiedSince != null) {
                 con.setIfModifiedSince(ifModifiedSince);
@@ -445 +475 @@
             con.setConnectTimeout(Main.pref.getInteger("socket.timeout.connect",15)*1000);
             con.setReadTimeout(Main.pref.getInteger("socket.timeout.read",30)*1000);
-            Main.debug("GET "+downloadUrl);
+            if (Main.isDebugEnabled()) {
+                Main.debug("GET "+downloadString);
+            }
             if (httpAccept != null) {
-                Main.debug("Accept: "+httpAccept);
+                if (Main.isTraceEnabled()) {
+                    Main.trace("Accept: "+httpAccept);
+                }
                 con.setRequestProperty("Accept", httpAccept);
             }
@@ -466 +500 @@
             case HttpURLConnection.HTTP_SEE_OTHER:
                 String redirectLocation = con.getHeaderField("Location");
-                if (downloadUrl == null) {
-                    /* I18n: argument is HTTP response code */ String msg = tr("Unexpected response from HTTP server. Got {0} response without ''Location'' header. Can''t redirect. Aborting.", con.getResponseCode());
+                if (redirectLocation == null) {
+                    /* I18n: argument is HTTP response code */
+                    String msg = tr("Unexpected response from HTTP server. Got {0} response without ''Location'' header."+
+                            " Can''t redirect. Aborting.", con.getResponseCode());
                     throw new IOException(msg);
                 }
                 downloadUrl = new URL(redirectLocation);
+                downloadString = downloadUrl.toExternalForm();
                 // keep track of redirect attempts to break a redirect loops if it happens
                 // to occur for whatever reason
@@ -478 +515 @@
                     throw new IOException(msg);
                 }
-                Main.info(tr("Download redirected to ''{0}''", downloadUrl));
+                Main.info(tr("Download redirected to ''{0}''", downloadString));
                 break;
             default:
-                String msg = tr("Failed to read from ''{0}''. Server responded with status code {1}.", downloadUrl, con.getResponseCode());
+                String msg = tr("Failed to read from ''{0}''. Server responded with status code {1}.", downloadString, con.getResponseCode());
                 throw new IOException(msg);
             }
         }
     }
-
 }