Changeset 9296 in josm for trunk/src/org/openstreetmap

Timestamp:

2016-01-04T01:06:23+01:00 (8 years ago)

Author:

Don-vip

Message:

fix #12249 - Fix Findbugs warnings "Exceptional return value of java.io.File.delete() ignored"

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/SessionLoadAction.java (modified) (1 diff)
• data/AutosaveTask.java (modified) (6 diffs)
• data/CustomConfigurator.java (modified) (1 diff)
• data/Preferences.java (modified) (2 diffs)
• gui/io/DownloadFileTask.java (modified) (2 diffs)
• gui/layer/geoimage/GeoImageLayer.java (modified) (1 diff)
• io/CachedFile.java (modified) (1 diff)
• io/OsmExporter.java (modified) (1 diff)
• plugins/ReadRemotePluginInformationTask.java (modified) (1 diff)
• tools/PlatformHookOsx.java (modified) (2 diffs)
• tools/PlatformHookWindows.java (modified) (1 diff)
• tools/Utils.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/actions/SessionLoadAction.java

@@ -163 +163 @@
                 } finally {
                     if (tempFile) {
-                        if (!file.delete()) {
-                            file.deleteOnExit();
-                        }
+                        Utils.deleteFile(file);
                         file = null;
                     }

trunk/src/org/openstreetmap/josm/data/AutosaveTask.java

@@ -2 +2 @@
 package org.openstreetmap.josm.data;
 
+import static org.openstreetmap.josm.tools.I18n.marktr;
 import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -40 +41 @@
 import org.openstreetmap.josm.io.OsmExporter;
 import org.openstreetmap.josm.io.OsmImporter;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -194 +196 @@
         while (info.backupFiles.size() > PROP_FILES_PER_LAYER.get()) {
             File oldFile = info.backupFiles.remove();
-            if (!oldFile.delete()) {
-                Main.warn(tr("Unable to delete old backup file {0}", oldFile.getAbsolutePath()));
-            } else {
-                File pidFile = getPidFile(oldFile);
-                if (!pidFile.delete()) {
-                    Main.warn(tr("Unable to delete old backup file {0}", pidFile.getAbsolutePath()));
-                }
+            if (Utils.deleteFile(oldFile, marktr("Unable to delete old backup file {0}"))) {
+                Utils.deleteFile(getPidFile(oldFile), marktr("Unable to delete old backup file {0}"));
             }
         }
@@ -273 +270 @@
                         }
                         for (File file: info.backupFiles) {
-                            if (file.delete()) {
-                                getPidFile(file).delete();
+                            if (Utils.deleteFile(file)) {
+                                Utils.deleteFile(getPidFile(file));
                             }
                         }
@@ -369 +366 @@
         if (backupFile.exists()) {
             deletedLayers.remove(backupFile);
-            if (!backupFile.delete()) {
-                Main.warn(String.format("Could not delete old backup file %s", backupFile));
-            }
+            Utils.deleteFile(backupFile, marktr("Unable to delete old backup file {0}"));
         }
         if (f.renameTo(backupFile)) {
             deletedLayers.add(backupFile);
-            pidFile.delete();
+            Utils.deleteFile(pidFile);
         } else {
             Main.warn(String.format("Could not move autosaved file %s to %s folder", f.getName(), deletedLayersDir.getName()));
             // we cannot move to deleted folder, so just try to delete it directly
-            if (!f.delete()) {
-                Main.warn(String.format("Could not delete backup file %s", f));
-            } else if (!pidFile.delete()) {
-                Main.warn(String.format("Could not delete PID file %s", pidFile));
+            if (Utils.deleteFile(f, marktr("Unable to delete backup file {0}"))) {
+                Utils.deleteFile(pidFile, marktr("Unable to delete PID file {0}"));
             }
         }
@@ -390 +383 @@
                 break;
             }
-            if (!next.delete()) {
-                Main.warn(String.format("Could not delete archived backup file %s", next));
-            }
+            Utils.deleteFile(next, marktr("Unable to delete archived backup file {0}"));
         }
     }

trunk/src/org/openstreetmap/josm/data/CustomConfigurator.java

@@ -314 +314 @@
             }
         }
-        try {
-            f.delete();
-        } catch (Exception e) {
-            log("Warning: Can not delete file "+f.getPath()+": "+e.getMessage());
+        if (!Utils.deleteFile(f)) {
+            log("Warning: Can not delete file "+f.getPath());
         }
     }

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -2 +2 @@
 package org.openstreetmap.josm.data;
 
+import static org.openstreetmap.josm.tools.I18n.marktr;
 import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -872 +873 @@
         File tmpFile = new File(prefFile + "_tmp");
         Utils.copyFile(tmpFile, prefFile);
-        if (!tmpFile.delete()) {
-            Main.warn(tr("Unable to delete temporary file {0}", tmpFile.getAbsolutePath()));
-        }
+        Utils.deleteFile(tmpFile, marktr("Unable to delete temporary file {0}"));
 
         setCorrectPermissions(prefFile);

trunk/src/org/openstreetmap/josm/gui/io/DownloadFileTask.java

@@ -23 +23 @@
 import org.openstreetmap.josm.gui.PleaseWaitRunnable;
 import org.openstreetmap.josm.tools.HttpClient;
+import org.openstreetmap.josm.tools.Utils;
 import org.xml.sax.SAXException;
 
@@ -132 +133 @@
                     Main.info(tr("Unpacking {0} into {1}", file.getAbsolutePath(), file.getParent()));
                     unzipFileRecursively(file, file.getParent());
-                    file.delete();
+                    Utils.deleteFile(file);
                 }
             }

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

@@ -666 +666 @@
                 }
 
-                if (toDelete.getFile().delete()) {
+                if (Utils.deleteFile(toDelete.getFile())) {
                     Main.info("File "+toDelete.getFile()+" deleted. ");
                 } else {

trunk/src/org/openstreetmap/josm/io/CachedFile.java

@@ -335 +335 @@
                     File lfile = new File(localPath.get(1));
                     if (lfile.exists()) {
-                        lfile.delete();
+                        Utils.deleteFile(lfile);
                     }
                 }

trunk/src/org/openstreetmap/josm/io/OsmExporter.java

@@ -93 +93 @@
             if (noBackup || !Main.pref.getBoolean("save.keepbackup", false)) {
                 if (tmpFile != null) {
-                    tmpFile.delete();
+                    Utils.deleteFile(tmpFile);
                 }
             }

trunk/src/org/openstreetmap/josm/plugins/ReadRemotePluginInformationTask.java

@@ -326 +326 @@
         // remove old stuff or whole update process is broken
         for (File file: siteCacheFiles) {
-            file.delete();
+            Utils.deleteFile(file);
         }
     }

trunk/src/org/openstreetmap/josm/tools/PlatformHookOsx.java

@@ -2 +2 @@
 package org.openstreetmap.josm.tools;
 
+import static org.openstreetmap.josm.tools.I18n.marktr;
 import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -366 +367 @@
                         Main.info("Copying old preferences file to new location");
                         Utils.copyFile(oldPref, newPref);
-                        if (!oldPref.delete()) {
-                            Main.warn("Unable to delete old preferences file: "+oldPref.getPath());
-                        }
+                        Utils.deleteFile(oldPref, marktr("Unable to delete old preferences file {0}"));
                     } catch (IOException e) {
                         Main.error(e);

trunk/src/org/openstreetmap/josm/tools/PlatformHookWindows.java

@@ -190 +190 @@
     public boolean rename(File from, File to) {
         if (to.exists())
-            to.delete();
+            Utils.deleteFile(to);
         return from.renameTo(to);
     }

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -2 +2 @@
 package org.openstreetmap.josm.tools;
 
+import static org.openstreetmap.josm.tools.I18n.marktr;
 import static org.openstreetmap.josm.tools.I18n.tr;
 import static org.openstreetmap.josm.tools.I18n.trn;
@@ -446 +447 @@
                     if (file.isDirectory()) {
                         deleteDirectory(file);
-                    } else if (!file.delete()) {
-                        Main.warn("Unable to delete file: "+file.getPath());
+                    } else {
+                        deleteFile(file);
                     }
                 }
@@ -453 +454 @@
         }
         return path.delete();
+    }
+
+    /**
+     * Deletes a file and log a default warning if the deletion fails.
+     * @param file file to delete
+     * and must contain a single parameter <code>{0}</code> for the file path
+     * @return {@code true} if and only if the file is successfully deleted; {@code false} otherwise
+     * @since XXXX
+     */
+    public static boolean deleteFile(File file) {
+        return deleteFile(file, marktr("Unable to delete file {0}"));
+    }
+
+    /**
+     * Deletes a file and log a configurable warning if the deletion fails.
+     * @param file file to delete
+     * @param warnMsg warning message. It will be translated with {@code tr()}
+     * and must contain a single parameter <code>{0}</code> for the file path
+     * @return {@code true} if and only if the file is successfully deleted; {@code false} otherwise
+     * @since XXXX
+     */
+    public static boolean deleteFile(File file, String warnMsg) {
+        boolean result = file.delete();
+        if (!result) {
+            Main.warn(tr(warnMsg, file.getPath()));
+        }
+        return result;
     }