Configurable filename for export: used for all automatic exports after recording, exporting all, and sharing tracks.

Fixes #512.
2022-05-03 20:06:29 +02:00
parent 8a2d1c42a8
commit 0d3cf4ce0d
11 changed files with 253 additions and 9 deletions
@@ -0,0 +1,105 @@
+package de.dennisguse.opentracks.io.file;
+
+import androidx.annotation.NonNull;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import de.dennisguse.opentracks.data.models.Track;
+import de.dennisguse.opentracks.util.FileUtils;
+
+public class TrackFilenameGenerator {
+
+    public static final String UUID_KEY = "{uuid}";
+    public static final String TRACKNAME_KEY = "{name}";
+    public static final String CATEGORY_KEY = "{category}";
+    public static final String STARTTIME_KEY = "{time}";
+
+    public static String getAllOptions() {
+        return Stream.of(UUID_KEY, TRACKNAME_KEY, CATEGORY_KEY, STARTTIME_KEY)
+                .collect(Collectors.joining(", "));
+    }
+
+    private final String template;
+
+    public TrackFilenameGenerator(@NonNull String template) {
+        this.template = template;
+    }
+
+    public String format(@NonNull Track track, @NonNull TrackFileFormat trackFileFormat) {
+        Map<String, String> values = new HashMap<>();
+
+        values.put(UUID_KEY, track.getUuid().toString().substring(0, 8));
+        values.put(TRACKNAME_KEY, track.getName());
+        values.put(CATEGORY_KEY, track.getCategory());
+        values.put(STARTTIME_KEY, track.getStartTime().toString());
+
+        return FileUtils.sanitizeFileName(format(template, values)) + "." + trackFileFormat.getExtension();
+    }
+
+    private static String format(String template, Map<String, String> values) {
+        StringBuilder templateCompiler = new StringBuilder(template);
+        List<String> valueList = new ArrayList<>();
+
+        Matcher keyMatcher = Pattern
+                .compile("\\{(\\w+)\\}")
+                .matcher(template);
+
+        while (keyMatcher.find()) {
+            String key = keyMatcher.group();
+
+            if (!values.containsKey(key)) {
+                throw new TemplateInvalidException(key);
+            }
+
+            int index = templateCompiler.indexOf(key);
+            if (index != -1) {
+                templateCompiler.replace(index, index + key.length(), "%s");
+                valueList.add(values.get(key));
+            }
+        }
+
+        String templateCompiled = templateCompiler.toString();
+        if (templateCompiled.contains("{") || templateCompiled.contains("}")) {
+            throw new TemplateInvalidException(template);
+        }
+
+        return String.format(templateCompiled, valueList.toArray());
+    }
+
+    public String getTemplate() {
+        return template;
+    }
+
+    public boolean isValid() {
+        try {
+            getExample();
+            return !template.isEmpty();
+        } catch (TemplateInvalidException e) {
+            return false;
+        }
+    }
+
+    public String getExample() {
+        Track track = new Track();
+        track.setName("Berlin");
+        track.setUuid(UUID.fromString("fefefefefe-0000-1000-8000-00805f9b34fb"));
+        track.getTrackStatistics().setStartTime(Instant.ofEpochMilli(0));
+
+        return format(track, TrackFileFormat.GPX);
+    }
+
+    public static class TemplateInvalidException extends RuntimeException {
+        public TemplateInvalidException(String invalidTemplate) {
+            super(invalidTemplate);
+        }
+    }
+}