source: josm/trunk/src/org/openstreetmap/josm/data/validation/OsmValidator.java @ 12841

Last change on this file since 12841 was 12841, checked in by bastiK, 6 weeks ago

see #15229 - fix deprecations caused by [12840]

  • Property svn:eol-style set to native
File size: 15.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data.validation;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.GraphicsEnvironment;
7import java.io.File;
8import java.io.FileNotFoundException;
9import java.io.IOException;
10import java.io.PrintWriter;
11import java.nio.charset.StandardCharsets;
12import java.nio.file.Files;
13import java.nio.file.Path;
14import java.nio.file.Paths;
15import java.util.ArrayList;
16import java.util.Arrays;
17import java.util.Collection;
18import java.util.Collections;
19import java.util.EnumMap;
20import java.util.HashMap;
21import java.util.List;
22import java.util.Map;
23import java.util.SortedMap;
24import java.util.TreeMap;
25import java.util.TreeSet;
26import java.util.function.Predicate;
27import java.util.stream.Collectors;
28
29import javax.swing.JOptionPane;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.data.preferences.sources.ValidatorPrefHelper;
33import org.openstreetmap.josm.data.validation.tests.Addresses;
34import org.openstreetmap.josm.data.validation.tests.ApiCapabilitiesTest;
35import org.openstreetmap.josm.data.validation.tests.BarriersEntrances;
36import org.openstreetmap.josm.data.validation.tests.Coastlines;
37import org.openstreetmap.josm.data.validation.tests.ConditionalKeys;
38import org.openstreetmap.josm.data.validation.tests.CrossingWays;
39import org.openstreetmap.josm.data.validation.tests.DuplicateNode;
40import org.openstreetmap.josm.data.validation.tests.DuplicateRelation;
41import org.openstreetmap.josm.data.validation.tests.DuplicateWay;
42import org.openstreetmap.josm.data.validation.tests.DuplicatedWayNodes;
43import org.openstreetmap.josm.data.validation.tests.Highways;
44import org.openstreetmap.josm.data.validation.tests.InternetTags;
45import org.openstreetmap.josm.data.validation.tests.Lanes;
46import org.openstreetmap.josm.data.validation.tests.LongSegment;
47import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker;
48import org.openstreetmap.josm.data.validation.tests.MultipolygonTest;
49import org.openstreetmap.josm.data.validation.tests.NameMismatch;
50import org.openstreetmap.josm.data.validation.tests.OpeningHourTest;
51import org.openstreetmap.josm.data.validation.tests.OverlappingWays;
52import org.openstreetmap.josm.data.validation.tests.PowerLines;
53import org.openstreetmap.josm.data.validation.tests.PublicTransportRouteTest;
54import org.openstreetmap.josm.data.validation.tests.RelationChecker;
55import org.openstreetmap.josm.data.validation.tests.SelfIntersectingWay;
56import org.openstreetmap.josm.data.validation.tests.SimilarNamedWays;
57import org.openstreetmap.josm.data.validation.tests.TagChecker;
58import org.openstreetmap.josm.data.validation.tests.TurnrestrictionTest;
59import org.openstreetmap.josm.data.validation.tests.UnclosedWays;
60import org.openstreetmap.josm.data.validation.tests.UnconnectedWays;
61import org.openstreetmap.josm.data.validation.tests.UntaggedNode;
62import org.openstreetmap.josm.data.validation.tests.UntaggedWay;
63import org.openstreetmap.josm.data.validation.tests.WayConnectedToArea;
64import org.openstreetmap.josm.data.validation.tests.WronglyOrderedWays;
65import org.openstreetmap.josm.gui.MainApplication;
66import org.openstreetmap.josm.gui.layer.ValidatorLayer;
67import org.openstreetmap.josm.gui.preferences.projection.ProjectionPreference;
68import org.openstreetmap.josm.tools.AlphanumComparator;
69import org.openstreetmap.josm.tools.Logging;
70import org.openstreetmap.josm.tools.Utils;
71
72/**
73 * A OSM data validator.
74 *
75 * @author Francisco R. Santos <frsantos@gmail.com>
76 */
77public final class OsmValidator {
78
79    private OsmValidator() {
80        // Hide default constructor for utilities classes
81    }
82
83    private static volatile ValidatorLayer errorLayer;
84
85    /** Grid detail, multiplier of east,north values for valuable cell sizing */
86    private static double griddetail;
87
88    private static final Collection<String> ignoredErrors = new TreeSet<>();
89
90    /**
91     * All registered tests
92     */
93    private static final Collection<Class<? extends Test>> allTests = new ArrayList<>();
94    private static final Map<String, Test> allTestsMap = new HashMap<>();
95
96    /**
97     * All available tests in core
98     */
99    @SuppressWarnings("unchecked")
100    private static final Class<Test>[] CORE_TEST_CLASSES = new Class[] {
101        /* FIXME - unique error numbers for tests aren't properly unique - ignoring will not work as expected */
102        DuplicateNode.class, // ID    1 ..   99
103        OverlappingWays.class, // ID  101 ..  199
104        UntaggedNode.class, // ID  201 ..  299
105        UntaggedWay.class, // ID  301 ..  399
106        SelfIntersectingWay.class, // ID  401 ..  499
107        DuplicatedWayNodes.class, // ID  501 ..  599
108        CrossingWays.Ways.class, // ID  601 ..  699
109        CrossingWays.Boundaries.class, // ID  601 ..  699
110        CrossingWays.Barrier.class, // ID  601 ..  699
111        CrossingWays.SelfCrossing.class, // ID  601 ..  699
112        SimilarNamedWays.class, // ID  701 ..  799
113        Coastlines.class, // ID  901 ..  999
114        WronglyOrderedWays.class, // ID 1001 .. 1099
115        UnclosedWays.class, // ID 1101 .. 1199
116        TagChecker.class, // ID 1201 .. 1299
117        UnconnectedWays.UnconnectedHighways.class, // ID 1301 .. 1399
118        UnconnectedWays.UnconnectedRailways.class, // ID 1301 .. 1399
119        UnconnectedWays.UnconnectedWaterways.class, // ID 1301 .. 1399
120        UnconnectedWays.UnconnectedNaturalOrLanduse.class, // ID 1301 .. 1399
121        UnconnectedWays.UnconnectedPower.class, // ID 1301 .. 1399
122        DuplicateWay.class, // ID 1401 .. 1499
123        NameMismatch.class, // ID  1501 ..  1599
124        MultipolygonTest.class, // ID  1601 ..  1699
125        RelationChecker.class, // ID  1701 ..  1799
126        TurnrestrictionTest.class, // ID  1801 ..  1899
127        DuplicateRelation.class, // ID 1901 .. 1999
128        WayConnectedToArea.class, // ID 2301 .. 2399
129        PowerLines.class, // ID 2501 .. 2599
130        Addresses.class, // ID 2601 .. 2699
131        Highways.class, // ID 2701 .. 2799
132        BarriersEntrances.class, // ID 2801 .. 2899
133        OpeningHourTest.class, // 2901 .. 2999
134        MapCSSTagChecker.class, // 3000 .. 3099
135        Lanes.class, // 3100 .. 3199
136        ConditionalKeys.class, // 3200 .. 3299
137        InternetTags.class, // 3300 .. 3399
138        ApiCapabilitiesTest.class, // 3400 .. 3499
139        LongSegment.class, // 3500 .. 3599
140        PublicTransportRouteTest.class, // 3600 .. 3699
141    };
142
143    /**
144     * Adds a test to the list of available tests
145     * @param testClass The test class
146     */
147    public static void addTest(Class<? extends Test> testClass) {
148        allTests.add(testClass);
149        try {
150            allTestsMap.put(testClass.getName(), testClass.getConstructor().newInstance());
151        } catch (ReflectiveOperationException e) {
152            Logging.error(e);
153        }
154    }
155
156    static {
157        for (Class<? extends Test> testClass : CORE_TEST_CLASSES) {
158            addTest(testClass);
159        }
160    }
161
162    /**
163     * Initializes {@code OsmValidator}.
164     */
165    public static void initialize() {
166        checkValidatorDir();
167        initializeGridDetail();
168        loadIgnoredErrors(); //FIXME: load only when needed
169    }
170
171    /**
172     * Returns the validator directory.
173     *
174     * @return The validator directory
175     */
176    public static String getValidatorDir() {
177        return new File(Main.pref.getUserDataDirectory(), "validator").getAbsolutePath();
178    }
179
180    /**
181     * Check if validator directory exists (store ignored errors file)
182     */
183    private static void checkValidatorDir() {
184        File pathDir = new File(getValidatorDir());
185        if (!pathDir.exists()) {
186            Utils.mkDirs(pathDir);
187        }
188    }
189
190    private static void loadIgnoredErrors() {
191        ignoredErrors.clear();
192        if (ValidatorPrefHelper.PREF_USE_IGNORE.get()) {
193            Path path = Paths.get(getValidatorDir()).resolve("ignorederrors");
194            if (path.toFile().exists()) {
195                try {
196                    ignoredErrors.addAll(Files.readAllLines(path, StandardCharsets.UTF_8));
197                } catch (final FileNotFoundException e) {
198                    Logging.debug(Logging.getErrorMessage(e));
199                } catch (final IOException e) {
200                    Logging.error(e);
201                }
202            }
203        }
204    }
205
206    /**
207     * Adds an ignored error
208     * @param s The ignore group / sub group name
209     * @see TestError#getIgnoreGroup()
210     * @see TestError#getIgnoreSubGroup()
211     */
212    public static void addIgnoredError(String s) {
213        ignoredErrors.add(s);
214    }
215
216    /**
217     * Check if a error should be ignored
218     * @param s The ignore group / sub group name
219     * @return <code>true</code> to ignore that error
220     */
221    public static boolean hasIgnoredError(String s) {
222        return ignoredErrors.contains(s);
223    }
224
225    /**
226     * Saves the names of the ignored errors to a file
227     */
228    public static void saveIgnoredErrors() {
229        try (PrintWriter out = new PrintWriter(new File(getValidatorDir(), "ignorederrors"), StandardCharsets.UTF_8.name())) {
230            for (String e : ignoredErrors) {
231                out.println(e);
232            }
233        } catch (IOException e) {
234            Logging.error(e);
235        }
236    }
237
238    /**
239     * Initializes error layer.
240     */
241    public static synchronized void initializeErrorLayer() {
242        if (!ValidatorPrefHelper.PREF_LAYER.get())
243            return;
244        if (errorLayer == null) {
245            errorLayer = new ValidatorLayer();
246            MainApplication.getLayerManager().addLayer(errorLayer);
247        }
248    }
249
250    /**
251     * Resets error layer.
252     * @since 11852
253     */
254    public static synchronized void resetErrorLayer() {
255        errorLayer = null;
256    }
257
258    /**
259     * Gets a map from simple names to all tests.
260     * @return A map of all tests, indexed and sorted by the name of their Java class
261     */
262    public static SortedMap<String, Test> getAllTestsMap() {
263        applyPrefs(allTestsMap, false);
264        applyPrefs(allTestsMap, true);
265        return new TreeMap<>(allTestsMap);
266    }
267
268    /**
269     * Returns the instance of the given test class.
270     * @param <T> testClass type
271     * @param testClass The class of test to retrieve
272     * @return the instance of the given test class, if any, or {@code null}
273     * @since 6670
274     */
275    @SuppressWarnings("unchecked")
276    public static <T extends Test> T getTest(Class<T> testClass) {
277        if (testClass == null) {
278            return null;
279        }
280        return (T) allTestsMap.get(testClass.getName());
281    }
282
283    private static void applyPrefs(Map<String, Test> tests, boolean beforeUpload) {
284        for (String testName : Main.pref.getList(beforeUpload
285        ? ValidatorPrefHelper.PREF_SKIP_TESTS_BEFORE_UPLOAD : ValidatorPrefHelper.PREF_SKIP_TESTS)) {
286            Test test = tests.get(testName);
287            if (test != null) {
288                if (beforeUpload) {
289                    test.testBeforeUpload = false;
290                } else {
291                    test.enabled = false;
292                }
293            }
294        }
295    }
296
297    /**
298     * Gets all tests that are possible
299     * @return The tests
300     */
301    public static Collection<Test> getTests() {
302        return getAllTestsMap().values();
303    }
304
305    /**
306     * Gets all tests that are run
307     * @param beforeUpload To get the ones that are run before upload
308     * @return The tests
309     */
310    public static Collection<Test> getEnabledTests(boolean beforeUpload) {
311        Collection<Test> enabledTests = getTests();
312        for (Test t : new ArrayList<>(enabledTests)) {
313            if (beforeUpload ? t.testBeforeUpload : t.enabled) {
314                continue;
315            }
316            enabledTests.remove(t);
317        }
318        return enabledTests;
319    }
320
321    /**
322     * Gets the list of all available test classes
323     *
324     * @return A collection of the test classes
325     */
326    public static Collection<Class<? extends Test>> getAllAvailableTestClasses() {
327        return Collections.unmodifiableCollection(allTests);
328    }
329
330    /**
331     * Initialize grid details based on current projection system. Values based on
332     * the original value fixed for EPSG:4326 (10000) using heuristics (that is, test&amp;error
333     * until most bugs were discovered while keeping the processing time reasonable)
334     */
335    public static void initializeGridDetail() {
336        String code = Main.getProjection().toCode();
337        if (Arrays.asList(ProjectionPreference.wgs84.allCodes()).contains(code)) {
338            OsmValidator.griddetail = 10_000;
339        } else if (Arrays.asList(ProjectionPreference.mercator.allCodes()).contains(code)) {
340            OsmValidator.griddetail = 0.01;
341        } else if (Arrays.asList(ProjectionPreference.lambert.allCodes()).contains(code)) {
342            OsmValidator.griddetail = 0.1;
343        } else {
344            OsmValidator.griddetail = 1.0;
345        }
346    }
347
348    /**
349     * Returns grid detail, multiplier of east,north values for valuable cell sizing
350     * @return grid detail
351     * @since 11852
352     */
353    public static double getGridDetail() {
354        return griddetail;
355    }
356
357    private static boolean testsInitialized;
358
359    /**
360     * Initializes all tests if this operations hasn't been performed already.
361     */
362    public static synchronized void initializeTests() {
363        if (!testsInitialized) {
364            Logging.debug("Initializing validator tests");
365            final long startTime = System.currentTimeMillis();
366            initializeTests(getTests());
367            testsInitialized = true;
368            if (Logging.isDebugEnabled()) {
369                final long elapsedTime = System.currentTimeMillis() - startTime;
370                Logging.debug("Initializing validator tests completed in {0}", Utils.getDurationString(elapsedTime));
371            }
372        }
373    }
374
375    /**
376     * Initializes all tests
377     * @param allTests The tests to initialize
378     */
379    public static void initializeTests(Collection<? extends Test> allTests) {
380        for (Test test : allTests) {
381            try {
382                if (test.enabled) {
383                    test.initialize();
384                }
385            } catch (Exception e) { // NOPMD
386                Logging.error(e);
387                if (!GraphicsEnvironment.isHeadless()) {
388                    JOptionPane.showMessageDialog(Main.parent,
389                            tr("Error initializing test {0}:\n {1}", test.getClass().getSimpleName(), e),
390                            tr("Error"), JOptionPane.ERROR_MESSAGE);
391                }
392            }
393        }
394    }
395
396    /**
397     * Groups the given collection of errors by severity, then message, then description.
398     * @param errors list of errors to group
399     * @param filterToUse optional filter
400     * @return collection of errors grouped by severity, then message, then description
401     * @since 12667
402     */
403    public static Map<Severity, Map<String, Map<String, List<TestError>>>> getErrorsBySeverityMessageDescription(
404            Collection<TestError> errors, Predicate<? super TestError> filterToUse) {
405        return errors.stream().filter(filterToUse).collect(
406                Collectors.groupingBy(TestError::getSeverity, () -> new EnumMap<>(Severity.class),
407                        Collectors.groupingBy(TestError::getMessage, () -> new TreeMap<>(AlphanumComparator.getInstance()),
408                                Collectors.groupingBy(e -> e.getDescription() == null ? "" : e.getDescription(),
409                                        () -> new TreeMap<>(AlphanumComparator.getInstance()),
410                                        Collectors.toList()
411                                ))));
412    }
413}
Note: See TracBrowser for help on using the repository browser.