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.IOException;
008import java.io.InputStream;
009
010import javax.swing.JOptionPane;
011import javax.swing.SwingUtilities;
012
013import org.openstreetmap.josm.Main;
014import org.openstreetmap.josm.actions.ExtensionFileFilter;
015import org.openstreetmap.josm.gui.HelpAwareOptionPane;
016import org.openstreetmap.josm.gui.Notification;
017import org.openstreetmap.josm.gui.layer.GpxLayer;
018import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
019import org.openstreetmap.josm.gui.progress.ProgressMonitor;
020import org.openstreetmap.josm.gui.util.GuiHelper;
021import org.openstreetmap.josm.io.GpxImporter.GpxImporterData;
022
023/**
024 * File importer allowing to import NMEA-0183 files (*.nmea/nme/nma/log/txt files).
025 * @since 1637
026 */
027public class NMEAImporter extends FileImporter {
028
029    /**
030     * The NMEA file filter (*.nmea *.nme *.nma *.log *.txt files).
031     */
032    public static final ExtensionFileFilter FILE_FILTER = ExtensionFileFilter.newFilterWithArchiveExtensions(
033            "nmea,nme,nma,log,txt", "nmea", tr("NMEA-0183 Files"), false);
034
035    /**
036     * Constructs a new {@code NMEAImporter}.
037     */
038    public NMEAImporter() {
039        super(FILE_FILTER);
040    }
041
042    @Override
043    public void importData(File file, ProgressMonitor progressMonitor) throws IOException {
044        final String fn = file.getName();
045        try (InputStream fis = Compression.getUncompressedFileInputStream(file)) {
046            final NmeaReader r = new NmeaReader(fis);
047            if (r.getNumberOfCoordinates() > 0) {
048                r.data.storageFile = file;
049                final GpxLayer gpxLayer = new GpxLayer(r.data, fn, true);
050                final File fileFinal = file;
051
052                GuiHelper.runInEDT(() -> {
053                    Main.getLayerManager().addLayer(gpxLayer);
054                    if (Main.pref.getBoolean("marker.makeautomarkers", true)) {
055                        MarkerLayer ml = new MarkerLayer(r.data, tr("Markers from {0}", fn), fileFinal, gpxLayer);
056                        if (!ml.data.isEmpty()) {
057                            Main.getLayerManager().addLayer(ml);
058                        }
059                    }
060                });
061            }
062            showNmeaInfobox(r.getNumberOfCoordinates() > 0, r);
063        }
064    }
065
066    private static void showNmeaInfobox(boolean success, NmeaReader r) {
067        final StringBuilder msg = new StringBuilder(160).append("<html>")
068           .append(tr("Coordinates imported: {0}", r.getNumberOfCoordinates())).append("<br>")
069           .append(tr("Malformed sentences: {0}", r.getParserMalformed())).append("<br>")
070           .append(tr("Checksum errors: {0}", r.getParserChecksumErrors())).append("<br>");
071        if (!success) {
072            msg.append(tr("Unknown sentences: {0}", r.getParserUnknown())).append("<br>");
073        }
074        msg.append(tr("Zero coordinates: {0}", r.getParserZeroCoordinates()))
075           .append("</html>");
076        if (success) {
077            SwingUtilities.invokeLater(() -> new Notification(
078                    "<h3>" + tr("NMEA import success:") + "</h3>" + msg.toString())
079                    .setIcon(JOptionPane.INFORMATION_MESSAGE)
080                    .show());
081        } else {
082            HelpAwareOptionPane.showMessageDialogInEDT(
083                    Main.parent,
084                    msg.toString(),
085                    tr("NMEA import failure!"),
086                    JOptionPane.ERROR_MESSAGE, null);
087        }
088    }
089
090    public static GpxImporterData loadLayers(InputStream is, final File associatedFile,
091            final String gpxLayerName, String markerLayerName) throws IOException {
092        final NmeaReader r = new NmeaReader(is);
093        final boolean parsedProperly = r.getNumberOfCoordinates() > 0;
094        r.data.storageFile = associatedFile;
095        return GpxImporter.loadLayers(r.data, parsedProperly, gpxLayerName, markerLayerName);
096    }
097}