* Mainly handles conflicts and certain error situations. */ public abstract class AbstractUploadTask extends PleaseWaitRunnable { private static final String CANCEL_TR = marktr("Cancel"); private static final String CANCEL = "cancel"; private static final String UPDATE_DATA = "updatedata"; /** * Constructs a new {@code AbstractUploadTask}. * @param title message for the user * @param ignoreException If true, exception will be silently ignored. If false then * exception will be handled by showing a dialog. When this runnable is executed using executor framework * then use false unless you read result of task (because exception will get lost if you don't) */ protected AbstractUploadTask(String title, boolean ignoreException) { super(title, ignoreException); } /** * Constructs a new {@code AbstractUploadTask}. * @param title message for the user * @param progressMonitor progress monitor * @param ignoreException If true, exception will be silently ignored. If false then * exception will be handled by showing a dialog. When this runnable is executed using executor framework * then use false unless you read result of task (because exception will get lost if you don't) */ protected AbstractUploadTask(String title, ProgressMonitor progressMonitor, boolean ignoreException) { super(title, progressMonitor, ignoreException); } /** * Constructs a new {@code AbstractUploadTask}. * @param title message for the user */ protected AbstractUploadTask(String title) { super(title); } /** * Synchronizes the local state of an {@link OsmPrimitive} with its state on the * server. The method uses an individual GET for the primitive. * @param type the primitive type * @param id the primitive ID */ protected void synchronizePrimitive(final OsmPrimitiveType type, final long id) { // FIXME: should now about the layer this task is running for. might // be different from the current edit layer OsmDataLayer layer = MainApplication.getLayerManager().getEditLayer(); if (layer == null) throw new IllegalStateException(tr("Failed to update primitive with id {0} because current edit layer is null", id)); OsmPrimitive p = layer.data.getPrimitiveById(id, type); if (p == null) throw new IllegalStateException( tr("Failed to update primitive with id {0} because current edit layer does not include such a primitive", id)); MainApplication.worker.execute(new UpdatePrimitivesTask(layer, Collections.singleton(p))); } /** * Synchronizes the local state of the dataset with the state on the server. *
* Reuses the functionality of {@link UpdateDataAction}.
*
* @see UpdateDataAction#actionPerformed(ActionEvent)
*/
protected void synchronizeDataSet() {
UpdateDataAction act = new UpdateDataAction();
act.actionPerformed(new ActionEvent(this, 0, ""));
}
/**
* Handles the case that a conflict in a specific {@link OsmPrimitive} was detected while
* uploading
*
* @param primitiveType the type of the primitive, either node, way or
* relation
* @param id the id of the primitive
* @param serverVersion the version of the primitive on the server
* @param myVersion the version of the primitive in the local dataset
*/
protected void handleUploadConflictForKnownConflict(final OsmPrimitiveType primitiveType, final long id, String serverVersion,
String myVersion) {
String lbl;
switch (primitiveType) {
// CHECKSTYLE.OFF: SingleSpaceSeparator
case NODE: lbl = tr("Synchronize node {0} only", id); break;
case WAY: lbl = tr("Synchronize way {0} only", id); break;
case RELATION: lbl = tr("Synchronize relation {0} only", id); break;
// CHECKSTYLE.ON: SingleSpaceSeparator
default: throw new AssertionError();
}
ButtonSpec[] spec = {
new ButtonSpec(
lbl,
new ImageProvider(UPDATE_DATA),
null, null),
new ButtonSpec(
tr("Synchronize entire dataset"),
new ImageProvider(UPDATE_DATA),
null, null),
new ButtonSpec(
tr(CANCEL_TR),
new ImageProvider(CANCEL),
null, null)
};
String msg = tr("Uploading failed because the server has a newer version of one
"
+ "of your nodes, ways, or relations.
"
+ "The conflict is caused by the {0} with id {1},
"
+ "the server has version {2}, your version is {3}.
"
+ "
"
+ "Click {4} to synchronize the conflicting primitive only.
"
+ "Click {5} to synchronize the entire local dataset with the server.
"
+ "Click {6} to abort and continue editing.
",
tr(primitiveType.getAPIName()), id, serverVersion, myVersion,
spec[0].text, spec[1].text, spec[2].text
);
int ret = HelpAwareOptionPane.showOptionDialog(
MainApplication.getMainFrame(),
msg,
tr("Conflicts detected"),
JOptionPane.ERROR_MESSAGE,
null,
spec,
spec[0],
"/Concepts/Conflict"
);
switch (ret) {
case 0: synchronizePrimitive(primitiveType, id); break;
case 1: synchronizeDataSet(); break;
default: // Do nothing (just return)
}
}
/**
* Handles the case that a conflict was detected while uploading where we don't
* know what {@link OsmPrimitive} actually caused the conflict (for whatever reason)
*
*/
protected void handleUploadConflictForUnknownConflict() {
ButtonSpec[] spec = {
new ButtonSpec(
tr("Synchronize entire dataset"),
new ImageProvider(UPDATE_DATA),
null, null),
new ButtonSpec(
tr(CANCEL_TR),
new ImageProvider(CANCEL),
null, null)
};
String msg = tr("Uploading failed because the server has a newer version of one
"
+ "of your nodes, ways, or relations.
"
+ "
"
+ "Click {0} to synchronize the entire local dataset with the server.
"
+ "Click {1} to abort and continue editing.
",
spec[0].text, spec[1].text
);
int ret = HelpAwareOptionPane.showOptionDialog(
MainApplication.getMainFrame(),
msg,
tr("Conflicts detected"),
JOptionPane.ERROR_MESSAGE,
null,
spec,
spec[0],
ht("/Concepts/Conflict")
);
if (ret == 0) {
synchronizeDataSet();
}
}
/**
* Handles the case that a conflict was detected while uploading where we don't
* know what {@link OsmPrimitive} actually caused the conflict (for whatever reason)
* @param changesetId changeset ID
* @param d changeset date
*/
protected void handleUploadConflictForClosedChangeset(long changesetId, Instant d) {
String msg = tr("Uploading failed because you have been using
"
+ "changeset {0} which was already closed at {1}.
"
+ "Please upload again with a new or an existing open changeset.",
changesetId, DateUtils.getDateTimeFormatter(FormatStyle.SHORT, FormatStyle.SHORT).format(d)
);
JOptionPane.showMessageDialog(
MainApplication.getMainFrame(),
msg,
tr("Changeset closed"),
JOptionPane.ERROR_MESSAGE
);
}
/**
* Handles the case where deleting a node failed because it is still in use in
* a non-deleted way on the server.
* @param e exception
* @param conflict conflict
*/
protected void handleUploadPreconditionFailedConflict(OsmApiException e, Pair