1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.actions;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
|
---|
5 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
6 |
|
---|
7 | import java.awt.event.ActionEvent;
|
---|
8 | import java.awt.event.KeyEvent;
|
---|
9 | import java.util.Collection;
|
---|
10 | import java.util.Collections;
|
---|
11 | import java.util.List;
|
---|
12 | import java.util.concurrent.Future;
|
---|
13 |
|
---|
14 | import org.openstreetmap.josm.gui.MainApplication;
|
---|
15 | import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
|
---|
16 | import org.openstreetmap.josm.gui.layer.Layer;
|
---|
17 | import org.openstreetmap.josm.gui.layer.OsmDataLayer;
|
---|
18 | import org.openstreetmap.josm.gui.util.GuiHelper;
|
---|
19 | import org.openstreetmap.josm.tools.ImageProvider;
|
---|
20 | import org.openstreetmap.josm.tools.Logging;
|
---|
21 | import org.openstreetmap.josm.tools.Shortcut;
|
---|
22 | import org.openstreetmap.josm.tools.Utils;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * Action that merges two or more OSM data layers.
|
---|
26 | * @since 1890
|
---|
27 | */
|
---|
28 | public class MergeLayerAction extends AbstractMergeAction {
|
---|
29 |
|
---|
30 | /**
|
---|
31 | * Constructs a new {@code MergeLayerAction}.
|
---|
32 | */
|
---|
33 | public MergeLayerAction() {
|
---|
34 | super(tr("Merge layer"), "dialogs/mergedown",
|
---|
35 | tr("Merge the current layer into another layer"),
|
---|
36 | Shortcut.registerShortcut("system:merge", tr("Edit: {0}",
|
---|
37 | tr("Merge")), KeyEvent.VK_M, Shortcut.CTRL),
|
---|
38 | true, "action/mergelayer", true);
|
---|
39 | putValue("help", ht("/Action/MergeLayer"));
|
---|
40 | }
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * Submits merge of layers.
|
---|
44 | * @param targetLayers possible target layers
|
---|
45 | * @param sourceLayers source layers
|
---|
46 | * @return a Future representing pending completion of the merge task, or {@code null}
|
---|
47 | * @since 11885 (return type)
|
---|
48 | */
|
---|
49 | protected Future<?> doMerge(List<Layer> targetLayers, final Collection<Layer> sourceLayers) {
|
---|
50 | final Layer targetLayer = askTargetLayer(targetLayers);
|
---|
51 | if (targetLayer == null)
|
---|
52 | return null;
|
---|
53 | final Object actionName = getValue(NAME);
|
---|
54 | return MainApplication.worker.submit(() -> {
|
---|
55 | final long start = System.currentTimeMillis();
|
---|
56 | boolean layerMerged = false;
|
---|
57 | for (final Layer sourceLayer: sourceLayers) {
|
---|
58 | if (sourceLayer != null && !sourceLayer.equals(targetLayer)) {
|
---|
59 | if (sourceLayer instanceof OsmDataLayer && targetLayer instanceof OsmDataLayer
|
---|
60 | && ((OsmDataLayer) sourceLayer).isUploadDiscouraged() != ((OsmDataLayer) targetLayer).isUploadDiscouraged()
|
---|
61 | && Boolean.TRUE.equals(GuiHelper.runInEDTAndWaitAndReturn(() ->
|
---|
62 | warnMergingUploadDiscouragedLayers(sourceLayer, targetLayer)))) {
|
---|
63 | break;
|
---|
64 | }
|
---|
65 | targetLayer.mergeFrom(sourceLayer);
|
---|
66 | GuiHelper.runInEDTAndWait(() -> getLayerManager().removeLayer(sourceLayer));
|
---|
67 | layerMerged = true;
|
---|
68 | }
|
---|
69 | }
|
---|
70 | if (layerMerged) {
|
---|
71 | getLayerManager().setActiveLayer(targetLayer);
|
---|
72 | Logging.info(tr("{0} completed in {1}", actionName, Utils.getDurationString(System.currentTimeMillis() - start)));
|
---|
73 | }
|
---|
74 | });
|
---|
75 | }
|
---|
76 |
|
---|
77 | /**
|
---|
78 | * Merges a list of layers together.
|
---|
79 | * @param sourceLayers The layers to merge
|
---|
80 | * @return a Future representing pending completion of the merge task, or {@code null}
|
---|
81 | * @since 11885 (return type)
|
---|
82 | */
|
---|
83 | public Future<?> merge(List<Layer> sourceLayers) {
|
---|
84 | return doMerge(sourceLayers, sourceLayers);
|
---|
85 | }
|
---|
86 |
|
---|
87 | /**
|
---|
88 | * Merges the given source layer with another one, determined at runtime.
|
---|
89 | * @param sourceLayer The source layer to merge
|
---|
90 | * @return a Future representing pending completion of the merge task, or {@code null}
|
---|
91 | * @since 11885 (return type)
|
---|
92 | */
|
---|
93 | public Future<?> merge(Layer sourceLayer) {
|
---|
94 | if (sourceLayer == null)
|
---|
95 | return null;
|
---|
96 | List<Layer> targetLayers = LayerListDialog.getInstance().getModel().getPossibleMergeTargets(sourceLayer);
|
---|
97 | if (targetLayers.isEmpty()) {
|
---|
98 | warnNoTargetLayersForSourceLayer(sourceLayer);
|
---|
99 | return null;
|
---|
100 | }
|
---|
101 | return doMerge(targetLayers, Collections.singleton(sourceLayer));
|
---|
102 | }
|
---|
103 |
|
---|
104 | @Override
|
---|
105 | public void actionPerformed(ActionEvent e) {
|
---|
106 | merge(getSourceLayer());
|
---|
107 | }
|
---|
108 |
|
---|
109 | @Override
|
---|
110 | protected void updateEnabledState() {
|
---|
111 | GuiHelper.runInEDT(() -> {
|
---|
112 | final Layer sourceLayer = getSourceLayer();
|
---|
113 | if (sourceLayer == null) {
|
---|
114 | setEnabled(false);
|
---|
115 | } else {
|
---|
116 | try {
|
---|
117 | setEnabled(!LayerListDialog.getInstance().getModel().getPossibleMergeTargets(sourceLayer).isEmpty());
|
---|
118 | } catch (IllegalStateException e) {
|
---|
119 | // May occur when destroying last layer / exiting JOSM, see #14476
|
---|
120 | setEnabled(false);
|
---|
121 | Logging.error(e);
|
---|
122 | }
|
---|
123 | }
|
---|
124 | });
|
---|
125 | }
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * Returns the source layer.
|
---|
129 | * @return the source layer
|
---|
130 | */
|
---|
131 | protected Layer getSourceLayer() {
|
---|
132 | return getLayerManager().getActiveLayer();
|
---|
133 | }
|
---|
134 |
|
---|
135 | /**
|
---|
136 | * Warns about a discouraged merge operation, ask for confirmation.
|
---|
137 | * @param sourceLayer The source layer
|
---|
138 | * @param targetLayer The target layer
|
---|
139 | * @return {@code true} if the user wants to cancel, {@code false} if they want to continue
|
---|
140 | */
|
---|
141 | public static final boolean warnMergingUploadDiscouragedLayers(Layer sourceLayer, Layer targetLayer) {
|
---|
142 | return GuiHelper.warnUser(tr("Merging layers with different upload policies"),
|
---|
143 | "<html>" +
|
---|
144 | tr("You are about to merge data between layers ''{0}'' and ''{1}''.<br /><br />"+
|
---|
145 | "These layers have different upload policies and should not been merged as it.<br />"+
|
---|
146 | "Merging them will result to enforce the stricter policy (upload discouraged) to ''{1}''.<br /><br />"+
|
---|
147 | "<b>This is not the recommended way of merging such data</b>.<br />"+
|
---|
148 | "You should instead check and merge each object, one by one, by using ''<i>Merge selection</i>''.<br /><br />"+
|
---|
149 | "Are you sure you want to continue?",
|
---|
150 | Utils.escapeReservedCharactersHTML(sourceLayer.getName()),
|
---|
151 | Utils.escapeReservedCharactersHTML(targetLayer.getName()),
|
---|
152 | Utils.escapeReservedCharactersHTML(targetLayer.getName()))+
|
---|
153 | "</html>",
|
---|
154 | ImageProvider.get("dialogs", "mergedown"), tr("Ignore this hint and merge anyway"));
|
---|
155 | }
|
---|
156 | }
|
---|