001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.io.importexport;
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.gui.MainApplication;
018import org.openstreetmap.josm.gui.layer.OsmDataLayer;
019import org.openstreetmap.josm.gui.progress.ProgressMonitor;
020import org.openstreetmap.josm.gui.util.GuiHelper;
021import org.openstreetmap.josm.io.Compression;
022import org.openstreetmap.josm.io.IllegalDataException;
023import org.openstreetmap.josm.io.OsmReader;
024import org.openstreetmap.josm.tools.Logging;
025
026/**
027 * File importer that reads *.osm data files. (main storage format for OSM data in JOSM)
028 */
029public class OsmImporter extends FileImporter {
030
031    /**
032     * The OSM file filter (*.osm and *.xml files).
033     */
034    public static final ExtensionFileFilter FILE_FILTER = ExtensionFileFilter.newFilterWithArchiveExtensions(
035            "osm,xml", "osm", tr("OSM Server Files") + " (*.osm, *.osm.gz, *.osm.bz2, *.osm.xz, *.osm.zip, *.xml)",
036            ExtensionFileFilter.AddArchiveExtension.NONE, Arrays.asList("gz", "bz", "bz2", "xz", "zip"));
037
038    /**
039     * Utility class containing imported OSM layer, and a task to run after it is added to MapView.
040     */
041    public static class OsmImporterData {
042
043        private final OsmDataLayer layer;
044        private final Runnable postLayerTask;
045
046        public OsmImporterData(OsmDataLayer layer, Runnable postLayerTask) {
047            this.layer = layer;
048            this.postLayerTask = postLayerTask;
049        }
050
051        public OsmDataLayer getLayer() {
052            return layer;
053        }
054
055        public Runnable getPostLayerTask() {
056            return postLayerTask;
057        }
058    }
059
060    /**
061     * Constructs a new {@code OsmImporter}.
062     */
063    public OsmImporter() {
064        super(FILE_FILTER);
065    }
066
067    /**
068     * Constructs a new {@code OsmImporter} with the given extension file filter.
069     * @param filter The extension file filter
070     */
071    public OsmImporter(ExtensionFileFilter filter) {
072        super(filter);
073    }
074
075    /**
076     * Imports OSM data from file
077     * @param file file to read data from
078     * @param progressMonitor handler for progress monitoring and canceling
079     */
080    @Override
081    public void importData(File file, ProgressMonitor progressMonitor) throws IOException, IllegalDataException {
082        try (InputStream in = Compression.getUncompressedFileInputStream(file)) {
083            importData(in, file, progressMonitor);
084        } catch (FileNotFoundException e) {
085            Logging.error(e);
086            throw new IOException(tr("File ''{0}'' does not exist.", file.getName()), e);
087        }
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     * @throws IllegalDataException if an error was found while parsing the OSM data
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(() -> {
103            OsmDataLayer layer = data.getLayer();
104            MainApplication.getLayerManager().addLayer(layer);
105            data.getPostLayerTask().run();
106            data.getLayer().onPostLoadFromFile();
107        });
108    }
109
110    /**
111     * Load osm data layer from InputStream.
112     * @param in input stream
113     * @param associatedFile filename of data (can be <code>null</code> if the stream does not come from a file)
114     * @param layerName name of generated layer
115     * @param progressMonitor handler for progress monitoring and canceling
116     * @return Utility class containing imported OSM layer, and a task to run after it is added to MapView
117     * @throws IllegalDataException if an error was found while parsing the OSM data
118     */
119    public OsmImporterData loadLayer(InputStream in, final File associatedFile, final String layerName, ProgressMonitor progressMonitor)
120            throws IllegalDataException {
121        final DataSet dataSet = parseDataSet(in, progressMonitor);
122        if (dataSet == null) {
123            throw new IllegalDataException(tr("Invalid dataset"));
124        }
125        OsmDataLayer layer = createLayer(dataSet, associatedFile, layerName);
126        Runnable postLayerTask = createPostLayerTask(dataSet, associatedFile, layerName, layer);
127        return new OsmImporterData(layer, postLayerTask);
128    }
129
130    protected DataSet parseDataSet(InputStream in, ProgressMonitor progressMonitor) throws IllegalDataException {
131        return OsmReader.parseDataSet(in, progressMonitor);
132    }
133
134    protected OsmDataLayer createLayer(final DataSet dataSet, final File associatedFile, final String layerName) {
135        return new OsmDataLayer(dataSet, layerName, associatedFile);
136    }
137
138    protected Runnable createPostLayerTask(final DataSet dataSet, final File associatedFile, final String layerName, final OsmDataLayer layer) {
139        return () -> {
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}