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

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

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