Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Made change to alleviate a bug in a multiuser environment with one ... #1126

Merged
merged 3 commits into from
Apr 25, 2016
Merged

Made change to alleviate a bug in a multiuser environment with one ... #1126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c6356c
Made change to alleviate a bug in a multiuser environment with one ce…
Apr 6, 2016
688c667
Merge remote-tracking branch 'upstream/master' into SaveDatabase-Conc…
Apr 25, 2016
f8b7eb2
Cleaned up the SaveDatabaseAction.java according to the comments prov…
Apr 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ to [sourceforge feature requests](https://sourceforge.net/p/jabref/features/) by
- Swedish is added as a language option (still not a complete translation)

### Fixed
- Alleviate multiuser concurrency issue when near simultaneous saves occur to a shared database file
- Fixed [#318](https://github.com/JabRef/jabref/issues/318): Improve normalization of author names
- Fixed [#598](https://github.com/JabRef/jabref/issues/598) and [#402](https://github.com/JabRef/jabref/issues/402): No more issues with invalid icons for ExternalFileTypes in global search or after editing the settings
- Fixed [#883](https://github.com/JabRef/jabref/issues/883): No NPE during cleanup
Expand Down
128 changes: 76 additions & 52 deletions src/main/java/net/sf/jabref/exporter/SaveDatabaseAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/* Copyright (C) 2003-2015 JabRef contributors.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
Expand Down Expand Up @@ -75,58 +76,9 @@ public void init() throws Throwable {
saveAs();
} else {

// Check for external modifications:
if (panel.isUpdatedExternally() || Globals.fileUpdateMonitor.hasBeenModified(panel.getFileMonitorHandle())) {
String[] opts = new String[] {Localization.lang("Review changes"),
Localization.lang("Save"),
Localization.lang("Cancel")};
int answer = JOptionPane.showOptionDialog(panel.frame(),
Localization.lang("File has been updated externally. "
+ "What do you want to do?"),
Localization.lang("File updated externally"),
JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.QUESTION_MESSAGE,
null, opts, opts[0]);

if (answer == JOptionPane.CANCEL_OPTION) {
canceled = true;
return;
} else if (answer == JOptionPane.YES_OPTION) {
canceled = true;

JabRefExecutorService.INSTANCE.execute((Runnable) () -> {

if (!FileBasedLock.waitForFileLock(panel.getBibDatabaseContext().getDatabaseFile(), 10)) {
// TODO: GUI handling of the situation when the externally modified file keeps being locked.
LOGGER.error("File locked, this will be trouble.");
}

ChangeScanner scanner = new ChangeScanner(panel.frame(), panel,
panel.getBibDatabaseContext().getDatabaseFile());
JabRefExecutorService.INSTANCE.executeWithLowPriorityInOwnThreadAndWait(scanner);
if (scanner.changesFound()) {
scanner.displayResult((ChangeScanner.DisplayResultCallback) resolved -> {
if (resolved) {
panel.setUpdatedExternally(false);
SwingUtilities.invokeLater(
(Runnable) () -> panel.getSidePaneManager().hide("fileUpdate"));
} else {
canceled = true;
}
});
}
});

return;
} else { // User indicated to store anyway.
if (panel.getBibDatabaseContext().getMetaData().isProtected()) {
JOptionPane.showMessageDialog(frame, Localization.lang("Database is protected. Cannot save until external changes have been reviewed."),
Localization.lang("Protected database"), JOptionPane.ERROR_MESSAGE);
canceled = true;
} else {
panel.setUpdatedExternally(false);
panel.getSidePaneManager().hide("fileUpdate");
}
}
// Check for external modifications: if true, save not performed so do not tell the user a save is underway but return instead.
if (checkExternalModification()) {
return;
}

panel.frame().output(Localization.lang("Saving database") + "...");
Expand Down Expand Up @@ -168,6 +120,13 @@ public void run() {
panel.autoGenerateKeysBeforeSaving();

if (FileBasedLock.waitForFileLock(panel.getBibDatabaseContext().getDatabaseFile(), 10)) {
// Check for external modifications to alleviate multiuser concurrency issue when near
// simultaneous saves occur to a shared database file: if true, do not perform the save
// rather return instead.
if (checkExternalModification()) {
return;
}

// Save the database:
success = saveDatabase(panel.getBibDatabaseContext().getDatabaseFile(), false, panel.getEncoding());

Expand Down Expand Up @@ -399,4 +358,69 @@ public boolean isSuccess() {
public boolean isCanceled() {
return canceled;
}

/**
* Check whether or not the external database has been modified. If so need to alert the user to accept external updates prior to
* saving the database. This is necessary to avoid overwriting other users work when using a multiuser database file.
*
* @return true if the external database file has been modified and the user must choose to accept the changes and false if no modifications
* were found or there is no requested protection for the database file.
*/
private boolean checkExternalModification() {
// Check for external modifications:
if (panel.isUpdatedExternally() || Globals.fileUpdateMonitor.hasBeenModified(panel.getFileMonitorHandle())) {
String[] opts = new String[] {Localization.lang("Review changes"), Localization.lang("Save"),
Localization.lang("Cancel")};
int answer = JOptionPane.showOptionDialog(panel.frame(),
Localization.lang("File has been updated externally. " + "What do you want to do?"),
Localization.lang("File updated externally"), JOptionPane.YES_NO_CANCEL_OPTION,
JOptionPane.QUESTION_MESSAGE, null, opts, opts[0]);

if (answer == JOptionPane.CANCEL_OPTION) {
canceled = true;
return true;
} else if (answer == JOptionPane.YES_OPTION) {
canceled = true;

JabRefExecutorService.INSTANCE.execute((Runnable) () -> {

if (!FileBasedLock.waitForFileLock(panel.getBibDatabaseContext().getDatabaseFile(), 10)) {
// TODO: GUI handling of the situation when the externally modified file keeps being locked.
LOGGER.error("File locked, this will be trouble.");
}

ChangeScanner scanner = new ChangeScanner(panel.frame(), panel,
panel.getBibDatabaseContext().getDatabaseFile());
JabRefExecutorService.INSTANCE.executeWithLowPriorityInOwnThreadAndWait(scanner);
if (scanner.changesFound()) {
scanner.displayResult((ChangeScanner.DisplayResultCallback) resolved -> {
if (resolved) {
panel.setUpdatedExternally(false);
SwingUtilities
.invokeLater((Runnable) () -> panel.getSidePaneManager().hide("fileUpdate"));
} else {
canceled = true;
}
});
}
});

return true;
} else { // User indicated to store anyway.
if (panel.getBibDatabaseContext().getMetaData().isProtected()) {
JOptionPane.showMessageDialog(frame,
Localization
.lang("Database is protected. Cannot save until external changes have been reviewed."),
Localization.lang("Protected database"), JOptionPane.ERROR_MESSAGE);
canceled = true;
} else {
panel.setUpdatedExternally(false);
panel.getSidePaneManager().hide("fileUpdate");
}
}
}

// Return false as either no external database file modifications have been found or overwrite is requested any way
return false;
}
}