Index: trunk/src/org/openstreetmap/josm/data/Preferences.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/Preferences.java (revision 9779) +++ trunk/src/org/openstreetmap/josm/data/Preferences.java (revision 9780) @@ -8,9 +8,7 @@ import java.awt.GraphicsEnvironment; import java.awt.Toolkit; -import java.io.BufferedReader; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; -import java.io.InputStream; import java.io.OutputStreamWriter; import java.io.PrintWriter; @@ -22,5 +20,4 @@ import java.lang.reflect.Field; import java.nio.charset.StandardCharsets; -import java.nio.file.Files; import java.util.ArrayList; import java.util.Collection; @@ -53,13 +50,5 @@ import javax.json.JsonWriter; import javax.swing.JOptionPane; -import javax.xml.XMLConstants; -import javax.xml.stream.XMLInputFactory; -import javax.xml.stream.XMLStreamConstants; import javax.xml.stream.XMLStreamException; -import javax.xml.stream.XMLStreamReader; -import javax.xml.transform.stream.StreamSource; -import javax.xml.validation.Schema; -import javax.xml.validation.SchemaFactory; -import javax.xml.validation.Validator; import org.openstreetmap.josm.Main; @@ -68,8 +57,8 @@ import org.openstreetmap.josm.data.preferences.ListSetting; import org.openstreetmap.josm.data.preferences.MapListSetting; +import org.openstreetmap.josm.data.preferences.PreferencesReader; import org.openstreetmap.josm.data.preferences.Setting; import org.openstreetmap.josm.data.preferences.SettingVisitor; import org.openstreetmap.josm.data.preferences.StringSetting; -import org.openstreetmap.josm.io.CachedFile; import org.openstreetmap.josm.io.OfflineAccessException; import org.openstreetmap.josm.io.OnlineResource; @@ -121,9 +110,4 @@ /** - * Version of the loaded data file, required for updates - */ - private int loadedVersion = 0; - - /** * Internal storage for the cache directory. */ @@ -524,5 +508,5 @@ try (PrintWriter out = new PrintWriter(new OutputStreamWriter( new FileOutputStream(prefFile + "_tmp"), StandardCharsets.UTF_8), false)) { - out.print(toXML(false)); + out.print(toXML(settingsMap, false)); } @@ -560,14 +544,19 @@ */ protected void load() throws IOException, SAXException, XMLStreamException { + File pref = getPreferenceFile(); + PreferencesReader.validateXML(pref); + PreferencesReader reader = new PreferencesReader(); + reader.fromXML(pref); settingsMap.clear(); - File pref = getPreferenceFile(); - try (BufferedReader in = Files.newBufferedReader(pref.toPath(), StandardCharsets.UTF_8)) { - validateXML(in); - } - try (BufferedReader in = Files.newBufferedReader(pref.toPath(), StandardCharsets.UTF_8)) { - fromXML(in); - } + settingsMap.putAll(reader.getSettings()); updateSystemProperties(); - removeObsolete(); + removeObsolete(reader.getVersion()); + } + + public void fromXML(Reader in) throws XMLStreamException { + PreferencesReader reader = new PreferencesReader(); + reader.fromXML(in); + settingsMap.clear(); + settingsMap.putAll(reader.getSettings()); } @@ -1336,174 +1325,5 @@ } - protected XMLStreamReader parser; - - public static void validateXML(Reader in) throws IOException, SAXException { - try (InputStream xsdStream = new CachedFile("resource://data/preferences.xsd").getInputStream()) { - Schema schema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(new StreamSource(xsdStream)); - Validator validator = schema.newValidator(); - validator.validate(new StreamSource(in)); - } - } - - protected void fromXML(Reader in) throws XMLStreamException { - this.parser = XMLInputFactory.newInstance().createXMLStreamReader(in); - parse(); - } - - private void parse() throws XMLStreamException { - int event = parser.getEventType(); - while (true) { - if (event == XMLStreamConstants.START_ELEMENT) { - try { - loadedVersion = Integer.parseInt(parser.getAttributeValue(null, "version")); - } catch (NumberFormatException e) { - if (Main.isDebugEnabled()) { - Main.debug(e.getMessage()); - } - } - parseRoot(); - } else if (event == XMLStreamConstants.END_ELEMENT) { - return; - } - if (parser.hasNext()) { - event = parser.next(); - } else { - break; - } - } - parser.close(); - } - - private void parseRoot() throws XMLStreamException { - while (true) { - int event = parser.next(); - if (event == XMLStreamConstants.START_ELEMENT) { - String localName = parser.getLocalName(); - switch(localName) { - case "tag": - settingsMap.put(parser.getAttributeValue(null, "key"), new StringSetting(parser.getAttributeValue(null, "value"))); - jumpToEnd(); - break; - case "list": - case "collection": - case "lists": - case "maps": - parseToplevelList(); - break; - default: - throwException("Unexpected element: "+localName); - } - } else if (event == XMLStreamConstants.END_ELEMENT) { - return; - } - } - } - - private void jumpToEnd() throws XMLStreamException { - while (true) { - int event = parser.next(); - if (event == XMLStreamConstants.START_ELEMENT) { - jumpToEnd(); - } else if (event == XMLStreamConstants.END_ELEMENT) { - return; - } - } - } - - private void parseToplevelList() throws XMLStreamException { - String key = parser.getAttributeValue(null, "key"); - String name = parser.getLocalName(); - - List entries = null; - List> lists = null; - List> maps = null; - while (true) { - int event = parser.next(); - if (event == XMLStreamConstants.START_ELEMENT) { - String localName = parser.getLocalName(); - switch(localName) { - case "entry": - if (entries == null) { - entries = new ArrayList<>(); - } - entries.add(parser.getAttributeValue(null, "value")); - jumpToEnd(); - break; - case "list": - if (lists == null) { - lists = new ArrayList<>(); - } - lists.add(parseInnerList()); - break; - case "map": - if (maps == null) { - maps = new ArrayList<>(); - } - maps.add(parseMap()); - break; - default: - throwException("Unexpected element: "+localName); - } - } else if (event == XMLStreamConstants.END_ELEMENT) { - break; - } - } - if (entries != null) { - settingsMap.put(key, new ListSetting(Collections.unmodifiableList(entries))); - } else if (lists != null) { - settingsMap.put(key, new ListListSetting(Collections.unmodifiableList(lists))); - } else if (maps != null) { - settingsMap.put(key, new MapListSetting(Collections.unmodifiableList(maps))); - } else { - if ("lists".equals(name)) { - settingsMap.put(key, new ListListSetting(Collections.>emptyList())); - } else if ("maps".equals(name)) { - settingsMap.put(key, new MapListSetting(Collections.>emptyList())); - } else { - settingsMap.put(key, new ListSetting(Collections.emptyList())); - } - } - } - - private List parseInnerList() throws XMLStreamException { - List entries = new ArrayList<>(); - while (true) { - int event = parser.next(); - if (event == XMLStreamConstants.START_ELEMENT) { - if ("entry".equals(parser.getLocalName())) { - entries.add(parser.getAttributeValue(null, "value")); - jumpToEnd(); - } else { - throwException("Unexpected element: "+parser.getLocalName()); - } - } else if (event == XMLStreamConstants.END_ELEMENT) { - break; - } - } - return Collections.unmodifiableList(entries); - } - - private Map parseMap() throws XMLStreamException { - Map map = new LinkedHashMap<>(); - while (true) { - int event = parser.next(); - if (event == XMLStreamConstants.START_ELEMENT) { - if ("tag".equals(parser.getLocalName())) { - map.put(parser.getAttributeValue(null, "key"), parser.getAttributeValue(null, "value")); - jumpToEnd(); - } else { - throwException("Unexpected element: "+parser.getLocalName()); - } - } else if (event == XMLStreamConstants.END_ELEMENT) { - break; - } - } - return Collections.unmodifiableMap(map); - } - - protected void throwException(String msg) { - throw new RuntimeException(msg + tr(" (at line {0}, column {1})", - parser.getLocation().getLineNumber(), parser.getLocation().getColumnNumber())); - } + private class SettingToXml implements SettingVisitor { @@ -1579,4 +1399,8 @@ public String toXML(boolean nopass) { + return toXML(settingsMap, nopass); + } + + public String toXML(Map> settings, boolean nopass) { StringBuilder b = new StringBuilder( "\n\n"); SettingToXml toXml = new SettingToXml(b, nopass); - for (Entry> e : settingsMap.entrySet()) { + for (Entry> e : settings.entrySet()) { toXml.setKey(e.getKey()); e.getValue().visit(toXml); @@ -1597,5 +1421,5 @@ * see something with an expiry date in the past, remove it from the list. */ - public void removeObsolete() { + private void removeObsolete(int loadedVersion) { // drop this block march 2016 // update old style JOSM server links to use zip now, see #10581, #12189 Index: trunk/src/org/openstreetmap/josm/data/preferences/PreferencesReader.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/preferences/PreferencesReader.java (revision 9780) +++ trunk/src/org/openstreetmap/josm/data/preferences/PreferencesReader.java (revision 9780) @@ -0,0 +1,263 @@ +// License: GPL. For details, see LICENSE file. +package org.openstreetmap.josm.data.preferences; + +import static org.openstreetmap.josm.tools.I18n.tr; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.Reader; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.util.ArrayList; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.SortedMap; +import java.util.TreeMap; +import javax.xml.XMLConstants; +import javax.xml.stream.XMLInputFactory; +import javax.xml.stream.XMLStreamConstants; +import javax.xml.stream.XMLStreamException; +import javax.xml.stream.XMLStreamReader; +import javax.xml.transform.stream.StreamSource; +import javax.xml.validation.Schema; +import javax.xml.validation.SchemaFactory; +import javax.xml.validation.Validator; + +import org.openstreetmap.josm.Main; +import org.openstreetmap.josm.io.CachedFile; +import org.xml.sax.SAXException; + +/** + * Loads preferences from XML. + */ +public class PreferencesReader { + + private final SortedMap> settings = new TreeMap<>(); + private int version = 0; + private XMLStreamReader parser; + + /** + * Validate the XML. + * @param f the file + * @throws java.io.IOException + * @throws org.xml.sax.SAXException + */ + public static void validateXML(File f) throws IOException, SAXException { + try (BufferedReader in = Files.newBufferedReader(f.toPath(), StandardCharsets.UTF_8)) { + validateXML(in); + } + } + + /** + * Validate the XML. + * @param in the {@link Reader} + * @throws java.io.IOException + * @throws org.xml.sax.SAXException + */ + public static void validateXML(Reader in) throws IOException, SAXException { + try (InputStream xsdStream = new CachedFile("resource://data/preferences.xsd").getInputStream()) { + Schema schema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(new StreamSource(xsdStream)); + Validator validator = schema.newValidator(); + validator.validate(new StreamSource(in)); + } + } + + /** + * Parse preferences XML. + * @param f the file + * @throws IOException + * @throws XMLStreamException + */ + public void fromXML(File f) throws IOException, XMLStreamException { + try (BufferedReader in = Files.newBufferedReader(f.toPath(), StandardCharsets.UTF_8)) { + fromXML(in); + } + } + + /** + * Parse preferences XML. + * @param in the {@link Reader} + * @throws XMLStreamException + */ + public void fromXML(Reader in) throws XMLStreamException { + this.parser = XMLInputFactory.newInstance().createXMLStreamReader(in); + parse(); + } + + /** + * Return the parsed preferences as a settings map + * @return the parsed preferences as a settings map + */ + public SortedMap> getSettings() { + return settings; + } + + /** + * Return the version from the XML root element. + * (Represents the JOSM version when the file was written.) + * @return the version + */ + public int getVersion() { + return version; + } + + private void parse() throws XMLStreamException { + int event = parser.getEventType(); + while (true) { + if (event == XMLStreamConstants.START_ELEMENT) { + try { + version = Integer.parseInt(parser.getAttributeValue(null, "version")); + } catch (NumberFormatException e) { + if (Main.isDebugEnabled()) { + Main.debug(e.getMessage()); + } + } + parseRoot(); + } else if (event == XMLStreamConstants.END_ELEMENT) { + return; + } + if (parser.hasNext()) { + event = parser.next(); + } else { + break; + } + } + parser.close(); + } + + private void parseRoot() throws XMLStreamException { + while (true) { + int event = parser.next(); + if (event == XMLStreamConstants.START_ELEMENT) { + String localName = parser.getLocalName(); + switch(localName) { + case "tag": + settings.put(parser.getAttributeValue(null, "key"), new StringSetting(parser.getAttributeValue(null, "value"))); + jumpToEnd(); + break; + case "list": + case "collection": + case "lists": + case "maps": + parseToplevelList(); + break; + default: + throwException("Unexpected element: "+localName); + } + } else if (event == XMLStreamConstants.END_ELEMENT) { + return; + } + } + } + + private void jumpToEnd() throws XMLStreamException { + while (true) { + int event = parser.next(); + if (event == XMLStreamConstants.START_ELEMENT) { + jumpToEnd(); + } else if (event == XMLStreamConstants.END_ELEMENT) { + return; + } + } + } + + private void parseToplevelList() throws XMLStreamException { + String key = parser.getAttributeValue(null, "key"); + String name = parser.getLocalName(); + + List entries = null; + List> lists = null; + List> maps = null; + while (true) { + int event = parser.next(); + if (event == XMLStreamConstants.START_ELEMENT) { + String localName = parser.getLocalName(); + switch(localName) { + case "entry": + if (entries == null) { + entries = new ArrayList<>(); + } + entries.add(parser.getAttributeValue(null, "value")); + jumpToEnd(); + break; + case "list": + if (lists == null) { + lists = new ArrayList<>(); + } + lists.add(parseInnerList()); + break; + case "map": + if (maps == null) { + maps = new ArrayList<>(); + } + maps.add(parseMap()); + break; + default: + throwException("Unexpected element: "+localName); + } + } else if (event == XMLStreamConstants.END_ELEMENT) { + break; + } + } + if (entries != null) { + settings.put(key, new ListSetting(Collections.unmodifiableList(entries))); + } else if (lists != null) { + settings.put(key, new ListListSetting(Collections.unmodifiableList(lists))); + } else if (maps != null) { + settings.put(key, new MapListSetting(Collections.unmodifiableList(maps))); + } else { + if ("lists".equals(name)) { + settings.put(key, new ListListSetting(Collections.>emptyList())); + } else if ("maps".equals(name)) { + settings.put(key, new MapListSetting(Collections.>emptyList())); + } else { + settings.put(key, new ListSetting(Collections.emptyList())); + } + } + } + + private List parseInnerList() throws XMLStreamException { + List entries = new ArrayList<>(); + while (true) { + int event = parser.next(); + if (event == XMLStreamConstants.START_ELEMENT) { + if ("entry".equals(parser.getLocalName())) { + entries.add(parser.getAttributeValue(null, "value")); + jumpToEnd(); + } else { + throwException("Unexpected element: "+parser.getLocalName()); + } + } else if (event == XMLStreamConstants.END_ELEMENT) { + break; + } + } + return Collections.unmodifiableList(entries); + } + + private Map parseMap() throws XMLStreamException { + Map map = new LinkedHashMap<>(); + while (true) { + int event = parser.next(); + if (event == XMLStreamConstants.START_ELEMENT) { + if ("tag".equals(parser.getLocalName())) { + map.put(parser.getAttributeValue(null, "key"), parser.getAttributeValue(null, "value")); + jumpToEnd(); + } else { + throwException("Unexpected element: "+parser.getLocalName()); + } + } else if (event == XMLStreamConstants.END_ELEMENT) { + break; + } + } + return Collections.unmodifiableMap(map); + } + + private void throwException(String msg) { + throw new RuntimeException(msg + tr(" (at line {0}, column {1})", + parser.getLocation().getLineNumber(), parser.getLocation().getColumnNumber())); + } +}