001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.actions.upload; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.Dimension; 007import java.awt.GridBagLayout; 008import java.util.ArrayList; 009import java.util.Collection; 010import java.util.List; 011 012import javax.swing.JPanel; 013import javax.swing.JScrollPane; 014 015import org.openstreetmap.josm.Main; 016import org.openstreetmap.josm.data.APIDataSet; 017import org.openstreetmap.josm.data.osm.OsmPrimitive; 018import org.openstreetmap.josm.data.validation.OsmValidator; 019import org.openstreetmap.josm.data.validation.Severity; 020import org.openstreetmap.josm.data.validation.Test; 021import org.openstreetmap.josm.data.validation.TestError; 022import org.openstreetmap.josm.data.validation.util.AggregatePrimitivesVisitor; 023import org.openstreetmap.josm.gui.ExtendedDialog; 024import org.openstreetmap.josm.gui.dialogs.validator.ValidatorTreePanel; 025import org.openstreetmap.josm.gui.layer.OsmDataLayer; 026import org.openstreetmap.josm.gui.preferences.validator.ValidatorPreference; 027import org.openstreetmap.josm.gui.widgets.HtmlPanel; 028import org.openstreetmap.josm.tools.GBC; 029 030/** 031 * The action that does the validate thing. 032 * <p> 033 * This action iterates through all active tests and give them the data, so that 034 * each one can test it. 035 * 036 * @author frsantos 037 * @since 3669 038 */ 039public class ValidateUploadHook implements UploadHook { 040 041 /** 042 * Validate the modified data before uploading 043 */ 044 @Override 045 public boolean checkUpload(APIDataSet apiDataSet) { 046 047 OsmValidator.initializeTests(); 048 Collection<Test> tests = OsmValidator.getEnabledTests(true); 049 if (tests.isEmpty()) 050 return true; 051 052 AggregatePrimitivesVisitor v = new AggregatePrimitivesVisitor(); 053 v.visit(apiDataSet.getPrimitivesToAdd()); 054 Collection<OsmPrimitive> selection = v.visit(apiDataSet.getPrimitivesToUpdate()); 055 056 List<TestError> errors = new ArrayList<>(30); 057 for (Test test : tests) { 058 test.setBeforeUpload(true); 059 test.setPartialSelection(true); 060 test.startTest(null); 061 test.visit(selection); 062 test.endTest(); 063 if (ValidatorPreference.PREF_OTHER.get() && ValidatorPreference.PREF_OTHER_UPLOAD.get()) { 064 errors.addAll(test.getErrors()); 065 } else { 066 for (TestError e : test.getErrors()) { 067 if (e.getSeverity() != Severity.OTHER) { 068 errors.add(e); 069 } 070 } 071 } 072 } 073 OsmDataLayer editLayer = Main.getLayerManager().getEditLayer(); 074 if (editLayer != null) { 075 editLayer.validationErrors.clear(); 076 editLayer.validationErrors.addAll(errors); 077 } 078 if (Main.map != null) { 079 Main.map.validatorDialog.tree.setErrors(errors); 080 } 081 if (errors.isEmpty()) 082 return true; 083 084 if (ValidatorPreference.PREF_USE_IGNORE.get()) { 085 int nume = 0; 086 for (TestError error : errors) { 087 List<String> s = new ArrayList<>(); 088 s.add(error.getIgnoreState()); 089 s.add(error.getIgnoreGroup()); 090 s.add(error.getIgnoreSubGroup()); 091 for (String state : s) { 092 if (state != null && OsmValidator.hasIgnoredError(state)) { 093 error.setIgnored(true); 094 } 095 } 096 if (!error.isIgnored()) { 097 ++nume; 098 } 099 } 100 if (nume == 0) 101 return true; 102 } 103 return displayErrorScreen(errors); 104 } 105 106 /** 107 * Displays a screen where the actions that would be taken are displayed and 108 * give the user the possibility to cancel the upload. 109 * @param errors The errors displayed in the screen 110 * @return <code>true</code>, if the upload should continue. <code>false</code> 111 * if the user requested cancel. 112 */ 113 private static boolean displayErrorScreen(List<TestError> errors) { 114 JPanel p = new JPanel(new GridBagLayout()); 115 ValidatorTreePanel errorPanel = new ValidatorTreePanel(errors); 116 errorPanel.expandAll(); 117 HtmlPanel pnlMessage = new HtmlPanel(); 118 pnlMessage.setText("<html><body>" 119 + tr("The following are results of automatic validation. Try fixing" 120 + " these, but be careful (don''t destroy valid data)." 121 + " When in doubt ignore them.<br>When you" 122 + " cancel this dialog, you can find the entries in the validator" 123 + " side panel to inspect them.") 124 + "<table align=\"center\">" 125 + "<tr><td align=\"left\"><b>"+tr("Errors") 126 + " </b></td><td align=\"left\">" 127 + tr("Usually this should be fixed.")+"</td></tr>" 128 + "<tr><td align=\"left\"><b>"+tr("Warnings") 129 + " </b></td><td align=\"left\">" 130 + tr("Fix these when possible.")+"</td></tr>" 131 + "<tr><td align=\"left\"><b>"+tr("Other") 132 + " </b></td><td align=\"left\">" 133 + tr("Informational warnings, expect many false entries.")+"</td></tr>" 134 + "</table>" 135 ); 136 pnlMessage.setPreferredSize(new Dimension(500, 150)); 137 p.add(pnlMessage, GBC.eol().fill(GBC.HORIZONTAL)); 138 p.add(new JScrollPane(errorPanel), GBC.eol().fill(GBC.BOTH)); 139 140 ExtendedDialog ed = new ExtendedDialog(Main.parent, 141 tr("Suspicious data found. Upload anyway?"), 142 new String[] {tr("Continue upload"), tr("Cancel")}); 143 ed.setButtonIcons(new String[] {"ok.png", "cancel.png"}); 144 ed.setContent(p); 145 ed.showDialog(); 146 147 if (ed.getValue() != 1) { 148 OsmValidator.initializeTests(); 149 OsmValidator.initializeErrorLayer(); 150 Main.map.validatorDialog.unfurlDialog(); 151 Main.getLayerManager().getEditDataSet().fireSelectionChanged(); 152 return false; 153 } 154 return true; 155 } 156}