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

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

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