Changeset 36275 in osm for applications/editors/josm/plugins

Timestamp:

2024-06-06T17:48:26+02:00 (4 months ago)

Author:

taylor.smock

Message:

Update photo_geotagging to use apache commons-imaging 1.0.0-alpha5

Also convert license headers to the standard JOSM license headers + SPDX.

Location:

applications/editors/josm/plugins/photo_geotagging

Files:

• LICENSE (added)
• src/org/openstreetmap/josm/plugins/photo_geotagging/ExifGPSTagger.java (modified) (6 diffs)
• src/org/openstreetmap/josm/plugins/photo_geotagging/GeotaggingAction.java (modified) (10 diffs)
• src/org/openstreetmap/josm/plugins/photo_geotagging/GeotaggingPlugin.java (modified) (2 diffs)

applications/editors/josm/plugins/photo_geotagging/src/org/openstreetmap/josm/plugins/photo_geotagging/ExifGPSTagger.java

@@ -1 @@
-// Wrapper class for sanselan library
+// License: GPL. For details, see LICENSE file.
+// SPDX-License-Identifier: GPL-2.0-or-later
 package org.openstreetmap.josm.plugins.photo_geotagging;
 
@@ -11 +12 @@
 import java.time.Instant;
 import java.util.Calendar;
-import java.util.Date;
 import java.util.GregorianCalendar;
 import java.util.TimeZone;
 
-import org.apache.commons.imaging.ImageReadException;
-import org.apache.commons.imaging.ImageWriteException;
 import org.apache.commons.imaging.Imaging;
+import org.apache.commons.imaging.ImagingException;
 import org.apache.commons.imaging.common.ImageMetadata;
 import org.apache.commons.imaging.common.RationalNumber;
@@ -28 +27 @@
 import org.apache.commons.imaging.formats.tiff.write.TiffOutputSet;
 
-public class ExifGPSTagger {
+/**
+ * Wrapper class for sanselan library
+ */
+public final class ExifGPSTagger {
+    private ExifGPSTagger() {
+        // Hide constructor
+    }
+
     /**
      * Set the GPS values in JPEG EXIF metadata.
@@ -44 +50 @@
      * @throws IOException in case of I/O error
      */
-    public static void setExifGPSTag(File imageFile, File dst, double lat, double lon, Instant gpsTime, Double speed, Double ele, Double imgDir, boolean lossy) throws IOException {
+    public static void setExifGPSTag(File imageFile, File dst, double lat, double lon, Instant gpsTime, Double speed,
+            Double ele, Double imgDir, boolean lossy) throws IOException {
         try {
             setExifGPSTagWorker(imageFile, dst, lat, lon, gpsTime, speed, ele, imgDir, lossy);
-        } catch (ImageReadException ire) {
-            throw new IOException(tr("Read error: "+ire), ire);
-        } catch (ImageWriteException ire2) {
-            throw new IOException(tr("Write error: "+ire2), ire2);
+        } catch (ImagingException ire) {
+            // This used to be two separate exceptions; ImageReadException and imageWriteException
+            throw new IOException(tr("Read/write error: " + ire.getMessage()), ire);
         }
     }
 
-    public static void setExifGPSTagWorker(File imageFile, File dst, double lat, double lon, Instant gpsTime, Double speed, Double ele, Double imgDir, boolean lossy)
-            throws IOException, ImageReadException, ImageWriteException {
+    public static void setExifGPSTagWorker(File imageFile, File dst, double lat, double lon, Instant gpsTime, Double speed,
+            Double ele, Double imgDir, boolean lossy) throws IOException {
 
         TiffOutputSet outputSet = null;
@@ -73 +79 @@
         }
 
-        TiffOutputDirectory gpsDirectory = outputSet.getOrCreateGPSDirectory();
+        TiffOutputDirectory gpsDirectory = outputSet.getOrCreateGpsDirectory();
         gpsDirectory.removeField(GpsTagConstants.GPS_TAG_GPS_VERSION_ID);
         gpsDirectory.add(GpsTagConstants.GPS_TAG_GPS_VERSION_ID, (byte)2, (byte)3, (byte)0, (byte)0);
@@ -112 +118 @@
         }
 
-        outputSet.setGPSInDegrees(lon, lat);
+        outputSet.setGpsInDegrees(lon, lat);
 
         if (speed != null) {

applications/editors/josm/plugins/photo_geotagging/src/org/openstreetmap/josm/plugins/photo_geotagging/GeotaggingAction.java

@@ -1 @@
-//License: GPL (v2 or later)
+// License: GPL. For details, see LICENSE file.
+// SPDX-License-Identifier: GPL-2.0-or-later
 package org.openstreetmap.josm.plugins.photo_geotagging;
 
@@ -8 +9 @@
 import java.awt.Component;
 import java.awt.Dimension;
+import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.event.ActionEvent;
@@ -17 +19 @@
 import java.time.Instant;
 import java.util.ArrayList;
-import java.util.Date;
 import java.util.List;
+import java.util.Locale;
 import java.util.UUID;
 
@@ -35 +37 @@
 import javax.swing.UIManager;
 
-import org.apache.commons.imaging.formats.jpeg.exif.ExifRewriter;
+import org.apache.commons.imaging.ImagingOverflowException;
 import org.apache.commons.io.FilenameUtils;
 import org.openstreetmap.josm.gui.ExtendedDialog;
@@ -57 +59 @@
 class GeotaggingAction extends AbstractAction implements LayerAction {
 
-    final static String KEEP_BACKUP = "plugins.photo_geotagging.keep_backup";
-    final static String CHANGE_MTIME = "plugins.photo_geotagging.change-mtime";
-    final static String MTIME_MODE = "plugins.photo_geotagging.mtime-mode";
-    final static int MTIME_MODE_GPS = 1;
-    final static int MTIME_MODE_PREVIOUS_VALUE = 2;
+    static final String KEEP_BACKUP = "plugins.photo_geotagging.keep_backup";
+    static final String CHANGE_MTIME = "plugins.photo_geotagging.change-mtime";
+    static final String MTIME_MODE = "plugins.photo_geotagging.mtime-mode";
+    static final int MTIME_MODE_GPS = 1;
+    static final int MTIME_MODE_PREVIOUS_VALUE = 2;
 
     public GeotaggingAction() {
@@ -88 +90 @@
             if (e.getPos() != null && e.hasNewGpsData()) {
                 String pth = e.getFile().getAbsolutePath();
-                switch (FilenameUtils.getExtension(pth).toLowerCase()) {
+                switch (FilenameUtils.getExtension(pth).toLowerCase(Locale.ENGLISH)) {
                     case "tif":
                     case "tiff":
@@ -113 +115 @@
         JScrollPane scroll = new JScrollPane(entryList);
         scroll.setPreferredSize(new Dimension(900, 250));
-        cont.add(scroll, GBC.eol().fill(GBC.BOTH));
+        cont.add(scroll, GBC.eol().fill(GridBagConstraints.BOTH));
 
         if (notSupportedFilesCount > 0) {
@@ -119 +121 @@
                     ? tr("The file \"{0}\" can not be updated. Only JPEG and TIFF images are supported.", notSupportedName)
                     : trn("{0} file can not be updated. Only JPEG and TIFF images are supported.",
-                          "{0} files can not be updated. Only JPEG and TIFF images are supported.", notSupportedFilesCount, notSupportedFilesCount));
+                          "{0} files can not be updated. Only JPEG and TIFF images are supported.",
+                    notSupportedFilesCount, notSupportedFilesCount));
             warn.setForeground(Color.RED);
             cont.add(warn, GBC.eol());
@@ -203 +206 @@
 
     static class GeoTaggingRunnable extends PleaseWaitRunnable {
-        final private List<ImageEntry> images;
-        final private boolean keep_backup;
-        final private int mTimeMode;
+        private final List<ImageEntry> images;
+        private final boolean keep_backup;
+        private final int mTimeMode;
 
         private boolean canceled = false;
@@ -288 +291 @@
                     processEntry(e, lossy);
                 } catch (final IOException ioe) {
-                    ioe.printStackTrace();
+                    Logging.trace(ioe);
                     restoreFile();
-                    if (!lossy && ioe.getCause() instanceof ExifRewriter.ExifOverflowException) {
+                    if (!lossy && ioe.getCause() instanceof ImagingOverflowException) {
                         exifFailedEntries.add(e);
                     } else {

applications/editors/josm/plugins/photo_geotagging/src/org/openstreetmap/josm/plugins/photo_geotagging/GeotaggingPlugin.java

@@ -1 @@
-//License: GPL (v2 or above)
+// License: GPL. For details, see LICENSE file.
+// SPDX-License-Identifier: GPL-2.0-or-later
 package org.openstreetmap.josm.plugins.photo_geotagging;
 
@@ -11 +12 @@
  * It extends the core geoimage feature of JOSM by adding a new entry
  * to the right click menu of any image layer.
- *
+ * <p>
  * The real work (writing lat/lon values to file) is done by the pure Java
  * sanselan library.