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() &&
064                Main.pref.getBoolean(ValidatorPreference.PREF_OTHER_UPLOAD, false)) {
065                errors.addAll(test.getErrors());
066            } else {
067                for (TestError e : test.getErrors()) {
068                    if (e.getSeverity() != Severity.OTHER) {
069                        errors.add(e);
070                    }
071                }
072            }
073        }
074        OsmDataLayer editLayer = Main.getLayerManager().getEditLayer();
075        if (editLayer != null) {
076            editLayer.validationErrors.clear();
077            editLayer.validationErrors.addAll(errors);
078        }
079        if (Main.map != null) {
080            Main.map.validatorDialog.tree.setErrors(errors);
081        }
082        if (errors.isEmpty())
083            return true;
084
085        if (Main.pref.getBoolean(ValidatorPreference.PREF_USE_IGNORE, true)) {
086            int nume = 0;
087            for (TestError error : errors) {
088                List<String> s = new ArrayList<>();
089                s.add(error.getIgnoreState());
090                s.add(error.getIgnoreGroup());
091                s.add(error.getIgnoreSubGroup());
092                for (String state : s) {
093                    if (state != null && OsmValidator.hasIgnoredError(state)) {
094                        error.setIgnored(true);
095                    }
096                }
097                if (!error.isIgnored()) {
098                    ++nume;
099                }
100            }
101            if (nume == 0)
102                return true;
103        }
104        return displayErrorScreen(errors);
105    }
106
107    /**
108     * Displays a screen where the actions that would be taken are displayed and
109     * give the user the possibility to cancel the upload.
110     * @param errors The errors displayed in the screen
111     * @return <code>true</code>, if the upload should continue. <code>false</code>
112     *          if the user requested cancel.
113     */
114    private static boolean displayErrorScreen(List<TestError> errors) {
115        JPanel p = new JPanel(new GridBagLayout());
116        ValidatorTreePanel errorPanel = new ValidatorTreePanel(errors);
117        errorPanel.expandAll();
118        HtmlPanel pnlMessage = new HtmlPanel();
119        pnlMessage.setText("<html><body>"
120                + tr("The following are results of automatic validation. Try fixing"
121                + " these, but be careful (don''t destroy valid data)."
122                + " When in doubt ignore them.<br>When you"
123                + " cancel this dialog, you can find the entries in the validator"
124                + " side panel to inspect them.")
125                + "<table align=\"center\">"
126                + "<tr><td align=\"left\"><b>"+tr("Errors")
127                + "&nbsp;</b></td><td align=\"left\">"
128                + tr("Usually this should be fixed.")+"</td></tr>"
129                + "<tr><td align=\"left\"><b>"+tr("Warnings")
130                + "&nbsp;</b></td><td align=\"left\">"
131                + tr("Fix these when possible.")+"</td></tr>"
132                + "<tr><td align=\"left\"><b>"+tr("Other")
133                + "&nbsp;</b></td><td align=\"left\">"
134                + tr("Informational warnings, expect many false entries.")+"</td></tr>"
135                + "</table>"
136        );
137        pnlMessage.setPreferredSize(new Dimension(500, 150));
138        p.add(pnlMessage, GBC.eol().fill(GBC.HORIZONTAL));
139        p.add(new JScrollPane(errorPanel), GBC.eol().fill(GBC.BOTH));
140
141        ExtendedDialog ed = new ExtendedDialog(Main.parent,
142                tr("Suspicious data found. Upload anyway?"),
143                new String[] {tr("Continue upload"), tr("Cancel")});
144        ed.setButtonIcons(new String[] {"ok.png", "cancel.png"});
145        ed.setContent(p);
146        ed.showDialog();
147
148        if (ed.getValue() != 1) {
149            OsmValidator.initializeTests();
150            OsmValidator.initializeErrorLayer();
151            Main.map.validatorDialog.unfurlDialog();
152            Main.getLayerManager().getEditDataSet().fireSelectionChanged();
153            return false;
154        }
155        return true;
156    }
157}