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