001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.data.validation.tests; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.util.ArrayList; 007import java.util.Arrays; 008import java.util.Collection; 009import java.util.Collections; 010import java.util.Comparator; 011import java.util.HashMap; 012import java.util.HashSet; 013import java.util.List; 014import java.util.Map; 015import java.util.Set; 016import java.util.TreeSet; 017 018import org.openstreetmap.josm.data.osm.Node; 019import org.openstreetmap.josm.data.osm.OsmPrimitive; 020import org.openstreetmap.josm.data.osm.OsmUtils; 021import org.openstreetmap.josm.data.osm.Relation; 022import org.openstreetmap.josm.data.osm.Way; 023import org.openstreetmap.josm.data.osm.WaySegment; 024import org.openstreetmap.josm.data.preferences.CollectionProperty; 025import org.openstreetmap.josm.data.validation.Severity; 026import org.openstreetmap.josm.data.validation.Test; 027import org.openstreetmap.josm.data.validation.TestError; 028import org.openstreetmap.josm.gui.progress.ProgressMonitor; 029import org.openstreetmap.josm.tools.MultiMap; 030import org.openstreetmap.josm.tools.Pair; 031import org.openstreetmap.josm.tools.Predicates; 032import org.openstreetmap.josm.tools.Utils; 033 034/** 035 * Tests if there are overlapping ways. 036 * 037 * @author frsantos 038 */ 039public class OverlappingWays extends Test { 040 041 /** Bag of all way segments */ 042 private MultiMap<Pair<Node, Node>, WaySegment> nodePairs; 043 044 protected static final int OVERLAPPING_HIGHWAY = 101; 045 protected static final int OVERLAPPING_RAILWAY = 102; 046 protected static final int OVERLAPPING_WAY = 103; 047 protected static final int OVERLAPPING_HIGHWAY_AREA = 111; 048 protected static final int OVERLAPPING_RAILWAY_AREA = 112; 049 protected static final int OVERLAPPING_WAY_AREA = 113; 050 protected static final int OVERLAPPING_AREA = 120; 051 protected static final int DUPLICATE_WAY_SEGMENT = 121; 052 053 protected static final CollectionProperty IGNORED_KEYS = new CollectionProperty( 054 "overlapping-ways.ignored-keys", Arrays.asList("barrier", "building", "historic:building", "man_made")); 055 056 /** Constructor */ 057 public OverlappingWays() { 058 super(tr("Overlapping ways"), 059 tr("This test checks that a connection between two nodes " 060 + "is not used by more than one way.")); 061 } 062 063 @Override 064 public void startTest(ProgressMonitor monitor) { 065 super.startTest(monitor); 066 nodePairs = new MultiMap<>(1000); 067 } 068 069 private static boolean parentMultipolygonConcernsArea(OsmPrimitive p) { 070 for (Relation r : OsmPrimitive.getFilteredList(p.getReferrers(), Relation.class)) { 071 if (r.concernsArea()) { 072 return true; 073 } 074 } 075 return false; 076 } 077 078 @Override 079 public void endTest() { 080 Map<List<Way>, Set<WaySegment>> seenWays = new HashMap<>(500); 081 082 Collection<TestError> preliminaryErrors = new ArrayList<>(); 083 for (Set<WaySegment> duplicated : nodePairs.values()) { 084 int ways = duplicated.size(); 085 086 if (ways > 1) { 087 List<OsmPrimitive> prims = new ArrayList<>(); 088 List<Way> currentWays = new ArrayList<>(); 089 Collection<WaySegment> highlight; 090 int highway = 0; 091 int railway = 0; 092 int area = 0; 093 094 for (WaySegment ws : duplicated) { 095 if (ws.way.get("highway") != null) { 096 highway++; 097 } else if (ws.way.get("railway") != null) { 098 railway++; 099 } 100 Boolean ar = OsmUtils.getOsmBoolean(ws.way.get("area")); 101 if (ar != null && ar) { 102 area++; 103 } 104 if (ws.way.concernsArea() || parentMultipolygonConcernsArea(ws.way)) { 105 area++; 106 ways--; 107 } 108 109 prims.add(ws.way); 110 currentWays.add(ws.way); 111 } 112 /* These ways not seen before 113 * If two or more of the overlapping ways are 114 * highways or railways mark a separate error 115 */ 116 if ((highlight = seenWays.get(currentWays)) == null) { 117 String errortype; 118 int type; 119 120 if (area > 0) { 121 if (ways == 0 || duplicated.size() == area) { 122 errortype = tr("Areas share segment"); 123 type = OVERLAPPING_AREA; 124 } else if (highway == ways) { 125 errortype = tr("Highways share segment with area"); 126 type = OVERLAPPING_HIGHWAY_AREA; 127 } else if (railway == ways) { 128 errortype = tr("Railways share segment with area"); 129 type = OVERLAPPING_RAILWAY_AREA; 130 } else { 131 errortype = tr("Ways share segment with area"); 132 type = OVERLAPPING_WAY_AREA; 133 } 134 } else if (highway == ways) { 135 errortype = tr("Overlapping highways"); 136 type = OVERLAPPING_HIGHWAY; 137 } else if (railway == ways) { 138 errortype = tr("Overlapping railways"); 139 type = OVERLAPPING_RAILWAY; 140 } else { 141 errortype = tr("Overlapping ways"); 142 type = OVERLAPPING_WAY; 143 } 144 145 preliminaryErrors.add(new TestError(this, 146 type < OVERLAPPING_HIGHWAY_AREA ? Severity.WARNING : Severity.OTHER, 147 errortype, type, prims, duplicated)); 148 seenWays.put(currentWays, duplicated); 149 } else { /* way seen, mark highlight layer only */ 150 highlight.addAll(duplicated); 151 } 152 } 153 } 154 155 // see ticket #9598 - only report if at least 3 segments are shared, except for overlapping ways, i.e warnings (see #9820) 156 for (TestError error : preliminaryErrors) { 157 if (error.getSeverity().equals(Severity.WARNING) || error.getHighlighted().size() / error.getPrimitives().size() >= 3) { 158 boolean ignore = false; 159 for (String ignoredKey : IGNORED_KEYS.get()) { 160 if (Utils.exists(error.getPrimitives(), Predicates.hasKey(ignoredKey))) { 161 ignore = true; 162 break; 163 } 164 } 165 if (!ignore) { 166 errors.add(error); 167 } 168 } 169 } 170 171 super.endTest(); 172 nodePairs = null; 173 } 174 175 protected static Set<WaySegment> checkDuplicateWaySegment(Way w) { 176 // test for ticket #4959 177 Set<WaySegment> segments = new TreeSet<>(new Comparator<WaySegment>() { 178 @Override 179 public int compare(WaySegment o1, WaySegment o2) { 180 final List<Node> n1 = Arrays.asList(o1.getFirstNode(), o1.getSecondNode()); 181 final List<Node> n2 = Arrays.asList(o2.getFirstNode(), o2.getSecondNode()); 182 Collections.sort(n1); 183 Collections.sort(n2); 184 final int first = n1.get(0).compareTo(n2.get(0)); 185 final int second = n1.get(1).compareTo(n2.get(1)); 186 return first != 0 ? first : second; 187 } 188 }); 189 final Set<WaySegment> duplicateWaySegments = new HashSet<>(); 190 191 for (int i = 0; i < w.getNodesCount() - 1; i++) { 192 final WaySegment segment = new WaySegment(w, i); 193 final boolean wasInSet = !segments.add(segment); 194 if (wasInSet) { 195 duplicateWaySegments.add(segment); 196 } 197 } 198 if (duplicateWaySegments.size() > 1) { 199 return duplicateWaySegments; 200 } else { 201 return null; 202 } 203 } 204 205 @Override 206 public void visit(Way w) { 207 208 final Set<WaySegment> duplicateWaySegment = checkDuplicateWaySegment(w); 209 if (duplicateWaySegment != null) { 210 errors.add(new TestError(this, Severity.ERROR, tr("Way contains segment twice"), 211 DUPLICATE_WAY_SEGMENT, Collections.singleton(w), duplicateWaySegment)); 212 return; 213 } 214 215 Node lastN = null; 216 int i = -2; 217 for (Node n : w.getNodes()) { 218 i++; 219 if (lastN == null) { 220 lastN = n; 221 continue; 222 } 223 nodePairs.put(Pair.sort(new Pair<>(lastN, n)), 224 new WaySegment(w, i)); 225 lastN = n; 226 } 227 } 228}