src/jalview/io/BackupFiles.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.io;
  22
  23 import java.io.File;
  24 import java.io.IOException;
  25 import java.nio.file.Files;
  26 import java.nio.file.Path;
  27 import java.nio.file.Paths;
  28 import java.nio.file.StandardCopyOption;
  29 import java.text.SimpleDateFormat;
  30 import java.util.ArrayList;
  31 import java.util.HashMap;
  32 import java.util.Map;
  33 import java.util.TreeMap;
  34
  35 import jalview.bin.Cache;
  36 import jalview.bin.Console;
  37 import jalview.gui.Desktop;
  38 import jalview.gui.JvOptionPane;
  39 import jalview.util.MessageManager;
  40 import jalview.util.Platform;
  41
  42 /*
  43  * BackupFiles used for manipulating (naming rolling/deleting) backup/version files when an alignment or project file is saved.
  44  * User configurable options are:
  45  * BACKUPFILES_ENABLED - boolean flag as to whether to use this mechanism or act as before, including overwriting files as saved.
  46  * The rest of the options are now saved as BACKUPFILES_PRESET, BACKUPFILES_SAVED and BACKUPFILES_CUSTOM
  47  * (see BackupFilesPresetEntry)
  48  */
  49
  50 public class BackupFiles
  51 {
  52
  53   // labels for saved params in Cache and .jalview_properties
  54   public static final String NS = "BACKUPFILES";
  55
  56   public static final String ENABLED = NS + "_ENABLED";
  57
  58   public static final String NUM_PLACEHOLDER = "%n";
  59
  60   private static final String DEFAULT_TEMP_FILE = "jalview_temp_file_" + NS;
  61
  62   private static final String TEMP_FILE_EXT = ".tmp";
  63
  64   // file - File object to be backed up and then updated (written over)
  65   private File file;
  66
  67   // enabled - default flag as to whether to do the backup file roll (if not
  68   // defined in preferences)
  69   private static boolean enabled;
  70
  71   // confirmDelete - default flag as to whether to confirm with the user before
  72   // deleting old backup/version files
  73   private static boolean confirmDelete;
  74
  75   // defaultSuffix - default template to use to append to basename of file
  76   private String suffix;
  77
  78   // noMax - flag to turn off a maximum number of files
  79   private boolean noMax;
  80
  81   // defaultMax - default max number of backup files
  82   private int max;
  83
  84   // defaultDigits - number of zero-led digits to use in the filename
  85   private int digits;
  86
  87   // reverseOrder - set to true to make newest (latest) files lowest number
  88   // (like rolled log files)
  89   private boolean reverseOrder;
  90
  91   // temp saved file to become new saved file
  92   private File tempFile;
  93
  94   // flag set to see if file save to temp file was successful
  95   private boolean tempFileWriteSuccess;
  96
  97   // array of files to be deleted, with extra information
  98   private ArrayList<File> deleteFiles = new ArrayList<>();
  99
 100   // date formatting for modification times
 101   private static final SimpleDateFormat sdf = new SimpleDateFormat(
 102           "yyyy-MM-dd HH:mm:ss");
 103
 104   private static final String newTempFileSuffix = "_newfile";
 105
 106   private static final String oldTempFileSuffix = "_oldfile_tobedeleted";
 107
 108   public BackupFiles(String filename)
 109   {
 110     this(new File(filename));
 111   }
 112
 113   // first time defaults for SUFFIX, NO_MAX, ROLL_MAX, SUFFIX_DIGITS and
 114   // REVERSE_ORDER
 115   public BackupFiles(File file)
 116   {
 117     classInit();
 118     this.file = file;
 119     BackupFilesPresetEntry bfpe = BackupFilesPresetEntry
 120             .getSavedBackupEntry();
 121     this.suffix = bfpe.suffix;
 122     this.noMax = bfpe.keepAll;
 123     this.max = bfpe.rollMax;
 124     this.digits = bfpe.digits;
 125     this.reverseOrder = bfpe.reverse;
 126
 127     // create a temp file to save new data in
 128     File temp = null;
 129     try
 130     {
 131       if (file != null)
 132       {
 133         String tempfilename = file.getName();
 134         File tempdir = file.getParentFile();
 135         Console.trace(
 136                 "BACKUPFILES [file!=null] attempting to create temp file for "
 137                         + tempfilename + " in dir " + tempdir);
 138         temp = File.createTempFile(tempfilename,
 139                 TEMP_FILE_EXT + newTempFileSuffix, tempdir);
 140         Console.debug(
 141                 "BACKUPFILES using temp file " + temp.getAbsolutePath());
 142       }
 143       else
 144       {
 145         Console.trace(
 146                 "BACKUPFILES [file==null] attempting to create default temp file "
 147                         + DEFAULT_TEMP_FILE + " with extension "
 148                         + TEMP_FILE_EXT);
 149         temp = File.createTempFile(DEFAULT_TEMP_FILE, TEMP_FILE_EXT);
 150       }
 151     } catch (IOException e)
 152     {
 153       Console.error("Could not create temp file to save to (IOException)");
 154       Console.error(e.getMessage());
 155       Console.debug(Cache.getStackTraceString(e));
 156     } catch (Exception e)
 157     {
 158       Console.error("Exception creating temp file for saving");
 159       Console.debug(Cache.getStackTraceString(e));
 160     }
 161     this.setTempFile(temp);
 162   }
 163
 164   public static void classInit()
 165   {
 166     Console.initLogger();
 167     Console.trace("BACKUPFILES classInit");
 168     boolean e = Cache.getDefault(ENABLED, !Platform.isJS());
 169     setEnabled(e);
 170     Console.trace("BACKUPFILES " + (e ? "enabled" : "disabled"));
 171     BackupFilesPresetEntry bfpe = BackupFilesPresetEntry
 172             .getSavedBackupEntry();
 173     Console.trace("BACKUPFILES preset scheme " + bfpe.toString());
 174     setConfirmDelete(bfpe.confirmDelete);
 175     Console.trace("BACKUPFILES confirm delete " + bfpe.confirmDelete);
 176   }
 177
 178   public static void setEnabled(boolean flag)
 179   {
 180     enabled = flag;
 181   }
 182
 183   public static boolean getEnabled()
 184   {
 185     classInit();
 186     return enabled;
 187   }
 188
 189   public static void setConfirmDelete(boolean flag)
 190   {
 191     confirmDelete = flag;
 192   }
 193
 194   public static boolean getConfirmDelete()
 195   {
 196     classInit();
 197     return confirmDelete;
 198   }
 199
 200   // set, get and rename temp file into place
 201   public void setTempFile(File temp)
 202   {
 203     this.tempFile = temp;
 204   }
 205
 206   public File getTempFile()
 207   {
 208     return tempFile;
 209   }
 210
 211   public String getTempFilePath()
 212   {
 213     String path = null;
 214     try
 215     {
 216       path = this.getTempFile().getCanonicalPath();
 217     } catch (IOException e)
 218     {
 219       Console.error("IOException when getting Canonical Path of temp file '"
 220               + this.getTempFile().getName() + "'");
 221       Console.debug(Cache.getStackTraceString(e));
 222     }
 223     return path;
 224   }
 225
 226   public boolean setWriteSuccess(boolean flag)
 227   {
 228     boolean old = this.tempFileWriteSuccess;
 229     this.tempFileWriteSuccess = flag;
 230     return old;
 231   }
 232
 233   public boolean getWriteSuccess()
 234   {
 235     return this.tempFileWriteSuccess;
 236   }
 237
 238   public boolean renameTempFile()
 239   {
 240     return moveFileToFile(tempFile, file);
 241   }
 242
 243   // roll the backupfiles
 244   public boolean rollBackupFiles()
 245   {
 246     return this.rollBackupFiles(true);
 247   }
 248
 249   public boolean rollBackupFiles(boolean tidyUp)
 250   {
 251     // file doesn't yet exist or backups are not enabled or template is null or
 252     // empty
 253     if ((!file.exists()) || (!enabled) || max < 0 || suffix == null
 254             || suffix.length() == 0)
 255     {
 256       // nothing to do
 257       Console.debug("BACKUPFILES rollBackupFiles nothing to do." + ", "
 258               + "filename: " + (file != null ? file.getName() : "null")
 259               + ", " + "file exists: " + file.exists() + ", " + "enabled: "
 260               + enabled + ", " + "max: " + max + ", " + "suffix: '" + suffix
 261               + "'");
 262       return true;
 263     }
 264
 265     Console.trace("BACKUPFILES rollBackupFiles starting");
 266
 267     String dir = "";
 268     File dirFile;
 269     try
 270     {
 271       dirFile = file.getParentFile();
 272       dir = dirFile.getCanonicalPath();
 273       Console.trace("BACKUPFILES dir: " + dir);
 274     } catch (Exception e)
 275     {
 276       Console.error("Could not get canonical path for file '" + file + "'");
 277       Console.error(e.getMessage());
 278       Console.debug(Cache.getStackTraceString(e));
 279       return false;
 280     }
 281     String filename = file.getName();
 282     String basename = filename;
 283
 284     Console.trace("BACKUPFILES filename is " + filename);
 285     boolean ret = true;
 286     // Create/move backups up one
 287
 288     deleteFiles.clear();
 289
 290     // find existing backup files
 291     BackupFilenameFilter bff = new BackupFilenameFilter(basename, suffix,
 292             digits);
 293     File[] backupFiles = dirFile.listFiles(bff);
 294     int nextIndexNum = 0;
 295
 296     Console.trace("BACKUPFILES backupFiles.length: " + backupFiles.length);
 297     if (backupFiles.length == 0)
 298     {
 299       // No other backup files. Just need to move existing file to backupfile_1
 300       Console.trace(
 301               "BACKUPFILES no existing backup files, setting index to 1");
 302       nextIndexNum = 1;
 303     }
 304     else
 305     {
 306       TreeMap<Integer, File> bfTreeMap = sortBackupFilesAsTreeMap(
 307               backupFiles, basename);
 308       // bfTreeMap now a sorted list of <Integer index>,<File backupfile>
 309       // mappings
 310
 311       if (reverseOrder)
 312       {
 313         // backup style numbering
 314         Console.trace("BACKUPFILES rolling files in reverse order");
 315
 316         int tempMax = noMax ? -1 : max;
 317         // noMax == true means no limits
 318         // look for first "gap" in backupFiles
 319         // if tempMax is -1 at this stage just keep going until there's a gap,
 320         // then hopefully tempMax gets set to the right index (a positive
 321         // integer so the loop breaks)...
 322         // why do I feel a little uneasy about this loop?..
 323         for (int i = 1; tempMax < 0 || i <= max; i++)
 324         {
 325           if (!bfTreeMap.containsKey(i)) // first index without existent
 326                                          // backupfile
 327           {
 328             tempMax = i;
 329           }
 330         }
 331
 332         File previousFile = null;
 333         File fileToBeDeleted = null;
 334         for (int n = tempMax; n > 0; n--)
 335         {
 336           String backupfilename = dir + File.separatorChar
 337                   + BackupFilenameParts.getBackupFilename(n, basename,
 338                           suffix, digits);
 339           File backupfile_n = new File(backupfilename);
 340
 341           if (!backupfile_n.exists())
 342           {
 343             // no "oldest" file to delete
 344             previousFile = backupfile_n;
 345             fileToBeDeleted = null;
 346             Console.trace("BACKUPFILES No oldest file to delete");
 347             continue;
 348           }
 349
 350           // check the modification time of this (backupfile_n) and the previous
 351           // file (fileToBeDeleted) if the previous file is going to be deleted
 352           if (fileToBeDeleted != null)
 353           {
 354             File replacementFile = backupfile_n;
 355             long fileToBeDeletedLMT = fileToBeDeleted.lastModified();
 356             long replacementFileLMT = replacementFile.lastModified();
 357             Console.trace("BACKUPFILES fileToBeDeleted is "
 358                     + fileToBeDeleted.getAbsolutePath());
 359             Console.trace("BACKUPFILES replacementFile is "
 360                     + backupfile_n.getAbsolutePath());
 361
 362             try
 363             {
 364               File oldestTempFile = nextTempFile(fileToBeDeleted.getName(),
 365                       dirFile);
 366
 367               if (fileToBeDeletedLMT > replacementFileLMT)
 368               {
 369                 String fileToBeDeletedLMTString = sdf
 370                         .format(fileToBeDeletedLMT);
 371                 String replacementFileLMTString = sdf
 372                         .format(replacementFileLMT);
 373                 Console.warn("WARNING! I am set to delete backupfile "
 374                         + fileToBeDeleted.getName()
 375                         + " has modification time "
 376                         + fileToBeDeletedLMTString
 377                         + " which is newer than its replacement "
 378                         + replacementFile.getName()
 379                         + " with modification time "
 380                         + replacementFileLMTString);
 381
 382                 boolean delete = confirmNewerDeleteFile(fileToBeDeleted,
 383                         replacementFile, true);
 384                 Console.trace("BACKUPFILES "
 385                         + (delete ? "confirmed" : "not") + " deleting file "
 386                         + fileToBeDeleted.getAbsolutePath()
 387                         + " which is newer than "
 388                         + replacementFile.getAbsolutePath());
 389
 390                 if (delete)
 391                 {
 392                   // User has confirmed delete -- no need to add it to the list
 393                   fileToBeDeleted.delete();
 394                 }
 395                 else
 396                 {
 397                   Console.debug("BACKUPFILES moving "
 398                           + fileToBeDeleted.getAbsolutePath() + " to "
 399                           + oldestTempFile.getAbsolutePath());
 400                   moveFileToFile(fileToBeDeleted, oldestTempFile);
 401                 }
 402               }
 403               else
 404               {
 405                 Console.debug("BACKUPFILES going to move "
 406                         + fileToBeDeleted.getAbsolutePath() + " to "
 407                         + oldestTempFile.getAbsolutePath());
 408                 moveFileToFile(fileToBeDeleted, oldestTempFile);
 409                 addDeleteFile(oldestTempFile);
 410               }
 411
 412             } catch (Exception e)
 413             {
 414               Console.error(
 415                       "Error occurred, probably making new temp file for '"
 416                               + fileToBeDeleted.getName() + "'");
 417               Console.error(Cache.getStackTraceString(e));
 418             }
 419
 420             // reset
 421             fileToBeDeleted = null;
 422           }
 423
 424           if (!noMax && n == tempMax && backupfile_n.exists())
 425           {
 426             fileToBeDeleted = backupfile_n;
 427           }
 428           else
 429           {
 430             if (previousFile != null)
 431             {
 432               // using boolean '&' instead of '&&' as don't want moveFileToFile
 433               // attempt to be conditional (short-circuit)
 434               ret = ret & moveFileToFile(backupfile_n, previousFile);
 435             }
 436           }
 437
 438           previousFile = backupfile_n;
 439         }
 440
 441         // index to use for the latest backup
 442         nextIndexNum = 1;
 443       }
 444       else // not reverse numbering
 445       {
 446         // version style numbering (with earliest file deletion if max files
 447         // reached)
 448
 449         bfTreeMap.values().toArray(backupFiles);
 450         StringBuilder bfsb = new StringBuilder();
 451         for (int i = 0; i < backupFiles.length; i++)
 452         {
 453           if (bfsb.length() > 0)
 454           {
 455             bfsb.append(", ");
 456           }
 457           bfsb.append(backupFiles[i].getName());
 458         }
 459         Console.trace("BACKUPFILES backupFiles: " + bfsb.toString());
 460
 461         // noMax == true means keep all backup files
 462         if ((!noMax) && bfTreeMap.size() >= max)
 463         {
 464           Console.trace("BACKUPFILES noMax: " + noMax + ", " + "max: " + max
 465                   + ", " + "bfTreeMap.size(): " + bfTreeMap.size());
 466           // need to delete some files to keep number of backups to designated
 467           // max.
 468           // Note that if the suffix is not numbered then do not delete any
 469           // backup files later or we'll delete the new backup file (there can
 470           // be only one).
 471           int numToDelete = suffix.indexOf(NUM_PLACEHOLDER) > -1
 472                   ? bfTreeMap.size() - max + 1
 473                   : 0;
 474           Console.trace("BACKUPFILES numToDelete: " + numToDelete);
 475           // the "replacement" file is the latest backup file being kept (it's
 476           // not replacing though)
 477           File replacementFile = numToDelete < backupFiles.length
 478                   ? backupFiles[numToDelete]
 479                   : null;
 480           for (int i = 0; i < numToDelete; i++)
 481           {
 482             // check the deletion files for modification time of the last
 483             // backupfile being saved
 484             File fileToBeDeleted = backupFiles[i];
 485             boolean delete = true;
 486
 487             Console.trace(
 488                     "BACKUPFILES fileToBeDeleted: " + fileToBeDeleted);
 489
 490             boolean newer = false;
 491             if (replacementFile != null)
 492             {
 493               long fileToBeDeletedLMT = fileToBeDeleted.lastModified();
 494               long replacementFileLMT = replacementFile != null
 495                       ? replacementFile.lastModified()
 496                       : Long.MAX_VALUE;
 497               if (fileToBeDeletedLMT > replacementFileLMT)
 498               {
 499                 String fileToBeDeletedLMTString = sdf
 500                         .format(fileToBeDeletedLMT);
 501                 String replacementFileLMTString = sdf
 502                         .format(replacementFileLMT);
 503
 504                 Console.warn("WARNING! I am set to delete backupfile '"
 505                         + fileToBeDeleted.getName()
 506                         + "' has modification time "
 507                         + fileToBeDeletedLMTString
 508                         + " which is newer than the oldest backupfile being kept '"
 509                         + replacementFile.getName()
 510                         + "' with modification time "
 511                         + replacementFileLMTString);
 512
 513                 delete = confirmNewerDeleteFile(fileToBeDeleted,
 514                         replacementFile, false);
 515                 if (delete)
 516                 {
 517                   // User has confirmed delete -- no need to add it to the list
 518                   fileToBeDeleted.delete();
 519                   Console.debug("BACKUPFILES deleting fileToBeDeleted: "
 520                           + fileToBeDeleted);
 521                   delete = false;
 522                 }
 523                 else
 524                 {
 525                   // keeping file, nothing to do!
 526                   Console.debug("BACKUPFILES keeping fileToBeDeleted: "
 527                           + fileToBeDeleted);
 528                 }
 529               }
 530             }
 531             if (delete)
 532             {
 533               addDeleteFile(fileToBeDeleted);
 534               Console.debug("BACKUPFILES addDeleteFile(fileToBeDeleted): "
 535                       + fileToBeDeleted);
 536             }
 537
 538           }
 539
 540         }
 541
 542         nextIndexNum = bfTreeMap.lastKey() + 1;
 543       }
 544     }
 545
 546     // Let's make the new backup file!! yay, got there at last!
 547     String latestBackupFilename = dir + File.separatorChar
 548             + BackupFilenameParts.getBackupFilename(nextIndexNum, basename,
 549                     suffix, digits);
 550     Console.trace("BACKUPFILES Moving old file [" + file
 551             + "] to latestBackupFilename [" + latestBackupFilename + "]");
 552     // using boolean '&' instead of '&&' as don't want moveFileToFile attempt to
 553     // be conditional (short-circuit)
 554     ret = ret & moveFileToFile(file, new File(latestBackupFilename));
 555     Console.debug(
 556             "BACKUPFILES moving " + file + " to " + latestBackupFilename
 557                     + " was " + (ret ? "" : "NOT ") + "successful");
 558     if (tidyUp)
 559     {
 560       Console.debug("BACKUPFILES tidying up files");
 561       tidyUpFiles();
 562     }
 563
 564     return ret;
 565   }
 566
 567   private static File nextTempFile(String filename, File dirFile)
 568           throws IOException
 569   {
 570     File temp = null;
 571     COUNT: for (int i = 1; i < 1000; i++)
 572     {
 573       File trythis = new File(dirFile,
 574               filename + '~' + Integer.toString(i));
 575       if (!trythis.exists())
 576       {
 577         temp = trythis;
 578         break COUNT;
 579       }
 580
 581     }
 582     if (temp == null)
 583     {
 584       temp = File.createTempFile(filename, TEMP_FILE_EXT, dirFile);
 585     }
 586     return temp;
 587   }
 588
 589   private void tidyUpFiles()
 590   {
 591     deleteOldFiles();
 592   }
 593
 594   private static boolean confirmNewerDeleteFile(File fileToBeDeleted,
 595           File replacementFile, boolean replace)
 596   {
 597     StringBuilder messageSB = new StringBuilder();
 598
 599     File ftbd = fileToBeDeleted;
 600     String ftbdLMT = sdf.format(ftbd.lastModified());
 601     String ftbdSize = Long.toString(ftbd.length());
 602
 603     File rf = replacementFile;
 604     String rfLMT = sdf.format(rf.lastModified());
 605     String rfSize = Long.toString(rf.length());
 606
 607     int confirmButton = JvOptionPane.NO_OPTION;
 608     if (replace)
 609     {
 610       File saveFile = null;
 611       try
 612       {
 613         saveFile = nextTempFile(ftbd.getName(), ftbd.getParentFile());
 614       } catch (Exception e)
 615       {
 616         Console.error(
 617                 "Error when confirming to keep backup file newer than other backup files.");
 618         e.printStackTrace();
 619       }
 620       messageSB.append(MessageManager.formatMessage(
 621               "label.newerdelete_replacement_line", new String[]
 622               { ftbd.getName(), rf.getName(), ftbdLMT, rfLMT, ftbdSize,
 623                   rfSize }));
 624       // "Backup file\n''{0}''\t(modified {2}, size {4})\nis to be deleted and
 625       // replaced by apparently older file \n''{1}''\t(modified {3}, size
 626       // {5}).""
 627       messageSB.append("\n\n");
 628       messageSB.append(MessageManager.formatMessage(
 629               "label.confirm_deletion_or_rename", new String[]
 630               { ftbd.getName(), saveFile.getName() }));
 631       // "Confirm deletion of ''{0}'' or rename to ''{1}''?"
 632       String[] options = new String[] {
 633           MessageManager.getString("label.delete"),
 634           MessageManager.getString("label.rename") };
 635
 636       // TODO enable JvOptionPane to behave appropriately when batch/headless
 637       confirmButton = Platform.isHeadless() ? JvOptionPane.YES_OPTION
 638               : JvOptionPane.showOptionDialog(Desktop.getDesktopPane(),
 639                       messageSB.toString(),
 640                       MessageManager.getString(
 641                               "label.backupfiles_confirm_delete"),
 642                       JvOptionPane.YES_NO_OPTION,
 643                       JvOptionPane.WARNING_MESSAGE, null, options,
 644                       options[0]);
 645     }
 646     else
 647     {
 648       messageSB.append(MessageManager
 649               .formatMessage("label.newerdelete_line", new String[]
 650               { ftbd.getName(), rf.getName(), ftbdLMT, rfLMT, ftbdSize,
 651                   rfSize }));
 652       // "Backup file\n''{0}''\t(modified {2}, size {4})\nis to be deleted but
 653       // is newer than the oldest remaining backup file \n''{1}''\t(modified
 654       // {3}, size {5})."
 655       messageSB.append("\n\n");
 656       messageSB.append(MessageManager
 657               .formatMessage("label.confirm_deletion", new String[]
 658               { ftbd.getName() }));
 659       // "Confirm deletion of ''{0}''?"
 660       String[] options = new String[] {
 661           MessageManager.getString("label.delete"),
 662           MessageManager.getString("label.keep") };
 663
 664       confirmButton = Platform.isHeadless() ? JvOptionPane.YES_OPTION
 665               : JvOptionPane.showOptionDialog(Desktop.getDesktopPane(),
 666               messageSB.toString(),
 667               MessageManager.getString("label.backupfiles_confirm_delete"),
 668               JvOptionPane.YES_NO_OPTION, JvOptionPane.WARNING_MESSAGE,
 669               null, options, options[0]);
 670     }
 671
 672     // return should be TRUE if file is to be deleted
 673     return (confirmButton == JvOptionPane.YES_OPTION);
 674   }
 675
 676   private void deleteOldFiles()
 677   {
 678     if (deleteFiles != null && !deleteFiles.isEmpty())
 679     {
 680       boolean doDelete = false;
 681       StringBuilder messageSB = null;
 682       if (confirmDelete && deleteFiles.size() > 0)
 683       {
 684         messageSB = new StringBuilder();
 685         messageSB.append(MessageManager
 686                 .getString("label.backupfiles_confirm_delete_old_files"));
 687         // "Delete the following older backup files? (see the Backups tab in
 688         // Preferences for more options)"
 689         for (int i = 0; i < deleteFiles.size(); i++)
 690         {
 691           File df = deleteFiles.get(i);
 692           messageSB.append("\n");
 693           messageSB.append(df.getName());
 694           messageSB.append(" ");
 695           messageSB.append(MessageManager.formatMessage("label.file_info",
 696                   new String[]
 697                   { sdf.format(df.lastModified()),
 698                       Long.toString(df.length()) }));
 699           // "(modified {0}, size {1})"
 700         }
 701
 702         int confirmButton = Platform.isHeadless() ? JvOptionPane.YES_OPTION
 703             : JvOptionPane.showConfirmDialog(Desktop.getDesktopPane(),
 704                         messageSB.toString(),
 705                         MessageManager.getString(
 706                                 "label.backupfiles_confirm_delete"),
 707                         // "Confirm delete"
 708                         JvOptionPane.YES_NO_OPTION,
 709                         JvOptionPane.WARNING_MESSAGE);
 710
 711         doDelete = (confirmButton == JvOptionPane.YES_OPTION);
 712       }
 713       else
 714       {
 715         doDelete = true;
 716       }
 717
 718       if (doDelete)
 719       {
 720         for (int i = 0; i < deleteFiles.size(); i++)
 721         {
 722           File fileToDelete = deleteFiles.get(i);
 723           Console.trace("BACKUPFILES about to delete fileToDelete:"
 724                   + fileToDelete);
 725           fileToDelete.delete();
 726           Console.warn("deleted '" + fileToDelete.getName() + "'");
 727         }
 728       }
 729
 730     }
 731
 732     deleteFiles.clear();
 733   }
 734
 735   private TreeMap<Integer, File> sortBackupFilesAsTreeMap(
 736           File[] backupFiles, String basename)
 737   {
 738     // sort the backup files (based on integer found in the suffix) using a
 739     // precomputed Hashmap for speed
 740     Map<Integer, File> bfHashMap = new HashMap<>();
 741     for (int i = 0; i < backupFiles.length; i++)
 742     {
 743       File f = backupFiles[i];
 744       BackupFilenameParts bfp = new BackupFilenameParts(f, basename, suffix,
 745               digits);
 746       bfHashMap.put(bfp.indexNum(), f);
 747     }
 748     TreeMap<Integer, File> bfTreeMap = new TreeMap<>();
 749     bfTreeMap.putAll(bfHashMap);
 750     return bfTreeMap;
 751   }
 752
 753   public boolean rollBackupsAndRenameTempFile()
 754   {
 755     boolean write = this.getWriteSuccess();
 756
 757     boolean roll = false;
 758     boolean rename = false;
 759     if (write)
 760     {
 761       roll = this.rollBackupFiles(false); // tidyUpFiles at the end
 762       rename = this.renameTempFile();
 763     }
 764
 765     /*
 766      * Not sure that this confirmation is desirable.  By this stage the new file is
 767      * already written successfully, but something (e.g. disk full) has happened while
 768      * trying to roll the backup files, and most likely the filename needed will already
 769      * be vacant so renaming the temp file is nearly always correct!
 770      */
 771     boolean okay = roll && rename;
 772     if (!okay)
 773     {
 774       StringBuilder messageSB = new StringBuilder();
 775       messageSB.append(MessageManager.getString(
 776               "label.backupfiles_confirm_save_file_backupfiles_roll_wrong"));
 777       // "Something possibly went wrong with the backups of this file."
 778       if (rename)
 779       {
 780         if (messageSB.length() > 0)
 781         {
 782           messageSB.append("\n");
 783         }
 784         messageSB.append(MessageManager.getString(
 785                 "label.backupfiles_confirm_save_new_saved_file_ok"));
 786         // "The new saved file seems okay."
 787       }
 788       else
 789       {
 790         if (messageSB.length() > 0)
 791         {
 792           messageSB.append("\n");
 793         }
 794         messageSB.append(MessageManager.getString(
 795                 "label.backupfiles_confirm_save_new_saved_file_not_ok"));
 796         // "The new saved file might not be okay."
 797       }
 798       if (messageSB.length() > 0)
 799       {
 800         messageSB.append("\n");
 801       }
 802       messageSB
 803               .append(MessageManager.getString("label.continue_operation"));
 804
 805       int confirmButton = Platform.isHeadless() ? JvOptionPane.OK_OPTION
 806               : JvOptionPane.showConfirmDialog(Desktop.getDesktopPane(),
 807                       messageSB.toString(),
 808                       MessageManager.getString(
 809                               "label.backupfiles_confirm_save_file"),
 810                       // "Confirm save file"
 811                       JvOptionPane.OK_OPTION, JvOptionPane.WARNING_MESSAGE);
 812       okay = confirmButton == JvOptionPane.OK_OPTION;
 813     }
 814     if (okay)
 815     {
 816       tidyUpFiles();
 817     }
 818
 819     return rename;
 820   }
 821
 822   public static TreeMap<Integer, File> getBackupFilesAsTreeMap(
 823           String fileName, String suffix, int digits)
 824   {
 825     File[] backupFiles = null;
 826
 827     File file = new File(fileName);
 828
 829     File dirFile;
 830     try
 831     {
 832       dirFile = file.getParentFile();
 833     } catch (Exception e)
 834     {
 835       Console.error("Could not get canonical path for file '" + file + "'");
 836       return new TreeMap<>();
 837     }
 838
 839     String filename = file.getName();
 840     String basename = filename;
 841
 842     // find existing backup files
 843     BackupFilenameFilter bff = new BackupFilenameFilter(basename, suffix,
 844             digits);
 845     backupFiles = dirFile.listFiles(bff); // is clone needed?
 846
 847     // sort the backup files (based on integer found in the suffix) using a
 848     // precomputed Hashmap for speed
 849     Map<Integer, File> bfHashMap = new HashMap<>();
 850     for (int i = 0; i < backupFiles.length; i++)
 851     {
 852       File f = backupFiles[i];
 853       BackupFilenameParts bfp = new BackupFilenameParts(f, basename, suffix,
 854               digits);
 855       bfHashMap.put(bfp.indexNum(), f);
 856     }
 857     TreeMap<Integer, File> bfTreeMap = new TreeMap<>();
 858     bfTreeMap.putAll(bfHashMap);
 859
 860     return bfTreeMap;
 861   }
 862
 863   /*
 864   private boolean addDeleteFile(File fileToBeDeleted, File originalFile,
 865           boolean delete, boolean newer)
 866   {
 867     return addDeleteFile(fileToBeDeleted, originalFile, null, delete, newer);
 868   }
 869   */
 870   private boolean addDeleteFile(File fileToBeDeleted)
 871   {
 872     boolean ret = false;
 873     int pos = deleteFiles.indexOf(fileToBeDeleted);
 874     if (pos > -1)
 875     {
 876       Console.debug("BACKUPFILES not adding file "
 877               + fileToBeDeleted.getAbsolutePath()
 878               + " to the delete list (already at index" + pos + ")");
 879       return true;
 880     }
 881     else
 882     {
 883       Console.debug("BACKUPFILES adding file "
 884               + fileToBeDeleted.getAbsolutePath() + " to the delete list");
 885       deleteFiles.add(fileToBeDeleted);
 886     }
 887     return ret;
 888   }
 889
 890   public static boolean moveFileToFile(File oldFile, File newFile)
 891   {
 892     Console.initLogger();
 893     boolean ret = false;
 894     Path oldPath = Paths.get(oldFile.getAbsolutePath());
 895     Path newPath = Paths.get(newFile.getAbsolutePath());
 896     try
 897     {
 898       // delete destination file - not usually necessary but Just In Case...
 899       Console.trace("BACKUPFILES deleting " + newFile.getAbsolutePath());
 900       newFile.delete();
 901       Console.trace("BACKUPFILES moving " + oldFile.getAbsolutePath()
 902               + " to " + newFile.getAbsolutePath());
 903       Files.move(oldPath, newPath, StandardCopyOption.REPLACE_EXISTING);
 904       ret = true;
 905       Console.trace("BACKUPFILES move seems to have succeeded");
 906     } catch (IOException e)
 907     {
 908       Console.warn("Could not move file '" + oldPath.toString() + "' to '"
 909               + newPath.toString() + "'");
 910       Console.error(e.getMessage());
 911       Console.debug(Cache.getStackTraceString(e));
 912       ret = false;
 913     } catch (Exception e)
 914     {
 915       Console.error(e.getMessage());
 916       Console.debug(Cache.getStackTraceString(e));
 917       ret = false;
 918     }
 919     return ret;
 920   }
 921 }