Changeset 9965 in josm for trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java

Timestamp:

2016-03-12T00:10:24+01:00 (9 years ago)

Author:

Don-vip

Message:

fix #12282 - drop XML mappaint support - keep XML detection in order to warn users and let them upgrade to MapCSS, with link to documentation

File:

• trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java

@@ -18 +18 @@
 
 import javax.swing.ImageIcon;
+import javax.swing.JOptionPane;
 import javax.swing.SwingUtilities;
 
@@ -25 +26 @@
 import org.openstreetmap.josm.data.osm.Node;
 import org.openstreetmap.josm.data.osm.Tag;
+import org.openstreetmap.josm.gui.HelpAwareOptionPane;
 import org.openstreetmap.josm.gui.PleaseWaitRunnable;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleSource;
 import org.openstreetmap.josm.gui.mappaint.styleelement.MapImage;
 import org.openstreetmap.josm.gui.mappaint.styleelement.NodeElement;
 import org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement;
-import org.openstreetmap.josm.gui.mappaint.xml.XmlStyleSource;
 import org.openstreetmap.josm.gui.preferences.SourceEntry;
 import org.openstreetmap.josm.gui.preferences.map.MapPaintPreference.MapPaintPrefHelper;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.io.CachedFile;
+import org.openstreetmap.josm.io.IllegalDataException;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.Utils;
@@ -46 +49 @@
  */
 public final class MapPaintStyles {
+
+    /** To remove in November 2016 */
+    private static final String XML_STYLE_MIME_TYPES =
+             "application/xml, text/xml, text/plain; q=0.8, application/zip, application/octet-stream; q=0.5";
 
     private static ElemStyles styles = new ElemStyles();
@@ -280 +287 @@
 
     private static StyleSource fromSourceEntry(SourceEntry entry) {
-        CachedFile cf = null;
-        try {
-            Set<String> mimes = new HashSet<>();
-            mimes.addAll(Arrays.asList(XmlStyleSource.XML_STYLE_MIME_TYPES.split(", ")));
-            mimes.addAll(Arrays.asList(MapCSSStyleSource.MAPCSS_STYLE_MIME_TYPES.split(", ")));
-            cf = new CachedFile(entry.url).setHttpAccept(Utils.join(", ", mimes));
+        // TODO: Method to clean up in November 2016: remove XML detection completely
+        Set<String> mimes = new HashSet<>(Arrays.asList(MapCSSStyleSource.MAPCSS_STYLE_MIME_TYPES.split(", ")));
+        mimes.addAll(Arrays.asList(XML_STYLE_MIME_TYPES.split(", ")));
+        try (CachedFile cf = new CachedFile(entry.url).setHttpAccept(Utils.join(", ", mimes))) {
             String zipEntryPath = cf.findZipEntryPath("mapcss", "style");
             if (zipEntryPath != null) {
@@ -293 +298 @@
             }
             zipEntryPath = cf.findZipEntryPath("xml", "style");
-            if (zipEntryPath != null)
-                return new XmlStyleSource(entry);
+            if (zipEntryPath != null || Utils.hasExtension(entry.url, "xml"))
+                throw new IllegalDataException("XML style");
             if (Utils.hasExtension(entry.url, "mapcss"))
                 return new MapCSSStyleSource(entry);
-            if (Utils.hasExtension(entry.url, "xml"))
-                return new XmlStyleSource(entry);
-            else {
-                try (InputStreamReader reader = new InputStreamReader(cf.getInputStream(), StandardCharsets.UTF_8)) {
-                    WHILE: while (true) {
-                        int c = reader.read();
-                        switch (c) {
-                            case -1:
-                                break WHILE;
-                            case ' ':
-                            case '\t':
-                            case '\n':
-                            case '\r':
-                                continue;
-                            case '<':
-                                return new XmlStyleSource(entry);
-                            default:
-                                return new MapCSSStyleSource(entry);
-                        }
+            try (InputStreamReader reader = new InputStreamReader(cf.getInputStream(), StandardCharsets.UTF_8)) {
+                WHILE: while (true) {
+                    int c = reader.read();
+                    switch (c) {
+                        case -1:
+                            break WHILE;
+                        case ' ':
+                        case '\t':
+                        case '\n':
+                        case '\r':
+                            continue;
+                        case '<':
+                            throw new IllegalDataException("XML style");
+                        default:
+                            return new MapCSSStyleSource(entry);
                     }
                 }
-                Main.warn("Could not detect style type. Using default (xml).");
-                return new XmlStyleSource(entry);
-            }
+            }
+            Main.warn("Could not detect style type. Using default (mapcss).");
+            return new MapCSSStyleSource(entry);
         } catch (IOException e) {
             Main.warn(tr("Failed to load Mappaint styles from ''{0}''. Exception was: {1}", entry.url, e.toString()));
             Main.error(e);
-        } finally {
-            if (cf != null) {
-                cf.close();
-            }
+        } catch (IllegalDataException e) {
+            String msg = tr("JOSM does no longer support mappaint styles written in the old XML format.\nPlease update ''{0}'' to MapCSS",
+                    entry.url);
+            Main.error(msg);
+            HelpAwareOptionPane.showOptionDialog(Main.parent, msg, tr("Warning"), JOptionPane.WARNING_MESSAGE,
+                    HelpUtil.ht("/Styles/MapCSSImplementation"));
         }
         return null;