3 import jalview.bin.Cache;
4 import jalview.gui.Desktop;
5 import jalview.gui.JvOptionPane;
6 import jalview.util.MessageManager;
9 import java.io.IOException;
10 import java.util.Arrays;
11 import java.util.HashMap;
12 import java.util.TreeMap;
15 * BackupFiles used for manipulating (naming rolling/deleting) backup/version files when an alignment or project file is saved.
16 * User configurable options are:
17 * BACKUPFILES_ENABLED - boolean flag as to whether to use this mechanism or act as before, including overwriting files as saved.
18 * BACKUPFILES_SUFFIX - a template to insert just before the file extension. Use '%n' to be replaced by a 0-led SUFFIX_DIGITS long integer.
19 * BACKUPFILES_NO_MAX - flag to turn off setting a maximum number of backup files to keep.
20 * BACKUPFILES_ROLL_MAX - the maximum number of backupfiles to keep for any one alignment or project file.
21 * BACKUPFILES_SUFFIX_DIGITS - the number of digits to insert replace %n with (e.g. BACKUPFILES_SUFFIX_DIGITS = 3 would make "001", "002", etc)
22 * BACKUPFILES_REVERSE_ORDER - if true then "logfile" style numbering and file rolling will occur. If false then ever-increasing version numbering will occur, but old files will still be deleted if there are more than ROLL_MAX backup files.
23 * BACKUPFILES_CONFIRM_DELETE_OLD - if true then prompt/confirm with the user when deleting older backup/version files.
26 public class BackupFiles
29 // labels for saved params in Cache and .jalview_properties
30 private static String NS = "BACKUPFILES";
32 public static String ENABLED = NS + "_ENABLED";
34 public static String SUFFIX = NS + "_SUFFIX";
36 public static String NO_MAX = NS + "_NO_MAX";
38 public static String ROLL_MAX = NS + "_ROLL_MAX";
40 public static String SUFFIX_DIGITS = NS + "_SUFFIX_DIGITS";
42 protected static String NUM_PLACEHOLDER = "%n";
44 public static String REVERSE_ORDER = NS + "_REVERSE_ORDER";
46 public static String CONFIRM_DELETE_OLD = NS + "_CONFIRM_DELETE_OLD";
48 private static String DEFAULT_TEMP_FILE = "jalview_temp_file_" + NS;
50 // file - File object to be backed up and then updated (written over)
53 // enabled - default flag as to whether to do the backup file roll (if not
54 // defined in preferences)
55 private static boolean enabled;
57 // confirmDelete - default flag as to whether to confirm with the user before
58 // deleting old backup/version files
59 private static boolean confirmDelete;
61 private static boolean classInit = false;
63 // defaultSuffix - default template to use to append to basename of file
64 private String suffix;
66 // noMax - flag to turn off a maximum number of files
67 private boolean noMax;
69 // defaultMax - default max number of backup files
72 // defaultDigits - number of zero-led digits to use in the filename
75 // reverseOrder - set to true to make newest (latest) files lowest number
76 // (like rolled log files)
77 private boolean reverseOrder;
79 // temp saved file to become new saved file
80 private File tempFile;
82 // flag set to see if file save to temp file was successful
83 private boolean tempFileWriteSuccess;
85 public BackupFiles(String filename)
87 this(new File(filename));
90 // first time defaults for SUFFIX, NO_MAX, ROLL_MAX, SUFFIX_DIGITS and
92 public BackupFiles(File file)
94 this(file, "-v" + NUM_PLACEHOLDER, false, 4, 3, false);
97 public BackupFiles(File file,
98 String defaultSuffix, boolean defaultNoMax, int defaultMax,
100 boolean defaultReverseOrder)
104 this.suffix = Cache.getDefault(SUFFIX, defaultSuffix);
105 this.noMax = Cache.getDefault(NO_MAX, defaultNoMax);
106 this.max = Cache.getDefault(ROLL_MAX, defaultMax);
107 this.digits = Cache.getDefault(SUFFIX_DIGITS, defaultDigits);
108 this.reverseOrder = Cache.getDefault(REVERSE_ORDER,
109 defaultReverseOrder);
111 // create a temp file to save new data in
117 String tempfilename = file.getName();
118 File tempdir = file.getParentFile();
119 temp = File.createTempFile(tempfilename, ".tmp", tempdir);
123 temp = File.createTempFile(DEFAULT_TEMP_FILE, ".tmp");
125 } catch (IOException e)
128 "Could not create temp file to save into (IOException)");
129 } catch (Exception e)
131 System.out.println("Exception ctreating temp file for saving");
133 this.setTempFile(temp);
136 public static void classInit()
140 setEnabled(Cache.getDefault(ENABLED, true));
141 setConfirmDelete(Cache.getDefault(CONFIRM_DELETE_OLD, true));
146 public static void setEnabled(boolean flag)
151 public static boolean getEnabled()
157 public static void setConfirmDelete(boolean flag)
159 confirmDelete = flag;
162 public static boolean getConfirmDelete()
165 return confirmDelete;
168 // set, get and rename temp file into place
169 public void setTempFile(File temp)
171 this.tempFile = temp;
174 public File getTempFile()
179 public String getTempFilePath()
184 path = this.getTempFile().getCanonicalPath();
185 } catch (IOException e)
188 "IOException when getting Canonical Path of temp file '"
189 + this.getTempFile().getName() + "'");
194 public static String getNumPlaceHolder()
196 return NUM_PLACEHOLDER;
199 public boolean setWriteSuccess(boolean flag)
201 boolean old = this.tempFileWriteSuccess;
202 this.tempFileWriteSuccess = flag;
206 public boolean getWriteSuccess()
208 return this.tempFileWriteSuccess;
211 public boolean renameTempFile()
213 return tempFile.renameTo(file);
217 // roll the backupfiles
218 public boolean rollBackupFiles()
221 // file doesn't yet exist or backups are not enabled
222 if ((!file.exists()) || (!enabled) || (max < 0))
228 // split filename up to insert suffix template in the right place. template
229 // and backupMax can be set in .jalview_properties
234 dirFile = file.getParentFile();
235 dir = dirFile.getCanonicalPath();
236 } catch (Exception e)
239 "Could not get canonical path for file '" + file + "'");
242 String filename = file.getName();
243 String basename = filename;
244 String extension = "";
245 int dotcharpos = filename.lastIndexOf('.');
246 // don't split of filenames with the last '.' at the very beginning or
247 // very end of the filename
248 if ((dotcharpos > 0) && (dotcharpos < filename.length() - 1))
250 basename = filename.substring(0, dotcharpos);
251 extension = filename.substring(dotcharpos); // NOTE this includes the '.'
255 // Create/move backups up one
257 File[] oldFilesToDelete = null;
259 // find existing backup files
260 BackupFilenameFilter bff = new BackupFilenameFilter(basename, suffix,
263 File[] backupFiles = dirFile.listFiles(bff);
264 int nextIndexNum = 0;
265 String confirmDeleteExtraInfo = null;
267 if (backupFiles.length == 0)
269 // No other backup files. Just need to move existing file to backupfile_1
275 // sort the backup files (based on integer found in the suffix) using a
276 // precomputed Hashmap for speed
277 HashMap<Integer, File> bfHashMap = new HashMap<>();
278 for (int i = 0; i < backupFiles.length; i++)
280 File f = backupFiles[i];
281 BackupFilenameParts bfp = new BackupFilenameParts(f, basename, suffix, digits, extension);
282 bfHashMap.put(bfp.indexNum(), f);
284 TreeMap<Integer, File> bfTreeMap = new TreeMap<>();
285 bfTreeMap.putAll(bfHashMap);
289 // backup style numbering
291 File lastfile = null;
292 int tempMax = noMax ? -1 : max;
293 // noMax == true means no limits
294 // look for first "gap" in backupFiles
295 // if tempMax is -1 at this stage just keep going until there's a gap,
296 // then hopefully tempMax gets set to the right index (a positive
297 // integer so the loop breaks)...
298 // why do I feel a little uneasy about this loop?..
299 for (int i = 1; tempMax < 0 || i <= max; i++)
301 if (!bfTreeMap.containsKey(i)) // first index without existent
308 // for (int m = 0; m < tempMax; m++)
309 for (int n = tempMax; n > 0; n--)
311 // int n = tempMax - m;
312 String backupfilename = dir + File.separatorChar
313 + BackupFilenameFilter.getBackupFilename(n, basename,
314 suffix, digits, extension);
315 File backupfile_n = new File(backupfilename);
317 if (!backupfile_n.exists())
319 lastfile = backupfile_n;
323 // if (m == 0 && backupfile_n.exists())
324 if ((!noMax) && n == tempMax && backupfile_n.exists())
326 // move the largest (max) rolled file to a temp file and add to the delete list
329 File temp = File.createTempFile(backupfilename, ".tmp",
331 backupfile_n.renameTo(temp);
333 oldFilesToDelete = new File[] { temp };
334 confirmDeleteExtraInfo = "(was " + backupfile_n.getName()
336 } catch (IOException e)
339 "IOException when creating temporary file for backupfilename");
345 if (lastfile != null)
347 ret = ret && backupfile_n.renameTo(lastfile);
351 lastfile = backupfile_n;
354 // index to use for the latest backup
359 // version style numbering (with earliest file deletion if max files
363 bfTreeMap.values().toArray(backupFiles);
365 // noMax == true means keep all backup files
366 if ((!noMax) && bfTreeMap.size() >= max)
368 // need to delete some files to keep number of backups to designated
370 int numToDelete = bfTreeMap.size() - max + 1;
371 oldFilesToDelete = Arrays.copyOfRange(backupFiles, 0,
376 nextIndexNum = bfTreeMap.lastKey() + 1;
381 if (oldFilesToDelete != null && oldFilesToDelete.length > 0)
383 // delete old backup/version files
385 boolean delete = false;
388 // Object[] confirmMessageArray = {};
389 StringBuilder confirmMessage = new StringBuilder();
390 confirmMessage.append(MessageManager
391 .getString("label.backupfiles_confirm_delete_old_files"));
392 for (File f : oldFilesToDelete)
394 confirmMessage.append("\n");
395 confirmMessage.append(f.getName());
397 if (confirmDeleteExtraInfo != null
398 && confirmDeleteExtraInfo.length() > 0)
400 confirmMessage.append("\n");
401 confirmMessage.append(confirmDeleteExtraInfo);
403 int confirm = JvOptionPane.showConfirmDialog(Desktop.desktop,
404 confirmMessage.toString(),
406 .getString("label.backupfiles_confirm_delete"),
407 JvOptionPane.YES_NO_OPTION, JvOptionPane.WARNING_MESSAGE);
409 delete = (confirm == JvOptionPane.YES_OPTION);
418 for (int i = 0; i < oldFilesToDelete.length; i++)
420 File fileToDelete = oldFilesToDelete[i];
421 fileToDelete.delete();
422 // System.out.println("DELETING '" + fileToDelete.getName() +
429 // Let's make the new backup file!! yay, got there at last!
430 String latestBackupFilename = dir + File.separatorChar
431 + BackupFilenameFilter.getBackupFilename(nextIndexNum, basename,
432 suffix, digits, extension);
433 File latestBackupFile = new File(latestBackupFilename);
434 ret = ret && file.renameTo(latestBackupFile);
439 public boolean rollBackupsAndRenameTempFile()
441 boolean write = this.getWriteSuccess();
443 boolean roll = false;
445 roll = this.rollBackupFiles();
451 * Not sure that this confirmation is desirable. By this stage the new file is
452 * already written successfully, but something (e.g. disk full) has happened while
453 * trying to roll the backup files, and most likely the filename needed will already
454 * be vacant so renaming the temp file is nearly always correct!
458 int confirm = JvOptionPane.showConfirmDialog(Desktop.desktop,
459 MessageManager.getString(
460 "label.backupfiles_confirm_save_file_backupfiles_roll_wrong"),
461 MessageManager.getString("label.backupfiles_confirm_save_file"),
462 JvOptionPane.YES_NO_OPTION, JvOptionPane.WARNING_MESSAGE);
464 if (confirm == JvOptionPane.YES_OPTION)
470 boolean rename = false;
473 rename = this.renameTempFile();