source: josm/trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java@ 10212

Last change on this file since 10212 was 10212, checked in by Don-vip, 8 years ago

sonar - squid:S2221 - "Exception" should not be caught when not required by called methods
  • Property svn:eol-style set to native
File size: 35.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data.validation.tests;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.io.BufferedReader;
7import java.io.IOException;
8import java.io.InputStream;
9import java.io.Reader;
10import java.io.StringReader;
11import java.text.MessageFormat;
12import java.util.ArrayList;
13import java.util.Arrays;
14import java.util.Collection;
15import java.util.Collections;
16import java.util.HashMap;
17import java.util.HashSet;
18import java.util.Iterator;
19import java.util.LinkedHashMap;
20import java.util.LinkedHashSet;
21import java.util.LinkedList;
22import java.util.List;
23import java.util.Locale;
24import java.util.Map;
25import java.util.Objects;
26import java.util.Set;
27import java.util.regex.Matcher;
28import java.util.regex.Pattern;
29
30import org.openstreetmap.josm.Main;
31import org.openstreetmap.josm.command.ChangePropertyCommand;
32import org.openstreetmap.josm.command.ChangePropertyKeyCommand;
33import org.openstreetmap.josm.command.Command;
34import org.openstreetmap.josm.command.DeleteCommand;
35import org.openstreetmap.josm.command.SequenceCommand;
36import org.openstreetmap.josm.data.osm.DataSet;
37import org.openstreetmap.josm.data.osm.OsmPrimitive;
38import org.openstreetmap.josm.data.osm.OsmUtils;
39import org.openstreetmap.josm.data.osm.Tag;
40import org.openstreetmap.josm.data.validation.FixableTestError;
41import org.openstreetmap.josm.data.validation.Severity;
42import org.openstreetmap.josm.data.validation.Test;
43import org.openstreetmap.josm.data.validation.TestError;
44import org.openstreetmap.josm.gui.mappaint.Environment;
45import org.openstreetmap.josm.gui.mappaint.Keyword;
46import org.openstreetmap.josm.gui.mappaint.MultiCascade;
47import org.openstreetmap.josm.gui.mappaint.mapcss.Condition;
48import org.openstreetmap.josm.gui.mappaint.mapcss.Condition.ClassCondition;
49import org.openstreetmap.josm.gui.mappaint.mapcss.Expression;
50import org.openstreetmap.josm.gui.mappaint.mapcss.Instruction;
51import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSRule;
52import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSRule.Declaration;
53import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleSource;
54import org.openstreetmap.josm.gui.mappaint.mapcss.Selector;
55import org.openstreetmap.josm.gui.mappaint.mapcss.Selector.AbstractSelector;
56import org.openstreetmap.josm.gui.mappaint.mapcss.Selector.GeneralSelector;
57import org.openstreetmap.josm.gui.mappaint.mapcss.parsergen.MapCSSParser;
58import org.openstreetmap.josm.gui.mappaint.mapcss.parsergen.ParseException;
59import org.openstreetmap.josm.gui.preferences.SourceEntry;
60import org.openstreetmap.josm.gui.preferences.validator.ValidatorPreference;
61import org.openstreetmap.josm.gui.preferences.validator.ValidatorTagCheckerRulesPreference;
62import org.openstreetmap.josm.io.CachedFile;
63import org.openstreetmap.josm.io.IllegalDataException;
64import org.openstreetmap.josm.io.UTFInputStreamReader;
65import org.openstreetmap.josm.tools.CheckParameterUtil;
66import org.openstreetmap.josm.tools.MultiMap;
67import org.openstreetmap.josm.tools.Predicate;
68import org.openstreetmap.josm.tools.Utils;
69
70/**
71 * MapCSS-based tag checker/fixer.
72 * @since 6506
73 */
74public class MapCSSTagChecker extends Test.TagTest {
75
76 /**
77 * A grouped MapCSSRule with multiple selectors for a single declaration.
78 * @see MapCSSRule
79 */
80 public static class GroupedMapCSSRule {
81 /** MapCSS selectors **/
82 public final List<Selector> selectors;
83 /** MapCSS declaration **/
84 public final Declaration declaration;
85
86 /**
87 * Constructs a new {@code GroupedMapCSSRule}.
88 * @param selectors MapCSS selectors
89 * @param declaration MapCSS declaration
90 */
91 public GroupedMapCSSRule(List<Selector> selectors, Declaration declaration) {
92 this.selectors = selectors;
93 this.declaration = declaration;
94 }
95
96 @Override
97 public int hashCode() {
98 return Objects.hash(selectors, declaration);
99 }
100
101 @Override
102 public boolean equals(Object obj) {
103 if (this == obj) return true;
104 if (obj == null || getClass() != obj.getClass()) return false;
105 GroupedMapCSSRule that = (GroupedMapCSSRule) obj;
106 return Objects.equals(selectors, that.selectors) &&
107 Objects.equals(declaration, that.declaration);
108 }
109
110 @Override
111 public String toString() {
112 return "GroupedMapCSSRule [selectors=" + selectors + ", declaration=" + declaration + ']';
113 }
114 }
115
116 /**
117 * The preference key for tag checker source entries.
118 * @since 6670
119 */
120 public static final String ENTRIES_PREF_KEY = "validator." + MapCSSTagChecker.class.getName() + ".entries";
121
122 /**
123 * Constructs a new {@code MapCSSTagChecker}.
124 */
125 public MapCSSTagChecker() {
126 super(tr("Tag checker (MapCSS based)"), tr("This test checks for errors in tag keys and values."));
127 }
128
129 /**
130 * Represents a fix to a validation test. The fixing {@link Command} can be obtained by {@link #createCommand(OsmPrimitive, Selector)}.
131 */
132 abstract static class FixCommand {
133 /**
134 * Creates the fixing {@link Command} for the given primitive. The {@code matchingSelector} is used to evaluate placeholders
135 * (cf. {@link MapCSSTagChecker.TagCheck#insertArguments(Selector, String, OsmPrimitive)}).
136 * @param p OSM primitive
137 * @param matchingSelector matching selector
138 * @return fix command
139 */
140 abstract Command createCommand(final OsmPrimitive p, final Selector matchingSelector);
141
142 private static void checkObject(final Object obj) {
143 CheckParameterUtil.ensureThat(obj instanceof Expression || obj instanceof String,
144 "instance of Exception or String expected, but got " + obj);
145 }
146
147 /**
148 * Evaluates given object as {@link Expression} or {@link String} on the matched {@link OsmPrimitive} and {@code matchingSelector}.
149 * @param obj object to evaluate ({@link Expression} or {@link String})
150 * @param p OSM primitive
151 * @param matchingSelector matching selector
152 * @return result string
153 */
154 private static String evaluateObject(final Object obj, final OsmPrimitive p, final Selector matchingSelector) {
155 final String s;
156 if (obj instanceof Expression) {
157 s = (String) ((Expression) obj).evaluate(new Environment(p));
158 } else if (obj instanceof String) {
159 s = (String) obj;
160 } else {
161 return null;
162 }
163 return TagCheck.insertArguments(matchingSelector, s, p);
164 }
165
166 /**
167 * Creates a fixing command which executes a {@link ChangePropertyCommand} on the specified tag.
168 * @param obj object to evaluate ({@link Expression} or {@link String})
169 * @return created fix command
170 */
171 static FixCommand fixAdd(final Object obj) {
172 checkObject(obj);
173 return new FixCommand() {
174 @Override
175 Command createCommand(OsmPrimitive p, Selector matchingSelector) {
176 final Tag tag = Tag.ofString(evaluateObject(obj, p, matchingSelector));
177 return new ChangePropertyCommand(p, tag.getKey(), tag.getValue());
178 }
179
180 @Override
181 public String toString() {
182 return "fixAdd: " + obj;
183 }
184 };
185 }
186
187 /**
188 * Creates a fixing command which executes a {@link ChangePropertyCommand} to delete the specified key.
189 * @param obj object to evaluate ({@link Expression} or {@link String})
190 * @return created fix command
191 */
192 static FixCommand fixRemove(final Object obj) {
193 checkObject(obj);
194 return new FixCommand() {
195 @Override
196 Command createCommand(OsmPrimitive p, Selector matchingSelector) {
197 final String key = evaluateObject(obj, p, matchingSelector);
198 return new ChangePropertyCommand(p, key, "");
199 }
200
201 @Override
202 public String toString() {
203 return "fixRemove: " + obj;
204 }
205 };
206 }
207
208 /**
209 * Creates a fixing command which executes a {@link ChangePropertyKeyCommand} on the specified keys.
210 * @param oldKey old key
211 * @param newKey new key
212 * @return created fix command
213 */
214 static FixCommand fixChangeKey(final String oldKey, final String newKey) {
215 return new FixCommand() {
216 @Override
217 Command createCommand(OsmPrimitive p, Selector matchingSelector) {
218 return new ChangePropertyKeyCommand(p,
219 TagCheck.insertArguments(matchingSelector, oldKey, p),
220 TagCheck.insertArguments(matchingSelector, newKey, p));
221 }
222
223 @Override
224 public String toString() {
225 return "fixChangeKey: " + oldKey + " => " + newKey;
226 }
227 };
228 }
229 }
230
231 final MultiMap<String, TagCheck> checks = new MultiMap<>();
232
233 /**
234 * Result of {@link TagCheck#readMapCSS}
235 * @since 8936
236 */
237 public static class ParseResult {
238 /** Checks successfully parsed */
239 public final List<TagCheck> parseChecks;
240 /** Errors that occured during parsing */
241 public final Collection<Throwable> parseErrors;
242
243 /**
244 * Constructs a new {@code ParseResult}.
245 * @param parseChecks Checks successfully parsed
246 * @param parseErrors Errors that occured during parsing
247 */
248 public ParseResult(List<TagCheck> parseChecks, Collection<Throwable> parseErrors) {
249 this.parseChecks = parseChecks;
250 this.parseErrors = parseErrors;
251 }
252 }
253
254 public static class TagCheck implements Predicate<OsmPrimitive> {
255 protected final GroupedMapCSSRule rule;
256 protected final List<FixCommand> fixCommands = new ArrayList<>();
257 protected final List<String> alternatives = new ArrayList<>();
258 protected final Map<Instruction.AssignmentInstruction, Severity> errors = new HashMap<>();
259 protected final Map<String, Boolean> assertions = new HashMap<>();
260 protected final Set<String> setClassExpressions = new HashSet<>();
261 protected boolean deletion;
262
263 TagCheck(GroupedMapCSSRule rule) {
264 this.rule = rule;
265 }
266
267 private static final String POSSIBLE_THROWS = possibleThrows();
268
269 static final String possibleThrows() {
270 StringBuilder sb = new StringBuilder();
271 for (Severity s : Severity.values()) {
272 if (sb.length() > 0) {
273 sb.append('/');
274 }
275 sb.append("throw")
276 .append(s.name().charAt(0))
277 .append(s.name().substring(1).toLowerCase(Locale.ENGLISH));
278 }
279 return sb.toString();
280 }
281
282 static TagCheck ofMapCSSRule(final GroupedMapCSSRule rule) throws IllegalDataException {
283 final TagCheck check = new TagCheck(rule);
284 for (Instruction i : rule.declaration.instructions) {
285 if (i instanceof Instruction.AssignmentInstruction) {
286 final Instruction.AssignmentInstruction ai = (Instruction.AssignmentInstruction) i;
287 if (ai.isSetInstruction) {
288 check.setClassExpressions.add(ai.key);
289 continue;
290 }
291 final String val = ai.val instanceof Expression
292 ? (String) ((Expression) ai.val).evaluate(new Environment())
293 : ai.val instanceof String
294 ? (String) ai.val
295 : ai.val instanceof Keyword
296 ? ((Keyword) ai.val).val
297 : null;
298 if (ai.key.startsWith("throw")) {
299 try {
300 final Severity severity = Severity.valueOf(ai.key.substring("throw".length()).toUpperCase(Locale.ENGLISH));
301 check.errors.put(ai, severity);
302 } catch (IllegalArgumentException e) {
303 Main.warn("Unsupported "+ai.key+" instruction. Allowed instructions are "+POSSIBLE_THROWS);
304 }
305 } else if ("fixAdd".equals(ai.key)) {
306 check.fixCommands.add(FixCommand.fixAdd(ai.val));
307 } else if ("fixRemove".equals(ai.key)) {
308 CheckParameterUtil.ensureThat(!(ai.val instanceof String) || !(val != null && val.contains("=")),
309 "Unexpected '='. Please only specify the key to remove!");
310 check.fixCommands.add(FixCommand.fixRemove(ai.val));
311 } else if ("fixChangeKey".equals(ai.key) && val != null) {
312 CheckParameterUtil.ensureThat(val.contains("=>"), "Separate old from new key by '=>'!");
313 final String[] x = val.split("=>", 2);
314 check.fixCommands.add(FixCommand.fixChangeKey(Tag.removeWhiteSpaces(x[0]), Tag.removeWhiteSpaces(x[1])));
315 } else if ("fixDeleteObject".equals(ai.key) && val != null) {
316 CheckParameterUtil.ensureThat("this".equals(val), "fixDeleteObject must be followed by 'this'");
317 check.deletion = true;
318 } else if ("suggestAlternative".equals(ai.key) && val != null) {
319 check.alternatives.add(val);
320 } else if ("assertMatch".equals(ai.key) && val != null) {
321 check.assertions.put(val, Boolean.TRUE);
322 } else if ("assertNoMatch".equals(ai.key) && val != null) {
323 check.assertions.put(val, Boolean.FALSE);
324 } else {
325 throw new IllegalDataException("Cannot add instruction " + ai.key + ": " + ai.val + '!');
326 }
327 }
328 }
329 if (check.errors.isEmpty() && check.setClassExpressions.isEmpty()) {
330 throw new IllegalDataException(
331 "No "+POSSIBLE_THROWS+" given! You should specify a validation error message for " + rule.selectors);
332 } else if (check.errors.size() > 1) {
333 throw new IllegalDataException(
334 "More than one "+POSSIBLE_THROWS+" given! You should specify a single validation error message for "
335 + rule.selectors);
336 }
337 return check;
338 }
339
340 static ParseResult readMapCSS(Reader css) throws ParseException {
341 CheckParameterUtil.ensureParameterNotNull(css, "css");
342
343 final MapCSSStyleSource source = new MapCSSStyleSource("");
344 final MapCSSParser preprocessor = new MapCSSParser(css, MapCSSParser.LexicalState.PREPROCESSOR);
345
346 css = new StringReader(preprocessor.pp_root(source));
347 final MapCSSParser parser = new MapCSSParser(css, MapCSSParser.LexicalState.DEFAULT);
348 parser.sheet(source);
349 Collection<Throwable> parseErrors = source.getErrors();
350 assert parseErrors.isEmpty();
351 // Ignore "meta" rule(s) from external rules of JOSM wiki
352 removeMetaRules(source);
353 // group rules with common declaration block
354 Map<Declaration, List<Selector>> g = new LinkedHashMap<>();
355 for (MapCSSRule rule : source.rules) {
356 if (!g.containsKey(rule.declaration)) {
357 List<Selector> sels = new ArrayList<>();
358 sels.add(rule.selector);
359 g.put(rule.declaration, sels);
360 } else {
361 g.get(rule.declaration).add(rule.selector);
362 }
363 }
364 List<TagCheck> parseChecks = new ArrayList<>();
365 for (Map.Entry<Declaration, List<Selector>> map : g.entrySet()) {
366 try {
367 parseChecks.add(TagCheck.ofMapCSSRule(
368 new GroupedMapCSSRule(map.getValue(), map.getKey())));
369 } catch (IllegalDataException e) {
370 Main.error("Cannot add MapCss rule: "+e.getMessage());
371 parseErrors.add(e);
372 }
373 }
374 return new ParseResult(parseChecks, parseErrors);
375 }
376
377 private static void removeMetaRules(MapCSSStyleSource source) {
378 for (Iterator<MapCSSRule> it = source.rules.iterator(); it.hasNext();) {
379 MapCSSRule x = it.next();
380 if (x.selector instanceof GeneralSelector) {
381 GeneralSelector gs = (GeneralSelector) x.selector;
382 if ("meta".equals(gs.base) && gs.getConditions().isEmpty()) {
383 it.remove();
384 }
385 }
386 }
387 }
388
389 @Override
390 public boolean evaluate(OsmPrimitive primitive) {
391 // Tests whether the primitive contains a deprecated tag which is represented by this MapCSSTagChecker.
392 return whichSelectorMatchesPrimitive(primitive) != null;
393 }
394
395 Selector whichSelectorMatchesPrimitive(OsmPrimitive primitive) {
396 return whichSelectorMatchesEnvironment(new Environment(primitive));
397 }
398
399 Selector whichSelectorMatchesEnvironment(Environment env) {
400 for (Selector i : rule.selectors) {
401 env.clearSelectorMatchingInformation();
402 if (i.matches(env)) {
403 return i;
404 }
405 }
406 return null;
407 }
408
409 /**
410 * Determines the {@code index}-th key/value/tag (depending on {@code type}) of the
411 * {@link org.openstreetmap.josm.gui.mappaint.mapcss.Selector.GeneralSelector}.
412 * @param matchingSelector matching selector
413 * @param index index
414 * @param type selector type ("key", "value" or "tag")
415 * @param p OSM primitive
416 * @return argument value, can be {@code null}
417 */
418 static String determineArgument(Selector.GeneralSelector matchingSelector, int index, String type, OsmPrimitive p) {
419 try {
420 final Condition c = matchingSelector.getConditions().get(index);
421 final Tag tag = c instanceof Condition.KeyCondition
422 ? ((Condition.KeyCondition) c).asTag(p)
423 : c instanceof Condition.SimpleKeyValueCondition
424 ? ((Condition.SimpleKeyValueCondition) c).asTag()
425 : c instanceof Condition.KeyValueCondition
426 ? ((Condition.KeyValueCondition) c).asTag()
427 : null;
428 if (tag == null) {
429 return null;
430 } else if ("key".equals(type)) {
431 return tag.getKey();
432 } else if ("value".equals(type)) {
433 return tag.getValue();
434 } else if ("tag".equals(type)) {
435 return tag.toString();
436 }
437 } catch (IndexOutOfBoundsException ignore) {
438 if (Main.isDebugEnabled()) {
439 Main.debug(ignore.getMessage());
440 }
441 }
442 return null;
443 }
444
445 /**
446 * Replaces occurrences of <code>{i.key}</code>, <code>{i.value}</code>, <code>{i.tag}</code> in {@code s} by the corresponding
447 * key/value/tag of the {@code index}-th {@link Condition} of {@code matchingSelector}.
448 * @param matchingSelector matching selector
449 * @param s any string
450 * @param p OSM primitive
451 * @return string with arguments inserted
452 */
453 static String insertArguments(Selector matchingSelector, String s, OsmPrimitive p) {
454 if (s != null && matchingSelector instanceof Selector.ChildOrParentSelector) {
455 return insertArguments(((Selector.ChildOrParentSelector) matchingSelector).right, s, p);
456 } else if (s == null || !(matchingSelector instanceof GeneralSelector)) {
457 return s;
458 }
459 final Matcher m = Pattern.compile("\\{(\\d+)\\.(key|value|tag)\\}").matcher(s);
460 final StringBuffer sb = new StringBuffer();
461 while (m.find()) {
462 final String argument = determineArgument((Selector.GeneralSelector) matchingSelector,
463 Integer.parseInt(m.group(1)), m.group(2), p);
464 try {
465 // Perform replacement with null-safe + regex-safe handling
466 m.appendReplacement(sb, String.valueOf(argument).replace("^(", "").replace(")$", ""));
467 } catch (IndexOutOfBoundsException | IllegalArgumentException e) {
468 Main.error(tr("Unable to replace argument {0} in {1}: {2}", argument, sb, e.getMessage()));
469 }
470 }
471 m.appendTail(sb);
472 return sb.toString();
473 }
474
475 /**
476 * Constructs a fix in terms of a {@link org.openstreetmap.josm.command.Command} for the {@link OsmPrimitive}
477 * if the error is fixable, or {@code null} otherwise.
478 *
479 * @param p the primitive to construct the fix for
480 * @return the fix or {@code null}
481 */
482 Command fixPrimitive(OsmPrimitive p) {
483 if (fixCommands.isEmpty() && !deletion) {
484 return null;
485 }
486 final Selector matchingSelector = whichSelectorMatchesPrimitive(p);
487 Collection<Command> cmds = new LinkedList<>();
488 for (FixCommand fixCommand : fixCommands) {
489 cmds.add(fixCommand.createCommand(p, matchingSelector));
490 }
491 if (deletion && !p.isDeleted()) {
492 cmds.add(new DeleteCommand(p));
493 }
494 return new SequenceCommand(tr("Fix of {0}", getDescriptionForMatchingSelector(p, matchingSelector)), cmds);
495 }
496
497 /**
498 * Constructs a (localized) message for this deprecation check.
499 * @param p OSM primitive
500 *
501 * @return a message
502 */
503 String getMessage(OsmPrimitive p) {
504 if (errors.isEmpty()) {
505 // Return something to avoid NPEs
506 return rule.declaration.toString();
507 } else {
508 final Object val = errors.keySet().iterator().next().val;
509 return String.valueOf(
510 val instanceof Expression
511 ? ((Expression) val).evaluate(new Environment(p))
512 : val
513 );
514 }
515 }
516
517 /**
518 * Constructs a (localized) description for this deprecation check.
519 * @param p OSM primitive
520 *
521 * @return a description (possibly with alternative suggestions)
522 * @see #getDescriptionForMatchingSelector
523 */
524 String getDescription(OsmPrimitive p) {
525 if (alternatives.isEmpty()) {
526 return getMessage(p);
527 } else {
528 /* I18N: {0} is the test error message and {1} is an alternative */
529 return tr("{0}, use {1} instead", getMessage(p), Utils.join(tr(" or "), alternatives));
530 }
531 }
532
533 /**
534 * Constructs a (localized) description for this deprecation check
535 * where any placeholders are replaced by values of the matched selector.
536 *
537 * @param matchingSelector matching selector
538 * @param p OSM primitive
539 * @return a description (possibly with alternative suggestions)
540 */
541 String getDescriptionForMatchingSelector(OsmPrimitive p, Selector matchingSelector) {
542 return insertArguments(matchingSelector, getDescription(p), p);
543 }
544
545 Severity getSeverity() {
546 return errors.isEmpty() ? null : errors.values().iterator().next();
547 }
548
549 @Override
550 public String toString() {
551 return getDescription(null);
552 }
553
554 /**
555 * Constructs a {@link TestError} for the given primitive, or returns null if the primitive does not give rise to an error.
556 *
557 * @param p the primitive to construct the error for
558 * @return an instance of {@link TestError}, or returns null if the primitive does not give rise to an error.
559 */
560 TestError getErrorForPrimitive(OsmPrimitive p) {
561 final Environment env = new Environment(p);
562 return getErrorForPrimitive(p, whichSelectorMatchesEnvironment(env), env);
563 }
564
565 TestError getErrorForPrimitive(OsmPrimitive p, Selector matchingSelector, Environment env) {
566 if (matchingSelector != null && !errors.isEmpty()) {
567 final Command fix = fixPrimitive(p);
568 final String description = getDescriptionForMatchingSelector(p, matchingSelector);
569 final List<OsmPrimitive> primitives;
570 if (env.child != null) {
571 primitives = Arrays.asList(p, env.child);
572 } else {
573 primitives = Collections.singletonList(p);
574 }
575 if (fix != null) {
576 return new FixableTestError(null, getSeverity(), description, null, matchingSelector.toString(), 3000, primitives, fix);
577 } else {
578 return new TestError(null, getSeverity(), description, null, matchingSelector.toString(), 3000, primitives);
579 }
580 } else {
581 return null;
582 }
583 }
584
585 /**
586 * Returns the set of tagchecks on which this check depends on.
587 * @param schecks the collection of tagcheks to search in
588 * @return the set of tagchecks on which this check depends on
589 * @since 7881
590 */
591 public Set<TagCheck> getTagCheckDependencies(Collection<TagCheck> schecks) {
592 Set<TagCheck> result = new HashSet<>();
593 Set<String> classes = getClassesIds();
594 if (schecks != null && !classes.isEmpty()) {
595 for (TagCheck tc : schecks) {
596 if (this.equals(tc)) {
597 continue;
598 }
599 for (String id : tc.setClassExpressions) {
600 if (classes.contains(id)) {
601 result.add(tc);
602 break;
603 }
604 }
605 }
606 }
607 return result;
608 }
609
610 /**
611 * Returns the list of ids of all MapCSS classes referenced in the rule selectors.
612 * @return the list of ids of all MapCSS classes referenced in the rule selectors
613 * @since 7881
614 */
615 public Set<String> getClassesIds() {
616 Set<String> result = new HashSet<>();
617 for (Selector s : rule.selectors) {
618 if (s instanceof AbstractSelector) {
619 for (Condition c : ((AbstractSelector) s).getConditions()) {
620 if (c instanceof ClassCondition) {
621 result.add(((ClassCondition) c).id);
622 }
623 }
624 }
625 }
626 return result;
627 }
628 }
629
630 static class MapCSSTagCheckerAndRule extends MapCSSTagChecker {
631 public final GroupedMapCSSRule rule;
632
633 MapCSSTagCheckerAndRule(GroupedMapCSSRule rule) {
634 this.rule = rule;
635 }
636
637 @Override
638 public boolean equals(Object obj) {
639 return super.equals(obj)
640 || (obj instanceof TagCheck && rule.equals(((TagCheck) obj).rule))
641 || (obj instanceof GroupedMapCSSRule && rule.equals(obj));
642 }
643
644 @Override
645 public int hashCode() {
646 return Objects.hash(super.hashCode(), rule);
647 }
648
649 @Override
650 public String toString() {
651 return "MapCSSTagCheckerAndRule [rule=" + rule + ']';
652 }
653 }
654
655 /**
656 * Obtains all {@link TestError}s for the {@link OsmPrimitive} {@code p}.
657 * @param p The OSM primitive
658 * @param includeOtherSeverity if {@code true}, errors of severity {@link Severity#OTHER} (info) will also be returned
659 * @return all errors for the given primitive, with or without those of "info" severity
660 */
661 public synchronized Collection<TestError> getErrorsForPrimitive(OsmPrimitive p, boolean includeOtherSeverity) {
662 return getErrorsForPrimitive(p, includeOtherSeverity, checks.values());
663 }
664
665 private static Collection<TestError> getErrorsForPrimitive(OsmPrimitive p, boolean includeOtherSeverity,
666 Collection<Set<TagCheck>> checksCol) {
667 final List<TestError> r = new ArrayList<>();
668 final Environment env = new Environment(p, new MultiCascade(), Environment.DEFAULT_LAYER, null);
669 for (Set<TagCheck> schecks : checksCol) {
670 for (TagCheck check : schecks) {
671 if (Severity.OTHER.equals(check.getSeverity()) && !includeOtherSeverity) {
672 continue;
673 }
674 final Selector selector = check.whichSelectorMatchesEnvironment(env);
675 if (selector != null) {
676 check.rule.declaration.execute(env);
677 final TestError error = check.getErrorForPrimitive(p, selector, env);
678 if (error != null) {
679 error.setTester(new MapCSSTagCheckerAndRule(check.rule));
680 r.add(error);
681 }
682 }
683 }
684 }
685 return r;
686 }
687
688 /**
689 * Visiting call for primitives.
690 *
691 * @param p The primitive to inspect.
692 */
693 @Override
694 public void check(OsmPrimitive p) {
695 errors.addAll(getErrorsForPrimitive(p, ValidatorPreference.PREF_OTHER.get()));
696 }
697
698 /**
699 * Adds a new MapCSS config file from the given URL.
700 * @param url The unique URL of the MapCSS config file
701 * @return List of tag checks and parsing errors, or null
702 * @throws ParseException if the config file does not match MapCSS syntax
703 * @throws IOException if any I/O error occurs
704 * @since 7275
705 */
706 public synchronized ParseResult addMapCSS(String url) throws ParseException, IOException {
707 CheckParameterUtil.ensureParameterNotNull(url, "url");
708 CachedFile cache = new CachedFile(url);
709 InputStream zip = cache.findZipEntryInputStream("validator.mapcss", "");
710 ParseResult result;
711 try (InputStream s = zip != null ? zip : cache.getInputStream()) {
712 result = TagCheck.readMapCSS(new BufferedReader(UTFInputStreamReader.create(s)));
713 checks.remove(url);
714 checks.putAll(url, result.parseChecks);
715 // Check assertions, useful for development of local files
716 if (Main.pref.getBoolean("validator.check_assert_local_rules", false) && Utils.isLocalUrl(url)) {
717 for (String msg : checkAsserts(result.parseChecks)) {
718 Main.warn(msg);
719 }
720 }
721 } finally {
722 cache.close();
723 }
724 return result;
725 }
726
727 @Override
728 public synchronized void initialize() throws Exception {
729 checks.clear();
730 for (SourceEntry source : new ValidatorTagCheckerRulesPreference.RulePrefHelper().get()) {
731 if (!source.active) {
732 continue;
733 }
734 String i = source.url;
735 try {
736 if (!i.startsWith("resource:")) {
737 Main.info(tr("Adding {0} to tag checker", i));
738 } else if (Main.isDebugEnabled()) {
739 Main.debug(tr("Adding {0} to tag checker", i));
740 }
741 addMapCSS(i);
742 if (Main.pref.getBoolean("validator.auto_reload_local_rules", true) && source.isLocal()) {
743 try {
744 Main.fileWatcher.registerValidatorRule(source);
745 } catch (IOException e) {
746 Main.error(e);
747 }
748 }
749 } catch (IOException ex) {
750 Main.warn(tr("Failed to add {0} to tag checker", i));
751 Main.warn(ex, false);
752 } catch (ParseException ex) {
753 Main.warn(tr("Failed to add {0} to tag checker", i));
754 Main.warn(ex);
755 }
756 }
757 }
758
759 /**
760 * Checks that rule assertions are met for the given set of TagChecks.
761 * @param schecks The TagChecks for which assertions have to be checked
762 * @return A set of error messages, empty if all assertions are met
763 * @since 7356
764 */
765 public Set<String> checkAsserts(final Collection<TagCheck> schecks) {
766 Set<String> assertionErrors = new LinkedHashSet<>();
767 final DataSet ds = new DataSet();
768 for (final TagCheck check : schecks) {
769 if (Main.isDebugEnabled()) {
770 Main.debug("Check: "+check);
771 }
772 for (final Map.Entry<String, Boolean> i : check.assertions.entrySet()) {
773 if (Main.isDebugEnabled()) {
774 Main.debug("- Assertion: "+i);
775 }
776 final OsmPrimitive p = OsmUtils.createPrimitive(i.getKey());
777 // Build minimal ordered list of checks to run to test the assertion
778 List<Set<TagCheck>> checksToRun = new ArrayList<>();
779 Set<TagCheck> checkDependencies = check.getTagCheckDependencies(schecks);
780 if (!checkDependencies.isEmpty()) {
781 checksToRun.add(checkDependencies);
782 }
783 checksToRun.add(Collections.singleton(check));
784 // Add primitive to dataset to avoid DataIntegrityProblemException when evaluating selectors
785 ds.addPrimitive(p);
786 final Collection<TestError> pErrors = getErrorsForPrimitive(p, true, checksToRun);
787 if (Main.isDebugEnabled()) {
788 Main.debug("- Errors: "+pErrors);
789 }
790 final boolean isError = Utils.exists(pErrors, new Predicate<TestError>() {
791 @Override
792 public boolean evaluate(TestError e) {
793 //noinspection EqualsBetweenInconvertibleTypes
794 return e.getTester().equals(check.rule);
795 }
796 });
797 if (isError != i.getValue()) {
798 final String error = MessageFormat.format("Expecting test ''{0}'' (i.e., {1}) to {2} {3} (i.e., {4})",
799 check.getMessage(p), check.rule.selectors, i.getValue() ? "match" : "not match", i.getKey(), p.getKeys());
800 assertionErrors.add(error);
801 }
802 ds.removePrimitive(p);
803 }
804 }
805 return assertionErrors;
806 }
807
808 @Override
809 public synchronized int hashCode() {
810 return Objects.hash(super.hashCode(), checks);
811 }
812
813 @Override
814 public synchronized boolean equals(Object obj) {
815 if (this == obj) return true;
816 if (obj == null || getClass() != obj.getClass()) return false;
817 if (!super.equals(obj)) return false;
818 MapCSSTagChecker that = (MapCSSTagChecker) obj;
819 return Objects.equals(checks, that.checks);
820 }
821}
Note: See TracBrowser for help on using the repository browser.