// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.io;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.util.Collection;
import java.util.Collections;
import java.util.Objects;
import javax.swing.JLabel;
import javax.swing.text.JTextComponent;
import org.openstreetmap.josm.data.osm.BBox;
import org.openstreetmap.josm.data.osm.IPrimitive;
import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
import org.openstreetmap.josm.spi.preferences.Config;
import org.openstreetmap.josm.tools.Utils;
/**
* Input validators for {@link UploadDialog}
*/
abstract class UploadTextComponentValidator extends AbstractTextComponentValidator {
private final JLabel feedback;
protected boolean uploadRejected;
UploadTextComponentValidator(JTextComponent tc, JLabel feedback) {
super(tc);
this.feedback = feedback;
this.feedback.setOpaque(true);
validate();
}
@Override
protected void feedbackValid(String msg) {
msg = msg != null ? "\u2714 " + msg : null;
super.feedbackValid(msg);
if (!Objects.equals(msg, feedback.getText())) {
feedback.setText(msg);
feedback.setForeground(VALID_COLOR);
feedback.setBackground(null);
feedback.setBorder(null);
}
}
@Override
protected void feedbackWarning(String msg) {
msg = msg != null ? "" + msg : null;
super.feedbackWarning(msg);
if (!Objects.equals(msg, feedback.getText())) {
feedback.setText(msg);
feedback.setForeground(WARNING_FOREGROUND);
feedback.setBackground(WARNING_BACKGROUND);
feedback.setBorder(WARNING_BORDER);
}
}
@Override
public boolean isValid() {
throw new UnsupportedOperationException();
}
/**
* Determines if the input validator considers the violation bad enough to reject upload.
* @return {@code true} if the input validator considers the violation bad enough to reject upload
* @since 17238
*/
public final boolean isUploadRejected() {
return uploadRejected;
}
/**
* Validator for the changeset {@code comment} tag
*/
static class UploadCommentValidator extends UploadTextComponentValidator {
UploadCommentValidator(JTextComponent tc, JLabel feedback) {
super(tc, feedback);
}
@Override
public void validate() {
if (!Config.getPref().getBoolean("message.upload_comment_is_empty_or_very_short", true)) {
feedbackDisabled();
return;
}
final String uploadComment = getComponent().getText();
final String rejection = UploadDialog.UploadAction.validateUploadTag(uploadComment, "upload.comment",
Collections.emptyList(), Collections.emptyList(), Collections.emptyList());
// Reject the upload if tags are required and are not in the input. If the tags exist or are not
// required, then check the length of the input and warn if it's too short (a short msg is not a rejection)
uploadRejected = rejection != null;
if (uploadRejected) {
feedbackWarning(tr("Your upload comment is rejected.") + "
" + rejection);
} else if (UploadDialog.UploadAction.isUploadCommentTooShort(uploadComment)) {
feedbackWarning(tr("Your upload comment is empty, or very short.
" +
"This is technically allowed, but please consider that many users who are
" +
"watching changes in their area depend on meaningful changeset comments
" +
"to understand what is going on!
" +
"If you spend a minute now to explain your change, you will make life
" +
"easier for many other mappers.").replace("
", " "));
} else {
feedbackValid(tr("Thank you for providing a changeset comment! " +
"This gives other mappers a better understanding of your intent."));
}
}
}
/**
* Validator for the changeset {@code source} tag
*/
static class UploadSourceValidator extends UploadTextComponentValidator {
UploadSourceValidator(JTextComponent tc, JLabel feedback) {
super(tc, feedback);
}
@Override
public void validate() {
if (!Config.getPref().getBoolean("message.upload_source_is_empty", true)) {
feedbackDisabled();
return;
}
final String uploadSource = getComponent().getText();
final String rejection = UploadDialog.UploadAction.validateUploadTag(
uploadSource, "upload.source", Collections.emptyList(), Collections.emptyList(), Collections.emptyList());
// Reject the upload only if tags are required and are not in the input. If the tags exist or are not
// required, then check the length of the input and warn if it's too short (a short msg is not a rejection)
uploadRejected = rejection != null;
if (uploadRejected) {
feedbackWarning(tr("Your changeset source is rejected.") + "
" + rejection);
} else if (Utils.isStripEmpty(uploadSource)) {
feedbackWarning(tr("You did not specify a source for your changes.
" +
"It is technically allowed, but this information helps
" +
"other users to understand the origins of the data.
" +
"If you spend a minute now to explain your change, you will make life
" +
"easier for many other mappers.").replace("
", " "));
} else {
feedbackValid(tr("Thank you for providing the data source!"));
}
}
}
/**
* Validator for the changeset area
*/
static class UploadAreaValidator extends UploadTextComponentValidator {
private double area = Double.NaN;
UploadAreaValidator(JTextComponent tc, JLabel feedback) {
super(tc, feedback);
}
void computeArea(Collection primitives) {
this.area = primitives.stream()
.map(IPrimitive::getBBox)
.reduce(new BBox(), (b1, b2) -> {
b1.add(b2);
return b1;
}).area();
validate();
}
@Override
public void validate() {
if (Double.isFinite(area) && area <= Config.getPref().getDouble("upload.max-area", 3.)) {
feedbackValid(null);
} else {
feedbackWarning(tr("The bounding box of this changeset is very large – please consider splitting your changes!"));
}
}
}
}