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.HashMap; 010import java.util.Iterator; 011import java.util.List; 012import java.util.Map; 013 014import org.openstreetmap.josm.Main; 015import org.openstreetmap.josm.command.ChangePropertyCommand; 016import org.openstreetmap.josm.command.Command; 017import org.openstreetmap.josm.data.osm.Node; 018import org.openstreetmap.josm.data.osm.OsmPrimitive; 019import org.openstreetmap.josm.data.osm.Relation; 020import org.openstreetmap.josm.data.osm.Way; 021import org.openstreetmap.josm.data.osm.visitor.paint.relations.Multipolygon; 022import org.openstreetmap.josm.data.osm.visitor.paint.relations.Multipolygon.JoinedWay; 023import org.openstreetmap.josm.data.osm.visitor.paint.relations.MultipolygonCache; 024import org.openstreetmap.josm.data.validation.Severity; 025import org.openstreetmap.josm.data.validation.Test; 026import org.openstreetmap.josm.data.validation.TestError; 027import org.openstreetmap.josm.gui.progress.ProgressMonitor; 028import org.openstreetmap.josm.tools.Geometry; 029 030/** 031 * Checks for nodes in power lines/minor_lines that do not have a power=tower/pole tag.<br> 032 * See #7812 for discussions about this test. 033 */ 034public class PowerLines extends Test { 035 036 protected static final int POWER_LINES = 2501; 037 038 /** Values for {@code power} key interpreted as power lines */ 039 protected static final Collection<String> POWER_LINE_TAGS = Arrays.asList("line", "minor_line"); 040 /** Values for {@code power} key interpreted as power towers */ 041 protected static final Collection<String> POWER_TOWER_TAGS = Arrays.asList("tower", "pole"); 042 /** Values for {@code power} key interpreted as power stations */ 043 protected static final Collection<String> POWER_STATION_TAGS = Arrays.asList("station", "sub_station", "substation", "plant", "generator"); 044 /** Values for {@code power} key interpreted as allowed power items */ 045 protected static final Collection<String> POWER_ALLOWED_TAGS = Arrays.asList("switch", "transformer", "busbar", "generator", "switchgear", 046 "portal", "terminal", "insulator"); 047 048 private final Map<Way, String> towerPoleTagMap = new HashMap<>(); 049 050 private final List<PowerLineError> potentialErrors = new ArrayList<>(); 051 052 private final List<OsmPrimitive> powerStations = new ArrayList<>(); 053 054 /** 055 * Constructs a new {@code PowerLines} test. 056 */ 057 public PowerLines() { 058 super(tr("Power lines"), tr("Checks for nodes in power lines that do not have a power=tower/pole tag.")); 059 } 060 061 @Override 062 public void visit(Way w) { 063 if (w.isUsable()) { 064 if (isPowerLine(w) && !w.hasTag("location", "underground")) { 065 String fixValue = null; 066 boolean erroneous = false; 067 boolean canFix = false; 068 for (Node n : w.getNodes()) { 069 if (!isPowerTower(n)) { 070 if (!isPowerAllowed(n) && IN_DOWNLOADED_AREA.evaluate(n)) { 071 if (!w.isFirstLastNode(n) || !isPowerStation(n)) { 072 potentialErrors.add(new PowerLineError(this, n, w)); 073 erroneous = true; 074 } 075 } 076 } else if (fixValue == null) { 077 // First tower/pole tag found, remember it 078 fixValue = n.get("power"); 079 canFix = true; 080 } else if (!fixValue.equals(n.get("power"))) { 081 // The power line contains both "tower" and "pole" -> cannot fix this error 082 canFix = false; 083 } 084 } 085 if (erroneous && canFix) { 086 towerPoleTagMap.put(w, fixValue); 087 } 088 } else if (w.isClosed() && isPowerStation(w)) { 089 powerStations.add(w); 090 } 091 } 092 } 093 094 @Override 095 public void visit(Relation r) { 096 if (r.isMultipolygon() && isPowerStation(r)) { 097 powerStations.add(r); 098 } 099 } 100 101 @Override 102 public void startTest(ProgressMonitor progressMonitor) { 103 super.startTest(progressMonitor); 104 towerPoleTagMap.clear(); 105 powerStations.clear(); 106 potentialErrors.clear(); 107 } 108 109 @Override 110 public void endTest() { 111 for (PowerLineError e : potentialErrors) { 112 Node n = e.getNode(); 113 if (n != null && !isInPowerStation(n)) { 114 errors.add(e); 115 } 116 } 117 potentialErrors.clear(); 118 super.endTest(); 119 } 120 121 protected final boolean isInPowerStation(Node n) { 122 for (OsmPrimitive station : powerStations) { 123 List<List<Node>> nodesLists = new ArrayList<>(); 124 if (station instanceof Way) { 125 nodesLists.add(((Way) station).getNodes()); 126 } else if (station instanceof Relation) { 127 Multipolygon polygon = MultipolygonCache.getInstance().get(Main.map.mapView, (Relation) station); 128 if (polygon != null) { 129 for (JoinedWay outer : Multipolygon.joinWays(polygon.getOuterWays())) { 130 nodesLists.add(outer.getNodes()); 131 } 132 } 133 } 134 for (List<Node> nodes : nodesLists) { 135 if (Geometry.nodeInsidePolygon(n, nodes)) { 136 return true; 137 } 138 } 139 } 140 return false; 141 } 142 143 @Override 144 public Command fixError(TestError testError) { 145 if (testError instanceof PowerLineError && isFixable(testError)) { 146 // primitives list can be empty if all primitives have been purged 147 Iterator<? extends OsmPrimitive> it = testError.getPrimitives().iterator(); 148 if (it.hasNext()) { 149 return new ChangePropertyCommand(it.next(), 150 "power", towerPoleTagMap.get(((PowerLineError) testError).line)); 151 } 152 } 153 return null; 154 } 155 156 @Override 157 public boolean isFixable(TestError testError) { 158 return testError instanceof PowerLineError && towerPoleTagMap.containsKey(((PowerLineError) testError).line); 159 } 160 161 /** 162 * Determines if the specified way denotes a power line. 163 * @param w The way to be tested 164 * @return {@code true} if power key is set and equal to line/minor_line 165 */ 166 protected static final boolean isPowerLine(Way w) { 167 return isPowerIn(w, POWER_LINE_TAGS); 168 } 169 170 /** 171 * Determines if the specified primitive denotes a power station. 172 * @param p The primitive to be tested 173 * @return {@code true} if power key is set and equal to station/sub_station/plant 174 */ 175 protected static final boolean isPowerStation(OsmPrimitive p) { 176 return isPowerIn(p, POWER_STATION_TAGS); 177 } 178 179 /** 180 * Determines if the specified node denotes a power tower/pole. 181 * @param n The node to be tested 182 * @return {@code true} if power key is set and equal to tower/pole 183 */ 184 protected static final boolean isPowerTower(Node n) { 185 return isPowerIn(n, POWER_TOWER_TAGS); 186 } 187 188 /** 189 * Determines if the specified node denotes a power infrastructure allowed on a power line. 190 * @param n The node to be tested 191 * @return True if power key is set and equal to switch/tranformer/busbar/generator 192 */ 193 protected static final boolean isPowerAllowed(Node n) { 194 return isPowerIn(n, POWER_ALLOWED_TAGS); 195 } 196 197 /** 198 * Helper function to check if power tags is a certain value. 199 * @param p The primitive to be tested 200 * @param values List of possible values 201 * @return {@code true} if power key is set and equal to possible values 202 */ 203 private static boolean isPowerIn(OsmPrimitive p, Collection<String> values) { 204 String v = p.get("power"); 205 return v != null && values != null && values.contains(v); 206 } 207 208 protected static class PowerLineError extends TestError { 209 private final Way line; 210 211 public PowerLineError(PowerLines tester, Node n, Way line) { 212 super(tester, Severity.WARNING, 213 tr("Missing power tower/pole within power line"), POWER_LINES, n); 214 this.line = line; 215 } 216 217 public final Node getNode() { 218 // primitives list can be empty if all primitives have been purged 219 Iterator<? extends OsmPrimitive> it = getPrimitives().iterator(); 220 return it.hasNext() ? (Node) it.next() : null; 221 } 222 } 223}