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