5 import java.util.concurrent.Callable;
6 import java.util.concurrent.CompletableFuture;
7 import java.util.concurrent.ExecutionException;
8 import java.util.concurrent.ExecutorService;
9 import java.util.concurrent.Executors;
10 import java.util.concurrent.TimeUnit;
11 import java.util.concurrent.TimeoutException;
13 import javax.swing.JButton;
14 import javax.swing.JFrame;
15 import javax.swing.JOptionPane;
16 import javax.swing.JTextPane;
18 import com.formdev.flatlaf.extras.FlatDesktop;
20 import jalview.api.AlignmentViewPanel;
21 import jalview.bin.Cache;
22 import jalview.bin.Console;
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.SequenceI;
25 import jalview.io.BackupFiles;
26 import jalview.project.Jalview2XML;
27 import jalview.util.MessageManager;
28 import jalview.util.Platform;
30 public class QuitHandler
32 private static final int MIN_WAIT_FOR_SAVE = 1000;
34 private static final int MAX_WAIT_FOR_SAVE = 20000;
36 private static boolean interactive = true;
38 public static enum QResponse
40 NULL, QUIT, CANCEL_QUIT, FORCE_QUIT
43 private static ExecutorService executor = Executors.newFixedThreadPool(3);
45 public static QResponse setQuitHandler()
47 FlatDesktop.setQuitHandler(response -> {
48 Callable<Void> performQuit = () -> {
49 response.performQuit();
50 setResponse(QResponse.QUIT);
53 Callable<Void> performForceQuit = () -> {
54 response.performQuit();
55 setResponse(QResponse.FORCE_QUIT);
58 Callable<Void> cancelQuit = () -> {
59 response.cancelQuit();
61 setResponse(QResponse.NULL);
64 getQuitResponse(true, performQuit, performForceQuit, cancelQuit);
67 return gotQuitResponse();
70 private static QResponse gotQuitResponse = QResponse.NULL;
72 protected static QResponse setResponse(QResponse qresponse)
74 gotQuitResponse = qresponse;
78 public static QResponse gotQuitResponse()
80 return gotQuitResponse;
83 public static final Callable<Void> defaultCancelQuit = () -> {
84 Console.debug("QuitHandler: (default) Quit action CANCELLED by user");
86 setResponse(QResponse.CANCEL_QUIT);
90 public static final Callable<Void> defaultOkQuit = () -> {
91 Console.debug("QuitHandler: (default) Quit action CONFIRMED by user");
92 setResponse(QResponse.QUIT);
96 public static final Callable<Void> defaultForceQuit = () -> {
97 Console.debug("QuitHandler: (default) Quit action FORCED by user");
98 // note that shutdown hook will not be run
99 Runtime.getRuntime().halt(0);
100 setResponse(QResponse.FORCE_QUIT); // this line never reached!
104 public static QResponse getQuitResponse(boolean ui)
106 return getQuitResponse(ui, defaultOkQuit, defaultForceQuit,
110 public static QResponse getQuitResponse(boolean ui, Callable<Void> okQuit,
111 Callable<Void> forceQuit, Callable<Void> cancelQuit)
113 QResponse got = gotQuitResponse();
114 if (got != QResponse.NULL && got != QResponse.CANCEL_QUIT)
116 // quit has already been selected, continue with calling quit method
120 interactive = ui && !Platform.isHeadless();
121 // confirm quit if needed and wanted
122 boolean confirmQuit = true;
126 Console.debug("Non interactive quit -- not confirming");
129 else if (Jalview2XML.allSavedUpToDate())
131 Console.debug("Nothing changed -- not confirming quit");
136 confirmQuit = jalview.bin.Cache
137 .getDefault(jalview.gui.Desktop.CONFIRM_KEYBOARD_QUIT, true);
138 Console.debug("Jalview property '"
139 + jalview.gui.Desktop.CONFIRM_KEYBOARD_QUIT
140 + "' is/defaults to " + confirmQuit + " -- "
141 + (confirmQuit ? "" : "not ") + "confirming quit");
143 got = confirmQuit ? QResponse.NULL : QResponse.QUIT;
148 JvOptionPane.newOptionDialog()
149 .setResponseHandler(JOptionPane.YES_OPTION, defaultOkQuit)
150 .setResponseHandler(JOptionPane.NO_OPTION, cancelQuit)
151 .showDialogOnTopAsync(
152 new StringBuilder(MessageManager
153 .getString("label.quit_jalview"))
155 .append(MessageManager
156 .getString("label.unsaved_changes"))
158 MessageManager.getString("action.quit"),
159 JOptionPane.YES_NO_OPTION,
160 JOptionPane.QUESTION_MESSAGE, null, new Object[]
161 { MessageManager.getString("action.quit"),
162 MessageManager.getString("action.cancel") },
163 MessageManager.getString("action.quit"), true);
166 got = gotQuitResponse();
167 boolean wait = false;
168 if (got == QResponse.CANCEL_QUIT)
171 Console.debug("Cancelling quit. Resetting response to NULL");
172 setResponse(QResponse.NULL);
174 return QResponse.CANCEL_QUIT;
176 else if (got == QResponse.QUIT)
178 if (Cache.getDefault("WAIT_FOR_SAVE", true)
179 && BackupFiles.hasSavesInProgress())
181 waitQuit(interactive, okQuit, forceQuit, cancelQuit);
182 QResponse waitResponse = gotQuitResponse();
183 wait = waitResponse == QResponse.QUIT;
187 Callable<Void> next = null;
188 switch (gotQuitResponse())
193 case FORCE_QUIT: // not actually an option at this stage
202 executor.submit(next).get();
203 got = gotQuitResponse();
204 } catch (InterruptedException | ExecutionException e)
207 .debug("Exception during quit handling (final choice)", e);
211 if (gotQuitResponse() == QResponse.CANCEL_QUIT)
213 // reset if cancelled
214 setResponse(QResponse.NULL);
215 return QResponse.CANCEL_QUIT;
217 return gotQuitResponse();
220 private static QResponse waitQuit(boolean interactive,
221 Callable<Void> okQuit, Callable<Void> forceQuit,
222 Callable<Void> cancelQuit)
224 // check for saves in progress
225 if (!BackupFiles.hasSavesInProgress())
226 return QResponse.QUIT;
229 AlignFrame[] afArray = Desktop.getAlignFrames();
230 if (!(afArray == null || afArray.length == 0))
232 for (int i = 0; i < afArray.length; i++)
234 AlignFrame af = afArray[i];
235 List<? extends AlignmentViewPanel> avpList = af.getAlignPanels();
236 for (AlignmentViewPanel avp : avpList)
238 AlignmentI a = avp.getAlignment();
239 List<SequenceI> sList = a.getSequences();
240 for (SequenceI s : sList)
242 size += s.getLength();
247 int waitTime = Math.min(MAX_WAIT_FOR_SAVE,
248 Math.max(MIN_WAIT_FOR_SAVE, size / 2));
249 Console.debug("Set waitForSave to " + waitTime);
252 boolean doIterations = true; // note iterations not used in the gui now,
253 // only one pass without the "Wait" button
254 while (doIterations && BackupFiles.hasSavesInProgress()
255 && iteration++ < (interactive ? 100 : 5))
257 // future that returns a Boolean when all files are saved
258 CompletableFuture<Boolean> filesAllSaved = new CompletableFuture<>();
260 // callback as each file finishes saving
261 for (CompletableFuture<Boolean> cf : BackupFiles
262 .savesInProgressCompletableFutures(false))
264 // if this is the last one then complete filesAllSaved
265 cf.whenComplete((ret, e) -> {
266 if (!BackupFiles.hasSavesInProgress())
268 filesAllSaved.complete(true);
274 filesAllSaved.get(waitTime, TimeUnit.MILLISECONDS);
275 } catch (InterruptedException | ExecutionException e1)
278 "Exception whilst waiting for files to save before quit",
280 } catch (TimeoutException e2)
282 // this Exception to be expected
285 if (interactive && BackupFiles.hasSavesInProgress())
287 boolean showForceQuit = iteration > 0; // iteration > 1 to not show
288 // force quit the first time
289 JFrame parent = new JFrame();
290 JButton[] buttons = { new JButton(), new JButton() };
291 JvOptionPane waitDialog = JvOptionPane.newOptionDialog();
292 JTextPane messagePane = new JTextPane();
293 messagePane.setBackground(waitDialog.getBackground());
294 messagePane.setBorder(null);
295 messagePane.setText(waitingForSaveMessage());
296 // callback as each file finishes saving
297 for (CompletableFuture<Boolean> cf : BackupFiles
298 .savesInProgressCompletableFutures(false))
300 cf.whenComplete((ret, e) -> {
301 if (BackupFiles.hasSavesInProgress())
303 // update the list of saving files as they save too
304 messagePane.setText(waitingForSaveMessage());
308 if (!(QuitHandler.gotQuitResponse() == QResponse.CANCEL_QUIT
309 || QuitHandler.gotQuitResponse() == QResponse.NULL))
311 for (int i = 0; i < buttons.length; i++)
313 Console.debug("DISABLING BUTTON " + buttons[i].getText());
314 buttons[i].setEnabled(false);
315 buttons[i].setVisible(false);
317 // if this is the last one then close the dialog
318 messagePane.setText(new StringBuilder()
319 .append(MessageManager.getString("label.all_saved"))
321 .append(MessageManager
322 .getString("label.quitting_bye"))
324 messagePane.setEditable(false);
328 } catch (InterruptedException e1)
341 options = new String[2];
342 options[0] = MessageManager.getString("action.force_quit");
343 options[1] = MessageManager.getString("action.cancel_quit");
344 dialogType = JOptionPane.YES_NO_OPTION;
345 waitDialog.setResponseHandler(JOptionPane.YES_OPTION, forceQuit)
346 .setResponseHandler(JOptionPane.NO_OPTION, cancelQuit);
350 options = new String[1];
351 options[0] = MessageManager.getString("action.cancel_quit");
352 dialogType = JOptionPane.YES_OPTION;
353 waitDialog.setResponseHandler(JOptionPane.YES_OPTION, cancelQuit);
355 waitDialog.showDialogOnTopAsync(parent, messagePane,
356 MessageManager.getString("label.wait_for_save"), dialogType,
357 JOptionPane.WARNING_MESSAGE, null, options,
358 MessageManager.getString("action.cancel_quit"), true,
362 final QResponse thisWaitResponse = gotQuitResponse();
363 switch (thisWaitResponse)
365 case QUIT: // wait -- do another iteration
368 doIterations = false;
371 doIterations = false;
373 case NULL: // already cancelled
374 doIterations = false;
378 } // end if interactive
380 } // end while wait iteration loop
381 return gotQuitResponse();
384 private static String waitingForSaveMessage()
386 StringBuilder messageSB = new StringBuilder();
388 messageSB.append(MessageManager.getString("label.save_in_progress"));
389 List<File> files = BackupFiles.savesInProgressFiles(false);
390 boolean any = files.size() > 0;
393 for (File file : files)
395 messageSB.append("\n\u2022 ").append(file.getName());
400 messageSB.append(MessageManager.getString("label.unknown"));
402 messageSB.append("\n\n")
403 .append(MessageManager.getString("label.quit_after_saving"));
404 return messageSB.toString();
407 public static void abortQuit()
409 setResponse(QResponse.CANCEL_QUIT);