// License: GPL. See LICENSE file for details.
package org.openstreetmap.josm.data.validation.tests;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.geom.GeneralPath;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.actions.CreateMultipolygonAction;
import org.openstreetmap.josm.data.osm.Node;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.osm.Relation;
import org.openstreetmap.josm.data.osm.RelationMember;
import org.openstreetmap.josm.data.osm.Way;
import org.openstreetmap.josm.data.osm.visitor.paint.relations.Multipolygon;
import org.openstreetmap.josm.data.osm.visitor.paint.relations.Multipolygon.JoinedWay;
import org.openstreetmap.josm.data.osm.visitor.paint.relations.Multipolygon.PolyData.Intersection;
import org.openstreetmap.josm.data.osm.visitor.paint.relations.MultipolygonCache;
import org.openstreetmap.josm.data.validation.OsmValidator;
import org.openstreetmap.josm.data.validation.Severity;
import org.openstreetmap.josm.data.validation.Test;
import org.openstreetmap.josm.data.validation.TestError;
import org.openstreetmap.josm.gui.DefaultNameFormatter;
import org.openstreetmap.josm.gui.mappaint.AreaElemStyle;
import org.openstreetmap.josm.gui.mappaint.ElemStyles;
import org.openstreetmap.josm.gui.mappaint.MapPaintStyles;
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
import org.openstreetmap.josm.tools.Pair;
/**
* Checks if multipolygons are valid
* @since 3669
*/
public class MultipolygonTest extends Test {
protected static final int WRONG_MEMBER_TYPE = 1601;
protected static final int WRONG_MEMBER_ROLE = 1602;
protected static final int NON_CLOSED_WAY = 1603;
protected static final int MISSING_OUTER_WAY = 1604;
protected static final int INNER_WAY_OUTSIDE = 1605;
protected static final int CROSSING_WAYS = 1606;
protected static final int OUTER_STYLE_MISMATCH = 1607;
protected static final int INNER_STYLE_MISMATCH = 1608;
protected static final int NOT_CLOSED = 1609;
protected static final int NO_STYLE = 1610;
protected static final int NO_STYLE_POLYGON = 1611;
private static ElemStyles styles;
private final List<List<Node>> nonClosedWays = new ArrayList<>();
private final Set<String> keysCheckedByAnotherTest = new HashSet<>();
/**
* Constructs a new {@code MultipolygonTest}.
*/
public MultipolygonTest() {
super(tr("Multipolygon"),
tr("This test checks if multipolygons are valid."));
}
@Override
public void initialize() {
styles = MapPaintStyles.getStyles();
}
@Override
public void startTest(ProgressMonitor progressMonitor) {
super.startTest(progressMonitor);
keysCheckedByAnotherTest.clear();
for (Test t : OsmValidator.getEnabledTests(false)) {
if (t instanceof UnclosedWays) {
keysCheckedByAnotherTest.addAll(((UnclosedWays)t).getCheckedKeys());
break;
}
}
}
@Override
public void endTest() {
keysCheckedByAnotherTest.clear();
super.endTest();
}
private List<List<Node>> joinWays(Collection<Way> ways) {
List<List<Node>> result = new ArrayList<>();
List<Way> waysToJoin = new ArrayList<>();
for (Way way : ways) {
if (way.isClosed()) {
result.add(way.getNodes());
} else {
waysToJoin.add(way);
}
}
for (JoinedWay jw : Multipolygon.joinWays(waysToJoin)) {
if (!jw.isClosed()) {
nonClosedWays.add(jw.getNodes());
} else {
result.add(jw.getNodes());
}
}
return result;
}
private GeneralPath createPath(List<Node> nodes) {
GeneralPath result = new GeneralPath();
result.moveTo((float) nodes.get(0).getCoor().lat(), (float) nodes.get(0).getCoor().lon());
for (int i=1; i<nodes.size(); i++) {
Node n = nodes.get(i);
result.lineTo((float) n.getCoor().lat(), (float) n.getCoor().lon());
}
return result;
}
private List<GeneralPath> createPolygons(List<List<Node>> joinedWays) {
List<GeneralPath> result = new ArrayList<>();
for (List<Node> way : joinedWays) {
result.add(createPath(way));
}
return result;
}
private Intersection getPolygonIntersection(GeneralPath outer, List<Node> inner) {
boolean inside = false;
boolean outside = false;
for (Node n : inner) {
boolean contains = outer.contains(n.getCoor().lat(), n.getCoor().lon());
inside = inside | contains;
outside = outside | !contains;
if (inside & outside) {
return Intersection.CROSSING;
}
}
return inside ? Intersection.INSIDE : Intersection.OUTSIDE;
}
@Override
public void visit(Way w) {
if (!w.isArea() && ElemStyles.hasAreaElemStyle(w, false)) {
List<Node> nodes = w.getNodes();
if (nodes.size()<1) return; // fix zero nodes bug
for (String key : keysCheckedByAnotherTest) {
if (w.hasKey(key)) {
return;
}
}
errors.add(new TestError(this, Severity.WARNING, tr("Area style way is not closed"), NOT_CLOSED,
Collections.singletonList(w), Arrays.asList(nodes.get(0), nodes.get(nodes.size() - 1))));
}
}
@Override
public void visit(Relation r) {
nonClosedWays.clear();
if (r.isMultipolygon()) {
checkMembersAndRoles(r);
Multipolygon polygon = MultipolygonCache.getInstance().get(Main.map.mapView, r);
boolean hasOuterWay = false;
for (RelationMember m : r.getMembers()) {
if ("outer".equals(m.getRole())) {
hasOuterWay = true;
break;
}
}
if (!hasOuterWay) {
addError(r, new TestError(this, Severity.WARNING, tr("No outer way for multipolygon"), MISSING_OUTER_WAY, r));
}
if (r.hasIncompleteMembers()) {
return; // Rest of checks is only for complete multipolygons
}
// Create new multipolygon using the logics from CreateMultipolygonAction and see if roles match.
final Pair<Relation, Relation> newMP = CreateMultipolygonAction.createMultipolygonRelation(r.getMemberPrimitives(Way.class), false);
if (newMP != null) {
for (RelationMember member : r.getMembers()) {
final Collection<RelationMember> memberInNewMP = newMP.b.getMembersFor(Collections.singleton(member.getMember()));
if (memberInNewMP != null && !memberInNewMP.isEmpty()) {
final String roleInNewMP = memberInNewMP.iterator().next().getRole();
if (!member.getRole().equals(roleInNewMP)) {
addError(r, new TestError(this, Severity.WARNING, RelationChecker.ROLE_VERIF_PROBLEM_MSG,
tr("Role for ''{0}'' should be ''{1}''",
member.getMember().getDisplayName(DefaultNameFormatter.getInstance()), roleInNewMP),
MessageFormat.format("Role for ''{0}'' should be ''{1}''",
member.getMember().getDisplayName(DefaultNameFormatter.getInstance()), roleInNewMP),
WRONG_MEMBER_ROLE, Collections.singleton(r), Collections.singleton(member.getMember())));
}
}
}
}
List<List<Node>> innerWays = joinWays(polygon.getInnerWays()); // Side effect - sets nonClosedWays
List<List<Node>> outerWays = joinWays(polygon.getOuterWays());
if (styles != null) {
AreaElemStyle area = ElemStyles.getAreaElemStyle(r, false);
boolean areaStyle = area != null;
// If area style was not found for relation then use style of ways
if (area == null) {
for (Way w : polygon.getOuterWays()) {
area = ElemStyles.getAreaElemStyle(w, true);
if (area != null) {
break;
}
}
if (!"boundary".equals(r.get("type"))) {
if (area == null) {
addError(r, new TestError(this, Severity.OTHER, tr("No style for multipolygon"), NO_STYLE, r));
} else {
addError(r, new TestError(this, Severity.OTHER, tr("No style in multipolygon relation"),
NO_STYLE_POLYGON, r));
}
}
}
if (area != null) {
for (Way wInner : polygon.getInnerWays()) {
AreaElemStyle areaInner = ElemStyles.getAreaElemStyle(wInner, false);
if (areaInner != null && area.equals(areaInner)) {
List<OsmPrimitive> l = new ArrayList<>();
l.add(r);
l.add(wInner);
addError(r, new TestError(this, Severity.WARNING, tr("Style for inner way equals multipolygon"),
INNER_STYLE_MISMATCH, l, Collections.singletonList(wInner)));
}
}
if(!areaStyle) {
for (Way wOuter : polygon.getOuterWays()) {
AreaElemStyle areaOuter = ElemStyles.getAreaElemStyle(wOuter, false);
if (areaOuter != null && !area.equals(areaOuter)) {
List<OsmPrimitive> l = new ArrayList<>();
l.add(r);
l.add(wOuter);
addError(r, new TestError(this, Severity.WARNING, tr("Style for outer way mismatches"),
OUTER_STYLE_MISMATCH, l, Collections.singletonList(wOuter)));
}
}
}
}
}
List<Node> openNodes = new LinkedList<>();
for (List<Node> w : nonClosedWays) {
if (w.size()<1) continue;
openNodes.add(w.get(0));
openNodes.add(w.get(w.size() - 1));
}
if (!openNodes.isEmpty()) {
List<OsmPrimitive> primitives = new LinkedList<>();
primitives.add(r);
primitives.addAll(openNodes);
Arrays.asList(openNodes, r);
addError(r, new TestError(this, Severity.WARNING, tr("Multipolygon is not closed"), NON_CLOSED_WAY,
primitives, openNodes));
}
// For painting is used Polygon class which works with ints only. For validation we need more precision
List<GeneralPath> outerPolygons = createPolygons(outerWays);
for (List<Node> pdInner : innerWays) {
boolean outside = true;
boolean crossing = false;
List<Node> outerWay = null;
for (int i=0; i<outerWays.size(); i++) {
GeneralPath outer = outerPolygons.get(i);
Intersection intersection = getPolygonIntersection(outer, pdInner);
outside = outside & intersection == Intersection.OUTSIDE;
if (intersection == Intersection.CROSSING) {
crossing = true;
outerWay = outerWays.get(i);
}
}
if (outside || crossing) {
List<List<Node>> highlights = new ArrayList<>();
highlights.add(pdInner);
if (outside) {
addError(r, new TestError(this, Severity.WARNING, tr("Multipolygon inner way is outside"), INNER_WAY_OUTSIDE, Collections.singletonList(r), highlights));
} else if (crossing) {
highlights.add(outerWay);
addError(r, new TestError(this, Severity.WARNING, tr("Intersection between multipolygon ways"), CROSSING_WAYS, Collections.singletonList(r), highlights));
}
}
}
}
}
private void checkMembersAndRoles(Relation r) {
for (RelationMember rm : r.getMembers()) {
if (rm.isWay()) {
if (!(rm.hasRole("inner", "outer") || !rm.hasRole())) {
addError(r, new TestError(this, Severity.WARNING, tr("No useful role for multipolygon member"), WRONG_MEMBER_ROLE, rm.getMember()));
}
} else {
if (!rm.hasRole("admin_centre", "label", "subarea", "land_area")) {
addError(r, new TestError(this, Severity.WARNING, tr("Non-Way in multipolygon"), WRONG_MEMBER_TYPE, rm.getMember()));
}
}
}
}
private void addRelationIfNeeded(TestError error, Relation r) {
// Fix #8212 : if the error references only incomplete primitives,
// add multipolygon in order to let user select something and fix the error
Collection<? extends OsmPrimitive> primitives = error.getPrimitives();
if (!primitives.contains(r)) {
for (OsmPrimitive p : primitives) {
if (!p.isIncomplete()) {
return;
}
}
List<OsmPrimitive> newPrimitives = new ArrayList<>(primitives);
newPrimitives.add(0, r);
error.setPrimitives(newPrimitives);
}
}
private void addError(Relation r, TestError error) {
addRelationIfNeeded(error, r);
errors.add(error);
}
}