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

Last change on this file since 12305 was 12282, checked in by Don-vip, 7 years ago

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