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.trace(
 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.debug(
 140                 "BACKUPFILES using temp file " + temp.getAbsolutePath());
 141       }
 142       else
 143       {
 144         Cache.trace(
 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.error("Could not create temp file to save to (IOException)");
 153       Cache.error(e.getMessage());
 154       Cache.debug(Cache.getStackTraceString(e));
 155     } catch (Exception e)
 156     {
 157       Cache.error("Exception creating temp file for saving");
 158       Cache.debug(Cache.getStackTraceString(e));
 159     }
 160     this.setTempFile(temp);
 161   }
 162
 163   public static void classInit()
 164   {
 165     Cache.initLogger();
 166     Cache.trace("BACKUPFILES classInit");
 167     boolean e = Cache.getDefault(ENABLED, !Platform.isJS());
 168     setEnabled(e);
 169     Cache.trace("BACKUPFILES " + (e ? "enabled" : "disabled"));
 170     BackupFilesPresetEntry bfpe = BackupFilesPresetEntry
 171             .getSavedBackupEntry();
 172     Cache.trace("BACKUPFILES preset scheme " + bfpe.toString());
 173     setConfirmDelete(bfpe.confirmDelete);
 174     Cache.trace("BACKUPFILES confirm delete " + bfpe.confirmDelete);
 175   }
 176
 177   public static void setEnabled(boolean flag)
 178   {
 179     enabled = flag;
 180   }
 181
 182   public static boolean getEnabled()
 183   {
 184     classInit();
 185     return enabled;
 186   }
 187
 188   public static void setConfirmDelete(boolean flag)
 189   {
 190     confirmDelete = flag;
 191   }
 192
 193   public static boolean getConfirmDelete()
 194   {
 195     classInit();
 196     return confirmDelete;
 197   }
 198
 199   // set, get and rename temp file into place
 200   public void setTempFile(File temp)
 201   {
 202     this.tempFile = temp;
 203   }
 204
 205   public File getTempFile()
 206   {
 207     return tempFile;
 208   }
 209
 210   public String getTempFilePath()
 211   {
 212     String path = null;
 213     try
 214     {
 215       path = this.getTempFile().getCanonicalPath();
 216     } catch (IOException e)
 217     {
 218       Cache.error("IOException when getting Canonical Path of temp file '"
 219               + this.getTempFile().getName() + "'");
 220       Cache.debug(Cache.getStackTraceString(e));
 221     }
 222     return path;
 223   }
 224
 225   public boolean setWriteSuccess(boolean flag)
 226   {
 227     boolean old = this.tempFileWriteSuccess;
 228     this.tempFileWriteSuccess = flag;
 229     return old;
 230   }
 231
 232   public boolean getWriteSuccess()
 233   {
 234     return this.tempFileWriteSuccess;
 235   }
 236
 237   public boolean renameTempFile()
 238   {
 239     return moveFileToFile(tempFile, file);
 240   }
 241
 242   // roll the backupfiles
 243   public boolean rollBackupFiles()
 244   {
 245     return this.rollBackupFiles(true);
 246   }
 247
 248   public boolean rollBackupFiles(boolean tidyUp)
 249   {
 250     // file doesn't yet exist or backups are not enabled or template is null or
 251     // empty
 252     if ((!file.exists()) || (!enabled) || max < 0 || suffix == null
 253             || suffix.length() == 0)
 254     {
 255       // nothing to do
 256       Cache.debug("BACKUPFILES rollBackupFiles nothing to do." + ", "
 257               + "filename: " + (file != null ? file.getName() : "null")
 258               + ", " + "file exists: " + file.exists() + ", " + "enabled: "
 259               + enabled + ", " + "max: " + max + ", " + "suffix: '" + suffix
 260               + "'");
 261       return true;
 262     }
 263
 264     Cache.trace("BACKUPFILES rollBackupFiles starting");
 265
 266     String dir = "";
 267     File dirFile;
 268     try
 269     {
 270       dirFile = file.getParentFile();
 271       dir = dirFile.getCanonicalPath();
 272       Cache.trace("BACKUPFILES dir: " + dir);
 273     } catch (Exception e)
 274     {
 275       Cache.error("Could not get canonical path for file '" + file + "'");
 276       Cache.error(e.getMessage());
 277       Cache.debug(Cache.getStackTraceString(e));
 278       return false;
 279     }
 280     String filename = file.getName();
 281     String basename = filename;
 282
 283     Cache.trace("BACKUPFILES filename is " + filename);
 284     boolean ret = true;
 285     // Create/move backups up one
 286
 287     deleteFiles.clear();
 288
 289     // find existing backup files
 290     BackupFilenameFilter bff = new BackupFilenameFilter(basename, suffix,
 291             digits);
 292     File[] backupFiles = dirFile.listFiles(bff);
 293     int nextIndexNum = 0;
 294
 295     Cache.trace("BACKUPFILES backupFiles.length: " + backupFiles.length);
 296     if (backupFiles.length == 0)
 297     {
 298       // No other backup files. Just need to move existing file to backupfile_1
 299       Cache.trace(
 300               "BACKUPFILES no existing backup files, setting index to 1");
 301       nextIndexNum = 1;
 302     }
 303     else
 304     {
 305       TreeMap<Integer, File> bfTreeMap = sortBackupFilesAsTreeMap(
 306               backupFiles, basename);
 307       // bfTreeMap now a sorted list of <Integer index>,<File backupfile>
 308       // mappings
 309
 310       if (reverseOrder)
 311       {
 312         // backup style numbering
 313         Cache.trace("BACKUPFILES rolling files in reverse order");
 314
 315         int tempMax = noMax ? -1 : max;
 316         // noMax == true means no limits
 317         // look for first "gap" in backupFiles
 318         // if tempMax is -1 at this stage just keep going until there's a gap,
 319         // then hopefully tempMax gets set to the right index (a positive
 320         // integer so the loop breaks)...
 321         // why do I feel a little uneasy about this loop?..
 322         for (int i = 1; tempMax < 0 || i <= max; i++)
 323         {
 324           if (!bfTreeMap.containsKey(i)) // first index without existent
 325                                          // backupfile
 326           {
 327             tempMax = i;
 328           }
 329         }
 330
 331         File previousFile = null;
 332         File fileToBeDeleted = null;
 333         for (int n = tempMax; n > 0; n--)
 334         {
 335           String backupfilename = dir + File.separatorChar
 336                   + BackupFilenameParts.getBackupFilename(n, basename,
 337                           suffix, digits);
 338           File backupfile_n = new File(backupfilename);
 339
 340           if (!backupfile_n.exists())
 341           {
 342             // no "oldest" file to delete
 343             previousFile = backupfile_n;
 344             fileToBeDeleted = null;
 345             Cache.trace("BACKUPFILES No oldest file to delete");
 346             continue;
 347           }
 348
 349           // check the modification time of this (backupfile_n) and the previous
 350           // file (fileToBeDeleted) if the previous file is going to be deleted
 351           if (fileToBeDeleted != null)
 352           {
 353             File replacementFile = backupfile_n;
 354             long fileToBeDeletedLMT = fileToBeDeleted.lastModified();
 355             long replacementFileLMT = replacementFile.lastModified();
 356             Cache.trace("BACKUPFILES fileToBeDeleted is "
 357                     + fileToBeDeleted.getAbsolutePath());
 358             Cache.trace("BACKUPFILES replacementFile is "
 359                     + backupfile_n.getAbsolutePath());
 360
 361             try
 362             {
 363               File oldestTempFile = nextTempFile(fileToBeDeleted.getName(),
 364                       dirFile);
 365
 366               if (fileToBeDeletedLMT > replacementFileLMT)
 367               {
 368                 String fileToBeDeletedLMTString = sdf
 369                         .format(fileToBeDeletedLMT);
 370                 String replacementFileLMTString = sdf
 371                         .format(replacementFileLMT);
 372                 Cache.warn("WARNING! I am set to delete backupfile "
 373                         + fileToBeDeleted.getName()
 374                         + " has modification time "
 375                         + fileToBeDeletedLMTString
 376                         + " which is newer than its replacement "
 377                         + replacementFile.getName()
 378                         + " with modification time "
 379                         + replacementFileLMTString);
 380
 381                 boolean delete = confirmNewerDeleteFile(fileToBeDeleted,
 382                         replacementFile, true);
 383                 Cache.trace("BACKUPFILES " + (delete ? "confirmed" : "not")
 384                         + " deleting file "
 385                         + fileToBeDeleted.getAbsolutePath()
 386                         + " which is newer than "
 387                         + replacementFile.getAbsolutePath());
 388
 389                 if (delete)
 390                 {
 391                   // User has confirmed delete -- no need to add it to the list
 392                   fileToBeDeleted.delete();
 393                 }
 394                 else
 395                 {
 396                   Cache.debug("BACKUPFILES moving "
 397                           + fileToBeDeleted.getAbsolutePath() + " to "
 398                           + oldestTempFile.getAbsolutePath());
 399                   moveFileToFile(fileToBeDeleted, oldestTempFile);
 400                 }
 401               }
 402               else
 403               {
 404                 Cache.debug("BACKUPFILES going to move "
 405                         + fileToBeDeleted.getAbsolutePath() + " to "
 406                         + oldestTempFile.getAbsolutePath());
 407                 moveFileToFile(fileToBeDeleted, oldestTempFile);
 408                 addDeleteFile(oldestTempFile);
 409               }
 410
 411             } catch (Exception e)
 412             {
 413               Cache.error(
 414                       "Error occurred, probably making new temp file for '"
 415                               + fileToBeDeleted.getName() + "'");
 416               Cache.error(Cache.getStackTraceString(e));
 417             }
 418
 419             // reset
 420             fileToBeDeleted = null;
 421           }
 422
 423           if (!noMax && n == tempMax && backupfile_n.exists())
 424           {
 425             fileToBeDeleted = backupfile_n;
 426           }
 427           else
 428           {
 429             if (previousFile != null)
 430             {
 431               // using boolean '&' instead of '&&' as don't want moveFileToFile
 432               // attempt to be conditional (short-circuit)
 433               ret = ret & moveFileToFile(backupfile_n, previousFile);
 434             }
 435           }
 436
 437           previousFile = backupfile_n;
 438         }
 439
 440         // index to use for the latest backup
 441         nextIndexNum = 1;
 442       }
 443       else // not reverse numbering
 444       {
 445         // version style numbering (with earliest file deletion if max files
 446         // reached)
 447
 448         bfTreeMap.values().toArray(backupFiles);
 449         StringBuilder bfsb = new StringBuilder();
 450         for (int i = 0; i < backupFiles.length; i++)
 451         {
 452           if (bfsb.length() > 0)
 453           {
 454             bfsb.append(", ");
 455           }
 456           bfsb.append(backupFiles[i].getName());
 457         }
 458         Cache.trace("BACKUPFILES backupFiles: " + bfsb.toString());
 459
 460         // noMax == true means keep all backup files
 461         if ((!noMax) && bfTreeMap.size() >= max)
 462         {
 463           Cache.trace("BACKUPFILES noMax: " + noMax + ", " + "max: " + max
 464                   + ", " + "bfTreeMap.size(): " + bfTreeMap.size());
 465           // need to delete some files to keep number of backups to designated
 466           // max.
 467           // Note that if the suffix is not numbered then do not delete any
 468           // backup files later or we'll delete the new backup file (there can
 469           // be only one).
 470           int numToDelete = suffix.indexOf(NUM_PLACEHOLDER) > -1
 471                   ? bfTreeMap.size() - max + 1
 472                   : 0;
 473           Cache.trace("BACKUPFILES numToDelete: " + numToDelete);
 474           // the "replacement" file is the latest backup file being kept (it's
 475           // not replacing though)
 476           File replacementFile = numToDelete < backupFiles.length
 477                   ? backupFiles[numToDelete]
 478                   : null;
 479           for (int i = 0; i < numToDelete; i++)
 480           {
 481             // check the deletion files for modification time of the last
 482             // backupfile being saved
 483             File fileToBeDeleted = backupFiles[i];
 484             boolean delete = true;
 485
 486             Cache.trace("BACKUPFILES fileToBeDeleted: " + fileToBeDeleted);
 487
 488             boolean newer = false;
 489             if (replacementFile != null)
 490             {
 491               long fileToBeDeletedLMT = fileToBeDeleted.lastModified();
 492               long replacementFileLMT = replacementFile != null
 493                       ? replacementFile.lastModified()
 494                       : Long.MAX_VALUE;
 495               if (fileToBeDeletedLMT > replacementFileLMT)
 496               {
 497                 String fileToBeDeletedLMTString = sdf
 498                         .format(fileToBeDeletedLMT);
 499                 String replacementFileLMTString = sdf
 500                         .format(replacementFileLMT);
 501
 502                 Cache.warn("WARNING! I am set to delete backupfile '"
 503                         + fileToBeDeleted.getName()
 504                         + "' has modification time "
 505                         + fileToBeDeletedLMTString
 506                         + " which is newer than the oldest backupfile being kept '"
 507                         + replacementFile.getName()
 508                         + "' with modification time "
 509                         + replacementFileLMTString);
 510
 511                 delete = confirmNewerDeleteFile(fileToBeDeleted,
 512                         replacementFile, false);
 513                 if (delete)
 514                 {
 515                   // User has confirmed delete -- no need to add it to the list
 516                   fileToBeDeleted.delete();
 517                   Cache.debug("BACKUPFILES deleting fileToBeDeleted: "
 518                           + fileToBeDeleted);
 519                   delete = false;
 520                 }
 521                 else
 522                 {
 523                   // keeping file, nothing to do!
 524                   Cache.debug("BACKUPFILES keeping fileToBeDeleted: "
 525                           + fileToBeDeleted);
 526                 }
 527               }
 528             }
 529             if (delete)
 530             {
 531               addDeleteFile(fileToBeDeleted);
 532               Cache.debug("BACKUPFILES addDeleteFile(fileToBeDeleted): "
 533                       + fileToBeDeleted);
 534             }
 535
 536           }
 537
 538         }
 539
 540         nextIndexNum = bfTreeMap.lastKey() + 1;
 541       }
 542     }
 543
 544     // Let's make the new backup file!! yay, got there at last!
 545     String latestBackupFilename = dir + File.separatorChar
 546             + BackupFilenameParts.getBackupFilename(nextIndexNum, basename,
 547                     suffix, digits);
 548     Cache.trace("BACKUPFILES Moving old file [" + file
 549             + "] to latestBackupFilename [" + latestBackupFilename + "]");
 550     // using boolean '&' instead of '&&' as don't want moveFileToFile attempt to
 551     // be conditional (short-circuit)
 552     ret = ret & moveFileToFile(file, new File(latestBackupFilename));
 553     Cache.debug("BACKUPFILES moving " + file + " to " + latestBackupFilename
 554             + " was " + (ret ? "" : "NOT ") + "successful");
 555     if (tidyUp)
 556     {
 557       Cache.debug("BACKUPFILES tidying up files");
 558       tidyUpFiles();
 559     }
 560
 561     return ret;
 562   }
 563
 564   private static File nextTempFile(String filename, File dirFile)
 565           throws IOException
 566   {
 567     File temp = null;
 568     COUNT: for (int i = 1; i < 1000; i++)
 569     {
 570       File trythis = new File(dirFile,
 571               filename + '~' + Integer.toString(i));
 572       if (!trythis.exists())
 573       {
 574         temp = trythis;
 575         break COUNT;
 576       }
 577
 578     }
 579     if (temp == null)
 580     {
 581       temp = File.createTempFile(filename, TEMP_FILE_EXT, dirFile);
 582     }
 583     return temp;
 584   }
 585
 586   private void tidyUpFiles()
 587   {
 588     deleteOldFiles();
 589   }
 590
 591   private static boolean confirmNewerDeleteFile(File fileToBeDeleted,
 592           File replacementFile, boolean replace)
 593   {
 594     StringBuilder messageSB = new StringBuilder();
 595
 596     File ftbd = fileToBeDeleted;
 597     String ftbdLMT = sdf.format(ftbd.lastModified());
 598     String ftbdSize = Long.toString(ftbd.length());
 599
 600     File rf = replacementFile;
 601     String rfLMT = sdf.format(rf.lastModified());
 602     String rfSize = Long.toString(rf.length());
 603
 604     int confirmButton = JvOptionPane.NO_OPTION;
 605     if (replace)
 606     {
 607       File saveFile = null;
 608       try
 609       {
 610         saveFile = nextTempFile(ftbd.getName(), ftbd.getParentFile());
 611       } catch (Exception e)
 612       {
 613         Cache.error(
 614                 "Error when confirming to keep backup file newer than other backup files.");
 615         e.printStackTrace();
 616       }
 617       messageSB.append(MessageManager.formatMessage(
 618               "label.newerdelete_replacement_line", new String[]
 619               { ftbd.getName(), rf.getName(), ftbdLMT, rfLMT, ftbdSize,
 620                   rfSize }));
 621       // "Backup file\n''{0}''\t(modified {2}, size {4})\nis to be deleted and
 622       // replaced by apparently older file \n''{1}''\t(modified {3}, size
 623       // {5}).""
 624       messageSB.append("\n\n");
 625       messageSB.append(MessageManager.formatMessage(
 626               "label.confirm_deletion_or_rename", new String[]
 627               { ftbd.getName(), saveFile.getName() }));
 628       // "Confirm deletion of ''{0}'' or rename to ''{1}''?"
 629       String[] options = new String[] {
 630           MessageManager.getString("label.delete"),
 631           MessageManager.getString("label.rename") };
 632
 633       confirmButton = Platform.isHeadless() ? JvOptionPane.YES_OPTION
 634               : JvOptionPane.showOptionDialog(Desktop.desktop,
 635                       messageSB.toString(),
 636                       MessageManager.getString(
 637                               "label.backupfiles_confirm_delete"),
 638                       // "Confirm delete"
 639                       JvOptionPane.YES_NO_OPTION,
 640                       JvOptionPane.WARNING_MESSAGE, null, options,
 641                       options[0]);
 642     }
 643     else
 644     {
 645       messageSB.append(MessageManager
 646               .formatMessage("label.newerdelete_line", new String[]
 647               { ftbd.getName(), rf.getName(), ftbdLMT, rfLMT, ftbdSize,
 648                   rfSize }));
 649       // "Backup file\n''{0}''\t(modified {2}, size {4})\nis to be deleted but
 650       // is newer than the oldest remaining backup file \n''{1}''\t(modified
 651       // {3}, size {5})."
 652       messageSB.append("\n\n");
 653       messageSB.append(MessageManager
 654               .formatMessage("label.confirm_deletion", new String[]
 655               { ftbd.getName() }));
 656       // "Confirm deletion of ''{0}''?"
 657       String[] options = new String[] {
 658           MessageManager.getString("label.delete"),
 659           MessageManager.getString("label.keep") };
 660
 661       confirmButton = Platform.isHeadless() ? JvOptionPane.YES_OPTION
 662               : JvOptionPane.showOptionDialog(Desktop.desktop,
 663                       messageSB.toString(),
 664                       MessageManager.getString(
 665                               "label.backupfiles_confirm_delete"),
 666                       // "Confirm delete"
 667                       JvOptionPane.YES_NO_OPTION,
 668                       JvOptionPane.WARNING_MESSAGE, null, options,
 669                       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.desktop,
 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           Cache.trace("BACKUPFILES about to delete fileToDelete:"
 724                   + fileToDelete);
 725           fileToDelete.delete();
 726           Cache.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.desktop,
 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       Cache.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       Cache.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       Cache.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     Cache.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       Cache.trace("BACKUPFILES deleting " + newFile.getAbsolutePath());
 900       newFile.delete();
 901       Cache.trace("BACKUPFILES moving " + oldFile.getAbsolutePath() + " to "
 902               + newFile.getAbsolutePath());
 903       Files.move(oldPath, newPath, StandardCopyOption.REPLACE_EXISTING);
 904       ret = true;
 905       Cache.trace("BACKUPFILES move seems to have succeeded");
 906     } catch (IOException e)
 907     {
 908       Cache.warn("Could not move file '" + oldPath.toString() + "' to '"
 909               + newPath.toString() + "'");
 910       Cache.error(e.getMessage());
 911       Cache.debug(Cache.getStackTraceString(e));
 912       ret = false;
 913     } catch (Exception e)
 914     {
 915       Cache.error(e.getMessage());
 916       Cache.debug(Cache.getStackTraceString(e));
 917       ret = false;
 918     }
 919     return ret;
 920   }
 921 }