Changeset 15045 in josm for trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java

Timestamp:

2019-05-04T14:17:27+02:00 (5 years ago)

Author:

Don-vip

Message:

fix #17576 - Fix timezones and DST for image correlation (patch by Bjoeni, modified)

File:

• trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java (modified) (19 diffs)

trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java

@@ -29 +29 @@
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.Comparator;
@@ -37 +36 @@
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 import java.util.TimeZone;
 import java.util.concurrent.TimeUnit;
@@ -108 +106 @@
  * This class displays the window to select the GPX file and the offset (timezone + delta).
  * Then it correlates the images of the layer with that GPX file.
+ * @since 2566
  */
 public class CorrelateGpxWithImages extends AbstractAction {
@@ -541 +540 @@
      */
     private class SetOffsetActionListener implements ActionListener {
-
-        @Override
-        public void actionPerformed(ActionEvent arg0) {
+        JCheckBox ckDst;
+        ImageDisplay imgDisp;
+        JLabel lbExifTime;
+        JosmTextField tfGpsTime;
+
+        class TimeZoneItem implements Comparable<TimeZoneItem> {
+            private final TimeZone tz;
+            private String rawString;
+            private String dstString;
+
+            TimeZoneItem(TimeZone tz) {
+                this.tz = tz;
+            }
+
+            public String getFormattedString() {
+                if (ckDst.isSelected()) {
+                    return getDstString();
+                } else {
+                    return getRawString();
+                }
+            }
+
+            public String getDstString() {
+                if (dstString == null) {
+                    dstString = formatTimezone(tz.getRawOffset() + tz.getDSTSavings());
+                }
+                return dstString;
+            }
+
+            public String getRawString() {
+                if (rawString == null) {
+                    rawString = formatTimezone(tz.getRawOffset());
+                }
+                return rawString;
+            }
+
+            public String getID() {
+                return tz.getID();
+            }
+
+            @Override
+            public String toString() {
+                return getID() + " (" + getFormattedString() + ')';
+            }
+
+            @Override
+            public int compareTo(TimeZoneItem o) {
+                return getID().compareTo(o.getID());
+            }
+
+            private String formatTimezone(int offset) {
+                return new GpxTimezone((double) offset / TimeUnit.HOURS.toMillis(1)).formatTimezone();
+            }
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
             SimpleDateFormat dateFormat = (SimpleDateFormat) DateUtils.getDateTimeFormat(DateFormat.SHORT, DateFormat.MEDIUM);
 
@@ -552 +605 @@
                     BorderLayout.NORTH);
 
-            ImageDisplay imgDisp = new ImageDisplay();
+            imgDisp = new ImageDisplay();
             imgDisp.setPreferredSize(new Dimension(300, 225));
             panel.add(imgDisp, BorderLayout.CENTER);
@@ -566 +619 @@
             panelTf.add(new JLabel(tr("Photo time (from exif):")), gc);
 
-            JLabel lbExifTime = new JLabel();
+            lbExifTime = new JLabel();
             gc.gridx = 1;
             gc.weightx = 1.0;
@@ -581 +634 @@
             panelTf.add(new JLabel(tr("Gps time (read from the above photo): ")), gc);
 
-            JosmTextField tfGpsTime = new JosmTextField(12);
+            tfGpsTime = new JosmTextField(12);
             tfGpsTime.setEnabled(false);
             tfGpsTime.setMinimumSize(new Dimension(155, tfGpsTime.getMinimumSize().height));
@@ -599 +652 @@
             gc.fill = GridBagConstraints.NONE;
             gc.anchor = GridBagConstraints.WEST;
-            panelTf.add(new JLabel(tr("I am in the timezone of: ")), gc);
+            panelTf.add(new JLabel(tr("Photo taken in the timezone of: ")), gc);
+
+            ckDst = new JCheckBox(tr("Use daylight saving time (where applicable)"), Config.getPref().getBoolean("geoimage.timezoneid.dst"));
 
             String[] tmp = TimeZone.getAvailableIDs();
-            List<String> vtTimezones = new ArrayList<>(tmp.length);
+            List<TimeZoneItem> vtTimezones = new ArrayList<>(tmp.length);
+
+            String defTzStr = Config.getPref().get("geoimage.timezoneid", "");
+            if (defTzStr.isEmpty()) {
+                defTzStr = TimeZone.getDefault().getID();
+            }
+            TimeZoneItem defTzItem = null;
 
             for (String tzStr : tmp) {
-                TimeZone tz = TimeZone.getTimeZone(tzStr);
-
-                String tzDesc = tzStr + " (" +
-                        new GpxTimezone(((double) tz.getRawOffset()) / TimeUnit.HOURS.toMillis(1)).formatTimezone() +
-                        ')';
-                vtTimezones.add(tzDesc);
+                TimeZoneItem tz = new TimeZoneItem(TimeZone.getTimeZone(tzStr));
+                vtTimezones.add(tz);
+                if (defTzStr.equals(tzStr)) {
+                    defTzItem = tz;
+                }
             }
 
             Collections.sort(vtTimezones);
 
-            JosmComboBox<String> cbTimezones = new JosmComboBox<>(vtTimezones.toArray(new String[0]));
-
-            String tzId = Config.getPref().get("geoimage.timezoneid", "");
-            TimeZone defaultTz;
-            if (tzId.isEmpty()) {
-                defaultTz = TimeZone.getDefault();
-            } else {
-                defaultTz = TimeZone.getTimeZone(tzId);
-            }
-
-            cbTimezones.setSelectedItem(defaultTz.getID() + " (" +
-                    new GpxTimezone(((double) defaultTz.getRawOffset()) / TimeUnit.HOURS.toMillis(1)).formatTimezone() +
-                    ')');
+            JosmComboBox<TimeZoneItem> cbTimezones = new JosmComboBox<>(vtTimezones.toArray(new TimeZoneItem[0]));
+
+            if (defTzItem != null) {
+                cbTimezones.setSelectedItem(defTzItem);
+            }
 
             gc.gridx = 1;
@@ -635 +687 @@
             panelTf.add(cbTimezones, gc);
 
+            gc.gridy = 3;
+            panelTf.add(ckDst, gc);
+
+            ckDst.addActionListener(x -> cbTimezones.repaint());
+
             panel.add(panelTf, BorderLayout.SOUTH);
 
@@ -654 +711 @@
                 int index = imgList.getSelectedIndex();
                 ImageEntry img = yLayer.getImageData().getImages().get(index);
-                imgDisp.setImage(img);
-                Date date = img.getExifTime();
-                if (date != null) {
-                    DateFormat df = DateUtils.getDateTimeFormat(DateFormat.SHORT, DateFormat.MEDIUM);
-                    lbExifTime.setText(df.format(date));
-                    tfGpsTime.setText(df.format(date));
-                    tfGpsTime.setCaretPosition(tfGpsTime.getText().length());
-                    tfGpsTime.setEnabled(true);
-                    tfGpsTime.requestFocus();
-                } else {
-                    lbExifTime.setText(tr("No date"));
-                    tfGpsTime.setText("");
-                    tfGpsTime.setEnabled(false);
-                }
+                updateExifComponents(img);
             });
             panelLst.add(new JScrollPane(imgList), BorderLayout.CENTER);
@@ -679 +723 @@
                 ImageEntry entry = new ImageEntry(fc.getSelectedFile());
                 entry.extractExif();
-                imgDisp.setImage(entry);
-
-                Date date = entry.getExifTime();
-                if (date != null) {
-                    lbExifTime.setText(DateUtils.getDateTimeFormat(DateFormat.SHORT, DateFormat.MEDIUM).format(date));
-                    tfGpsTime.setText(DateUtils.getDateFormat(DateFormat.SHORT).format(date)+' ');
-                    tfGpsTime.setEnabled(true);
-                } else {
-                    lbExifTime.setText(tr("No date"));
-                    tfGpsTime.setText("");
-                    tfGpsTime.setEnabled(false);
-                }
+                updateExifComponents(entry);
             });
             panelLst.add(openButton, BorderLayout.PAGE_END);
@@ -711 +744 @@
                 try {
                     delta = dateFormat.parse(lbExifTime.getText()).getTime()
-                    - dateFormat.parse(tfGpsTime.getText()).getTime();
-                } catch (ParseException e) {
+                          - dateFormat.parse(tfGpsTime.getText()).getTime();
+                } catch (ParseException ex) {
                     JOptionPane.showMessageDialog(MainApplication.getMainFrame(), tr("Error while parsing the date.\n"
                             + "Please use the requested format"),
@@ -719 +752 @@
                 }
 
-                String selectedTz = (String) cbTimezones.getSelectedItem();
-                int pos = selectedTz.lastIndexOf('(');
-                tzId = selectedTz.substring(0, pos - 1);
-                String tzValue = selectedTz.substring(pos + 1, selectedTz.length() - 1);
-
-                Config.getPref().put("geoimage.timezoneid", tzId);
+                TimeZoneItem selectedTz = (TimeZoneItem) cbTimezones.getSelectedItem();
+
+                Config.getPref().put("geoimage.timezoneid", selectedTz.getID());
+                Config.getPref().putBoolean("geoimage.timezoneid.dst", ckDst.isSelected());
                 tfOffset.setText(GpxTimeOffset.milliseconds(delta).formatOffset());
-                tfTimezone.setText(tzValue);
+                tfTimezone.setText(selectedTz.getFormattedString());
 
                 isOk = true;
@@ -733 +764 @@
             statusBarUpdater.updateStatusBar();
             yLayer.updateBufferAndRepaint();
+        }
+
+        void updateExifComponents(ImageEntry img) {
+            imgDisp.setImage(img);
+            Date date = img.getExifTime();
+            if (date != null) {
+                DateFormat df = DateUtils.getDateTimeFormat(DateFormat.SHORT, DateFormat.MEDIUM);
+                df.setTimeZone(DateUtils.UTC); // EXIF data does not contain timezone information and is read as UTC
+                lbExifTime.setText(df.format(date));
+                tfGpsTime.setText(df.format(date));
+                tfGpsTime.setCaretPosition(tfGpsTime.getText().length());
+                tfGpsTime.setEnabled(true);
+                tfGpsTime.requestFocus();
+            } else {
+                lbExifTime.setText(tr("No date"));
+                tfGpsTime.setText("");
+                tfGpsTime.setEnabled(false);
+            }
         }
     }
@@ -769 +818 @@
     public void actionPerformed(ActionEvent ae) {
         // Construct the list of loaded GPX tracks
-        Collection<Layer> layerLst = MainApplication.getLayerManager().getLayers();
         gpxLst.clear();
         GpxDataWrapper defaultItem = null;
-        for (Layer cur : layerLst) {
-            if (cur instanceof GpxLayer) {
-                GpxLayer curGpx = (GpxLayer) cur;
-                GpxDataWrapper gdw = new GpxDataWrapper(curGpx.getName(), curGpx.data, curGpx.data.storageFile);
-                gpxLst.add(gdw);
-                if (cur == yLayer.gpxLayer) {
-                    defaultItem = gdw;
-                }
+        for (GpxLayer cur : MainApplication.getLayerManager().getLayersOfType(GpxLayer.class)) {
+            GpxDataWrapper gdw = new GpxDataWrapper(cur.getName(), cur.data, cur.data.storageFile);
+            gpxLst.add(gdw);
+            if (cur == yLayer.gpxLayer) {
+                defaultItem = gdw;
             }
         }
@@ -801 +846 @@
         } else {
             // select first GPX track associated to a file
-            for (GpxDataWrapper item : gpxLst) {
-                if (item.file != null) {
-                    cbGpx.setSelectedItem(item);
-                    break;
-                }
-            }
+            gpxLst.stream().filter(i -> i.file != null).findFirst().ifPresent(cbGpx::setSelectedItem);
         }
         cbGpx.addActionListener(statusBarUpdaterWithRepaint);
@@ -818 +858 @@
 
         try {
-            timezone = GpxTimezone.parseTimezone(Optional.ofNullable(Config.getPref().get("geoimage.timezone", "0:00")).orElse("0:00"));
+            String tz = Config.getPref().get("geoimage.timezone");
+            if (!tz.isEmpty()) {
+                timezone = GpxTimezone.parseTimezone(tz);
+            } else {
+                timezone = new GpxTimezone(TimeUnit.MILLISECONDS.toMinutes(TimeZone.getDefault().getRawOffset()) / 60.); //hours is double
+            }
         } catch (ParseException e) {
             timezone = GpxTimezone.ZERO;
@@ -837 +882 @@
         tfOffset.setText(delta.formatOffset());
 
-        JButton buttonViewGpsPhoto = new JButton(tr("<html>Use photo of an accurate clock,<br>"
-                + "e.g. GPS receiver display</html>"));
+        JButton buttonViewGpsPhoto = new JButton(tr("<html>Use photo of an accurate clock,<br>e.g. GPS receiver display</html>"));
         buttonViewGpsPhoto.setIcon(ImageProvider.get("clock"));
         buttonViewGpsPhoto.addActionListener(new SetOffsetActionListener());
@@ -1055 +1099 @@
                 return tr("No gpx selected");
 
-            final long offsetMs = ((long) (timezone.getHours() * TimeUnit.HOURS.toMillis(-1))) + delta.getMilliseconds(); // in milliseconds
+            final long offsetMs = ((long) (timezone.getHours() * TimeUnit.HOURS.toMillis(1))) + delta.getMilliseconds(); // in milliseconds
             lastNumMatched = GpxImageCorrelation.matchGpxTrack(dateImgLst, selGpx.data, offsetMs, forceTags);