001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.io;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.io.File;
007import java.io.FileNotFoundException;
008import java.io.IOException;
009import java.io.InputStream;
010import java.util.Arrays;
011
012import javax.swing.JOptionPane;
013
014import org.openstreetmap.josm.Main;
015import org.openstreetmap.josm.actions.ExtensionFileFilter;
016import org.openstreetmap.josm.data.osm.DataSet;
017import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
018import org.openstreetmap.josm.gui.layer.OsmDataLayer;
019import org.openstreetmap.josm.gui.progress.ProgressMonitor;
020import org.openstreetmap.josm.gui.util.GuiHelper;
021
022public class OsmImporter extends FileImporter {
023
024    /**
025     * The OSM file filter (*.osm and *.xml files).
026     */
027    public static final ExtensionFileFilter FILE_FILTER = ExtensionFileFilter.newFilterWithArchiveExtensions(
028            "osm,xml", "osm", tr("OSM Server Files") + " (*.osm, *.osm.gz, *.osm.bz2, *.osm.zip, *.xml)",
029            ExtensionFileFilter.AddArchiveExtension.NONE, Arrays.asList("gz", "bz", "bz2", "zip"));
030
031    /**
032     * Utility class containing imported OSM layer, and a task to run after it is added to MapView.
033     */
034    public static class OsmImporterData {
035
036        private final OsmDataLayer layer;
037        private final Runnable postLayerTask;
038
039        public OsmImporterData(OsmDataLayer layer, Runnable postLayerTask) {
040            this.layer = layer;
041            this.postLayerTask = postLayerTask;
042        }
043
044        public OsmDataLayer getLayer() {
045            return layer;
046        }
047
048        public Runnable getPostLayerTask() {
049            return postLayerTask;
050        }
051    }
052
053    /**
054     * Constructs a new {@code OsmImporter}.
055     */
056    public OsmImporter() {
057        super(FILE_FILTER);
058    }
059
060    /**
061     * Constructs a new {@code OsmImporter} with the given extension file filter.
062     * @param filter The extension file filter
063     */
064    public OsmImporter(ExtensionFileFilter filter) {
065        super(filter);
066    }
067
068    /**
069     * Imports OSM data from file
070     * @param file file to read data from
071     * @param progressMonitor handler for progress monitoring and canceling
072     */
073    @Override
074    public void importData(File file, ProgressMonitor progressMonitor) throws IOException, IllegalDataException {
075        try (InputStream in = Compression.getUncompressedFileInputStream(file)) {
076            importData(in, file, progressMonitor);
077        } catch (FileNotFoundException e) {
078            Main.error(e);
079            throw new IOException(tr("File ''{0}'' does not exist.", file.getName()), e);
080        }
081    }
082
083    /**
084     * Imports OSM data from stream
085     * @param in input stream
086     * @param associatedFile filename of data (layer name will be generated from name of file)
087     * @param pm handler for progress monitoring and canceling
088     * @throws IllegalDataException if an error was found while parsing the OSM data
089     */
090    protected void importData(InputStream in, final File associatedFile, ProgressMonitor pm) throws IllegalDataException {
091        final OsmImporterData data = loadLayer(in, associatedFile,
092                associatedFile == null ? OsmDataLayer.createNewName() : associatedFile.getName(), pm);
093
094        // FIXME: remove UI stuff from IO subsystem
095        GuiHelper.runInEDT(new Runnable() {
096            @Override
097            public void run() {
098                OsmDataLayer layer = data.getLayer();
099                BoundingXYVisitor v = new BoundingXYVisitor();
100                v.visit(layer.data.getDataSourceBoundingBox());
101                if (!v.hasExtend()) {
102                    v.computeBoundingBox(layer.data.getNodes());
103                }
104                Main.main.addLayer(layer, v.getBounds());
105                data.getPostLayerTask().run();
106                data.getLayer().onPostLoadFromFile();
107            }
108        });
109    }
110
111    /**
112     * Load osm data layer from InputStream.
113     * @param in input stream
114     * @param associatedFile filename of data (can be <code>null</code> if the stream does not come from a file)
115     * @param layerName name of generated layer
116     * @param progressMonitor handler for progress monitoring and canceling
117     * @return Utility class containing imported OSM layer, and a task to run after it is added to MapView
118     * @throws IllegalDataException if an error was found while parsing the OSM data
119     */
120    public OsmImporterData loadLayer(InputStream in, final File associatedFile, final String layerName, ProgressMonitor progressMonitor)
121            throws IllegalDataException {
122        final DataSet dataSet = parseDataSet(in, progressMonitor);
123        if (dataSet == null) {
124            throw new IllegalDataException(tr("Invalid dataset"));
125        }
126        OsmDataLayer layer = createLayer(dataSet, associatedFile, layerName);
127        Runnable postLayerTask = createPostLayerTask(dataSet, associatedFile, layerName, layer);
128        return new OsmImporterData(layer, postLayerTask);
129    }
130
131    protected DataSet parseDataSet(InputStream in, ProgressMonitor progressMonitor) throws IllegalDataException {
132        return OsmReader.parseDataSet(in, progressMonitor);
133    }
134
135    protected OsmDataLayer createLayer(final DataSet dataSet, final File associatedFile, final String layerName) {
136        return new OsmDataLayer(dataSet, layerName, associatedFile);
137    }
138
139    protected Runnable createPostLayerTask(final DataSet dataSet, final File associatedFile, final String layerName, final OsmDataLayer layer) {
140        return new Runnable() {
141            @Override
142            public void run() {
143                if (dataSet.allPrimitives().isEmpty()) {
144                    String msg;
145                    if (associatedFile == null) {
146                        msg = tr("No data found for layer ''{0}''.", layerName);
147                    } else {
148                        msg = tr("No data found in file ''{0}''.", associatedFile.getPath());
149                    }
150                    JOptionPane.showMessageDialog(
151                            Main.parent,
152                            msg,
153                            tr("Open OSM file"),
154                            JOptionPane.INFORMATION_MESSAGE);
155                }
156                layer.onPostLoadFromFile();
157            }
158        };
159    }
160}