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