Changeset 16426 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2020-05-16T20:59:34+02:00 (4 years ago)

Author:

simon04

Message:

see #18712 - Add NetworkManager.isOffline(String) to test offline status of given URL

Deprecates OnlineResource.checkOfflineAccess(String, String)

Location:

trunk/src/org/openstreetmap/josm/io

Files:

• CacheCustomContent.java (modified) (1 diff)
• CachedFile.java (modified) (2 diffs)
• NetworkManager.java (modified) (1 diff)
• OnlineResource.java (modified) (2 diffs)
• OsmApi.java (modified) (1 diff)
• OsmServerReader.java (modified) (2 diffs)

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

@@ -95 +95 @@
     }
 
-    private boolean isOffline() {
-        try {
-            checkOfflineAccess();
-            return false;
-        } catch (OfflineAccessException e) {
-            Logging.trace(e);
-            return true;
-        }
-    }
-
-    /**
-     * Ensures underlying resource is not accessed in offline mode.
-     * @throws OfflineAccessException if resource is accessed in offline mode
-     */
-    protected abstract void checkOfflineAccess();
+    /**
+     * Checks underlying resource is not accessed in offline mode.
+     * @return whether resource is accessed in offline mode
+     */
+    protected abstract boolean isOffline();
 
     /**

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

@@ -435 +435 @@
         File localFile = null;
         List<String> localPathEntry = new ArrayList<>(Config.getPref().getList(prefKey));
-        boolean offline = false;
-        try {
-            checkOfflineAccess(urlStr);
-        } catch (OfflineAccessException e) {
-            Logging.trace(e);
-            offline = true;
-        }
+        boolean offline = NetworkManager.isOffline(urlStr);
         if (localPathEntry.size() == 2) {
             localFile = new File(localPathEntry.get(1));
@@ -534 +528 @@
     }
 
-    private static void checkOfflineAccess(String urlString) {
-        OnlineResource.JOSM_WEBSITE.checkOfflineAccess(urlString, Config.getUrls().getJOSMWebsite());
-        OnlineResource.OSM_API.checkOfflineAccess(urlString, OsmApi.getOsmApi().getServerUrl());
-    }
-
     private static String truncatePath(String directory, String fileName) {
         if (directory.length() + fileName.length() > 255) {

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

@@ -74 +74 @@
 
     /**
+     * Determines if the given online resource specified as URL is currently offline.
+     * @param url the online resource specified as URL
+     * @return {@code true} if {@code url} is offline and should not be accessed
+     * @since 16426
+     */
+    public static boolean isOffline(String url) {
+        return OFFLINE_RESOURCES.stream().anyMatch(r -> r.matches(url));
+    }
+
+    /**
      * Determines if the given online resource is currently offline.
      * @param r the online resource

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

@@ -3 +3 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
+
+import org.openstreetmap.josm.spi.preferences.Config;
 
 /**
@@ -37 +39 @@
 
     /**
+     * Replies whether the given URL matches this online resource
+     * @return whether the given URL matches this online resource
+     */
+    public final boolean matches(String url) {
+        final String baseUrl;
+        switch (this) {
+            case ALL:
+                return true;
+            case OSM_API:
+                baseUrl = OsmApi.getOsmApi().getServerUrl();
+                break;
+            case JOSM_WEBSITE:
+                baseUrl = Config.getUrls().getJOSMWebsite();
+                break;
+            default:
+                return false;
+        }
+        return url.startsWith(baseUrl.substring(baseUrl.indexOf("://")), url.indexOf("://"));
+    }
+
+    /**
      * Ensures resource is not accessed in offline mode.
      * @param downloadString The attempted download string
-     * @param resourceString The resource download string that should not be accessed
+     * @param ignore ignored
      * @throws OfflineAccessException if resource is accessed in offline mode, in any protocol
+     * @deprecated use {@link NetworkManager#isOffline(String)}
      */
-    public final void checkOfflineAccess(String downloadString, String resourceString) {
-        if (NetworkManager.isOffline(this) && downloadString
-                .startsWith(resourceString.substring(resourceString.indexOf("://")), downloadString.indexOf("://"))) {
+    @Deprecated
+    public final void checkOfflineAccess(String downloadString, String ignore) {
+        if (NetworkManager.isOffline(downloadString)) {
             throw new OfflineAccessException(tr("Unable to access ''{0}'': {1} not available (offline mode)", downloadString, getLocName()));
         }

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

@@ -209 +209 @@
 
         @Override
-        protected void checkOfflineAccess() {
-            OnlineResource.OSM_API.checkOfflineAccess(getBaseUrl(getServerUrlFromPref(), "0.6")+CAPABILITIES, getServerUrlFromPref());
+        protected boolean isOffline() {
+            return NetworkManager.isOffline(OnlineResource.OSM_API);
         }
 

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

@@ -20 +20 @@
 import org.openstreetmap.josm.io.auth.CredentialsAgentException;
 import org.openstreetmap.josm.io.auth.CredentialsManager;
-import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.HttpClient;
 import org.openstreetmap.josm.tools.Logging;
@@ -158 +157 @@
             boolean uncompressAccordingToContentDisposition, String httpMethod, byte[] requestBody) throws OsmTransferException {
         try {
-            OnlineResource.JOSM_WEBSITE.checkOfflineAccess(urlStr, Config.getUrls().getJOSMWebsite());
-            OnlineResource.OSM_API.checkOfflineAccess(urlStr, OsmApi.getOsmApi().getServerUrl());
+            if (NetworkManager.isOffline(urlStr)) {
+                throw new OsmApiException(new OfflineAccessException(tr("{0} not available (offline mode)", urlStr)));
+            }
 
             URL url = null;