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