Cleanup: extracted SAX2 import from AbstractFileTrackImporter.

src/androidTest/java/de/dennisguse/opentracks/io/file/importer/ExportImportTest.java

@@ -154,7 +154,7 @@ public class ExportImportTest {
 
         // 2. import
         InputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
-        AbstractFileTrackImporter trackImporter = new KmlFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new KmlFileTrackImporter(context));
         importTrackId = trackImporter.importFile(inputStream).get(0);
 
         // then
@@ -195,7 +195,7 @@ public class ExportImportTest {
 
         // 2. import
         InputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
-        AbstractFileTrackImporter trackImporter = new KmlFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new KmlFileTrackImporter(context));
         importTrackId = trackImporter.importFile(inputStream).get(0);
 
         // then
@@ -237,7 +237,7 @@ public class ExportImportTest {
 
         // 2. import
         InputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
-        AbstractFileTrackImporter trackImporter = new KmlFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new KmlFileTrackImporter(context));
         importTrackId = trackImporter.importFile(inputStream).get(0);
 
         // then
@@ -263,7 +263,7 @@ public class ExportImportTest {
 
         // 2. import
         InputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
-        AbstractFileTrackImporter trackImporter = new GpxFileTrackImporter(context, contentProviderUtils);
+        XMLImporter trackImporter = new XMLImporter(new GpxFileTrackImporter(context, contentProviderUtils));
         importTrackId = trackImporter.importFile(inputStream).get(0);
 
         // then
@@ -313,7 +313,7 @@ public class ExportImportTest {
 
         // 2. import
         InputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
-        AbstractFileTrackImporter trackImporter = new GpxFileTrackImporter(context, contentProviderUtils);
+        XMLImporter trackImporter = new XMLImporter(new GpxFileTrackImporter(context, contentProviderUtils));
         importTrackId = trackImporter.importFile(inputStream).get(0);
 
         // then

src/androidTest/java/de/dennisguse/opentracks/io/file/importer/LegacyImportTest.java

@@ -50,7 +50,7 @@ public class LegacyImportTest {
     @Test
     public void kml_with_statistics_marker() {
         // given
-        KmlFileTrackImporter trackImporter = new KmlFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new KmlFileTrackImporter(context));
         InputStream inputStream = InstrumentationRegistry.getInstrumentation().getContext().getResources().openRawResource(de.dennisguse.opentracks.debug.test.R.raw.legacy_kml_statistics_marker);
 
         // when
@@ -92,7 +92,7 @@ public class LegacyImportTest {
     @Test(expected = ImportParserException.class)
     public void kml_without_locations() {
         // given
-        KmlFileTrackImporter trackImporter = new KmlFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new KmlFileTrackImporter(context));
         InputStream inputStream = InstrumentationRegistry.getInstrumentation().getContext().getResources().openRawResource(de.dennisguse.opentracks.debug.test.R.raw.legacy_kml_empty);
 
         // when
@@ -106,7 +106,7 @@ public class LegacyImportTest {
     @Test
     public void gpx_with_pause_resume() {
         // given
-        GpxFileTrackImporter trackImporter = new GpxFileTrackImporter(context);
+        XMLImporter trackImporter = new XMLImporter(new GpxFileTrackImporter(context));
         InputStream inputStream = InstrumentationRegistry.getInstrumentation().getContext().getResources().openRawResource(de.dennisguse.opentracks.debug.test.R.raw.legacy_gpx_pause_resume);
 
         // when

src/main/java/de/dennisguse/opentracks/io/file/importer/AbstractFileTrackImporter.java

@@ -18,7 +18,6 @@ package de.dennisguse.opentracks.io.file.importer;
 
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.database.sqlite.SQLiteConstraintException;
 import android.net.Uri;
 import android.util.Log;
 
@@ -29,8 +28,6 @@ import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;
 
 import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
 import java.time.Duration;
 import java.time.Instant;
 import java.util.ArrayList;
@@ -38,9 +35,6 @@ import java.util.List;
 import java.util.Locale;
 import java.util.UUID;
 
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.parsers.SAXParserFactory;
-
 import de.dennisguse.opentracks.R;
 import de.dennisguse.opentracks.content.data.Distance;
 import de.dennisguse.opentracks.content.data.Marker;
@@ -62,7 +56,7 @@ import de.dennisguse.opentracks.util.TrackIconUtils;
  *
  * @author Jimmy Shih
  */
-abstract class AbstractFileTrackImporter extends DefaultHandler implements TrackImporter {
+abstract class AbstractFileTrackImporter extends DefaultHandler implements XMLImporter.TrackParser {
 
     private static final String TAG = AbstractFileTrackImporter.class.getSimpleName();
 
@@ -127,24 +121,6 @@ abstract class AbstractFileTrackImporter extends DefaultHandler implements Track
         }
     }
 
-    @Override
-    @NonNull
-    public List<Track.Id> importFile(InputStream inputStream) {
-        try {
-            SAXParserFactory.newInstance().newSAXParser().parse(inputStream, this);
-            return trackIds;
-        } catch (IOException | SAXException | ParserConfigurationException | ParsingException e) {
-            Log.e(TAG, "Unable to import file", e);
-            if (trackIds.size() > 0) {
-                cleanImport();
-            }
-            throw new ImportParserException(e);
-        } catch (SQLiteConstraintException e) {
-            Log.e(TAG, "Unable to import file", e);
-            throw new ImportAlreadyExistsException(e);
-        }
-    }
-
     protected void onFileEnd() {
         // Add markers to the last imported track
         int size = trackIds.size();
@@ -484,10 +460,12 @@ abstract class AbstractFileTrackImporter extends DefaultHandler implements Track
         }
     }
 
-    /**
+    @Override
-     * Cleans up import.
+    public List<Track.Id> getImportTrackIds() {
-     */
+        return trackIds;
-    private void cleanImport() {
+    }
+
+    public void cleanImport() {
         contentProviderUtils.deleteTracks(context, trackIds);
     }
 

src/main/java/de/dennisguse/opentracks/io/file/importer/GpxFileTrackImporter.java

@@ -22,6 +22,7 @@ import androidx.annotation.VisibleForTesting;
 
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
 
 import java.util.Locale;
 
@@ -83,6 +84,11 @@ public class GpxFileTrackImporter extends AbstractFileTrackImporter {
         super(context, contentProviderUtils);
     }
 
+    @Override
+    public DefaultHandler getHandler() {
+        return this;
+    }
+
     @Override
     public void startElement(String uri, String localName, String tag, Attributes attributes) throws SAXException {
         switch (tag) {

src/main/java/de/dennisguse/opentracks/io/file/importer/ImportService.java

@@ -51,9 +51,9 @@ public class ImportService extends JobIntentService {
         String fileExtension = FileUtils.getExtension(file);
 
         if (TrackFileFormat.GPX.getExtension().equals(fileExtension)) {
-            trackImporter = new GpxFileTrackImporter(this);
+            trackImporter = new XMLImporter(new GpxFileTrackImporter(this));
         } else if (TrackFileFormat.KML_WITH_TRACKDETAIL_AND_SENSORDATA.getExtension().equals(fileExtension)) {
-            trackImporter = new KmlFileTrackImporter(this);
+            trackImporter = new XMLImporter(new KmlFileTrackImporter(this));
         } else if (TrackFileFormat.KMZ_WITH_TRACKDETAIL_AND_SENSORDATA_AND_PICTURES.getExtension().equals(fileExtension)) {
             trackImporter = new KmzTrackImporter(this, file.getUri());
         } else {

src/main/java/de/dennisguse/opentracks/io/file/importer/KmlFileTrackImporter.java

@@ -23,6 +23,7 @@ import androidx.annotation.VisibleForTesting;
 
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
 
 import java.util.ArrayList;
 
@@ -83,6 +84,11 @@ public class KmlFileTrackImporter extends AbstractFileTrackImporter {
         super(context, contentProviderUtils);
     }
 
+    @Override
+    public DefaultHandler getHandler() {
+        return this;
+    }
+
     @Override
     public void startElement(String uri, String localName, String tag, Attributes attributes) throws SAXException {
         switch (tag) {

src/main/java/de/dennisguse/opentracks/io/file/importer/KmzTrackImporter.java

@@ -71,7 +71,7 @@ public class KmzTrackImporter implements TrackImporter {
     List<Track.Id> importFile(InputStream inputStream) {
         List<Track.Id> trackIds = findAndParseKmlFile(inputStream);
 
-        ArrayList<Track.Id> trackIdsWithImages = new ArrayList<>();
+        List<Track.Id> trackIdsWithImages = new ArrayList<>();
 
         for (Track.Id trackId : trackIds) {
             if (copyKmzImages(trackId)) {
@@ -228,7 +228,7 @@ public class KmzTrackImporter implements TrackImporter {
     }
 
     private List<Track.Id> parseKml(ZipInputStream zipInputStream) {
-        KmlFileTrackImporter kmlFileTrackImporter = new KmlFileTrackImporter(context);
+        XMLImporter kmlFileTrackImporter = new XMLImporter(new KmlFileTrackImporter(context));
 
         try (ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(getKml(zipInputStream))) {
             return kmlFileTrackImporter.importFile(byteArrayInputStream);
@@ -244,6 +244,7 @@ public class KmzTrackImporter implements TrackImporter {
      *
      * @param zipInputStream the zip input stream
      */
+    //TODO We should be able to process the stream; we are wasting memory here.
     private byte[] getKml(ZipInputStream zipInputStream) throws IOException {
         try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
             byte[] buffer = new byte[BUFFER_SIZE];

src/main/java/de/dennisguse/opentracks/io/file/importer/XMLImporter.java

@@ -0,0 +1,56 @@
+package de.dennisguse.opentracks.io.file.importer;
+
+import android.database.sqlite.SQLiteConstraintException;
+import android.util.Log;
+
+import androidx.annotation.NonNull;
+
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.parsers.SAXParserFactory;
+
+import de.dennisguse.opentracks.content.data.Track;
+
+public class XMLImporter implements TrackImporter {
+
+    private static final String TAG = XMLImporter.class.getSimpleName();
+
+    private final TrackParser parser;
+
+    public XMLImporter(TrackParser parser) {
+        this.parser = parser;
+    }
+
+    @Override
+    @NonNull
+    public List<Track.Id> importFile(InputStream inputStream) throws ImportParserException, ImportAlreadyExistsException {
+        try {
+            SAXParserFactory.newInstance().newSAXParser().parse(inputStream, parser.getHandler());
+            List<Track.Id> trackIds = parser.getImportTrackIds();
+            return trackIds;
+        } catch (IOException | SAXException | ParserConfigurationException | AbstractFileTrackImporter.ParsingException e) {
+            Log.e(TAG, "Unable to import file", e);
+            if (parser.getImportTrackIds().size() > 0) {
+                parser.cleanImport();
+            }
+            throw new ImportParserException(e);
+        } catch (SQLiteConstraintException e) {
+            Log.e(TAG, "Unable to import file", e);
+            throw new ImportAlreadyExistsException(e);
+        }
+    }
+
+    interface TrackParser {
+        DefaultHandler getHandler();
+
+        List<Track.Id> getImportTrackIds();
+
+        void cleanImport();
+    }
+}