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

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

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