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