source: josm/trunk/src/org/openstreetmap/josm/command/PurgeCommand.java@ 16187

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

fix #18962 - introduce DataSet.update to avoid repetitive begin/endUpdate statements
  • Property svn:eol-style set to native
File size: 16.7 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.command;
3
4import static org.openstreetmap.josm.tools.I18n.trn;
5
6import java.util.ArrayList;
7import java.util.Collection;
8import java.util.HashMap;
9import java.util.HashSet;
10import java.util.Iterator;
11import java.util.List;
12import java.util.Map;
13import java.util.Objects;
14import java.util.Set;
15
16import javax.swing.Icon;
17
18import org.openstreetmap.josm.data.conflict.Conflict;
19import org.openstreetmap.josm.data.conflict.ConflictCollection;
20import org.openstreetmap.josm.data.osm.DataSet;
21import org.openstreetmap.josm.data.osm.Node;
22import org.openstreetmap.josm.data.osm.NodeData;
23import org.openstreetmap.josm.data.osm.OsmPrimitive;
24import org.openstreetmap.josm.data.osm.PrimitiveData;
25import org.openstreetmap.josm.data.osm.PrimitiveId;
26import org.openstreetmap.josm.data.osm.Relation;
27import org.openstreetmap.josm.data.osm.RelationData;
28import org.openstreetmap.josm.data.osm.RelationMember;
29import org.openstreetmap.josm.data.osm.Storage;
30import org.openstreetmap.josm.data.osm.Way;
31import org.openstreetmap.josm.data.osm.WayData;
32import org.openstreetmap.josm.spi.preferences.Config;
33import org.openstreetmap.josm.tools.ImageProvider;
34
35/**
36 * Command, to purge a list of primitives.
37 */
38public class PurgeCommand extends Command {
39 protected List<OsmPrimitive> toPurge;
40 protected Storage<PrimitiveData> makeIncompleteData;
41
42 protected Map<PrimitiveId, PrimitiveData> makeIncompleteDataByPrimId;
43
44 protected final ConflictCollection purgedConflicts = new ConflictCollection();
45
46 /**
47 * Constructs a new {@code PurgeCommand} (does not handle conflicts).
48 * This command relies on a number of consistency conditions:
49 * - makeIncomplete must be a subset of toPurge.
50 * - Each primitive, that is in toPurge but not in makeIncomplete, must have all its referrers in toPurge.
51 * - Each element of makeIncomplete must not be new and must have only referrers that are either a relation or included in toPurge.
52 * @param data OSM data set
53 * @param toPurge primitives to purge
54 * @param makeIncomplete primitives to make incomplete
55 * @since 11240
56 */
57 public PurgeCommand(DataSet data, Collection<OsmPrimitive> toPurge, Collection<OsmPrimitive> makeIncomplete) {
58 super(data);
59 init(toPurge, makeIncomplete);
60 }
61
62 private void init(Collection<OsmPrimitive> toPurge, Collection<OsmPrimitive> makeIncomplete) {
63 /**
64 * The topological sort is to avoid missing way nodes and missing
65 * relation members when adding primitives back to the dataset on undo.
66 *
67 * The same should hold for normal execution, but at time of writing
68 * there seem to be no such consistency checks when removing primitives.
69 * (It is done in a save manner, anyway.)
70 */
71 this.toPurge = topoSort(toPurge);
72 saveIncomplete(makeIncomplete);
73 }
74
75 protected final void saveIncomplete(Collection<OsmPrimitive> makeIncomplete) {
76 makeIncompleteData = new Storage<>(new Storage.PrimitiveIdHash());
77 makeIncompleteDataByPrimId = makeIncompleteData.foreignKey(new Storage.PrimitiveIdHash());
78
79 for (OsmPrimitive osm : makeIncomplete) {
80 makeIncompleteData.add(osm.save());
81 }
82 }
83
84 @Override
85 public boolean executeCommand() {
86 getAffectedDataSet().update(() -> {
87 purgedConflicts.get().clear();
88 // unselect primitives in advance to not fire a selection change for every one of them
89 getAffectedDataSet().clearSelection(toPurge);
90 // Loop from back to front to keep referential integrity.
91 for (int i = toPurge.size()-1; i >= 0; --i) {
92 OsmPrimitive osm = toPurge.get(i);
93 if (makeIncompleteDataByPrimId.containsKey(osm)) {
94 // we could simply set the incomplete flag
95 // but that would not free memory in case the
96 // user clears undo/redo buffer after purge
97 PrimitiveData empty;
98 switch(osm.getType()) {
99 case NODE: empty = new NodeData(); break;
100 case WAY: empty = new WayData(); break;
101 case RELATION: empty = new RelationData(); break;
102 default: throw new AssertionError();
103 }
104 empty.setId(osm.getUniqueId());
105 empty.setIncomplete(true);
106 osm.load(empty);
107 } else {
108 getAffectedDataSet().removePrimitive(osm);
109 Conflict<?> conflict = getAffectedDataSet().getConflicts().getConflictForMy(osm);
110 if (conflict != null) {
111 purgedConflicts.add(conflict);
112 getAffectedDataSet().getConflicts().remove(conflict);
113 }
114 }
115 }
116 getAffectedDataSet().clearMappaintCache();
117 });
118 return true;
119 }
120
121 @Override
122 public void undoCommand() {
123 if (getAffectedDataSet() == null)
124 return;
125
126 getAffectedDataSet().update(() -> {
127 for (OsmPrimitive osm : toPurge) {
128 PrimitiveData data = makeIncompleteDataByPrimId.get(osm);
129 if (data != null) {
130 if (getAffectedDataSet().getPrimitiveById(osm) != osm)
131 throw new AssertionError(
132 String.format("Primitive %s has been made incomplete when purging, but it cannot be found on undo.", osm));
133 osm.load(data);
134 } else {
135 if (getAffectedDataSet().getPrimitiveById(osm) != null)
136 throw new AssertionError(String.format("Primitive %s was removed when purging, but is still there on undo", osm));
137 getAffectedDataSet().addPrimitive(osm);
138 }
139 }
140
141 for (Conflict<?> conflict : purgedConflicts) {
142 getAffectedDataSet().getConflicts().add(conflict);
143 }
144 getAffectedDataSet().clearMappaintCache();
145 });
146 }
147
148 /**
149 * Sorts a collection of primitives such that for each object
150 * its referrers come later in the sorted collection.
151 * @param sel collection of primitives to sort
152 * @return sorted list
153 */
154 public static List<OsmPrimitive> topoSort(Collection<OsmPrimitive> sel) {
155 Set<OsmPrimitive> in = new HashSet<>(sel);
156 List<OsmPrimitive> out = new ArrayList<>(in.size());
157 Set<Relation> inR = new HashSet<>();
158
159 // Nodes not deleted in the first pass
160 Set<OsmPrimitive> remainingNodes = new HashSet<>(in.size());
161
162 /**
163 * First add nodes that have no way referrer.
164 */
165 outer:
166 for (Iterator<OsmPrimitive> it = in.iterator(); it.hasNext();) {
167 OsmPrimitive u = it.next();
168 if (u instanceof Node) {
169 Node n = (Node) u;
170 for (OsmPrimitive ref : n.getReferrers()) {
171 if (ref instanceof Way && in.contains(ref)) {
172 it.remove();
173 remainingNodes.add(n);
174 continue outer;
175 }
176 }
177 it.remove();
178 out.add(n);
179 }
180 }
181
182 /**
183 * Then add all ways, each preceded by its (remaining) nodes.
184 */
185 for (Iterator<OsmPrimitive> it = in.iterator(); it.hasNext();) {
186 OsmPrimitive u = it.next();
187 if (u instanceof Way) {
188 Way w = (Way) u;
189 it.remove();
190 for (Node n : w.getNodes()) {
191 if (remainingNodes.contains(n)) {
192 remainingNodes.remove(n);
193 out.add(n);
194 }
195 }
196 out.add(w);
197 } else if (u instanceof Relation) {
198 inR.add((Relation) u);
199 }
200 }
201
202 if (!remainingNodes.isEmpty())
203 throw new AssertionError("topo sort algorithm failed (nodes remaining)");
204
205 // Do topological sorting on a DAG where each arrow points from child to parent.
206 // (Because it is faster to loop over getReferrers() than getMembers().)
207
208 Map<Relation, Integer> numChilds = new HashMap<>();
209
210 // calculate initial number of childs
211 for (Relation r : inR) {
212 numChilds.put(r, 0);
213 }
214 for (Relation r : inR) {
215 for (OsmPrimitive parent : r.getReferrers()) {
216 if (!(parent instanceof Relation))
217 throw new AssertionError();
218 Integer i = numChilds.get(parent);
219 if (i != null) {
220 numChilds.put((Relation) parent, i+1);
221 }
222 }
223 }
224 Set<Relation> childlessR = new HashSet<>();
225 for (Relation r : inR) {
226 if (numChilds.get(r).equals(0)) {
227 childlessR.add(r);
228 }
229 }
230
231 List<Relation> outR = new ArrayList<>(inR.size());
232 while (!childlessR.isEmpty()) {
233 // Identify one childless Relation and let it virtually die. This makes other relations childless.
234 Iterator<Relation> it = childlessR.iterator();
235 Relation next = it.next();
236 it.remove();
237 outR.add(next);
238
239 for (OsmPrimitive parentPrim : next.getReferrers()) {
240 Relation parent = (Relation) parentPrim;
241 Integer i = numChilds.get(parent);
242 if (i != null) {
243 numChilds.put(parent, i-1);
244 if (i-1 == 0) {
245 childlessR.add(parent);
246 }
247 }
248 }
249 }
250
251 if (outR.size() != inR.size())
252 throw new AssertionError("topo sort algorithm failed");
253
254 out.addAll(outR);
255
256 return out;
257 }
258
259 @Override
260 public String getDescriptionText() {
261 return trn("Purged {0} object", "Purged {0} objects", toPurge.size(), toPurge.size());
262 }
263
264 @Override
265 public Icon getDescriptionIcon() {
266 return ImageProvider.get("data", "purge");
267 }
268
269 @Override
270 public Collection<? extends OsmPrimitive> getParticipatingPrimitives() {
271 return toPurge;
272 }
273
274 @Override
275 public void fillModifiedData(Collection<OsmPrimitive> modified, Collection<OsmPrimitive> deleted, Collection<OsmPrimitive> added) {
276 // Do nothing
277 }
278
279 @Override
280 public int hashCode() {
281 return Objects.hash(super.hashCode(), toPurge, makeIncompleteData, makeIncompleteDataByPrimId, purgedConflicts, getAffectedDataSet());
282 }
283
284 @Override
285 public boolean equals(Object obj) {
286 if (this == obj) return true;
287 if (obj == null || getClass() != obj.getClass()) return false;
288 if (!super.equals(obj)) return false;
289 PurgeCommand that = (PurgeCommand) obj;
290 return Objects.equals(toPurge, that.toPurge) &&
291 Objects.equals(makeIncompleteData, that.makeIncompleteData) &&
292 Objects.equals(makeIncompleteDataByPrimId, that.makeIncompleteDataByPrimId) &&
293 Objects.equals(purgedConflicts, that.purgedConflicts);
294 }
295
296 /**
297 * Creates a new {@code PurgeCommand} to purge selected OSM primitives.
298 * @param sel selected OSM primitives
299 * @param toPurgeAdditionally optional list that will be filled with primitives to be purged that have not been in the selection
300 * @return command to purge selected OSM primitives
301 * @since 12718
302 */
303 public static PurgeCommand build(Collection<OsmPrimitive> sel, List<OsmPrimitive> toPurgeAdditionally) {
304 Set<OsmPrimitive> toPurge = new HashSet<>(sel);
305 // finally, contains all objects that are purged
306 Set<OsmPrimitive> toPurgeChecked = new HashSet<>();
307
308 // Add referrer, unless the object to purge is not new and the parent is a relation
309 Set<OsmPrimitive> toPurgeRecursive = new HashSet<>();
310 while (!toPurge.isEmpty()) {
311
312 for (OsmPrimitive osm: toPurge) {
313 for (OsmPrimitive parent: osm.getReferrers()) {
314 if (toPurge.contains(parent) || toPurgeChecked.contains(parent) || toPurgeRecursive.contains(parent)) {
315 continue;
316 }
317 if (parent instanceof Way || (parent instanceof Relation && osm.isNew())) {
318 if (toPurgeAdditionally != null) {
319 toPurgeAdditionally.add(parent);
320 }
321 toPurgeRecursive.add(parent);
322 }
323 }
324 toPurgeChecked.add(osm);
325 }
326 toPurge = toPurgeRecursive;
327 toPurgeRecursive = new HashSet<>();
328 }
329
330 // Subset of toPurgeChecked. Marks primitives that remain in the dataset, but incomplete.
331 Set<OsmPrimitive> makeIncomplete = new HashSet<>();
332
333 // Find the objects that will be incomplete after purging.
334 // At this point, all parents of new to-be-purged primitives are
335 // also to-be-purged and
336 // all parents of not-new to-be-purged primitives are either
337 // to-be-purged or of type relation.
338 TOP:
339 for (OsmPrimitive child : toPurgeChecked) {
340 if (child.isNew()) {
341 continue;
342 }
343 for (OsmPrimitive parent : child.getReferrers()) {
344 if (parent instanceof Relation && !toPurgeChecked.contains(parent)) {
345 makeIncomplete.add(child);
346 continue TOP;
347 }
348 }
349 }
350
351 // Add untagged way nodes. Do not add nodes that have other referrers not yet to-be-purged.
352 if (Config.getPref().getBoolean("purge.add_untagged_waynodes", true)) {
353 Set<OsmPrimitive> wayNodes = new HashSet<>();
354 for (OsmPrimitive osm : toPurgeChecked) {
355 if (osm instanceof Way) {
356 Way w = (Way) osm;
357 NODE:
358 for (Node n : w.getNodes()) {
359 if (n.isTagged() || toPurgeChecked.contains(n)) {
360 continue;
361 }
362 for (OsmPrimitive ref : n.getReferrers()) {
363 if (ref != w && !toPurgeChecked.contains(ref)) {
364 continue NODE;
365 }
366 }
367 wayNodes.add(n);
368 }
369 }
370 }
371 toPurgeChecked.addAll(wayNodes);
372 if (toPurgeAdditionally != null) {
373 toPurgeAdditionally.addAll(wayNodes);
374 }
375 }
376
377 if (Config.getPref().getBoolean("purge.add_relations_with_only_incomplete_members", true)) {
378 Set<Relation> relSet = new HashSet<>();
379 for (OsmPrimitive osm : toPurgeChecked) {
380 for (OsmPrimitive parent : osm.getReferrers()) {
381 if (parent instanceof Relation
382 && !(toPurgeChecked.contains(parent))
383 && hasOnlyIncompleteMembers((Relation) parent, toPurgeChecked, relSet)) {
384 relSet.add((Relation) parent);
385 }
386 }
387 }
388
389 // Add higher level relations (list gets extended while looping over it)
390 List<Relation> relLst = new ArrayList<>(relSet);
391 for (int i = 0; i < relLst.size(); ++i) { // foreach loop not applicable since list gets extended while looping over it
392 for (OsmPrimitive parent : relLst.get(i).getReferrers()) {
393 if (!(toPurgeChecked.contains(parent))
394 && hasOnlyIncompleteMembers((Relation) parent, toPurgeChecked, relLst)) {
395 relLst.add((Relation) parent);
396 }
397 }
398 }
399 relSet = new HashSet<>(relLst);
400 toPurgeChecked.addAll(relSet);
401 if (toPurgeAdditionally != null) {
402 toPurgeAdditionally.addAll(relSet);
403 }
404 }
405
406 return new PurgeCommand(toPurgeChecked.iterator().next().getDataSet(), toPurgeChecked, makeIncomplete);
407 }
408
409 private static boolean hasOnlyIncompleteMembers(
410 Relation r, Collection<OsmPrimitive> toPurge, Collection<? extends OsmPrimitive> moreToPurge) {
411 for (RelationMember m : r.getMembers()) {
412 if (!m.getMember().isIncomplete() && !toPurge.contains(m.getMember()) && !moreToPurge.contains(m.getMember()))
413 return false;
414 }
415 return true;
416 }
417}
Note: See TracBrowser for help on using the repository browser.