001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.dialogs;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.BorderLayout;
007import java.awt.FlowLayout;
008import java.awt.Frame;
009import java.awt.event.ActionEvent;
010import java.awt.event.ItemEvent;
011import java.awt.event.ItemListener;
012import java.awt.event.MouseAdapter;
013import java.awt.event.MouseEvent;
014import java.util.Arrays;
015import java.util.Collection;
016import java.util.HashSet;
017import java.util.List;
018import java.util.Set;
019import java.util.concurrent.ExecutionException;
020import java.util.concurrent.Future;
021
022import javax.swing.AbstractAction;
023import javax.swing.Action;
024import javax.swing.DefaultListSelectionModel;
025import javax.swing.JCheckBox;
026import javax.swing.JList;
027import javax.swing.JMenuItem;
028import javax.swing.JPanel;
029import javax.swing.JScrollPane;
030import javax.swing.ListSelectionModel;
031import javax.swing.SwingUtilities;
032import javax.swing.event.ListSelectionEvent;
033import javax.swing.event.ListSelectionListener;
034
035import org.openstreetmap.josm.Main;
036import org.openstreetmap.josm.actions.AbstractInfoAction;
037import org.openstreetmap.josm.data.osm.Changeset;
038import org.openstreetmap.josm.data.osm.ChangesetCache;
039import org.openstreetmap.josm.data.osm.DataSet;
040import org.openstreetmap.josm.data.osm.OsmPrimitive;
041import org.openstreetmap.josm.data.osm.event.DatasetEventManager;
042import org.openstreetmap.josm.data.osm.event.DatasetEventManager.FireMode;
043import org.openstreetmap.josm.gui.MapView;
044import org.openstreetmap.josm.gui.SideButton;
045import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetCacheManager;
046import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetHeaderDownloadTask;
047import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetInSelectionListModel;
048import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetListCellRenderer;
049import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetListModel;
050import org.openstreetmap.josm.gui.dialogs.changeset.ChangesetsInActiveDataLayerListModel;
051import org.openstreetmap.josm.gui.help.HelpUtil;
052import org.openstreetmap.josm.gui.io.CloseChangesetTask;
053import org.openstreetmap.josm.gui.layer.OsmDataLayer;
054import org.openstreetmap.josm.gui.util.GuiHelper;
055import org.openstreetmap.josm.gui.widgets.ListPopupMenu;
056import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
057import org.openstreetmap.josm.io.OnlineResource;
058import org.openstreetmap.josm.tools.BugReportExceptionHandler;
059import org.openstreetmap.josm.tools.ImageProvider;
060import org.openstreetmap.josm.tools.OpenBrowser;
061
062/**
063 * ChangesetDialog is a toggle dialog which displays the current list of changesets.
064 * It either displays
065 * <ul>
066 *   <li>the list of changesets the currently selected objects are assigned to</li>
067 *   <li>the list of changesets objects in the current data layer are assigend to</li>
068 * </ul>
069 *
070 * The dialog offers actions to download and to close changesets. It can also launch an external
071 * browser with information about a changeset. Furthermore, it can select all objects in
072 * the current data layer being assigned to a specific changeset.
073 *
074 */
075public class ChangesetDialog extends ToggleDialog{
076    private ChangesetInSelectionListModel inSelectionModel;
077    private ChangesetsInActiveDataLayerListModel inActiveDataLayerModel;
078    private JList<Changeset> lstInSelection;
079    private JList<Changeset> lstInActiveDataLayer;
080    private JCheckBox cbInSelectionOnly;
081    private JPanel pnlList;
082
083    // the actions
084    private SelectObjectsAction selectObjectsAction;
085    private ReadChangesetsAction readChangesetAction;
086    private ShowChangesetInfoAction showChangesetInfoAction;
087    private CloseOpenChangesetsAction closeChangesetAction;
088    private LaunchChangesetManagerAction launchChangesetManagerAction;
089
090    private ChangesetDialogPopup popupMenu;
091
092    protected void buildChangesetsLists() {
093        DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
094        inSelectionModel = new ChangesetInSelectionListModel(selectionModel);
095
096        lstInSelection = new JList<>(inSelectionModel);
097        lstInSelection.setSelectionModel(selectionModel);
098        lstInSelection.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
099        lstInSelection.setCellRenderer(new ChangesetListCellRenderer());
100
101        selectionModel = new DefaultListSelectionModel();
102        inActiveDataLayerModel = new ChangesetsInActiveDataLayerListModel(selectionModel);
103        lstInActiveDataLayer = new JList<>(inActiveDataLayerModel);
104        lstInActiveDataLayer.setSelectionModel(selectionModel);
105        lstInActiveDataLayer.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
106        lstInActiveDataLayer.setCellRenderer(new ChangesetListCellRenderer());
107
108        DblClickHandler dblClickHandler = new DblClickHandler();
109        lstInSelection.addMouseListener(dblClickHandler);
110        lstInActiveDataLayer.addMouseListener(dblClickHandler);
111    }
112
113    protected void registerAsListener() {
114        // let the model for changesets in the current selection listen to various events
115        ChangesetCache.getInstance().addChangesetCacheListener(inSelectionModel);
116        MapView.addEditLayerChangeListener(inSelectionModel);
117        DataSet.addSelectionListener(inSelectionModel);
118
119        // let the model for changesets in the current layer listen to various
120        // events and bootstrap it's content
121        ChangesetCache.getInstance().addChangesetCacheListener(inActiveDataLayerModel);
122        MapView.addEditLayerChangeListener(inActiveDataLayerModel);
123        OsmDataLayer editLayer = Main.main.getEditLayer();
124        if (editLayer != null) {
125            editLayer.data.addDataSetListener(inActiveDataLayerModel);
126            inActiveDataLayerModel.initFromDataSet(editLayer.data);
127            inSelectionModel.initFromPrimitives(editLayer.data.getAllSelected());
128        }
129    }
130
131    protected void unregisterAsListener() {
132        // remove the list model for the current edit layer as listener
133        //
134        ChangesetCache.getInstance().removeChangesetCacheListener(inActiveDataLayerModel);
135        MapView.removeEditLayerChangeListener(inActiveDataLayerModel);
136        OsmDataLayer editLayer = Main.main.getEditLayer();
137        if (editLayer != null) {
138            editLayer.data.removeDataSetListener(inActiveDataLayerModel);
139        }
140
141        // remove the list model for the changesets in the current selection as
142        // listener
143        //
144        MapView.removeEditLayerChangeListener(inSelectionModel);
145        DataSet.removeSelectionListener(inSelectionModel);
146    }
147
148    @Override
149    public void showNotify() {
150        registerAsListener();
151        DatasetEventManager.getInstance().addDatasetListener(inActiveDataLayerModel, FireMode.IN_EDT);
152    }
153
154    @Override
155    public void hideNotify() {
156        unregisterAsListener();
157        DatasetEventManager.getInstance().removeDatasetListener(inActiveDataLayerModel);
158    }
159
160    protected JPanel buildFilterPanel() {
161        JPanel pnl = new JPanel(new FlowLayout(FlowLayout.LEFT));
162        pnl.setBorder(null);
163        pnl.add(cbInSelectionOnly = new JCheckBox(tr("For selected objects only")));
164        cbInSelectionOnly.setToolTipText(tr("<html>Select to show changesets for the currently selected objects only.<br>"
165                + "Unselect to show all changesets for objects in the current data layer.</html>"));
166        cbInSelectionOnly.setSelected(Main.pref.getBoolean("changeset-dialog.for-selected-objects-only", false));
167        return pnl;
168    }
169
170    protected JPanel buildListPanel() {
171        buildChangesetsLists();
172        JPanel pnl = new JPanel(new BorderLayout());
173        if (cbInSelectionOnly.isSelected()) {
174            pnl.add(new JScrollPane(lstInSelection));
175        } else {
176            pnl.add(new JScrollPane(lstInActiveDataLayer));
177        }
178        return pnl;
179    }
180
181    protected void build() {
182        JPanel pnl = new JPanel(new BorderLayout());
183        pnl.add(buildFilterPanel(), BorderLayout.NORTH);
184        pnl.add(pnlList = buildListPanel(), BorderLayout.CENTER);
185
186        cbInSelectionOnly.addItemListener(new FilterChangeHandler());
187
188        HelpUtil.setHelpContext(pnl, HelpUtil.ht("/Dialog/ChangesetListDialog"));
189
190        // -- select objects action
191        selectObjectsAction = new SelectObjectsAction();
192        cbInSelectionOnly.addItemListener(selectObjectsAction);
193
194        // -- read changesets action
195        readChangesetAction = new ReadChangesetsAction();
196        cbInSelectionOnly.addItemListener(readChangesetAction);
197
198        // -- close changesets action
199        closeChangesetAction = new CloseOpenChangesetsAction();
200        cbInSelectionOnly.addItemListener(closeChangesetAction);
201
202        // -- show info action
203        showChangesetInfoAction = new ShowChangesetInfoAction();
204        cbInSelectionOnly.addItemListener(showChangesetInfoAction);
205
206        // -- launch changeset manager action
207        launchChangesetManagerAction = new LaunchChangesetManagerAction();
208        cbInSelectionOnly.addItemListener(launchChangesetManagerAction);
209
210        popupMenu = new ChangesetDialogPopup(lstInActiveDataLayer, lstInSelection);
211
212        PopupMenuLauncher popupMenuLauncher = new PopupMenuLauncher(popupMenu);
213        lstInSelection.addMouseListener(popupMenuLauncher);
214        lstInActiveDataLayer.addMouseListener(popupMenuLauncher);
215
216        createLayout(pnl, false, Arrays.asList(new SideButton[] {
217            new SideButton(selectObjectsAction, false),
218            new SideButton(readChangesetAction, false),
219            new SideButton(closeChangesetAction, false),
220            new SideButton(showChangesetInfoAction, false),
221            new SideButton(launchChangesetManagerAction, false)
222        }));
223    }
224
225    protected JList<Changeset> getCurrentChangesetList() {
226        if (cbInSelectionOnly.isSelected())
227            return lstInSelection;
228        return lstInActiveDataLayer;
229    }
230
231    protected ChangesetListModel getCurrentChangesetListModel() {
232        if (cbInSelectionOnly.isSelected())
233            return inSelectionModel;
234        return inActiveDataLayerModel;
235    }
236
237    protected void initWithCurrentData() {
238        OsmDataLayer editLayer = Main.main.getEditLayer();
239        if (editLayer != null) {
240            inSelectionModel.initFromPrimitives(editLayer.data.getAllSelected());
241            inActiveDataLayerModel.initFromDataSet(editLayer.data);
242        }
243    }
244
245    /**
246     * Constructs a new {@code ChangesetDialog}.
247     */
248    public ChangesetDialog() {
249        super(
250                tr("Changesets"),
251                "changesetdialog",
252                tr("Open the list of changesets in the current layer."),
253                null, /* no keyboard shortcut */
254                200, /* the preferred height */
255                false /* don't show if there is no preference */
256        );
257        build();
258        initWithCurrentData();
259    }
260
261    class DblClickHandler extends MouseAdapter {
262        @Override
263        public void mouseClicked(MouseEvent e) {
264            if (!SwingUtilities.isLeftMouseButton(e) || e.getClickCount() < 2)
265                return;
266            Set<Integer> sel = getCurrentChangesetListModel().getSelectedChangesetIds();
267            if (sel.isEmpty())
268                return;
269            if (Main.main.getCurrentDataSet() == null)
270                return;
271            new SelectObjectsAction().selectObjectsByChangesetIds(Main.main.getCurrentDataSet(), sel);
272        }
273
274    }
275
276    class FilterChangeHandler implements ItemListener {
277        @Override
278        public void itemStateChanged(ItemEvent e) {
279            Main.pref.put("changeset-dialog.for-selected-objects-only", cbInSelectionOnly.isSelected());
280            pnlList.removeAll();
281            if (cbInSelectionOnly.isSelected()) {
282                pnlList.add(new JScrollPane(lstInSelection), BorderLayout.CENTER);
283            } else {
284                pnlList.add(new JScrollPane(lstInActiveDataLayer), BorderLayout.CENTER);
285            }
286            validate();
287            repaint();
288        }
289    }
290
291    /**
292     * Selects objects for the currently selected changesets.
293     */
294    class SelectObjectsAction extends AbstractAction implements ListSelectionListener, ItemListener{
295
296        public SelectObjectsAction() {
297            putValue(NAME, tr("Select"));
298            putValue(SHORT_DESCRIPTION, tr("Select all objects assigned to the currently selected changesets"));
299            putValue(SMALL_ICON, ImageProvider.get("dialogs", "select"));
300            updateEnabledState();
301        }
302
303        public void selectObjectsByChangesetIds(DataSet ds, Set<Integer> ids) {
304            if (ds == null || ids == null)
305                return;
306            Set<OsmPrimitive> sel = new HashSet<>();
307            for (OsmPrimitive p: ds.allPrimitives()) {
308                if (ids.contains(p.getChangesetId())) {
309                    sel.add(p);
310                }
311            }
312            ds.setSelected(sel);
313        }
314
315        @Override
316        public void actionPerformed(ActionEvent e) {
317            if (!Main.main.hasEditLayer())
318                return;
319            ChangesetListModel model = getCurrentChangesetListModel();
320            Set<Integer> sel = model.getSelectedChangesetIds();
321            if (sel.isEmpty())
322                return;
323
324            DataSet ds = Main.main.getEditLayer().data;
325            selectObjectsByChangesetIds(ds,sel);
326        }
327
328        protected void updateEnabledState() {
329            setEnabled(getCurrentChangesetList().getSelectedIndices().length > 0);
330        }
331
332        @Override
333        public void itemStateChanged(ItemEvent arg0) {
334            updateEnabledState();
335
336        }
337
338        @Override
339        public void valueChanged(ListSelectionEvent e) {
340            updateEnabledState();
341        }
342    }
343
344    /**
345     * Downloads selected changesets
346     *
347     */
348    class ReadChangesetsAction extends AbstractAction implements ListSelectionListener, ItemListener{
349        public ReadChangesetsAction() {
350            putValue(NAME, tr("Download"));
351            putValue(SHORT_DESCRIPTION, tr("Download information about the selected changesets from the OSM server"));
352            putValue(SMALL_ICON, ImageProvider.get("download"));
353            updateEnabledState();
354        }
355
356        @Override
357        public void actionPerformed(ActionEvent arg0) {
358            ChangesetListModel model = getCurrentChangesetListModel();
359            Set<Integer> sel = model.getSelectedChangesetIds();
360            if (sel.isEmpty())
361                return;
362            ChangesetHeaderDownloadTask task = new ChangesetHeaderDownloadTask(sel);
363            Main.worker.submit(task);
364        }
365
366        protected void updateEnabledState() {
367            setEnabled(getCurrentChangesetList().getSelectedIndices().length > 0 && !Main.isOffline(OnlineResource.OSM_API));
368        }
369
370        @Override
371        public void itemStateChanged(ItemEvent arg0) {
372            updateEnabledState();
373
374        }
375
376        @Override
377        public void valueChanged(ListSelectionEvent e) {
378            updateEnabledState();
379        }
380    }
381
382    /**
383     * Closes the currently selected changesets
384     *
385     */
386    class CloseOpenChangesetsAction extends AbstractAction implements ListSelectionListener, ItemListener {
387        public CloseOpenChangesetsAction() {
388            putValue(NAME, tr("Close open changesets"));
389            putValue(SHORT_DESCRIPTION, tr("Closes the selected open changesets"));
390            putValue(SMALL_ICON, ImageProvider.get("closechangeset"));
391            updateEnabledState();
392        }
393
394        @Override
395        public void actionPerformed(ActionEvent arg0) {
396            List<Changeset> sel = getCurrentChangesetListModel().getSelectedOpenChangesets();
397            if (sel.isEmpty())
398                return;
399            Main.worker.submit(new CloseChangesetTask(sel));
400        }
401
402        protected void updateEnabledState() {
403            setEnabled(getCurrentChangesetListModel().hasSelectedOpenChangesets());
404        }
405
406        @Override
407        public void itemStateChanged(ItemEvent arg0) {
408            updateEnabledState();
409        }
410
411        @Override
412        public void valueChanged(ListSelectionEvent e) {
413            updateEnabledState();
414        }
415    }
416
417    /**
418     * Show information about the currently selected changesets
419     *
420     */
421    class ShowChangesetInfoAction extends AbstractAction implements ListSelectionListener, ItemListener {
422        public ShowChangesetInfoAction() {
423            putValue(NAME, tr("Show info"));
424            putValue(SHORT_DESCRIPTION, tr("Open a web page for each selected changeset"));
425            putValue(SMALL_ICON, ImageProvider.get("about"));
426            updateEnabledState();
427        }
428
429        @Override
430        public void actionPerformed(ActionEvent arg0) {
431            Set<Changeset> sel = getCurrentChangesetListModel().getSelectedChangesets();
432            if (sel.isEmpty())
433                return;
434            if (sel.size() > 10 && ! AbstractInfoAction.confirmLaunchMultiple(sel.size()))
435                return;
436            String baseUrl = AbstractInfoAction.getBaseBrowseUrl();
437            for (Changeset cs: sel) {
438                String url = baseUrl + "/changeset/" + cs.getId();
439                OpenBrowser.displayUrl(
440                        url
441                );
442            }
443        }
444
445        protected void updateEnabledState() {
446            setEnabled(getCurrentChangesetList().getSelectedIndices().length > 0);
447        }
448
449        @Override
450        public void itemStateChanged(ItemEvent arg0) {
451            updateEnabledState();
452        }
453
454        @Override
455        public void valueChanged(ListSelectionEvent e) {
456            updateEnabledState();
457        }
458    }
459
460    /**
461     * Show information about the currently selected changesets
462     *
463     */
464    class LaunchChangesetManagerAction extends AbstractAction implements ListSelectionListener, ItemListener {
465        public LaunchChangesetManagerAction() {
466            putValue(NAME, tr("Details"));
467            putValue(SHORT_DESCRIPTION, tr("Opens the Changeset Manager window for the selected changesets"));
468            putValue(SMALL_ICON, ImageProvider.get("dialogs/changeset", "changesetmanager"));
469        }
470
471        protected void launchChangesetManager(Collection<Integer> toSelect) {
472            ChangesetCacheManager cm = ChangesetCacheManager.getInstance();
473            if (cm.isVisible()) {
474                cm.setExtendedState(Frame.NORMAL);
475                cm.toFront();
476                cm.requestFocus();
477            } else {
478                cm.setVisible(true);
479                cm.toFront();
480                cm.requestFocus();
481            }
482            cm.setSelectedChangesetsById(toSelect);
483        }
484
485        @Override
486        public void actionPerformed(ActionEvent arg0) {
487            ChangesetListModel model = getCurrentChangesetListModel();
488            Set<Integer> sel = model.getSelectedChangesetIds();
489            final Set<Integer> toDownload = new HashSet<>();
490            if (!Main.isOffline(OnlineResource.OSM_API)) {
491                ChangesetCache cc = ChangesetCache.getInstance();
492                for (int id: sel) {
493                    if (!cc.contains(id)) {
494                        toDownload.add(id);
495                    }
496                }
497            }
498
499            final ChangesetHeaderDownloadTask task;
500            final Future<?> future;
501            if (toDownload.isEmpty()) {
502                task = null;
503                future = null;
504            } else {
505                task = new ChangesetHeaderDownloadTask(toDownload);
506                future = Main.worker.submit(task);
507            }
508
509            Runnable r = new Runnable() {
510                @Override
511                public void run() {
512                    // first, wait for the download task to finish, if a download task was launched
513                    if (future != null) {
514                        try {
515                            future.get();
516                        } catch(InterruptedException e) {
517                            Main.warn("InterruptedException in "+getClass().getSimpleName()+" while downloading changeset header");
518                        } catch(ExecutionException e) {
519                            Main.error(e);
520                            BugReportExceptionHandler.handleException(e.getCause());
521                            return;
522                        }
523                    }
524                    if (task != null) {
525                        if (task.isCanceled())
526                            // don't launch the changeset manager if the download task was canceled
527                            return;
528                        if (task.isFailed()) {
529                            toDownload.clear();
530                        }
531                    }
532                    // launch the task
533                    GuiHelper.runInEDT(new Runnable() {
534                        @Override
535                        public void run() {
536                            launchChangesetManager(toDownload);
537                        }
538                    });
539                }
540            };
541            Main.worker.submit(r);
542        }
543
544        @Override
545        public void itemStateChanged(ItemEvent arg0) {
546        }
547
548        @Override
549        public void valueChanged(ListSelectionEvent e) {
550        }
551    }
552
553    class ChangesetDialogPopup extends ListPopupMenu {
554        public ChangesetDialogPopup(JList<?> ... lists) {
555            super(lists);
556            add(selectObjectsAction);
557            addSeparator();
558            add(readChangesetAction);
559            add(closeChangesetAction);
560            addSeparator();
561            add(showChangesetInfoAction);
562        }
563    }
564
565    public void addPopupMenuSeparator() {
566        popupMenu.addSeparator();
567    }
568
569    public JMenuItem addPopupMenuAction(Action a) {
570        return popupMenu.add(a);
571    }
572}