001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.command; 003 004import static org.openstreetmap.josm.tools.I18n.marktr; 005import static org.openstreetmap.josm.tools.I18n.tr; 006import static org.openstreetmap.josm.tools.I18n.trn; 007 008import java.awt.GridBagLayout; 009import java.util.ArrayList; 010import java.util.Collection; 011import java.util.Collections; 012import java.util.EnumSet; 013import java.util.HashMap; 014import java.util.HashSet; 015import java.util.Iterator; 016import java.util.LinkedList; 017import java.util.List; 018import java.util.Map; 019import java.util.Map.Entry; 020import java.util.Objects; 021import java.util.Set; 022 023import javax.swing.Icon; 024import javax.swing.JOptionPane; 025import javax.swing.JPanel; 026 027import org.openstreetmap.josm.Main; 028import org.openstreetmap.josm.actions.SplitWayAction; 029import org.openstreetmap.josm.data.osm.Node; 030import org.openstreetmap.josm.data.osm.OsmPrimitive; 031import org.openstreetmap.josm.data.osm.OsmPrimitiveType; 032import org.openstreetmap.josm.data.osm.PrimitiveData; 033import org.openstreetmap.josm.data.osm.Relation; 034import org.openstreetmap.josm.data.osm.RelationToChildReference; 035import org.openstreetmap.josm.data.osm.Way; 036import org.openstreetmap.josm.data.osm.WaySegment; 037import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil; 038import org.openstreetmap.josm.gui.DefaultNameFormatter; 039import org.openstreetmap.josm.gui.dialogs.DeleteFromRelationConfirmationDialog; 040import org.openstreetmap.josm.gui.layer.OsmDataLayer; 041import org.openstreetmap.josm.gui.widgets.JMultilineLabel; 042import org.openstreetmap.josm.tools.CheckParameterUtil; 043import org.openstreetmap.josm.tools.ImageProvider; 044import org.openstreetmap.josm.tools.Utils; 045 046/** 047 * A command to delete a number of primitives from the dataset. 048 * @since 23 049 */ 050public class DeleteCommand extends Command { 051 /** 052 * The primitives that get deleted. 053 */ 054 private final Collection<? extends OsmPrimitive> toDelete; 055 private final Map<OsmPrimitive, PrimitiveData> clonedPrimitives = new HashMap<>(); 056 057 /** 058 * Constructor. Deletes a collection of primitives in the current edit layer. 059 * 060 * @param data the primitives to delete. Must neither be null nor empty. 061 * @throws IllegalArgumentException if data is null or empty 062 */ 063 public DeleteCommand(Collection<? extends OsmPrimitive> data) { 064 CheckParameterUtil.ensureParameterNotNull(data, "data"); 065 if (data.isEmpty()) 066 throw new IllegalArgumentException(tr("At least one object to delete required, got empty collection")); 067 this.toDelete = data; 068 checkConsistency(); 069 } 070 071 /** 072 * Constructor. Deletes a single primitive in the current edit layer. 073 * 074 * @param data the primitive to delete. Must not be null. 075 * @throws IllegalArgumentException if data is null 076 */ 077 public DeleteCommand(OsmPrimitive data) { 078 this(Collections.singleton(data)); 079 } 080 081 /** 082 * Constructor for a single data item. Use the collection constructor to delete multiple 083 * objects. 084 * 085 * @param layer the layer context for deleting this primitive. Must not be null. 086 * @param data the primitive to delete. Must not be null. 087 * @throws IllegalArgumentException if data is null 088 * @throws IllegalArgumentException if layer is null 089 */ 090 public DeleteCommand(OsmDataLayer layer, OsmPrimitive data) { 091 this(layer, Collections.singleton(data)); 092 } 093 094 /** 095 * Constructor for a collection of data to be deleted in the context of 096 * a specific layer 097 * 098 * @param layer the layer context for deleting these primitives. Must not be null. 099 * @param data the primitives to delete. Must neither be null nor empty. 100 * @throws IllegalArgumentException if layer is null 101 * @throws IllegalArgumentException if data is null or empty 102 */ 103 public DeleteCommand(OsmDataLayer layer, Collection<? extends OsmPrimitive> data) { 104 super(layer); 105 CheckParameterUtil.ensureParameterNotNull(data, "data"); 106 if (data.isEmpty()) 107 throw new IllegalArgumentException(tr("At least one object to delete required, got empty collection")); 108 this.toDelete = data; 109 checkConsistency(); 110 } 111 112 private void checkConsistency() { 113 for (OsmPrimitive p : toDelete) { 114 if (p == null) { 115 throw new IllegalArgumentException("Primitive to delete must not be null"); 116 } else if (p.getDataSet() == null) { 117 throw new IllegalArgumentException("Primitive to delete must be in a dataset"); 118 } 119 } 120 } 121 122 @Override 123 public boolean executeCommand() { 124 // Make copy and remove all references (to prevent inconsistent dataset (delete referenced) while command is executed) 125 for (OsmPrimitive osm: toDelete) { 126 if (osm.isDeleted()) 127 throw new IllegalArgumentException(osm + " is already deleted"); 128 clonedPrimitives.put(osm, osm.save()); 129 130 if (osm instanceof Way) { 131 ((Way) osm).setNodes(null); 132 } else if (osm instanceof Relation) { 133 ((Relation) osm).setMembers(null); 134 } 135 } 136 137 for (OsmPrimitive osm: toDelete) { 138 osm.setDeleted(true); 139 } 140 141 return true; 142 } 143 144 @Override 145 public void undoCommand() { 146 for (OsmPrimitive osm: toDelete) { 147 osm.setDeleted(false); 148 } 149 150 for (Entry<OsmPrimitive, PrimitiveData> entry: clonedPrimitives.entrySet()) { 151 entry.getKey().load(entry.getValue()); 152 } 153 } 154 155 @Override 156 public void fillModifiedData(Collection<OsmPrimitive> modified, Collection<OsmPrimitive> deleted, 157 Collection<OsmPrimitive> added) { 158 } 159 160 private Set<OsmPrimitiveType> getTypesToDelete() { 161 Set<OsmPrimitiveType> typesToDelete = EnumSet.noneOf(OsmPrimitiveType.class); 162 for (OsmPrimitive osm : toDelete) { 163 typesToDelete.add(OsmPrimitiveType.from(osm)); 164 } 165 return typesToDelete; 166 } 167 168 @Override 169 public String getDescriptionText() { 170 if (toDelete.size() == 1) { 171 OsmPrimitive primitive = toDelete.iterator().next(); 172 String msg = ""; 173 switch(OsmPrimitiveType.from(primitive)) { 174 case NODE: msg = marktr("Delete node {0}"); break; 175 case WAY: msg = marktr("Delete way {0}"); break; 176 case RELATION:msg = marktr("Delete relation {0}"); break; 177 } 178 179 return tr(msg, primitive.getDisplayName(DefaultNameFormatter.getInstance())); 180 } else { 181 Set<OsmPrimitiveType> typesToDelete = getTypesToDelete(); 182 String msg = ""; 183 if (typesToDelete.size() > 1) { 184 msg = trn("Delete {0} object", "Delete {0} objects", toDelete.size(), toDelete.size()); 185 } else { 186 OsmPrimitiveType t = typesToDelete.iterator().next(); 187 switch(t) { 188 case NODE: msg = trn("Delete {0} node", "Delete {0} nodes", toDelete.size(), toDelete.size()); break; 189 case WAY: msg = trn("Delete {0} way", "Delete {0} ways", toDelete.size(), toDelete.size()); break; 190 case RELATION: msg = trn("Delete {0} relation", "Delete {0} relations", toDelete.size(), toDelete.size()); break; 191 } 192 } 193 return msg; 194 } 195 } 196 197 @Override 198 public Icon getDescriptionIcon() { 199 if (toDelete.size() == 1) 200 return ImageProvider.get(toDelete.iterator().next().getDisplayType()); 201 Set<OsmPrimitiveType> typesToDelete = getTypesToDelete(); 202 if (typesToDelete.size() > 1) 203 return ImageProvider.get("data", "object"); 204 else 205 return ImageProvider.get(typesToDelete.iterator().next()); 206 } 207 208 @Override public Collection<PseudoCommand> getChildren() { 209 if (toDelete.size() == 1) 210 return null; 211 else { 212 List<PseudoCommand> children = new ArrayList<>(toDelete.size()); 213 for (final OsmPrimitive osm : toDelete) { 214 children.add(new PseudoCommand() { 215 216 @Override public String getDescriptionText() { 217 return tr("Deleted ''{0}''", osm.getDisplayName(DefaultNameFormatter.getInstance())); 218 } 219 220 @Override public Icon getDescriptionIcon() { 221 return ImageProvider.get(osm.getDisplayType()); 222 } 223 224 @Override public Collection<? extends OsmPrimitive> getParticipatingPrimitives() { 225 return Collections.singleton(osm); 226 } 227 228 }); 229 } 230 return children; 231 232 } 233 } 234 235 @Override public Collection<? extends OsmPrimitive> getParticipatingPrimitives() { 236 return toDelete; 237 } 238 239 /** 240 * Delete the primitives and everything they reference. 241 * 242 * If a node is deleted, the node and all ways and relations the node is part of are deleted as well. 243 * If a way is deleted, all relations the way is member of are also deleted. 244 * If a way is deleted, only the way and no nodes are deleted. 245 * 246 * @param layer the {@link OsmDataLayer} in whose context primitives are deleted. Must not be null. 247 * @param selection The list of all object to be deleted. 248 * @param silent Set to true if the user should not be bugged with additional dialogs 249 * @return command A command to perform the deletions, or null of there is nothing to delete. 250 * @throws IllegalArgumentException if layer is null 251 */ 252 public static Command deleteWithReferences(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection, boolean silent) { 253 CheckParameterUtil.ensureParameterNotNull(layer, "layer"); 254 if (selection == null || selection.isEmpty()) return null; 255 Set<OsmPrimitive> parents = OsmPrimitive.getReferrer(selection); 256 parents.addAll(selection); 257 258 if (parents.isEmpty()) 259 return null; 260 if (!silent && !checkAndConfirmOutlyingDelete(parents, null)) 261 return null; 262 return new DeleteCommand(layer, parents); 263 } 264 265 /** 266 * Delete the primitives and everything they reference. 267 * 268 * If a node is deleted, the node and all ways and relations the node is part of are deleted as well. 269 * If a way is deleted, all relations the way is member of are also deleted. 270 * If a way is deleted, only the way and no nodes are deleted. 271 * 272 * @param layer the {@link OsmDataLayer} in whose context primitives are deleted. Must not be null. 273 * @param selection The list of all object to be deleted. 274 * @return command A command to perform the deletions, or null of there is nothing to delete. 275 * @throws IllegalArgumentException if layer is null 276 */ 277 public static Command deleteWithReferences(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection) { 278 return deleteWithReferences(layer, selection, false); 279 } 280 281 /** 282 * Try to delete all given primitives. 283 * 284 * If a node is used by a way, it's removed from that way. If a node or a way is used by a 285 * relation, inform the user and do not delete. 286 * 287 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If 288 * they are part of a relation, inform the user and do not delete. 289 * 290 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted 291 * @param selection the objects to delete. 292 * @return command a command to perform the deletions, or null if there is nothing to delete. 293 */ 294 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection) { 295 return delete(layer, selection, true, false); 296 } 297 298 /** 299 * Replies the collection of nodes referred to by primitives in <code>primitivesToDelete</code> which 300 * can be deleted too. A node can be deleted if 301 * <ul> 302 * <li>it is untagged (see {@link Node#isTagged()}</li> 303 * <li>it is not referred to by other non-deleted primitives outside of <code>primitivesToDelete</code></li> 304 * </ul> 305 * @param primitivesToDelete the primitives to delete 306 * @return the collection of nodes referred to by primitives in <code>primitivesToDelete</code> which 307 * can be deleted too 308 */ 309 protected static Collection<Node> computeNodesToDelete(Collection<OsmPrimitive> primitivesToDelete) { 310 Collection<Node> nodesToDelete = new HashSet<>(); 311 for (Way way : OsmPrimitive.getFilteredList(primitivesToDelete, Way.class)) { 312 for (Node n : way.getNodes()) { 313 if (n.isTagged()) { 314 continue; 315 } 316 Collection<OsmPrimitive> referringPrimitives = n.getReferrers(); 317 referringPrimitives.removeAll(primitivesToDelete); 318 int count = 0; 319 for (OsmPrimitive p : referringPrimitives) { 320 if (!p.isDeleted()) { 321 count++; 322 } 323 } 324 if (count == 0) { 325 nodesToDelete.add(n); 326 } 327 } 328 } 329 return nodesToDelete; 330 } 331 332 /** 333 * Try to delete all given primitives. 334 * 335 * If a node is used by a way, it's removed from that way. If a node or a way is used by a 336 * relation, inform the user and do not delete. 337 * 338 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If 339 * they are part of a relation, inform the user and do not delete. 340 * 341 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted 342 * @param selection the objects to delete. 343 * @param alsoDeleteNodesInWay <code>true</code> if nodes should be deleted as well 344 * @return command a command to perform the deletions, or null if there is nothing to delete. 345 */ 346 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection, 347 boolean alsoDeleteNodesInWay) { 348 return delete(layer, selection, alsoDeleteNodesInWay, false /* not silent */); 349 } 350 351 /** 352 * Try to delete all given primitives. 353 * 354 * If a node is used by a way, it's removed from that way. If a node or a way is used by a 355 * relation, inform the user and do not delete. 356 * 357 * If this would cause ways with less than 2 nodes to be created, delete these ways instead. If 358 * they are part of a relation, inform the user and do not delete. 359 * 360 * @param layer the {@link OsmDataLayer} in whose context the primitives are deleted 361 * @param selection the objects to delete. 362 * @param alsoDeleteNodesInWay <code>true</code> if nodes should be deleted as well 363 * @param silent set to true if the user should not be bugged with additional questions 364 * @return command a command to perform the deletions, or null if there is nothing to delete. 365 */ 366 public static Command delete(OsmDataLayer layer, Collection<? extends OsmPrimitive> selection, 367 boolean alsoDeleteNodesInWay, boolean silent) { 368 if (selection == null || selection.isEmpty()) 369 return null; 370 371 // Diamond operator does not work with Java 9 here 372 @SuppressWarnings("unused") 373 Set<OsmPrimitive> primitivesToDelete = new HashSet<OsmPrimitive>(selection); 374 375 Collection<Relation> relationsToDelete = Utils.filteredCollection(primitivesToDelete, Relation.class); 376 if (!relationsToDelete.isEmpty() && !silent && !confirmRelationDeletion(relationsToDelete)) 377 return null; 378 379 if (alsoDeleteNodesInWay) { 380 // delete untagged nodes only referenced by primitives in primitivesToDelete, too 381 Collection<Node> nodesToDelete = computeNodesToDelete(primitivesToDelete); 382 primitivesToDelete.addAll(nodesToDelete); 383 } 384 385 if (!silent && !checkAndConfirmOutlyingDelete( 386 primitivesToDelete, Utils.filteredCollection(primitivesToDelete, Way.class))) 387 return null; 388 389 Collection<Way> waysToBeChanged = new HashSet<>(OsmPrimitive.getFilteredSet(OsmPrimitive.getReferrer(primitivesToDelete), Way.class)); 390 391 Collection<Command> cmds = new LinkedList<>(); 392 for (Way w : waysToBeChanged) { 393 Way wnew = new Way(w); 394 wnew.removeNodes(OsmPrimitive.getFilteredSet(primitivesToDelete, Node.class)); 395 if (wnew.getNodesCount() < 2) { 396 primitivesToDelete.add(w); 397 } else { 398 cmds.add(new ChangeNodesCommand(w, wnew.getNodes())); 399 } 400 } 401 402 // get a confirmation that the objects to delete can be removed from their parent relations 403 // 404 if (!silent) { 405 Set<RelationToChildReference> references = RelationToChildReference.getRelationToChildReferences(primitivesToDelete); 406 Iterator<RelationToChildReference> it = references.iterator(); 407 while (it.hasNext()) { 408 RelationToChildReference ref = it.next(); 409 if (ref.getParent().isDeleted()) { 410 it.remove(); 411 } 412 } 413 if (!references.isEmpty()) { 414 DeleteFromRelationConfirmationDialog dialog = DeleteFromRelationConfirmationDialog.getInstance(); 415 dialog.getModel().populate(references); 416 dialog.setVisible(true); 417 if (dialog.isCanceled()) 418 return null; 419 } 420 } 421 422 // remove the objects from their parent relations 423 // 424 for (Relation cur : OsmPrimitive.getFilteredSet(OsmPrimitive.getReferrer(primitivesToDelete), Relation.class)) { 425 Relation rel = new Relation(cur); 426 rel.removeMembersFor(primitivesToDelete); 427 cmds.add(new ChangeCommand(cur, rel)); 428 } 429 430 // build the delete command 431 // 432 if (!primitivesToDelete.isEmpty()) { 433 cmds.add(new DeleteCommand(layer, primitivesToDelete)); 434 } 435 436 return new SequenceCommand(tr("Delete"), cmds); 437 } 438 439 public static Command deleteWaySegment(OsmDataLayer layer, WaySegment ws) { 440 if (ws.way.getNodesCount() < 3) 441 return delete(layer, Collections.singleton(ws.way), false); 442 443 if (ws.way.isClosed()) { 444 // If the way is circular (first and last nodes are the same), the way shouldn't be splitted 445 446 List<Node> n = new ArrayList<>(); 447 448 n.addAll(ws.way.getNodes().subList(ws.lowerIndex + 1, ws.way.getNodesCount() - 1)); 449 n.addAll(ws.way.getNodes().subList(0, ws.lowerIndex + 1)); 450 451 Way wnew = new Way(ws.way); 452 wnew.setNodes(n); 453 454 return new ChangeCommand(ws.way, wnew); 455 } 456 457 List<Node> n1 = new ArrayList<>(); 458 List<Node> n2 = new ArrayList<>(); 459 460 n1.addAll(ws.way.getNodes().subList(0, ws.lowerIndex + 1)); 461 n2.addAll(ws.way.getNodes().subList(ws.lowerIndex + 1, ws.way.getNodesCount())); 462 463 Way wnew = new Way(ws.way); 464 465 if (n1.size() < 2) { 466 wnew.setNodes(n2); 467 return new ChangeCommand(ws.way, wnew); 468 } else if (n2.size() < 2) { 469 wnew.setNodes(n1); 470 return new ChangeCommand(ws.way, wnew); 471 } else { 472 List<List<Node>> chunks = new ArrayList<>(2); 473 chunks.add(n1); 474 chunks.add(n2); 475 return SplitWayAction.splitWay(layer, ws.way, chunks, Collections.<OsmPrimitive>emptyList()).getCommand(); 476 } 477 } 478 479 public static boolean checkAndConfirmOutlyingDelete(Collection<? extends OsmPrimitive> primitives, 480 Collection<? extends OsmPrimitive> ignore) { 481 return Command.checkAndConfirmOutlyingOperation("delete", 482 tr("Delete confirmation"), 483 tr("You are about to delete nodes outside of the area you have downloaded." 484 + "<br>" 485 + "This can cause problems because other objects (that you do not see) might use them." 486 + "<br>" 487 + "Do you really want to delete?"), 488 tr("You are about to delete incomplete objects." 489 + "<br>" 490 + "This will cause problems because you don''t see the real object." 491 + "<br>" + "Do you really want to delete?"), 492 primitives, ignore); 493 } 494 495 private static boolean confirmRelationDeletion(Collection<Relation> relations) { 496 JPanel msg = new JPanel(new GridBagLayout()); 497 msg.add(new JMultilineLabel("<html>" + trn( 498 "You are about to delete {0} relation: {1}" 499 + "<br/>" 500 + "This step is rarely necessary and cannot be undone easily after being uploaded to the server." 501 + "<br/>" 502 + "Do you really want to delete?", 503 "You are about to delete {0} relations: {1}" 504 + "<br/>" 505 + "This step is rarely necessary and cannot be undone easily after being uploaded to the server." 506 + "<br/>" 507 + "Do you really want to delete?", 508 relations.size(), relations.size(), DefaultNameFormatter.getInstance().formatAsHtmlUnorderedList(relations, 20)) 509 + "</html>")); 510 return ConditionalOptionPaneUtil.showConfirmationDialog( 511 "delete_relations", 512 Main.parent, 513 msg, 514 tr("Delete relation?"), 515 JOptionPane.YES_NO_OPTION, 516 JOptionPane.QUESTION_MESSAGE, 517 JOptionPane.YES_OPTION); 518 } 519 520 @Override 521 public int hashCode() { 522 return Objects.hash(super.hashCode(), toDelete, clonedPrimitives); 523 } 524 525 @Override 526 public boolean equals(Object obj) { 527 if (this == obj) return true; 528 if (obj == null || getClass() != obj.getClass()) return false; 529 if (!super.equals(obj)) return false; 530 DeleteCommand that = (DeleteCommand) obj; 531 return Objects.equals(toDelete, that.toDelete) && 532 Objects.equals(clonedPrimitives, that.clonedPrimitives); 533 } 534}