source: josm/trunk/src/org/openstreetmap/josm/actions/PurgeAction.java@ 11240

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

see #10387 - refactor various actions and commands so they can be used without data layer
  • Property svn:eol-style set to native
File size: 13.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Component;
7import java.awt.Dimension;
8import java.awt.GraphicsEnvironment;
9import java.awt.GridBagLayout;
10import java.awt.Insets;
11import java.awt.event.ActionEvent;
12import java.awt.event.KeyEvent;
13import java.util.ArrayList;
14import java.util.Collection;
15import java.util.HashSet;
16import java.util.List;
17import java.util.Set;
18
19import javax.swing.AbstractAction;
20import javax.swing.BorderFactory;
21import javax.swing.Box;
22import javax.swing.JButton;
23import javax.swing.JCheckBox;
24import javax.swing.JLabel;
25import javax.swing.JList;
26import javax.swing.JOptionPane;
27import javax.swing.JPanel;
28import javax.swing.JScrollPane;
29import javax.swing.JSeparator;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.command.PurgeCommand;
33import org.openstreetmap.josm.data.osm.DataSet;
34import org.openstreetmap.josm.data.osm.Node;
35import org.openstreetmap.josm.data.osm.OsmPrimitive;
36import org.openstreetmap.josm.data.osm.Relation;
37import org.openstreetmap.josm.data.osm.RelationMember;
38import org.openstreetmap.josm.data.osm.Way;
39import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
40import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
41import org.openstreetmap.josm.gui.help.HelpUtil;
42import org.openstreetmap.josm.gui.layer.OsmDataLayer;
43import org.openstreetmap.josm.tools.GBC;
44import org.openstreetmap.josm.tools.ImageProvider;
45import org.openstreetmap.josm.tools.Shortcut;
46
47/**
48 * The action to purge the selected primitives, i.e. remove them from the
49 * data layer, or remove their content and make them incomplete.
50 *
51 * This means, the deleted flag is not affected and JOSM simply forgets
52 * about these primitives.
53 *
54 * This action is undo-able. In order not to break previous commands in the
55 * undo buffer, we must re-add the identical object (and not semantically
56 * equal ones).
57 */
58public class PurgeAction extends JosmAction {
59
60 /**
61 * Constructs a new {@code PurgeAction}.
62 */
63 public PurgeAction() {
64 /* translator note: other expressions for "purge" might be "forget", "clean", "obliterate", "prune" */
65 super(tr("Purge..."), "purge", tr("Forget objects but do not delete them on server when uploading."),
66 Shortcut.registerShortcut("system:purge", tr("Edit: {0}", tr("Purge")),
67 KeyEvent.VK_P, Shortcut.CTRL_SHIFT),
68 true);
69 putValue("help", HelpUtil.ht("/Action/Purge"));
70 }
71
72 protected transient OsmDataLayer layer;
73 protected JCheckBox cbClearUndoRedo;
74
75 protected transient Set<OsmPrimitive> toPurge;
76 /**
77 * finally, contains all objects that are purged
78 */
79 protected transient Set<OsmPrimitive> toPurgeChecked;
80 /**
81 * Subset of toPurgeChecked. Marks primitives that remain in the
82 * dataset, but incomplete.
83 */
84 protected transient Set<OsmPrimitive> makeIncomplete;
85 /**
86 * Subset of toPurgeChecked. Those that have not been in the selection.
87 */
88 protected transient List<OsmPrimitive> toPurgeAdditionally;
89
90 @Override
91 public void actionPerformed(ActionEvent e) {
92 if (!isEnabled())
93 return;
94
95 doPurge(getLayerManager().getEditDataSet().getAllSelected(), true);
96 }
97
98 /**
99 * Performs purge on selected OSM primitives.
100 * @param sel selected OSM primitives
101 * @param confirm asks user confirmation through a popup dialog
102 * @since 11240
103 */
104 public void doPurge(Collection<OsmPrimitive> sel, boolean confirm) {
105 layer = Main.getLayerManager().getEditLayer();
106
107 toPurge = new HashSet<>(sel);
108 toPurgeAdditionally = new ArrayList<>();
109 toPurgeChecked = new HashSet<>();
110
111 // Add referrer, unless the object to purge is not new
112 // and the parent is a relation
113 Set<OsmPrimitive> toPurgeRecursive = new HashSet<>();
114 while (!toPurge.isEmpty()) {
115
116 for (OsmPrimitive osm: toPurge) {
117 for (OsmPrimitive parent: osm.getReferrers()) {
118 if (toPurge.contains(parent) || toPurgeChecked.contains(parent) || toPurgeRecursive.contains(parent)) {
119 continue;
120 }
121 if (parent instanceof Way || (parent instanceof Relation && osm.isNew())) {
122 toPurgeAdditionally.add(parent);
123 toPurgeRecursive.add(parent);
124 }
125 }
126 toPurgeChecked.add(osm);
127 }
128 toPurge = toPurgeRecursive;
129 toPurgeRecursive = new HashSet<>();
130 }
131
132 makeIncomplete = new HashSet<>();
133
134 // Find the objects that will be incomplete after purging.
135 // At this point, all parents of new to-be-purged primitives are
136 // also to-be-purged and
137 // all parents of not-new to-be-purged primitives are either
138 // to-be-purged or of type relation.
139 TOP:
140 for (OsmPrimitive child : toPurgeChecked) {
141 if (child.isNew()) {
142 continue;
143 }
144 for (OsmPrimitive parent : child.getReferrers()) {
145 if (parent instanceof Relation && !toPurgeChecked.contains(parent)) {
146 makeIncomplete.add(child);
147 continue TOP;
148 }
149 }
150 }
151
152 // Add untagged way nodes. Do not add nodes that have other
153 // referrers not yet to-be-purged.
154 if (Main.pref.getBoolean("purge.add_untagged_waynodes", true)) {
155 Set<OsmPrimitive> wayNodes = new HashSet<>();
156 for (OsmPrimitive osm : toPurgeChecked) {
157 if (osm instanceof Way) {
158 Way w = (Way) osm;
159 NODE:
160 for (Node n : w.getNodes()) {
161 if (n.isTagged() || toPurgeChecked.contains(n)) {
162 continue;
163 }
164 for (OsmPrimitive ref : n.getReferrers()) {
165 if (ref != w && !toPurgeChecked.contains(ref)) {
166 continue NODE;
167 }
168 }
169 wayNodes.add(n);
170 }
171 }
172 }
173 toPurgeChecked.addAll(wayNodes);
174 toPurgeAdditionally.addAll(wayNodes);
175 }
176
177 if (Main.pref.getBoolean("purge.add_relations_with_only_incomplete_members", true)) {
178 Set<Relation> relSet = new HashSet<>();
179 for (OsmPrimitive osm : toPurgeChecked) {
180 for (OsmPrimitive parent : osm.getReferrers()) {
181 if (parent instanceof Relation
182 && !(toPurgeChecked.contains(parent))
183 && hasOnlyIncompleteMembers((Relation) parent, toPurgeChecked, relSet)) {
184 relSet.add((Relation) parent);
185 }
186 }
187 }
188
189 /**
190 * Add higher level relations (list gets extended while looping over it)
191 */
192 List<Relation> relLst = new ArrayList<>(relSet);
193 for (int i = 0; i < relLst.size(); ++i) { // foreach loop not applicable since list gets extended while looping over it
194 for (OsmPrimitive parent : relLst.get(i).getReferrers()) {
195 if (!(toPurgeChecked.contains(parent))
196 && hasOnlyIncompleteMembers((Relation) parent, toPurgeChecked, relLst)) {
197 relLst.add((Relation) parent);
198 }
199 }
200 }
201 relSet = new HashSet<>(relLst);
202 toPurgeChecked.addAll(relSet);
203 toPurgeAdditionally.addAll(relSet);
204 }
205
206 boolean modified = false;
207 for (OsmPrimitive osm : toPurgeChecked) {
208 if (osm.isModified()) {
209 modified = true;
210 break;
211 }
212 }
213
214 boolean clearUndoRedo = false;
215
216 if (!GraphicsEnvironment.isHeadless() && confirm) {
217 final boolean answer = ConditionalOptionPaneUtil.showConfirmationDialog(
218 "purge", Main.parent, buildPanel(modified), tr("Confirm Purging"),
219 JOptionPane.OK_CANCEL_OPTION, JOptionPane.PLAIN_MESSAGE, JOptionPane.OK_OPTION);
220 if (!answer)
221 return;
222
223 clearUndoRedo = cbClearUndoRedo.isSelected();
224 Main.pref.put("purge.clear_undo_redo", clearUndoRedo);
225 }
226
227 Main.main.undoRedo.add(layer != null ? new PurgeCommand(layer, toPurgeChecked, makeIncomplete) :
228 new PurgeCommand(toPurgeChecked.iterator().next().getDataSet(), toPurgeChecked, makeIncomplete));
229
230 if (clearUndoRedo) {
231 Main.main.undoRedo.clean();
232 getLayerManager().getEditDataSet().clearSelectionHistory();
233 }
234 }
235
236 private JPanel buildPanel(boolean modified) {
237 JPanel pnl = new JPanel(new GridBagLayout());
238
239 pnl.add(Box.createRigidArea(new Dimension(400, 0)), GBC.eol().fill(GBC.HORIZONTAL));
240
241 pnl.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
242 pnl.add(new JLabel("<html>"+
243 tr("This operation makes JOSM forget the selected objects.<br> " +
244 "They will be removed from the layer, but <i>not</i> deleted<br> " +
245 "on the server when uploading.")+"</html>",
246 ImageProvider.get("purge"), JLabel.LEFT), GBC.eol().fill(GBC.HORIZONTAL));
247
248 if (!toPurgeAdditionally.isEmpty()) {
249 pnl.add(new JSeparator(), GBC.eol().fill(GBC.HORIZONTAL).insets(0, 5, 0, 5));
250 pnl.add(new JLabel("<html>"+
251 tr("The following dependent objects will be purged<br> " +
252 "in addition to the selected objects:")+"</html>",
253 ImageProvider.get("warning-small"), JLabel.LEFT), GBC.eol().fill(GBC.HORIZONTAL));
254
255 toPurgeAdditionally.sort((o1, o2) -> {
256 int type = o2.getType().compareTo(o1.getType());
257 if (type != 0)
258 return type;
259 return Long.compare(o1.getUniqueId(), o2.getUniqueId());
260 });
261 JList<OsmPrimitive> list = new JList<>(toPurgeAdditionally.toArray(new OsmPrimitive[toPurgeAdditionally.size()]));
262 /* force selection to be active for all entries */
263 list.setCellRenderer(new OsmPrimitivRenderer() {
264 @Override
265 public Component getListCellRendererComponent(JList<? extends OsmPrimitive> list,
266 OsmPrimitive value,
267 int index,
268 boolean isSelected,
269 boolean cellHasFocus) {
270 return super.getListCellRendererComponent(list, value, index, true, false);
271 }
272 });
273 JScrollPane scroll = new JScrollPane(list);
274 scroll.setPreferredSize(new Dimension(250, 300));
275 scroll.setMinimumSize(new Dimension(250, 300));
276 pnl.add(scroll, GBC.std().fill(GBC.BOTH).weight(1.0, 1.0));
277
278 JButton addToSelection = new JButton(new AbstractAction() {
279 {
280 putValue(SHORT_DESCRIPTION, tr("Add to selection"));
281 putValue(SMALL_ICON, ImageProvider.get("dialogs", "select"));
282 }
283
284 @Override
285 public void actionPerformed(ActionEvent e) {
286 layer.data.addSelected(toPurgeAdditionally);
287 }
288 });
289 addToSelection.setMargin(new Insets(0, 0, 0, 0));
290 pnl.add(addToSelection, GBC.eol().anchor(GBC.SOUTHWEST).weight(0.0, 1.0).insets(2, 0, 0, 3));
291 }
292
293 if (modified) {
294 pnl.add(new JSeparator(), GBC.eol().fill(GBC.HORIZONTAL).insets(0, 5, 0, 5));
295 pnl.add(new JLabel("<html>"+tr("Some of the objects are modified.<br> " +
296 "Proceed, if these changes should be discarded."+"</html>"),
297 ImageProvider.get("warning-small"), JLabel.LEFT),
298 GBC.eol().fill(GBC.HORIZONTAL));
299 }
300
301 cbClearUndoRedo = new JCheckBox(tr("Clear Undo/Redo buffer"));
302 cbClearUndoRedo.setSelected(Main.pref.getBoolean("purge.clear_undo_redo", false));
303
304 pnl.add(new JSeparator(), GBC.eol().fill(GBC.HORIZONTAL).insets(0, 5, 0, 5));
305 pnl.add(cbClearUndoRedo, GBC.eol());
306 return pnl;
307 }
308
309 @Override
310 protected void updateEnabledState() {
311 DataSet ds = getLayerManager().getEditDataSet();
312 if (ds == null) {
313 setEnabled(false);
314 } else {
315 setEnabled(!ds.selectionEmpty());
316 }
317 }
318
319 @Override
320 protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
321 setEnabled(selection != null && !selection.isEmpty());
322 }
323
324 private static boolean hasOnlyIncompleteMembers(
325 Relation r, Collection<OsmPrimitive> toPurge, Collection<? extends OsmPrimitive> moreToPurge) {
326 for (RelationMember m : r.getMembers()) {
327 if (!m.getMember().isIncomplete() && !toPurge.contains(m.getMember()) && !moreToPurge.contains(m.getMember()))
328 return false;
329 }
330 return true;
331 }
332}
Note: See TracBrowser for help on using the repository browser.