// License: GPL. See LICENSE file for details.
package org.openstreetmap.josm.actions.upload;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.Dimension;
import java.awt.GridBagLayout;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.data.APIDataSet;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.validation.OsmValidator;
import org.openstreetmap.josm.data.validation.Severity;
import org.openstreetmap.josm.data.validation.Test;
import org.openstreetmap.josm.data.validation.TestError;
import org.openstreetmap.josm.data.validation.util.AggregatePrimitivesVisitor;
import org.openstreetmap.josm.gui.ExtendedDialog;
import org.openstreetmap.josm.gui.dialogs.validator.ValidatorTreePanel;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.gui.preferences.validator.ValidatorPreference;
import org.openstreetmap.josm.gui.widgets.HtmlPanel;
import org.openstreetmap.josm.tools.GBC;
/**
* The action that does the validate thing.
* <p>
* This action iterates through all active tests and give them the data, so that
* each one can test it.
*
* @author frsantos
* @since 3669
*/
public class ValidateUploadHook implements UploadHook {
/**
* Validate the modified data before uploading
*/
@Override
public boolean checkUpload(APIDataSet apiDataSet) {
OsmValidator.initializeTests();
Collection<Test> tests = OsmValidator.getEnabledTests(true);
if (tests.isEmpty())
return true;
AggregatePrimitivesVisitor v = new AggregatePrimitivesVisitor();
v.visit(apiDataSet.getPrimitivesToAdd());
Collection<OsmPrimitive> selection = v.visit(apiDataSet.getPrimitivesToUpdate());
List<TestError> errors = new ArrayList<>(30);
for (Test test : tests) {
test.setBeforeUpload(true);
test.setPartialSelection(true);
test.startTest(null);
test.visit(selection);
test.endTest();
if (ValidatorPreference.PREF_OTHER.get() &&
Main.pref.getBoolean(ValidatorPreference.PREF_OTHER_UPLOAD, false)) {
errors.addAll(test.getErrors());
} else {
for (TestError e : test.getErrors()) {
if (e.getSeverity() != Severity.OTHER) {
errors.add(e);
}
}
}
}
tests = null;
OsmDataLayer editLayer = Main.main.getEditLayer();
editLayer.validationErrors.clear();
editLayer.validationErrors.addAll(errors);
Main.map.validatorDialog.tree.setErrors(errors);
if (errors == null || errors.isEmpty())
return true;
if (Main.pref.getBoolean(ValidatorPreference.PREF_USE_IGNORE, true)) {
int nume = 0;
for (TestError error : errors) {
List<String> s = new ArrayList<>();
s.add(error.getIgnoreState());
s.add(error.getIgnoreGroup());
s.add(error.getIgnoreSubGroup());
for (String state : s) {
if (state != null && OsmValidator.hasIgnoredError(state)) {
error.setIgnored(true);
}
}
if (!error.getIgnored()) {
++nume;
}
}
if (nume == 0)
return true;
}
return displayErrorScreen(errors);
}
/**
* Displays a screen where the actions that would be taken are displayed and
* give the user the possibility to cancel the upload.
* @param errors The errors displayed in the screen
* @return <code>true</code>, if the upload should continue. <code>false</code>
* if the user requested cancel.
*/
private boolean displayErrorScreen(List<TestError> errors) {
JPanel p = new JPanel(new GridBagLayout());
ValidatorTreePanel errorPanel = new ValidatorTreePanel(errors);
errorPanel.expandAll();
HtmlPanel pnlMessage = new HtmlPanel();
pnlMessage.setText("<html><body>"
+ tr("The following are results of automatic validation. Try fixing"
+ " these, but be careful (don''t destroy valid data)."
+ " When in doubt ignore them.<br>When you"
+ " cancel this dialog, you can find the entries in the validator"
+ " side panel to inspect them.")
+ "<table align=\"center\">"
+ "<tr><td align=\"left\"><b>"+tr("Errors")
+ " </b></td><td align=\"left\">"
+ tr("Usually this should be fixed.")+"</td></tr>"
+ "<tr><td align=\"left\"><b>"+tr("Warnings")
+ " </b></td><td align=\"left\">"
+ tr("Fix these when possible.")+"</td></tr>"
+ "<tr><td align=\"left\"><b>"+tr("Other")
+ " </b></td><td align=\"left\">"
+ tr("Informational warnings, expect many false entries.")+"</td></tr>"
+ "</table>"
);
pnlMessage.setPreferredSize(new Dimension(500, 150));
p.add(pnlMessage, GBC.eol().fill(GBC.HORIZONTAL));
p.add(new JScrollPane(errorPanel), GBC.eol().fill(GBC.BOTH));
ExtendedDialog ed = new ExtendedDialog(Main.parent,
tr("Suspicious data found. Upload anyway?"),
new String[] {tr("Continue upload"), tr("Cancel")});
ed.setButtonIcons(new String[] {"ok.png", "cancel.png"});
ed.setContent(p);
ed.showDialog();
if (ed.getValue() != 1) {
OsmValidator.initializeTests();
OsmValidator.initializeErrorLayer();
Main.map.validatorDialog.unfurlDialog();
Main.main.getCurrentDataSet().fireSelectionChanged();
return false;
}
return true;
}
}