source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/ConflictDialog.java@ 9440

Last change on this file since 9440 was 9440, checked in by simon04, 8 years ago

see #12338 - Conflict resolution: add expert actions "Resolve to my/their versions" in popup menu

This resolves all selected conflicts to my/their versions.
  • Property svn:eol-style set to native
File size: 20.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.marktr;
6import static org.openstreetmap.josm.tools.I18n.tr;
7import static org.openstreetmap.josm.tools.I18n.trn;
8
9import java.awt.Color;
10import java.awt.Graphics;
11import java.awt.Point;
12import java.awt.event.ActionEvent;
13import java.awt.event.KeyEvent;
14import java.awt.event.MouseEvent;
15import java.util.ArrayList;
16import java.util.Arrays;
17import java.util.Collection;
18import java.util.HashSet;
19import java.util.LinkedList;
20import java.util.List;
21import java.util.Set;
22import java.util.concurrent.CopyOnWriteArrayList;
23
24import javax.swing.AbstractAction;
25import javax.swing.JList;
26import javax.swing.JMenuItem;
27import javax.swing.JOptionPane;
28import javax.swing.JPopupMenu;
29import javax.swing.ListModel;
30import javax.swing.ListSelectionModel;
31import javax.swing.event.ListDataEvent;
32import javax.swing.event.ListDataListener;
33import javax.swing.event.ListSelectionEvent;
34import javax.swing.event.ListSelectionListener;
35import javax.swing.event.PopupMenuEvent;
36import javax.swing.event.PopupMenuListener;
37
38import org.openstreetmap.josm.Main;
39import org.openstreetmap.josm.actions.AbstractSelectAction;
40import org.openstreetmap.josm.actions.ExpertToggleAction;
41import org.openstreetmap.josm.command.Command;
42import org.openstreetmap.josm.command.SequenceCommand;
43import org.openstreetmap.josm.data.SelectionChangedListener;
44import org.openstreetmap.josm.data.conflict.Conflict;
45import org.openstreetmap.josm.data.conflict.ConflictCollection;
46import org.openstreetmap.josm.data.conflict.IConflictListener;
47import org.openstreetmap.josm.data.osm.DataSet;
48import org.openstreetmap.josm.data.osm.Node;
49import org.openstreetmap.josm.data.osm.OsmPrimitive;
50import org.openstreetmap.josm.data.osm.Relation;
51import org.openstreetmap.josm.data.osm.RelationMember;
52import org.openstreetmap.josm.data.osm.Way;
53import org.openstreetmap.josm.data.osm.visitor.AbstractVisitor;
54import org.openstreetmap.josm.data.osm.visitor.Visitor;
55import org.openstreetmap.josm.gui.HelpAwareOptionPane;
56import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
57import org.openstreetmap.josm.gui.MapView;
58import org.openstreetmap.josm.gui.NavigatableComponent;
59import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
60import org.openstreetmap.josm.gui.PopupMenuHandler;
61import org.openstreetmap.josm.gui.SideButton;
62import org.openstreetmap.josm.gui.conflict.pair.ConflictResolver;
63import org.openstreetmap.josm.gui.conflict.pair.MergeDecisionType;
64import org.openstreetmap.josm.gui.layer.OsmDataLayer;
65import org.openstreetmap.josm.gui.util.GuiHelper;
66import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
67import org.openstreetmap.josm.tools.ImageProvider;
68import org.openstreetmap.josm.tools.Shortcut;
69
70/**
71 * This dialog displays the {@link ConflictCollection} of the active {@link OsmDataLayer} in a toggle
72 * dialog on the right of the main frame.
73 *
74 */
75public final class ConflictDialog extends ToggleDialog implements MapView.EditLayerChangeListener, IConflictListener, SelectionChangedListener {
76
77 /**
78 * Replies the color used to paint conflicts.
79 *
80 * @return the color used to paint conflicts
81 * @see #paintConflicts
82 * @since 1221
83 */
84 public static Color getColor() {
85 return Main.pref.getColor(marktr("conflict"), Color.gray);
86 }
87
88 /** the collection of conflicts displayed by this conflict dialog */
89 private transient ConflictCollection conflicts;
90
91 /** the model for the list of conflicts */
92 private transient ConflictListModel model;
93 /** the list widget for the list of conflicts */
94 private JList<OsmPrimitive> lstConflicts;
95
96 private final JPopupMenu popupMenu = new JPopupMenu();
97 private final transient PopupMenuHandler popupMenuHandler = new PopupMenuHandler(popupMenu);
98
99 private ResolveAction actResolve;
100 private SelectAction actSelect;
101
102 /**
103 * builds the GUI
104 */
105 protected void build() {
106 model = new ConflictListModel();
107
108 lstConflicts = new JList<>(model);
109 lstConflicts.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
110 lstConflicts.setCellRenderer(new OsmPrimitivRenderer());
111 lstConflicts.addMouseListener(new MouseEventHandler());
112 addListSelectionListener(new ListSelectionListener() {
113 @Override
114 public void valueChanged(ListSelectionEvent e) {
115 Main.map.mapView.repaint();
116 }
117 });
118
119 SideButton btnResolve = new SideButton(actResolve = new ResolveAction());
120 addListSelectionListener(actResolve);
121
122 SideButton btnSelect = new SideButton(actSelect = new SelectAction());
123 addListSelectionListener(actSelect);
124
125 createLayout(lstConflicts, true, Arrays.asList(new SideButton[] {
126 btnResolve, btnSelect
127 }));
128
129 popupMenuHandler.addAction(Main.main.menu.autoScaleActions.get("conflict"));
130
131 final ResolveTpMyVersionAction resolveTpMyVersionAction = new ResolveTpMyVersionAction();
132 final ResolveToTheirVersionAction resolveToTheirVersionAction = new ResolveToTheirVersionAction();
133 addListSelectionListener(resolveTpMyVersionAction);
134 addListSelectionListener(resolveToTheirVersionAction);
135 final JMenuItem btnResolveMy = popupMenuHandler.addAction(resolveTpMyVersionAction);
136 final JMenuItem btnResolveTheir = popupMenuHandler.addAction(resolveToTheirVersionAction);
137
138 popupMenuHandler.addListener(new PopupMenuListener() {
139 @Override
140 public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
141 btnResolveMy.setVisible(ExpertToggleAction.isExpert());
142 btnResolveTheir.setVisible(ExpertToggleAction.isExpert());
143 }
144
145 @Override
146 public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
147 // Do nothing
148 }
149
150 @Override
151 public void popupMenuCanceled(PopupMenuEvent e) {
152 // Do nothing
153 }
154 });
155 }
156
157 /**
158 * constructor
159 */
160 public ConflictDialog() {
161 super(tr("Conflict"), "conflict", tr("Resolve conflicts."),
162 Shortcut.registerShortcut("subwindow:conflict", tr("Toggle: {0}", tr("Conflict")),
163 KeyEvent.VK_C, Shortcut.ALT_SHIFT), 100);
164
165 build();
166 refreshView();
167 }
168
169 @Override
170 public void showNotify() {
171 DataSet.addSelectionListener(this);
172 MapView.addEditLayerChangeListener(this, true);
173 refreshView();
174 }
175
176 @Override
177 public void hideNotify() {
178 MapView.removeEditLayerChangeListener(this);
179 DataSet.removeSelectionListener(this);
180 }
181
182 /**
183 * Add a list selection listener to the conflicts list.
184 * @param listener the ListSelectionListener
185 * @since 5958
186 */
187 public void addListSelectionListener(ListSelectionListener listener) {
188 lstConflicts.getSelectionModel().addListSelectionListener(listener);
189 }
190
191 /**
192 * Remove the given list selection listener from the conflicts list.
193 * @param listener the ListSelectionListener
194 * @since 5958
195 */
196 public void removeListSelectionListener(ListSelectionListener listener) {
197 lstConflicts.getSelectionModel().removeListSelectionListener(listener);
198 }
199
200 /**
201 * Replies the popup menu handler.
202 * @return The popup menu handler
203 * @since 5958
204 */
205 public PopupMenuHandler getPopupMenuHandler() {
206 return popupMenuHandler;
207 }
208
209 /**
210 * Launches a conflict resolution dialog for the first selected conflict
211 *
212 */
213 private void resolve() {
214 if (conflicts == null || model.getSize() == 0) return;
215
216 int index = lstConflicts.getSelectedIndex();
217 if (index < 0) {
218 index = 0;
219 }
220
221 Conflict<? extends OsmPrimitive> c = conflicts.get(index);
222 ConflictResolutionDialog dialog = new ConflictResolutionDialog(Main.parent);
223 dialog.getConflictResolver().populate(c);
224 dialog.setVisible(true);
225
226 lstConflicts.setSelectedIndex(index);
227
228 Main.map.mapView.repaint();
229 }
230
231 /**
232 * refreshes the view of this dialog
233 */
234 public void refreshView() {
235 OsmDataLayer editLayer = Main.main.getEditLayer();
236 conflicts = (editLayer == null ? new ConflictCollection() : editLayer.getConflicts());
237 GuiHelper.runInEDT(new Runnable() {
238 @Override
239 public void run() {
240 model.fireContentChanged();
241 updateTitle();
242 }
243 });
244 }
245
246 private void updateTitle() {
247 int conflictsCount = conflicts.size();
248 if (conflictsCount > 0) {
249 setTitle(trn("Conflict: {0} unresolved", "Conflicts: {0} unresolved", conflictsCount, conflictsCount) +
250 " ("+tr("Rel.:{0} / Ways:{1} / Nodes:{2}",
251 conflicts.getRelationConflicts().size(),
252 conflicts.getWayConflicts().size(),
253 conflicts.getNodeConflicts().size())+')');
254 } else {
255 setTitle(tr("Conflict"));
256 }
257 }
258
259 /**
260 * Paints all conflicts that can be expressed on the main window.
261 *
262 * @param g The {@code Graphics} used to paint
263 * @param nc The {@code NavigatableComponent} used to get screen coordinates of nodes
264 * @since 86
265 */
266 public void paintConflicts(final Graphics g, final NavigatableComponent nc) {
267 Color preferencesColor = getColor();
268 if (preferencesColor.equals(Main.pref.getColor(marktr("background"), Color.black)))
269 return;
270 g.setColor(preferencesColor);
271 Visitor conflictPainter = new AbstractVisitor() {
272 // Manage a stack of visited relations to avoid infinite recursion with cyclic relations (fix #7938)
273 private final Set<Relation> visited = new HashSet<>();
274 @Override
275 public void visit(Node n) {
276 Point p = nc.getPoint(n);
277 g.drawRect(p.x-1, p.y-1, 2, 2);
278 }
279
280 public void visit(Node n1, Node n2) {
281 Point p1 = nc.getPoint(n1);
282 Point p2 = nc.getPoint(n2);
283 g.drawLine(p1.x, p1.y, p2.x, p2.y);
284 }
285
286 @Override
287 public void visit(Way w) {
288 Node lastN = null;
289 for (Node n : w.getNodes()) {
290 if (lastN == null) {
291 lastN = n;
292 continue;
293 }
294 visit(lastN, n);
295 lastN = n;
296 }
297 }
298
299 @Override
300 public void visit(Relation e) {
301 if (!visited.contains(e)) {
302 visited.add(e);
303 try {
304 for (RelationMember em : e.getMembers()) {
305 em.getMember().accept(this);
306 }
307 } finally {
308 visited.remove(e);
309 }
310 }
311 }
312 };
313 for (OsmPrimitive o : lstConflicts.getSelectedValuesList()) {
314 if (conflicts == null || !conflicts.hasConflictForMy(o)) {
315 continue;
316 }
317 conflicts.getConflictForMy(o).getTheir().accept(conflictPainter);
318 }
319 }
320
321 @Override
322 public void editLayerChanged(OsmDataLayer oldLayer, OsmDataLayer newLayer) {
323 if (oldLayer != null) {
324 oldLayer.getConflicts().removeConflictListener(this);
325 }
326 if (newLayer != null) {
327 newLayer.getConflicts().addConflictListener(this);
328 }
329 refreshView();
330 }
331
332
333 /**
334 * replies the conflict collection currently held by this dialog; may be null
335 *
336 * @return the conflict collection currently held by this dialog; may be null
337 */
338 public ConflictCollection getConflicts() {
339 return conflicts;
340 }
341
342 /**
343 * returns the first selected item of the conflicts list
344 *
345 * @return Conflict
346 */
347 public Conflict<? extends OsmPrimitive> getSelectedConflict() {
348 if (conflicts == null || model.getSize() == 0) return null;
349
350 int index = lstConflicts.getSelectedIndex();
351 if (index < 0) return null;
352
353 return conflicts.get(index);
354 }
355
356 private boolean isConflictSelected() {
357 final ListSelectionModel model = lstConflicts.getSelectionModel();
358 return model.getMinSelectionIndex() >= 0 && model.getMaxSelectionIndex() >= model.getMinSelectionIndex();
359 }
360
361 @Override
362 public void onConflictsAdded(ConflictCollection conflicts) {
363 refreshView();
364 }
365
366 @Override
367 public void onConflictsRemoved(ConflictCollection conflicts) {
368 Main.info("1 conflict has been resolved.");
369 refreshView();
370 }
371
372 @Override
373 public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
374 lstConflicts.clearSelection();
375 for (OsmPrimitive osm : newSelection) {
376 if (conflicts != null && conflicts.hasConflictForMy(osm)) {
377 int pos = model.indexOf(osm);
378 if (pos >= 0) {
379 lstConflicts.addSelectionInterval(pos, pos);
380 }
381 }
382 }
383 }
384
385 @Override
386 public String helpTopic() {
387 return ht("/Dialog/ConflictList");
388 }
389
390 class MouseEventHandler extends PopupMenuLauncher {
391 /**
392 * Constructs a new {@code MouseEventHandler}.
393 */
394 MouseEventHandler() {
395 super(popupMenu);
396 }
397
398 @Override public void mouseClicked(MouseEvent e) {
399 if (isDoubleClick(e)) {
400 resolve();
401 }
402 }
403 }
404
405 /**
406 * The {@link ListModel} for conflicts
407 *
408 */
409 class ConflictListModel implements ListModel<OsmPrimitive> {
410
411 private final CopyOnWriteArrayList<ListDataListener> listeners;
412
413 /**
414 * Constructs a new {@code ConflictListModel}.
415 */
416 ConflictListModel() {
417 listeners = new CopyOnWriteArrayList<>();
418 }
419
420 @Override
421 public void addListDataListener(ListDataListener l) {
422 if (l != null) {
423 listeners.addIfAbsent(l);
424 }
425 }
426
427 @Override
428 public void removeListDataListener(ListDataListener l) {
429 listeners.remove(l);
430 }
431
432 protected void fireContentChanged() {
433 ListDataEvent evt = new ListDataEvent(
434 this,
435 ListDataEvent.CONTENTS_CHANGED,
436 0,
437 getSize()
438 );
439 for (ListDataListener listener : listeners) {
440 listener.contentsChanged(evt);
441 }
442 }
443
444 @Override
445 public OsmPrimitive getElementAt(int index) {
446 if (index < 0) return null;
447 if (index >= getSize()) return null;
448 return conflicts.get(index).getMy();
449 }
450
451 @Override
452 public int getSize() {
453 if (conflicts == null) return 0;
454 return conflicts.size();
455 }
456
457 public int indexOf(OsmPrimitive my) {
458 if (conflicts == null) return -1;
459 for (int i = 0; i < conflicts.size(); i++) {
460 if (conflicts.get(i).isMatchingMy(my))
461 return i;
462 }
463 return -1;
464 }
465
466 public OsmPrimitive get(int idx) {
467 if (conflicts == null) return null;
468 return conflicts.get(idx).getMy();
469 }
470 }
471
472 class ResolveAction extends AbstractAction implements ListSelectionListener {
473 ResolveAction() {
474 putValue(NAME, tr("Resolve"));
475 putValue(SHORT_DESCRIPTION, tr("Open a merge dialog of all selected items in the list above."));
476 putValue(SMALL_ICON, ImageProvider.get("dialogs", "conflict"));
477 putValue("help", ht("/Dialog/ConflictList#ResolveAction"));
478 }
479
480 @Override
481 public void actionPerformed(ActionEvent e) {
482 resolve();
483 }
484
485 @Override
486 public void valueChanged(ListSelectionEvent e) {
487 setEnabled(isConflictSelected());
488 }
489 }
490
491 final class SelectAction extends AbstractSelectAction implements ListSelectionListener {
492 private SelectAction() {
493 putValue("help", ht("/Dialog/ConflictList#SelectAction"));
494 }
495
496 @Override
497 public void actionPerformed(ActionEvent e) {
498 Collection<OsmPrimitive> sel = new LinkedList<>();
499 for (OsmPrimitive o : lstConflicts.getSelectedValuesList()) {
500 sel.add(o);
501 }
502 DataSet ds = Main.main.getCurrentDataSet();
503 if (ds != null) { // Can't see how it is possible but it happened in #7942
504 ds.setSelected(sel);
505 }
506 }
507
508 @Override
509 public void valueChanged(ListSelectionEvent e) {
510 setEnabled(isConflictSelected());
511 }
512 }
513
514 abstract class ResolveToAction extends ResolveAction {
515 private final String name;
516 private final MergeDecisionType type;
517
518 ResolveToAction(String name, String description, MergeDecisionType type) {
519 this.name = name;
520 this.type = type;
521 putValue(NAME, name);
522 putValue(SHORT_DESCRIPTION, description);
523 }
524
525 @Override
526 public void actionPerformed(ActionEvent e) {
527 final ConflictResolver resolver = new ConflictResolver();
528 final List<Command> commands = new ArrayList<>();
529 for (OsmPrimitive osmPrimitive : lstConflicts.getSelectedValuesList()) {
530 Conflict<? extends OsmPrimitive> c = conflicts.getConflictForMy(osmPrimitive);
531 resolver.populate(c);
532 resolver.decideRemaining(type);
533 commands.add(resolver.buildResolveCommand());
534 }
535 Main.main.undoRedo.add(new SequenceCommand(name, commands));
536 refreshView();
537 Main.map.mapView.repaint();
538 }
539 }
540
541 class ResolveTpMyVersionAction extends ResolveToAction {
542 public ResolveTpMyVersionAction() {
543 super(tr("Resolve to my versions"), tr("Resolves all unresolved conflicts to ''my'' version"),
544 MergeDecisionType.KEEP_MINE);
545 }
546 }
547
548 class ResolveToTheirVersionAction extends ResolveToAction {
549 public ResolveToTheirVersionAction() {
550 super(tr("Resolve to their versions"), tr("Resolves all unresolved conflicts to ''their'' version"),
551 MergeDecisionType.KEEP_THEIR);
552 }
553 }
554
555 /**
556 * Warns the user about the number of detected conflicts
557 *
558 * @param numNewConflicts the number of detected conflicts
559 * @since 5775
560 */
561 public void warnNumNewConflicts(int numNewConflicts) {
562 if (numNewConflicts == 0) return;
563
564 String msg1 = trn(
565 "There was {0} conflict detected.",
566 "There were {0} conflicts detected.",
567 numNewConflicts,
568 numNewConflicts
569 );
570
571 final StringBuilder sb = new StringBuilder();
572 sb.append("<html>").append(msg1).append("</html>");
573 if (numNewConflicts > 0) {
574 final ButtonSpec[] options = new ButtonSpec[] {
575 new ButtonSpec(
576 tr("OK"),
577 ImageProvider.get("ok"),
578 tr("Click to close this dialog and continue editing"),
579 null /* no specific help */
580 )
581 };
582 GuiHelper.runInEDT(new Runnable() {
583 @Override
584 public void run() {
585 HelpAwareOptionPane.showOptionDialog(
586 Main.parent,
587 sb.toString(),
588 tr("Conflicts detected"),
589 JOptionPane.WARNING_MESSAGE,
590 null, /* no icon */
591 options,
592 options[0],
593 ht("/Concepts/Conflict#WarningAboutDetectedConflicts")
594 );
595 unfurlDialog();
596 Main.map.repaint();
597 }
598 });
599 }
600 }
601}
Note: See TracBrowser for help on using the repository browser.