001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.actions;
003
004import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
005import static org.openstreetmap.josm.tools.CheckParameterUtil.ensureParameterNotNull;
006import static org.openstreetmap.josm.tools.I18n.tr;
007
008import java.awt.event.ActionEvent;
009import java.awt.event.KeyEvent;
010import java.util.Collection;
011import java.util.Collections;
012
013import javax.swing.JOptionPane;
014
015import org.openstreetmap.josm.Main;
016import org.openstreetmap.josm.data.osm.DataSet;
017import org.openstreetmap.josm.data.osm.OsmPrimitive;
018import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
019import org.openstreetmap.josm.data.osm.PrimitiveId;
020import org.openstreetmap.josm.gui.ExceptionDialogUtil;
021import org.openstreetmap.josm.gui.io.UpdatePrimitivesTask;
022import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
023import org.openstreetmap.josm.io.MultiFetchServerObjectReader;
024import org.openstreetmap.josm.io.OnlineResource;
025import org.openstreetmap.josm.io.OsmTransferException;
026import org.openstreetmap.josm.tools.Shortcut;
027
028/**
029 * This action synchronizes a set of primitives with their state on the server.
030 * @since 1670
031 */
032public class UpdateSelectionAction extends JosmAction {
033
034    /**
035     * handle an exception thrown because a primitive was deleted on the server
036     *
037     * @param id the primitive id
038     * @param type The primitive type. Must be one of {@link OsmPrimitiveType#NODE NODE},
039     * {@link OsmPrimitiveType#WAY WAY}, {@link OsmPrimitiveType#RELATION RELATION}
040     */
041    public static void handlePrimitiveGoneException(long id, OsmPrimitiveType type) {
042        MultiFetchServerObjectReader reader = MultiFetchServerObjectReader.create();
043        reader.append(Main.getLayerManager().getEditDataSet(), id, type);
044        try {
045            DataSet ds = reader.parseOsm(NullProgressMonitor.INSTANCE);
046            Main.getLayerManager().getEditLayer().mergeFrom(ds);
047        } catch (OsmTransferException e) {
048            ExceptionDialogUtil.explainException(e);
049        }
050    }
051
052    /**
053     * Updates the data for for the {@link OsmPrimitive}s in <code>selection</code>
054     * with the data currently kept on the server.
055     *
056     * @param selection a collection of {@link OsmPrimitive}s to update
057     *
058     */
059    public static void updatePrimitives(final Collection<OsmPrimitive> selection) {
060        Main.worker.submit(new UpdatePrimitivesTask(Main.getLayerManager().getEditLayer(), selection));
061    }
062
063    /**
064     * Updates the data for  the {@link OsmPrimitive}s with id <code>id</code>
065     * with the data currently kept on the server.
066     *
067     * @param id  the id of a primitive in the {@link DataSet} of the current edit layer. Must not be null.
068     * @throws IllegalArgumentException if id is null
069     * @throws IllegalStateException if there is no primitive with <code>id</code> in the current dataset
070     * @throws IllegalStateException if there is no current dataset
071     */
072    public static void updatePrimitive(PrimitiveId id) {
073        ensureParameterNotNull(id, "id");
074        if (Main.getLayerManager().getEditLayer() == null)
075            throw new IllegalStateException(tr("No current dataset found"));
076        OsmPrimitive primitive = Main.getLayerManager().getEditLayer().data.getPrimitiveById(id);
077        if (primitive == null)
078            throw new IllegalStateException(tr("Did not find an object with id {0} in the current dataset", id));
079        updatePrimitives(Collections.singleton(primitive));
080    }
081
082    /**
083     * Constructs a new {@code UpdateSelectionAction}.
084     */
085    public UpdateSelectionAction() {
086        super(tr("Update selection"), "updatedata",
087                tr("Updates the currently selected objects from the server (re-downloads data)"),
088                Shortcut.registerShortcut("file:updateselection",
089                        tr("File: {0}", tr("Update selection")), KeyEvent.VK_U,
090                        Shortcut.ALT_CTRL),
091                true, "updateselection", true);
092        putValue("help", ht("/Action/UpdateSelection"));
093    }
094
095    /**
096     * Constructs a new {@code UpdateSelectionAction}.
097     *
098     * @param name the action's text as displayed on the menu (if it is added to a menu)
099     * @param iconName the filename of the icon to use
100     * @param tooltip  a longer description of the action that will be displayed in the tooltip. Please note
101     *           that html is not supported for menu actions on some platforms.
102     * @param shortcut a ready-created shortcut object or null if you don't want a shortcut. But you always
103     *            do want a shortcut, remember you can always register it with group=none, so you
104     *            won't be assigned a shortcut unless the user configures one. If you pass null here,
105     *            the user CANNOT configure a shortcut for your action.
106     * @param register register this action for the toolbar preferences?
107     * @param toolbarId identifier for the toolbar preferences. The iconName is used, if this parameter is null
108     */
109    public UpdateSelectionAction(String name, String iconName, String tooltip, Shortcut shortcut, boolean register, String toolbarId) {
110        super(name, iconName, tooltip, shortcut, register, toolbarId, true);
111    }
112
113    @Override
114    protected void updateEnabledState() {
115        DataSet ds = getLayerManager().getEditDataSet();
116        if (ds == null) {
117            setEnabled(false);
118        } else {
119            updateEnabledState(ds.getAllSelected());
120        }
121    }
122
123    @Override
124    protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
125        setEnabled(selection != null && !selection.isEmpty() && !Main.isOffline(OnlineResource.OSM_API));
126    }
127
128    @Override
129    public void actionPerformed(ActionEvent e) {
130        if (!isEnabled())
131            return;
132        Collection<OsmPrimitive> toUpdate = getData();
133        if (toUpdate.isEmpty()) {
134            JOptionPane.showMessageDialog(
135                    Main.parent,
136                    tr("There are no selected objects to update."),
137                    tr("Selection empty"),
138                    JOptionPane.INFORMATION_MESSAGE
139            );
140            return;
141        }
142        updatePrimitives(toUpdate);
143    }
144
145    /**
146     * Returns the data on which this action operates. Override if needed.
147     * @return the data on which this action operates
148     */
149    public Collection<OsmPrimitive> getData() {
150        return getLayerManager().getEditDataSet().getAllSelected();
151    }
152}